public abstract class DocumentAction extends Object
DocumentAction performs some operation to modify a document, without creating new documents.
It is recommended that DocumentOperation (where the performOperation message simply returns null to create 0 documents) be used in most cases.
A plugin may provide a set of actions
via GeneiousPlugin.getDocumentActions().| Constructor and Description |
|---|
DocumentAction() |
| Modifier and Type | Method and Description |
|---|---|
abstract void |
actionPerformed(AnnotatedPluginDocument[] documents)
Perform a document action.
|
abstract GeneiousActionOptions |
getActionOptions()
Get options for action.
|
abstract String |
getHelp()
Help for this action in the form of HTML or plain text.
|
abstract DocumentSelectionSignature[] |
getSelectionSignatures()
Specifies the document(s) this action is available for.
|
public abstract GeneiousActionOptions getActionOptions()
public abstract String getHelp()
public abstract void actionPerformed(AnnotatedPluginDocument[] documents)
documents - to operate on.public abstract DocumentSelectionSignature[] getSelectionSignatures()
new DocumentSelectionSignature(PluginDocument.class, 0, Integer.MAX_VALUE)
to have it enabled when at least one document of any type is selected.