org.eclipse.eavp.viz.service.connections.preferences

Class DynamicComboFieldEditor

java.lang.Object

org.eclipse.jface.preference.FieldEditor

org.eclipse.eavp.viz.service.connections.preferences.DynamicComboFieldEditor

public class DynamicComboFieldEditor
extends org.eclipse.jface.preference.FieldEditor

This class provides a field editor with an underlying Combo.

The major difference between this class and the default JFace ComboFieldEditor is that this editor provides hooks to update the current value and the allowed values for the editor. This is important if the preference page needs to update a list of allowed preference values when some other preference changes.

Author:

Jordan Deyton

Field Summary

Fields inherited from class org.eclipse.jface.preference.FieldEditor

IS_VALID, VALUE

Constructor Summary

Constructors

Constructor and Description
DynamicComboFieldEditor(java.lang.String name, java.lang.String labelText, org.eclipse.swt.widgets.Composite parent, java.util.List<java.lang.String> allowedValues) The default constructor.

Method Summary

Modifier and Type	Method and Description
int	getIndex() Gets the index of the currently selected value from the field editor.
int	getNumberOfControls()
java.lang.String	getValue() Gets the currently selected value from the field editor.
void	setAllowedValues(java.util.List<java.lang.String> newValues) Sets the allowed values displayed in the underlying combo.
void	setValue(int index) Sets the currently selected value in the field editor.
void	setValue(java.lang.String value) Sets the currently selected value in the field editor.

Methods inherited from class org.eclipse.jface.preference.FieldEditor

dispose, fillIntoGrid, getFieldEditorFontName, getLabelControl, getLabelText, getPreferenceName, getPreferenceStore, isValid, load, loadDefault, presentsDefaultValue, setEnabled, setFocus, setLabelText, setPage, setPreferenceName, setPreferencePage, setPreferenceStore, setPropertyChangeListener, store

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DynamicComboFieldEditor

public DynamicComboFieldEditor(java.lang.String name,
                               java.lang.String labelText,
                               org.eclipse.swt.widgets.Composite parent,
                               java.util.List<java.lang.String> allowedValues)

The default constructor.

Parameters:

name - The name of the preference this field editor works on.

labelText - The label text of the field editor (seen by the user).

parent - The parent Control for this field editor.

allowedValues - The current list of allowed values displayed in the combo.

Method Detail

getIndex

public int getIndex()

Gets the index of the currently selected value from the field editor.

Note:This value may not yet be in the preference store.

Returns:

The index of the selected value in the combo.

getNumberOfControls

public int getNumberOfControls()

Specified by:

getNumberOfControls in class org.eclipse.jface.preference.FieldEditor

getValue

public java.lang.String getValue()

Gets the currently selected value from the field editor.

Note:This value may not yet be in the preference store.

Returns:

The currently selected value.

setAllowedValues

public void setAllowedValues(java.util.List<java.lang.String> newValues)

Sets the allowed values displayed in the underlying combo.

Parameters:

newValues - The new list of values. If null, nothing is done.

setValue

public void setValue(int index)

Sets the currently selected value in the field editor.

Note:This value will not be put in the preference store from this operation.

Parameters:

index - The index of the new value. Nothing is done if the index is invalid.

setValue

public void setValue(java.lang.String value)

Sets the currently selected value in the field editor.

Note:This value will not be put in the preference store from this operation.

Parameters:

value - The new value. Nothing is done if the value cannot be found in the allowed values.