All Packages Class Hierarchy This Package Previous Next Index
Class com.ibm.eNetwork.ECL.screenreco.ECLSDAttrib
java.lang.Object
|
+----com.ibm.eNetwork.ECL.screenreco.ECLScreenDescriptor
|
+----com.ibm.eNetwork.ECL.screenreco.ECLSDAttrib
- 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 IBM 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.
- See Also:
- ECLScreenReco, ECLScreenDesc, ECLScreenDescriptor, ECLSDCursor, ECLSDCustom, ECLSDFields, ECLSDInputFields, ECLSDOIA, ECLSDString, ECLPS, ECLField
-
ECLSDAttrib()
- Default constructor for a string descriptor.
-
ECLSDAttrib(char, int, int, int, boolean)
- Constructs an attribute descriptor with the given parameters.
-
Create(Hashtable)
- Creates a working instance of the descriptor from the string values
contained in the hash table.
-
Format(int, boolean)
- Formats the action object's contents into a readable string.
-
GetAttrib()
- Returns the attribute value for the descriptor.
-
GetCol()
- Returns the column position for the attribute descriptor.
-
GetPlane()
- Returns the plane type for the attribute descriptor.
-
GetPlaneAsString()
- Returns the string representation of the plane value set for the
attribute descriptor.
-
GetRow()
- Returns the row position for the attribute descriptor.
-
SetAttrib(char)
- Sets the attribute value for the descriptor.
-
SetAttrib(String)
- Sets the attribute value for the descriptor from a string.
-
SetCol(int)
- Sets the column position for the attribute descriptor.
-
SetPlane(int)
- Sets the plane type for the attribute descriptor.
-
SetPlaneAsString(String)
- Sets the plane value from string for the attribute descriptor.
-
SetRow(int)
- Sets the row position for the attribute descriptor.
ECLSDAttrib
public ECLSDAttrib()
- Default constructor for a string descriptor. Attribute value will be
0x00, row/col positions will be 1, and the plane will be ECLConstants.FIELD_PLANE.
If you use this constructor you must call all the set methods of this
class to properly set up the descriptor.
ECLSDAttrib
public ECLSDAttrib(char attrib,
int row,
int col,
int plane,
boolean opt)
- Constructs an attribute descriptor with the given parameters.
This constructor will create a usable descriptor. No set methods
need be called.
- Parameters:
- attrib - attibute value for the descriptor
- row - row position for the attribute
- col - column position for the attribute
- plane - plane type for the attribute
- opt - if true, descriptor is optional
See Also:
Appendix B. Host Access Class Library Planes -- Format and Content
- See Also:
- ECLConstants
Format
public String Format(int argType,
boolean displayAll)
- Formats the action object's contents into a readable string. Intended
for visual feedback, as with the ECLRecoDebugEvent class.
- Parameters:
- argType - type of string to produce (reserved for future use)
- displayAll - formats the default values also
- Returns:
- formatted string that reflects the contents of the descriptor
- Overrides:
- Format in class ECLScreenDescriptor
Create
public Vector Create(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 Host Access Beans for Java : Appendix A. Macro Script Syntax
- Overrides:
- Create in class ECLScreenDescriptor
GetPlane
public int GetPlane()
- Returns the plane type for the attribute descriptor.
- Returns:
- plane value
SetPlane
public void SetPlane(int plane)
- Sets the plane type for the attribute descriptor. The plane values
are defined in the ECLConstants class.
- Parameters:
- plane - plane type for the attribute
- See Also:
- ECLConstants
GetAttrib
public char GetAttrib()
- Returns the attribute value for the descriptor.
- Returns:
- attribute value
SetAttrib
public void SetAttrib(char attrib)
- Sets the attribute value for the descriptor.
- Parameters:
- attrib - attibute value for the descriptor
SetAttrib
public void SetAttrib(String attribStr)
- Sets the attribute value for the descriptor from a string.
- Parameters:
- attribStr - string that represents attibute value for
the descriptor
GetRow
public int GetRow()
- Returns the row position for the attribute descriptor.
- Returns:
- row position
SetRow
public void SetRow(int row)
- Sets the row position for the attribute descriptor.
- Parameters:
- row - row position for the attribute
GetCol
public int GetCol()
- Returns the column position for the attribute descriptor.
- Returns:
- column position
SetCol
public void SetCol(int col)
- Sets the column position for the attribute descriptor.
- Parameters:
- col - column position for the attribute
SetPlaneAsString
public void SetPlaneAsString(String planestr)
- Sets the plane value from string for the attribute descriptor.
This is a convenience method.
- Parameters:
- planestr - string representation of a plane, valid values
are as follows:
Plane Value | String Value |
ECLConstants.TEXT_PLANE | TEXT_PLANE |
ECLConstants.FIELD_PLANE | FIELD_PLANE |
ECLConstants.EXFIELD_PLANE | EXFIELD_PLANE |
ECLConstants.COLOR_PLANE | COLOR_PLANE |
ECLConstants.DBCS_PLANE | DBCS_PLANE |
ECLConstants.GRID_PLANE | GRID_PLANE |
GetPlaneAsString
public String GetPlaneAsString()
- Returns the string representation of the plane value set for the
attribute descriptor. This is a convenience method.
- Returns:
- string representation of the plane value
All Packages Class Hierarchy This Package Previous Next Index