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.hsr.screen
Class IScreenFieldList

java.lang.Object
  extended by com.ibm.hsr.screen.IScreenFieldList
Direct Known Subclasses:
HostScreenFieldList

public abstract class IScreenFieldList
extends Object


Constructor Summary
IScreenFieldList()
           
 
Method Summary
abstract  HsrScreenField findField(int pos)
          Finds the field which contains the specified linear position.
abstract  HsrScreenField findField(int row, int col)
          Finds the field which contains the specified row and column coordinate.
abstract  HsrScreenField getField(int index)
          Returns the HsrScreenField at the specified (zero-based) index.
abstract  int getFieldCount()
          Get the number of fields in the screen.
 int GetFieldCount()
          Deprecated. - Use getFieldCount() instead.
abstract  HsrScreenField getFirstField()
          Get the first field in the field list.
abstract  int getIndex(HsrScreenField hsrField)
          Returns the zero-based index of the given HsrScreenField in the field list.
abstract  HsrScreenField getNextField(HsrScreenField afterThis)
          Returns the next field in the field list after the given field.
abstract  HsrScreenField getPreviousField(HsrScreenField beforeThis)
          Returns the previous field in the field list before the given field.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IScreenFieldList

public IScreenFieldList()
Method Detail

findField

public abstract HsrScreenField findField(int pos)
Finds the field which contains the specified linear position.

Parameters:
pos - - Linear position.
Returns:
The field which contains the specified position.

findField

public abstract HsrScreenField findField(int row,
                                         int col)
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.

getField

public abstract HsrScreenField getField(int index)
Returns the HsrScreenField at the specified (zero-based) index.

Parameters:
index - 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()
Deprecated. - Use getFieldCount() instead.


getFieldCount

public abstract int getFieldCount()
Get the number of fields in the screen.

Returns:
The number of fields.

getFirstField

public abstract HsrScreenField getFirstField()
Get the first field in the field list.

Returns:
HsrScreenField

getIndex

public abstract int getIndex(HsrScreenField hsrField)
Returns the zero-based index of the given HsrScreenField in the field list.

Parameters:
hsrField - the HsrScreenField to be searched for
Returns:
the index of the given HsrScreenField in field list.

getNextField

public abstract HsrScreenField getNextField(HsrScreenField afterThis)
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.

Parameters:
afterThis - - The field after which the search will return
Returns:
HsrScreenField

getPreviousField

public abstract HsrScreenField getPreviousField(HsrScreenField beforeThis)
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.

Parameters:
beforeThis -
Returns:
HsrScreenField

HATS 7.5.1 (201005110649)