public static class Options.EditableComboBoxOption extends Options.Option<String,GComboBox>
XMLSerializable.OldVersionCompatible, XMLSerializable.VersionSupportTypeROOT_ELEMENT_NAME| Modifier and Type | Method and Description |
|---|---|
protected GComboBox |
createComponent()
Create a graphical component representing this option.
|
protected String |
getExtraPersistentInformation()
Gets any information in addition to the option value that should be
persistent between instances.
|
protected String |
getPossibleValues()
Provide a descriptive string representation of possible values of this option.
|
String[] |
getSelectableValues()
return the current selectable values that the option has.
|
String |
getValueFromString(String value)
Convert a String into an instance of the object type used by this option.
|
void |
restoreDefault()
Restore this option to its default value
|
protected void |
setExtraPersistentInformation(String extras)
Sets any information in addition to the option value that should be
persistent between instances.
|
void |
setSelectableValues(String[] selectableValues)
Replace the selectable values that this Option has.
|
protected void |
setValueOnComponent(GComboBox component,
String value)
Set the value on this component.
|
org.jdom.Element |
toXML()
Convert object to a JDOM element.
|
addChangeListener, addChildOptionsDependent, addDependent, fromXML, generateValidValue, getComponent, getDefaultValue, getDescription, getDescriptionAndState, getDisplayedLabel, getLabel, getName, getParentOptions, getValue, getValueAsString, getValueAsString, getVerticalWeight, handleSetEnabled, hideWarningMessage, isAdvanced, isEnabled, isFillHorizontalSpace, isProOnly, isRestoreDefaultApplies, isRestorePreferenceApplies, isSpanningComponent, isVisible, moveToOptions, removeChangeListener, setAdvanced, setAlwaysUsesDefaultPreferenceLocation, setDefaultValue, setDescription, setDisabledValue, setEnabled, setFillHorizontalSpace, setHidden, setLabelComponent, setPreferredHeight, setPreferredWidth, setProOnly, setRestoreDefaultApplies, setRestorePreferenceApplies, setShouldSaveValue, setSpanningComponent, setValue, setValue, setValueFromString, setVerticalWeight, setVisible, setWarningMessage, shouldSaveValue, toStringpublic org.jdom.Element toXML()
XMLSerializableXMLSerializable.fromXML(org.jdom.Element) can completely
restore the objects representation.
It is recommended that the returned element use XMLSerializable.ROOT_ELEMENT_NAME as its name,
in which case it must not define an attribute called "type". In this case,
fromXML, will be called with an element whose name may differ from the element
return from this function. This recommendation allows a more compact representation
of the XML can be stored.
This method generally should not be called directly. Instead, you should usually call
XMLSerializer.classToXML(String, XMLSerializable)
which calls this method internally.
PluginDocument implementations of this method may choose to throw an XMLSerializationException,
enclosed in a RuntimeException.toXML in interface XMLSerializabletoXML in class Options.Option<String,GComboBox>protected String getPossibleValues()
Options.OptionOptions.ComboBoxOrRadioOption.getPossibleOptionValues() to
get possible values as a List of OptionValues.getPossibleValues in class Options.Option<String,GComboBox>Options.ComboBoxOrRadioOption.getPossibleOptionValues()public String getValueFromString(String value)
Options.OptionOptions.Option.getValueAsString(Object) .getValueFromString in class Options.Option<String,GComboBox>value - the string representation of the object valueprotected void setValueOnComponent(GComboBox component, String value)
Options.OptionsetValueOnComponent in class Options.Option<String,GComboBox>component - a component return from Options.Option.createComponent()value - the value to set.protected String getExtraPersistentInformation()
Options.OptiongetExtraPersistentInformation in class Options.Option<String,GComboBox>protected void setExtraPersistentInformation(String extras)
Options.OptionsetExtraPersistentInformation in class Options.Option<String,GComboBox>extras - any additional persistent information or null if this option has none.protected GComboBox createComponent()
Options.OptionOptions.Option.getValue().
The implementation is also responsible for making sure that the returned component
listens to any changes made to itself and
reflects those changes in the value of this option
using the Options.Option.setValue(Object) method.
This method will only be called once for each instance of an Option.
After it has been called, getComponent() will return a cached copy of it.createComponent in class Options.Option<String,GComboBox>public void setSelectableValues(String[] selectableValues)
selectableValues - some selectable values to display in the drop down box.public String[] getSelectableValues()
public void restoreDefault()
Options.OptionrestoreDefault in class Options.Option<String,GComboBox>