Methods
getPresentationSpace() → {PresentationSpace}
Obtains the presentation space which created this field list.
Returns:
the parent of this field list instance.
- Type
- PresentationSpace
findField(start, textopt, directionopt) → {Field}
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:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
start |
Position | the starting position from which to search. |
||
text |
String |
<optional> |
null
|
the text to search for. If not provided, returns the next field to the right of, or below the specified position. |
direction |
Number |
<optional> |
SearchDirection.FORWARD
|
the direction of the search, as defined in
|
Throws:
-
if the position is out of range.
- Type
- RangeError
Returns:
- the field containing the string, or null if a field meeting the given criteria is not found.
- Type
- Field
get(index) → {Field}
Obtains the field at the given index.
Parameters:
| Name | Type | Description |
|---|---|---|
index |
Number | the index into the field list. |
Throws:
-
if the index is out of range.
- Type
- RangeError
Returns:
- the field located at the specified index.
- Type
- Field
isEmpty() → {Boolean}
Determines if the field list is empty.
Returns:
- true if the list is empty.
- Type
- Boolean
size() → {Number}
Indicates the number of fields in the list.
Returns:
- the field count.
- Type
- Number
toString() → {String}
Creates a user-friendly description of the field list.
Returns:
- a human-readable rendition of the field list.
- Type
- String