Package adams.scripting.command.gui

Class MenuItem

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.scripting.command.AbstractCommand

adams.scripting.command.AbstractFlowAwareCommand

adams.scripting.command.gui.MenuItem

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, FlowContextHandler, FlowAwareRemoteCommand, RemoteCommand, Serializable

public class MenuItem
extends AbstractFlowAwareCommand

Launches the specified menu item on the remote machine.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected BaseString[]	m_AdditionalParameters	additional paramers.
protected AbstractBasicMenuItemDefinition	m_MenuItem	the menu item to executre.

Fields inherited from class adams.scripting.command.AbstractFlowAwareCommand

m_FlowContext

Fields inherited from class adams.scripting.command.AbstractCommand

m_RemoteScriptingEngineHandler, m_Request

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Fields inherited from interface adams.scripting.command.RemoteCommand

KEY_COMMAND, KEY_TYPE, VALUE_REQUEST, VALUE_RESPONSE

Constructor Summary

Constructors

Constructor	Description
MenuItem()

Method Summary

Modifier and Type	Method	Description
String	additionalParametersTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected String	doHandleRequest(RemoteScriptingEngine engine, RemoteCommandProcessor processor)	Handles the request.
BaseString[]	getAdditionalParameters()	Returns the (optional) additional parameters for the menu item, in case it implements AdditionalParameterHandler.
AbstractBasicMenuItemDefinition	getMenuItem()	Returns the class label index (1-based index).
byte[]	getRequestPayload()	Returns the payload of the request, if any.
Object[]	getRequestPayloadObjects()	Returns the objects that represent the request payload.
String	globalInfo()	Returns a string describing the object.
String	menuItemTipText()	Returns the tip text for this property.
void	setAdditionalParameters(BaseString[] value)	Sets the (optional) additional parameters for the menu item, in case it implements AdditionalParameterHandler.
void	setMenuItem(AbstractBasicMenuItemDefinition value)	Sets the class label index (1-based index).
void	setRequestPayload(byte[] value)	Sets the payload for the request.

Methods inherited from class adams.scripting.command.AbstractFlowAwareCommand

getFlowContext, initialize, setFlowContext

Methods inherited from class adams.scripting.command.AbstractCommand

afterSendRequest, assembleRequest, assembleRequestHeader, beforeSendRequest, getRemoteScriptingEngineHandler, handleRequest, isRequest, parse, prepareRequestPayload, setRemoteScriptingEngineHandler, setRequest, toString

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine

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

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.logging.LoggingSupporter

getLogger, isLoggingEnabled

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Methods inherited from interface adams.scripting.command.RemoteCommand

afterSendRequest, assembleRequest, beforeSendRequest, getRemoteScriptingEngineHandler, handleRequest, isRequest, parse, setRemoteScriptingEngineHandler, setRequest

Field Detail

m_MenuItem

protected AbstractBasicMenuItemDefinition m_MenuItem

the menu item to executre.

m_AdditionalParameters

protected BaseString[] m_AdditionalParameters

additional paramers.

Constructor Detail

MenuItem

public MenuItem()

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

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface OptionHandler

Overrides:

defineOptions in class AbstractOptionHandler

setMenuItem

public void setMenuItem(AbstractBasicMenuItemDefinition value)

Sets the class label index (1-based index).

Parameters:

value - the index

getMenuItem

public AbstractBasicMenuItemDefinition getMenuItem()

Returns the class label index (1-based index).

Returns:

the index

menuItemTipText

public String menuItemTipText()

Returns the tip text for this property.

Returns:

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

setAdditionalParameters

public void setAdditionalParameters(BaseString[] value)

Sets the (optional) additional parameters for the menu item, in case it implements AdditionalParameterHandler.

Parameters:

value - the parameters

getAdditionalParameters

public BaseString[] getAdditionalParameters()

Returns the (optional) additional parameters for the menu item, in case it implements AdditionalParameterHandler.

Returns:

the parameters

additionalParametersTipText

public String additionalParametersTipText()

Returns the tip text for this property.

Returns:

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

setRequestPayload

public void setRequestPayload(byte[] value)

Sets the payload for the request.

Parameters:

value - the payload

getRequestPayload

public byte[] getRequestPayload()

Returns the payload of the request, if any.

Returns:

the payload

getRequestPayloadObjects

public Object[] getRequestPayloadObjects()

Returns the objects that represent the request payload.

Returns:

the objects

doHandleRequest

protected String doHandleRequest(RemoteScriptingEngine engine,
                                 RemoteCommandProcessor processor)

Handles the request.

Specified by:

doHandleRequest in class AbstractCommand

Parameters:

engine - the remote engine handling the request

processor - the processor for formatting/parsing

Returns:

null if successful, otherwise error message