|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.eclipse.jface.preference.FieldEditor
org.eclipse.jface.preference.RadioGroupFieldEditor
public class RadioGroupFieldEditor
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 | |
|---|---|
protected |
RadioGroupFieldEditor()
Creates a new radio group field editor |
|
RadioGroupFieldEditor(java.lang.String name,
java.lang.String labelText,
int numColumns,
java.lang.String[][] labelAndValues,
Composite parent)
Creates a radio group field editor. |
|
RadioGroupFieldEditor(java.lang.String name,
java.lang.String labelText,
int numColumns,
java.lang.String[][] labelAndValues,
Composite parent,
boolean useGroup)
Creates a radio group field editor. |
| Method Summary | |
|---|---|
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. |
int |
getNumberOfControls()
Returns the number of basic controls this field editor consists of. |
Composite |
getRadioBoxControl(Composite parent)
Returns this field editor's radio group control. |
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 java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
protected RadioGroupFieldEditor()
public RadioGroupFieldEditor(java.lang.String name,
java.lang.String labelText,
int numColumns,
java.lang.String[][] labelAndValues,
Composite parent)
Group to contain the radio buttons.
It is equivalent to using the following constructor with false
for the useGroup argument.
Example usage:
RadioGroupFieldEditor editor= new RadioGroupFieldEditor(
"GeneralPage.DoubleClick", resName, 1,
new String[][] {
{"Open Browser", "open"},
{"Expand Tree", "expand"}
},
parent);
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
public RadioGroupFieldEditor(java.lang.String name,
java.lang.String labelText,
int numColumns,
java.lang.String[][] labelAndValues,
Composite parent,
boolean useGroup)
Example usage:
RadioGroupFieldEditor editor= new RadioGroupFieldEditor(
"GeneralPage.DoubleClick", resName, 1,
new String[][] {
{"Open Browser", "open"},
{"Expand Tree", "expand"}
},
parent,
true);
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 |
|---|
protected void adjustForNumColumns(int numColumns)
FieldEditorSubclasses 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 FieldEditornumColumns - the number of columns
protected void doFillIntoGrid(Composite parent,
int numColumns)
FieldEditorSubclasses 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 FieldEditorparent - the composite used as a parent for the basic controls;
the parent's layout must be a GridLayoutnumColumns - the number of columnsprotected void doLoad()
FieldEditorSubclasses must implement this method to properly initialize the field editor.
doLoad in class FieldEditorprotected void doLoadDefault()
FieldEditorSubclasses must implement this method to properly initialize the field editor.
doLoadDefault in class FieldEditorprotected void doStore()
FieldEditorSubclasses must implement this method to save the entered value into the preference store.
doStore in class FieldEditorpublic int getNumberOfControls()
FieldEditor
getNumberOfControls in class FieldEditorpublic Composite getRadioBoxControl(Composite parent)
parent - The parent to create the radioBox in
public void setIndent(int indent)
indent - the indent (in pixels)
public void setEnabled(boolean enabled,
Composite parent)
FieldEditor
setEnabled in class FieldEditorenabled - The enabled state.parent - The parent of the controls in the group.
Used to create the controls if required.
|
Eclipse Platform Release 3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2010. All rights reserved.