com.ibm.eNetwork.ECL.screenreco Class ECLSDAttrib

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.ECLSDAttrib
All Implemented Interfaces:
com.ibm.eNetwork.HOD.common.HODConstants, java.io.Serializable
public class ECLSDAttrib
extends ECLScreenDescriptor

This class is the descriptor class used to describe a single attribute 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 attribute descriptor specifies a given attribute in a given plane at a given row/column position. Attribute and plane values are described in Appendix B of the HCL Host Access Class Library reference.

You should only use this descriptor when you know the makeup of your host screen and you need to make your screen description unique.

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 , ECLSDCursor , ECLSDCustom , ECLSDFields , ECLSDInputFields , ECLSDOIA , ECLSDString , ECLSDVarUpdate , ECLPS , ECLField , 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_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
ECLSDAttrib ()           Default constructor for a string descriptor.
ECLSDAttrib (char attrib, int row, int col, int plane, boolean opt)           Constructs an attribute descriptor with the given parameters.
ECLSDAttrib (java.lang.String hostid, char attrib, int row, int col, int plane, boolean opt)           Constructs an attribute 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.
 char GetAttrib ()           Returns the attribute value for the descriptor.
 java.lang.String GetAttribRaw ()           Returns the expression form of the attribute value for the descriptor.
 int GetCol ()           Returns the column position for the attribute descriptor.
 java.lang.String GetColRaw ()           Returns the expression form of the column position for the attribute descriptor.
 int GetPlane ()           Returns the plane type for the attribute descriptor.
 java.lang.String GetPlaneAsString ()           Returns the string representation of the plane value set for the attribute descriptor.
 java.lang.String GetPlaneRaw ()           Returns the expression form of the plane type for the attribute descriptor.
 int GetRow ()           Returns the row position for the attribute descriptor.
 java.lang.String GetRowRaw ()           Returns the expression form of the row position for the attribute descriptor.
 void SetAttrib (char attrib)           Sets the attribute value for the descriptor.
 void SetAttrib (java.lang.String attribStr)           Sets the attribute value for the descriptor from a string.
 void SetCol (int col)           Sets the column position for the attribute descriptor.
 void SetCol (java.lang.String col)           Sets the column position for the attribute descriptor.
 void SetPlane (int plane)           Sets the plane type for the attribute descriptor.
 void SetPlane (java.lang.String argPlane)           Sets the plane type for the attribute descriptor.
 void SetPlaneAsString (java.lang.String planestr)           Sets the plane value from string for the attribute descriptor.
 void SetRow (int row)           Sets the row position for the attribute descriptor.
 void SetRow (java.lang.String row)           Sets the row position for the attribute 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

 

Constructor Detail

ECLSDAttrib



public 
ECLSDAttrib()

ECLSDAttrib



public 
ECLSDAttrib(char attrib,
                   int row,
                   int col,
                   int plane,
                   boolean opt)

ECLSDAttrib



public 
ECLSDAttrib(java.lang.String hostid,
                   char attrib,
                   int row,
                   int col,
                   int plane,
                   boolean opt)

Method Detail

Format



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

Create



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

GetPlane



public int 
GetPlane()

GetPlaneRaw



public java.lang.String 
GetPlaneRaw()

SetPlane



public void 
SetPlane(int plane)

SetPlane



public void 
SetPlane(java.lang.String argPlane)

GetAttrib



public char 
GetAttrib()

GetAttribRaw



public java.lang.String 
GetAttribRaw()

SetAttrib



public void 
SetAttrib(char attrib)

SetAttrib



public void 
SetAttrib(java.lang.String attribStr)

GetRow



public int 
GetRow()

GetRowRaw



public java.lang.String 
GetRowRaw()

SetRow



public void 
SetRow(int row)

SetRow



public void 
SetRow(java.lang.String row)

GetCol



public int 
GetCol()

GetColRaw



public java.lang.String 
GetColRaw()

SetCol



public void 
SetCol(int col)

SetCol



public void 
SetCol(java.lang.String col)

SetPlaneAsString



public void 
SetPlaneAsString(java.lang.String planestr)

GetPlaneAsString



public java.lang.String 
GetPlaneAsString()

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