Package adams.gui.flow.tree.keyboardaction

Class EncloseActor

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

adams.gui.flow.tree.keyboardaction.EncloseActor

All Implemented Interfaces:

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

public class EncloseActor
extends AbstractKeyboardActionWithActor

Encloses the selected actor(s) with the specified actor.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.gui.flow.tree.keyboardaction.AbstractKeyboardActionWithActor

m_Actor

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
EncloseActor()

Method Summary

Modifier and Type	Method	Description
String	actorTipText()	Returns the tip text for this property.
protected String	check(StateContainer state)	Checks whether the current state is suitable.
protected String	doExecute(StateContainer state)	Performs the actual execution of the aciton.
protected Actor	getDefaultActor()	Returns the default actor of the action.
protected BaseShortcut	getDefaultShortcut()	Returns the default shortcut of the action.
String	globalInfo()	Returns a string describing the object.
void	setActor(Actor value)	Sets the actor of the action.

Methods inherited from class adams.gui.flow.tree.keyboardaction.AbstractKeyboardActionWithActor

defineOptions, getActor

Methods inherited from class adams.gui.flow.tree.keyboardaction.AbstractKeyboardAction

execute, getDefaultName, getName, getShortcut, nameTipText, postExecute, setName, setShortcut, shortcutTipText

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, 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

Constructor Detail

EncloseActor

public EncloseActor()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface GlobalInfoSupporter

Specified by:

globalInfo in class AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

actorTipText

public String actorTipText()

Returns the tip text for this property.

Specified by:

actorTipText in class AbstractKeyboardActionWithActor

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

getDefaultShortcut

protected BaseShortcut getDefaultShortcut()

Returns the default shortcut of the action.

Specified by:

getDefaultShortcut in class AbstractKeyboardAction

Returns:

the default

getDefaultActor

protected Actor getDefaultActor()

Returns the default actor of the action.

Specified by:

getDefaultActor in class AbstractKeyboardActionWithActor

Returns:

the default

setActor

public void setActor(Actor value)

Sets the actor of the action.

Overrides:

setActor in class AbstractKeyboardActionWithActor

Parameters:

value - the actor

check

protected String check(StateContainer state)

Checks whether the current state is suitable.

Overrides:

check in class AbstractKeyboardAction

Parameters:

state - the current state

Returns:

null if OK, otherwise error message

doExecute

protected String doExecute(StateContainer state)

Performs the actual execution of the aciton.

Specified by:

doExecute in class AbstractKeyboardAction

Parameters:

state - the current state

Returns:

null if OK, otherwise error message