com.ibm.eNetwork.beans.HOD
Class MacroActionMouseClick

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

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, 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
MacroActionMouseClick()
          Constructs an empty instance of a macro mouse click action.
MacroActionMouseClick(int argRow, int argCol)
          Constructs an working instance of a macro mouse click action.
 
Method Summary
 void execute()
          Executes the macro mouse click action.
 java.lang.String format(int argType, boolean displayAll)
          Formats the action object's contents into a readable string.
 int getCol()
          Returns the column position for the mouse click action.
 java.lang.String getColRaw()
          Returns the expression form of the column position for the mouse click action.
 int getRow()
          Returns the row position for the mouse click action.
 java.lang.String getRowRaw()
          Returns the expression form of the row position for the mouse click action.
 void setCol(int argCol)
          Sets the column position for the mouse click action.
 void setCol(java.lang.String argCol)
          Sets the column position for the mouse click action.
 void setRow(int argRow)
          Sets the row position for the mouse click action.
 void setRow(java.lang.String argRow)
          Sets the row position for the mouse click action.
 
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

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.


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
Method Detail

getRow

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

getRowRaw

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

setRow

public void setRow(int argRow)
Sets the row position for the mouse click action.
Parameters:
argRow - row position where the mouse starts

setRow

public void setRow(java.lang.String argRow)
Sets the row position for the mouse click action.
Parameters:
expression - row position where the mouse starts

getCol

public int getCol()
Returns the column position for the mouse click action.
Returns:
mouse column position

getColRaw

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

setCol

public void setCol(int argCol)
Sets the column position for the mouse click action.
Parameters:
argCol - column position where the mouse starts

setCol

public void setCol(java.lang.String argCol)
Sets the column position for the mouse click action.
Parameters:
expression - column position where the mouse starts

execute

public void execute()
Executes the macro mouse click action. Does nothing if ECLSession is not set.
Overrides:
execute in class MacroAction
See Also:
MacroAction.setECLSession(ECLSession)

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