All Packages Class Hierarchy This Package Previous Next Index
Class com.ibm.eNetwork.ECL.screenreco.ECLSDCustom
java.lang.Object
|
+----com.ibm.eNetwork.ECL.screenreco.ECLScreenDescriptor
|
+----com.ibm.eNetwork.ECL.screenreco.ECLSDCustom
- public class ECLSDCustom
- extends ECLScreenDescriptor
This class is the descriptor class used to describe the a custom
recognition handler for 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 custom descriptor simply specifies a listener to call who will
perform custom matching logic. This enables any java program using this
class to extend the ECLScreenReco comparison algorithms.
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, ECLSDFields, ECLSDInputFields, ECLSDOIA, ECLSDString, ECLPS, ECLField
-
ECLSDCustom()
- Default constructor for a custom descriptor.
-
ECLSDCustom(ECLCustomRecoListener, String, boolean)
- Constructs a custom 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.
-
GetID()
- Returns the identifier for the custom descriptor.
-
GetListener()
- Returns the listener for the custom descriptor
-
SetID(String)
- Sets the identifier for the custom descriptor
-
SetListener(ECLCustomRecoListener)
- Sets the listener for the custom descriptor
ECLSDCustom
public ECLSDCustom()
- Default constructor for a custom descriptor.
If you use this constructor you must call all the set methods of this
class to properly set up the descriptor.
ECLSDCustom
public ECLSDCustom(ECLCustomRecoListener listener,
String ID,
boolean opt)
- Constructs a custom descriptor with the given parameters.
This constructor will create a usable descriptor. No set methods
need be called.
- Parameters:
- listener - custom recognition listener object
- ID - unique identifier for the custom recognition event
- 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, as 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
GetID
public String GetID()
- Returns the identifier for the custom descriptor.
- Returns:
- unique identifier for the custom descriptor
SetID
public void SetID(String id)
- Sets the identifier for the custom descriptor
- Parameters:
- id - unique identifier for the custom descriptor
GetListener
public ECLCustomRecoListener GetListener()
- Returns the listener for the custom descriptor
- Returns:
- listener for the custom descriptor
SetListener
public void SetListener(ECLCustomRecoListener listener)
- Sets the listener for the custom descriptor
- Parameters:
- listener - listener for the custom descriptor
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