com.biomatters.geneious.publicapi.plugin

Class Options.ComboBoxOption<ValueType extends Options.OptionValue>

java.lang.Object

com.biomatters.geneious.publicapi.plugin.Options.Option<ValueType,ComponentType>

com.biomatters.geneious.publicapi.plugin.Options.ComboBoxOption<ValueType>

All Implemented Interfaces:

XMLSerializable

Enclosing class:

Options

public static class Options.ComboBoxOption<ValueType extends Options.OptionValue>
extends Options.Option<ValueType,ComponentType>

An option that provides the user with a list of options in a combo box

Nested Class Summary

Nested classes/interfaces inherited from interface com.biomatters.geneious.publicapi.documents.XMLSerializable

XMLSerializable.OldVersionCompatible, XMLSerializable.VersionSupportType

Field Summary

Fields inherited from interface com.biomatters.geneious.publicapi.documents.XMLSerializable

ROOT_ELEMENT_NAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Options.ComboBoxOption(org.jdom.Element e) Constructor for XML Serialization.
protected	Options.ComboBoxOption(String name, String label, List<? extends ValueType> possibleValues, ValueType defaultValue) Construct a new ComboBoxOption.
protected	Options.ComboBoxOption(String name, String label, ValueType[] options, ValueType defaultValue) Construct a new ComboBoxOption.

Method Summary

Methods

Modifier and Type	Method and Description
void	addPossibleValue(ValueType newValue) Add a new value for this option.
protected JComboBox	createComponent() Create a graphical component representing this option.
protected ValueType	generateValidValue(ValueType value) Converts a potentially invalid value into a valid one.
protected String	getPossibleValues() Provide a descriptive string representation of possible values of this option.
ValueType	getValueFromString(String valueString) Convert a String into an instance of the object type used by this option.
void	setAcceptsUnknownPossibleValues(boolean acceptsUnknownPossibleValues) Sets whether or not this combo box allows Options.Option.setValue(Object) or Options.setStringValue(String, String) to accept values not in the list of ComboBoxOrRadioOption#getPossibleOptionValues().
void	setPossibleValues(List<? extends ValueType> possibleValues) Set the values the user can select from in the combo box.
protected void	setValueOnComponent(JComboBox component, Options.OptionValue value) Set the value on this component.
org.jdom.Element	toXML() Convert object to a JDOM element.

Methods inherited from class com.biomatters.geneious.publicapi.plugin.Options.Option

addChangeListener, addChildOptionsDependent, addDependent, fromXML, getComponent, getDefaultValue, getDescription, getDescriptionAndState, getDisplayedLabel, getExtraPersistentInformation, getLabel, getName, getParentOptions, getValue, getValueAsString, getValueAsString, getVerticalWeight, handleSetEnabled, hideWarningMessage, isAdvanced, isEnabled, isFillHorizontalSpace, isProOnly, isRestoreDefaultApplies, isRestorePreferenceApplies, isSpanningComponent, isVisible, moveToOptions, removeChangeListener, restoreDefault, setAdvanced, setAlwaysUsesDefaultPreferenceLocation, setDefaultValue, setDescription, setDisabledValue, setEnabled, setExtraPersistentInformation, setFillHorizontalSpace, setHidden, setLabelComponent, setPreferredHeight, setPreferredWidth, setProOnly, setRestoreDefaultApplies, setRestorePreferenceApplies, setShouldSaveValue, setSpanningComponent, setValue, setValue, setValueFromString, setVerticalWeight, setVisible, setWarningMessage, shouldSaveValue, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Options.ComboBoxOption

protected Options.ComboBoxOption(org.jdom.Element e)
                          throws XMLSerializationException

Constructor for XML Serialization. See XMLSerializable

Throws:

XMLSerializationException

Options.ComboBoxOption

protected Options.ComboBoxOption(String name,
                      String label,
                      ValueType[] options,
                      ValueType defaultValue)

Construct a new ComboBoxOption. This is a list of options that are provided to the user graphically as a combo box.

Parameters:

name - the name to be used for referencing this option. For example from scripts or source code which wish to programmatically get or set the value of this option. Names should be in standard Java variable name style eg. "myAwesomeOption".

label - a label describing this option to be displayed to the user. eg. "My Awesome Option"

defaultValue - the default value for this option

options - An array containing all possible values (i.e. all the entries to appear in the combo box)

Options.ComboBoxOption

protected Options.ComboBoxOption(String name,
                      String label,
                      List<? extends ValueType> possibleValues,
                      ValueType defaultValue)

Construct a new ComboBoxOption. This is a list of options that are provided to the user graphically as a combo box.

Parameters:

name - the name to be used for referencing this option. For example from scripts or source code which wish to programmatically get or set the value of this option. Names should be in standard Java variable name style eg. "myAwesomeOption".

label - a label describing this option to be displayed to the user. eg. "My Awesome Option"

defaultValue - the default value for this option

possibleValues - A list containing all possible values (i.e. all the entries to appear in the combo box)

Method Detail

toXML

public org.jdom.Element toXML()

Description copied from interface: XMLSerializable

Convert object to a JDOM element. The representation should be complete so that XMLSerializable.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.

Specified by:

toXML in interface XMLSerializable

Overrides:

toXML in class Options.Option<ValueType extends Options.OptionValue,JComboBox>

Returns:

object encoded as a JDOM element

setPossibleValues

public void setPossibleValues(List<? extends ValueType> possibleValues)

Set the values the user can select from in the combo box. If the existing value is not in the list of new possible values, the existing value becomes the first new possible value.

Parameters:

possibleValues - A list containing all possible values (i.e. all the entries to appear in the combo box)

addPossibleValue

public void addPossibleValue(ValueType newValue)

Add a new value for this option. The value will be appended to the end of the ComboBox returned by getComponent() without changing the selection, i.e. the new value will initially not be selected.

Parameters:

newValue - New option value to add.

getPossibleValues

protected String getPossibleValues()

Description copied from class: Options.Option

Provide a descriptive string representation of possible values of this option. For example, combo box and radio options should provide a list of all available values. The default implementation returns null. Radio and ComboBox options provide Options.ComboBoxOrRadioOption.getPossibleOptionValues() to get possible values as a List of OptionValues.

Overrides:

getPossibleValues in class Options.Option<ValueType extends Options.OptionValue,JComboBox>

Returns:

a descriptive string representation of possible values of this option or null if this option may have any String value.

See Also:

Options.ComboBoxOrRadioOption.getPossibleOptionValues()

getValueFromString

public ValueType getValueFromString(String valueString)

Description copied from class: Options.Option

Convert a String into an instance of the object type used by this option. This method should generally create a new object every time it is invoked. Only disregard this advice if you know what you are doing - e.g. it is safe to maintain an object pool and return the same object more than once if your Option's ValueType is immutable.

This method is the inverse of Options.Option.getValueAsString(Object) .

Specified by:

getValueFromString in class Options.Option<ValueType extends Options.OptionValue,JComboBox>

Parameters:

valueString - the string representation of the object value

Returns:

the object value or the default value if the string representation is not valid.

createComponent

protected JComboBox createComponent()

Description copied from class: Options.Option

Create a graphical component representing this option. The implementation is responsible for making sure that the returned component is initialised to the current value of Options.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.

Specified by:

createComponent in class Options.Option<ValueType extends Options.OptionValue,JComboBox>

Returns:

a graphical component representing this option. May not be null.

setValueOnComponent

protected void setValueOnComponent(JComboBox component,
                       Options.OptionValue value)

Description copied from class: Options.Option

Set the value on this component.

Specified by:

setValueOnComponent in class Options.Option<ValueType extends Options.OptionValue,JComboBox>

Parameters:

component - a component return from Options.Option.createComponent()

value - the value to set.

generateValidValue

protected ValueType generateValidValue(ValueType value)

Description copied from class: Options.Option

Converts a potentially invalid value into a valid one. The default implementation always returns candidateValue, implying that all values are valid. Subclasses can override this method e.g. to clamp integer values to a certain interval, or to ensure that a disabled radio item cannot be selected. If a new value is determined to be invalid, a subclass may choose to return the current value (Options.Option.getValue() or any arbitrary other value. IMPORTANT: subclasses which implement this method should call Options.Option.setDefaultValue(Object) at the end of their constructor(s)

Overrides:

generateValidValue in class Options.Option<ValueType extends Options.OptionValue,JComboBox>

Parameters:

value - the value to determine the validity of

Returns:

an allowed value.

setAcceptsUnknownPossibleValues

public void setAcceptsUnknownPossibleValues(boolean acceptsUnknownPossibleValues)

Sets whether or not this combo box allows Options.Option.setValue(Object) or Options.setStringValue(String, String) to accept values not in the list of ComboBoxOrRadioOption#getPossibleOptionValues(). WARNING: Since setStringValue instantiates a new OptionValue, setAcceptsUnknownPossibleValues must not be used on ComboBox Options that use custom OptionValue sub-classes.

Parameters:

acceptsUnknownPossibleValues - true to accept unknown values and automatically add the to the list of getPossibleOptionValues().

Since:

API 4.700 (Geneious 7.0.0)