com.ibm.eNetwork.ECL Class ECLScreenDesc


Overview	Package	Class	Tree	Serialized	Deprecated	Index	Help	API User's Guide

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD



java.lang.Object
  |
  +--
com.ibm.eNetwork.ECL.ECLScreenDesc

All Implemented Interfaces:: java.io.Serializable

public class ECLScreenDesc
extends java.lang.Object
implements java.io.Serializable

ECLScreenDesc is the class that is used to "describe" a screen for HCL'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.

See Also:: ECLScreenReco , ECLScreenDescriptor , ECLSDAttrib , ECLSDCursor , ECLSDCustom , ECLSDFields , ECLSDInputFields , ECLSDOIA , ECLSDString , ECLSDVarUpdate , ECLSDCondition , ECLPS , Serialized Form


Field 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`	`AddChecksum (int val)` Adds checksum of a screen to the screen description.
`void`	`AddChecksum (int val, boolean optional)` Adds checksum of a screen 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`	`AddOIAInhibitStatus (java.lang.String hid, int type)` Turns on waiting on OIA inhibit status in the screen description with a Host ID.
`void`	`AddOIAInhibitStatus (java.lang.String hid, int type, boolean optional)` Turns on waiting on OIA inhibit status in the screen description with a Host ID.
`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.
`ECLSDChecksum`	`GetSDChecksum ()` Returns the first checksum screen descriptor for the ECLScreenDesc object.
`java.util.Vector`	`GetSDChecksums ()` Returns a collection of Checksum 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.
`ECLSDCursor`	`GetSDCursor (java.lang.String hid)` Returns the first cursor screen descriptor with matching Host ID 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.
`ECLSDFields`	`GetSDFields (java.lang.String hid)` Returns the first field count screen descriptor with matching Host ID 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.
`ECLSDInputFields`	`GetSDInputFields (java.lang.String hid)` Returns the first input field count screen descriptor with matching Host ID 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.
`ECLSDOIA`	`GetSDOIA (java.lang.String hid)` Returns the OIA state screen descriptor for the ECLScreenDesc object with matching Host ID.
`java.util.Vector`	`GetSDOIAVec ()` Returns a collection of OIA screen descriptors 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

DONTCARE



public static final int 
DONTCARE

NOTINHIBITED



public static final int 
NOTINHIBITED


Constructor Detail

ECLScreenDesc



public 
ECLScreenDesc()

ECLScreenDesc



public 
ECLScreenDesc(java.lang.String str)

See Also:: toString()


Method Detail

toString



public java.lang.String 
toString()

Clear



public void 
Clear()

AddCursorPos



public void 
AddCursorPos(int row,
                         int col)

AddCursorPos



public void 
AddCursorPos(int row,
                         int col,
                         boolean optional)

AddAttrib



public void 
AddAttrib(char attrib,
                      int row,
                      int col,
                      int plane)

AddAttrib



public void 
AddAttrib(char attrib,
                      int row,
                      int col,
                      int plane,
                      boolean optional)

AddNumFields



public void 
AddNumFields(int num)

AddNumFields



public void 
AddNumFields(int num,
                         boolean optional)

AddNumInputFields



public void 
AddNumInputFields(int num)

AddNumInputFields



public void 
AddNumInputFields(int num,
                              boolean optional)

AddOIAInhibitStatus



public void 
AddOIAInhibitStatus(int type)

AddOIAInhibitStatus



public void 
AddOIAInhibitStatus(java.lang.String hid,
                                int type)

AddOIAInhibitStatus



public void 
AddOIAInhibitStatus(int type,
                                boolean optional)

AddOIAInhibitStatus



public void 
AddOIAInhibitStatus(java.lang.String hid,
                                int type,
                                boolean optional)

AddBlock



public void 
AddBlock(java.lang.String[] texts)

AddBlock



public void 
AddBlock(java.lang.String[] texts,
                     int row,
                     int col)

AddBlock



public void 
AddBlock(java.lang.String[] texts,
                     int row,
                     int col,
                     boolean caseSensitive)

AddBlock



public void 
AddBlock(java.lang.String[] texts,
                     int row,
                     int col,
                     boolean caseSensitive,
                     boolean optional)

AddBlockInRect



public void 
AddBlockInRect(java.lang.String[] texts,
                           int startRow,
                           int startCol,
                           int endRow,
                           int endCol)

AddBlockInRect



public void 
AddBlockInRect(java.lang.String[] texts,
                           int startRow,
                           int startCol,
                           int endRow,
                           int endCol,
                           boolean caseSensitive)

AddBlockInRect



public void 
AddBlockInRect(java.lang.String[] texts,
                           int startRow,
                           int startCol,
                           int endRow,
                           int endCol,
                           boolean caseSensitive,
                           boolean optional)

AddString



public void 
AddString(java.lang.String text)

AddString



public void 
AddString(java.lang.String text,
                      int row,
                      int col)

AddString



public void 
AddString(java.lang.String text,
                      int row,
                      int col,
                      boolean caseSensitive)

AddString



public void 
AddString(java.lang.String text,
                      int row,
                      int col,
                      boolean caseSensitive,
                      boolean optional)

AddStringInRect



public void 
AddStringInRect(java.lang.String text,
                            int startRow,
                            int startCol,
                            int endRow,
                            int endCol)

AddStringInRect



public void 
AddStringInRect(java.lang.String text,
                            int startRow,
                            int startCol,
                            int endRow,
                            int endCol,
                            boolean caseSensitive)

AddStringInRect



public void 
AddStringInRect(java.lang.String text,
                            int startRow,
                            int startCol,
                            int endRow,
                            int endCol,
                            boolean caseSensitive,
                            boolean optional)

SetCustomListener



public void 
SetCustomListener(
ECLCustomRecoListener listener,
                              java.lang.String id)

AddCustom



public void 
AddCustom(
ECLCustomRecoListener listener,
                      java.lang.String id)

AddCustom



public void 
AddCustom(
ECLCustomRecoListener listener,
                      java.lang.String id,
                      boolean optional)

AddChecksum



public void 
AddChecksum(int val)

AddChecksum



public void 
AddChecksum(int val,
                        boolean optional)

AddDescriptor



public void 
AddDescriptor(
ECLScreenDescriptor desctor)

RemoveDescriptor



public void 
RemoveDescriptor(
ECLScreenDescriptor desctor)

GetDescriptors



public java.util.Vector 
GetDescriptors()

SetDescriptors



public void 
SetDescriptors(java.util.Vector desctors)

GetSDCursor



public 
ECLSDCursor 

            GetSDCursor()

GetSDCursor



public 
ECLSDCursor 

            GetSDCursor(java.lang.String hid)

GetSDFields



public 
ECLSDFields 

            GetSDFields()

GetSDFields



public 
ECLSDFields 

            GetSDFields(java.lang.String hid)

GetSDInputFields



public 
ECLSDInputFields 

            GetSDInputFields()

GetSDInputFields



public 
ECLSDInputFields 

            GetSDInputFields(java.lang.String hid)

GetSDCursors



public java.util.Vector 
GetSDCursors()

GetSDFieldsVec



public java.util.Vector 
GetSDFieldsVec()

GetSDInputFieldsVec



public java.util.Vector 
GetSDInputFieldsVec()

GetSDOIA



public 
ECLSDOIA 

            GetSDOIA()

GetSDOIA



public 
ECLSDOIA 

            GetSDOIA(java.lang.String hid)

GetSDOIAVec



public java.util.Vector 
GetSDOIAVec()

GetSDAttribs



public java.util.Vector 
GetSDAttribs()

GetSDStrings



public java.util.Vector 
GetSDStrings()

GetSDVarUpdates



public java.util.Vector 
GetSDVarUpdates()

GetSDConditions



public java.util.Vector 
GetSDConditions()

GetSDBlock



public java.util.Vector 
GetSDBlock()

GetSDCustom



public java.util.Vector 
GetSDCustom()

GetSDCustom



public 
ECLSDCustom 

            GetSDCustom(java.lang.String id)

GetSDChecksum



public 
ECLSDChecksum 

            GetSDChecksum()

GetSDChecksums



public java.util.Vector 
GetSDChecksums()

Descriptors



public java.util.Enumeration 
Descriptors()

SetName



public void 
SetName(java.lang.String argName)

GetName



public java.lang.String 
GetName()

SetTransient



public void 
SetTransient(boolean argVal)

SetTransient



public void 
SetTransient(java.lang.String argVal)

IsTransient



public boolean 
IsTransient()

IsTransientRaw



public java.lang.String 
IsTransientRaw()

IsMatch



public boolean 
IsMatch()

SetActive



public void 
SetActive(boolean active)

IsActive



public boolean 
IsActive()

StringToAttrib



public static char 
StringToAttrib(java.lang.String str)

AttribToString



public static java.lang.String 
AttribToString(char attrib)

StringToPlane



public static int 
StringToPlane(java.lang.String planeStr)

PlaneToString



public static java.lang.String 
PlaneToString(int plane)


Overview	Package	Class	Tree	Serialized	Deprecated	Index	Help	API User's Guide

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD