com.sabratec.applinx.baseobject

Interface GXIFieldCollection

All Known Implementing Classes:

GXFieldCollection

public interface GXIFieldCollection

This class represents a collection of fields as they were gathered from a screen or many screens. It should be used to perform queries on the fields.

Method Summary

Modifier and Type	Method and Description
GXIFieldCollection	getAppFields()
GXIField	getFieldAt(int index)
GXIField	getFieldByPosition(GXPosition position)
int	getFieldCount()
GXIField	getFieldInstance(String name, int fieldIndex)
GXIField[]	getFields()
GXIFieldCollection	getFields(String name)
GXIField	getFirstFieldInstance(String name)
GXIField	getLastFieldInstance(String name)

Method Detail

getFieldCount

int getFieldCount()

Returns:

the number of fields in the collection.

getFieldAt

GXIField getFieldAt(int index)

Parameters:

index - the index of the field in the collection.

Returns:

the field at the given index from the collection.

getFields

GXIField[] getFields()

Returns:

the field array on which the collection was constructed.

getAppFields

GXIFieldCollection getAppFields()

Returns:

all the application fields in the current collection.

getFieldByPosition

GXIField getFieldByPosition(GXPosition position)

Parameters:

position - the position of the first character of the field.

Returns:

the field that starts at the given position. This method should be used when the field collection is from one screen. If the collection collects more than one screen, the positions may collide.

getFieldInstance

GXIField getFieldInstance(String name,
                          int fieldIndex)

Parameters:

name - multiple application field name

fieldIndex - index within the multiple application field.

Returns:

the instance of the field at the given index.

getFirstFieldInstance

GXIField getFirstFieldInstance(String name)

Parameters:

name - the name of an application field in the collection

Returns:

the first instance of this application field that was added to the collection.

getLastFieldInstance

GXIField getLastFieldInstance(String name)

Parameters:

name - application field name

Returns:

the last instance (currently available in the collection) of the given application field.

getFields

GXIFieldCollection getFields(String name)

Parameters:

name - name of an application field

Returns:

a collection holding all the instances of the application field.