All Packages Class Hierarchy This Package Previous Next Index
Class com.ibm.eNetwork.ECL.screenreco.ECLSDBlock
java.lang.Object
|
+----com.ibm.eNetwork.ECL.screenreco.ECLScreenDescriptor
|
+----com.ibm.eNetwork.ECL.screenreco.ECLSDBlock
- public class ECLSDBlock
- extends ECLScreenDescriptor
This class is the descriptor class used to describe a
block of strings 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 block descriptor may specify a block of strings at either an absolute position
or inside a rectangle by using the SetBlockType method. Also, the block
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, ECLSDString, ECLPS, ECLField
-
BLOCK_ABSOLUTE
- Value used to specify that the block descriptor describes a block of strings
at an absolute position.
-
BLOCK_INRECT
- Value used to specify that the block descriptor describes a block of strings
that is in a rectangular area.
-
ECLSDBlock()
- Default constructor for a block descriptor.
-
ECLSDBlock(int, int, boolean, boolean)
- Constructs a BLOCK_ABSOLUTE string descriptor with the given parameters.
-
ECLSDBlock(int, int, int, int, boolean, boolean)
- Constructs a BLOCK_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.
-
GetBlockType()
- Returns the block matching type for the block descriptor.
-
GetECol()
- Returns the ending column for the block descriptor.
-
GetERow()
- Returns the ending row for the block descriptor.
-
GetSCol()
- Returns the starting column for the block descriptor.
-
GetSRow()
- Returns the starting row for the block descriptor.
-
GetStrings()
- Returns the string text for the block descriptor.
-
IsCaseSense()
- Returns the case sensitivity for the block descriptor.
-
SetBlockType(int)
- Sets the block matching type for the block descriptor.
-
SetCaseSense(boolean)
- Sets the case sensitivity for the block descriptor.
-
SetECol(int)
- Sets the ending column for the block descriptor.
-
SetERow(int)
- Sets the ending row for the block descriptor.
-
SetSCol(int)
- Sets the starting column for the block descriptor.
-
SetSRow(int)
- Sets the starting row for the block descriptor.
-
SetStrings(String[])
- Sets the string text for the block descriptor.
BLOCK_ABSOLUTE
public static final int BLOCK_ABSOLUTE
- Value used to specify that the block descriptor describes a block of strings
at an absolute position. For the matching logic to pass the descriptor,
the string must start at the row/col position.
BLOCK_INRECT
public static final int BLOCK_INRECT
- Value used to specify that the block descriptor describes a block of strings
that is in a rectangular area. For the matching logic to pass the
descriptor, the block of strings must be within the bounding coordinates of
the rectangle. Word wrapping is not allowed.
ECLSDBlock
public ECLSDBlock()
- Default constructor for a block descriptor. Block type will be
BLOCK_INRECT, Starting row/col positions will be 1 and ending row/col
positions will be -1, case sensitivity will be false and there are
no strings to match
If you use this constructor you must call all the set methods of this
class to properly set up the descriptor.
ECLSDBlock
public ECLSDBlock(int row,
int col,
boolean caseSense,
boolean opt)
- Constructs a BLOCK_ABSOLUTE string descriptor with the given parameters.
This constructor will create a usable descriptor. No set methods
need be called.
- Parameters:
- row - starting row for the string descriptor
- col - starting column for the string descriptor
- caseSense - if true, descriptor is case sensitive
- opt - if true, descriptor is optional
ECLSDBlock
public ECLSDBlock(int srow,
int scol,
int erow,
int ecol,
boolean caseSense,
boolean opt)
- Constructs a BLOCK_INRECT string descriptor with the given parameters.
This constructor will create a usable descriptor. No set methods
need be called.
- Parameters:
- 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 case sensitive
- 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 - 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
- Overrides:
- Format in class ECLScreenDescriptor
GetBlockType
public int GetBlockType()
- Returns the block matching type for the block descriptor.
- Returns:
- block type, either absolute position or in a rectangle
- See Also:
- BLOCK_ABSOLUTE, BLOCK_INRECT
SetBlockType
public void SetBlockType(int type)
- Sets the block matching type for the block descriptor.
- Parameters:
- type - type to set in the block descriptor
- See Also:
- BLOCK_ABSOLUTE, BLOCK_INRECT
GetSRow
public int GetSRow()
- Returns the starting row for the block descriptor.
- Returns:
- row position
SetSRow
public void SetSRow(int row)
- Sets the starting row for the block descriptor.
- Parameters:
- row - starting row for the block descriptor
GetSCol
public int GetSCol()
- Returns the starting column for the block descriptor.
- Returns:
- column position
SetSCol
public void SetSCol(int col)
- Sets the starting column for the block descriptor.
- Parameters:
- col - starting column for the block descriptor
GetERow
public int GetERow()
- Returns the ending row for the block descriptor. The ending row/col
values are used only for the BLOCK_INRECT type.
- Returns:
- row position
SetERow
public void SetERow(int row)
- Sets the ending row for the block descriptor. The ending row/col
values are used only for the BLOCK_INRECT type.
- Parameters:
- row - ending row for the block descriptor
GetECol
public int GetECol()
- Returns the ending column for the block descriptor. The ending row/col
values are used only for the BLOCK_INRECT type.
- Returns:
- column position
SetECol
public void SetECol(int col)
- Sets the ending column for the block descriptor. The ending row/col
values are used only for the BLOCK_INRECT type.
- Parameters:
- col - ending column for the block descriptor
GetStrings
public String[] GetStrings()
- Returns the string text for the block descriptor.
- Returns:
- string text
SetStrings
public void SetStrings(String ss[])
- Sets the string text for the block descriptor.
- Parameters:
- text - text to set in the block descriptor
IsCaseSense
public boolean IsCaseSense()
- Returns the case sensitivity for the block descriptor.
- Returns:
- case sensitivity
SetCaseSense
public void SetCaseSense(boolean val)
- Sets the case sensitivity for the block descriptor.
- Parameters:
- val - if true, descriptor is case sensitive
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