All Packages Class Hierarchy This Package Previous Next Index
Class com.ibm.eNetwork.ECL.screenreco.ECLSDString
java.lang.Object
|
+----com.ibm.eNetwork.ECL.screenreco.ECLScreenDescriptor
|
+----com.ibm.eNetwork.ECL.screenreco.ECLSDString
- public class ECLSDString
- extends ECLScreenDescriptor
This class is the descriptor class used to describe a
single string 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 string descriptor may specify a string at either an absolute position
or inside a rectangle by using the setStringType method. Also, the string
descriptor can be set as either case sensitive or not using the setCaseSense
method.
Once you have created the descriptor, you may add it to an ECLScreenDesc
object by calling ECLScreenDesc.AddDescriptor.
- See Also:
- ECLScreenReco, ECLScreenDesc, ECLScreenDescriptor, ECLSDAttrib, ECLSDCursor, ECLSDCustom, ECLSDFields, ECLSDInputFields, ECLSDOIA, ECLPS, ECLField
-
STRING_ABSOLUTE
- Value used to specify that the string descriptor describes a string
at an absolute position.
-
STRING_INRECT
- Value used to specify that the string descriptor describes a string
that is in a rectangular area.
-
ECLSDString()
- Default constructor for a string descriptor.
-
ECLSDString(String, int, int, boolean, boolean)
- Constructs a STRING_ABSOLUTE string descriptor with the given parameters.
-
ECLSDString(String, int, int, int, int, boolean, boolean)
- Constructs a STRING_INRECT string descriptor with the given parameters.
-
Create(Hashtable)
- Creates a working instance of the descriptor from the string values
contained in the hash table.
-
Format(int, boolean)
- Formats the action object's contents into a readable string.
-
GetECol()
- Returns the ending column for the string descriptor.
-
GetERow()
- Returns the ending row for the string descriptor.
-
GetSCol()
- Returns the starting column for the string descriptor.
-
GetSRow()
- Returns the starting row for the string descriptor.
-
GetString()
- Returns the string text for the string descriptor.
-
GetStringType()
- Returns the string matching type for the string descriptor.
-
IsCaseSense()
- Returns the case sensitivity for the string descriptor.
-
SetCaseSense(boolean)
- Sets the case sensitivity for the string descriptor.
-
SetECol(int)
- Sets the ending column for the string descriptor.
-
SetERow(int)
- Sets the ending row for the string descriptor.
-
SetSCol(int)
- Sets the starting column for the string descriptor.
-
SetSRow(int)
- Sets the starting row for the string descriptor.
-
SetString(String)
- Sets the string text for the string descriptor.
-
SetStringType(int)
- Sets the string matching type for the string descriptor.
STRING_ABSOLUTE
public static final int STRING_ABSOLUTE
- Value used to specify that the string descriptor describes a string
at an absolute position. For the matching logic to pass the descriptor,
the string must start at the row/col position.
STRING_INRECT
public static final int STRING_INRECT
- Value used to specify that the string descriptor describes a string
that is in a rectangular area. For the matching logic to pass the
descriptor, the string must be within the bounding coordinates of
the rectangle. Word wrapping is not allowed.
ECLSDString
public ECLSDString()
- Default constructor for a string descriptor. String type will be
STRING_ABSOLUTE, all row/col positions will be 1, case sensitivity
will be true, and the text will be a zero length string.
If you use this constructor you must call all the set methods of this
class to properly set up the descriptor.
ECLSDString
public ECLSDString(String text,
int row,
int col,
boolean caseSense,
boolean opt)
- Constructs a STRING_ABSOLUTE string descriptor with the given parameters.
This constructor will create a usable descriptor. No set methods
need be called.
- Parameters:
- text - text to set in the string descriptor
- row - starting row for the string descriptor
- col - starting column for the string descriptor
- caseSense - if true, descriptor is caseSensitive
- opt - if true, descriptor is optional
ECLSDString
public ECLSDString(String text,
int srow,
int scol,
int erow,
int ecol,
boolean caseSense,
boolean opt)
- Constructs a STRING_INRECT string descriptor with the given parameters.
This constructor will create a usable descriptor. No set methods
need be called.
- Parameters:
- text - text to set in the string descriptor
- srow - starting row for the string descriptor
- scol - starting column for the string descriptor
- erow - ending row for the string descriptor
- ecol - ending column for the string descriptor
- caseSense - if true, descriptor is caseSensitive
- opt - if true, descriptor is optional
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
GetStringType
public int GetStringType()
- Returns the string matching type for the string descriptor.
- Returns:
- string type, either absolute position or in a rectangle
- See Also:
- STRING_ABSOLUTE, STRING_INRECT
SetStringType
public void SetStringType(int type)
- Sets the string matching type for the string descriptor.
- Parameters:
- type - type to set in the string descriptor
- See Also:
- STRING_ABSOLUTE, STRING_INRECT
GetSRow
public int GetSRow()
- Returns the starting row for the string descriptor.
- Returns:
- row position
SetSRow
public void SetSRow(int row)
- Sets the starting row for the string descriptor.
- Parameters:
- row - starting row for the string descriptor
GetSCol
public int GetSCol()
- Returns the starting column for the string descriptor.
- Returns:
- column position
SetSCol
public void SetSCol(int col)
- Sets the starting column for the string descriptor.
- Parameters:
- col - starting column for the string descriptor
GetERow
public int GetERow()
- Returns the ending row for the string descriptor. The ending row/col
values are used only for the STRING_INRECT type.
- Returns:
- row position
SetERow
public void SetERow(int row)
- Sets the ending row for the string descriptor. The ending row/col
values are used only for the STRING_INRECT type.
- Parameters:
- row - ending row for the string descriptor
GetECol
public int GetECol()
- Returns the ending column for the string descriptor. The ending row/col
values are used only for the STRING_INRECT type.
- Returns:
- column position
SetECol
public void SetECol(int col)
- Sets the ending column for the string descriptor. The ending row/col
values are used only for the STRING_INRECT type.
- Parameters:
- col - ending column for the string descriptor
GetString
public String GetString()
- Returns the string text for the string descriptor.
- Returns:
- string text
SetString
public void SetString(String text)
- Sets the string text for the string descriptor.
- Parameters:
- text - text to set in the string descriptor
IsCaseSense
public boolean IsCaseSense()
- Returns the case sensitivity for the string descriptor.
- Returns:
- case sensitivity
SetCaseSense
public void SetCaseSense(boolean val)
- Sets the case sensitivity for the string descriptor.
- Parameters:
- val - if true, descriptor is caseSensitive
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