ListCollectionView

パッケージ	mx.collections
クラス	public class ListCollectionView
継承	ListCollectionView Proxy
実装	ICollectionView, IList, IMXMLObject
サブクラス	ArrayCollection, XMLListCollection

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

ListCollectionView クラスでは、ICollectionView インターフェイスのプロパティとメソッドが IList インターフェイスに適合するオブジェクトに追加されます。したがって、IList または ICollectionView を必要とするものに、このクラスのオブジェクトを渡すことができます。

また、このクラスによって、[] 配列表記を使用して getItemAt() メソッドおよび setItemAt() メソッドにアクセスすることもできます。 myListCollectionView[index] のようなコードを使用すると、myListCollectionView オブジェクトの getItemAt() メソッドまたは setItemAt() メソッドが呼び出されます。

MXML シンタックス expanded

MXML シンタックスを隠す

The <mx:ListCollectionView> has the following attributes, which all of its subclasses inherit:

  <mx:ListCollectionView
  Properties
  filterFunction="null"
  list="null"
  sort="null"
  Events
  collectionChange="No default"
  />

パブリックプロパティ

	プロパティ		定義元
		filterFunction : Function 関数の条件に一致しないアイテムを削除するためにビューが使用する関数です。	ListCollectionView
		length : int [読み取り専用] このビュー内のアイテムの数です。	ListCollectionView
		list : IList このコレクションビューがラップする IList です。	ListCollectionView
		sort : ISort ICollectionView に適用される ISort です。	ListCollectionView

プロテクトプロパティ

	プロパティ		定義元
		localIndex : Array ビューにソートまたはフィルターを適用すると、ソートによりアイテムの順序が変更されたか、またはフィルターによりアイテム数が減ったビューに含まれるアイテムの配列が localIndex プロパティにソート順に入れられます。	ListCollectionView

パブリックメソッド

	メソッド		定義元
		ListCollectionView(list:IList = null) ListCollectionView コンストラクターです。	ListCollectionView
		addAll(addList:IList):void アイテムのリストを現在のリストに追加し、渡される順序でリストの末尾に配置します。	ListCollectionView
		addAllAt(addList:IList, index:int):void アイテムのリストを現在のリストに追加し、関数に渡されるインデックス位置に配置します。	ListCollectionView
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。	ListCollectionView
		addItem(item:Object):void 指定されたアイテムをリストの末尾に追加します。	ListCollectionView
		addItemAt(item:Object, index:int):void 指定されたインデックス位置にアイテムを追加します。	ListCollectionView
		contains(item:Object):Boolean 指定されたオブジェクトをビューに含めるかどうかを返します。	ListCollectionView
		createCursor():IViewCursor このビューに対して使用する新しい IViewCursor を作成します。	ListCollectionView
		disableAutoUpdate():void コレクション自体およびコレクション内のアイテムの変更がビューから送出されないようにします。	ListCollectionView
		dispatchEvent(event:Event):Boolean イベントをイベントフローに送出します。	ListCollectionView
		enableAutoUpdate():void 自動更新を有効にします。	ListCollectionView
		getItemAt(index:int, prefetch:int = 0):Object 指定されたインデックス位置にあるアイテムを取得します。	ListCollectionView
		getItemIndex(item:Object):int リスト内の、getItemAt(index) == アイテムとなるアイテムのインデックスを返します。	ListCollectionView
		hasEventListener(type:String):Boolean EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。	ListCollectionView
		initialized(document:Object, id:String):void MXML タグを使用して ListCollectionView を作成したときに、MXML コンパイラーによって自動的に呼び出されます。	ListCollectionView
		itemUpdated(item:Object, property:Object = null, oldValue:Object = null, newValue:Object = null):void アイテムが更新されたビューを通知します。	ListCollectionView
		refresh():Boolean ビューにソートとフィルターを適用します。	ListCollectionView
		removeAll():void リストからすべてのアイテムを削除します。	ListCollectionView
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void EventDispatcher オブジェクトからリスナーを削除します。	ListCollectionView
		removeItemAt(index:int):Object 指定されたインデックス位置にあるアイテムを削除し、返します。	ListCollectionView
		setItemAt(item:Object, index:int):Object 指定されたインデックス位置にアイテムを配置します。	ListCollectionView
		toArray():Array IList 実装と同じ順序で指定された配列を返します。	ListCollectionView
		toString():String このビューのコンテンツをストリングにプリントし、返します。	ListCollectionView
		willTrigger(type:String):Boolean 指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。	ListCollectionView

イベント

イベントの詳細についてはここをクリックしてください

	イベント		概要	定義元
		collectionChange	ICollectionView が何らかの方法で更新されると送出されます。	ListCollectionView

プロパティの詳細

filterFunction

プロパティ

filterFunction:Function

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

関数の条件に一致しないアイテムを削除するためにビューが使用する関数です。 filterFunction のシグネチャは次のとおりになると予想されます。

f(item:Object):Boolean

指定されたアイテムがビューに残っている場合、戻り値は true です。

フィルターがサポートされない場合、このプロパティにアクセスするとエラーがスローされます。 refresh() を呼び出す前に、更新するビューについて filterFunction プロパティを設定する必要があります。

メモ：ICollectionView の実装では、フィルター関数を実行する前にリモートからすべてのアイテムを取得します。ページングを使用している場合は、データを取得する前にリモートコレクションにフィルターを適用します。

このプロパティはデータバインディングのソースとして使用できます。このプロパティを変更すると、 filterFunctionChanged イベントが送出されます。

実装
public function get filterFunction():Function
public function set filterFunction(value:Function):void

関連する API エレメント

refresh()

length

プロパティ

length:int [読み取り専用]

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

このビュー内のアイテムの数です。 0 はアイテムがないことを意味し、-1 は長さが不明であることを意味します。

このプロパティはデータバインディングのソースとして使用できます。このプロパティを変更すると、 collectionChange イベントが送出されます。

実装
public function get length():int

list

プロパティ

list:IList

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

このコレクションビューがラップする IList です。

このプロパティはデータバインディングのソースとして使用できます。このプロパティを変更すると、 listChanged イベントが送出されます。

実装
public function get list():IList
public function set list(value:IList):void

localIndex

プロパティ

protected var localIndex:Array

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

ビューにソートまたはフィルターを適用すると、ソートによりアイテムの順序が変更されたか、またはフィルターによりアイテム数が減ったビューに含まれるアイテムの配列が localIndex プロパティにソート順に入れられます。 ListCollectionView クラスはこのプロパティを使用して、ビュー内のアイテムにアクセスします。 localIndex プロパティには、ソースにないものは含まれませんが、ソースにあるすべてのものが含まれるとは限りません。ソートが実行されない場合、このプロパティは null になります。

sort

プロパティ

sort:ISort

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

ICollectionView に適用される ISort です。ソートを設定してもビューは自動的に更新されないため、このプロパティを設定した後で refresh() メソッドを呼び出す必要があります。ソートがサポートされていない場合、このプロパティにアクセスするとエラーがスローされます。

メモ：ICollectionView の実装では、ソートを実行する前にリモートからすべてのアイテムを取得します。ソートされたリストにページングを使用している場合は、データを取得する前にリモートコレクションにソートを適用します。

このプロパティはデータバインディングのソースとして使用できます。このプロパティを変更すると、 sortChanged イベントが送出されます。

実装
public function get sort():ISort
public function set sort(value:ISort):void

関連する API エレメント

refresh()

コンストラクターの詳細

()

コンストラクター

public function ListCollectionView(list:IList = null)

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

ListCollectionView コンストラクターです。

パラメーター

list:IList (default = null) — この ListCollectionView がラップする IList です。

メソッドの詳細

addAll

()

メソッド

public function addAll(addList:IList):void

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

アイテムのリストを現在のリストに追加し、渡される順序でリストの末尾に配置します。

パラメーター

addList:IList — 現在のリストに追加するアイテムのリストです。

addAllAt

()

メソッド

public function addAllAt(addList:IList, index:int):void

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

アイテムのリストを現在のリストに追加し、関数に渡されるインデックス位置に配置します。アイテムはインデックス位置に、返される順序で配置されます。

パラメーター

	`addList:IList` — 現在のリストに追加するアイテムのリストです。

	`index:int` — 新しいアイテムを追加する、現在のリストの位置です。

例外

RangeError — インデックスが 0 未満であるか、またはリストの長さより大きい場合。

addEventListener

()

メソッド

 public function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

イベントリスナーオブジェクトを EventDispatcher オブジェクトに登録し、リスナーがイベントの通知を受け取るようにします。イベントリスナーは、特定のタイプのイベント、段階、および優先度に関する表示リスト内のすべてのノードに登録できます。

イベントリスナーが正常に登録された後に、addEventListener() をさらに呼び出して優先度を変更することはできません。リスナーの優先度を変更するには、最初に removeEventListener() を呼び出す必要があります。その後、同じリスナーを新しい優先度レベルで再度登録できます。

リスナーが登録された後に、addEventListener()（type または useCapture に別の値を設定）を再度呼び出すと、別のリスナー登録が作成されることに注意してください。例えば、最初にリスナーを登録するときに useCapture を true に設定すると、そのリスナーはキャプチャ段階のみでリスニングします。同じリスナーオブジェクトを使用して再度 addEventListener() を呼び出すと（このとき、useCapture に false を設定）、異なる 2 つのリスナーが登録されます。1 つはキャプチャ段階でリスニングするリスナーで、もう 1 つはターゲット段階とバブリング段階でリスニングするリスナーです。

ターゲット段階またはバブリング段階のみを対象とするイベントリスナーを登録することはできません。登録時にこれらの段階が組み合わされるのは、バブリングはターゲットノードの祖先にしか適用されないためです。

イベントリスナーが不要になった場合は、EventDispatcher.removeEventListener() を呼び出して、イベントリスナーを削除します。削除しない場合、メモリの問題が発生する可能性があります。ガベージコレクターは参照を有するオブジェクトを削除しないため、登録されているイベントリスナーに関係したオブジェクトはメモリから自動的に除去されません。

EventDispatcher インスタンスをコピーしても、それに関連付けられているイベントリスナーはコピーされません。新しく作成したノードにイベントリスナーが必要な場合は、ノードを作成した後に、リスナーを関連付ける必要があります。ただし、EventDispatcher インスタンスを移動した場合は、関連付けられているイベントリスナーも一緒に移動されます。

イベントがノードで処理されるときに、イベントリスナーがそのノードに登録中であれば、イベントリスナーは現在の段階ではトリガーされません。ただし、バブリング段階など、イベントフローの後の段階でトリガーすることができます。

イベントがノードで処理されているときにイベントリスナーがノードから削除された場合でも、イベントは現在のアクションによってトリガーされます。削除された後は、その後の処理で再び登録されない限り、イベントリスナーは二度と呼び出されません。

パラメーター

	`type:String` — イベントのタイプです。

	`listener:Function` — イベントを処理するリスナー関数です。次の例のように、この関数は、Event オブジェクトを唯一のパラメーターとして受け取り、何も返さないようにします。 `function(evt:Event):void` 関数の名前は任意に付けられます。

	`useCapture:Boolean` (default = `false`) — リスナーが、キャプチャ段階、またはターゲットおよびバブリング段階で動作するかどうかを判断します。`useCapture` を `true` に設定すると、リスナーはキャプチャ段階のみでイベントを処理し、ターゲット段階またはバブリング段階では処理しません。`useCapture` を `false` に設定すると、リスナーはターゲット段階またはバブリング段階のみでイベントを処理します。3 つの段階すべてでイベントを受け取るには、`addEventListener()` を 2 回呼び出します。`useCapture` を `true` に設定して 1 度呼び出し、`useCapture` を `false` に設定してもう一度呼び出します。

	`priority:int` (default = `0`) — イベントリスナーの優先度レベルです。優先度は、32 ビット整数で指定します。数値が大きくなるほど優先度が高くなります。優先度が n のすべてのリスナーは、優先度が n-1 のリスナーよりも前に処理されます。複数のリスナーに対して同じ優先度が設定されている場合、それらは追加された順番に処理されます。デフォルトの優先度は 0 です。

	`useWeakReference:Boolean` (default = `false`) — リスナーへの参照が強参照と弱参照のいずれであるかを判断します。デフォルトである強参照の場合は、リスナーのガベージコレクションが回避されます。弱参照では回避されません。クラスレベルメンバー関数はガベージコレクションの対象外であるため、クラスレベルメンバー関数の `useWeakReference` は、ガベージコレクションの制限とは無関係に `true` に設定できます。inner 関数がネストしているリスナーの `useWeakReference` を `true` に設定すると、この関数はガベージコレクションの対象となり、永続化されなくなります。inner 関数に対する参照を作成（別の変数に保存）した場合、その関数はガベージコレクションされず、永続化された状態のままになります。

addItem

()

メソッド

public function addItem(item:Object):void

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

指定されたアイテムをリストの末尾に追加します。 addItemAt(item, length) と同等です。

パラメーター

item:Object — 追加するアイテムです。

addItemAt

()

メソッド

public function addItemAt(item:Object, index:int):void

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

指定されたインデックス位置にアイテムを追加します。追加したアイテムより大きいインデックスを持つすべてのアイテムのインデックスが 1 ずつ増えます。指定されたインデックスが 0 未満であるか、またはリストの長さより大きい場合は、RangeError がスローされます。

パラメーター

	`item:Object` — インデックス位置に配置するアイテムです。

	`index:int` — アイテムを配置するインデックス位置です。

contains

()

メソッド

public function contains(item:Object):Boolean

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

指定されたオブジェクトをビューに含めるかどうかを返します。 IViewCursor.findxxx メソッドの場合とは異なり、この検索が成功するのは、パラメーターに完全に一致するアイテムが見つかったときのみです。ビューにフィルターが適用されている場合、このメソッドは、基になるコレクションにアイテムが含まれている場合でも false を返します。

パラメーター

item:Object — 検索対象のオブジェクトです。

戻り値

Boolean — 任意のフィルターを適用した後、ICollectionView にアイテムが含まれている場合は true を返します。それ以外の場合は、false を返します。

createCursor

()

メソッド

public function createCursor():IViewCursor

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

このビューに対して使用する新しい IViewCursor を作成します。

戻り値

IViewCursor — 新しい IViewCursor 実装です。

disableAutoUpdate

()

メソッド

public function disableAutoUpdate():void

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

コレクション自体およびコレクション内のアイテムの変更がビューから送出されないようにします。また、コレクション内で位置が変更された場合、ビュー内のアイテムの位置が更新されないようにします。 enableAutoUpdate が呼び出された後、変更は適切にキューに入れられ、送出されます。単一のアイテムに対して更新よりも多くのイベントが発生した場合は、ビューがリセットされることがあります。 disableAutoUpdate メソッドは累積的に動作します。ビューからイベントが送出され、ビューが更新されるには、enableAutoUpdate が同じ回数呼び出される必要があります。 disableAutoUpdate は個々のビューでのみ有効であるため、編集は他のビューによって個別に検出されます。

dispatchEvent

()

メソッド

public function dispatchEvent(event:Event):Boolean

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

イベントをイベントフローに送出します。イベントターゲットは EventDispatcher オブジェクトです。これに対して dispatchEvent() が呼び出されます。

パラメーター

event:Event — イベントフローに送出されるイベントオブジェクトです。

戻り値

Boolean — true を返します（イベントで preventDefault() が呼び出されない限り）。呼び出された場合は false を返します。

enableAutoUpdate

()

メソッド

public function enableAutoUpdate():void

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

自動更新を有効にします。詳細については、disableAutoUpdate を参照してください。

getItemAt

()

メソッド

public function getItemAt(index:int, prefetch:int = 0):Object

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

指定されたインデックス位置にあるアイテムを取得します。

パラメーター

	`index:int` — アイテムを取得するリストのインデックスです。

	`prefetch:int` (default = `0`) — アイテムがローカルでない場合に要求時に取得するアイテムの方向と量を示す `int` 値です。

戻り値

Object — そのインデックス位置にあるアイテムです。アイテムがない場合は null です。

getItemIndex

()

メソッド

public function getItemIndex(item:Object):int

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

リスト内の、getItemAt(index) == アイテムとなるアイテムのインデックスを返します。

メモ：IViewCursor.findxxx() メソッドとは異なり、getItemIndex() メソッドは、検索対象のアイテムに含まれるフィールドのサブセットのみをパラメーターとして渡すことはできません。このメソッドは常に、入力パラメーターに完全に一致するアイテムを検索します。

パラメーター

item:Object — 検索するアイテムです。

戻り値

int — アイテムのインデックスです。アイテムがリスト内にない場合は -1 です。

hasEventListener

()

メソッド

public function hasEventListener(type:String):Boolean

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

EventDispatcher オブジェクトに、特定のイベントタイプに対して登録されたリスナーがあるかどうかを確認します。これにより、EventDispatcher オブジェクトがイベントタイプの処理をイベントフロー階層のどこで変更したかを判断できます。特定のイベントタイプが実際にイベントリスナーをトリガーするかどうかを判別するには、IEventDispatcher.willTrigger() を使用します。

hasEventListener() と willTrigger() の違いは、hasEventListener() では自身が属するオブジェクトのみ検証され、willTrigger() では type パラメーターで指定されたイベントのイベントフロー全体が検証されることです。

パラメーター

type:String — イベントのタイプです。

戻り値

Boolean — 指定したタイプのリスナーが登録されている場合は true、それ以外の場合は false です。

initialized

()

メソッド

public function initialized(document:Object, id:String):void

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

MXML タグを使用して ListCollectionView を作成したときに、MXML コンパイラーによって自動的に呼び出されます。 ActionScript を介して ListCollectionView を作成する場合は、このメソッドを呼び出して、MXML ドキュメントおよび null（id について）を渡す必要があります。

パラメーター

	`document:Object` — この ListCollectionView を含む MXML ドキュメントです。

	`id:String` — 無視されます。

itemUpdated

()

メソッド

public function itemUpdated(item:Object, property:Object = null, oldValue:Object = null, newValue:Object = null):void

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

アイテムが更新されたビューを通知します。このメソッドは、ビューのコンテンツが IPropertyChangeNotifier を実装しない場合に便利です。このメソッドの呼び出しに property パラメーターが含まれている場合、ビューは通知メカニズムを最適化できることがあります。プロパティを指定しないと、ビュー全体の単純な更新が選択されます。

パラメーター

	`item:Object` — 更新されたビュー内のアイテムです。

	`property:Object` (default = `null`) — 更新されたプロパティの名前です。

	`oldValue:Object` (default = `null`) — そのプロパティの古い値です。プロパティが null の場合はアイテムの古い値を指定できます。

	`newValue:Object` (default = `null`) — そのプロパティの新しい値です。プロパティが null の場合、アイテムは新しい値と見なされるので、指定する必要はありません。

refresh

()

メソッド

public function refresh():Boolean

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

ビューにソートとフィルターを適用します。 ICollectionView は、ソートまたはフィルターの変更を自動検出しません。したがって、refresh() メソッドを呼び出してビューを更新する前に、sort プロパティまたは filterFunction プロパティを設定する必要があります。 ICollectionView が IMXMLObject インターフェイスも実装する場合は、refresh() メソッドを initialized() メソッドから呼び出す必要があります。

更新が正常に完了した場合は true を返し、ソートが完了していない場合（アイテムが保留中の場合など）は false を返します。ビューのクライアントは、CollectionEventKind.REFRESH kind プロパティを含む CollectionEvent イベントを待機して、refresh() 操作が完了したことを確認する必要があります。

戻り値

Boolean — refresh() が完了した場合は true、refresh() が完了していない場合は false です。

removeAll

()

メソッド

public function removeAll():void

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

リストからすべてのアイテムを削除します。

removeEventListener

()

メソッド

public function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

EventDispatcher オブジェクトからリスナーを削除します。対応するリスナーが EventDispatcher オブジェクトに登録されていない場合は、このメソッドを呼び出しても効果はありません。

パラメーター

	`type:String` — イベントのタイプです。

	`listener:Function` — 削除するリスナーオブジェクトです。

	`useCapture:Boolean` (default = `false`) — リスナーが、キャプチャ段階、またはターゲットおよびバブリング段階に対して登録されたかどうかを示します。リスナーがキャプチャ段階だけでなくターゲット段階とバブリング段階にも登録されている場合は、`removeEventListener()` を 2 回呼び出して両方のリスナーを削除する必要があります。1 回は `useCapture` を `true` に設定し、もう 1 回は `useCapture` を `false` に設定する必要があります。

removeItemAt

()

メソッド

public function removeItemAt(index:int):Object

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

指定されたインデックス位置にあるアイテムを削除し、返します。このインデックスより後にあったアイテムは、インデックスが 1 つずつ前になります。

パラメーター

index:int — アイテムが削除されるインデックスです。

戻り値

Object — 削除されたアイテムです。

setItemAt

()

メソッド

public function setItemAt(item:Object, index:int):Object

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

指定されたインデックス位置にアイテムを配置します。アイテムが既にそのインデックス位置にある場合は、新しいアイテムに置き換えられ、インデックス位置にあったアイテムが返されます。

パラメーター

	`item:Object` — 指定されたインデックス位置に配置される新しいアイテムです。

	`index:int` — アイテムを配置するインデックス位置です。

戻り値

Object — 置き換えられたアイテムです。アイテムがない場合は null です。

toArray

()

メソッド

public function toArray():Array

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

IList 実装と同じ順序で指定された配列を返します。このメソッドでは、ItemPendingError がスローされることがあります。

戻り値

Array — 配列です。

toString

()

メソッド

public function toString():String

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

このビューのコンテンツをストリングにプリントし、返します。

戻り値

String — このビューのストリング形式のコンテンツです。

willTrigger

()

メソッド

public function willTrigger(type:String):Boolean

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

指定されたイベントタイプについて、この EventDispatcher オブジェクトまたはその祖先にイベントリスナーが登録されているかどうかを確認します。指定されたタイプのイベントがこの EventDispatcher オブジェクトまたはその子孫に送出されたときに、イベントリスナーがイベントフローの任意の段階でトリガーされる場合、このメソッドは true を返します。

パラメーター

type:String — イベントのタイプです。

戻り値

Boolean — 指定したタイプのリスナーがトリガーされた場合は true、それ以外の場合は false です。

イベントの詳細

collectionChange

イベント

イベントオブジェクトの型: mx.events.CollectionEvent
プロパティ CollectionEvent.type = mx.events.CollectionEvent.COLLECTION_CHANGE

言語バージョン:

ActionScript 3.0

製品バージョン:

Flex 3

ランタイムバージョン:

Flash Player 9, AIR 1.1

ICollectionView が何らかの方法で更新されると送出されます。

CollectionEvent.COLLECTION_CHANGE 定数は、コレクションが変更されたときに送出されるイベントのイベントオブジェクトの type プロパティ値を定義します。

イベントオブジェクトの各プロパティには次の値が設定されています。イベントの種類によっては無効なプロパティもあります。詳細については、各プロパティの説明を参照してください。

プロパティ	値
`bubbles`	false
`cancelable`	false
`currentTarget`	イベント処理を行うイベントリスナーの定義用オブジェクトを表します。例えば、イベントリスナーの登録に `myButton.addEventListener()` を使用すると、myButton の値は `currentTarget` となります。
`items`	イベントの影響を受けるアイテムの情報を持つオブジェクトの配列です。このフィールドの内容はイベントの種類に応じて異なります。詳細については、`items` プロパティを参照してください。
`kind`	イベントの種類です。有効な値が定数として CollectionEventKind クラスに定義されます。
`location`	`items` プロパティで指定されたアイテムのターゲットコレクション内における位置です。
`oldLocation`	`items` プロパティで指定されたアイテムのコレクション内における以前の位置です。
`target`	イベントを送出したオブジェクトを表します。このオブジェクトは必ずしもイベントを受け取るオブジェクトとは限りません。イベントを受け取るオブジェクトに常にアクセスするには、`currentTarget` プロパティを使用してください。
`type`	CollectionEvent.COLLECTION_CHANGE

法律上の注意 | プライバシーポリシー

ListCollectionView - AS3 Flex

パッケージx

言語エレメント

付録

パッケージ mx.collections

filterFunction

length

list

localIndex

sort