|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.eclipse.jface.preference.FieldEditor | +--org.eclipse.jface.preference.ListEditor
An abstract field editor that manages a list of input values. The editor displays a list containing the values, buttons for adding and removing values, and Up and Down buttons to adjust the order of elements in the list.
Subclasses must implement the parseString
,
createList
, and createNewInputObject
framework methods.
Field Summary |
Fields inherited from class org.eclipse.jface.preference.FieldEditor |
HORIZONTAL_GAP, IS_VALID, VALUE |
Constructor Summary | |
protected |
ListEditor()
Creates a new list field editor |
protected |
ListEditor(String name,
String labelText,
Composite parent)
Creates a list field editor. |
Method Summary | |
protected void |
adjustForNumColumns(int numColumns)
Adjusts the horizontal span of this field editor's basic controls |
protected abstract String |
createList(String[] items)
Combines the given list of items into a single string. |
void |
createSelectionListener()
Creates a selection listener. |
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. |
Composite |
getButtonBoxControl(Composite parent)
Returns this field editor's button box containing the Add, Remove, Up, and Down button. |
List |
getListControl(Composite parent)
Returns this field editor's list control. |
protected abstract String |
getNewInputObject()
Creates and returns a new item for the list. |
int |
getNumberOfControls()
Returns the number of basic controls this field editor consists of. |
protected Shell |
getShell()
Returns this field editor's shell. |
protected abstract String[] |
parseString(String stringList)
Splits the given string into a list of strings. |
void |
setFocus()
Sets the focus to this field editor. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
protected ListEditor()
protected ListEditor(String name, String labelText, Composite parent)
name
- the name of the preference this field editor works onlabelText
- the label text of the field editorparent
- the parent of the field editor's controlMethod Detail |
protected 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 abstract String createList(String[] items)
parseString
.
Subclasses must implement this method.
items
- the list of items
parseString(java.lang.String)
public void createSelectionListener()
protected void doFillIntoGrid(Composite parent, int numColumns)
FieldEditor
Subclasses must implement this method to create the controls for this field editor.
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 columnsprotected 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 Composite getButtonBoxControl(Composite parent)
parent
- the parent control
public List getListControl(Composite parent)
parent
- the parent control
protected abstract String getNewInputObject()
Subclasses must implement this method.
public int getNumberOfControls()
FieldEditor
getNumberOfControls
in class FieldEditor
protected Shell getShell()
This method is internal to the framework; subclassers should not call this method.
protected abstract String[] parseString(String stringList)
createList
.
Subclasses must implement this method.
stringList
- the string
String
createList(java.lang.String[])
public void setFocus()
FieldEditor
The default implementation of this framework method does nothing. Subclasses may reimplement.
setFocus
in class FieldEditor
|
Eclipse Platform 2.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |