All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.eNetwork.beans.HOD.MacroActionInput

java.lang.Object
   |
   +----com.ibm.eNetwork.beans.HOD.MacroAction
           |
           +----com.ibm.eNetwork.beans.HOD.MacroActionInput

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

Constructor Index

 o MacroActionInput()
Constructs an empty instance of a macro input action.
 o MacroActionInput(String, boolean, boolean, ECLPS)
Constructs a functional instance of a macro input action with the given parameters.
 o MacroActionInput(String, int, int, boolean, boolean, ECLPS)
Constructs a functional instance of a macro input action with the given parameters.

Method Index

 o execute()
Executes the macro input action.
 o format(int, boolean)
Formats the action object's contents into a readable string.
 o getCol()
Returns the starting column position for the input action.
 o getRow()
Returns the starting row position for the input action.
 o getText()
Returns the text for the input action.
 o isEncrypted()
Returns whether the input action data should be hidden, like with a password.
 o isMoveCursor()
Returns whether the cursor will be moved by the input action or not.
 o isTranslateHostKeys()
Returns if the input text will be literal or translated for host aid keys.
 o setCol(int)
Sets the starting column position for the input action.
 o setEncrypted(boolean)
Sets whether the input action data should be hidden, as with a password.
 o setMoveCursor(boolean)
Sets whether the cursor will be moved by the input action or not.
 o setRow(int)
Sets the starting row position for the input action.
 o setText(String)
Sets the text for the input action.
 o setTranslateHostKeys(boolean)
Sets if the input text will be literal or translated for host aid keys.

Constructors

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

 o MacroActionInput
 public MacroActionInput(String argText,
                         boolean argXlateAid,
                         boolean argMoveCursor,
                         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
 o MacroActionInput
 public MacroActionInput(String argText,
                         int argRow,
                         int argCol,
                         boolean argXlateAid,
                         boolean argMoveCursor,
                         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

Methods

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

Returns:
input row position
 o setRow
 public void setRow(int argR)
Sets the starting row position for the input action.

Parameters:
argRow - row position where the input starts
 o getCol
 public int getCol()
Returns the starting column position for the input action.

Returns:
input column position
 o setCol
 public void setCol(int argC)
Sets the starting column position for the input action.

Parameters:
argCol - column position where the input starts
 o getText
 public String getText()
Returns the text for the input action.

Returns:
input text string
 o setText
 public void setText(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
 o 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
 o 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
 o 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.
 o 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
 o execute
 public void execute()
Executes the macro input action.

Overrides:
execute in class MacroAction
 o format
 public 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].

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
Overrides:
format in class MacroAction
 o 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
 o 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)

All Packages  Class Hierarchy  This Package  Previous  Next  Index