org.eclipse.sphinx.platform.ui.fields

Class ComboField

java.lang.Object

org.eclipse.sphinx.platform.ui.fields.BasicField

org.eclipse.sphinx.platform.ui.fields.ComboField

All Implemented Interfaces:

IComboField, IField

Direct Known Subclasses:

ComboButtonField

public class ComboField
extends BasicField
implements IComboField

Combo Field

Field containing a label and a combo control.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	EMPTY_LIST

Fields inherited from class org.eclipse.sphinx.platform.ui.fields.BasicField

fLabelControl, fLabelText, fUseFormLayout, fWidgetFactory, MAX_WITDH

Constructor Summary

Constructors

Constructor and Description
ComboField()
ComboField(boolean isEditable)
ComboField(int style)
ComboField(IWidgetFactory widgetFactory)
ComboField(IWidgetFactory widgetFactory, boolean isEditable)
ComboField(IWidgetFactory widgetFactory, int style)

Method Summary

Modifier and Type	Method and Description
void	dispose() Disposes of the operating system resources associated with the field.
protected org.eclipse.swt.widgets.Control[]	doFillIntoGrid(org.eclipse.swt.widgets.Composite parent, int nColumns)	/!\	To be re-implemented by platform field implementors.	/!\
org.eclipse.swt.widgets.Control	getComboControl()
protected org.eclipse.swt.widgets.Combo	getComboControl(org.eclipse.swt.widgets.Composite parent, int hspan) Creates combo control.
java.lang.String[]	getItems() Gets the combo items.
protected int	getNumberOfControls() Returns the number of columns of the dialog field.
int	getSelectionIndex()
java.lang.String	getText() Gets the text.
void	refresh() Brings the UI in sync with the model.
boolean	selectItem(int index) Selects an item.
boolean	selectItem(int index, boolean silent)
boolean	selectItem(java.lang.String name) Selects an item.
boolean	setFocus() Tries to set the focus to this field.
void	setItems(java.lang.String[] items) Sets the combo items.
void	setItems(java.lang.String[] items, boolean silent)
void	setText(java.lang.String text) Sets the text.
void	setTextWithoutUpdate(java.lang.String text) Sets the text without triggering a dialog-changed event.
protected void	updateEnableState() Called when the enable state changed.

Methods inherited from class org.eclipse.sphinx.platform.ui.fields.BasicField

addFieldListener, assertCompositeNotNull, createEmptySpace, createEmptySpace, createLabelControl, createSpecificComposite, dialogFieldChanged, fillIntoGrid, getLabelControl, getLabelControl, getLabelControl, isEnabled, isOkToUse, removeFieldListener, setEnabled, setLabelText, setToolTipText

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.sphinx.platform.ui.fields.IField

addFieldListener, fillIntoGrid, getLabelControl, isEnabled, removeFieldListener, setEnabled, setLabelText, setToolTipText

Field Detail

EMPTY_LIST

public static java.lang.String[] EMPTY_LIST

Constructor Detail

ComboField

public ComboField()

ComboField

public ComboField(IWidgetFactory widgetFactory)

ComboField

public ComboField(boolean isEditable)

ComboField

public ComboField(int style)

ComboField

public ComboField(IWidgetFactory widgetFactory,
                  boolean isEditable)

ComboField

public ComboField(IWidgetFactory widgetFactory,
                  int style)

Method Detail

doFillIntoGrid

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

Description copied from class: BasicField

/!\

To be re-implemented by platform field implementors.

/!\

Overrides:

doFillIntoGrid in class BasicField

Parameters:

parent - The parent composite of this dialog field.

nColumns - The number of columns of this dialog field.

Returns:

The controls of this dialog field.

getNumberOfControls

protected int getNumberOfControls()

Description copied from class: BasicField

Returns the number of columns of the dialog field. To be re-implemented by dialog field implementors.

Overrides:

getNumberOfControls in class BasicField

setFocus

public boolean setFocus()

Description copied from class: BasicField

Tries to set the focus to this field. Returns true if the dialog field can take focus. To be re-implemented by dialog field implementors.

Overrides:

setFocus in class BasicField

Returns:

• true if field got the focus;
• false if it was unable to.

getComboControl

protected final org.eclipse.swt.widgets.Combo getComboControl(org.eclipse.swt.widgets.Composite parent,
                                                              int hspan)

Creates combo control.

Parameters:

parent - The parent composite (supposed to be not null).

hspan - The number of columns the combo widget must span.

Returns:

The created combo widget.

updateEnableState

protected void updateEnableState()

Description copied from class: BasicField

Called when the enable state changed. To be extended by dialog field implementors.

Overrides:

updateEnableState in class BasicField

dispose

public void dispose()

Description copied from interface: IField

Disposes of the operating system resources associated with the field.

Specified by:

dispose in interface IField

Overrides:

dispose in class BasicField

getItems

public java.lang.String[] getItems()

Gets the combo items.

Specified by:

getItems in interface IComboField

setItems

public void setItems(java.lang.String[] items)

Sets the combo items. Triggers a dialog-changed event.

Specified by:

setItems in interface IComboField

setItems

public void setItems(java.lang.String[] items,
                     boolean silent)

getText

public java.lang.String getText()

Gets the text.

setText

public void setText(java.lang.String text)

Sets the text. Triggers a dialog-changed event.

Specified by:

setText in interface IComboField

selectItem

public boolean selectItem(int index)

Selects an item.

Specified by:

selectItem in interface IComboField

selectItem

public boolean selectItem(int index,
                          boolean silent)

selectItem

public boolean selectItem(java.lang.String name)

Selects an item.

getSelectionIndex

public int getSelectionIndex()

Specified by:

getSelectionIndex in interface IComboField

Returns:

setTextWithoutUpdate

public void setTextWithoutUpdate(java.lang.String text)

Sets the text without triggering a dialog-changed event.

refresh

public void refresh()

Description copied from class: BasicField

Brings the UI in sync with the model. Only needed when model was changed in different thread while UI was already created.

Overrides:

refresh in class BasicField

getComboControl

public org.eclipse.swt.widgets.Control getComboControl()

Specified by:

getComboControl in interface IComboField

Returns: