IInformationControl

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> eclipse >> jface >> [ text overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.eclipse.jface.text.IInformationControl

SOURCE |

Download org.eclipse.jface.text.IInformationControl

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.jface.text
Interface IInformationControl

All Known Implementing Classes:: DefaultInformationControl

public interface IInformationControl

Interface of a control presenting information. The information is given in the form of an input object. It can be either the content itself or a description of the content. The specification of what is required from an input object is left to the implementers of this interface.

The information control may not grab focus when made visible using setVisible(true). In order to provide backward compatibility for clients of IInformationControl, extension interfaces are used as a means of evolution. The following extension interfaces exist:

IInformationControlExtension since version 2.0 introducing the predicate of whether the control has anything to show or would be empty
IInformationControlExtension2 since version 2.1 replacing the original concept of textual input by general input objects.
IInformationControlExtension3since version 3.0 providing access to the control's bounds and introducing the concept of persistent size and location.

Clients can implements that interface and its extension interfaces or use the provided default implementation DefaultInformationControl.

Since:: 2.0

Method Summary

void addDisposeListener(org.eclipse.swt.events.DisposeListener listener)
          Adds the given listener to the list of dispose listeners.

void addFocusListener(org.eclipse.swt.events.FocusListener listener)
          Adds the given listener to the list of focus listeners.

org.eclipse.swt.graphics.Point computeSizeHint()
          Computes and returns a proposal for the size of this information control depending on the information to present.

void dispose()
          Disposes this information control.

boolean isFocusControl()
          Returns whether this information control has the focus.

void removeDisposeListener(org.eclipse.swt.events.DisposeListener listener)
          Removes the given listeners from the list of dispose listeners.

void removeFocusListener(org.eclipse.swt.events.FocusListener listener)
          Removes the given listeners from the list of focus listeners.

void setBackgroundColor(org.eclipse.swt.graphics.Color background)
          Sets the background color of this information control.

void setFocus()
          Sets the keyboard focus to this information control.

void setForegroundColor(org.eclipse.swt.graphics.Color foreground)
          Sets the foreground color of this information control.

void setInformation(java.lang.String information)
          Sets the information to be presented by this information control.

void setLocation(org.eclipse.swt.graphics.Point location)
          Sets the location of this information control.

void setSize(int width, int height)
          Sets the size of this information control.

void setSizeConstraints(int maxWidth, int maxHeight)
          Sets the information control's size constraints.

void setVisible(boolean visible)
          Controls the visibility of this information control.

Method Detail

setInformation

public void setInformation(java.lang.String information)

Sets the information to be presented by this information control.

Replaced by IInformationControlExtension2.setInput(Object) 55 .

setSizeConstraints

public void setSizeConstraints(int maxWidth,
                               int maxHeight)

Sets the information control's size constraints. A constraint value of -1 indicates no constraint. This method must be called before computeSizeHint is called.

Note: An information control which implements IInformationControlExtension3 may ignore this method or use it as hint for its very first appearance.

computeSizeHint

public org.eclipse.swt.graphics.Point computeSizeHint()

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.

setVisible

public void setVisible(boolean visible)

Controls the visibility of this information control.

setSize

public void setSize(int width,
                    int height)

Sets the size of this information control.

setLocation

public void setLocation(org.eclipse.swt.graphics.Point location)

Sets the location of this information control.

dispose

public void dispose()

Disposes this information control.

addDisposeListener

public void addDisposeListener(org.eclipse.swt.events.DisposeListener listener)

Adds the given listener to the list of dispose listeners. If the listener is already registered it is not registered again.

removeDisposeListener

public void removeDisposeListener(org.eclipse.swt.events.DisposeListener listener)

Removes the given listeners from the list of dispose listeners. If the listener is not registered this call has no effect.

setForegroundColor

public void setForegroundColor(org.eclipse.swt.graphics.Color foreground)

Sets the foreground color of this information control.

setBackgroundColor

public void setBackgroundColor(org.eclipse.swt.graphics.Color background)

Sets the background color of this information control.

isFocusControl

public boolean isFocusControl()

Returns whether this information control has the focus.

setFocus

public void setFocus()

Sets the keyboard focus to this information control.

addFocusListener

public void addFocusListener(org.eclipse.swt.events.FocusListener listener)

Adds the given listener to the list of focus listeners. If the listener is already registered it is not registered again.

removeFocusListener

public void removeFocusListener(org.eclipse.swt.events.FocusListener listener)

Removes the given listeners from the list of focus listeners. If the listener is not registered this call has no affect.