| Package | mx.core |
| Interface | public interface IRepeater |
| Implementors | Repeater |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
| Property | Defined By | ||
|---|---|---|---|
| container : IContainer [read-only]
The container that contains this Repeater,
and in which it will create its children. | IRepeater | ||
| count : int
The number of times this Repeater should execute. | IRepeater | ||
| currentIndex : int [read-only]
The index of the item in the dataProvider currently
being processed while this Repeater is executing. | IRepeater | ||
| currentItem : Object [read-only]
The item in the dataProvider currently being processed
while this Repeater is executing. | IRepeater | ||
| dataProvider : Object
The data provider used by this Repeater to create repeated instances
of its children. | IRepeater | ||
| recycleChildren : Boolean
A Boolean flag indicating whether this Repeater should re-use
previously created children, or create new ones. | IRepeater | ||
| startingIndex : int
The index into the dataProvider at which this Repeater
starts creating children. | IRepeater | ||
| Method | Defined By | ||
|---|---|---|---|
Executes the bindings into all the UIComponents created
by this Repeater. | IRepeater | ||
Initializes a new Repeater object. | IRepeater | ||
container | property |
container:IContainer [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The container that contains this Repeater, and in which it will create its children.
Implementation
public function get container():IContainercount | property |
count:int| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The number of times this Repeater should execute.
If the Repeater reaches the end of the data provider while executing, the number of times it actually executes will be less that the requested count.
Implementation
public function get count():int public function set count(value:int):voidcurrentIndex | property |
currentIndex:int [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The index of the item in the dataProvider currently
being processed while this Repeater is executing.
After the Repeater has finished executing,
this property is -1.
However, the repeaterIndex property of a repeated
component instance remembers the index of the
dataProvider item from which it was created.
In the case of nested Repeaters, you can use the
repeaterIndices array.
Implementation
public function get currentIndex():intRelated API Elements
currentItem | property |
currentItem:Object [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The item in the dataProvider currently being processed
while this Repeater is executing.
After the Repeater has finished executing,
this property is null.
However, in this case you can call the getRepeaterItem()
method of the repeated component instance to get the
dataProvider item from which it was created.
Implementation
public function get currentItem():ObjectRelated API Elements
dataProvider | property |
dataProvider:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The data provider used by this Repeater to create repeated instances of its children.
If you read the dataProvider property, you always get
an ICollectionView object or null.
If you set the dataProvider property to anything other than
null, it is converted into an ICollectionView object,
according the following rules:
- If you set it to an Array, it is converted into an ArrayCollection.
- If you set it to an ICollectionView, no conversion is performed.
- If you set it to an IList, it is converted into a ListCollectionView.
- If you set it to an XML or XMLList, it is converted into an XMLListCollection.
- Otherwise, it is converted to a single-element ArrayCollection.
You must specify a value for the dataProvider property
or the Repeater component will not execute.
Implementation
public function get dataProvider():Object public function set dataProvider(value:Object):voidrecycleChildren | property |
recycleChildren:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A Boolean flag indicating whether this Repeater should re-use previously created children, or create new ones.
If true, when this Repeater's
dataProvider, startingIndex,
or count changes, it will recycle the existing
children by binding the new data into them.
If more children are required, they are created and added.
If fewer children are required, the extra ones are removed
and garbage collected.
If false, when this Repeater's
dataProvider, startingIndex,
or count changes, it will remove any previous
children that it created and then create and
add new children from the new data items.
This property is false by default.
Setting it to true can increase performance,
but is not appropriate in all situations.
For example, if the previously created children have state
information such as text typed in by a user, then this
state will not get reset when the children are recycled.
Implementation
public function get recycleChildren():Boolean public function set recycleChildren(value:Boolean):voidstartingIndex | property |
startingIndex:int| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The index into the dataProvider at which this Repeater
starts creating children.
Implementation
public function get startingIndex():int public function set startingIndex(value:int):voidexecuteChildBindings | () | method |
public function executeChildBindings():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Executes the bindings into all the UIComponents created by this Repeater.
This method is called by the Flex framework. Developers should not need to call it.
initializeRepeater | () | method |
public function initializeRepeater(container:IContainer, recurse:Boolean):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Initializes a new Repeater object.
This method is called by the Flex framework. Developers should not need to call it.
Parameters
container:IContainer — The Container that contains this Repeater,
and in which this Repeater will create its children.
| |
recurse:Boolean — A Boolean flag indicating whether this Repeater
should create all descendants of its children.
|
Mon Nov 28 2011, 06:48 AM -08:00