Adobe® Flex® 4 Language Reference
Show Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
mx.core 
IRepeaterClient 
Packagemx.core
Interfacepublic interface IRepeaterClient
Implementors UIComponent

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The IRepeaterClient interface defines the APIs for components that can have multiple instances created by a Repeater. The IRepeaterClient interface is implemented by the UIComponent class and so is inherited by all Flex framework controls and containers.



Public Properties
 PropertyDefined By
  instanceIndices : Array
An Array that contains the indices required to reference the repeated component instance from its document.
IRepeaterClient
  isDocument : Boolean
[read-only] Contains true if this UIComponent instance is a document object.
IRepeaterClient
  repeaterIndices : Array
An Array that contains the indices of the items in the data providers of the Repeaters that produced the component.
IRepeaterClient
  repeaters : Array
An Array that contains any enclosing Repeaters of the component.
IRepeaterClient
Public Methods
 MethodDefined By
  
Initializes the instanceIndices, repeaterIndices, and repeaters properties.
IRepeaterClient
Property Detail

instanceIndices

property
instanceIndices:Array

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

An Array that contains the indices required to reference the repeated component instance from its document. This Array is empty unless the component is within one or more Repeaters. The first element corresponds to the outermost Repeater. For example, if the id is "b" and instanceIndices is [ 2, 4 ], you would reference it on the document as b[2][4].



Implementation
    public function get instanceIndices():Array
    public function set instanceIndices(value:Array):void

isDocument

property 
isDocument:Boolean  [read-only]

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Contains true if this UIComponent instance is a document object. That means it is at the top of the hierarchy of a Flex application, MXML component, or ActionScript component.



Implementation
    public function get isDocument():Boolean

repeaterIndices

property 
repeaterIndices:Array

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

An Array that contains the indices of the items in the data providers of the Repeaters that produced the component. The Array is empty unless the component is within one or more Repeaters. The first element corresponds to the outermost Repeater component. For example, if repeaterIndices is [ 2, 4 ], the outer Repeater component used its dataProvider[2] data item and the inner Repeater component used its dataProvider[4] data item.

This property differs from instanceIndices if the startingIndex of any of the Repeater components is non-zero. For example, even if a Repeater component starts at dataProvider item 4, the document reference of the first repeated component is b[0], not b[4].



Implementation
    public function get repeaterIndices():Array
    public function set repeaterIndices(value:Array):void

repeaters

property 
repeaters:Array

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

An Array that contains any enclosing Repeaters of the component. The Array is empty unless the component is within one or more Repeaters. The first element corresponds to the outermost Repeater.



Implementation
    public function get repeaters():Array
    public function set repeaters(value:Array):void
Method Detail

initializeRepeaterArrays

()method
public function initializeRepeaterArrays(parent:IRepeaterClient):void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Initializes the instanceIndices, repeaterIndices, and repeaters properties.

This method is called by the Flex framework. Developers should not need to call it.

Parameters

parent:IRepeaterClient — The parent Repeater that created this component.