public static enum AnnotatedPluginDocument.ActiveLinkSaveBehaviour extends Enum<AnnotatedPluginDocument.ActiveLinkSaveBehaviour>
AnnotatedPluginDocument.saveDocument(com.biomatters.geneious.publicapi.documents.AnnotatedPluginDocument.ActiveLinkSaveBehaviour, jebl.util.ProgressListener) is called.
Only applicable when the document has at least one descendant operation with active links.| Enum Constant and Description |
|---|
DeactivateLinks
For the parent and for every immediate descendant operation with active links, will automatically deactivate the link.
|
DoNotPropagateChangesButKeepActive
Keep any active links to descendant operations active, but do not propagate changes.
|
PromptUser
Prompt the user for which of the other behaviours (
PropagateChanges, DeactivateLinks) to do. |
PropagateChanges
For every descendant operation with active links, will recursively recompute all that operation's descendants automatically.
|
| Modifier and Type | Method and Description |
|---|---|
static AnnotatedPluginDocument.ActiveLinkSaveBehaviour |
valueOf(String name)
Returns the enum constant of this type with the specified name.
|
static AnnotatedPluginDocument.ActiveLinkSaveBehaviour[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
public static final AnnotatedPluginDocument.ActiveLinkSaveBehaviour PropagateChanges
public static final AnnotatedPluginDocument.ActiveLinkSaveBehaviour DoNotPropagateChangesButKeepActive
public static final AnnotatedPluginDocument.ActiveLinkSaveBehaviour DeactivateLinks
public static final AnnotatedPluginDocument.ActiveLinkSaveBehaviour PromptUser
PropagateChanges, DeactivateLinks) to do. This dialog will not be cancellable. Instead where possible,
viewers or operations that modify documents should handle prompting the user at an earlier stage. This is also preferable if the user edits many documents at once to provide a single dialog.
If the document is actively linked to its parent the user will be notified and the parent link deactivated.
On Geneious Server, this option is equivalent to PropagateChanges for descendant links and DeactivateLinks for parent links.public static AnnotatedPluginDocument.ActiveLinkSaveBehaviour[] values()
for (AnnotatedPluginDocument.ActiveLinkSaveBehaviour c : AnnotatedPluginDocument.ActiveLinkSaveBehaviour.values()) System.out.println(c);
public static AnnotatedPluginDocument.ActiveLinkSaveBehaviour valueOf(String name)
name - the name of the enum constant to be returned.IllegalArgumentException - if this enum type has no constant
with the specified nameNullPointerException - if the argument is null