|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.eNetwork.ECL.ECLScreenDesc
ECLScreenDesc is the class that is used to "describe" a screen for IBM's Host Access Class Library Screen Recognition Technology. It uses all four major planes of the presentation space to describe it (TEXT, FIELD, EXFIELD, COLOR), as well as the cursor position and OIA status.
Using the methods provided on this object, the programmer can set up a detailed description of what a given screen "looks like" in a host side application. Once an ECLScreenDesc object is created and set, it may be passed to either the synchronous WaitFor... methods provided on ECLPS, or it may be passed to ECLScreenReco, which fires an asynchronous event if the screen matching the ECLScreenDesc object appears in the PS.
Note on the optional parameter on the Addxxx methods: ECLScreenReco uses the following logic for recognizing, or matching ECLScreenDesc objects, which contain ECLScreenDescriptor-derived objects, against the data in an ECLPS object:
Note that some of the methods below are intended specifically for macro programming, as indicated.
ECLScreenReco
,
ECLScreenDescriptor
,
ECLSDAttrib
,
ECLSDCursor
,
ECLSDCustom
,
ECLSDFields
,
ECLSDInputFields
,
ECLSDOIA
,
ECLSDString
,
ECLSDVarUpdate
,
ECLSDCondition
,
ECLPS
, Serialized FormField Summary | |
---|---|
static int |
DONTCARE
Constant for AddOIAInhibitStatus. |
static int |
NOTINHIBITED
Constant for AddOIAInhibitStatus. |
Constructor Summary | |
---|---|
ECLScreenDesc()
Creates an empty instance of ECLScreenDesc. |
|
ECLScreenDesc(java.lang.String str)
Creates an instance of ECLScreenDesc from a persistent ECLScreen string. |
Method Summary | |
---|---|
void |
AddAttrib(char attrib,
int row,
int col,
int plane)
Adds an attribute value to the screen description. |
void |
AddAttrib(char attrib,
int row,
int col,
int plane,
boolean optional)
Adds an attribute value to the screen description. |
void |
AddBlock(java.lang.String[] texts)
Adds a block of strings to the screen description. |
void |
AddBlock(java.lang.String[] texts,
int row,
int col)
Adds a block of strings starting at the an exact row/col position to the screen description. |
void |
AddBlock(java.lang.String[] texts,
int row,
int col,
boolean caseSensitive)
Adds a block of strings starting at the an exact row/col position to the screen description, allowing you to specify case sensitivity. |
void |
AddBlock(java.lang.String[] texts,
int row,
int col,
boolean caseSensitive,
boolean optional)
Adds a block of strings starting at the an exact row/col position to the screen description, allowing you to specify case sensitivity. |
void |
AddBlockInRect(java.lang.String[] texts,
int startRow,
int startCol,
int endRow,
int endCol)
Adds a block of strings to the screen description. |
void |
AddBlockInRect(java.lang.String[] texts,
int startRow,
int startCol,
int endRow,
int endCol,
boolean caseSensitive)
Adds a block of strings to the screen description. |
void |
AddBlockInRect(java.lang.String[] texts,
int startRow,
int startCol,
int endRow,
int endCol,
boolean caseSensitive,
boolean optional)
Adds a block of strings to the screen description. |
void |
AddCursorPos(int row,
int col)
Sets the cursor position for the screen description. |
void |
AddCursorPos(int row,
int col,
boolean optional)
Sets the cursor position for the screen description. |
void |
AddCustom(ECLCustomRecoListener listener,
java.lang.String id)
Adds a custom recognition listener with a given ID. |
void |
AddCustom(ECLCustomRecoListener listener,
java.lang.String id,
boolean optional)
Adds a custom recognition listener with a given ID. |
void |
AddDescriptor(ECLScreenDescriptor desctor)
Adds a descriptor to the screen description. |
void |
AddNumFields(int num)
Adds the total field count of a screen to the screen description. |
void |
AddNumFields(int num,
boolean optional)
Adds the total field count of a screen to the screen description. |
void |
AddNumInputFields(int num)
Adds the input field count of a screen to the screen description. |
void |
AddNumInputFields(int num,
boolean optional)
Adds the input field count of a screen to the screen description. |
void |
AddOIAInhibitStatus(int type)
Turns on waiting on OIA inhibit status in the screen description. |
void |
AddOIAInhibitStatus(int type,
boolean optional)
Turns on waiting on OIA inhibit status in the screen description. |
void |
AddString(java.lang.String text)
Adds a string to the screen description. |
void |
AddString(java.lang.String text,
int row,
int col)
Adds a string starting at the an exact row/col position to the screen description. |
void |
AddString(java.lang.String text,
int row,
int col,
boolean caseSensitive)
Adds a string starting at the an exact row/col position to the screen description, allowing you to specify case sensitivity. |
void |
AddString(java.lang.String text,
int row,
int col,
boolean caseSensitive,
boolean optional)
Adds a string starting at the an exact row/col position to the screen description, allowing you to specify case sensitivity. |
void |
AddStringInRect(java.lang.String text,
int startRow,
int startCol,
int endRow,
int endCol)
Adds a string to the screen description. |
void |
AddStringInRect(java.lang.String text,
int startRow,
int startCol,
int endRow,
int endCol,
boolean caseSensitive)
Adds a string to the screen description. |
void |
AddStringInRect(java.lang.String text,
int startRow,
int startCol,
int endRow,
int endCol,
boolean caseSensitive,
boolean optional)
Adds a string to the screen description. |
static java.lang.String |
AttribToString(char attrib)
Converts a character attribute value to a hex string. |
void |
Clear()
Member method that clears the data in the ECLScreenDesc object. |
java.util.Enumeration |
Descriptors()
Returns an enumeration of all the descriptors for the ECLScreenDesc object. |
java.util.Vector |
GetDescriptors()
Returns the descriptor collection object for the ECLScreenDesc class. |
java.lang.String |
GetName()
Returns unique name for the screen description. |
java.util.Vector |
GetSDAttribs()
Returns a collection of the attribute screen descriptors for the ECLScreenDesc object. |
java.util.Vector |
GetSDBlock()
Returns a collection of the block string screen descriptors for the ECLScreenDesc object. |
java.util.Vector |
GetSDConditions()
Returns a collection of the conditional screen descriptors for the ECLScreenDesc object. |
ECLSDCursor |
GetSDCursor()
Returns the first cursor screen descriptor for the ECLScreenDesc object. |
java.util.Vector |
GetSDCursors()
Returns a collection of cursor screen descriptors for the ECLScreenDesc object. |
java.util.Vector |
GetSDCustom()
Returns a collection of the custom screen descriptors for the ECLScreenDesc object. |
ECLSDCustom |
GetSDCustom(java.lang.String id)
Returns the custom recognition screen descriptor for the ECLScreenDesc object that has the given ID. |
ECLSDFields |
GetSDFields()
Returns the first field count screen descriptor for the ECLScreenDesc object. |
java.util.Vector |
GetSDFieldsVec()
Returns a collection of field count screen descriptors for the ECLScreenDesc object. |
ECLSDInputFields |
GetSDInputFields()
Returns the first input field count screen descriptor for the ECLScreenDesc object. |
java.util.Vector |
GetSDInputFieldsVec()
Returns a collection of input field count screen descriptors for the ECLScreenDesc object. |
ECLSDOIA |
GetSDOIA()
Returns the OIA state screen descriptor for the ECLScreenDesc object. |
java.util.Vector |
GetSDStrings()
Returns a collection of the string screen descriptors for the ECLScreenDesc object. |
java.util.Vector |
GetSDVarUpdates()
Returns a collection of the variable update screen descriptors for the ECLScreenDesc object. |
boolean |
IsActive()
Returns whether the ECLScreenDesc object should be monitored if it is registered with the ECLScreenReco system. |
boolean |
IsMatch()
Returns whether the description matched in the ECLScreenReco matching algorithm. |
boolean |
IsTransient()
Returns whether the screen description is transient. |
java.lang.String |
IsTransientRaw()
Returns expression form of whether the screen description is transient. |
static java.lang.String |
PlaneToString(int plane)
Takes a plane value and converts it into a string representation of a plane constant. |
void |
RemoveDescriptor(ECLScreenDescriptor desctor)
Removes a descriptor from the screen description. |
void |
SetActive(boolean active)
Sets whether the ECLScreenDesc object should be monitored if it is registered with the ECLScreenReco system. |
void |
SetCustomListener(ECLCustomRecoListener listener,
java.lang.String id)
Registers a custom recognition listener with a given ID. |
void |
SetDescriptors(java.util.Vector desctors)
Sets the descriptor collection object for the ECLScreenDesc class. |
void |
SetName(java.lang.String argName)
Sets the unique name for the screen description. |
void |
SetTransient(boolean argVal)
Sets the screen description as transient. |
void |
SetTransient(java.lang.String argVal)
Sets the screen description as transient. |
static char |
StringToAttrib(java.lang.String str)
Converts a hex string (0x00) to a character attribute. |
static int |
StringToPlane(java.lang.String planeStr)
Takes a string representation of a plane constant and converts it into a plane value. |
java.lang.String |
toString()
This method is used to serialize an ECLScreenDesc object. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int DONTCARE
public static final int NOTINHIBITED
Constructor Detail |
public ECLScreenDesc()
public ECLScreenDesc(java.lang.String str)
toString()
Method Detail |
public java.lang.String toString()
toString
in class java.lang.Object
ECLScreenDesc(java.lang.String)
public void Clear()
public void AddCursorPos(int row, int col)
NOTE: Because the ECLScreenDesc object has no explicit relationship with a single Presentation Space, and Presentation Spaces vary with respect to size, the row and column parameters are not validated in this method. They are validated in the IsMatch method of ECLScreenReco, where a specific PS is passed and validation is possible.
row
- Cursor rowcol
- Cursor columnpublic void AddCursorPos(int row, int col, boolean optional)
NOTE: Because the ECLScreenDesc object has no explicit relationship with a single Presentation Space, and Presentation Spaces vary with respect to size, the row and column parameters are not validated in this method. They are validated in the IsMatch method of ECLScreenReco, where a specific PS is passed and validation is possible.
row
- Cursor rowcol
- Cursor columnoptional
- Cursor comparison will be optional in ECLScreenRecopublic void AddAttrib(char attrib, int row, int col, int plane)
NOTE: Because the ECLScreenDesc object has no explicit relationship with a single Presentation Space, and Presentation Spaces vary with respect to size, the row and column parameters are not validated in this method. They are validated in the IsMatch method of ECLScreenReco, where a specific PS is passed and validation is possible.
attrib
- Attribute to add to description.row
- Row position for attributecol
- Column position for attributeplane
- Plane in PS where attribute resides
See Also:
Appendix B. Host Access Class Library Planes -- Format and Content
public void AddAttrib(char attrib, int row, int col, int plane, boolean optional)
NOTE: Because the ECLScreenDesc object has no explicit relationship with a single Presentation Space, and Presentation Spaces vary with respect to size, the row and column parameters are not validated in this method. They are validated in the IsMatch method of ECLScreenReco, where a specific PS is passed and validation is possible.
attrib
- Attribute to add to description.row
- Row position for attributecol
- Column position for attributeplane
- Plane in PS where attribute residesoptional
- Comparison will be optional in ECLScreenRecopublic void AddNumFields(int num)
num
- Number of fields.public void AddNumFields(int num, boolean optional)
num
- Number of fields.optional
- Comparison will be optional in ECLScreenRecopublic void AddNumInputFields(int num)
num
- Number of fields.public void AddNumInputFields(int num, boolean optional)
num
- Number of fields.optional
- Comparison will be optional in ECLScreenRecopublic void AddOIAInhibitStatus(int type)
type
- OIA condition of the screen description. The valid
constant values follow:
public void AddOIAInhibitStatus(int type, boolean optional)
type
- OIA condition of the screen description. The valid
constant values follow:
optional
- Comparison will be optional in ECLScreenRecopublic void AddBlock(java.lang.String[] texts)
text
- String to addAddBlock(java.lang.String[], int, int)
,
AddBlock(java.lang.String[], int, int, boolean)
,
AddBlock(java.lang.String[], int, int, boolean, boolean)
public void AddBlock(java.lang.String[] texts, int row, int col)
NOTE: Because the ECLScreenDesc object has no explicit relationship with a single Presentation Space, and Presentation Spaces vary with respect to size, the row and column parameters are not validated in this method. They are validated in the IsMatch method of ECLScreenReco, where a specific PS is passed and validation is possible.
texts
- String to addrow
- Starting row for EXACT or IN_RECT location type.col
- Starting column for EXACT or IN_RECT location type.AddBlock(java.lang.String[])
,
AddBlock(java.lang.String[], int, int, boolean)
,
AddBlock(java.lang.String[], int, int, boolean, boolean)
public void AddBlock(java.lang.String[] texts, int row, int col, boolean caseSensitive)
NOTE: Because the ECLScreenDesc object has no explicit relationship with a single Presentation Space, and Presentation Spaces vary with respect to size, the row and column parameters are not validated in this method. They are validated in the IsMatch method of ECLScreenReco, where a specific PS is passed and validation is possible.
text
- String to addrow
- Starting row for EXACT or IN_RECT location type.col
- Starting column for EXACT or IN_RECT location type.caseSensitive
- Indicates whether exact case should be used.
AddBlock(java.lang.String[])
,
AddBlock(java.lang.String[], int, int)
,
AddBlock(java.lang.String[], int, int, boolean, boolean)
public void AddBlock(java.lang.String[] texts, int row, int col, boolean caseSensitive, boolean optional)
NOTE: Because the ECLScreenDesc object has no explicit relationship with a single Presentation Space, and Presentation Spaces vary with respect to size, the row and column parameters are not validated in this method. They are validated in the IsMatch method of ECLScreenReco, where a specific PS is passed and validation is possible.
text
- String to addrow
- Starting row for EXACT or IN_RECT location type.col
- Starting column for EXACT or IN_RECT location type.caseSensitive
- Indicates whether exact case should be used.
optional
- Comparison will be optional in ECLScreenRecoAddBlock(java.lang.String[])
,
AddBlock(java.lang.String[], int, int)
,
AddBlock(java.lang.String[], int, int, boolean)
public void AddBlockInRect(java.lang.String[] texts, int startRow, int startCol, int endRow, int endCol)
NOTE: Because the ECLScreenDesc object has no explicit relationship with a single Presentation Space, and Presentation Spaces vary with respect to size, the row and column parameters are not validated in this method. They are validated in the IsMatch method of ECLScreenReco, where a specific PS is passed and validation is possible.
text
- String to add.startRow
- Starting row for location type.startCol
- Starting column for location type.endRow
- Ending row for IN_RECT location type.endCol
- Ending column for IN_RECT location type.AddBlockInRect(java.lang.String[], int, int, int, int, boolean)
,
AddBlockInRect(java.lang.String[], int, int, int, int, boolean, boolean)
public void AddBlockInRect(java.lang.String[] texts, int startRow, int startCol, int endRow, int endCol, boolean caseSensitive)
NOTE: Because the ECLScreenDesc object has no explicit relationship with a single Presentation Space, and Presentation Spaces vary with respect to size, the row and column parameters are not validated in this method. They are validated in the IsMatch method of ECLScreenReco, where a specific PS is passed and validation is possible.
text
- String to addstartRow
- Starting row for location.startCol
- Starting column for location type.endRow
- Ending row for IN_RECT location type.endCol
- Ending column for IN_RECT location type.caseSensitive
- Indicates whether exact case should be used.
AddBlockInRect(java.lang.String[], int, int, int, int)
,
AddBlockInRect(java.lang.String[], int, int, int, int, boolean, boolean)
public void AddBlockInRect(java.lang.String[] texts, int startRow, int startCol, int endRow, int endCol, boolean caseSensitive, boolean optional)
texts
- Block to addstartRow
- Starting row for location.startCol
- Starting column for location type.endRow
- Ending row for IN_RECT location type.endCol
- Ending column for IN_RECT location type.caseSensitive
- Indicates whether exact case should be used.
optional
- Comparison will be optional in ECLScreenRecoAddBlockInRect(java.lang.String[], int, int, int, int)
,
AddBlockInRect(java.lang.String[], int, int, int, int, boolean)
public void AddString(java.lang.String text)
text
- String to addAddString(java.lang.String, int, int)
,
AddString(java.lang.String, int, int, boolean)
public void AddString(java.lang.String text, int row, int col)
NOTE: Because the ECLScreenDesc object has no explicit relationship with a single Presentation Space, and Presentation Spaces vary with respect to size, the row and column parameters are not validated in this method. They are validated in the IsMatch method of ECLScreenReco, where a specific PS is passed and validation is possible.
text
- String to addrow
- Starting row for EXACT or IN_RECT location type.col
- Starting column for EXACT or IN_RECT location type.AddString(java.lang.String)
,
AddString(java.lang.String, int, int, boolean)
public void AddString(java.lang.String text, int row, int col, boolean caseSensitive)
NOTE: Because the ECLScreenDesc object has no explicit relationship with a single Presentation Space, and Presentation Spaces vary with respect to size, the row and column parameters are not validated in this method. They are validated in the IsMatch method of ECLScreenReco, where a specific PS is passed and validation is possible.
text
- String to addrow
- Starting row for EXACT or IN_RECT location type.col
- Starting column for EXACT or IN_RECT location type.caseSensitive
- Indicates whether exact case should be used.
AddString(java.lang.String)
,
AddString(java.lang.String, int, int)
public void AddString(java.lang.String text, int row, int col, boolean caseSensitive, boolean optional)
NOTE: Because the ECLScreenDesc object has no explicit relationship with a single Presentation Space, and Presentation Spaces vary with respect to size, the row and column parameters are not validated in this method. They are validated in the IsMatch method of ECLScreenReco, where a specific PS is passed and validation is possible.
text
- String to addrow
- Starting row for EXACT or IN_RECT location type.col
- Starting column for EXACT or IN_RECT location type.caseSensitive
- Indicates whether exact case should be used.
optional
- Comparison will be optional in ECLScreenRecoAddString(java.lang.String)
,
AddString(java.lang.String, int, int)
public void AddStringInRect(java.lang.String text, int startRow, int startCol, int endRow, int endCol)
NOTE: Because the ECLScreenDesc object has no explicit relationship with a single Presentation Space, and Presentation Spaces vary with respect to size, the row and column parameters are not validated in this method. They are validated in the IsMatch method of ECLScreenReco, where a specific PS is passed and validation is possible.
text
- String to add.startRow
- Starting row for location type.startCol
- Starting column for location type.endRow
- Ending row for IN_RECT location type.endCol
- Ending column for IN_RECT location type.AddStringInRect(java.lang.String, int, int, int, int, boolean)
public void AddStringInRect(java.lang.String text, int startRow, int startCol, int endRow, int endCol, boolean caseSensitive)
NOTE: Because the ECLScreenDesc object has no explicit relationship with a single Presentation Space, and Presentation Spaces vary with respect to size, the row and column parameters are not validated in this method. They are validated in the IsMatch method of ECLScreenReco, where a specific PS is passed and validation is possible.
text
- String to addstartRow
- Starting row for location.startCol
- Starting column for location type.endRow
- Ending row for IN_RECT location type.endCol
- Ending column for IN_RECT location type.caseSensitive
- Indicates whether exact case should be used.
AddStringInRect(java.lang.String, int, int, int, int)
public void AddStringInRect(java.lang.String text, int startRow, int startCol, int endRow, int endCol, boolean caseSensitive, boolean optional)
NOTE: Because the ECLScreenDesc object has no explicit relationship with a single Presentation Space, and Presentation Spaces vary with respect to size, the row and column parameters are not validated in this method. They are validated in the IsMatch method of ECLScreenReco, where a specific PS is passed and validation is possible.
text
- String to addstartRow
- Starting row for location.startCol
- Starting column for location type.endRow
- Ending row for IN_RECT location type.endCol
- Ending column for IN_RECT location type.caseSensitive
- Indicates whether exact case should be used.
optional
- Comparison will be optional in ECLScreenRecoAddStringInRect(java.lang.String, int, int, int, int)
public void SetCustomListener(ECLCustomRecoListener listener, java.lang.String id)
listener
- listener that is called for recognitionID
- unique identifier for recognitionECLCustomRecoListener
,
ECLCustomRecoEvent
public void AddCustom(ECLCustomRecoListener listener, java.lang.String id)
listener
- listener that is called for recognitionID
- unique identifier for recognitionECLCustomRecoListener
,
ECLCustomRecoEvent
public void AddCustom(ECLCustomRecoListener listener, java.lang.String id, boolean optional)
listener
- listener that is called for recognitionID
- unique identifier for recognitionoptional
- Comparison will be optional in ECLScreenRecoECLCustomRecoListener
,
ECLCustomRecoEvent
public void AddDescriptor(ECLScreenDescriptor desctor)
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.
If the type of descriptor is unknown, this method will just return without adding anything.
ECLScreenDescriptor
public void RemoveDescriptor(ECLScreenDescriptor desctor)
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.
ECLScreenDescriptor
public java.util.Vector GetDescriptors()
ECLScreenDescriptor
public void SetDescriptors(java.util.Vector desctors)
desctors
- descriptor collection to setECLScreenDescriptor
public ECLSDCursor GetSDCursor()
GetSDCursors()
public ECLSDFields GetSDFields()
GetSDFieldsVec()
public ECLSDInputFields GetSDInputFields()
GetSDInputFieldsVec()
public java.util.Vector GetSDCursors()
GetSDCursor()
public java.util.Vector GetSDFieldsVec()
GetSDFields()
public java.util.Vector GetSDInputFieldsVec()
GetSDInputFields()
public ECLSDOIA GetSDOIA()
public java.util.Vector GetSDAttribs()
public java.util.Vector GetSDStrings()
public java.util.Vector GetSDVarUpdates()
public java.util.Vector GetSDConditions()
public java.util.Vector GetSDBlock()
public java.util.Vector GetSDCustom()
public ECLSDCustom GetSDCustom(java.lang.String id)
id
- unique identifier of the custom reco descriptorpublic java.util.Enumeration Descriptors()
public void SetName(java.lang.String argName)
argName
- name of descriptionpublic java.lang.String GetName()
public void SetTransient(boolean argVal)
argVal
- if true, screen will be set to transientpublic void SetTransient(java.lang.String argVal)
expression
- if expression evaluates to true, screen will be set to transientpublic boolean IsTransient()
SetTransient(boolean)
public java.lang.String IsTransientRaw()
SetTransient(String)
public boolean IsMatch()
public void SetActive(boolean active)
active
- If false, ECLScreenReco will not fire reco events.
If true, ECLScreenReco will fire reco events for the
screen.public boolean IsActive()
public static char StringToAttrib(java.lang.String str)
str
- hex string representation of the char valuepublic static java.lang.String AttribToString(char attrib)
attrib
- char value to convert to a stringpublic static int StringToPlane(java.lang.String planeStr)
planeStr
- string representation of the plane (example, TEXT_PLANE)public static java.lang.String PlaneToString(int plane)
plane
- integer value of the plane as defined in ECLConstants
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |