Adobe® Flash® Platform 用 ActionScript® 3.0 リファレンスガイド
ホーム  |  パッケージおよびクラスリストの非表示 |  パッケージ  |  クラス  |  新機能  |  索引  |  付録  |  英語で表示される理由
フィルター: サーバーからデータを取得しています...
サーバーからデータを取得しています...
mx.events 

CollectionEvent  - AS3 Flex

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

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

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

関連する API エレメント



パブリックプロパティ
 プロパティ定義元
 Inheritedbubbles : Boolean
[読み取り専用] イベントがバブリングイベントかどうかを示します。
Event
 Inheritedcancelable : Boolean
[読み取り専用] イベントに関連付けられた動作を回避できるかどうかを示します。
Event
 Inheritedconstructor : Object
指定されたオブジェクトインスタンスのクラスオブジェクトまたはコンストラクター関数への参照です。
Object
 InheritedcurrentTarget : Object
[読み取り専用] イベントリスナーで Event オブジェクトをアクティブに処理しているオブジェクトです。
Event
 InheritedeventPhase : uint
[読み取り専用] イベントフローの現在の段階です。
Event
  items : Array
kind が CollectionEventKind.ADD または CollectionEventKind.REMOVE の場合、items プロパティは追加または削除されたアイテムの配列になります。
CollectionEvent
  kind : String
発生したイベントの種類を示します。
CollectionEvent
  location : int
kind 値が CollectionEventKind.ADD、CollectionEventKind.MOVE、CollectionEventKind.REMOVE または CollectionEventKind.REPLACE の場合、このプロパティは、items プロパティで指定されたアイテムのコレクションの 0 から始まるインデックスになります。
CollectionEvent
  oldLocation : int
kind 値が CollectionEventKind.MOVE の場合、このプロパティは、items プロパティで指定されたアイテムの以前の位置にあるターゲットコレクションの 0 から始まるインデックスになります。
CollectionEvent
 Inheritedtarget : Object
[読み取り専用] イベントターゲットです。
Event
 Inheritedtype : String
[読み取り専用] イベントのタイプです。
Event
パブリックメソッド
 メソッド定義元
  
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
カスタム ActionScript 3.0 Event クラスに toString() メソッドを実装するためのユーティリティ関数です。
Event
 Inherited
オブジェクトに指定されたプロパティが定義されているかどうかを示します。
Object
 Inherited
イベントで preventDefault() メソッドが呼び出されたかどうかを確認します。
Event
 Inherited
Object クラスのインスタンスが、パラメーターとして指定されたオブジェクトのプロトタイプチェーン内にあるかどうかを示します。
Object
 Inherited
イベントのデフォルト動作をキャンセルできる場合に、その動作をキャンセルします。
Event
 Inherited
指定されたプロパティが存在し、列挙できるかどうかを示します。
Object
 Inherited
ループ処理に対するダイナミックプロパティの可用性を設定します。
Object
 Inherited
イベントフローの現在のノードおよび後続するノードで、イベントリスナーが処理されないようにします。
Event
 Inherited
イベントフローの現在のノードに後続するノードで、イベントリスナーが処理されないようにします。
Event
 Inherited
ロケール固有の規則に従って書式設定された、このオブジェクトのストリング表現を返します。
Object
 Inherited
Event オブジェクトのすべてのプロパティを含むストリングを返します。
Event
 Inherited
指定されたオブジェクトのプリミティブな値を返します。
Object
パブリック定数
 定数定義元
  COLLECTION_CHANGE : String = "collectionChange"
[静的] CollectionEvent.COLLECTION_CHANGE 定数は、コレクションが変更されたときに送出されるイベントのイベントオブジェクトの type プロパティ値を定義します。
CollectionEvent
プロパティの詳細

items

プロパティ
public var items:Array

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

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

デフォルト値: [ ]。

関連する API エレメント

kind

プロパティ 
public var kind:String

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

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

デフォルト値: null。

関連する API エレメント

location

プロパティ 
public var location:int

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

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

デフォルト値: -1。

関連する API エレメント

oldLocation

プロパティ 
public var oldLocation:int

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

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

デフォルト値: -1。

コンストラクターの詳細

CollectionEvent

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

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

コンストラクターです。

パラメーター
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"

言語バージョン: ActionScript 3.0
製品バージョン: Flex 3
ランタイムバージョン: Flash Player 9, AIR 1.1

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

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

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





[ X ]英語で表示される理由
ActionScript 3.0 リファレンスガイドのコンテンツが英語で表示されます。

ActionScript 3.0 リファレンスガイドのすべての部分がすべての言語に翻訳されているわけではありません。言語エレメントが翻訳されていない場合、そのエレメントは英語で表示されます。例えば、ga.controls.HelpBox クラスはどの言語にも訳されていません。このため、リファレンスガイドの日本語バージョンでは、ga.controls.HelpBox クラスは英語で表示されます。