com.ibm.eNetwork.ECL.screenreco
Class ECLSDCursor

java.lang.Object
  |
  +--com.ibm.eNetwork.ECL.screenreco.ECLScreenDescriptor
        |
        +--com.ibm.eNetwork.ECL.screenreco.ECLSDCursor

All Implemented Interfaces:

com.ibm.eNetwork.HOD.common.HODConstants, java.io.Serializable

public class ECLSDCursor

extends ECLScreenDescriptor

This class is the descriptor class used to describe the cursor position on a host screen. When the descriptor is instantiated, it may be added to an object of the ECLScreenDesc class. The ECLScreenDesc class may then be used in either the ECLScreenReco class or the ECLPS WaitForScreen methods to reliably wait for the screen described by ECLScreenDesc to appear in the Presentation Space.

The cursor position descriptor simply specifies the cursor row and column for a screen that you wish to describe. You can set the row and column by using the appropriate constructor or by calling the set methods.

Once you have created the descriptor, you may add it to an ECLScreenDesc object by calling ECLScreenDesc.AddDescriptor.

Note that some of the methods below are intended specifically for macro programming, as indicated.

See Also:

ECLScreenReco, ECLScreenDesc, ECLScreenDescriptor, ECLSDAttrib, ECLSDCustom, ECLSDFields, ECLSDInputFields, ECLSDOIA, ECLSDString, ECLSDVarUpdate, ECLPS, ECLField, 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

ECLSDCursor()
Default constructor for a cursor descriptor.

ECLSDCursor(int row, int col, boolean opt)
Constructs a cursor descriptor with the given parameters.

Method Summary

java.util.Vector	Create(java.util.Hashtable argTable) Creates a working instance of the descriptor from the string values contained in the hash table.
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 cursor descriptor
java.lang.String	GetColRaw() Returns the expression form of the column position for the cursor descriptor.
int	GetRow() Returns the row position for the cursor descriptor.
java.lang.String	GetRowRaw() Returns the expression form of the row position for the cursor descriptor.
void	SetCol(int col) Sets the column position for the cursor descriptor
void	SetCol(java.lang.String argCol) Sets the column position for the cursor descriptor.
void	SetRow(int row) Sets the row position for the cursor descriptor
void	SetRow(java.lang.String argRow) Sets the row position for the cursor descriptor.

Methods inherited from class com.ibm.eNetwork.ECL.screenreco.ECLScreenDescriptor

IsInvertMatch, IsInvertMatchRaw, IsMatch, IsOptional, IsOptionalRaw, SetInvertMatch, SetInvertMatch, SetMatch, SetOptional, SetOptional

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ECLSDCursor

public ECLSDCursor()

Default constructor for a cursor descriptor. Cursor row/col positions will be 1.

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

ECLSDCursor

public ECLSDCursor(int row,
                   int col,
                   boolean opt)

Constructs a cursor descriptor with the given parameters.

This constructor will create a usable descriptor. No set methods need be called.

Parameters:

row - row position for the cursor

col - column position for the cursor.

opt - if true, descriptor is optional

Method Detail

Format

public java.lang.String Format(int argType,
                               boolean displayAll)

Formats the action object's contents into a readable string. Intended for visual feedback, like with the ECLRecoDebugEvent class.

Overrides:

Format in class ECLScreenDescriptor

Parameters:

argType - reserved for future use

displayAll - if true all returned string contains all tags including those that are not explicitly set else returned string contains only those tags that are explicitly set

Returns:

formatted string that reflects the contents of the descriptor

GetRow

public int GetRow()

Returns the row position for the cursor descriptor.

Returns:

row position for the cursor

GetRowRaw

public java.lang.String GetRowRaw()

Returns the expression form of the row position for the cursor descriptor. Intended for macro programming use.

Returns:

expression form of the row position for the cursor

SetRow

public void SetRow(int row)

Sets the row position for the cursor descriptor

Parameters:

row - row position for the cursor

SetRow

public void SetRow(java.lang.String argRow)

Sets the row position for the cursor descriptor. Intended for macro programming use.

Parameters:

expression - row position for the cursor

GetCol

public int GetCol()

Returns the column position for the cursor descriptor

Returns:

column position for the cursor

GetColRaw

public java.lang.String GetColRaw()

Returns the expression form of the column position for the cursor descriptor. Intended for macro programming use.

Returns:

expression form of the column position for the cursor

SetCol

public void SetCol(int col)

Sets the column position for the cursor descriptor

Parameters:

col - column position for the cursor.

SetCol

public void SetCol(java.lang.String argCol)

Sets the column position for the cursor descriptor. Intended for macro programming use.

Parameters:

expression - column position for the cursor.

Create

public java.util.Vector Create(java.util.Hashtable argTable)

Creates a working instance of the descriptor from the string values contained in the hash table.

Overrides:

Create in class ECLScreenDescriptor

Parameters:

argTable - hash table that contains all the valid parameters.
Consult this document: Host Access Beans for Java : Appendix A. Macro Script Syntax