Package adams.gui.scripting

Class AbstractVisibilityScriplet

java.lang.Object

adams.core.logging.LoggingObject

adams.gui.scripting.AbstractScriptlet

adams.gui.scripting.AbstractUndoScriptlet

adams.gui.scripting.AbstractDataContainerPanelScriptlet

adams.gui.scripting.AbstractVisibilityScriplet

All Implemented Interfaces:

LoggingSupporter, SizeOfHandler, Stoppable, StoppableWithFeedback, UndoHandler, Serializable, Comparable

Direct Known Subclasses:

Invisible, Visible

public abstract class AbstractVisibilityScriplet
extends AbstractDataContainerPanelScriptlet

Ancestor for visibility-related scriptlets.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields inherited from class adams.gui.scripting.AbstractScriptlet

m_DataProvider, m_Owner, m_Parameters, m_Stopped

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
AbstractVisibilityScriplet()

Method Summary

Modifier and Type	Method	Description
protected String	getOptionsDescription()	Returns a one-line listing of the options of the action.
protected String	process(String options, boolean visible)	Processes the options.

Methods inherited from class adams.gui.scripting.AbstractDataContainerPanelScriptlet

getDataContainerPanel, getRequirements

Methods inherited from class adams.gui.scripting.AbstractUndoScriptlet

addUndoPoint, getUndo, isUndoSupported, setUndo

Methods inherited from class adams.gui.scripting.AbstractScriptlet

compareTo, doProcess, equals, forName, getAction, getBasePanel, getDataProvider, getDescription, getOwner, getParameter, getParameterDescription, getScriptlets, hashCode, hasOwner, hasParameter, initialize, isStopped, process, setDataProvider, setOwner, setParameter, showStatus, stopExecution, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractVisibilityScriplet

public AbstractVisibilityScriplet()

Method Detail

getOptionsDescription

protected String getOptionsDescription()

Returns a one-line listing of the options of the action.

Overrides:

getOptionsDescription in class AbstractScriptlet

Returns:

the options or null if none

process

protected String process(String options,
                         boolean visible)
                  throws Exception

Processes the options.

Parameters:

options - additional/optional options for the action

visible - whether to make them visible or not

Returns:

null if no error, otherwise error message

Throws:

Exception - if something goes wrong