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, Observer
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

Variable Index

 o ALL_FIELDS
 o ALPHANUM_FIELD
 o DB_CA_EXIST
 o DB_CLEAR
 o DB_DB1
 o DB_DBCS
 o DB_DBHIGH
 o DB_DEAD
 o DB_MIX
 o DB_SI
 o DB_SO
 o DB_SOSI_EXIST
 o DBATTR_DEFAULT
 o DBATTR_EITHER
 o DBATTR_ONLY
 o DBATTR_OPEN
 o DBATTR_PURE
 o DISPLAYABLE_FIELD
 o DUP_CHAR
 o EBC_SI
 o EBC_SO
 o EXT_BLINK
 o EXT_COL_SEP
 o EXT_D_BOTH
 o EXT_D_LEFT
 o EXT_D_OVER
 o EXT_D_RIGHT
 o EXT_D_UNDER
 o EXT_G_ALL
 o EXT_G_LEFT
 o EXT_G_OVER
 o EXT_G_RIGHT
 o EXT_G_UNDER
 o EXT_REVERSE
 o EXT_UNDERLN
 o FIELD_MARK
 o HILIGHT_FIELD
 o LOLIGHT_FIELD
 o MODIFIED_FIELD
 o NON_DISPLAYABLE_FIELD
 o NON_PENDETECTABLE_FIELD
 o NUMERIC_FIELD
 o PENDETECTABLE_FIELD
 o PROTECTED_FIELD
 o UNMODIFIED_FIELD
 o UNPROTECTED_FIELD

Method Index

 o FindField(int)
Finds the field which contains the specified linear position.
 o FindField(int, int)
Finds the field which contains the specified row and column coordinate.
 o FindField(String, int)
Finds the field which contains the given string.
 o FindField(String, int, int)
Finds the field which contains the given string.
 o FindField(String, int, int, int)
Finds the field which contains the given string.
 o GetFieldCount()
Gets the number of fields in the field list.
 o GetFirstField(int)
Gets the first field in the field list which matches the specified attributes.
 o GetNextField(ECLField, int)
Gets the first field after the specified field with the specified attributes.
 o Refresh(int)
Refreshes the field list with a snapshot of the fields in the current presentation space.
 o update(Observable, Object)
Method called to turn tracing on and off for this class.

Variables

 o EXT_BLINK
 public static final short EXT_BLINK
 o EXT_REVERSE
 public static final short EXT_REVERSE
 o EXT_UNDERLN
 public static final short EXT_UNDERLN
 o EXT_COL_SEP
 public static final short EXT_COL_SEP
 o DB_MIX
 public static final short DB_MIX
 o DB_SOSI_EXIST
 public static final short DB_SOSI_EXIST
 o DB_CA_EXIST
 public static final short DB_CA_EXIST
 o DBATTR_DEFAULT
 public static final short DBATTR_DEFAULT
 o DBATTR_ONLY
 public static final short DBATTR_ONLY
 o DBATTR_EITHER
 public static final short DBATTR_EITHER
 o DBATTR_OPEN
 public static final short DBATTR_OPEN
 o DBATTR_PURE
 public static final short DBATTR_PURE
 o DB_DBCS
 public static final short DB_DBCS
 o DB_DB1
 public static final short DB_DB1
 o DB_SO
 public static final short DB_SO
 o DB_SI
 public static final short DB_SI
 o DB_DEAD
 public static final short DB_DEAD
 o DB_DBHIGH
 public static final short DB_DBHIGH
 o DB_CLEAR
 public static final short DB_CLEAR
 o EBC_SO
 public static final short EBC_SO
 o EBC_SI
 public static final short EBC_SI
 o EXT_G_LEFT
 public static final short EXT_G_LEFT
 o EXT_G_OVER
 public static final short EXT_G_OVER
 o EXT_G_RIGHT
 public static final short EXT_G_RIGHT
 o EXT_G_UNDER
 public static final short EXT_G_UNDER
 o EXT_D_LEFT
 public static final short EXT_D_LEFT
 o EXT_D_OVER
 public static final short EXT_D_OVER
 o EXT_D_RIGHT
 public static final short EXT_D_RIGHT
 o EXT_D_UNDER
 public static final short EXT_D_UNDER
 o EXT_G_ALL
 public static final short EXT_G_ALL
 o EXT_D_BOTH
 public static final short EXT_D_BOTH
 o ALL_FIELDS
 public static final int ALL_FIELDS
 o MODIFIED_FIELD
 public static final int MODIFIED_FIELD
 o ALPHANUM_FIELD
 public static final int ALPHANUM_FIELD
 o HILIGHT_FIELD
 public static final int HILIGHT_FIELD
 o PROTECTED_FIELD
 public static final int PROTECTED_FIELD
 o DISPLAYABLE_FIELD
 public static final int DISPLAYABLE_FIELD
 o PENDETECTABLE_FIELD
 public static final int PENDETECTABLE_FIELD
 o UNMODIFIED_FIELD
 public static final int UNMODIFIED_FIELD
 o NUMERIC_FIELD
 public static final int NUMERIC_FIELD
 o LOLIGHT_FIELD
 public static final int LOLIGHT_FIELD
 o UNPROTECTED_FIELD
 public static final int UNPROTECTED_FIELD
 o NON_DISPLAYABLE_FIELD
 public static final int NON_DISPLAYABLE_FIELD
 o NON_PENDETECTABLE_FIELD
 public static final int NON_PENDETECTABLE_FIELD
 o DUP_CHAR
 public static final short DUP_CHAR
 o FIELD_MARK
 public static final short FIELD_MARK

Methods

 o 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. Note that the text and field planes are always refreshed.

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.
 o GetFieldCount
 public int GetFieldCount()
Gets the number of fields in the field list.

Returns:
The number fields in the field list.
 o 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
 o GetNextField
 public ECLField GetNextField(ECLField afterThis,
                              int attr)
Gets the first field after the specified field with the specified attributes. 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. See the value descriptions under GetFirstField(int).
Returns:
The first field after the given field with the given attributes or null if no matching field is found.
See Also:
GetFirstField
 o 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
 o 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
 o 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 positoin 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
 o 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
 o 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
 o update
 public void update(Observable o,
                    Object arg)
Method called to turn tracing on and off for this class.


All Packages  Class Hierarchy  This Package  Previous  Next  Index