public static class Options.ExecutableFileSelectionOption extends Options.Option<String,com.biomatters.geneious.publicapi.plugin.Options.ExecutableFilePanel>
XMLSerializable.OldVersionCompatible, XMLSerializable.VersionSupportTypeROOT_ELEMENT_NAME| Modifier | Constructor and Description |
|---|---|
protected |
Options.ExecutableFileSelectionOption(org.jdom.Element e)
Constructor for XML Serialization.
|
protected |
Options.ExecutableFileSelectionOption(String name,
String label,
String fileName,
String defaultValue)
Construct a new ExecutableFileOption.
|
| Modifier and Type | Method and Description |
|---|---|
protected com.biomatters.geneious.publicapi.plugin.Options.ExecutableFilePanel |
createComponent()
Create a graphical component representing this option.
|
protected String |
getPossibleValues()
Provide a descriptive string representation of possible values of this option.
|
String |
getValueFromString(String value)
Convert a String into an instance of the object type used by this option.
|
protected void |
setValueOnComponent(com.biomatters.geneious.publicapi.plugin.Options.ExecutableFilePanel panel,
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, 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, toStringprotected Options.ExecutableFileSelectionOption(org.jdom.Element e)
throws XMLSerializationException
XMLSerializablee - The JDOM Element from which the constructed object should be initialised.XMLSerializationException - if such an exception occurs while initialising the element from XMLprotected Options.ExecutableFileSelectionOption(String name, String label, String fileName, String defaultValue)
setAlwaysUsesDefaultPreferenceLocation(true).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".fileName - the name of the executable file which we are trying to locatelabel - a label describing this option to be displayed to the user. eg. "My Awesome Option"defaultValue - the default value for this optionpublic 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,com.biomatters.geneious.publicapi.plugin.Options.ExecutableFilePanel>public String getValueFromString(String value)
Options.OptionOptions.Option.getValueAsString(Object) .getValueFromString in class Options.Option<String,com.biomatters.geneious.publicapi.plugin.Options.ExecutableFilePanel>value - the string representation of the object valueprotected String getPossibleValues()
Options.OptionOptions.ComboBoxOrRadioOption.getPossibleOptionValues() to
get possible values as a List of OptionValues.getPossibleValues in class Options.Option<String,com.biomatters.geneious.publicapi.plugin.Options.ExecutableFilePanel>Options.ComboBoxOrRadioOption.getPossibleOptionValues()protected void setValueOnComponent(com.biomatters.geneious.publicapi.plugin.Options.ExecutableFilePanel panel,
String value)
Options.OptionsetValueOnComponent in class Options.Option<String,com.biomatters.geneious.publicapi.plugin.Options.ExecutableFilePanel>panel - a component return from Options.Option.createComponent()value - the value to set.protected com.biomatters.geneious.publicapi.plugin.Options.ExecutableFilePanel 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,com.biomatters.geneious.publicapi.plugin.Options.ExecutableFilePanel>