com.ibm.eNetwork.beans.HOD
Class MacroActionInput

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

public class MacroActionInput
extends MacroAction

This class represents one input action associated with a MacroScreen object. The input action is used for placing text and host aid keys on a host screen. This is a fairly static way of placing text. That is, there is no way to change the action's text that it will place during the runtime of the Macro bean (this is possible using the MacroPromptAction).

There are two classifications of input that the Macro bean understands: literal text and text with host aid keys in it. Host aid keys are function keys, such as the Enter key, Clear key, and so forth. If setTranslateHostKeys is called with a false value, then all the characters in the action are placed on the host screen.

"hello IBM[enter]" places "hello IBM[enter]" on the screen

If setTranslateHostKeys is called with a true value, host aid keys embedded in the input text are translated. The valid aid key mnemonics are specified in IBM Host Access Class Library.

"hello IBM[enter]" places "hello IBM" on the screen and then sends the host enter key

Note: if row/column position is not specified (either value is 0), then the current cursor position will be used.

See Also:
Macro, MacroActionPrompt, Serialized Form

Fields inherited from interface com.ibm.eNetwork.HOD.common.HODConstants
DEFAULT_WIN_FONT, HOD_ICON_EVENT, HOD_MSG_FILE, HOD_RAS_COMPID_ADVMACRO, 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_HOD_API, 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_COMPID_ZIPPRINT, 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
MacroActionInput()
          Constructs an empty instance of a macro input action.
MacroActionInput(java.lang.String argText, boolean argXlateAid, boolean argMoveCursor, com.ibm.eNetwork.ECL.ECLPS argPS)
          Constructs a functional instance of a macro input action with the given parameters.
MacroActionInput(java.lang.String argText, int argRow, int argCol, boolean argXlateAid, boolean argMoveCursor, com.ibm.eNetwork.ECL.ECLPS argPS)
          Constructs a functional instance of a macro input action with the given parameters.
 
Method Summary
 void execute()
          Executes the macro input action.
 java.lang.String format(int argType, boolean displayAll)
          Formats the action object's contents into a readable string.
 int getCol()
          Returns the starting column position for the input action.
 java.lang.String getColRaw()
          Returns the expression form of the starting column position for the input action.
 int getRow()
          Returns the starting row position for the input action.
 java.lang.String getRowRaw()
          Returns the expression form of the starting row position for the input action.
 java.lang.String getText()
          Returns the text for the input action.
 java.lang.String getTextRaw()
          Returns the expression form of the text for the input action.
 boolean isEncrypted()
          Returns whether the input action data should be hidden, like with a password.
 java.lang.String isEncryptedRaw()
          Returns the expression form of whether the input action data should be hidden, like with a password.
 boolean isMoveCursor()
          Returns whether the cursor will be moved by the input action or not.
 java.lang.String isMoveCursorRaw()
          Returns expression form of whether the cursor will be moved by the input action or not.
 boolean isTranslateHostKeys()
          Returns if the input text will be literal or translated for host aid keys.
 java.lang.String isTranslateHostKeysRaw()
          Returns the expression form of if the input text will be literal or translated for host aid keys.
 void setCol(int argC)
          Sets the starting column position for the input action.
 void setCol(java.lang.String argC)
          Sets the starting column position for the input action.
 void setEncrypted(boolean argEncrypt)
          Sets whether the input action data should be hidden, as with a password.
 void setEncrypted(java.lang.String argEncrypt)
          Sets whether the input action data should be hidden, as with a password.
 void setMoveCursor(boolean argMC)
          Sets whether the cursor will be moved by the input action or not.
 void setMoveCursor(java.lang.String argMC)
          Sets whether the cursor will be moved by the input action or not.
 void setRow(int argR)
          Sets the starting row position for the input action.
 void setRow(java.lang.String argR)
          Sets the starting row position for the input action.
 void setText(java.lang.String argText)
          Sets the text for the input action.
 void setTranslateHostKeys(boolean argVal)
          Sets if the input text will be literal or translated for host aid keys.
 void setTranslateHostKeys(java.lang.String argVal)
          Sets if the input text will be literal or translated for host aid keys.
 
Methods inherited from class com.ibm.eNetwork.beans.HOD.MacroAction
clone, equals, halt, setECLSession, setOwner, setRuntimeListeners
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.eNetwork.beans.HOD.macro.parser.MacroParsable
setAttributes, setError
 

Constructor Detail

MacroActionInput

public MacroActionInput()
Constructs an empty instance of a macro input action.

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


MacroActionInput

public MacroActionInput(java.lang.String argText,
                        boolean argXlateAid,
                        boolean argMoveCursor,
                        com.ibm.eNetwork.ECL.ECLPS argPS)
Constructs a functional instance of a macro input action with the given parameters. Row and column positioning will be ignored unless you call the set method for each.

Note: if control character nemonics are embedded in the text parameter, they will be converted to their appropriate value. For example, [Ctrl-Z] (case sensitive!) will be converted to (char)0x1A. Valid values are [Ctrl-A] through [Ctrl-Z].

Parameters:
argText - text for the input
argXlateAid - if true, the host aid keys will be translated
argMoveCursor - if true, the cursor is moved to the end of the input
argPS - ECLPS object that the action will input to when executed

MacroActionInput

public MacroActionInput(java.lang.String argText,
                        int argRow,
                        int argCol,
                        boolean argXlateAid,
                        boolean argMoveCursor,
                        com.ibm.eNetwork.ECL.ECLPS argPS)
Constructs a functional instance of a macro input action with the given parameters.

Note: if control character mnemonics are embedded in the text parameter, they will be converted to their appropriate value. For example, [Ctrl-Z] (case sensitive!) will be converted to (char)0x1A. Valid values are [Ctrl-A] through [Ctrl-Z].

Parameters:
argText - text for the input
argRow - row position where the input starts
argCol - column position where the input starts
argXlateAid - if true, the host aid keys will be translated
argMoveCursor - if true, the cursor is moved to the end of the input
argPS - ECLPS object that the action will input to when executed
Method Detail

getRow

public int getRow()
Returns the starting row position for the input action.
Returns:
input row position

getRowRaw

public java.lang.String getRowRaw()
Returns the expression form of the starting row position for the input action.
Returns:
expression form of the input row position

setRow

public void setRow(int argR)
Sets the starting row position for the input action.
Parameters:
argRow - row position where the input starts

setRow

public void setRow(java.lang.String argR)
Sets the starting row position for the input action.
Parameters:
expression - row position where the input starts

getCol

public int getCol()
Returns the starting column position for the input action.
Returns:
input column position

getColRaw

public java.lang.String getColRaw()
Returns the expression form of the starting column position for the input action.
Returns:
expression form of the input column position

setCol

public void setCol(int argC)
Sets the starting column position for the input action.
Parameters:
argCol - column position where the input starts

setCol

public void setCol(java.lang.String argC)
Sets the starting column position for the input action.
Parameters:
expression - column position where the input starts

getText

public java.lang.String getText()
Returns the text for the input action.
Returns:
input text string

getTextRaw

public java.lang.String getTextRaw()
Returns the expression form of the text for the input action.
Returns:
expression form of the input text string

setText

public void setText(java.lang.String argText)
Sets the text for the input action.

Note: if control character mnemonics are embedded in the text parameter, they will be converted to their appropriate value. For example, [Ctrl-Z] (case sensitive!) will be converted to (char)0x1A. Valid values are [Ctrl-A] through [Ctrl-Z].

Parameters:
argText - text for the input

isMoveCursor

public boolean isMoveCursor()
Returns whether the cursor will be moved by the input action or not. This only applies when the inputType property is set to INPUT_LITERAL.
Returns:
if true, the cursor is moved by the action

isMoveCursorRaw

public java.lang.String isMoveCursorRaw()
Returns expression form of whether the cursor will be moved by the input action or not. This only applies when the inputType property is set to INPUT_LITERAL.
Returns:
if expression evaluates to true, the cursor is moved by the action

setMoveCursor

public void setMoveCursor(boolean argMC)
Sets whether the cursor will be moved by the input action or not. This only applies when the inputType property is set to INPUT_LITERAL.
Parameters:
argMoveCursor - if true, the cursor is moved to the end of the input

setMoveCursor

public void setMoveCursor(java.lang.String argMC)
Sets whether the cursor will be moved by the input action or not. This only applies when the inputType property is set to INPUT_LITERAL.
Parameters:
expression - if true, the cursor is moved to the end of the input

setTranslateHostKeys

public void setTranslateHostKeys(boolean argVal)
Sets if the input text will be literal or translated for host aid keys. The action will translate host aid keys by default.
Parameters:
argVal - if true host aid key translation will take place, if false, all the characters in the text will be placed on the PS.

setTranslateHostKeys

public void setTranslateHostKeys(java.lang.String argVal)
Sets if the input text will be literal or translated for host aid keys. The action will translate host aid keys by default.
Parameters:
expression - if expression evaluates to true host aid key translation will take place, if false, all the characters in the text will be placed on the PS.

isTranslateHostKeys

public boolean isTranslateHostKeys()
Returns if the input text will be literal or translated for host aid keys.
Returns:
input type, literal or host aid key translation

isTranslateHostKeysRaw

public java.lang.String isTranslateHostKeysRaw()
Returns the expression form of if the input text will be literal or translated for host aid keys.
Returns:
expression form of the input type, literal or host aid key translation

execute

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

format

public java.lang.String format(int argType,
                               boolean displayAll)
Formats the action object's contents into a readable string. Intended for visual feedback, as with the MacroDebugActionEvent class.

Note: if control character are embedded in the input text, they will be converted to their appropriate value. For example, (char)0x1A will be converted to [Ctrl-Z] (case sensitive!). Valid values are [Ctrl-A] through [Ctrl-Z].

Overrides:
format in class MacroAction
Parameters:
argType - reserved, currently only XML strings are supported
displayAll - if true, optional parameters are formatted also
Returns:
formatted string that reflects the contents of the action

isEncrypted

public boolean isEncrypted()
Returns whether the input action data should be hidden, like with a password.
Returns:
if true, input action data should not be displayed

isEncryptedRaw

public java.lang.String isEncryptedRaw()
Returns the expression form of whether the input action data should be hidden, like with a password.
Returns:
if expression evaluates to true, input action data should not be displayed

setEncrypted

public void setEncrypted(boolean argEncrypt)
Sets whether the input action data should be hidden, as with a password.
Parameters:
argEncrypt - if true, indicates that input data should not be displayed (example, passwords)

setEncrypted

public void setEncrypted(java.lang.String argEncrypt)
Sets whether the input action data should be hidden, as with a password.
Parameters:
expression - if true, indicates that input data should not be displayed (example, passwords)