Package adams.gui.flow.tree.keyboardaction

Class AbstractSearchActor

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.AbstractSearchActor

All Implemented Interfaces:

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

Direct Known Subclasses:

SearchActorAfter, SearchActorBeneath, SearchActorHere

public abstract class AbstractSearchActor
extends AbstractKeyboardAction

Ancestor for actions that add an actor.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_DisplayActorOptions	whether to display the GOE with the 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
AbstractSearchActor()

Method Summary

Modifier and Type	Method	Description
protected String	check(StateContainer state)	Checks whether the current state is suitable.
void	defineOptions()	Adds options to the internal list of options.
String	displayActorOptionsTipText()	Returns the tip text for this property.
protected TreeOperations.ActorDialog	getActorDialogType()	Returns the type of dialog to use.
boolean	getDisplayActorOptions()	Returns whether to display the actor options in GOE.
void	setDisplayActorOptions(boolean value)	Sets whether to display the actor options in GOE.

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

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_DisplayActorOptions

protected boolean m_DisplayActorOptions

whether to display the GOE with the actor.

Constructor Detail

AbstractSearchActor

public AbstractSearchActor()

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

setDisplayActorOptions

public void setDisplayActorOptions(boolean value)

Sets whether to display the actor options in GOE.

Parameters:

value - true if to display

getDisplayActorOptions

public boolean getDisplayActorOptions()

Returns whether to display the actor options in GOE.

Returns:

true if to display

displayActorOptionsTipText

public String displayActorOptionsTipText()

Returns the tip text for this property.

Returns:

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

getActorDialogType

protected TreeOperations.ActorDialog getActorDialogType()

Returns the type of dialog to use.

Returns:

the type

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