Package adams.gui.flow.tree.keyboardaction

Class AbstractQuickSearchActor

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

All Implemented Interfaces:

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

Direct Known Subclasses:

QuickSearchActorAfter, QuickSearchActorBeneath, QuickSearchActorHere

public abstract class AbstractQuickSearchActor
extends AbstractKeyboardAction

Ancestor for actions that add an actor via a quick search list.

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.
protected ClassQuickSearchPanel	m_SearchPanel	the panel to use for searching.
protected ListSelectionListener	m_SelectionListener	the selection listener.
protected boolean	m_ShowClassTree	whether to show the class tree in the GOE.

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

Method Summary

Modifier and Type	Method	Description
protected void	addActor(StateContainer state, Actor actor, TreeOperations.InsertPosition position)	Inserts the actor
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.
boolean	getShowClassTree()	Returns whether to show the class tree in the GenericObjectEditor window.
protected void	search(StateContainer state, TreeOperations.InsertPosition position)	Allows the user to search for an actor to insert at the specified position.
void	setDisplayActorOptions(boolean value)	Sets whether to display the actor options in GOE.
void	setShowClassTree(boolean value)	Sets whether to show the class tree in the GenericObjectEditor window.
String	showClassTreeTipText()	Returns the tip text for this property.

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.

m_ShowClassTree

protected boolean m_ShowClassTree

whether to show the class tree in the GOE.

m_SearchPanel

protected transient ClassQuickSearchPanel m_SearchPanel

the panel to use for searching.

m_SelectionListener

protected transient ListSelectionListener m_SelectionListener

the selection listener.

Constructor Detail

AbstractQuickSearchActor

public AbstractQuickSearchActor()

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.

setShowClassTree

public void setShowClassTree(boolean value)

Sets whether to show the class tree in the GenericObjectEditor window.

Parameters:

value - true if to display

getShowClassTree

public boolean getShowClassTree()

Returns whether to show the class tree in the GenericObjectEditor window.

Returns:

true if to display

showClassTreeTipText

public String showClassTreeTipText()

Returns the tip text for this property.

Returns:

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

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

getActorDialogType

protected TreeOperations.ActorDialog getActorDialogType()

Returns the type of dialog to use.

Returns:

the type

addActor

protected void addActor(StateContainer state,
                        Actor actor,
                        TreeOperations.InsertPosition position)

Inserts the actor

Parameters:

state - the current state

actor - the actor to insert

position - the position to insert the actor at

search

protected void search(StateContainer state,
                      TreeOperations.InsertPosition position)

Allows the user to search for an actor to insert at the specified position.

Parameters:

state - the current state

position - the insert position