Package com.microfocus.zfe.haapi.ps

Interface FieldList

All Superinterfaces:

Collection<Field>, Iterable<Field>, List<Field>

public interface FieldList
extends List<Field>

A FieldList contains a list of all the fields in the host presentation space. If fields are not supported by the host, then the field list will be empty. Important: FieldList is a static view of the fields in the host presentation space when the field list is initially requested; it is not updated to reflect changes that may occur in the presentation space.

Method Summary

Modifier and Type	Method	Description
Field	findField(Position pos)	Returns the field containing the specified position.
Field	findField(String text, Position pos, PresentationSpace.SearchDirection direction)	Returns the field containing the specified text.
PresentationSpace	getPresentationSpace()	Returns the PresentationSpace instance which created this field list

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray

Method Detail

getPresentationSpace

PresentationSpace getPresentationSpace()

Returns the PresentationSpace instance which created this field list

Returns:

the PresentationSpace instance which created this field list

findField

Field findField(Position pos)
         throws InvalidPositionException

Returns the field containing the specified position.

Parameters:

pos - the position of the field of interest. The position can be anywhere within the field. For 3270 and 5250 hosts the position can also be the space that contains the field delimiter.

Returns:

the field containing the position or null if the list is empty or the position is on a 0 length field

Throws:

InvalidPositionException - if the position is out of range.

findField

Field findField(String text,
                Position pos,
                PresentationSpace.SearchDirection direction)
         throws InvalidPositionException

Returns the field containing the specified text. The search starts from the specified position, and proceeds either forward or backward. If the string spans multiple fields, the field containing the starting position is returned. When searching forward the search will not wrap to the top of the screen. When searching backwards the search will not wrap to the bottom of the screen.

Parameters:

text - the text string to search for.

pos - the position at which to start the search.

direction - the direction of the search.

Returns:

the field containing the string, or null if the string is not found.

Throws:

InvalidPositionException - if the position is out of range.