com.ibm.eNetwork.ECL.screenreco Class ECLSDBlock

Overview   Package     Class   Tree   Serialized   Deprecated   Index   Help   API User's Guide  
  PREV CLASS     NEXT CLASS FRAMES     NO FRAMES
SUMMARY:  INNER |  FIELD |  CONSTR |  METHOD DETAIL:   FIELD |  CONSTR |  METHOD 


java.lang.Object
  |
  +--
com.ibm.eNetwork.ECL.screenreco.ECLScreenDescriptor
        |
        +--
com.ibm.eNetwork.ECL.screenreco.ECLSDBlock
All Implemented Interfaces:
com.ibm.eNetwork.HOD.common.HODConstants, java.io.Serializable
public class ECLSDBlock
extends ECLScreenDescriptor

This class is the descriptor class used to describe a block of strings 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 block descriptor may specify a block of strings at either an absolute position or inside a rectangle by using the SetBlockType method. Also, the block 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 , ECLSDString , ECLSDVarUpdate , ECLPS , ECLField , Serialized Form

Field Summary
static int BLOCK_ABSOLUTE           Value used to specify that the block descriptor describes a block of strings at an absolute position.
static int BLOCK_INRECT           Value used to specify that the block descriptor describes a block of strings 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_DATAACCESS, 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
ECLSDBlock ()           Default constructor for a block descriptor.
ECLSDBlock (int row, int col, boolean caseSense, boolean opt)           Constructs a BLOCK_ABSOLUTE string descriptor with the given parameters.
ECLSDBlock (int srow, int scol, int erow, int ecol, boolean caseSense, boolean opt)           Constructs a BLOCK_INRECT string descriptor with the given parameters.
ECLSDBlock (java.lang.String hostid, int row, int col, boolean caseSense, boolean opt)           Constructs a BLOCK_ABSOLUTE string descriptor with the given parameters.
ECLSDBlock (java.lang.String hostid, int srow, int scol, int erow, int ecol, boolean caseSense, boolean opt)           Constructs a BLOCK_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 GetBlockType ()           Returns the block matching type for the block descriptor.
 int GetECol ()           Returns the ending column for the block descriptor.
 java.lang.String GetEColRaw ()           Returns the expression form of the ending column for the block descriptor.
 int GetERow ()           Returns the ending row for the block descriptor.
 java.lang.String GetERowRaw ()           Returns the expression form of the ending row for the block descriptor.
 int GetSCol ()           Returns the starting column for the block descriptor.
 java.lang.String GetSColRaw ()           Returns the expression form of the starting column for the block descriptor.
 int GetSRow ()           Returns the starting row for the block descriptor.
 java.lang.String GetSRowRaw ()           Returns the expression form of the starting row for the block descriptor.
 java.lang.String[] GetStrings ()           Returns the string text for the block descriptor.
 java.lang.String[] GetStringsRaw ()           Returns the expression form of the string text for the block descriptor.
 boolean IsCaseSense ()           Returns the case sensitivity for the block descriptor.
 java.lang.String IsCaseSenseRaw ()           Returns the expression form of the case sensitivity for the block descriptor.
 void SetBlockType (int type)           Sets the block matching type for the block descriptor.
 void SetCaseSense (boolean val)           Sets the case sensitivity for the block descriptor.
 void SetCaseSense (java.lang.String val)           Sets the case sensitivity for the block descriptor.
 void SetECol (int col)           Sets the ending column for the block descriptor.
 void SetECol (java.lang.String col)           Sets the ending column for the block descriptor.
 void SetERow (int row)           Sets the ending row for the block descriptor.
 void SetERow (java.lang.String row)           Sets the ending row for the block descriptor.
 void SetSCol (int col)           Sets the starting column for the block descriptor.
 void SetSCol (java.lang.String col)           Sets the starting column for the block descriptor.
 void SetSRow (int row)           Sets the starting row for the block descriptor.
 void SetSRow (java.lang.String row)           Sets the starting row for the block descriptor.
 void SetStrings (java.lang.String[] ss)           Sets the string text for the block descriptor.

 

Methods inherited from class com.ibm.eNetwork.ECL.screenreco. ECLScreenDescriptor
GetHostid, GetHostidRaw, IsInvertMatch, IsInvertMatchRaw, IsMatch, IsMultiSessionDescriptor, IsOptional, IsOptionalRaw, SetHostid, SetInvertMatch, SetInvertMatch, SetMatch, SetOptional, SetOptional

 

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

BLOCK_ABSOLUTE



public static final int 
BLOCK_ABSOLUTE

BLOCK_INRECT



public static final int 
BLOCK_INRECT

Constructor Detail

ECLSDBlock



public 
ECLSDBlock()

ECLSDBlock



public 
ECLSDBlock(int row,
                  int col,
                  boolean caseSense,
                  boolean opt)

ECLSDBlock



public 
ECLSDBlock(java.lang.String hostid,
                  int row,
                  int col,
                  boolean caseSense,
                  boolean opt)

ECLSDBlock



public 
ECLSDBlock(int srow,
                  int scol,
                  int erow,
                  int ecol,
                  boolean caseSense,
                  boolean opt)

ECLSDBlock



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

Method Detail

Format



public java.lang.String 
Format(int argType,
                               boolean displayAll)

GetBlockType



public int 
GetBlockType()

SetBlockType



public void 
SetBlockType(int type)

GetSRow



public int 
GetSRow()

GetSRowRaw



public java.lang.String 
GetSRowRaw()

SetSRow



public void 
SetSRow(int row)

SetSRow



public void 
SetSRow(java.lang.String row)

GetSCol



public int 
GetSCol()

GetSColRaw



public java.lang.String 
GetSColRaw()

SetSCol



public void 
SetSCol(int col)

SetSCol



public void 
SetSCol(java.lang.String col)

GetERow



public int 
GetERow()

GetERowRaw



public java.lang.String 
GetERowRaw()

SetERow



public void 
SetERow(int row)

SetERow



public void 
SetERow(java.lang.String row)

GetECol



public int 
GetECol()

GetEColRaw



public java.lang.String 
GetEColRaw()

SetECol



public void 
SetECol(int col)

SetECol



public void 
SetECol(java.lang.String col)

GetStrings



public java.lang.String[] 
GetStrings()

GetStringsRaw



public java.lang.String[] 
GetStringsRaw()

SetStrings



public void 
SetStrings(java.lang.String[] ss)

IsCaseSense



public boolean 
IsCaseSense()

IsCaseSenseRaw



public java.lang.String 
IsCaseSenseRaw()

SetCaseSense



public void 
SetCaseSense(boolean val)

SetCaseSense



public void 
SetCaseSense(java.lang.String val)

Create



public java.util.Vector 
Create(java.util.Hashtable argTable)

Overview   Package     Class   Tree   Serialized   Deprecated   Index   Help   API User's Guide  
  PREV CLASS     NEXT CLASS FRAMES     NO FRAMES
SUMMARY:  INNER |  FIELD |  CONSTR |  METHOD DETAIL:   FIELD |  CONSTR |  METHOD