org.eclipse.jface.text/src/org/eclipse/jface/text/DefaultInformationControl.java - platform/eclipse.platform.text - Git at Google

 /*******************************************************************************
  * Copyright (c) 2000, 2003 IBM Corporation and others.
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Common Public License v1.0
  * which accompanies this distribution, and is available at
  * http://www.eclipse.org/legal/cpl-v10.html
  *
  * Contributors:
  *     IBM Corporation - initial API and implementation
  *******************************************************************************/

 package org.eclipse.jface.text;


 import org.eclipse.swt.SWT;
 import org.eclipse.swt.custom.StyledText;
 import org.eclipse.swt.events.DisposeListener;
 import org.eclipse.swt.events.FocusListener;
 import org.eclipse.swt.events.KeyEvent;
 import org.eclipse.swt.events.KeyListener;
 import org.eclipse.swt.graphics.Color;
 import org.eclipse.swt.graphics.Point;
 import org.eclipse.swt.graphics.Rectangle;
 import org.eclipse.swt.widgets.Composite;
 import org.eclipse.swt.widgets.Control;
 import org.eclipse.swt.widgets.Display;
 import org.eclipse.swt.widgets.Layout;
 import org.eclipse.swt.widgets.Shell;


 /**
  * Text based implementation of <code>IInformationControl</code>.
  * Displays information in a styled text widget. Before displaying, the
  * information set to this information control is processed by an
  * <code>IInformationPresenter</code>.
  *
  * @since 2.0
  */
 public class DefaultInformationControl implements IInformationControl, IInformationControlExtension {

 	/**
 	 * An information presenter determines the style presentation
 	 * of information displayed in the default information control.
 	 * The interface can be implemented by clients.
 	 */
 	public static interface IInformationPresenter {

 		/**
 		 * Updates the given presentation of the given information and
 		 * thereby may manipulate the information to be displayed. The manipulation
 		 * could be the extraction of textual encoded style information etc. Returns the
 		 * manipulated information.
 		 *
 		 * @param display the display of the information control
 		 * @param hoverInfo the information to be presented
 		 * @param presentation the presentation to be updated
 		 * @param maxWidth the maximal width in pixels
 		 * @param maxHeight the maximal height in pixels
 		 *
 		 * @return the manipulated information
 		 */
 		String updatePresentation(Display display, String hoverInfo, TextPresentation presentation, int maxWidth, int maxHeight);
 	};

 	/**
 	 * Layout used to achive the "tool tip" look, i.e., flat with a thin boarder.
 	 */
 	private static class BorderFillLayout extends Layout {

 		/** The border widths. */
 		final int fBorderSize;

 		/**
 		 * Creates a fill layout with a border.
 		 *
 		 * @param borderSize the size of the border
 		 */
 		public BorderFillLayout(int borderSize) {
 			if (borderSize < 0)
 				throw new IllegalArgumentException();
 			fBorderSize= borderSize;
 		}

 		/**
 		 * Returns the border size.
 		 *
 		 * @return the border size
 		 */
 		public int getBorderSize() {
 			return fBorderSize;
 		}

 		/*
 		 * @see org.eclipse.swt.widgets.Layout#computeSize(org.eclipse.swt.widgets.Composite, int, int, boolean)
 		 */
 		protected Point computeSize(Composite composite, int wHint, int hHint, boolean flushCache) {

 			Control[] children= composite.getChildren();
 			Point minSize= new Point(0, 0);

 			if (children != null) {
 				for (int i= 0; i < children.length; i++) {
 					Point size= children[i].computeSize(wHint, hHint, flushCache);
 					minSize.x= Math.max(minSize.x, size.x);
 					minSize.y= Math.max(minSize.y, size.y);
 				}
 			}

 			minSize.x += fBorderSize * 2 + RIGHT_MARGIN;
 			minSize.y += fBorderSize * 2;

 			return minSize;
 		}
 		/*
 		 * @see org.eclipse.swt.widgets.Layout#layout(org.eclipse.swt.widgets.Composite, boolean)
 		 */
 		protected void layout(Composite composite, boolean flushCache) {

 			Control[] children= composite.getChildren();
 			Point minSize= new Point(composite.getClientArea().width, composite.getClientArea().height);

 			if (children != null) {
 				for (int i= 0; i < children.length; i++) {
 					Control child= children[i];
 					child.setSize(minSize.x - fBorderSize * 2, minSize.y - fBorderSize * 2);
 					child.setLocation(fBorderSize, fBorderSize);
 				}
 			}
 		}
 	}


 	/** Border thickness in pixels. */
 	private static final int BORDER= 1;
 	/** Right margin in pixels. */
 	private static final int RIGHT_MARGIN= 3;

 	/** The control's shell */
 	private Shell fShell;
 	/** The control's text widget */
 	private StyledText fText;
 	/** The information presenter */
 	private IInformationPresenter fPresenter;
 	/** A cached text presentation */
 	private TextPresentation fPresentation= new TextPresentation();
 	/** The control width constraint */
 	private int fMaxWidth= -1;
 	/** The control height constraint */
 	private int fMaxHeight= -1;


 	/**
 	 * Creates a default information control with the given shell as parent. The given
 	 * information presenter is used to process the information to be displayed. The given
 	 * styles are applied to the created styled text widget.
 	 *
 	 * @param parent the parent shell
 	 * @param shellStyle the additional styles for the shell
 	 * @param style the additional styles for the styled text widget
 	 * @param presenter the presenter to be used
 	 */
 	public DefaultInformationControl(Shell parent, int shellStyle, int style, IInformationPresenter presenter) {

 		fShell= new Shell(parent, SWT.NO_FOCUS | SWT.ON_TOP | shellStyle);
 		fText= new StyledText(fShell, SWT.MULTI | SWT.READ_ONLY | style);

 		Display display= fShell.getDisplay();

 		int border= ((shellStyle & SWT.NO_TRIM) == 0) ? 0 : BORDER;

 		fShell.setLayout(new BorderFillLayout(border));
 		fShell.setBackground(display.getSystemColor(SWT.COLOR_BLACK));

 		fText.setForeground(display.getSystemColor(SWT.COLOR_INFO_FOREGROUND));
 		fText.setBackground(display.getSystemColor(SWT.COLOR_INFO_BACKGROUND));

 		fText.addKeyListener(new KeyListener() {

 			public void keyPressed(KeyEvent e)  {
 				if (e.character == 0x1B) // ESC
 					fShell.dispose();
 			}

 			public void keyReleased(KeyEvent e) {}
 		});

 		fPresenter= presenter;
 	}

 	/**
 	 * Creates a default information control with the given shell as parent. The given
 	 * information presenter is used to process the information to be displayed. The given
 	 * styles are applied to the created styled text widget.
 	 *
 	 * @param parent the parent shell
 	 * @param style the additional styles for the styled text widget
 	 * @param presenter the presenter to be used
 	 */
 	public DefaultInformationControl(Shell parent,int style, IInformationPresenter presenter) {
 		this(parent, SWT.NO_TRIM, style, presenter);
 	}

 	/**
 	 * Creates a default information control with the given shell as parent.
 	 * No information presenter is used to process the information
 	 * to be displayed. No additional styles are applied to the styled text widget.
 	 *
 	 * @param parent the parent shell
 	 */
 	public DefaultInformationControl(Shell parent) {
 		this(parent, SWT.NONE, null);
 	}

 	/**
 	 * Creates a default information control with the given shell as parent. The given
 	 * information presenter is used to process the information to be displayed.
 	 * No additional styles are applied to the styled text widget.
 	 *
 	 * @param parent the parent shell
 	 * @param presenter the presenter to be used
 	 */
 	public DefaultInformationControl(Shell parent, IInformationPresenter presenter) {
 		this(parent, SWT.NONE, presenter);
 	}

 	/*
 	 * @see IInformationControl#setInformation(String)
 	 */
 	public void setInformation(String content) {
 		if (fPresenter == null) {
 			fText.setText(content);
 		} else {
 			fPresentation.clear();
 			content= fPresenter.updatePresentation(fShell.getDisplay(), content, fPresentation, fMaxWidth, fMaxHeight);
 			if (content != null) {
 				fText.setText(content);
 				TextPresentation.applyTextPresentation(fPresentation, fText);
 			} else {
 				fText.setText(""); //$NON-NLS-1$
 			}
 		}
 	}

 	/*
 	 * @see IInformationControl#setVisible(boolean)
 	 */
 	public void setVisible(boolean visible) {
 			fShell.setVisible(visible);
 	}

 	/*
 	 * @see IInformationControl#dispose()
 	 */
 	public void dispose() {
 		if (fShell != null) {
 			if (!fShell.isDisposed())
 				fShell.dispose();
 			fShell= null;
 			fText= null;
 		}
 	}

 	/*
 	 * @see IInformationControl#setSize(int, int)
 	 */
 	public void setSize(int width, int height) {
 		fShell.setSize(width, height);
 	}

 	/*
 	 * @see IInformationControl#setLocation(Point)
 	 */
 	public void setLocation(Point location) {
 		Rectangle trim= fShell.computeTrim(0, 0, 0, 0);
 		Point textLocation= fText.getLocation();
 		location.x += trim.x - textLocation.x;
 		location.y += trim.y - textLocation.y;
 		fShell.setLocation(location);
 	}

 	/*
 	 * @see IInformationControl#setSizeConstraints(int, int)
 	 */
 	public void setSizeConstraints(int maxWidth, int maxHeight) {
 		fMaxWidth= maxWidth;
 		fMaxHeight= maxHeight;
 	}

 	/*
 	 * @see IInformationControl#computeSizeHint()
 	 */
 	public Point computeSizeHint() {
 		return fShell.computeSize(SWT.DEFAULT, SWT.DEFAULT);
 	}

 	/*
 	 * @see IInformationControl#addDisposeListener(DisposeListener)
 	 */
 	public void addDisposeListener(DisposeListener listener) {
 		fShell.addDisposeListener(listener);
 	}

 	/*
 	 * @see IInformationControl#removeDisposeListener(DisposeListener)
 	 */
 	public void removeDisposeListener(DisposeListener listener) {
 		fShell.removeDisposeListener(listener);
 	}

 	/*
 	 * @see IInformationControl#setForegroundColor(Color)
 	 */
 	public void setForegroundColor(Color foreground) {
 		fText.setForeground(foreground);
 	}

 	/*
 	 * @see IInformationControl#setBackgroundColor(Color)
 	 */
 	public void setBackgroundColor(Color background) {
 		fText.setBackground(background);
 	}

 	/*
 	 * @see IInformationControl#isFocusControl()
 	 */
 	public boolean isFocusControl() {
 		return fText.isFocusControl();
 	}

 	/*
 	 * @see IInformationControl#setFocus()
 	 */
 	public void setFocus() {
 		fShell.forceFocus();
 		fText.setFocus();
 	}

 	/*
 	 * @see IInformationControl#addFocusListener(FocusListener)
 	 */
 	public void addFocusListener(FocusListener listener) {
 		fText.addFocusListener(listener);
 	}

 	/*
 	 * @see IInformationControl#removeFocusListener(FocusListener)
 	 */
 	public void removeFocusListener(FocusListener listener) {
 		fText.removeFocusListener(listener);
 	}

 	/*
 	 * @see IInformationControlExtension#hasContents()
 	 */
 	public boolean hasContents() {
 		return fText.getCharCount() > 0;
 	}
 }
	/*******************************************************************************
	* Copyright (c) 2000, 2003 IBM Corporation and others.
	* All rights reserved. This program and the accompanying materials
	* are made available under the terms of the Common Public License v1.0
	* which accompanies this distribution, and is available at
	* http://www.eclipse.org/legal/cpl-v10.html
	*
	* Contributors:
	* IBM Corporation - initial API and implementation
	*******************************************************************************/

	package org.eclipse.jface.text;


	import org.eclipse.swt.SWT;
	import org.eclipse.swt.custom.StyledText;
	import org.eclipse.swt.events.DisposeListener;
	import org.eclipse.swt.events.FocusListener;
	import org.eclipse.swt.events.KeyEvent;
	import org.eclipse.swt.events.KeyListener;
	import org.eclipse.swt.graphics.Color;
	import org.eclipse.swt.graphics.Point;
	import org.eclipse.swt.graphics.Rectangle;
	import org.eclipse.swt.widgets.Composite;
	import org.eclipse.swt.widgets.Control;
	import org.eclipse.swt.widgets.Display;
	import org.eclipse.swt.widgets.Layout;
	import org.eclipse.swt.widgets.Shell;



	/**
	* Text based implementation of <code>IInformationControl</code>.
	* Displays information in a styled text widget. Before displaying, the
	* information set to this information control is processed by an
	* <code>IInformationPresenter</code>.
	*
	* @since 2.0
	*/
	public class DefaultInformationControl implements IInformationControl, IInformationControlExtension {

	/**
	* An information presenter determines the style presentation
	* of information displayed in the default information control.
	* The interface can be implemented by clients.
	*/
	public static interface IInformationPresenter {

	/**
	* Updates the given presentation of the given information and
	* thereby may manipulate the information to be displayed. The manipulation
	* could be the extraction of textual encoded style information etc. Returns the
	* manipulated information.
	*
	* @param display the display of the information control
	* @param hoverInfo the information to be presented
	* @param presentation the presentation to be updated
	* @param maxWidth the maximal width in pixels
	* @param maxHeight the maximal height in pixels
	*
	* @return the manipulated information
	*/
	String updatePresentation(Display display, String hoverInfo, TextPresentation presentation, int maxWidth, int maxHeight);
	};

	/**
	* Layout used to achive the "tool tip" look, i.e., flat with a thin boarder.
	*/
	private static class BorderFillLayout extends Layout {

	/** The border widths. */
	final int fBorderSize;

	/**
	* Creates a fill layout with a border.
	*
	* @param borderSize the size of the border
	*/
	public BorderFillLayout(int borderSize) {
	if (borderSize < 0)
	throw new IllegalArgumentException();
	fBorderSize= borderSize;
	}

	/**
	* Returns the border size.
	*
	* @return the border size
	*/
	public int getBorderSize() {
	return fBorderSize;
	}

	/*
	* @see org.eclipse.swt.widgets.Layout#computeSize(org.eclipse.swt.widgets.Composite, int, int, boolean)
	*/
	protected Point computeSize(Composite composite, int wHint, int hHint, boolean flushCache) {

	Control[] children= composite.getChildren();
	Point minSize= new Point(0, 0);

	if (children != null) {
	for (int i= 0; i < children.length; i++) {
	Point size= children[i].computeSize(wHint, hHint, flushCache);
	minSize.x= Math.max(minSize.x, size.x);
	minSize.y= Math.max(minSize.y, size.y);
	}
	}

	minSize.x += fBorderSize * 2 + RIGHT_MARGIN;
	minSize.y += fBorderSize * 2;

	return minSize;
	}
	/*
	* @see org.eclipse.swt.widgets.Layout#layout(org.eclipse.swt.widgets.Composite, boolean)
	*/
	protected void layout(Composite composite, boolean flushCache) {

	Control[] children= composite.getChildren();
	Point minSize= new Point(composite.getClientArea().width, composite.getClientArea().height);

	if (children != null) {
	for (int i= 0; i < children.length; i++) {
	Control child= children[i];
	child.setSize(minSize.x - fBorderSize * 2, minSize.y - fBorderSize * 2);
	child.setLocation(fBorderSize, fBorderSize);
	}
	}
	}
	}


	/** Border thickness in pixels. */
	private static final int BORDER= 1;
	/** Right margin in pixels. */
	private static final int RIGHT_MARGIN= 3;

	/** The control's shell */
	private Shell fShell;
	/** The control's text widget */
	private StyledText fText;
	/** The information presenter */
	private IInformationPresenter fPresenter;
	/** A cached text presentation */
	private TextPresentation fPresentation= new TextPresentation();
	/** The control width constraint */
	private int fMaxWidth= -1;
	/** The control height constraint */
	private int fMaxHeight= -1;



	/**
	* Creates a default information control with the given shell as parent. The given
	* information presenter is used to process the information to be displayed. The given
	* styles are applied to the created styled text widget.
	*
	* @param parent the parent shell
	* @param shellStyle the additional styles for the shell
	* @param style the additional styles for the styled text widget
	* @param presenter the presenter to be used
	*/
	public DefaultInformationControl(Shell parent, int shellStyle, int style, IInformationPresenter presenter) {

	fShell= new Shell(parent, SWT.NO_FOCUS \| SWT.ON_TOP \| shellStyle);
	fText= new StyledText(fShell, SWT.MULTI \| SWT.READ_ONLY \| style);

	Display display= fShell.getDisplay();

	int border= ((shellStyle & SWT.NO_TRIM) == 0) ? 0 : BORDER;

	fShell.setLayout(new BorderFillLayout(border));
	fShell.setBackground(display.getSystemColor(SWT.COLOR_BLACK));

	fText.setForeground(display.getSystemColor(SWT.COLOR_INFO_FOREGROUND));
	fText.setBackground(display.getSystemColor(SWT.COLOR_INFO_BACKGROUND));

	fText.addKeyListener(new KeyListener() {

	public void keyPressed(KeyEvent e) {
	if (e.character == 0x1B) // ESC
	fShell.dispose();
	}

	public void keyReleased(KeyEvent e) {}
	});

	fPresenter= presenter;
	}

	/**
	* Creates a default information control with the given shell as parent. The given
	* information presenter is used to process the information to be displayed. The given
	* styles are applied to the created styled text widget.
	*
	* @param parent the parent shell
	* @param style the additional styles for the styled text widget
	* @param presenter the presenter to be used
	*/
	public DefaultInformationControl(Shell parent,int style, IInformationPresenter presenter) {
	this(parent, SWT.NO_TRIM, style, presenter);
	}

	/**
	* Creates a default information control with the given shell as parent.
	* No information presenter is used to process the information
	* to be displayed. No additional styles are applied to the styled text widget.
	*
	* @param parent the parent shell
	*/
	public DefaultInformationControl(Shell parent) {
	this(parent, SWT.NONE, null);
	}

	/**
	* Creates a default information control with the given shell as parent. The given
	* information presenter is used to process the information to be displayed.
	* No additional styles are applied to the styled text widget.
	*
	* @param parent the parent shell
	* @param presenter the presenter to be used
	*/
	public DefaultInformationControl(Shell parent, IInformationPresenter presenter) {
	this(parent, SWT.NONE, presenter);
	}

	/*
	* @see IInformationControl#setInformation(String)
	*/
	public void setInformation(String content) {
	if (fPresenter == null) {
	fText.setText(content);
	} else {
	fPresentation.clear();
	content= fPresenter.updatePresentation(fShell.getDisplay(), content, fPresentation, fMaxWidth, fMaxHeight);
	if (content != null) {
	fText.setText(content);
	TextPresentation.applyTextPresentation(fPresentation, fText);
	} else {
	fText.setText(""); //$NON-NLS-1$
	}
	}
	}

	/*
	* @see IInformationControl#setVisible(boolean)
	*/
	public void setVisible(boolean visible) {
	fShell.setVisible(visible);
	}

	/*
	* @see IInformationControl#dispose()
	*/
	public void dispose() {
	if (fShell != null) {
	if (!fShell.isDisposed())
	fShell.dispose();
	fShell= null;
	fText= null;
	}
	}

	/*
	* @see IInformationControl#setSize(int, int)
	*/
	public void setSize(int width, int height) {
	fShell.setSize(width, height);
	}

	/*
	* @see IInformationControl#setLocation(Point)
	*/
	public void setLocation(Point location) {
	Rectangle trim= fShell.computeTrim(0, 0, 0, 0);
	Point textLocation= fText.getLocation();
	location.x += trim.x - textLocation.x;
	location.y += trim.y - textLocation.y;
	fShell.setLocation(location);
	}

	/*
	* @see IInformationControl#setSizeConstraints(int, int)
	*/
	public void setSizeConstraints(int maxWidth, int maxHeight) {
	fMaxWidth= maxWidth;
	fMaxHeight= maxHeight;
	}

	/*
	* @see IInformationControl#computeSizeHint()
	*/
	public Point computeSizeHint() {
	return fShell.computeSize(SWT.DEFAULT, SWT.DEFAULT);
	}

	/*
	* @see IInformationControl#addDisposeListener(DisposeListener)
	*/
	public void addDisposeListener(DisposeListener listener) {
	fShell.addDisposeListener(listener);
	}

	/*
	* @see IInformationControl#removeDisposeListener(DisposeListener)
	*/
	public void removeDisposeListener(DisposeListener listener) {
	fShell.removeDisposeListener(listener);
	}

	/*
	* @see IInformationControl#setForegroundColor(Color)
	*/
	public void setForegroundColor(Color foreground) {
	fText.setForeground(foreground);
	}

	/*
	* @see IInformationControl#setBackgroundColor(Color)
	*/
	public void setBackgroundColor(Color background) {
	fText.setBackground(background);
	}

	/*
	* @see IInformationControl#isFocusControl()
	*/
	public boolean isFocusControl() {
	return fText.isFocusControl();
	}

	/*
	* @see IInformationControl#setFocus()
	*/
	public void setFocus() {
	fShell.forceFocus();
	fText.setFocus();
	}

	/*
	* @see IInformationControl#addFocusListener(FocusListener)
	*/
	public void addFocusListener(FocusListener listener) {
	fText.addFocusListener(listener);
	}

	/*
	* @see IInformationControl#removeFocusListener(FocusListener)
	*/
	public void removeFocusListener(FocusListener listener) {
	fText.removeFocusListener(listener);
	}

	/*
	* @see IInformationControlExtension#hasContents()
	*/
	public boolean hasContents() {
	return fText.getCharCount() > 0;
	}
	}