com.ibm.eNetwork.ECL.screenreco
Class ECLScreenDescriptor

java.lang.Object
  |
  +--com.ibm.eNetwork.ECL.screenreco.ECLScreenDescriptor

All Implemented Interfaces:

com.ibm.eNetwork.HOD.common.HODConstants, java.io.Serializable

Direct Known Subclasses:

ECLSDAttrib, ECLSDBlock, ECLSDCondition, ECLSDCursor, ECLSDCustom, ECLSDFields, ECLSDInputFields, ECLSDOIA, ECLSDString, ECLSDVarUpdate

public abstract class ECLScreenDescriptor

extends java.lang.Object

implements java.io.Serializable, com.ibm.eNetwork.HOD.common.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.

Note that some of the methods below are intended specifically for macro programming, as indicated.

See Also:

ECLScreenDesc, ECLSDAttrib, ECLSDCursor, ECLSDCustom, ECLSDFields, ECLSDInputFields, ECLSDOIA, ECLSDString, ECLSDBlock, ECLSDVarUpdate, Serialized Form

Fields inherited from interface com.ibm.eNetwork.HOD.common.HODConstants

DEFAULT_WIN_FONT, HOD_ICON_EVENT, HOD_MSG_FILE, HOD_RAS_COMPID_ADVMACRO, HOD_RAS_COMPID_ASSOC_PRT, HOD_RAS_COMPID_BLINKREMAP, HOD_RAS_COMPID_CODEPAGE, HOD_RAS_COMPID_COLORREMAP, HOD_RAS_COMPID_CONFIG, HOD_RAS_COMPID_FILETRANSFER, HOD_RAS_COMPID_FTP_SCREEN, HOD_RAS_COMPID_FTP_SESSION, HOD_RAS_COMPID_FTP_TERMINAL, HOD_RAS_COMPID_FUDOMA, HOD_RAS_COMPID_HOD_API, HOD_RAS_COMPID_IMPEXP, HOD_RAS_COMPID_JNILOAD, HOD_RAS_COMPID_KEYPAD, HOD_RAS_COMPID_KEYREMAP, HOD_RAS_COMPID_MACRO, HOD_RAS_COMPID_MACROMANGR, HOD_RAS_COMPID_PRT_TERMINAL, HOD_RAS_COMPID_SCREEN, HOD_RAS_COMPID_SESSION, HOD_RAS_COMPID_SESSION_MGR, HOD_RAS_COMPID_SLP, HOD_RAS_COMPID_TERMINAL, HOD_RAS_COMPID_ZIPPRINT, HOD_RAS_FUNC_NAME, HOD_START_UP, HOD_TRANSFER_FILE_INFO, MOUSE_DOUBLE_CLICK_THRESHOLD, XFER_ASCII_GET_OPTIONS, XFER_ASCII_GET_OPTIONS_DEFAULT, XFER_ASCII_PUT_OPTIONS, XFER_ASCII_PUT_OPTIONS_DEFAULT, XFER_BINARY_GET_OPTIONS, XFER_BINARY_GET_OPTIONS_DEFAULT, XFER_BINARY_PUT_OPTIONS, XFER_BINARY_PUT_OPTIONS_DEFAULT, XFER_DEFAULT_OPTIONS, XFER_FILETYPE_DTA, XFER_FILETYPE_SAVF, XFER_FILETYPE_SRC, XFER_HOST_TYPE, XFER_HOST_TYPE_CICS, XFER_HOST_TYPE_CMS, XFER_HOST_TYPE_DEFAULT, XFER_HOST_TYPE_OS400, XFER_HOST_TYPE_TSO, XFER_PACKET_SIZE, XFER_PACKET_SIZE_DEFAULT, XFER_TIME_OUT_VALUE, XFER_TIME_OUT_VALUE_DEFAULT, XFER_TRANSFER_MODE, XFER_TRANSFER_MODE_ASCII, XFER_TRANSFER_MODE_BINARY, XFER_TRANSFER_MODE_DEFAULT

Method Summary

java.util.Vector	Create(java.util.Hashtable argTable) Creates a working instance of the descriptor from the string values contained in the hash table.
java.lang.String	Format(int argType, boolean displayAll) Formats the action object's contents into a readable string.
boolean	IsInvertMatch() Returns whether the recognition matching will be inverted for the descriptor.
java.lang.String	IsInvertMatchRaw() Returns expression form of whether the recognition matching will be inverted for the descriptor.
boolean	IsMatch() Returns whether the descriptor matched in the ECLScreenReco matching algorithm.
boolean	IsOptional() Returns whether the descriptor will be optional in the ECLScreenReco matching algorithm.
java.lang.String	IsOptionalRaw() Returns expression form of whether the descriptor will be optional in the ECLScreenReco matching algorithm.
void	SetInvertMatch(boolean val) Sets whether the recognition matching should be inverted for the descriptor.
void	SetInvertMatch(java.lang.String val) Sets whether the recognition matching should be inverted for the descriptor.
void	SetMatch(boolean val) Sets whether the descriptor matched in the ECLScreenReco matching algorithm.
void	SetOptional(boolean val) Sets whether the descriptor will be optional in the ECLScreenReco matching algorithm.
void	SetOptional(java.lang.String val) Sets whether the descriptor will be optional in the ECLScreenReco matching algorithm.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

Format

public java.lang.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)

displayAll - if true 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 action

Create

public java.util.Vector Create(java.util.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 this document: 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

IsOptionalRaw

public java.lang.String IsOptionalRaw()

Returns expression form of whether the descriptor will be optional in the ECLScreenReco matching algorithm. Intended for macro programming use.

Returns:

expression evaluates to 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.

SetOptional

public void SetOptional(java.lang.String 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. Intended for macro programming use.

Parameters:

expression - if expression evaluates to true, descriptor will be optional in ECLScreenReco matching algorithm. if expression evaluates to 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 pseudo-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

IsInvertMatchRaw

public java.lang.String IsInvertMatchRaw()

Returns expression form of whether the recognition matching will be inverted for the descriptor. This introduces a pseudo-boolean NOT capability. The match will be successful if the description element is not on the host screen. Intended for macro programming use.

Returns:

expression which evaluates to 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 pseudo-boolean NOT capability. The match will be successful if the description element is not on the host screen.

SetInvertMatch

public void SetInvertMatch(java.lang.String val)

Sets whether the recognition matching should be inverted for the descriptor. Intended for macro programming use.

Parameters:

expression - if expression evaluates to true, recognition of the element will be inverted. This introduces a pseudo-boolean NOT capability. The match will be successful if the description element is not on the host screen.