All Packages Class Hierarchy This Package Previous Next Index
Class com.ibm.eNetwork.beans.HOD.MacroActionBoxSelect
java.lang.Object
|
+----com.ibm.eNetwork.beans.HOD.MacroAction
|
+----com.ibm.eNetwork.beans.HOD.MacroActionBoxSelect
- public class MacroActionBoxSelect
- extends MacroAction
- implements ECLConstants
This class represents one box selection action associated with
a MacroScreen object. The box selection action is used for either
marking or unmarking the marking rectangle on the Terminal bean.
Among others, it allows you to record and play rectangle actions
to facilitate an input action with the [copy] key mnemonic in it. With
this support, you can cut text from one screen and paste it on another
screen that is several screens away in the macro's screen flow.
- See Also:
- Macro
-
DESELECT
- Used for get/setType.
-
SELECT
- Used for get/setType.
-
MacroActionBoxSelect()
- Constructs an empty instance of a macro box selection action.
-
MacroActionBoxSelect(int, int, int, int, int)
- Constructs a functional instance of a macro box selection action with
the given parameters.
-
execute()
- Executes the macro box selection action.
-
format(int, boolean)
- Formats the action object's contents into a readable string.
-
getECol()
- Returns the lower right column for the box selection area.
-
getERow()
- Returns the lower right row for the box selection area.
-
getSCol()
- Returns the upper left column for the box selection area.
-
getSRow()
- Returns the upper left row for the box selection area.
-
getType()
- Returns the type for the selection action.
-
setECol(int)
- Sets the lower right column for the box selection area.
-
setERow(int)
- Sets the lower right row for the box selection area.
-
setSCol(int)
- Sets the upper left column for the box selection area.
-
setSRow(int)
- Sets the upper left row for the box selection area.
-
setTerminal(Terminal)
- Sets the Host On-Demand Terminal Java bean for the box selection action.
-
setType(int)
- Sets the type for the selection action.
-
string2Type(String)
- Returns an integer that represents the type for the selection action.
-
type2String(int)
- Returns a string that represents the type for the selection action.
SELECT
public static final int SELECT
- Used for get/setType. Causes the action to mark the rectangle.
- See Also:
- setType
DESELECT
public static final int DESELECT
- Used for get/setType. Causes the action to unmark the rectangle.
- See Also:
- setType
MacroActionBoxSelect
public MacroActionBoxSelect()
- Constructs an empty instance of a macro box selection action.
If you use this constructor you must call all the set methods of this
class to properly set up the action.
MacroActionBoxSelect
public MacroActionBoxSelect(int argSRow,
int argSCol,
int argERow,
int argECol,
int argType)
- Constructs a functional instance of a macro box selection action with
the given parameters.
- Parameters:
- argSRow - upper left row for the box selection area
- argSCol - upper left column for the box selection area
- argERow - lower right row for the box selection area
- argECol - lower right column for the box selection area
- argType - type of selection, may be either MacroActionBoxSelect.SELECT or MacroActionBoxSelect.DESELECT
execute
public void execute()
- Executes the macro box selection action. Note: if the Macro bean is
not connected to a Terminal bean (connecting to Session bean) this
execute method will do nothing.
- Overrides:
- execute in class MacroAction
getSRow
public int getSRow()
- Returns the upper left row for the box selection area.
- Returns:
- upper left row
setSRow
public void setSRow(int argSRow)
- Sets the upper left row for the box selection area.
- Parameters:
- argSRow - upper left row for the box selection area
getSCol
public int getSCol()
- Returns the upper left column for the box selection area.
- Returns:
- upper left column
setSCol
public void setSCol(int argSCol)
- Sets the upper left column for the box selection area.
- Parameters:
- argSCol - upper left column for the box selection area
getERow
public int getERow()
- Returns the lower right row for the box selection area.
- Returns:
- lower right row
setERow
public void setERow(int argERow)
- Sets the lower right row for the box selection area.
- Parameters:
- argERow - lower right row for the box selection area
getECol
public int getECol()
- Returns the lower right column for the box selection area.
- Returns:
- lower right column
setECol
public void setECol(int argECol)
- Sets the lower right column for the box selection area.
- Parameters:
- argECol - lower right column for the box selection area
setTerminal
public void setTerminal(Terminal argTerminal)
- Sets the Host On-Demand Terminal Java bean for the box selection action.
- Parameters:
- com.ibm.eNetwork.beans.HOD.Terminal - argTerminal Terminal bean to be used for the selection
getType
public int getType()
- Returns the type for the selection action. May be either
MacroActionBoxSelect.SELECT or MacroActionBoxSelect.DESELECT.
- Returns:
- selection type
setType
public void setType(int argType)
- Sets the type for the selection action. May be either
MacroActionBoxSelect.SELECT or MacroActionBoxSelect.DESELECT.
type2String
public static String type2String(int argType)
- Returns a string that represents the type for the selection action.
Will return either "SELECT" or "DESELECT". If an unrecognized type
value is returned, the default of "SELECT" will just be returned.
- Returns:
- java.lang.String selection type as a String
string2Type
public static int string2Type(String argType)
- Returns an integer that represents the type for the selection action.
Will return MacroActionBoxSelect.SELECT for "SELECT" or
MacroActionBoxSelect.DESELECT for "DESELECT". If an unrecognized type
value is returned, the default of MacroActionBoxSelect.SELECT will
just be returned.
- Returns:
- java.lang.int selection type as an integer
format
public 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.
- 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
- Overrides:
- format in class MacroAction
All Packages Class Hierarchy This Package Previous Next Index