Package adams.gui.flow.tree.keyboardaction

Class SearchActorHere

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

adams.gui.flow.tree.keyboardaction.SearchActorHere

All Implemented Interfaces:

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

public class SearchActorHere
extends AbstractSearchActor

Allows the user to search for an actor to be inserted at the current location.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

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

m_DisplayActorOptions

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

Method Summary

Modifier and Type	Method	Description
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 BaseShortcut	getDefaultShortcut()	Returns the default shortcut of the action.
String	globalInfo()	Returns a string describing the object.

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

defineOptions, displayActorOptionsTipText, getActorDialogType, getDisplayActorOptions, setDisplayActorOptions

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

SearchActorHere

public SearchActorHere()

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

getDefaultShortcut

protected BaseShortcut getDefaultShortcut()

Returns the default shortcut of the action.

Specified by:

getDefaultShortcut in class AbstractKeyboardAction

Returns:

the default

check

protected String check(StateContainer state)

Checks whether the current state is suitable.

Overrides:

check in class AbstractSearchActor

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