WidgetCollection
A WidgetCollection is an array-like object representing a set of widgets, as returned by the widget methods children and find.
Includes Events API, Properties API
A WidgetCollection is an array-like object that represents any number of widgets - it can also be empty.
It combines a subset of the JavaScript Array API with a subset of the Tabris.js Widget API. Like an array, the widgets within the collection may be accessed directly using the [index] syntax. The number of widgets is stored in the length field. Instances of WidgetCollection are immutable.
Example:
var children = page.children();
for(var i = 0; i < children.length; i++) {
console.log(children[i].get("id"));
}
Calls to set or animate change the given properties for all widgets in the collection. Similarly, the on, off and once methods will add/remove the given listener to/from all widgets. When get is used, the value of the first widget in the collection is returned.
Methods
animate(properties, options)
Parameters:
- properties: Object, the properties and target values to animate.
- options: Object, configures the animation itself.
Animates all widgets in this collection.
appendTo(parent)
Parameters:
- parent: Composite
Returns: WidgetCollection
Append all widgets in this collection to the given widget.
children()
Parameters:
Returns: WidgetCollection
Returns a collection containing all children of all widgets in this collection.
children(selector)
Parameters:
- selector: Selector
Returns: WidgetCollection
Same as collection.children().filter(selector).
dispose()
Parameters:
Disposes all widgets in this collection.
filter(selector)
Parameters:
- selector: Selector
Returns: WidgetCollection
Returns a new WidgetCollection containing all widgets in this collection that match the given selector.
find()
Parameters:
Returns: WidgetCollection
Returns a collection containing all descendants of all widgets in this collection.
find(selector)
Parameters:
- selector: Selector
Returns: WidgetCollection
Returns a collection containing all descendants of all widgets in this collection that match the given selector.
first()
Parameters:
Returns: Widget
Returns the first widget in the collection. Same as collection[0].
forEach(callback)
Parameters:
- callback: Function, the function to call. The arguments are: widget, index, WidgetCollection
Calls the given callback for each widget in the collection.
indexOf(widget)
Parameters:
- widget: Widget
Returns: number
Returns the index of the given widget within the collection. If there is no match, the return value is -1.
last()
Parameters:
Returns: Widget
Returns the last widget in the collection. Same as collection[collection.length - 1].
parent()
Parameters:
Returns: WidgetCollection
Returns a collection containing all direct parents of all widgets in this collection.
toArray()
Parameters:
Returns: Widget[]
Return an Array containing all widgets in the collection.
Fields
length
Type: number
A read-only field containing the number of widgets in the collection.
