| Package | Description |
|---|---|
| com.biomatters.geneious.publicapi.components |
Provides useful GUI (graphical user interface) components, none of which
are necessary for creating a plugin, but many plugin implentations
will find these components useful.
|
| com.biomatters.geneious.publicapi.databaseservice |
Provides the interface and associated classes for
defining a database service which is a service that
appears on the left-hand side of the main Geneious window
and provides the user with access to a database, for example
NCBI or the local database for storing the user's documents.
|
| com.biomatters.geneious.publicapi.plugin |
Provides the
GeneiousPlugin interface and plugin
related interfaces. |
| Modifier and Type | Method and Description |
|---|---|
List<GeneiousAction> |
GeneiousActionToolbar.getActions()
Get all the GeneiousActions that are in this toolbar.
|
| Modifier and Type | Method and Description |
|---|---|
AbstractButton |
GeneiousActionToolbar.addAction(GeneiousAction action)
Add an action to the toolbar.
|
AbstractButton |
GeneiousActionToolbar.addAction(GeneiousAction action,
boolean defaultVisible)
Add an action to the toolbar.
|
AbstractButton |
GeneiousActionToolbar.addAction(GeneiousAction action,
boolean defaultVisible,
boolean floatRight)
Add an action to the toolbar.
|
void |
GeneiousActionToolbar.removeAction(GeneiousAction action)
Remove an action from the toolbar, the button associated with the action will be removed.
|
| Constructor and Description |
|---|
ProOnlyComponents.Button(GeneiousAction a) |
ProOnlyComponents.CheckBoxMenuItem(GeneiousAction a) |
ProOnlyComponents.MenuItem(GeneiousAction a) |
| Modifier and Type | Method and Description |
|---|---|
protected List<GeneiousAction> |
WritableDatabaseService._getActionsEnabledWhenServiceSelected()
Sub-classes should override this to provide actions as defined by
GeneiousService.getActionsEnabledWhenServiceSelected(). |
List<GeneiousAction> |
SequenceDatabaseSuperService.getActionsEnabledWhenServiceSelected() |
List<GeneiousAction> |
WritableDatabaseService.getActionsEnabledWhenServiceSelected()
WritableDatabaseService implements this as a final method to add
any additional actions supplied to
WritableDatabaseService.addAdditionalAction(com.biomatters.geneious.publicapi.plugin.GeneiousAction)
combined with the actions provided by sub-classes in
WritableDatabaseService._getActionsEnabledWhenServiceSelected(). |
| Modifier and Type | Method and Description |
|---|---|
void |
WritableDatabaseService.addAdditionalAction(GeneiousAction action)
Adds an additional action that this service will provide
via
WritableDatabaseService.getActionsEnabledWhenServiceSelected() |
void |
WritableDatabaseService.removeAdditionalAction(GeneiousAction action)
Removes an additional action (added previously using
WritableDatabaseService.addAdditionalAction(com.biomatters.geneious.publicapi.plugin.GeneiousAction))
that this service provides. |
| Modifier and Type | Class and Description |
|---|---|
static class |
GeneiousAction.Divider
A subclass of GeneiousAction which is placed in a toolbar/menu as a divider.
|
static class |
GeneiousAction.SubMenu
A subclass of GeneiousAction which is placed in the menu as a submenu which opens to the right;
In the toolbar, it will appear as a drop-down menu that opens downwards.
|
static class |
GeneiousAction.ToggleAction
A subclass of GeneiousAction which is placed in a toolbar/menu as a toggle button or check box menu item.
|
| Modifier and Type | Method and Description |
|---|---|
GeneiousAction |
ActionProvider.getBackAction()
Provide an optional back action that is displayed as a back arrow in the viewer toolbar
and has the default back keyboard shortcut.
|
GeneiousAction |
ActionProvider.getCopyAction()
Action that should be performed when this viewer etc.
|
GeneiousAction |
ActionProvider.getCutAction()
Action that should be performed when this viewer etc.
|
GeneiousAction |
ActionProvider.getDeleteAction()
Action that should be performed when this viewer etc.
|
GeneiousAction |
ActionProvider.getForwardAction()
Provide an optional forward action that is displayed as a forward arrow in the viewer toolbar
and has the default forward keyboard shortcut.
|
GeneiousAction |
ActionProvider.getPasteAction()
Action that should be performed when this viewer etc.
|
GeneiousAction |
ActionProvider.getRedoAction()
Action that should be performed when this viewer etc.
|
GeneiousAction |
ActionProvider.getSaveAction()
Provide an optional action which will be performed when the user selects Save from the file menu
or pushes Ctrl+S (Cmd+S on Mac OS).
|
GeneiousAction |
ActionProvider.getSelectAllAction()
Action that should be performed when this viewer etc.
|
GeneiousAction |
ActionProvider.getUndoAction()
Action that should be performed when this viewer etc.
|
GeneiousAction |
GeneiousAction.setInMainToolbar(boolean isInMainToolbar)
Set the location of this actio in the main toolbar (with the default position of 0.5 - see
setInMainToolbar(boolean, double)). |
GeneiousAction |
GeneiousAction.setInMainToolbar(boolean isInMainToolbar,
double mainToolbarPosition)
Set the location of this action in the main toolbar.
|
GeneiousAction |
GeneiousAction.setInPopupMenu(boolean isInPopupMenu)
Set the location of this action in the popup menu (with the default position of 0.5 - see
setInPopupMenu(boolean, double)). |
GeneiousAction |
GeneiousAction.setInPopupMenu(boolean isInPopupMenu,
double popupMenuPosition)
Set the location of this action in the popup menu.
|
GeneiousAction |
GeneiousAction.setMainMenuLocation(GeneiousActionOptions.MainMenu menu)
Set the location of this action in the main menu (with the default position of 0.5 - see
setMainMenuLocation(com.biomatters.geneious.publicapi.plugin.GeneiousActionOptions.MainMenu, double)). |
GeneiousAction |
GeneiousAction.setMainMenuLocation(GeneiousActionOptions.MainMenu menu,
double mainMenuPosition)
Set the location of this action in the main menu.
|
GeneiousAction |
GeneiousAction.setProOnly(boolean isProOnly)
Set whether this action requires an active license.
|
GeneiousAction |
GeneiousAction.setShortcutKey(KeyStroke shortcutKey)
Set the shortcutKey for this action (eg.
|
| Modifier and Type | Method and Description |
|---|---|
List<GeneiousAction> |
GeneiousService.getActionsAlwaysEnabled()
a list of Geneious Actions which can appear in the menu bar, toolbar or popup-menu in the service tree.
|
List<GeneiousAction> |
GeneiousService.getActionsEnabledWhenServiceSelected()
List of Geneious Actions which can appear in the menu bar, toolbar or popup-menu in the service tree.
|
static List<GeneiousAction> |
GeneiousAction.getActionsInMainMenuOrder(List<GeneiousAction> actions)
Get a sorted list of actions in the order determined by
GeneiousActionOptions.getMainMenuPosition()/alphabetically
for any actions with the same main menu position value. |
static List<GeneiousAction> |
GeneiousAction.getActionsInPopupMenuOrder(List<GeneiousAction> actions)
Get a sorted list of actions in the order determined by
GeneiousActionOptions.getPopupMenuPosition()/alphabetically
for any actions with the same popup menu position value. |
static List<GeneiousAction> |
GeneiousAction.getActionsInToolbarOrder(List<GeneiousAction> actions)
Get a sorted list of actions in the order determined by
GeneiousActionOptions.getMainToolbarPosition()/alphabetically
for any actions with the same toolbar position value. |
List<GeneiousAction> |
ActionProvider.getExternalActions()
Get a list of actions that should appear in the main menu or elsewhere outside the viewer's toolbar.
|
List<GeneiousAction> |
ActionProvider.getOtherActions()
Get a list of other actions associated with viewer which will be displayed in a toolbar within the viewer panel.
|
List<GeneiousAction> |
DocumentViewerFactory.getPossibleExternalActions()
Get a list of
GeneiousActions for viewer actions that should be displayed in the main menu
or other location outside the viewer's toolbar. |
List<GeneiousAction> |
GeneiousAction.SubMenu.getSubMenuActions()
Get the actions that appear in the submen/popup-menu, in the same order they will appear in the menu.
|
List<GeneiousAction> |
SequenceViewerExtension.getToolbarActions()
Get a list of other actions associated with extension which will be displayed in the sequence viewer toolbar.
|
| Modifier and Type | Method and Description |
|---|---|
static List<GeneiousAction> |
GeneiousAction.getActionsInMainMenuOrder(List<GeneiousAction> actions)
Get a sorted list of actions in the order determined by
GeneiousActionOptions.getMainMenuPosition()/alphabetically
for any actions with the same main menu position value. |
static List<GeneiousAction> |
GeneiousAction.getActionsInPopupMenuOrder(List<GeneiousAction> actions)
Get a sorted list of actions in the order determined by
GeneiousActionOptions.getPopupMenuPosition()/alphabetically
for any actions with the same popup menu position value. |
static List<GeneiousAction> |
GeneiousAction.getActionsInToolbarOrder(List<GeneiousAction> actions)
Get a sorted list of actions in the order determined by
GeneiousActionOptions.getMainToolbarPosition()/alphabetically
for any actions with the same toolbar position value. |
void |
GeneiousAction.SubMenu.setSubMenuActions(List<GeneiousAction> subMenuActions)
Set the list of actions which will appear in the submenu/popup-menu.
|
| Constructor and Description |
|---|
GeneiousAction(GeneiousAction internalAction)
Creates a GeneiousAction that wraps another action.
|
| Constructor and Description |
|---|
GeneiousAction.SubMenu(GeneiousActionOptions actionOptions,
List<GeneiousAction> subMenuActions) |