All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.eNetwork.ECL.screenreco.ECLSDCursor

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

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.

See Also:
ECLScreenReco, ECLScreenDesc, ECLScreenDescriptor, ECLSDAttrib, ECLSDCustom, ECLSDFields, ECLSDInputFields, ECLSDOIA, ECLSDString, ECLPS, ECLField

Constructor Index

 o ECLSDCursor()
Default constructor for a cursor descriptor.
 o ECLSDCursor(int, int, boolean)
Constructs a cursor descriptor with the given parameters.

Method Index

 o Create(Hashtable)
Creates a working instance of the descriptor from the string values contained in the hash table.
 o Format(int, boolean)
Formats the action object's contents into a readable string.
 o GetCol()
Returns the column position for the cursor descriptor
 o GetRow()
Returns the row position for the cursor descriptor.
 o SetCol(int)
Sets the column position for the cursor descriptor
 o SetRow(int)
Sets the row position for the cursor descriptor

Constructors

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

 o 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

Methods

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

Parameters:
argType - type of string to produce (reserved for future use)
displayAll - formats the default values also
Returns:
formatted string that reflects the contents of the descriptor
Overrides:
Format in class ECLScreenDescriptor
 o GetRow
 public int GetRow()
Returns the row position for the cursor descriptor.

Returns:
row position for the cursor
 o SetRow
 public void SetRow(int row)
Sets the row position for the cursor descriptor

Parameters:
row - row position for the cursor
 o GetCol
 public int GetCol()
Returns the column position for the cursor descriptor

Returns:
column position for the cursor
 o SetCol
 public void SetCol(int col)
Sets the column position for the cursor descriptor

Parameters:
col - column position for the cursor.
 o Create
 public Vector Create(Hashtable argTable)
Creates a working instance of the descriptor from the string values contained in the hash table.

Parameters:
argTable - hash table that contains all the valid parameters. Consult Host Access Beans for Java : Appendix A. Macro Script Syntax
Overrides:
Create in class ECLScreenDescriptor

All Packages  Class Hierarchy  This Package  Previous  Next  Index