All Packages Class Hierarchy This Package Previous Next Index
Class com.ibm.eNetwork.ECL.screenreco.ECLScreenDescriptor
java.lang.Object
|
+----com.ibm.eNetwork.ECL.screenreco.ECLScreenDescriptor
- public abstract class ECLScreenDescriptor
- extends Object
- implements Serializable, HODConstants
The ECLScreenDescriptor class is the parent class of all screen
descriptors contained in ECLScreenDesc. Screen descriptors expand
on the work done in IBM Host On-Demand version 3 by allowing the
user of the ECLScreenDesc to not only add descriptions, but allowing
the user to discover what is contained in the ECLScreenDesc object.
A descriptor represents one unique description item in ECLScreenDesc.
These descriptors can be items like strings, cursor position, field
count, and the like. Each of these types of descriptors has its own
class that is derived from ECLScreenDescriptor.
When a 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.
Refer to the ECLScreenDesc object for details on using descriptors.
Refer to each descriptor class for details on each descriptor.
- See Also:
- ECLScreenDesc, ECLSDAttrib, ECLSDCursor, ECLSDCustom, ECLSDFields, ECLSDInputFields, ECLSDOIA, ECLSDString
-
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.
-
IsInvertMatch()
- Returns whether the recognition matching will be inverted for the
descriptor.
-
IsMatch()
- Returns whether the descriptor matched in the ECLScreenReco
matching algorithm.
-
IsOptional()
- Returns whether the descriptor will be optional in the ECLScreenReco
matching algorithm.
-
SetInvertMatch(boolean)
- Sets whether the recognition matching should be inverted for the
descriptor.
-
SetMatch(boolean)
- Sets whether the descriptor matched in the ECLScreenReco
matching algorithm.
-
SetOptional(boolean)
- Sets whether the descriptor will be optional in the ECLScreenReco
matching algorithm.
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 MacroDebugActionEvent class.
- Parameters:
- argType - type of string to produce (reserved for future use)
- Returns:
- formatted string that reflects the contents of the action
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
IsOptional
public boolean IsOptional()
- Returns whether the descriptor will be optional in the ECLScreenReco
matching algorithm.
- Returns:
- true if optional, false if required
SetOptional
public void SetOptional(boolean val)
- Sets whether the descriptor will be optional in the ECLScreenReco
matching algorithm. If optional is set to false, ECLScreenReco will
not pass the screen descriptor if it does not match.
- Parameters:
- val - if true, descriptor will be optional in ECLScreenReco matching algorithm.
if false, descriptor will be required.
IsMatch
public boolean IsMatch()
- Returns whether the descriptor matched in the ECLScreenReco
matching algorithm. Use this method to determine why a particular
screen description did or did not match.
- Returns:
- true if matched, false if not matched
SetMatch
public void SetMatch(boolean val)
- Sets whether the descriptor matched in the ECLScreenReco
matching algorithm. This method is used internally by ECLScreenReco.
- Parameters:
- val - if true, descriptor matched.
if false, descriptor did not match.
IsInvertMatch
public boolean IsInvertMatch()
- Returns whether the recognition matching will be inverted for the
descriptor. This introduces a psuedo-boolean NOT capability. The match
will be successful if the description element is not on the host screen.
- Returns:
- true if inverted, false if not inverted
SetInvertMatch
public void SetInvertMatch(boolean val)
- Sets whether the recognition matching should be inverted for the
descriptor.
- Parameters:
- val - if true, recognition of the element will be inverted. This
introduces a psuedo-boolean NOT capability. The match will
be successful if the description element is not on the host
screen.
All Packages Class Hierarchy This Package Previous Next Index