public class BooleanFieldEditor extends FieldEditor
Modifier and Type | Field and Description |
---|---|
static int |
DEFAULT
Style constant (value
0 ) indicating the default layout where
the field editor's check box appears to the left of the label. |
static int |
SEPARATE_LABEL
Style constant (value
1 ) indicating a layout where the field
editor's label appears on the left with a check box on the right. |
HORIZONTAL_GAP, IS_VALID, VALUE
Modifier | Constructor and Description |
---|---|
protected |
BooleanFieldEditor()
Creates a new boolean field editor
|
|
BooleanFieldEditor(String name,
String label,
Composite parent)
Creates a boolean field editor in the default style.
|
|
BooleanFieldEditor(String name,
String labelText,
int style,
Composite parent)
Creates a boolean field editor in the given style.
|
Modifier and Type | Method and Description |
---|---|
protected 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 |
doLoadDefault()
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 |
getBooleanValue()
Returns this field editor's current value.
|
protected Button |
getChangeControl(Composite parent)
Returns the change button for this field editor.
|
Control |
getDescriptionControl(Composite parent)
Returns the control responsible for displaying this field editor's label.
|
int |
getNumberOfControls()
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. |
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
public static final int DEFAULT
0
) indicating the default layout where
the field editor's check box appears to the left of the label.public static final int SEPARATE_LABEL
1
) indicating a layout where the field
editor's label appears on the left with a check box on the right.protected BooleanFieldEditor()
public BooleanFieldEditor(String name, String labelText, int style, Composite parent)
name
- the name of the preference this field editor works onlabelText
- the label text of the field editorstyle
- the style, either DEFAULT
or
SEPARATE_LABEL
parent
- the parent of the field editor's controlDEFAULT
,
SEPARATE_LABEL
public BooleanFieldEditor(String name, String label, Composite parent)
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 controlprotected void adjustForNumColumns(int numColumns)
FieldEditor
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.
adjustForNumColumns
in class FieldEditor
numColumns
- the number of columnsprotected void doFillIntoGrid(Composite parent, int numColumns)
FieldEditor
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.
doFillIntoGrid
in class FieldEditor
parent
- the composite used as a parent for the basic controls;
the parent's layout must be a GridLayout
numColumns
- the number of columnspublic Control getDescriptionControl(Composite parent)
BooleanFieldEditor
. Note that the normal pattern of
getLabelControl(parent).setToolTipText(tooltipText)
does not
work for boolean field editors, as it can lead to duplicate text (see bug
259952).parent
- the parent compositeprotected void doLoad()
FieldEditor
Subclasses must implement this method to properly initialize the field editor.
doLoad
in class FieldEditor
protected void doLoadDefault()
FieldEditor
Subclasses must implement this method to properly initialize the field editor.
doLoadDefault
in class FieldEditor
protected void doStore()
FieldEditor
Subclasses must implement this method to save the entered value into the preference store.
doStore
in class FieldEditor
public boolean getBooleanValue()
protected Button getChangeControl(Composite parent)
parent
- The Composite to create the receiver in.public int getNumberOfControls()
FieldEditor
getNumberOfControls
in class FieldEditor
public void setFocus()
FieldEditor
The default implementation of this framework method does nothing. Subclasses may reimplement.
setFocus
in class FieldEditor
public void setLabelText(String text)
FieldEditor
setLabelText
in class FieldEditor
text
- the label textprotected void valueChanged(boolean oldValue, boolean newValue)
VALUE
property) provided that the old and new
values are different.oldValue
- the old valuenewValue
- the new valuepublic void setEnabled(boolean enabled, Composite parent)
FieldEditor
setEnabled
in class FieldEditor
enabled
- The enabled state.parent
- The parent of the controls in the group.
Used to create the controls if required.
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.