com.ibm.eNetwork.ECL.screenreco
Class ECLSDString

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

All Implemented Interfaces:

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

public class ECLSDString

extends ECLScreenDescriptor

This class is the descriptor class used to describe a single string on 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 string descriptor may specify a string at either an absolute position or inside a rectangle by using the SetStringType method. Also, the string descriptor can be set as either case sensitive or not using the SetCaseSense method.

Once you have created the descriptor, you may add it to an ECLScreenDesc object by calling ECLScreenDesc.AddDescriptor.

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

See Also:

ECLScreenReco, ECLScreenDesc, ECLScreenDescriptor, ECLSDAttrib, ECLSDCursor, ECLSDCustom, ECLSDFields, ECLSDInputFields, ECLSDOIA, ECLSDVarUpdate, ECLPS, ECLField, Serialized Form

Field Summary

static int	STRING_ABSOLUTE Value used to specify that the string descriptor describes a string at an absolute position.
static int	STRING_INRECT Value used to specify that the string descriptor describes a string that is in a rectangular area.

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

Constructor Summary

ECLSDString()
Default constructor for a string descriptor.

ECLSDString(java.lang.String text, int row, int col, boolean caseSense, boolean opt)
Constructs a STRING_ABSOLUTE string descriptor with the given parameters.

ECLSDString(java.lang.String text, int srow, int scol, int erow, int ecol, boolean caseSense, boolean opt)
Constructs a STRING_INRECT string descriptor with the given parameters.

ECLSDString(java.lang.String text, int srow, int scol, int erow, int ecol, boolean caseSense, boolean opt, boolean wrap)
Constructs a STRING_INRECT string descriptor with the given parameters.

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.
int	GetECol() Returns the ending column for the string descriptor.
java.lang.String	GetEColRaw() Returns the expression form of the ending column for the string descriptor.
int	GetERow() Returns the ending row for the string descriptor.
java.lang.String	GetERowRaw() Returns the expression form of the ending row for the string descriptor.
int	GetSCol() Returns the starting column for the string descriptor.
java.lang.String	GetSColRaw() Returns the expression form of the starting column for the string descriptor.
int	GetSRow() Returns the starting row for the string descriptor.
java.lang.String	GetSRowRaw() Returns the expression form of the starting row for the string descriptor.
java.lang.String	GetString() Returns the string text for the string descriptor.
java.lang.String	GetStringRaw() Returns the expression form of the string text for the string descriptor.
int	GetStringType() Returns the string matching type for the string descriptor.
boolean	IsCaseSense() Returns the case sensitivity for the string descriptor.
java.lang.String	IsCaseSenseRaw() Returns the expression form of the case sensitivity for the string descriptor.
boolean	IsWrap() Returns whether the rows specified by a STRING_INRECT descriptor will be concatenated before checking for the specified string.
java.lang.String	IsWrapRaw() Returns the expression form of whether the rows specified by a STRING_INRECT descriptor will be concatenated before checking for the specified string.
void	SetCaseSense(boolean val) Sets the case sensitivity for the string descriptor.
void	SetCaseSense(java.lang.String val) Sets the case sensitivity for the string descriptor.
void	SetECol(int col) Sets the ending column for the string descriptor.
void	SetECol(java.lang.String col) Sets the ending column for the string descriptor.
void	SetERow(int row) Sets the ending row for the string descriptor.
void	SetERow(java.lang.String row) Sets the ending row for the string descriptor.
void	SetSCol(int col) Sets the starting column for the string descriptor.
void	SetSCol(java.lang.String col) Sets the starting column for the string descriptor.
void	SetSRow(int row) Sets the starting row for the string descriptor.
void	SetSRow(java.lang.String row) Sets the starting row for the string descriptor.
void	SetString(java.lang.String text) Sets the string text for the string descriptor.
void	SetStringType(int type) Sets the string matching type for the string descriptor.
void	SetWrap(boolean val) Sets the wrap attribute for the string descriptor.
void	SetWrap(java.lang.String val) Sets the wrap attribute for the string descriptor.

Methods inherited from class com.ibm.eNetwork.ECL.screenreco.ECLScreenDescriptor

IsInvertMatch, IsInvertMatchRaw, IsMatch, IsOptional, IsOptionalRaw, SetInvertMatch, SetInvertMatch, SetMatch, SetOptional, SetOptional

Methods inherited from class java.lang.Object

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

Field Detail

STRING_ABSOLUTE

public static final int STRING_ABSOLUTE

Value used to specify that the string descriptor describes a string at an absolute position. For the matching logic to pass the descriptor, the string must start at the row/col position.

STRING_INRECT

public static final int STRING_INRECT

Value used to specify that the string descriptor describes a string that is in a rectangular area. For the matching logic to pass the descriptor, the string must be within the bounding coordinates of the rectangle. Word wrapping is not allowed.

Constructor Detail

ECLSDString

public ECLSDString()

Default constructor for a string descriptor. String type will be STRING_INRECT, Starting row/col positions will be 1, ending row/col positions will be -1, case sensitivity will be false and the text will be a zero length string.

If you use this constructor you must call all the set methods of this class to properly set up the descriptor.

ECLSDString

public ECLSDString(java.lang.String text,
                   int row,
                   int col,
                   boolean caseSense,
                   boolean opt)

Constructs a STRING_ABSOLUTE string descriptor with the given parameters.

This constructor will create a usable descriptor. No set methods need be called.

Parameters:

text - text to set in the string descriptor

row - starting row for the string descriptor

col - starting column for the string descriptor

caseSense - if true, descriptor is case sensitive

opt - if true, descriptor is optional

ECLSDString

public ECLSDString(java.lang.String text,
                   int srow,
                   int scol,
                   int erow,
                   int ecol,
                   boolean caseSense,
                   boolean opt)

Constructs a STRING_INRECT string descriptor with the given parameters.

This constructor will create a usable descriptor. No set methods need be called.

Parameters:

text - text to set in the string descriptor

srow - starting row for the string descriptor

scol - starting column for the string descriptor

erow - ending row for the string descriptor

ecol - ending column for the string descriptor

caseSense - if true, descriptor is case sensitive

opt - if true, descriptor is optional

ECLSDString

public ECLSDString(java.lang.String text,
                   int srow,
                   int scol,
                   int erow,
                   int ecol,
                   boolean caseSense,
                   boolean opt,
                   boolean wrap)

Constructs a STRING_INRECT string descriptor with the given parameters.

This constructor will create a usable descriptor. No set methods need be called.

Parameters:

text - text to set in the string descriptor

srow - starting row for the string descriptor

scol - starting column for the string descriptor

erow - ending row for the string descriptor

ecol - ending column for the string descriptor

caseSense - if true, descriptor is case sensitive

opt - if true, descriptor is optional

wrap - if true, the rows of the specified rectangle will be concatenated when searching for the specified string. if false(default), the rectangle will be searched row by row for the specified text

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 ECLRecoDebugEvent class.

Overrides:

Format in class ECLScreenDescriptor

Parameters:

argType - reserved for future use

displayAll - if true all 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 descriptor

GetStringType

public int GetStringType()

Returns the string matching type for the string descriptor.

Returns:

string type, either absolute position or in a rectangle

See Also:

STRING_ABSOLUTE, STRING_INRECT

SetStringType

public void SetStringType(int type)

Sets the string matching type for the string descriptor.

Parameters:

type - type to set in the string descriptor

See Also:

STRING_ABSOLUTE, STRING_INRECT

GetSRow

public int GetSRow()

Returns the starting row for the string descriptor.

Returns:

row position

GetSRowRaw

public java.lang.String GetSRowRaw()

Returns the expression form of the starting row for the string descriptor. Intended for macro programming use.

Returns:

expression form of the row position

SetSRow

public void SetSRow(int row)

Sets the starting row for the string descriptor.

Parameters:

row - starting row for the string descriptor

SetSRow

public void SetSRow(java.lang.String row)

Sets the starting row for the string descriptor. Intended for macro programming use.

Parameters:

expression - starting row for the string descriptor

GetSCol

public int GetSCol()

Returns the starting column for the string descriptor.

Returns:

column position

GetSColRaw

public java.lang.String GetSColRaw()

Returns the expression form of the starting column for the string descriptor. Intended for macro programming use.

Returns:

expression form of the column position

SetSCol

public void SetSCol(int col)

Sets the starting column for the string descriptor.

Parameters:

col - starting column for the string descriptor

SetSCol

public void SetSCol(java.lang.String col)

Sets the starting column for the string descriptor. Intended for macro programming use.

Parameters:

expression - starting column for the string descriptor

GetERow

public int GetERow()

Returns the ending row for the string descriptor. The ending row/col values are used only for the STRING_INRECT type.

Returns:

row position

GetERowRaw

public java.lang.String GetERowRaw()

Returns the expression form of the ending row for the string descriptor. The ending row/col values are used only for the STRING_INRECT type. Intended for macro programming use.

Returns:

expression form of the row position

SetERow

public void SetERow(int row)

Sets the ending row for the string descriptor. The ending row/col values are used only for the STRING_INRECT type.

Parameters:

row - ending row for the string descriptor

SetERow

public void SetERow(java.lang.String row)

Sets the ending row for the string descriptor. The ending row/col values are used only for the STRING_INRECT type. Intended for macro programming use.

Parameters:

expression - ending row for the string descriptor

GetECol

public int GetECol()

Returns the ending column for the string descriptor. The ending row/col values are used only for the STRING_INRECT type.

Returns:

column position

GetEColRaw

public java.lang.String GetEColRaw()

Returns the expression form of the ending column for the string descriptor. The ending row/col values are used only for the STRING_INRECT type. Intended for macro programming use.

Returns:

expression form of the column position

SetECol

public void SetECol(int col)

Sets the ending column for the string descriptor. The ending row/col values are used only for the STRING_INRECT type.

Parameters:

col - ending column for the string descriptor

SetECol

public void SetECol(java.lang.String col)

Sets the ending column for the string descriptor. The ending row/col values are used only for the STRING_INRECT type. Intended for macro programming use.

Parameters:

expression - ending column for the string descriptor

GetString

public java.lang.String GetString()

Returns the string text for the string descriptor.

Returns:

string text

GetStringRaw

public java.lang.String GetStringRaw()

Returns the expression form of the string text for the string descriptor. Intended for macro programming use.

Returns:

expression form of the string text

SetString

public void SetString(java.lang.String text)

Sets the string text for the string descriptor.

Parameters:

text - text to set in the string descriptor

IsCaseSense

public boolean IsCaseSense()

Returns the case sensitivity for the string descriptor.

Returns:

case sensitivity

IsCaseSenseRaw

public java.lang.String IsCaseSenseRaw()

Returns the expression form of the case sensitivity for the string descriptor. Intended for macro programming use.

Returns:

expression form of the case sensitivity

SetCaseSense

public void SetCaseSense(boolean val)

Sets the case sensitivity for the string descriptor.

Parameters:

val - if true, descriptor is case sensitive

SetCaseSense

public void SetCaseSense(java.lang.String val)

Sets the case sensitivity for the string descriptor. Intended for macro programming use.

Parameters:

expression - if expression evaluates to true, descriptor is case sensitive

IsWrap

public boolean IsWrap()

Returns whether the rows specified by a STRING_INRECT descriptor will be concatenated before checking for the specified string. For example, say your STRING_INRECT descriptor specifies a rectangular area that contains: abcdef ghijkl mnopqr If IsWrap() returns true, the string "defghi" would be found with this descriptor. If IsWrap() returns false, the string "defghi" would not be found, because the rectangle would be searched row by row for the descriptor. By default, the "wrap" attribute is false.

Returns:

wrap

IsWrapRaw

public java.lang.String IsWrapRaw()

Returns the expression form of whether the rows specified by a STRING_INRECT descriptor will be concatenated before checking for the specified string. Intended for macro programming use.

Returns:

expression form of wrap

See Also:

IsWrap()

SetWrap

public void SetWrap(boolean val)

Sets the wrap attribute for the string descriptor.

Parameters:

val - if true and this is a STRING_INRECT descriptor, the rows of the specified rectangle will be concatenated when searching for the specified string. if false(default), the rectangle will be searched row by row for the specified text

SetWrap

public void SetWrap(java.lang.String val)

Sets the wrap attribute for the string descriptor. Intended for macro programming use.

Parameters:

expression - if expression evaluates to true and this is a STRING_INRECT descriptor, the rows of the specified rectangle will be concatenated when searching for the specified string. if false(default), the rectangle will be searched row by row for the specified text

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.

Overrides:

Create in class ECLScreenDescriptor

Parameters:

argTable - hash table that contains all the valid parameters.
Consult this document: Host Access Beans for Java : Appendix A. Macro Script Syntax