Class ListEditor
- java.lang.Object
-
- org.eclipse.jface.preference.FieldEditor
-
- org.eclipse.jface.preference.ListEditor
-
- Direct Known Subclasses:
PathEditor
public abstract class ListEditor extends FieldEditor
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, andgetNewInputObjectframework methods.
-
-
Field Summary
-
Fields inherited from class org.eclipse.jface.preference.FieldEditor
HORIZONTAL_GAP, IS_VALID, VALUE
-
-
Constructor Summary
Constructors Modifier Constructor Description protectedListEditor()Creates a new list field editorprotectedListEditor(String name, String labelText, Composite parent)Creates a list field editor.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected voidadjustForNumColumns(int numColumns)Adjusts the horizontal span of this field editor's basic controls.protected abstract StringcreateList(String[] items)Combines the given list of items into a single string.voidcreateSelectionListener()Creates a selection listener.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.protected ButtongetAddButton()Return the Add button.CompositegetButtonBoxControl(Composite parent)Returns this field editor's button box containing the Add, Remove, Up, and Down button.protected ButtongetDownButton()Return the Down button.protected ListgetList()Return the List.ListgetListControl(Composite parent)Returns this field editor's list control.protected abstract StringgetNewInputObject()Creates and returns a new item for the list.intgetNumberOfControls()Returns the number of basic controls this field editor consists of.protected ButtongetRemoveButton()Return the Remove button.protected ShellgetShell()Returns this field editor's shell.protected ButtongetUpButton()Return the Up button.protected abstract String[]parseString(String stringList)Splits the given string into a list of strings.protected voidselectionChanged()Invoked when the selection in the list has changed.voidsetEnabled(boolean enabled, Composite parent)Set whether or not the controls in the field editor are enabled.voidsetFocus()Sets the focus to this field editor.-
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, setLabelText, setPage, setPreferenceName, setPreferencePage, setPreferenceStore, setPresentsDefaultValue, setPropertyChangeListener, showErrorMessage, showMessage, store
-
-
-
-
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
-
createList
protected abstract String createList(String[] items)
Combines the given list of items into a single string. This method is the converse ofparseString.Subclasses must implement this method.
- Parameters:
items- the list of items- Returns:
- the combined string
- See Also:
parseString(java.lang.String)
-
createSelectionListener
public void createSelectionListener()
Creates a selection listener.
-
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
-
getButtonBoxControl
public Composite getButtonBoxControl(Composite parent)
Returns this field editor's button box containing the Add, Remove, Up, and Down button.- Parameters:
parent- the parent control- Returns:
- the button box
-
getListControl
public List getListControl(Composite parent)
Returns this field editor's list control.- Parameters:
parent- the parent control- Returns:
- the list control
-
getNewInputObject
protected abstract String getNewInputObject()
Creates and returns a new item for the list.Subclasses must implement this method.
- Returns:
- a new item
-
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
-
getShell
protected Shell getShell()
Returns this field editor's shell.This method is internal to the framework; subclassers should not call this method.
- Returns:
- the shell
-
parseString
protected abstract String[] parseString(String stringList)
Splits the given string into a list of strings. This method is the converse ofcreateList.Subclasses must implement this method.
- Parameters:
stringList- the string- Returns:
- an array of
String - See Also:
createList(java.lang.String[])
-
selectionChanged
protected void selectionChanged()
Invoked when the selection in the list has changed.The default implementation of this method utilizes the selection index and the size of the list to toggle the enablement of the up, down and remove buttons.
Sublcasses may override.
- Since:
- 3.5
-
setFocus
public void setFocus()
Description copied from class:FieldEditorSets the focus to this field editor.The default implementation of this framework method does nothing. Subclasses may reimplement.
- Overrides:
setFocusin classFieldEditor
-
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.
-
getAddButton
protected Button getAddButton()
Return the Add button.- Returns:
- the button
- Since:
- 3.5
-
getRemoveButton
protected Button getRemoveButton()
Return the Remove button.- Returns:
- the button
- Since:
- 3.5
-
getUpButton
protected Button getUpButton()
Return the Up button.- Returns:
- the button
- Since:
- 3.5
-
getDownButton
protected Button getDownButton()
Return the Down button.- Returns:
- the button
- Since:
- 3.5
-
getList
protected List getList()
Return the List.- Returns:
- the list
- Since:
- 3.5
-
-