ASDoc

mx.core
Repeater クラス

Repeater クラス

Repeater クラスは <mx:Repeater> タグに対応するランタイムオブジェクトです。このクラスは、その dataProvider に基づいて、自分の子の複数のインスタンスを作成します。標準またはカスタムの任意のコントロールまたはコンテナを、コンポーネントとして繰り返し使用できます。

コントロールタグ、またはコンテナタグ (<mx:Application> コンテナタグを除く) を使用できる位置であれば、<mx:Repeater> タグを使用できます。ユーザーインターフェイスコンポーネントを繰り返し使用するには、タグを <mx:Repeater> タグの中に置きます。また、MXML ドキュメントでは、複数の <mx:Repeater> タグを使用できます。<mx:Repeater> タグをネストすることも可能です。

UIObject クラスを拡張しないオブジェクトに <mx:Repeater> タグを使用することはできません。

MXML シンタックス

<Repeater> クラスには次のプロパティがあります。

 <mx:Repeater
   count="No default."
   dataProvider="No default."
   recycleChildren="false|true"
   startingIndex="No default."
 >
   ...
     子タグ
   ...
 </mx:Repeater>

例を参照するにはここをクリックしてください

関連項目
    mx.containers.Container
    UIObject
    UIObjectDescriptor
    View
    mx.events.EventDispatcher

コンストラクタ
`Repeater (parentDocument, container, descriptor)`コンストラクタです。

メソッド
	`executeBindings( ) : Void`この Repeater へのバインディングを実行します。
	`executeChildBindings( ) : Void`この Repeater のコンテナ内にある、この Repeater (またはこの Repeater にネストされた Repeater) によって作成された、すべての UIObject へのバインディングを実行します。
	`getRepeaterAt( repeaterIndex:Number) : mx.core.Repeater`指定されたインデックスを持つ Repeater を返します。
	`getRepeaterItem( whichRepeater:Number) : Object`指定された Repeater がこの Repeater を生成するために使用した、`dataProvider` 内のアイテムを返します。この Repeater が繰り返されていない場合は、undefined を返します。
	`hasRepeaterMatchingDescriptor( descriptorOrIndex:Object) : Object`指定された記述子を持つ Repeater の配列を返します。

プロパティ
	`childDescriptors:Array`この Repeater の子に対する記述子の配列への参照です。
	`container:mx.containers.Container [読み取り専用]`この Repeater を含むコンテナへの参照です。
	`count:Number`子の作成時にこの Repeater によって処理される `dataProvider` 内のアイテムの数を表します。
	`currentIndex:Number [読み取り専用]`この Repeater の実行中に処理される `dataProvider` 内にあるアイテムの、ゼロベースのインデックスです。
	`currentItem:Object [読み取り専用]`この Repeater の実行中に処理される `dataProvider` 内のアイテムを表します。
	`dataProvider:Object`この Repeater が、子の繰り返しインスタンスを作成するために使用するデータの配列です。
	`descriptor:mx.core.UIObjectDescriptor [読み取り専用]`この Repeater を作成した記述子 (存在する場合) への参照です。
	`id:String [読み取り専用]`この Repeater の MXML ID を表します。
	`instanceIndices:Array [読み取り専用]`この Repeater を親ドキュメントから参照するために必要なインデックスを含む配列です。
	`parentDocument:Object [読み取り専用]`この Repeater を含む親ドキュメントオブジェクトへの参照です。
	`recycleChildren:Booleantrue` の場合、Repeater の `dataProvider`、`startingIndex`、または `count` が変更されると、Repeater は新規データをこれらにバインドすることにより、既存の子を再利用します。
	`repeaterIndices:Array [読み取り専用]`この Repeater を生成した親ドキュメント内にある、Repeater の `dataProviders` に含まれるアイテムのインデックスを含む配列です。
	`repeaters:Array [読み取り専用]`この Repeater を生成した親ドキュメント内にある、Repeater への参照を含む配列です。
	`startingIndex:Number`この Repeater が子の作成を開始する `dataProvider` へのインデックスです。

イベント
`repeat`	アイテムが処理され、`currentIndex` および `currentItem` が更新されるたびにブロードキャストします。イベントオブジェクトの target プロパティには、このイベントをトリガしたコンポーネントへの参照が設定されます。イベントオブジェクトの type プロパティには、イベント名 `repeat` が設定されます。
`repeatEnd`	すべての子が作成された後にブロードキャストします。
`repeatStart`	子を作成するための `dataProvider` の処理が開始されたときにブロードキャストします。

コンストラクタの詳細

Repeater

Repeater (parentDocument, container, descriptor)

コンストラクタです。

パラメータ
    parentDocument:Object - この Repeater を含む親ドキュメントオブジェクトです。
    container:mx.containers.Container - この Repeater を含むコンテナです。
    descriptor:mx.core.UIObjectDescriptor - この Repeater を作成した記述子 (存在する場合) です。

メソッドの詳細

executeBindings

executeBindings( )
										
													 :  Void

この Repeater へのバインディングを実行します。

executeChildBindings

executeChildBindings( )
										
													 :  Void

この Repeater のコンテナ内にある、この Repeater (またはこの Repeater にネストされた Repeater) によって作成された、すべての UIObject へのバインディングを実行します。

getRepeaterAt

getRepeaterAt( repeaterIndex:Number)
										
													 :  mx.core.Repeater

指定されたインデックスを持つ Repeater を返します。

パラメータ
repeaterIndex:Number - Repeater のインデックスです。
メモ : "this" はコンテナです。

getRepeaterItem

getRepeaterItem( whichRepeater:Number)
										
													 :  Object

指定された Repeater がこの Repeater を生成するために使用した dataProvider 内のアイテムを返します。この Repeater が繰り返されていない場合は、undefined を返します。引数 whichRepeater は、最も外側の Repeater が 0、次に内側の Repeater が 1 になり、以降も同様に続きます。whichRepeater が指定されていない場合は、最も内側の Repeater が使用されます。

パラメータ
whichRepeater:Number - Repeater の番号を表します。一番外側から数え、0 から始まります。

hasRepeaterMatchingDescriptor

hasRepeaterMatchingDescriptor( descriptorOrIndex:Object)
										
													 :  Object

指定された記述子を持つ Repeater の配列を返します。

パラメータ
descriptorOrIndex:Object - 照合する記述子またはインデックスです。

プロパティの詳細

childDescriptors

childDescriptors:Array

この Repeater の子に対する記述子の配列への参照です。

container

container:mx.containers.Container [読み取り専用]

この Repeater を含むコンテナへの参照です。

count

count:Number

子の作成時にこの Repeater によって処理される dataProvider 内のアイテムの数を表します。

currentIndex

currentIndex:Number [読み取り専用]

この Repeater の実行中に処理される dataProvider 内にあるアイテムの、ゼロベースのインデックスです。Repeater が実行されていないとき、このプロパティの値は undefined になります。

currentItem

currentItem:Object [読み取り専用]

この Repeater の実行中に処理される dataProvider 内のアイテムを表します。Repeater が実行されていないとき、このプロパティの値は undefined になります。

dataProvider

dataProvider:Object

この Repeater が、子の繰り返しインスタンスを作成するために使用するデータの配列です。

descriptor

descriptor:mx.core.UIObjectDescriptor [読み取り専用]

この Repeater を作成した記述子 (存在する場合) への参照です。

id

id:String [読み取り専用]

この Repeater の MXML ID を表します。

instanceIndices

instanceIndices:Array [読み取り専用]

この Repeater を親ドキュメントから参照するために必要なインデックスを含む配列です。この Repeater が他の Repeater に含まれていない限り、この配列は空です。最初のエレメントが最も外側の Repeater を表します。たとえば、ID が "r" で instanceIndices が [2,4] の場合、ドキュメント上で r[2][4] として参照します。

parentDocument

parentDocument:Object [読み取り専用]

この Repeater を含む親ドキュメントオブジェクトへの参照です。

recycleChildren

recycleChildren:Boolean

true の場合、Repeater の dataProvider、startingIndex、または count が変更されると、Repeater は新規データをこれらにバインドすることにより、既存の子を再利用します。追加の子が必要な場合は、作成されます。子が多すぎる場合には、余分な子が破棄されます。false の場合は、Repeater の dataProvider、startingIndex、または count が変更されると、Repeater は前に作成した子を破棄し、新規データアイテムから新しい子を作成します。デフォルト値は false です。

repeaterIndices

repeaterIndices:Array [読み取り専用]

この Repeater を生成した親ドキュメント内にある、Repeater の dataProviders に含まれるアイテムのインデックスを含む配列です。この Repeater が他の Repeater に含まれていない限り、この配列は空です。最初のエレメントが最も外側の Repeater を表します。たとえば、repeaterIndices が [2,4] の場合は、外部リピーターがアイテム dataProvider[2] を使用し、内部リピーターがアイテム dataProvider[4] を使用したことを意味します。いずれかの Repeater の startingIndex が 0 以外の場合、このプロパティは instanceIndices と異なります。たとえば、Repeater が dataProvider アイテム 4 から開始する場合も、最初に繰り返されるオブジェクトのドキュメント参照は b[4] ではなく b[0] です。

repeaters

repeaters:Array [読み取り専用]

この Repeater を生成した親ドキュメント内にある、Repeater への参照を含む配列です。この Repeater が他の Repeater に含まれていない限り、この配列は空です。最初のエレメントが最も外側の Repeater を表します。

startingIndex

startingIndex:Number

この Repeater が子の作成を開始する dataProvider へのインデックスです。

例

RepeaterExample.mxml

<?xml version="1.0"?>
<!-- Repeater の使用方法を示す簡単な例 -->
<mx:Application xmlns:mx="http://www.macromedia.com/2003/mxml" backgroundColor="#FFFFFF">

	<mx:Script>
		<![CDATA[
  
			var dp:Array = [1, 2, 3, 4, 5, 6, 7, 8, 9];    
			
		]]>
	</mx:Script>

<mx:Panel title="Repeater Panel">
  
<mx:Tile marginBottom="10" borderStyle="inset" verticalGap="15" id="myFlow"
marginLeft="10" backgroundColor="#FFFFCC" marginTop="10" marginRight="10"
horizontalGap="10" direction="horizontal" autoLayout="false" clipContent="false" >
        
		<mx:Repeater  id="rp" dataProvider="{dp}">
			<mx:Button height="49" width="50" label="{rp.currentItem}" click="alert(event.target.getRepeaterItem() + ' pressed')"/>
		</mx:Repeater>
    
	</mx:Tile>
  
</mx:Panel>
  
</mx:Application>

mx.core Repeater クラス