com.ibm.eNetwork.beans.HOD
Class MacroActionMessage

java.lang.Object
  |
  +--com.ibm.eNetwork.beans.HOD.MacroAction
        |
        +--com.ibm.eNetwork.beans.HOD.MacroActionMessage
All Implemented Interfaces:
com.ibm.eNetwork.HOD.common.HODConstants, com.ibm.eNetwork.beans.HOD.macro.parser.MacroParsable, java.io.Serializable

public class MacroActionMessage
extends MacroAction

This class represents one message action associated with a MacroScreen object. For the message action, the Macro bean fires an event with the message to any registered message listeners.

See Also:
Serialized Form

Fields inherited from interface com.ibm.eNetwork.HOD.common.HODConstants
DEFAULT_WIN_FONT, HOD_ICON_EVENT, HOD_MSG_FILE, HOD_RAS_COMPID_ASSOC_PRT, HOD_RAS_COMPID_BLINKREMAP, HOD_RAS_COMPID_CODEPAGE, HOD_RAS_COMPID_COLORREMAP, HOD_RAS_COMPID_CONFIG, HOD_RAS_COMPID_FILETRANSFER, HOD_RAS_COMPID_FTP_SCREEN, HOD_RAS_COMPID_FTP_SESSION, HOD_RAS_COMPID_FTP_TERMINAL, HOD_RAS_COMPID_FUDOMA, HOD_RAS_COMPID_IMPEXP, HOD_RAS_COMPID_JNILOAD, HOD_RAS_COMPID_KEYPAD, HOD_RAS_COMPID_KEYREMAP, HOD_RAS_COMPID_MACRO, HOD_RAS_COMPID_MACROMANGR, HOD_RAS_COMPID_PRT_TERMINAL, HOD_RAS_COMPID_SCREEN, HOD_RAS_COMPID_SESSION, HOD_RAS_COMPID_SESSION_MGR, HOD_RAS_COMPID_SLP, HOD_RAS_COMPID_TERMINAL, HOD_RAS_FUNC_NAME, HOD_START_UP, HOD_TRANSFER_FILE_INFO, MOUSE_DOUBLE_CLICK_THRESHOLD, XFER_ASCII_GET_OPTIONS, XFER_ASCII_GET_OPTIONS_DEFAULT, XFER_ASCII_PUT_OPTIONS, XFER_ASCII_PUT_OPTIONS_DEFAULT, XFER_BINARY_GET_OPTIONS, XFER_BINARY_GET_OPTIONS_DEFAULT, XFER_BINARY_PUT_OPTIONS, XFER_BINARY_PUT_OPTIONS_DEFAULT, XFER_DEFAULT_OPTIONS, XFER_FILETYPE_DTA, XFER_FILETYPE_SAVF, XFER_FILETYPE_SRC, XFER_HOST_TYPE, XFER_HOST_TYPE_CICS, XFER_HOST_TYPE_CMS, XFER_HOST_TYPE_DEFAULT, XFER_HOST_TYPE_OS400, XFER_HOST_TYPE_TSO, XFER_PACKET_SIZE, XFER_PACKET_SIZE_DEFAULT, XFER_TIME_OUT_VALUE, XFER_TIME_OUT_VALUE_DEFAULT, XFER_TRANSFER_MODE, XFER_TRANSFER_MODE_ASCII, XFER_TRANSFER_MODE_BINARY, XFER_TRANSFER_MODE_DEFAULT
 
Constructor Summary
MacroActionMessage()
          Constructs an empty instance of a macro message action.
MacroActionMessage(java.lang.String argMessage, java.lang.String argTitle)
          Constructs a functional instance of a macro message action with the given parameter.
 
Method Summary
 void execute()
          Executes the macro message action.
 java.lang.String format(int argType, boolean formatAll)
          Formats the action object's contents into a readable string.
 java.lang.String getMessage()
          Returns the message text
 java.lang.String getMessageRaw()
          Returns the expression form of the message text
 java.lang.String getTitle()
          Returns the title text
 java.lang.String getTitleRaw()
          Returns the expression form of the title text
 void setMessage(java.lang.String argMessage)
          Sets the message text.
 void setTitle(java.lang.String argTitle)
          Sets the message title.
 
Methods inherited from class com.ibm.eNetwork.beans.HOD.MacroAction
clone, halt, setECLSession, setOwner, setRuntimeListeners
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.eNetwork.beans.HOD.macro.parser.MacroParsable
setAttributes, setError
 

Constructor Detail

MacroActionMessage

public MacroActionMessage()
Constructs an empty instance of a macro message action.

If you use this constructor, you must call all the set methods of this class to properly set up the action.


MacroActionMessage

public MacroActionMessage(java.lang.String argMessage,
                          java.lang.String argTitle)
Constructs a functional instance of a macro message action with the given parameter.
Parameters:
argMessage - message text
argTitle - title string
Method Detail

execute

public void execute()
Executes the macro message action.
Overrides:
execute in class MacroAction

getMessage

public java.lang.String getMessage()
Returns the message text
Returns:
message string

getMessageRaw

public java.lang.String getMessageRaw()
Returns the expression form of the message text
Returns:
expression form of the message string

setMessage

public void setMessage(java.lang.String argMessage)
Sets the message text.
Parameters:
argMessage - message string to set

getTitle

public java.lang.String getTitle()
Returns the title text
Returns:
title string

getTitleRaw

public java.lang.String getTitleRaw()
Returns the expression form of the title text
Returns:
expression form of the title string

setTitle

public void setTitle(java.lang.String argTitle)
Sets the message title.
Parameters:
argTitle - title string to set

format

public java.lang.String format(int argType,
                               boolean formatAll)
Formats the action object's contents into a readable string. Intended for visual feedback, as with the MacroDebugActionEvent class.
Overrides:
format in class MacroAction
Parameters:
argType - reserved, currently only XML strings are supported
formatAll - if true, optional parameters will be formatted also
Returns:
formatted string that reflects the contents of the action