public abstract class ListEditor extends FieldEditor
Subclasses must implement the parseString
,
createList
, and getNewInputObject
framework methods.
HORIZONTAL_GAP, IS_VALID, VALUE
Modifier | Constructor and Description |
---|---|
protected |
ListEditor()
Creates a new list field editor
|
protected |
ListEditor(String name,
String labelText,
Composite parent)
Creates a list field editor.
|
Modifier and Type | Method and Description |
---|---|
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.
|
protected Button |
getAddButton()
Return the Add button.
|
Composite |
getButtonBoxControl(Composite parent)
Returns this field editor's button box containing the Add, Remove,
Up, and Down button.
|
protected Button |
getDownButton()
Return the Down button.
|
protected List |
getList()
Return the List.
|
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 Button |
getRemoveButton()
Return the Remove button.
|
protected Shell |
getShell()
Returns this field editor's shell.
|
protected Button |
getUpButton()
Return the Up button.
|
protected abstract String[] |
parseString(String stringList)
Splits the given string into a list of strings.
|
protected void |
selectionChanged()
Invoked when the selection in the list has changed.
|
void |
setEnabled(boolean enabled,
Composite parent)
Set whether or not the controls in the field editor
are enabled.
|
void |
setFocus()
Sets the focus to this field editor.
|
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
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 itemsparseString(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.
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 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 controlpublic List getListControl(Composite parent)
parent
- the parent controlprotected 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 stringString
createList(java.lang.String[])
protected void selectionChanged()
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.
public void setFocus()
FieldEditor
The default implementation of this framework method does nothing. Subclasses may reimplement.
setFocus
in class FieldEditor
public void setEnabled(boolean enabled, Composite parent)
FieldEditor
setEnabled
in class FieldEditor
enabled
- The enabled state.parent
- The parent of the controls in the group.
Used to create the controls if required.protected Button getAddButton()
protected Button getRemoveButton()
protected Button getUpButton()
protected Button getDownButton()
protected List getList()
Copyright (c) 2000, 2014 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.