All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.ibm.eNetwork.ECL.screenreco.ECLSDFields

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

public class ECLSDFields
extends ECLScreenDescriptor
This class is the descriptor class used to describe the number of total fields 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 fields descriptor simply specifies the total number of fields for a screen that you wish to describe. These field types are specified in the ECLField class, but the important thing to remember is that the ECLSDFields class compares the number of total fields. You may set this number by using the appropriate constructor or by calling the setNum method.

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

See Also:
ECLScreenReco, ECLScreenDesc, ECLScreenDescriptor, ECLSDAttrib, ECLSDCursor, ECLSDCustom, ECLSDInputFields, ECLSDOIA, ECLSDString, ECLPS, ECLField

Constructor Index

 o ECLSDFields()
Default constructor for a string descriptor.
 o ECLSDFields(int, boolean)
Constructs a fields descriptor with the given parameters.

Method Index

 o Create(Hashtable)
Creates a working instance of the descriptor from the string values contained in the hash table.
 o Format(int, boolean)
Formats the action object's contents into a readable string.
 o GetNum()
Returns the number of fields for the descriptor.
 o SetNum(int)
Sets the number of fields for the descriptor.

Constructors

 o ECLSDFields
 public ECLSDFields()
Default constructor for a string descriptor. Field count will be 0.

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

 o ECLSDFields
 public ECLSDFields(int num,
                    boolean opt)
Constructs a fields descriptor with the given parameters.

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

Parameters:
num - number of fields for the descriptor
opt - if true, descriptor is optional

Methods

 o Format
 public 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.

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
 o GetNum
 public int GetNum()
Returns the number of fields for the descriptor.

Returns:
number of fields
 o SetNum
 public void SetNum(int num)
Sets the number of fields for the descriptor.

Parameters:
num - number of input fields for the descriptor
 o 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

All Packages  Class Hierarchy  This Package  Previous  Next  Index