|
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.ComboFieldEditor
public class ComboFieldEditor
A field editor for a combo box that allows the drop-down selection of one of a list of items.
| Field Summary |
|---|
| Fields inherited from class org.eclipse.jface.preference.FieldEditor |
|---|
HORIZONTAL_GAP, IS_VALID, VALUE |
| Constructor Summary | |
|---|---|
ComboFieldEditor(java.lang.String name,
java.lang.String labelText,
java.lang.String[][] entryNamesAndValues,
Composite parent)
Create the combo box 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. |
void |
setEnabled(boolean enabled,
Composite parent)
Set whether or not the controls in the field editor are enabled. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public ComboFieldEditor(java.lang.String name,
java.lang.String labelText,
java.lang.String[][] entryNamesAndValues,
Composite parent)
name - the name of the preference this field editor works onlabelText - the label text of the field editorentryNamesAndValues - the names (labels) and underlying values to populate the combo widget. These should be
arranged as: { {name1, value1}, {name2, value2}, ...}parent - the parent composite| 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 FieldEditor
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.