| 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.documents |
Provides interfaces and classes for defining documents in Geneious and related
interfaces and classes for dealing with XMLSerialization.
|
| com.biomatters.geneious.publicapi.plugin |
Provides the
GeneiousPlugin interface and plugin
related interfaces. |
| com.biomatters.geneious.publicapi.utilities |
Provides various utility methods and classes, none of which
are necessary for creating a plugin, but many plugins implentations
will find these methods useful.
|
| Modifier and Type | Class and Description |
|---|---|
class |
OverlayIcons
|
| Modifier and Type | Method and Description |
|---|---|
Icons |
GComboBox.IconsProvider.getIcons()
Provides the icons for this item.
|
| Modifier and Type | Method and Description |
|---|---|
void |
ProgressFrame.setIcons(Icons icons)
Set the icons for the frame/task bar (displayed in the left corner of the title bar).
|
| Constructor and Description |
|---|
BubbleToolTip(String message,
JComponent sourceComponent,
Icons icon)
A tooltip component in the shape of a speech bubble (a rectangle on Mac because they ruin it by painting a rectangular shadow around everything).
|
OverlayIcons(Icons baseIcons,
Icons... overlayIcons)
|
OverlayIcons(Icons baseIcons,
Icons... overlayIcons)
|
| Modifier and Type | Method and Description |
|---|---|
protected abstract Icons |
WritableDatabaseService._getIcons()
Sub-classes should override this to provide icons as defined by
GeneiousService.getIcons(). |
protected Icons |
WritableDatabaseService.DummyService._getIcons() |
Icons |
WritableDatabaseService.getIcons()
WritableDatabaseService implements this as a final method to add
any additional icons supplied to
WritableDatabaseService.addOverlayIcons(com.biomatters.geneious.publicapi.plugin.Icons)
combined with the icons provided by sub-classes in
WritableDatabaseService._getIcons() |
| Modifier and Type | Method and Description |
|---|---|
void |
WritableDatabaseService.addOverlayIcons(Icons icons)
add an icon which will be drawn on top of the standard database icon
|
void |
WritableDatabaseService.removeOverlayIcons(Icons icons)
remove an icon added using
WritableDatabaseService.addOverlayIcons(com.biomatters.geneious.publicapi.plugin.Icons) |
| Constructor and Description |
|---|
WritableDatabaseService.DummyService(String name,
String rootUniqueId,
Icons icons)
Construct a new dummy service that provides no functionality apart from a name and icons
|
| Modifier and Type | Method and Description |
|---|---|
Icons |
AnnotatedPluginDocument.getIcons() |
| Modifier and Type | Field and Description |
|---|---|
Icons |
DocumentType.documentIcon
An icon associated with documents of that type.
|
| Modifier and Type | Method and Description |
|---|---|
Icons |
AlignmentOperation.getIcons() |
Icons |
DocumentViewerFactory.getIcons()
An icon which will be displayed (at 16x16) next to the viewer name in the tabbed pane.
|
Icons |
GeneiousActionOptions.getIcons() |
Icons |
GeneiousPlugin.getIcons()
get plugin icons set.
|
abstract Icons |
GeneiousService.getIcons()
Icons used in the service list.
|
Icons |
Options.getIcons()
Gets Icons associated with these options.
|
Icons |
GeneiousAction.SubMenu.getPopupIcons()
Get the icons which should be used for this action when it is displayed as a toolbar button.
|
| Modifier and Type | Method and Description |
|---|---|
Options.LabelOption |
Options.addLabelWithIcon(String label,
Icons icons)
Adds a label with an icon to the left of it.
|
void |
GeneiousAction.setIcons(Icons icons)
Set the icons of the action.
|
void |
Options.setIcons(Icons icons)
Sets Icons associated with these options.
|
void |
GeneiousAction.SubMenu.setPopupIcons(Icons popupIcons)
Set the icons which should be used for this action when it is displayed as a toolbar button.
|
| Constructor and Description |
|---|
DocumentType(String name,
Class<T> classOfDocument,
Class overrideClass,
Icons icon) |
DocumentType(String name,
Class<T> classOfDocument,
Icons icon)
constructor.
|
GeneiousAction(String name,
String description,
Icons icons) |
GeneiousAction(String name,
String description,
Icons icons,
GeneiousActionOptions.Category category,
GeneiousActionOptions.MainMenu menu,
boolean isInPopupMenu,
boolean isInMainToolbar,
KeyStroke shortcut)
Deprecated.
Construct
GeneiousActionOptions first then use
constructor GeneiousAction.GeneiousAction(GeneiousActionOptions) instead. |
GeneiousActionOptions(String name,
String description,
Icons icons) |
GeneiousActionOptions(String name,
String description,
Icons icons,
GeneiousActionOptions.Category category)
Constructor of GeneiousActionOptions for DocumentOperations that belong to a category (eg.
|
GeneiousActionOptions(String name,
String description,
Icons icons,
GeneiousActionOptions.Category category,
GeneiousActionOptions.MainMenu menu,
boolean isInPopupMenu,
boolean isInMainToolbar,
KeyStroke shortcut,
boolean isProOnly)
Deprecated.
Use other constructors in combination with setters instead
|
Options.OptionValue(String name,
String label,
String description,
boolean enabled,
Icons icons)
Construct a new option value.
|
| Modifier and Type | Method and Description |
|---|---|
static Icons |
IconUtilities.createGrayedOutIcons(Icons icons,
double saturationAdjustment,
float alpha)
Creates and caches a version of the icons with less (or more) saturation and/or a change in
alpha.
|
static Icons |
IconUtilities.getCategoryDefaultIcons(GeneiousActionOptions.Category category)
Get the default
Icons for the specified action category. |
static Icons |
IconUtilities.getGrayedOutIconsOriginal(Icons icons)
Get the non-grayed out version of Icons, IF
IconUtilities.createGrayedOutIcons(com.biomatters.geneious.publicapi.plugin.Icons, double, float)
was used to create the grayed out version. |
Icons |
StandardIcons.getIcons()
Get the Icons for this standard icon.
|
static Icons |
IconUtilities.getIcons(String iconNameOrPath)
Create an
Icons from an image file on disk. |
static Icons |
IconUtilities.getIcons(String smallIconNameOrPath,
String largeIconNameOrPath)
Create an
Icons from two image files on disk: a small and a large
version of the image (typically 16x16 pixels and 32x32 (for document icons) or 24x24 (for toolbar icons)). |
static Icons |
IconUtilities.getIconsFromJar(Class aClass,
String iconNameOrPath)
Create and
Icons from an image file in a resource bundle (jar). |
static Icons |
IconUtilities.getIconsFromJar(Class aClass,
String smallIconPath,
String largeIconPath)
Create and
Icons from two image files from a resource bundle (jar). |
| Modifier and Type | Method and Description |
|---|---|
static Icons |
IconUtilities.createGrayedOutIcons(Icons icons,
double saturationAdjustment,
float alpha)
Creates and caches a version of the icons with less (or more) saturation and/or a change in
alpha.
|
static Icons |
IconUtilities.getGrayedOutIconsOriginal(Icons icons)
Get the non-grayed out version of Icons, IF
IconUtilities.createGrayedOutIcons(com.biomatters.geneious.publicapi.plugin.Icons, double, float)
was used to create the grayed out version. |
static String |
IconUtilities.getIconsName(Icons icons)
Get a string name of an icon for the purposes of lexographic comparison.
|