Package adams.gui.flow.tree.keyboardaction

Class ActionQuickSearch

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

All Implemented Interfaces:

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

public class ActionQuickSearch
extends AbstractKeyboardAction

Allows the user to search for actions in menu items for editor and tree popup.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected List<Object>	m_AllActions	all instantiated classes.

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

Method Summary

Modifier and Type	Method	Description
protected Object[]	determineActions(StateContainer state)	Determines the action objects that can be used within this context.
protected String	doExecute(StateContainer state)	Performs the actual execution of the action.
protected BaseShortcut	getDefaultShortcut()	Returns the default shortcut of the action.
String	globalInfo()	Returns a string describing the object.
protected boolean	isActionEnabled(Object obj)	Checks whether the action is enabled.
protected boolean	updateAction(StateContainer state, Object obj)	Updates the state of the action.

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

check, defineOptions, 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

Field Detail

m_AllActions

protected transient List<Object> m_AllActions

all instantiated classes.

Constructor Detail

ActionQuickSearch

public ActionQuickSearch()

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

updateAction

protected boolean updateAction(StateContainer state,
                               Object obj)

Updates the state of the action.

Parameters:

state - the state to use

obj - the action to update

Returns:

true if successfully updated

isActionEnabled

protected boolean isActionEnabled(Object obj)

Checks whether the action is enabled.

Parameters:

obj - the action to check

Returns:

true if enabled

determineActions

protected Object[] determineActions(StateContainer state)

Determines the action objects that can be used within this context.

Returns:

the objects

doExecute

protected String doExecute(StateContainer state)

Performs the actual execution of the action.

Specified by:

doExecute in class AbstractKeyboardAction

Parameters:

state - the current state

Returns:

null if OK, otherwise error message