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
-
ECLSDFields()
- Default constructor for a string descriptor.
-
ECLSDFields(int, boolean)
- Constructs a fields 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.
-
GetNum()
- Returns the number of fields for the descriptor.
-
SetNum(int)
- Sets the number of fields for the descriptor.
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.
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
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
GetNum
public int GetNum()
- Returns the number of fields for the descriptor.
- Returns:
- number of fields
SetNum
public void SetNum(int num)
- Sets the number of fields for the descriptor.
- Parameters:
- num - number of input fields for the descriptor
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