org.eclipse.xtext.ui.editor.tasks.dialogfields

Class StringDialogField

java.lang.Object

org.eclipse.xtext.ui.editor.tasks.dialogfields.DialogField

org.eclipse.xtext.ui.editor.tasks.dialogfields.StringDialogField

public class StringDialogField
extends DialogField

Dialog field containing a label and a text control.

Field Summary

Fields inherited from class org.eclipse.xtext.ui.editor.tasks.dialogfields.DialogField

fLabelText

Constructor Summary

Constructors

Constructor and Description
StringDialogField()

Method Summary

Methods

Modifier and Type	Method and Description
org.eclipse.swt.widgets.Control[]	doFillIntoGrid(org.eclipse.swt.widgets.Composite parent, int nColumns) Creates all controls of the dialog field and fills it to a composite.
int	getNumberOfControls() Returns the number of columns of the dialog field.
String	getText() Gets the text.
org.eclipse.swt.widgets.Text	getTextControl(org.eclipse.swt.widgets.Composite parent) Creates or returns the created text control.
protected static org.eclipse.swt.layout.GridData	gridDataForText(int span)
void	refresh() Brings the UI in sync with the model.
boolean	setFocus() Tries to set the focus to the dialog field.
void	setText(String text) Sets the text.
void	setTextWithoutUpdate(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.xtext.ui.editor.tasks.dialogfields.DialogField

assertCompositeNotNull, assertEnoughColumns, createEmptySpace, createEmptySpace, dialogFieldChanged, getLabelControl, gridDataForLabel, isEnabled, isOkToUse, postSetFocusOnDialogField, setDialogFieldListener, setEnabled, setLabelText

Methods inherited from class java.lang.Object

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

Constructor Detail

StringDialogField

public StringDialogField()

Method Detail

doFillIntoGrid

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

Description copied from class: DialogField

Creates all controls of the dialog field and fills it to a composite. The composite is assumed to have MGridLayout as layout. The dialog field will adjust its controls' spans to the number of columns given. To be reimplemented by dialog field implementors.

Overrides:

doFillIntoGrid in class DialogField

getNumberOfControls

public int getNumberOfControls()

Description copied from class: DialogField

Returns the number of columns of the dialog field. To be reimplemented by dialog field implementors.

Overrides:

getNumberOfControls in class DialogField

gridDataForText

protected static org.eclipse.swt.layout.GridData gridDataForText(int span)

setFocus

public boolean setFocus()

Description copied from class: DialogField

Tries to set the focus to the dialog field. Returns true if the dialog field can take focus. To be reimplemented by dialog field implementors.

Overrides:

setFocus in class DialogField

getTextControl

public org.eclipse.swt.widgets.Text getTextControl(org.eclipse.swt.widgets.Composite parent)

Creates or returns the created text control.

Parameters:

parent - The parent composite or null when the widget has already been created.

updateEnableState

protected void updateEnableState()

Description copied from class: DialogField

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

Overrides:

updateEnableState in class DialogField

getText

public String getText()

Gets the text. Can not be null

setText

public void setText(String text)

Sets the text. Triggers a dialog-changed event.

setTextWithoutUpdate

public void setTextWithoutUpdate(String text)

Sets the text without triggering a dialog-changed event.

refresh

public void refresh()

Description copied from class: DialogField

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

Overrides:

refresh in class DialogField