| Package | Description |
|---|---|
| com.biomatters.geneious.publicapi.plugin |
Provides the
GeneiousPlugin interface and plugin
related interfaces. |
| Modifier and Type | Class and Description |
|---|---|
class |
DocumentSelectionOption
An option to allow the user to select a number of documents of a particular type from their local database.
|
static class |
Options.BooleanOption
An option that stores a Boolean and is represented graphically as a check box.
|
static class |
Options.ButtonOption
Provides the user with a button which may have actions associated with it by calling
Options.ButtonOption.addActionListener(java.awt.event.ActionListener). |
static class |
Options.ComboBoxOption<ValueType extends Options.OptionValue>
An option that provides the user with a list of options in a combo box
|
static class |
Options.DateOption
An option that stores a date.
|
static class |
Options.DoubleOption
An option that stores an Double and is displayed graphically
to the user as a single line text field with a spinner (up and down arrow)
on the right-hand side
|
static class |
Options.EditableComboBoxOption
Like a ComboBoxOption, but besides letting the user choose one of
the preconfigured default values, also allows arbitrary custom strings
to be entered.
|
static class |
Options.ExecutableFileSelectionOption
Provides the user with an executable file name and provides assistance with finding
the location of it.
|
static class |
Options.FileSelectionOption
Provides functionality to let the user choose a file.
|
static class |
Options.IntegerOption
An option that stores an Integer and is displayed graphically
to the user as a single line text field with a spinner (up and down arrow)
on the right-hand side.
|
static class |
Options.LabelOption
An option that is only used for display purposes.
|
static class |
Options.MultipleLineStringOption
An option that stores a String and is displayed to the user as a multiple line text area
|
static class |
Options.RadioOption<ValueType extends Options.OptionValue>
An option that provides the user with a list of radio buttons to select one of
|
static class |
Options.StringOption
An option that stores a String and is displayed graphically to the user as a single line text field.
|
static class |
SequenceAnnotationGenerator.SelectionGrabOption
If any option returned from
SequenceAnnotationGenerator.getOptions(com.biomatters.geneious.publicapi.documents.AnnotatedPluginDocument[], com.biomatters.geneious.publicapi.plugin.SequenceAnnotationGenerator.SelectionRange)
is a SelectionGrabOption then the sequence viewer will interact with the option such that when the user clicks on the button representing this option, the current selection
in the sequence viewer is copied to this option value. |
| Modifier and Type | Method and Description |
|---|---|
<OptionType extends Options.Option> |
Options.addCustomOption(OptionType option)
Add a custom option.
|
| Modifier and Type | Method and Description |
|---|---|
Options.Option |
Options.addChildOptionsPageChooser(String name,
String label,
List<String> disabledOptions,
Options.PageChooserType type,
boolean allChildOptionsApplySimultaneously)
Makes all previously added child options available via a list of tab buttons.
|
Options.Option |
Options.addCustomComponent(JComponent component)
Adds a custom component that will be laid out along with all the standard
options.
|
Options.Option |
Options.addCustomComponent(Options.ComponentCreator componentCreator)
Adds a custom component that will be laid out along with all the standard
options.
|
Options.Option |
Options.addDivider(String label)
Add a new divider that is displayed between options when the options are graphically presented to the user.
|
Options.Option |
Options.addHelpButtonOption(String dialogTitle,
String dialogMessage)
Adds a little help button (with a question mark on it) which when clicked shows a dialog containing a message
|
Options.Option<String,? extends JComponent> |
Options.addLabel(String label)
Add a new label that is displayed between options when the options are graphically presented to the user.
|
Options.Option<String,? extends JComponent> |
Options.addLabel(String label,
boolean centreText,
boolean spanEntirePanelWidth)
Add a new label that is displayed between options when the options are graphically presented to the user.
|
Options.Option<WritableDatabaseService,JComponent> |
Options.addServiceOption(String name,
String label,
WritableDatabaseService defaultValue)
Add an option that allows the user to select a WtiableDatabaseService which appears under one of the services returned from
PluginUtilities.getWritableDatabaseServiceRoots(). |
Options.Option |
Options.getChildOptionsPageChooser()
if
Options.addChildOptionsPageChooser(String, String, java.util.List, com.biomatters.geneious.publicapi.plugin.Options.PageChooserType, boolean) has been called, return the
option created for choosing which set of child options are currently active. |
Options.Option |
Options.getOption(String optionName)
Get an option or child option.
|
| Modifier and Type | Method and Description |
|---|---|
List<Options.Option> |
Options.getOptions()
Get a list of all options added via any of the add*Option methods.
|
| Modifier and Type | Method and Description |
|---|---|
void |
Options.BooleanOption.addDependent(Options.Option dependent,
boolean requireOn)
Makes another option's enabled state depend on this boolean option being on or off.
|
void |
Options.BooleanOption.addDependent(Options.Option dependent,
boolean requireOn,
boolean layoutCheckboxNextToDependent)
Makes another option's enabled state depend on this boolean option being on or off.
|
void |
Options.Option.addDependent(Options.Option dependent,
ValueType valueRequiredForDependentToBeEnabled)
Makes another option's enabled state depend on the current value of this option.
|
void |
Options.RadioOption.addDependent(ValueType optionValue,
Options.Option dependent,
boolean layoutDependentNearRadioButton)
Adds a dependent option that will be enabled when the radio button associated with the OptionValue is
selected, and disabled when it is not.
|