パッケージmx.events
public class CollectionEvent
継承CollectionEvent Inheritance Event Inheritance Object

mx.events.CollectionEvent クラスは、関連付けられたコレクションが変更された場合に送出されるイベントを表します。

関連項目

FlexEvent.CURSOR_UPDATE


パブリックプロパティ
 プロパティ定義
 Inheritedbubbles : Boolean
イベントがバブリングイベントかどうかを示します。
Event
 Inheritedcancelable : Boolean
イベントに関連付けられた動作をキャンセルできるかどうかを示します。
Event
 Inheritedconstructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクタ関数への参照です。
Object
 InheritedcurrentTarget : Object
イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
Event
 InheritedeventPhase : uint
イベントフローの現在の段階。
Event
  items : Array
kindCollectionEventKind.ADD または CollectionEventKind.REMOVE の場合、items プロパティは追加または削除されたアイテムの配列になります。
CollectionEvent
  kind : String
発生したイベントの種類を示します。
CollectionEvent
  location : int
kind 値が CollectionEventKind.ADDCollectionEventKind.MOVECollectionEventKind.REMOVE、または CollectionEventKind.REPLACE の場合、このプロパティは、items プロパティで指定されたアイテムのコレクションの 0 から始まるインデックスになります。
CollectionEvent
  oldLocation : int
kind 値が CollectionEventKind.MOVE の場合、このプロパティは、items プロパティで指定されたアイテムの以前の位置にあるターゲットコレクションの 0 から始まるインデックスになります。
CollectionEvent
 Inheritedprototype : Object
[static] クラスまたは関数オブジェクトのプロトタイプオブジェクトへの参照です。
Object
 Inheritedtarget : Object
イベントターゲットです。
Event
 Inheritedtype : String
イベントのタイプです。
Event
パブリック Methods
 メソッド定義
  
CollectionEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, kind:String = null, location:int = -1, oldLocation:int = -1, items:Array = null)
コンストラクタです。
CollectionEvent
 Inherited
Event サブクラスのインスタンスを複製します。
Event
 Inherited
formatToString(className:String, ... arguments):String
カスタム Event クラスに toString() メソッドを実装するためのユーティリティ関数です。
Event
 Inherited
指定されたプロパティがオブジェクトに定義されているかどうかを示します。
Object
 Inherited
イベントで preventDefault() が呼び出されたかどうかを確認します。
Event
 Inherited
Object クラスのインスタンスが、パラメータとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
 Inherited
イベントのデフォルト動作をキャンセルできる場合に、その動作をキャンセルします。
Event
 Inherited
指定されたプロパティが存在し、列挙できるかどうかを示します。
Object
 Inherited
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
 Inherited
イベントフローの現在のノードおよび後続するノードで、イベントリスナーが処理されないようにします。
Event
 Inherited
イベントフローの現在のノードに後続するノードで、イベントリスナーが処理されないようにします。
Event
 Inherited
Event オブジェクトのすべてのプロパティを含むストリングを返します。
Event
 Inherited
指定されたオブジェクトのプリミティブな値を返します。
Object
パブリック定数
 定数定義
 InheritedACTIVATE : String = "activate"
[static] activate イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedADDED : String = "added"
[static] added イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedADDED_TO_STAGE : String = "addedToStage"
[static] addedToStage イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedCANCEL : String = "cancel"
[static] cancel イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedCHANGE : String = "change"
[static] change イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedCLOSE : String = "close"
[static] close イベントオブジェクトの type プロパティの値を定義します。
Event
  COLLECTION_CHANGE : String = "collectionChange"
[static] CollectionEvent.COLLECTION_CHANGE 定数は、コレクションが変更されるときに送出されるイベントのイベントオブジェクトの type プロパティ値を定義します。
CollectionEvent
 InheritedCOMPLETE : String = "complete"
[static] complete イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedCONNECT : String = "connect"
[static] connect イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedDEACTIVATE : String = "deactivate"
[static] deactivate イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedENTER_FRAME : String = "enterFrame"
[static] enterFrame イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedFULLSCREEN : String = "fullScreen"
[static] fullScreen イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedID3 : String = "id3"
[static] id3 イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedINIT : String = "init"
[static] init イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedMOUSE_LEAVE : String = "mouseLeave"
[static] mouseLeave イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedOPEN : String = "open"
[static] open イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedREMOVED : String = "removed"
[static] removed イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedREMOVED_FROM_STAGE : String = "removedFromStage"
[static] removedFromStage イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedRENDER : String = "render"
[static] render イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedRESIZE : String = "resize"
[static] resize イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedSCROLL : String = "scroll"
[static] scroll イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedSELECT : String = "select"
[static] select イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedSOUND_COMPLETE : String = "soundComplete"
[static] soundComplete イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedTAB_CHILDREN_CHANGE : String = "tabChildrenChange"
[static] tabChildrenChange イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedTAB_ENABLED_CHANGE : String = "tabEnabledChange"
[static] tabEnabledChange イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedTAB_INDEX_CHANGE : String = "tabIndexChange"
[static] tabIndexChange イベントオブジェクトの type プロパティの値を定義します。
Event
 InheritedUNLOAD : String = "unload"
[static] unload イベントオブジェクトの type プロパティの値を定義します。
Event
プロパティの詳細
itemsプロパティ
public var items:Array

kindCollectionEventKind.ADD または CollectionEventKind.REMOVE の場合、items プロパティは追加または削除されたアイテムの配列になります。kindCollectionEventKind.REPLACE または CollectionEventKind.UPDATE の場合、items プロパティは、イベントの影響を受けるアイテムの情報を持つ PropertyChangeEvent オブジェクトの配列になります。値が変更された場合は、PropertyChangeEvent オブジェクトの newValue フィールドおよび oldValue フィールドを調べて、古い値と新しい値を見つけます。kindCollectionEventKind.REFRESH または CollectionEventKind.RESET の場合、この配列の長さは 0 です。

デフォルト値[ ].

関連項目

kindプロパティ 
public var kind:String

発生したイベントの種類を示します。プロパティ値は CollectionEventKind クラスのいずれかの値、またはイベントの種類が不明であることを示す null になります。

デフォルト値ヌル (null).

関連項目

locationプロパティ 
public var location:int

kind 値が CollectionEventKind.ADDCollectionEventKind.MOVECollectionEventKind.REMOVE、または CollectionEventKind.REPLACE の場合、このプロパティは、items プロパティで指定されたアイテムのコレクションの 0 から始まるインデックスになります。

デフォルト値-1.

関連項目

oldLocationプロパティ 
public var oldLocation:int

kind 値が CollectionEventKind.MOVE の場合、このプロパティは、items プロパティで指定されたアイテムの以前の位置にあるターゲットコレクションの 0 から始まるインデックスになります。

デフォルト値-1.

コンストラクタの詳細
CollectionEvent()コンストラクタ
public 関数 CollectionEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, kind:String = null, location:int = -1, oldLocation:int = -1, items:Array = null)

コンストラクタです。

パラメータ
type:String — イベントタイプ。イベントをトリガしたアクションを示します。
 
bubbles:Boolean (default = false) — イベントが表示リスト階層を上方にバブルできるかどうかを指定します。
 
cancelable:Boolean (default = false) — イベントに関連付けられた動作をキャンセルできるかどうかを指定します。
 
kind:String (default = null) — 発生したイベントの種類を示します。パラメータ値は CollectionEventKind クラスのいずれかの値、またはイベントの種類が不明であることを示す null になります。
 
location:int (default = -1)kindCollectionEventKind.ADDCollectionEventKind.MOVECollectionEventKind.REMOVE、または CollectionEventKind.REPLACE の場合、この値は、items property で指定されたアイテムがターゲットコレクション内のどの位置にあるかを示します。
 
oldLocation:int (default = -1)kindCollectionEventKind.MOVE の場合、この値は、items プロパティで指定されたアイテムのターゲットコレクション内での以前の位置を示します。
 
items:Array (default = null)items プロパティで説明しているように、イベントの影響を受けるアイテムの情報を持つオブジェクトの配列です。kindCollectionEventKind.REFRESH または CollectionEventKind.RESET の場合、この配列の長さは 0 です。
定数の詳細
COLLECTION_CHANGE定数
public static const COLLECTION_CHANGE:String = "collectionChange"

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

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

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