org.eclipse.sphinx.platform.ui.fields

Class SelectionButtonField

java.lang.Object

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

org.eclipse.sphinx.platform.ui.fields.SelectionButtonField

All Implemented Interfaces:

IField

public class SelectionButtonField
extends BasicField

Selection Button Dialog Field

Dialog Field containing a single button such as a radio or checkbox button.

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
SelectionButtonField(int buttonStyle) Creates a selection button.
SelectionButtonField(IWidgetFactory widgetFactory, int buttonStyle)

Method Summary

Modifier and Type	Method and Description
void	attachDialogField(BasicField basicField) Attaches a field to the selection state of the selection button.
void	attachDialogFields(BasicField[] dialogFields) Attaches fields to the selection state of the selection button.
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	getButtonControl()
protected int	getNumberOfControls() Returns the number of columns of the dialog field.
org.eclipse.swt.widgets.Button	getSelectionButton(org.eclipse.swt.widgets.Composite group) Returns the selection button widget.
boolean	isAttached(BasicField editor) Returns true is the given field is attached to the selection button.
boolean	isSelected() Returns the selection state of the button.
void	refresh() Brings the UI in sync with the model.
void	setLabelText(java.lang.String labeltext) Sets the label of the dialog field.
void	setSelection(boolean selected) Sets the selection state of the button.
void	setSelectionWithoutEvent(boolean selected) Set button selection without triggering "dialog field changed" event.
void	setToolTipText(java.lang.String toolTip) Sets the tool tip of the dialog field.
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, setFocus

Methods inherited from class java.lang.Object

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

Constructor Detail

SelectionButtonField

public SelectionButtonField(int buttonStyle)

Creates a selection button. Several styles are allowed for this button: SWT.RADIO, SWT.CHECK, SWT.TOGGLE, SWT.PUSH

Parameters:

buttonStyle - Style to be applied to the button.

SelectionButtonField

public SelectionButtonField(IWidgetFactory widgetFactory,
                            int buttonStyle)

Method Detail

attachDialogField

public void attachDialogField(BasicField basicField)

Attaches a field to the selection state of the selection button. The attached field will be disabled if the selection button is not selected.

attachDialogFields

public void attachDialogFields(BasicField[] dialogFields)

Attaches fields to the selection state of the selection button. The attached fields will be disabled if the selection button is not selected.

isAttached

public boolean isAttached(BasicField editor)

Returns true is the given field is attached to the selection button.

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

getSelectionButton

public org.eclipse.swt.widgets.Button getSelectionButton(org.eclipse.swt.widgets.Composite group)

Returns the selection button widget. When called the first time, the widget will be created.

Parameters:

group - The parent composite when called the first time, or null after.

getButtonControl

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

setLabelText

public void setLabelText(java.lang.String labeltext)

Description copied from interface: IField

Sets the label of the dialog field.

Specified by:

setLabelText in interface IField

Overrides:

setLabelText in class BasicField

Parameters:

labeltext - The text of the label.

setToolTipText

public void setToolTipText(java.lang.String toolTip)

Description copied from interface: IField

Sets the tool tip of the dialog field.

Specified by:

setToolTipText in interface IField

Overrides:

setToolTipText in class BasicField

Parameters:

toolTip - The text to use as tool tip.

isSelected

public boolean isSelected()

Returns the selection state of the button.

setSelection

public void setSelection(boolean selected)

Sets the selection state of the button.

setSelectionWithoutEvent

public void setSelectionWithoutEvent(boolean selected)

Set button selection without triggering "dialog field changed" event.

Parameters:

selected - The expected selection state of the button.

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

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