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
-
ALL_FIELDS
-
-
ALPHANUM_FIELD
-
-
DB_CA_EXIST
-
-
DB_CLEAR
-
-
DB_DB1
-
-
DB_DBCS
-
-
DB_DBHIGH
-
-
DB_DEAD
-
-
DB_MIX
-
-
DB_SI
-
-
DB_SO
-
-
DB_SOSI_EXIST
-
-
DBATTR_DEFAULT
-
-
DBATTR_EITHER
-
-
DBATTR_ONLY
-
-
DBATTR_OPEN
-
-
DBATTR_PURE
-
-
DISPLAYABLE_FIELD
-
-
DUP_CHAR
-
-
EBC_SI
-
-
EBC_SO
-
-
EXT_BLINK
-
-
EXT_COL_SEP
-
-
EXT_D_BOTH
-
-
EXT_D_LEFT
-
-
EXT_D_OVER
-
-
EXT_D_RIGHT
-
-
EXT_D_UNDER
-
-
EXT_G_ALL
-
-
EXT_G_LEFT
-
-
EXT_G_OVER
-
-
EXT_G_RIGHT
-
-
EXT_G_UNDER
-
-
EXT_REVERSE
-
-
EXT_UNDERLN
-
-
FIELD_MARK
-
-
HILIGHT_FIELD
-
-
LOLIGHT_FIELD
-
-
MODIFIED_FIELD
-
-
NON_DISPLAYABLE_FIELD
-
-
NON_PENDETECTABLE_FIELD
-
-
NUMERIC_FIELD
-
-
PENDETECTABLE_FIELD
-
-
PROTECTED_FIELD
-
-
UNMODIFIED_FIELD
-
-
UNPROTECTED_FIELD
-
-
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(int)
- Gets the first field in the field list which matches the specified
attributes.
-
GetNextField(ECLField, int)
- Gets the first field after the specified field with the specified
attributes.
-
Refresh(int)
- Refreshes the field list with a snapshot of the fields in the current
presentation space.
-
update(Observable, Object)
- Method called to turn tracing on and off for this class.
EXT_BLINK
public static final short EXT_BLINK
EXT_REVERSE
public static final short EXT_REVERSE
EXT_UNDERLN
public static final short EXT_UNDERLN
EXT_COL_SEP
public static final short EXT_COL_SEP
DB_MIX
public static final short DB_MIX
DB_SOSI_EXIST
public static final short DB_SOSI_EXIST
DB_CA_EXIST
public static final short DB_CA_EXIST
DBATTR_DEFAULT
public static final short DBATTR_DEFAULT
DBATTR_ONLY
public static final short DBATTR_ONLY
DBATTR_EITHER
public static final short DBATTR_EITHER
DBATTR_OPEN
public static final short DBATTR_OPEN
DBATTR_PURE
public static final short DBATTR_PURE
DB_DBCS
public static final short DB_DBCS
DB_DB1
public static final short DB_DB1
DB_SO
public static final short DB_SO
DB_SI
public static final short DB_SI
DB_DEAD
public static final short DB_DEAD
DB_DBHIGH
public static final short DB_DBHIGH
DB_CLEAR
public static final short DB_CLEAR
EBC_SO
public static final short EBC_SO
EBC_SI
public static final short EBC_SI
EXT_G_LEFT
public static final short EXT_G_LEFT
EXT_G_OVER
public static final short EXT_G_OVER
EXT_G_RIGHT
public static final short EXT_G_RIGHT
EXT_G_UNDER
public static final short EXT_G_UNDER
EXT_D_LEFT
public static final short EXT_D_LEFT
EXT_D_OVER
public static final short EXT_D_OVER
EXT_D_RIGHT
public static final short EXT_D_RIGHT
EXT_D_UNDER
public static final short EXT_D_UNDER
EXT_G_ALL
public static final short EXT_G_ALL
EXT_D_BOTH
public static final short EXT_D_BOTH
ALL_FIELDS
public static final int ALL_FIELDS
MODIFIED_FIELD
public static final int MODIFIED_FIELD
ALPHANUM_FIELD
public static final int ALPHANUM_FIELD
HILIGHT_FIELD
public static final int HILIGHT_FIELD
PROTECTED_FIELD
public static final int PROTECTED_FIELD
DISPLAYABLE_FIELD
public static final int DISPLAYABLE_FIELD
PENDETECTABLE_FIELD
public static final int PENDETECTABLE_FIELD
UNMODIFIED_FIELD
public static final int UNMODIFIED_FIELD
NUMERIC_FIELD
public static final int NUMERIC_FIELD
LOLIGHT_FIELD
public static final int LOLIGHT_FIELD
UNPROTECTED_FIELD
public static final int UNPROTECTED_FIELD
NON_DISPLAYABLE_FIELD
public static final int NON_DISPLAYABLE_FIELD
NON_PENDETECTABLE_FIELD
public static final int NON_PENDETECTABLE_FIELD
DUP_CHAR
public static final short DUP_CHAR
FIELD_MARK
public static final short FIELD_MARK
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.
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
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
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 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
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
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