Class BooleanFieldEditor
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
Style constant (value0
) indicating the default layout where the field editor's check box appears to the left of the label.static final int
Style constant (value1
) indicating a layout where the field editor's label appears on the left with a check box on the right.Fields inherited from class org.eclipse.jface.preference.FieldEditor
HORIZONTAL_GAP, IS_VALID, VALUE
-
Constructor Summary
ModifierConstructorDescriptionprotected
Creates a new boolean field editorBooleanFieldEditor
(String name, String labelText, int style, Composite parent) Creates a boolean field editor in the given style.BooleanFieldEditor
(String name, String label, Composite parent) Creates a boolean field editor in the default style. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
adjustForNumColumns
(int numColumns) Adjusts the horizontal span of this field editor's basic controls.protected void
doFillIntoGrid
(Composite parent, int numColumns) Fills this field editor's basic controls into the given parent.protected void
doLoad()
Initializes this field editor with the preference value from the preference store.protected void
Initializes this field editor with the default preference value from the preference store.protected void
doStore()
Stores the preference value from this field editor into the preference store.boolean
Returns this field editor's current value.protected Button
getChangeControl
(Composite parent) Returns the change button for this field editor.getDescriptionControl
(Composite parent) Returns the control responsible for displaying this field editor's label.int
Returns the number of basic controls this field editor consists of.void
setEnabled
(boolean enabled, Composite parent) Set whether or not the controls in the field editor are enabled.void
setFocus()
Sets the focus to this field editor.void
setLabelText
(String text) Sets this field editor's label text.protected void
valueChanged
(boolean oldValue, boolean newValue) Informs this field editor's listener, if it has one, about a change to the value (VALUE
property) provided that the old and new values are different.Methods inherited from class org.eclipse.jface.preference.FieldEditor
applyFont, checkParent, clearErrorMessage, clearMessage, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, createControl, dispose, fillIntoGrid, fireStateChanged, fireValueChanged, getFieldEditorFontName, getLabelControl, getLabelControl, getLabelText, getPage, getPreferenceName, getPreferencePage, getPreferenceStore, init, isValid, load, loadDefault, presentsDefaultValue, refreshValidState, setButtonLayoutData, setPage, setPreferenceName, setPreferencePage, setPreferenceStore, setPresentsDefaultValue, setPropertyChangeListener, showErrorMessage, showMessage, store
-
Field Details
-
DEFAULT
public static final int DEFAULTStyle constant (value0
) indicating the default layout where the field editor's check box appears to the left of the label.- See Also:
-
SEPARATE_LABEL
public static final int SEPARATE_LABELStyle constant (value1
) indicating a layout where the field editor's label appears on the left with a check box on the right.- See Also:
-
-
Constructor Details
-
BooleanFieldEditor
protected BooleanFieldEditor()Creates a new boolean field editor -
BooleanFieldEditor
Creates a boolean field editor in the given style.- Parameters:
name
- the name of the preference this field editor works onlabelText
- the label text of the field editorstyle
- the style, eitherDEFAULT
orSEPARATE_LABEL
parent
- the parent of the field editor's control- See Also:
-
BooleanFieldEditor
Creates a boolean field editor in the default style.- Parameters:
name
- the name of the preference this field editor works onlabel
- the label text of the field editorparent
- the parent of the field editor's control
-
-
Method Details
-
adjustForNumColumns
protected void adjustForNumColumns(int numColumns) Description copied from class:FieldEditor
Adjusts the horizontal span of this field editor's basic controls.Subclasses must implement this method to adjust the horizontal span of controls so they appear correct in the given number of columns.
The number of columns will always be equal to or greater than the value returned by this editor's
getNumberOfControls
method.- Specified by:
adjustForNumColumns
in classFieldEditor
- Parameters:
numColumns
- the number of columns
-
doFillIntoGrid
Description copied from class:FieldEditor
Fills this field editor's basic controls into the given parent.Subclasses must implement this method to create the controls for this field editor.
Note this method may be called by the constructor, so it must not access fields on the receiver object because they will not be fully initialized.
- Specified by:
doFillIntoGrid
in classFieldEditor
- Parameters:
parent
- the composite used as a parent for the basic controls; the parent's layout must be aGridLayout
numColumns
- the number of columns
-
getDescriptionControl
Returns the control responsible for displaying this field editor's label. This method can be used to set a tooltip for aBooleanFieldEditor
. Note that the normal pattern ofgetLabelControl(parent).setToolTipText(tooltipText)
does not work for boolean field editors, as it can lead to duplicate text (see bug 259952).- Parameters:
parent
- the parent composite- Returns:
- the control responsible for displaying the label
- Since:
- 3.5
-
doLoad
protected void doLoad()Description copied from class:FieldEditor
Initializes this field editor with the preference value from the preference store.Subclasses must implement this method to properly initialize the field editor.
- Specified by:
doLoad
in classFieldEditor
-
doLoadDefault
protected void doLoadDefault()Description copied from class:FieldEditor
Initializes this field editor with the default preference value from the preference store.Subclasses must implement this method to properly initialize the field editor.
- Specified by:
doLoadDefault
in classFieldEditor
-
doStore
protected void doStore()Description copied from class:FieldEditor
Stores the preference value from this field editor into the preference store.Subclasses must implement this method to save the entered value into the preference store.
- Specified by:
doStore
in classFieldEditor
-
getBooleanValue
public boolean getBooleanValue()Returns this field editor's current value.- Returns:
- the value
-
getChangeControl
Returns the change button for this field editor.- Parameters:
parent
- The Composite to create the receiver in.- Returns:
- the change button
-
getNumberOfControls
public int getNumberOfControls()Description copied from class:FieldEditor
Returns the number of basic controls this field editor consists of.- Specified by:
getNumberOfControls
in classFieldEditor
- Returns:
- the number of controls
-
setFocus
public void setFocus()Description copied from class:FieldEditor
Sets the focus to this field editor.The default implementation of this framework method does nothing. Subclasses may reimplement.
- Overrides:
setFocus
in classFieldEditor
-
setLabelText
Description copied from class:FieldEditor
Sets this field editor's label text. The label is typically presented to the left of the entry field.- Overrides:
setLabelText
in classFieldEditor
- Parameters:
text
- the label text
-
valueChanged
protected void valueChanged(boolean oldValue, boolean newValue) Informs this field editor's listener, if it has one, about a change to the value (VALUE
property) provided that the old and new values are different.- Parameters:
oldValue
- the old valuenewValue
- the new value
-
setEnabled
Description copied from class:FieldEditor
Set whether or not the controls in the field editor are enabled.- Overrides:
setEnabled
in classFieldEditor
- Parameters:
enabled
- The enabled state.parent
- The parent of the controls in the group. Used to create the controls if required.
-