ActionBase (MIPAV API Documentation)

java.lang.Object
- gov.nih.mipav.model.scripting.actions.ActionBase

All Implemented Interfaces:

ScriptableActionInterface

Direct Known Subclasses:

ActionCollectGarbage, ActionExit, ActionImageProcessorBase, ActionStopMipav
```
public abstract class ActionBase
extends java.lang.Object
implements ScriptableActionInterface
```
A base class for all non-algorithmic (not JDialog*) script actions.

Field Summary

Fields
Modifier and Type Field Description

protected boolean isScript

Constructor Summary

Constructors
Constructor Description

ActionBase()

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getActionName()`	Returns the script action command string for this action.
`static java.lang.String`	`getActionName(java.lang.Class actionClass)`	Returns the script command string for an action.
`abstract void`	`insertScriptLine()`	If a script is being recorded and the action (read: algorithm) is done, add an entry for this action.
`boolean`	`isScript()`
`abstract void`	`scriptRun(ParameterTable parameters)`	Sets up the action dialog state and then executes it.
`void`	`setIsScript(boolean isScript)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - isScript
```
protected boolean isScript
```
- Constructor Detail
  - ActionBase
```
public ActionBase()
```
- Method Detail
  - insertScriptLine
```
public abstract void insertScriptLine()
```
    If a script is being recorded and the action (read: algorithm) is done, add an entry for this action.
    
    Specified by:
    
    insertScriptLine in interface ScriptableActionInterface
  - scriptRun
```
public abstract void scriptRun(ParameterTable parameters)
```
    Sets up the action dialog state and then executes it.
    
    Specified by:
    
    scriptRun in interface ScriptableActionInterface
    
    Parameters:
    
    parameters - Table of parameters for the script to use.
  - getActionName
```
public java.lang.String getActionName()
```
    Returns the script action command string for this action.
    
    Returns:
    
    The script command which should be used for this action (e.g., Clone for ActionClone).
  - getActionName
```
public static final java.lang.String getActionName(java.lang.Class actionClass)
```
    Returns the script command string for an action.
    
    Parameters:
    
    actionClass - The class to find the script command string for.
    
    Returns:
    
    The script command which should be used for the given class (e.g., Clone for ActionClone).
  - setIsScript
```
public void setIsScript(boolean isScript)
```
  - isScript
```
public boolean isScript()
```