All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.eNetwork.beans.HOD.MacroActionMouseClick

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

public class MacroActionMouseClick
extends MacroAction
This class represents one mouse click action associated with a MacroScreen object. The click action is used for simulating a user mouse click on the Terminal bean. The essentially just sets the cursor at a given row and column position.

See Also:
Macro

Constructor Index

 o MacroActionMouseClick()
Constructs an empty instance of a macro mouse click action.
 o MacroActionMouseClick(int, int)
Constructs an working instance of a macro mouse click action.

Method Index

 o execute()
Executes the macro mouse click action.
 o format(int, boolean)
Formats the action object's contents into a readable string.
 o getCol()
Returns the column position for the mouse click action.
 o getRow()
Returns the row position for the mouse click action.
 o setAttributes(Hashtable)
Sets all the basic attributes for the Macro action from the String contents in the given hash table.
 o setCol(int)
Sets the column position for the mouse click action.
 o setRow(int)
Sets the row position for the mouse click action.

Constructors

 o MacroActionMouseClick
 public MacroActionMouseClick()
Constructs an empty instance of a macro mouse click action.

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

 o MacroActionMouseClick
 public MacroActionMouseClick(int argRow,
                              int argCol)
Constructs an working instance of a macro mouse click action.

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

Parameters:
argRow - row position for the mouse click
argCol - row position for the mouse click

Methods

 o getRow
 public int getRow()
Returns the row position for the mouse click action.

Returns:
mouse row position
 o setRow
 public void setRow(int argRow)
Sets the row position for the mouse click action.

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

Returns:
mouse column position
 o setCol
 public void setCol(int argCol)
Sets the column position for the mouse click action.

Parameters:
argCol - column position where the mouse starts
 o execute
 public void execute()
Executes the macro mouse click 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.

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 setAttributes
 public MacroParseEvent setAttributes(Hashtable ht) throws MacroException
Sets all the basic attributes for the Macro action from the String contents in the given hash table.

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

Parameters:
ht - hash table that contains string values of each attribute. Numeric and boolean values are converted from strings.
Overrides:
setAttributes in class MacroAction

All Packages  Class Hierarchy  This Package  Previous  Next  Index