Class RadioGroupFieldEditor
- java.lang.Object
-
- org.eclipse.jface.preference.FieldEditor
-
- org.eclipse.jface.preference.RadioGroupFieldEditor
-
public class RadioGroupFieldEditor extends FieldEditor
A field editor for an enumeration type preference. The choices are presented as a list of radio buttons.
-
-
Field Summary
-
Fields inherited from class org.eclipse.jface.preference.FieldEditor
HORIZONTAL_GAP, IS_VALID, VALUE
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedRadioGroupFieldEditor()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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected voidadjustForNumColumns(int numColumns)Adjusts the horizontal span of this field editor's basic controls.protected voiddoFillIntoGrid(Composite parent, int numColumns)Fills this field editor's basic controls into the given parent.protected voiddoLoad()Initializes this field editor with the preference value from the preference store.protected voiddoLoadDefault()Initializes this field editor with the default preference value from the preference store.protected voiddoStore()Stores the preference value from this field editor into the preference store.intgetNumberOfControls()Returns the number of basic controls this field editor consists of.CompositegetRadioBoxControl(Composite parent)Returns this field editor's radio group control.StringgetSelectionValue()Returns this field editor's current selected value.voidsetEnabled(boolean enabled, Composite parent)Set whether or not the controls in the field editor are enabled.voidsetIndent(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 Detail
-
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 aGroupto contain the radio buttons. It is equivalent to using the following constructor withfalsefor theuseGroupargument.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 Detail
-
adjustForNumColumns
protected void adjustForNumColumns(int numColumns)
Description copied from class:FieldEditorAdjusts 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
getNumberOfControlsmethod.- Specified by:
adjustForNumColumnsin classFieldEditor- Parameters:
numColumns- the number of columns
-
doFillIntoGrid
protected void doFillIntoGrid(Composite parent, int numColumns)
Description copied from class:FieldEditorFills 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:
doFillIntoGridin classFieldEditor- Parameters:
parent- the composite used as a parent for the basic controls; the parent's layout must be aGridLayoutnumColumns- the number of columns
-
doLoad
protected void doLoad()
Description copied from class:FieldEditorInitializes this field editor with the preference value from the preference store.Subclasses must implement this method to properly initialize the field editor.
- Specified by:
doLoadin classFieldEditor
-
doLoadDefault
protected void doLoadDefault()
Description copied from class:FieldEditorInitializes 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:
doLoadDefaultin classFieldEditor
-
doStore
protected void doStore()
Description copied from class:FieldEditorStores 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:
doStorein classFieldEditor
-
getSelectionValue
public String getSelectionValue()
Returns this field editor's current selected value.- Returns:
- current selected value
- Since:
- 3.18
-
getNumberOfControls
public int getNumberOfControls()
Description copied from class:FieldEditorReturns the number of basic controls this field editor consists of.- Specified by:
getNumberOfControlsin classFieldEditor- Returns:
- the number of controls
-
getRadioBoxControl
public Composite getRadioBoxControl(Composite parent)
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
public void setEnabled(boolean enabled, Composite parent)Description copied from class:FieldEditorSet whether or not the controls in the field editor are enabled.- Overrides:
setEnabledin classFieldEditor- Parameters:
enabled- The enabled state.parent- The parent of the controls in the group. Used to create the controls if required.
-
-