All Packages Class Hierarchy This Package Previous Next Index
Class com.ibm.eNetwork.ECL.ECLFieldList
java.lang.Object
|
+----java.util.Vector
|
+----com.ibm.eNetwork.ECL.ECLFieldList
- public class ECLFieldList
- extends Vector
- implements ECLConstants, iOhioFields
ECLFieldList contains a collection of the fields in the presentation
space. It provides methods to iterate through the fields, find fields
based on location, and find fields containing a given string. Each
element of the collection is an instance of ECLField.
ECLFieldList can only be accessed through ECLPS using the
GetFieldList() method. ECLFieldList is a static view of the
presentation space and does not reflect changes made to the
presentation space after its construction. The field list can be
updated with a new snapshot of the presentation space using the
Refresh() method.
Note:All ECLField objects returned by methods in this class
are invalidated when Refresh() is called.
- See Also:
- ECLField, ECLPS
-
FindField(int)
- Finds the field which contains the specified linear position.
-
FindField(int, int)
- Finds the field which contains the specified row and column coordinate.
-
FindField(String, int)
- Finds the field which contains the given string.
-
FindField(String, int, int)
- Finds the field which contains the given string.
-
FindField(String, int, int, int)
- Finds the field which contains the given string.
-
GetFieldCount()
- Gets the number of fields in the field list.
-
GetFirstField()
- Returns the first field in the field list.
-
GetFirstField(int)
- Gets the first field in the field list which matches the specified
attributes.
-
GetNextField(ECLField)
- Returns the next field in the field list after the given field.
-
GetNextField(ECLField, int)
- Returns the next field in the field list with the specified
attributes.
-
Refresh()
- Refreshes the field list with a snapshot of the fields in the current
presentation space.
-
Refresh(int)
- Refreshes the field list with a snapshot of the fields in the current
presentation space.
Refresh
public void Refresh() throws ECLErr
- Refreshes the field list with a snapshot of the fields in the current
presentation space. All references to the fields previously contained
within the field list are invalidated.
The new ECLField objects will contain only TEXT plane information.
- Throws: ECLErr
- Thrown if the plane parameter is not valid or
error occurred building the field list.
- See Also:
- Refresh
Refresh
public void Refresh(int planes) throws ECLErr
- Refreshes the field list with a snapshot of the fields in the current
presentation space. All references to the fields previously contained
within the field list are invalidated.
The new ECLField objects will only contain information
about the presentation space planes specified, except for the text and
attribute planes which are always available.
- Parameters:
- planes - The planes to refresh. The valid values follow
and can be ORed together:
- TEXT_PLANE - The character
contents of the field. The text plane contains no null
or non-displayable characters.
- FIELD_PLANE - The field
attributes for each field in the plane.
- COLOR_PLANE - The color
attributes for each character in the plane.
- EXFIELD_PLANE - The extended
field attributes for each character in the plane.
- DBCS_PLANE - The double byte
character set (DBCS) character and field attribute data.
- GRID_PLANE - The DBCS
grid information.
- ALL_PLANES - Refreshes all planes.
- Throws: ECLErr
- Thrown if the planes parameter is not valid or
error occurred building the field list.
GetFieldCount
public int GetFieldCount()
- Gets the number of fields in the field list.
- Returns:
- The number fields in the field list.
GetFirstField
public ECLField GetFirstField(int attr)
- Gets the first field in the field list which matches the specified
attributes.
- Parameters:
- attr - The attributes of the desired field. The valid
values follow:
- ALL_FIELDS - all fields, regardless of attributes
- These values may be ORed together and take precedence
over their counterparts below if both are included in
the attribute parameter.
- MODIFIED_FIELD - modified
- ALPHANUM_FIELD - alphanumeric
- HILIGHT_FIELD - high-intensity
- PROTECTED_FIELD - protected
- DISPLAYABLE_FIELD - displayable
- PENDETECTABLE_FIELD - pen-detectable
- These values may be ORed together and will be overridden
by their counterparts above if both are included in
the attribute parameter.
- UNMODIFIED_FIELD - unmodified
- NUMERIC_FIELD - numeric-only
- LOLIGHT_FIELD - not high-intensity
- UNPROTECTED_FIELD - unprotected
- NON_DISPLAYABLE_FIELD - non-displayable
- NON_PENDETECTABLE_FIELD - not pen-detectable
- Returns:
- The first field with the given attributes or null if
no matching field is found.
- See Also:
- GetNextField
GetFirstField
public ECLField GetFirstField()
- Returns the first field in the field list.
- See Also:
- GetFirstField, GetNextField, GetNextField
GetNextField
public ECLField GetNextField(ECLField afterThis,
int attr)
- Returns the next field in the field list with the specified
attributes. Searching starts at the field given by the ECLField parameter. If the ECLField
parameter is null, the first field in the field list with the specified
attributes will be returned.
- Parameters:
- afterThis - The field after which the search will begin.
- attr - The attributes of the desired field. Use one of
the following values:
- ALL_FIELDS - all fields, regardless of attributes
- These values may be ORed together and take precedence
over their counterparts below if both are included in
the attribute parameter.
- MODIFIED_FIELD - modified
- ALPHANUM_FIELD - alphanumeric
- HILIGHT_FIELD - high-intensity
- PROTECTED_FIELD - protected
- DISPLAYABLE_FIELD - displayable
- PENDETECTABLE_FIELD - pen-detectable
- These values may be ORed together and will be overridden
by their counterparts above if both are included in
the attribute parameter.
- UNMODIFIED_FIELD - unmodified
- NUMERIC_FIELD - numeric-only
- LOLIGHT_FIELD - not high-intensity
- UNPROTECTED_FIELD - unprotected
- NON_DISPLAYABLE_FIELD - non-displayable
- NON_PENDETECTABLE_FIELD - not pen-detectable
- See Also:
- GetFirstField, GetFirstField, GetNextField
GetNextField
public ECLField GetNextField(ECLField afterThis)
- Returns the next field in the field list after the given field.
If the ECLField parameter is null, the first field in the field list
will be returned.
- Parameters:
- afterThis - The field after which the search will begin.
- See Also:
- GetFirstField, GetFirstField, GetNextField
FindField
public ECLField FindField(int pos) throws ECLErr
- Finds the field which contains the specified linear position.
- Parameters:
- pos - Linear position
- Returns:
- The field which contains the specified position.
- Throws: ECLErr
- Thrown if the given position is out of range.
- See Also:
- FindField
FindField
public ECLField FindField(int row,
int col) throws ECLErr
- Finds the field which contains the specified row and column coordinate.
- Parameters:
- row - Row of the field to find
- col - Column of the field to find
- Returns:
- The field which contains the specified coordinate.
- Throws: ECLErr
- Thrown if the given position is out of range.
- See Also:
- FindField
FindField
public ECLField FindField(String text,
int direction) throws ECLErr
- Finds the field which contains the given string. This method
searches for the text string in either the forward or backward
direction. If a forward search is requested,
the search starts at the beginning of the presentation space.
If a backward search is requested, the search starts at the end
of the presentation space.
If the search string spans more than one field, the field
containing the starting position of the string is returned.
- Parameters:
- text - String to search for.
- direction - Direction to search, either SEARCH_FORWARD or
SEARCH_BACKWARD
- Returns:
- The field which contains the specified string or null if
no field is found.
- Throws: ECLErr
- Thrown if the given position is out of range.
- See Also:
- FindField, FindField
FindField
public ECLField FindField(String text,
int pos,
int direction) throws ECLErr
- Finds the field which contains the given string. This method
searches from the given linear position in either the forward
or backward direction.
If the search string spans more than one field, the field
containing the starting position of the string is returned.
- Parameters:
- text - String to search for.
- pos - Starting position for the search.
- direction - Direction to search, either SEARCH_FORWARD or
SEARCH_BACKWARD
- Returns:
- The field which contains the specified string or null if
no field is found.
- Throws: ECLErr
- Thrown if the given position is out of range.
- See Also:
- FindField, FindField
FindField
public ECLField FindField(String text,
int row,
int col,
int direction) throws ECLErr
- Finds the field which contains the given string. This method
searches from the given row and column coordinate in either the forward
or backward direction.
If the search string spans more than one field, the field
containing the starting position of the string is returned.
- Parameters:
- text - String to search for.
- row - Starting row for the search.
- col - Starting column for the search.
- direction - Direction to search, either SEARCH_FORWARD or
SEARCH_BACKWARD
- Returns:
- The field which contains the specified string or null if
no field is found.
- Throws: ECLErr
- Thrown if the given position is out of range.
- See Also:
- FindField, FindField
All Packages Class Hierarchy This Package Previous Next Index