org.eclipse.sphinx.platform.ui.fields

Class HyperlinkStringField

java.lang.Object

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

org.eclipse.sphinx.platform.ui.fields.BasicHyperlinkField

org.eclipse.sphinx.platform.ui.fields.HyperlinkStringField

All Implemented Interfaces:

IField, IStringField

Direct Known Subclasses:

HyperlinkStringButtonField

public class HyperlinkStringField
extends BasicHyperlinkField
implements IStringField

Dialog field containing a label and a text control.

Note	Parts have been commented (content assist for example). These parts are not needed for the moment, but one day, they could be useful!

Field Summary

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

fLabelControl, fLabelText, fUseFormLayout, fWidgetFactory, MAX_WITDH

Constructor Summary

Constructors

Constructor and Description
HyperlinkStringField(IWidgetFactory widgetFactory, org.eclipse.ui.forms.events.HyperlinkAdapter hyperlinkAdapter)
HyperlinkStringField(IWidgetFactory widgetFactory, org.eclipse.ui.forms.events.HyperlinkAdapter hyperlinkAdapter, 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.	/!\
protected int	getNumberOfControls() Returns the number of columns of the dialog field.
java.lang.String	getText() Gets the text.
org.eclipse.swt.widgets.Control	getTextControl()
protected org.eclipse.swt.widgets.Text	getTextControl(org.eclipse.swt.widgets.Composite parent, int hspan)
protected boolean	isEditable()
void	refresh() Brings the UI in sync with the model.
void	setEditable(boolean editable) Sets the editable state of the field.
boolean	setFocus() Tries to set the focus to this field.
void	setText(java.lang.String text) Sets the text.
void	setTextEnabled(boolean b)	/!\	This method only concerns the encapsulated text control.	/!\
void	setTextWithoutUpdate(java.lang.String text) Sets the text without triggering a dialog-changed event.
protected void	updateEditableState()
protected void	updateEnableState() Called when the enable state changed.

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

createLabelControl, setLabelText

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

addFieldListener, assertCompositeNotNull, createEmptySpace, createEmptySpace, createSpecificComposite, dialogFieldChanged, fillIntoGrid, getLabelControl, getLabelControl, getLabelControl, isEnabled, isOkToUse, removeFieldListener, setEnabled, 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

Constructor Detail

HyperlinkStringField

public HyperlinkStringField(IWidgetFactory widgetFactory,
                            org.eclipse.ui.forms.events.HyperlinkAdapter hyperlinkAdapter)

HyperlinkStringField

public HyperlinkStringField(IWidgetFactory widgetFactory,
                            org.eclipse.ui.forms.events.HyperlinkAdapter hyperlinkAdapter,
                            int style)

Parameters:

style -
Default value: SWT.SINGLE | SWT.BORDER

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.

getTextControl

protected final org.eclipse.swt.widgets.Text getTextControl(org.eclipse.swt.widgets.Composite parent,
                                                            int hspan)

Parameters:

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

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

Returns:

The created text widget.

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.

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

getText

public java.lang.String getText()

Gets the text. Can not be null

Specified by:

getText in interface IStringField

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

setText

public void setText(java.lang.String text)

Sets the text. Triggers a dialog-changed event.

Specified by:

setText in interface IStringField

setTextEnabled

public void setTextEnabled(boolean b)

/!\

This method only concerns the encapsulated text control.

/!\

Enables the text control if the parameter is true. Otherwise, disables it.

Parameters:

b - The new enabled state.

setTextWithoutUpdate

public void setTextWithoutUpdate(java.lang.String text)

Sets the text without triggering a dialog-changed event.

Specified by:

setTextWithoutUpdate in interface IStringField

getTextControl

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

Specified by:

getTextControl in interface IStringField

Returns:

setEditable

public void setEditable(boolean editable)

Description copied from interface: IStringField

Sets the editable state of the field.

Specified by:

setEditable in interface IStringField

Parameters:

editable - The new editable state.

updateEditableState

protected void updateEditableState()

isEditable

protected final boolean isEditable()