public class OperationLocationOptions extends Options
Options that provides the ability to pick between running an Operation on the local computer or on a
supported GeneiousService. Supported services include for example a Geneious Server or a Green Button server.
Implementing a Geneious Server or Green Button service is outside the scope of the Geneious public API, but operations
can be developed to run on Geneious Server or Green Button using the Geneious Public API.
A listener can be added to via addLocationChangedListener(com.biomatters.geneious.publicapi.plugin.OperationLocationOptions.LocationChangedListener) to be notified when
the location changes.
OperationLocationOptions can be created using DocumentOperation.getLocationOptions(com.biomatters.geneious.publicapi.documents.AnnotatedPluginDocument...)| Modifier and Type | Class and Description |
|---|---|
static class |
OperationLocationOptions.LocationChangedListener
Used to indicate that the value returned from
getSelectedLocation() has changed. |
Options.Alignment, Options.BooleanOption, Options.ButtonOption, Options.ComboBoxOption<ValueType extends Options.OptionValue>, Options.ComponentCreator, Options.DateOption, Options.DoubleOption, Options.EditableComboBoxOption, Options.ExecutableFileSelectionOption, Options.FileSelectionOption, Options.IntegerOption, Options.LabelOption, Options.MultipleLineStringOption, Options.MultipleOptions, Options.Option<ValueType,ComponentType extends JComponent>, Options.OptionValue, Options.PageChooserType, Options.RadioOption<ValueType extends Options.OptionValue>, Options.StringOptionXMLSerializable.OldVersionCompatible, XMLSerializable.VersionSupportTypeASSOCIATED_OPTION_PROPERTYROOT_ELEMENT_NAME| Modifier and Type | Method and Description |
|---|---|
void |
addLocationChangedListener(OperationLocationOptions.LocationChangedListener listener)
Registers a listener that will be notified when the location changes.
|
GeneiousService |
getSelectedLocation() |
org.jdom.Element |
toXML()
Convert object to a JDOM element.
|
addBooleanOption, addButtonOption, addButtonOption, addChangeListener, addChildOptions, addChildOptions, addChildOptions, addChildOptionsPageChooser, addCollapsibleChildOptions, addComboBoxOption, addComboBoxOption, addCustomComponent, addCustomComponent, addCustomOption, addDateOption, addDefaultsRestoredListener, addDivider, addDocumentSelectionOption, addDoubleOption, addDoubleOption, addEditableComboBoxOption, addEditableComboBoxOption, addExecutableFileSelectionOption, addExecutableFileSelectionOption, addFileSelectionOption, addFileSelectionOption, addFileSelectionOption, addHelpButton, addHelpButtonOption, addIntegerOption, addIntegerOption, addLabel, addLabel, addLabelWithIcon, addMultipleLineStringOption, addMultipleOptions, addPrimerSelectionOption, addRadioOption, addRadioOption, addServiceOption, addStringOption, addStringOption, areValuesGoodEnoughToContinue, beginAlignHorizontally, canRestoreDefaults, createAdvancedPanel, createPanel, endAlignHorizontally, fromXML, getAdvancedPanel, getChildOptions, getChildOptionsPageChooser, getDescriptionAndState, getDialogOptions, getIcons, getMultipleOptions, getMultipleOptions, getNamesAndValues, getOption, getOptions, getOptionsHelp, getPanel, getParentOptions, getValue, getValueAsString, getVersionSupportForValuesToXML, hasAdvancedOptions, hasBasicOptions, isEnabled, isHorizontallyCompact, isProOnly, isVisible, removeChangeListener, removeDefaultsRestoredListener, restoreDefaults, restorePreferences, restorePreferences, savePreferences, savePreferences, setChildOptionsCollapsed, setEnabled, setHorizontallyCompact, setHorizontallyCompactAdvanced, setIcons, setInScrollPane, setProOnly, setSavePreferencesForInvisibleChildOptions, setStringValue, setValue, setVerticallyCompact, setVerticallyCompactAdvanced, setVisible, toString, valuesFromXML, valuesFromXML, valuesToXML, valuesToXML, verifyOptionsAreValidpublic 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 Optionspublic void addLocationChangedListener(OperationLocationOptions.LocationChangedListener listener)
listener - that will be notified when the location changespublic GeneiousService getSelectedLocation()