org.eclipse.jface.internal.text.html

Class BrowserInformationControl [ source ]

java.lang.Object

org.eclipse.jface.text.AbstractInformationControl

org.eclipse.jface.internal.text.html.BrowserInformationControl

All Implemented Interfaces:

IDelayedInputChangeProvider, IInformationControl, IInformationControlExtension, IInformationControlExtension2, IInformationControlExtension3, IInformationControlExtension4, IInformationControlExtension5

public class BrowserInformationControl
extends AbstractInformationControl
implements IInformationControlExtension2, IDelayedInputChangeProvider

Displays HTML information in a Browser widget.

This IInformationControlExtension2 expects setInput(Object) to be called with an argument of type BrowserInformationControlInput.

Moved into this package from org.eclipse.jface.internal.text.revisions.

This class may be instantiated; it is not intended to be subclassed.

Current problems:

• the size computation is too small
• focusLost event is not sent - see https://bugs.eclipse.org/bugs/show_bug.cgi?id=84532

Since:

3.2

Constructor Summary

Constructors

Constructor and Description
BrowserInformationControl(Shell parent, String symbolicFontName, boolean resizable) Creates a browser information control with the given shell as parent.
BrowserInformationControl(Shell parent, String symbolicFontName, String statusFieldText) Creates a browser information control with the given shell as parent.
BrowserInformationControl(Shell parent, String symbolicFontName, ToolBarManager toolBarManager) Creates a browser information control with the given shell as parent.

Method Summary

Methods

Modifier and Type	Method and Description
void	addInputChangeListener(IInputChangedListener inputChangeListener) Adds a listener for input changes to this input change provider.
void	addLocationListener(LocationListener listener) Adds the listener to the collection of listeners who will be notified when the current location has changed or is about to change.
Point	computeSizeConstraints(int widthInChars, int heightInChars) Computes the size constraints based on the dialog font.
Point	computeSizeHint() Computes and returns a proposal for the size of this information control depending on the information to present.
Rectangle	computeTrim() Computes the trim (status text and tool bar are considered as trim).
protected void	createContent(Composite parent) Creates the content of the popup window.
void	dispose() Disposes this information control.
BrowserInformationControlInput	getInput()
boolean	hasContents() Returns whether this information control has contents to be displayed.
boolean	hasDelayedInputChangeListener() Tells whether a delayed input change listener is registered.
static boolean	isAvailable(Composite parent) Tells whether the SWT Browser widget and hence this information control is available.
void	notifyDelayedInputChange(Object newInput) Notifies listeners of a delayed input change.
void	removeInputChangeListener(IInputChangedListener inputChangeListener) Removes the given input change listener from this input change provider.
void	setBackgroundColor(Color background) Sets the background color of this information control.
void	setDelayedInputChangeListener(IInputChangedListener inputChangeListener) Sets or clears the delayed input change listener.
void	setForegroundColor(Color foreground) Sets the foreground color of this information control.
void	setInformation(String content) Deprecated. use setInput(Object)
void	setInput(Object input) Sets the input to be presented in this information control.
void	setSize(int width, int height) Sets the size of this information control.
void	setVisible(boolean visible) Controls the visibility of this information control.
String	toString()

Methods inherited from class org.eclipse.jface.text.AbstractInformationControl

addDisposeListener, addFocusListener, containsControl, create, getBounds, getInformationPresenterControlCreator, getShell, getSizeConstraints, getToolBarManager, isFocusControl, isResizable, isVisible, removeDisposeListener, removeFocusListener, restoresLocation, restoresSize, setFocus, setLocation, setSizeConstraints, setStatusText

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BrowserInformationControl

public BrowserInformationControl(Shell parent,
                         String symbolicFontName,
                         boolean resizable)

Creates a browser information control with the given shell as parent.

Parameters:

parent - the parent shell

symbolicFontName - the symbolic name of the font used for size computations

resizable - true if the control should be resizable

Since:

3.4

BrowserInformationControl

public BrowserInformationControl(Shell parent,
                         String symbolicFontName,
                         String statusFieldText)

Creates a browser information control with the given shell as parent.

Parameters:

parent - the parent shell

symbolicFontName - the symbolic name of the font used for size computations

statusFieldText - the text to be used in the optional status field or null if the status field should be hidden

Since:

3.4

BrowserInformationControl

public BrowserInformationControl(Shell parent,
                         String symbolicFontName,
                         ToolBarManager toolBarManager)

Creates a browser information control with the given shell as parent.

Parameters:

parent - the parent shell

symbolicFontName - the symbolic name of the font used for size computations

toolBarManager - the manager or null if toolbar is not desired

Since:

3.4

Method Detail

isAvailable

public static boolean isAvailable(Composite parent)

Tells whether the SWT Browser widget and hence this information control is available.

Parameters:

parent - the parent component used for checking or null if none

Returns:

true if this control is available

createContent

protected void createContent(Composite parent)

Description copied from class: AbstractInformationControl

Creates the content of the popup window.

Implementors will usually take over Control.getBackground() and Control.getForeground() from parent.

Implementors are expected to consider AbstractInformationControl.isResizable(): If true, they should show scrollbars if their content may exceed the size of the information control. If false, they should never show scrollbars.

The given parent comes with a FillLayout. Subclasses may set a different layout.

Specified by:

createContent in class AbstractInformationControl

Parameters:

parent - the container of the content

setInformation

public void setInformation(String content)

Deprecated. use setInput(Object)

Sets the information to be presented by this information control.

The default implementation does nothing. Subclasses must either override this method or implement IInformationControlExtension2.

Specified by:

setInformation in interface IInformationControl

Overrides:

setInformation in class AbstractInformationControl

Parameters:

content - the information to be presented

See Also:

IInformationControl.setInformation(java.lang.String)

setInput

public void setInput(Object input)

Sets the input to be presented in this information control. The concrete contract the input object is expected to adhere is defined by the implementer of this interface. This control can handle String and BrowserInformationControlInput.

Specified by:

setInput in interface IInformationControlExtension2

Parameters:

input - the object to be used as input for this control

setVisible

public void setVisible(boolean visible)

Description copied from interface: IInformationControl

Controls the visibility of this information control.

Note: The information control must not grab focus when made visible.

Specified by:

setVisible in interface IInformationControl

Overrides:

setVisible in class AbstractInformationControl

Parameters:

visible - true if the control should be visible

setSize

public void setSize(int width,
           int height)

Description copied from interface: IInformationControl

Sets the size of this information control.

Specified by:

setSize in interface IInformationControl

Overrides:

setSize in class AbstractInformationControl

Parameters:

width - the width of the control

height - the height of the control

dispose

public void dispose()

Description copied from interface: IInformationControl

Disposes this information control.

Specified by:

dispose in interface IInformationControl

Overrides:

dispose in class AbstractInformationControl

computeSizeHint

public Point computeSizeHint()

Description copied from interface: IInformationControl

Computes and returns a proposal for the size of this information control depending on the information to present. The method tries to honor known size constraints but might return a size that exceeds them.

Specified by:

computeSizeHint in interface IInformationControl

Overrides:

computeSizeHint in class AbstractInformationControl

Returns:

the computed size hint

computeTrim

public Rectangle computeTrim()

Description copied from class: AbstractInformationControl

Computes the trim (status text and tool bar are considered as trim). Subclasses can extend this method to add additional trim (e.g. scroll bars for resizable information controls).

Specified by:

computeTrim in interface IInformationControlExtension3

Overrides:

computeTrim in class AbstractInformationControl

Returns:

The receiver's trim. x and y denote the upper left corner of the trimming relative to this control's location i.e. this will most likely be negative values. width and height represent the border sizes (the sum of the horizontal and vertical trimmings, respectively).

See Also:

IInformationControlExtension3.computeTrim()

addLocationListener

public void addLocationListener(LocationListener listener)

Adds the listener to the collection of listeners who will be notified when the current location has changed or is about to change.

Parameters:

listener - the location listener

Since:

3.4

setForegroundColor

public void setForegroundColor(Color foreground)

Description copied from interface: IInformationControl

Sets the foreground color of this information control.

Specified by:

setForegroundColor in interface IInformationControl

Overrides:

setForegroundColor in class AbstractInformationControl

Parameters:

foreground - the foreground color of this information control

setBackgroundColor

public void setBackgroundColor(Color background)

Description copied from interface: IInformationControl

Sets the background color of this information control.

Specified by:

setBackgroundColor in interface IInformationControl

Overrides:

setBackgroundColor in class AbstractInformationControl

Parameters:

background - the background color of this information control

hasContents

public boolean hasContents()

Description copied from interface: IInformationControlExtension

Returns whether this information control has contents to be displayed.

Specified by:

hasContents in interface IInformationControlExtension

Returns:

true if there is contents to be displayed.

addInputChangeListener

public void addInputChangeListener(IInputChangedListener inputChangeListener)

Adds a listener for input changes to this input change provider. Has no effect if an identical listener is already registered.

Parameters:

inputChangeListener - the listener to add

Since:

3.4

removeInputChangeListener

public void removeInputChangeListener(IInputChangedListener inputChangeListener)

Removes the given input change listener from this input change provider. Has no effect if an identical listener is not registered.

Parameters:

inputChangeListener - the listener to remove

Since:

3.4

setDelayedInputChangeListener

public void setDelayedInputChangeListener(IInputChangedListener inputChangeListener)

Description copied from interface: IDelayedInputChangeProvider

Sets or clears the delayed input change listener.

Specified by:

setDelayedInputChangeListener in interface IDelayedInputChangeProvider

Parameters:

inputChangeListener - the new delayed input change listener, or null if none

hasDelayedInputChangeListener

public boolean hasDelayedInputChangeListener()

Tells whether a delayed input change listener is registered.

Returns:

true iff a delayed input change listener is currently registered

Since:

3.4

notifyDelayedInputChange

public void notifyDelayedInputChange(Object newInput)

Notifies listeners of a delayed input change.

Parameters:

newInput - the new input, or null to request cancellation

Since:

3.4

toString

public String toString()

Overrides:

toString in class Object

getInput

public BrowserInformationControlInput getInput()

Returns:

the current browser input or null

computeSizeConstraints

public Point computeSizeConstraints(int widthInChars,
                           int heightInChars)

Description copied from class: AbstractInformationControl

Computes the size constraints based on the dialog font. Subclasses can override or extend.

Specified by:

computeSizeConstraints in interface IInformationControlExtension5

Overrides:

computeSizeConstraints in class AbstractInformationControl

Parameters:

widthInChars - the width constraint in number of characters

heightInChars - the height constraint in number of characters

Returns:

a point with width and height in pixels, or null to use the subject control's font to calculate the size

See Also:

IInformationControlExtension5.computeSizeConstraints(int, int)