AbstractKeyboardActionWithActor (adams-pom 24.5.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.gui.flow.tree.keyboardaction.AbstractKeyboardAction
      - adams.gui.flow.tree.keyboardaction.AbstractKeyboardActionWithActor

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Serializable

Direct Known Subclasses:

AbstractAddActor, EncloseActor, PullUpActor
```
public abstract class AbstractKeyboardActionWithActor
extends AbstractKeyboardAction
```
Ancestor for actions that do something with a specified actor.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected Actor m_Actor
the actor to use.
- Fields inherited from class adams.gui.flow.tree.keyboardaction.AbstractKeyboardAction
  m_Name, m_Shortcut
- Fields inherited from class adams.core.option.AbstractOptionHandler
  m_OptionManager
- Fields inherited from class adams.core.logging.LoggingObject
  m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors
Constructor Description

AbstractKeyboardActionWithActor()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract String`	`actorTipText()`	Returns the tip text for this property.
`void`	`defineOptions()`	Adds options to the internal list of options.
`Actor`	`getActor()`	Returns the actor of the action.
`protected abstract Actor`	`getDefaultActor()`	Returns the default actor of the action.
`void`	`setActor(Actor value)`	Sets the actor of the action.

Methods inherited from class adams.gui.flow.tree.keyboardaction.AbstractKeyboardAction
check, doExecute, execute, getDefaultName, getDefaultShortcut, getName, getShortcut, nameTipText, postExecute, setName, setShortcut, shortcutTipText

Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject
configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

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

Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel

- Field Detail
  - m_Actor
```
protected Actor m_Actor
```
    the actor to use.
- Constructor Detail
  - AbstractKeyboardActionWithActor
```
public AbstractKeyboardActionWithActor()
```
- Method Detail
  - defineOptions
```
public void defineOptions()
```
    Adds options to the internal list of options.
    
    Specified by:
    
    defineOptions in interface OptionHandler
    
    Overrides:
    
    defineOptions in class AbstractKeyboardAction
  - getDefaultActor
```
protected abstract Actor getDefaultActor()
```
    Returns the default actor of the action.
    
    Returns:
    
    the default
  - setActor
```
public void setActor(Actor value)
```
    Sets the actor of the action.
    
    Parameters:
    
    value - the actor
  - getActor
```
public Actor getActor()
```
    Returns the actor of the action.
    
    Returns:
    
    the actor
  - actorTipText
```
public abstract String actorTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.