org.eclipse.sphinx.platform.ui.fields

Interface IField

All Known Subinterfaces:

ICComboButtonField, ICComboField, IComboButtonField, IComboField, IStringButtonField, IStringField

All Known Implementing Classes:

BasicField, BasicHyperlinkField, CComboButtonField, CComboField, ComboButtonField, ComboField, HyperlinkCComboButtonField, HyperlinkCComboField, HyperlinkStringButtonField, HyperlinkStringField, ListButtonsField, ListField, RangeField, SelectionButtonField, Separator, StringButtonField, StringField

public interface IField

Sphinx Platform Field

A platform field is made of several controls (i.e. widgets such as: label, text, combo, button, list, etc.). From the association of such controls result a field whose behavior is specialized according to the widgets it owns. The field content creation is supposed to be performed inside method fillIntoGrid that must be implemented by every field.

Every field contains at least a label; this label displays a text that is owned by the field. This interface provides methods allowing: to set the text of this label control, to set the tool tip of this label control, or to get this label control.

A platform field may have listeners that can be added or removed thanks to methods provided by this interface. Inside concrete implementation of this interface, it is recommended to use a listener list (ListenerList) in order to store listeners associated to this field.

See Also:

Label, ListenerList

Method Summary

Methods

Modifier and Type	Method and Description
void	addFieldListener(IFieldListener listener) Adds the given field listener in the listeners list of this field.
void	dispose() Disposes of the operating system resources associated with the field.
org.eclipse.swt.widgets.Control[]	fillIntoGrid(org.eclipse.swt.widgets.Composite parent, int nColumns) Creates all controls of the dialog field and fills it to a composite.
org.eclipse.swt.widgets.Control	getLabelControl()
boolean	isEnabled() Gets the enable state of the dialog field.
void	removeFieldListener(IFieldListener listener) Removes the given field listener from the listeners list of this field.
void	setEnabled(boolean enabled) Sets the enable state of the field.
void	setLabelText(java.lang.String labeltext) Sets the label of the dialog field.
void	setToolTipText(java.lang.String toolTip) Sets the tool tip of the dialog field.

Method Detail

fillIntoGrid

org.eclipse.swt.widgets.Control[] fillIntoGrid(org.eclipse.swt.widgets.Composite parent,
                                             int nColumns)

Creates all controls of the dialog field and fills it to a composite. The composite is assumed to have a GridLayout or a FormLayout as layout. The field will adjust its controls' spans to the given number of columns.

Parameters:

parent - The parent composite into which this field must be created.

nColumns - The number of columns over which this field must span.

Returns:

The created controls constituting this field.

See Also:

GridLayout, FormLayout

getLabelControl

org.eclipse.swt.widgets.Control getLabelControl()

Returns:

The label control of this field.

setEnabled

void setEnabled(boolean enabled)

Sets the enable state of the field.

Parameters:

enabled - The new enable state.

isEnabled

boolean isEnabled()

Gets the enable state of the dialog field.

setLabelText

void setLabelText(java.lang.String labeltext)

Sets the label of the dialog field.

Parameters:

labeltext - The text of the label.

setToolTipText

void setToolTipText(java.lang.String toolTip)

Sets the tool tip of the dialog field.

Parameters:

toolTip - The text to use as tool tip.

addFieldListener

void addFieldListener(IFieldListener listener)

Adds the given field listener in the listeners list of this field.

Parameters:

listener - The field listener to add.

removeFieldListener

void removeFieldListener(IFieldListener listener)

Removes the given field listener from the listeners list of this field.

Parameters:

listener - The field listener to remove.

dispose

void dispose()

Disposes of the operating system resources associated with the field.