Package adams.gui.flow.tree.keyboardaction

Class AbstractAddTemplate

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

All Implemented Interfaces:

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

Direct Known Subclasses:

AddTemplateAfter, AddTemplateBeneath, AddTemplateHere

public abstract class AbstractAddTemplate
extends AbstractKeyboardAction

Ancestor for actions that add a template.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected AbstractActorTemplate	m_Template	the template to use.

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

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.
protected abstract AbstractActorTemplate	getDefaultTemplate()	Returns the default template of the action.
AbstractActorTemplate	getTemplate()	Returns the template of the action.
void	setTemplate(AbstractActorTemplate value)	Sets the template of the action.
String	templateTipText()	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_Template

protected AbstractActorTemplate m_Template

the template to use.

Constructor Detail

AbstractAddTemplate

public AbstractAddTemplate()

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

getDefaultTemplate

protected abstract AbstractActorTemplate getDefaultTemplate()

Returns the default template of the action.

Returns:

the default

setTemplate

public void setTemplate(AbstractActorTemplate value)

Sets the template of the action.

Parameters:

value - the template

getTemplate

public AbstractActorTemplate getTemplate()

Returns the template of the action.

Returns:

the template

templateTipText

public String templateTipText()

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