HATS 7.5.1 Web API Reference

Publicly accessible methods not documented here are for IBM internal use only and may change in a future release of the product.

com.ibm.hats.common
Class HostScreenFieldList

java.lang.Object
  extended by com.ibm.hsr.screen.IScreenFieldList
      extended by com.ibm.hats.common.HostScreenFieldList

public class HostScreenFieldList
extends IScreenFieldList

This is the HATS implementation of an ECLFieldList. Please refer to the ECLFieldList javadoc for information on usage.

See Also:
ECLFieldList

Field Summary
static int ALL_FIELDS
           
static int ALPHANUM_FIELD
           
static int DISPLAYABLE_FIELD
           
static int HILIGHT_FIELD
           
static int LOLIGHT_FIELD
           
static int MODIFIED_FIELD
           
static int NON_DISPLAYABLE_FIELD
           
static int NON_PENDETECTABLE_FIELD
           
static int NUMERIC_FIELD
           
static int PENDETECTABLE_FIELD
           
static int PROTECTED_FIELD
           
static int UNMODIFIED_FIELD
           
static int UNPROTECTED_FIELD
           
 
Constructor Summary
HostScreenFieldList(HostScreen screen)
           
 
Method Summary
 HsrScreenField findField(int pos)
          Finds the field which contains the specified linear position.
 HostScreenField FindField(int pos)
           
 HsrScreenField findField(int row, int col)
          Finds the field which contains the specified row and column coordinate.
 HostScreenField FindField(int row, int col)
           
 HostScreenField findField(String text, int direction)
           
 HostScreenField FindField(String text, int direction)
           
 HostScreenField findField(String text, int pos, int direction)
           
 HostScreenField FindField(String text, int pos, int direction)
           
 HostScreenField findField(String text, int row, int col, int direction)
           
 HostScreenField FindField(String text, int row, int col, int direction)
           
 HsrScreenField getField(int number)
          Returns the HsrScreenField at the specified (zero-based) index.
 int getFieldCount()
          Get the number of fields in the screen.
 int GetFieldCount()
           
 HsrScreenField getFirstField()
          Get the first field in the field list.
 HostScreenField GetFirstField()
           
 HostScreenField getFirstField(int attr)
           
 HostScreenField GetFirstField(int attr)
           
 int getIndex(HsrScreenField hsrField)
          Returns the zero-based index of the given HsrScreenField in the field list.
 HostScreenField getNextField(HostScreenField afterThis)
           
 HsrScreenField getNextField(HsrScreenField afterThis)
          Returns the next field in the field list after the given field.
 HostScreenField GetNextField(HsrScreenField afterThis)
           
 HostScreenField getNextField(HsrScreenField afterThis, int attr)
           
 HostScreenField GetNextField(HsrScreenField afterThis, int attr)
           
 HostScreenField getPreviousField(HostScreenField afterThis)
           
 HsrScreenField getPreviousField(HsrScreenField afterThis)
          Returns the previous field in the field list before the given field.
 HostScreenField getPreviousField(HsrScreenField beforeThis, int attr)
           
 void Refresh()
           
 void Refresh(int planes)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ALL_FIELDS

public static int ALL_FIELDS

ALPHANUM_FIELD

public static int ALPHANUM_FIELD

DISPLAYABLE_FIELD

public static int DISPLAYABLE_FIELD

HILIGHT_FIELD

public static int HILIGHT_FIELD

LOLIGHT_FIELD

public static int LOLIGHT_FIELD

MODIFIED_FIELD

public static int MODIFIED_FIELD

NON_DISPLAYABLE_FIELD

public static int NON_DISPLAYABLE_FIELD

NON_PENDETECTABLE_FIELD

public static int NON_PENDETECTABLE_FIELD

NUMERIC_FIELD

public static int NUMERIC_FIELD

PENDETECTABLE_FIELD

public static int PENDETECTABLE_FIELD

PROTECTED_FIELD

public static int PROTECTED_FIELD

UNMODIFIED_FIELD

public static int UNMODIFIED_FIELD

UNPROTECTED_FIELD

public static int UNPROTECTED_FIELD
Constructor Detail

HostScreenFieldList

public HostScreenFieldList(HostScreen screen)
Method Detail

findField

public HsrScreenField findField(int pos)
Description copied from class: IScreenFieldList
Finds the field which contains the specified linear position.

Specified by:
findField in class IScreenFieldList
Parameters:
pos - - Linear position.
Returns:
The field which contains the specified position.

findField

public HsrScreenField findField(int row,
                                int col)
Description copied from class: IScreenFieldList
Finds the field which contains the specified row and column coordinate.

Specified by:
findField in class IScreenFieldList
Parameters:
row - - Row of the field to find.
col - - Column of the field to find.
Returns:
The field which contains the specified coordinate.

findField

public HostScreenField findField(String text,
                                 int direction)

findField

public HostScreenField findField(String text,
                                 int pos,
                                 int direction)

findField

public HostScreenField findField(String text,
                                 int row,
                                 int col,
                                 int direction)

FindField

public HostScreenField FindField(int pos)

FindField

public HostScreenField FindField(int row,
                                 int col)

FindField

public HostScreenField FindField(String text,
                                 int direction)

FindField

public HostScreenField FindField(String text,
                                 int pos,
                                 int direction)

FindField

public HostScreenField FindField(String text,
                                 int row,
                                 int col,
                                 int direction)

getField

public HsrScreenField getField(int number)
Description copied from class: IScreenFieldList
Returns the HsrScreenField at the specified (zero-based) index.

Specified by:
getField in class IScreenFieldList
Parameters:
number - 0-based index of the field to get
Returns:
a HsrScreenField object or null if the index did not exist in the field list

getFieldCount

public int getFieldCount()
Description copied from class: IScreenFieldList
Get the number of fields in the screen.

Specified by:
getFieldCount in class IScreenFieldList
Returns:
The number of fields.

GetFieldCount

public int GetFieldCount()
Overrides:
GetFieldCount in class IScreenFieldList

getFirstField

public HsrScreenField getFirstField()
Description copied from class: IScreenFieldList
Get the first field in the field list.

Specified by:
getFirstField in class IScreenFieldList
Returns:
HsrScreenField

getFirstField

public HostScreenField getFirstField(int attr)

GetFirstField

public HostScreenField GetFirstField()

GetFirstField

public HostScreenField GetFirstField(int attr)

getIndex

public int getIndex(HsrScreenField hsrField)
Description copied from class: IScreenFieldList
Returns the zero-based index of the given HsrScreenField in the field list.

Specified by:
getIndex in class IScreenFieldList
Parameters:
hsrField - the HsrScreenField to be searched for
Returns:
the index of the given HsrScreenField in field list.

getNextField

public HsrScreenField getNextField(HsrScreenField afterThis)
Description copied from class: IScreenFieldList
Returns the next field in the field list after the given field. If the HsrScreenField parameter is null, the first field in the field list is to be returned.

Specified by:
getNextField in class IScreenFieldList
Parameters:
afterThis - - The field after which the search will return
Returns:
HsrScreenField

getNextField

public HostScreenField getNextField(HostScreenField afterThis)

getNextField

public HostScreenField getNextField(HsrScreenField afterThis,
                                    int attr)

GetNextField

public HostScreenField GetNextField(HsrScreenField afterThis)

GetNextField

public HostScreenField GetNextField(HsrScreenField afterThis,
                                    int attr)

getPreviousField

public HsrScreenField getPreviousField(HsrScreenField afterThis)
Description copied from class: IScreenFieldList
Returns the previous field in the field list before the given field. If the HsrScreenField parameter is null, the first field in the field list is to be returned.

Specified by:
getPreviousField in class IScreenFieldList
Returns:
HsrScreenField

getPreviousField

public HostScreenField getPreviousField(HostScreenField afterThis)

getPreviousField

public HostScreenField getPreviousField(HsrScreenField beforeThis,
                                        int attr)

Refresh

public void Refresh()

Refresh

public void Refresh(int planes)

HATS 7.5.1 (201005110649)