Use the FieldList object, along with Field object, to obtain field list information.
Table 5-21 FieldList
|
Method |
|
|---|---|
|
getPresentationSpace() |
Obtains the PresentationSpace which created this field list. Returns {PresentationSpace}Parent of this field list instance. |
|
findField(position, text, direction) |
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 backward the search will not wrap to the bottom of the screen. Parameters {Position} Position from which to start the search. See Position object. {String} The text to search for (optional). If not provided, returns the next field to the right of or below the specified position. {Number} direction of the search (optional). Use PresentationSpace. SearchDirection constants for this parameter. For example, PresentationSpace.SearchDirection.FORWARD or PresentationSpace.SearchDirection.BACKWARD. If not provided, searches forward. Returns {Field} containing the string or null if a field meeting the given criteria is not found. Throws {RangeError} If the position is out of range. |
|
get(index) |
Obtains the field at the given index. Parameters {Number}index into the field list. Returns {Field} located at the specified index. Throws {RangeError} If the index is out of range. |
|
isEmpty() |
Determines if the field list is empty. Returns {Boolean} True if the list is empty. |
|
size() |
Indicates the number of fields in the list. Returns {Number} The field count |
|
toString() |
Creates a user-friendly description of the field list. Returns {String} User readable rendition of the field list. |