Class RadioGroupFieldEditor
-
Field Summary
Fields inherited from class org.eclipse.jface.preference.FieldEditor
HORIZONTAL_GAP, IS_VALID, VALUE
-
Constructor Summary
ModifierConstructorDescriptionprotected
Creates a new radio group field editorRadioGroupFieldEditor
(String name, String labelText, int numColumns, String[][] labelAndValues, Composite parent) Creates a radio group field editor.RadioGroupFieldEditor
(String name, String labelText, int numColumns, String[][] labelAndValues, Composite parent, boolean useGroup) Creates a radio group field editor. -
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.int
Returns the number of basic controls this field editor consists of.getRadioBoxControl
(Composite parent) Returns this field editor's radio group control.Returns this field editor's current selected value.void
setEnabled
(boolean enabled, Composite parent) Set whether or not the controls in the field editor are enabled.void
setIndent
(int indent) Sets the indent used for the first column of the radion button matrix.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, setFocus, setLabelText, setPage, setPreferenceName, setPreferencePage, setPreferenceStore, setPresentsDefaultValue, setPropertyChangeListener, showErrorMessage, showMessage, store
-
Constructor Details
-
RadioGroupFieldEditor
protected RadioGroupFieldEditor()Creates a new radio group field editor -
RadioGroupFieldEditor
public RadioGroupFieldEditor(String name, String labelText, int numColumns, String[][] labelAndValues, Composite parent) Creates a radio group field editor. This constructor does not use aGroup
to contain the radio buttons. It is equivalent to using the following constructor withfalse
for theuseGroup
argument.Example usage:
RadioGroupFieldEditor editor= new RadioGroupFieldEditor( "GeneralPage.DoubleClick", resName, 1, new String[][] {{"Open Browser", "open"}, {"Expand Tree", "expand"}}, parent);
- Parameters:
name
- the name of the preference this field editor works onlabelText
- the label text of the field editornumColumns
- the number of columns for the radio button presentationlabelAndValues
- list of radio button [label, value] entries; the value is returned when the radio button is selectedparent
- the parent of the field editor's control
-
RadioGroupFieldEditor
public RadioGroupFieldEditor(String name, String labelText, int numColumns, String[][] labelAndValues, Composite parent, boolean useGroup) Creates a radio group field editor.Example usage:
RadioGroupFieldEditor editor= new RadioGroupFieldEditor( "GeneralPage.DoubleClick", resName, 1, new String[][] { {"Open Browser", "open"}, {"Expand Tree", "expand"} }, parent, true);
- Parameters:
name
- the name of the preference this field editor works onlabelText
- the label text of the field editornumColumns
- the number of columns for the radio button presentationlabelAndValues
- list of radio button [label, value] entries; the value is returned when the radio button is selectedparent
- the parent of the field editor's controluseGroup
- whether to use a Group control to contain the radio buttons
-
-
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
-
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
-
getSelectionValue
Returns this field editor's current selected value.- Returns:
- current selected value
- Since:
- 3.18
-
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
-
getRadioBoxControl
Returns this field editor's radio group control.- Parameters:
parent
- The parent to create the radioBox in- Returns:
- the radio group control
-
setIndent
public void setIndent(int indent) Sets the indent used for the first column of the radion button matrix.- Parameters:
indent
- the indent (in pixels)
-
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.
-