CollectionEvent

套件	mx.events
類別	public class CollectionEvent
繼承	CollectionEvent Event Object

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

The mx.events.CollectionEvent class represents an event that is dispatched when the associated collection changes.

相關 API 元素

FlexEvent.CURSOR_UPDATE

公用屬性

隱藏繼承公用屬性

顯示繼承公用屬性

	屬性		定義自
		bubbles : Boolean [唯讀] 指出事件是否為反昇事件。	Event
		cancelable : Boolean [唯讀] 指出是否可避免與事件相關聯的行為指令。	Event
		constructor : Object 類別物件的參照或是特定物件實體的建構函數。	Object
		currentTarget : Object [唯讀] 正主動使用事件偵聽程式處理 Event 物件的物件。	Event
		eventPhase : uint [唯讀] 事件流程中的目前階段。	Event
		items : Array When the kind is CollectionEventKind.ADD or CollectionEventKind.REMOVE the items property is an Array of added/removed items.	CollectionEvent
		kind : String Indicates the kind of event that occurred.	CollectionEvent
		location : int When the kind value is CollectionEventKind.ADD, CollectionEventKind.MOVE, CollectionEventKind.REMOVE, or CollectionEventKind.REPLACE, this property is the zero-base index in the collection of the item(s) specified in the items property.	CollectionEvent
		oldLocation : int When the kind value is CollectionEventKind.MOVE, this property is the zero-based index in the target collection of the previous location of the item(s) specified by the items property.	CollectionEvent
		target : Object [唯讀] 事件目標。	Event
		type : String [唯讀] 事件類型。	Event

公用方法

隱藏繼承公用方法

顯示繼承公用方法

	方法		定義自
		CollectionEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, kind:String = null, location:int = -1, oldLocation:int = -1, items:Array = null) Constructor.	CollectionEvent
		clone():Event 複製 Event 子類別的實體。	Event
		formatToString(className:String, ... arguments):String 公用程式函數，可用來實作自訂 ActionScript 3.0 Event 類別中的 toString() 方法。	Event
		hasOwnProperty(name:String):Boolean 指出物件是否有已定義的指定屬性。	Object
		isDefaultPrevented():Boolean 檢查是否已經對事件呼叫 preventDefault() 方法。	Event
		isPrototypeOf(theClass:Object):Boolean 指出 Object 類別的實體是否位於指定為參數的物件原型鏈中。	Object
		preventDefault():void 如果可以取消事件的預設行為指令，則取消該行為指令。	Event
		propertyIsEnumerable(name:String):Boolean 指出指定的屬性是否存在，以及是否可列舉。	Object
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 為迴圈作業設定動態屬性的可用性。	Object
		stopImmediatePropagation():void 避免處理事件流程中，目前節點以及任何後續節點中的任何事件偵聽程式。	Event
		stopPropagation():void 避免處理接續在事件流程中的目前節點之後，後續節點中的任何事件偵聽程式。	Event
		toLocaleString():String 傳回代表此物件的字串，根據地區特定慣例進行格式化。	Object
		toString():String 傳回包含 Event 物件所有屬性的字串。	Event
		valueOf():Object 會傳回指定之物件的基本值。	Object

公用常數

隱藏繼承公用常數

顯示繼承公用常數

	常數		定義自
		COLLECTION_CHANGE : String = "collectionChange" [靜態] The CollectionEvent.COLLECTION_CHANGE constant defines the value of the type property of the event object for an event that is dispatched when a collection has changed.	CollectionEvent

屬性詳細資訊

items

屬性

public var items:Array

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

When the kind is CollectionEventKind.ADD or CollectionEventKind.REMOVE the items property is an Array of added/removed items. When the kind is CollectionEventKind.REPLACE or CollectionEventKind.UPDATE the items property is an Array of PropertyChangeEvent objects with information about the items affected by the event. When a value changes, query the newValue and oldValue fields of the PropertyChangeEvent objects to find out what the old and new values were. When the kind is CollectionEventKind.REFRESH or CollectionEventKind.RESET, this array has zero length.

預設值為 [ ]。

相關 API 元素

PropertyChangeEvent

kind

屬性

public var kind:String

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

Indicates the kind of event that occurred. The property value can be one of the values in the CollectionEventKind class, or null, which indicates that the kind is unknown.

預設值為 null。

相關 API 元素

CollectionEventKind

location

屬性

public var location:int

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

When the kind value is CollectionEventKind.ADD, CollectionEventKind.MOVE, CollectionEventKind.REMOVE, or CollectionEventKind.REPLACE, this property is the zero-base index in the collection of the item(s) specified in the items property.

預設值為 -1。

相關 API 元素

CollectionEventKind

oldLocation

屬性

public var oldLocation:int

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

When the kind value is CollectionEventKind.MOVE, this property is the zero-based index in the target collection of the previous location of the item(s) specified by the items property.

預設值為 -1。

建構函式詳細資料

()

建構函式

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

Constructor.

參數

	`type:String` — The event type; indicates the action that triggered the event.

	`bubbles:Boolean` (default = `false`) — Specifies whether the event can bubble up the display list hierarchy.

	`cancelable:Boolean` (default = `false`) — Specifies whether the behavior associated with the event can be prevented.

	`kind:String` (default = `null`) — Indicates the kind of event that occured. The parameter value can be one of the values in the CollectionEventKind class, or `null`, which indicates that the kind is unknown.

	`location:int` (default = `-1`) — When the `kind` is `CollectionEventKind.ADD`, `CollectionEventKind.MOVE`, `CollectionEventKind.REMOVE`, or `CollectionEventKind.REPLACE`, this value indicates at what location the item(s) specified in the `items property` can be found within the target collection.

	`oldLocation:int` (default = `-1`) — When the `kind` is `CollectionEventKind.MOVE`, this value indicates the old location within the target collection of the item(s) specified in the `items` property.

	`items:Array` (default = `null`) — Array of objects with information about the items affected by the event, as described in the `items` property. When the `kind` is `CollectionEventKind.REFRESH` or `CollectionEventKind.RESET`, this Array has zero length.

常數詳細資訊

COLLECTION_CHANGE

常數

public static const COLLECTION_CHANGE:String = "collectionChange"

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

The CollectionEvent.COLLECTION_CHANGE constant defines the value of the type property of the event object for an event that is dispatched when a collection has changed.

The properties of the event object have the following values. Not all properties are meaningful for all kinds of events. See the detailed property descriptions for more information.

Property	Value
`bubbles`	false
`cancelable`	false
`currentTarget`	The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`items`	An Array of objects with information about the items affected by the event. The contents of this field depend on the event kind; for details see the `items` property
`kind`	The kind of event. The valid values are defined in the CollectionEventKind class as constants.
`location`	Location within the target collection of the item(s) specified in the `items` property.
`oldLocation`	the previous location in the collection of the item specified in the `items` property.
`target`	The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.
`type`	CollectionEvent.COLLECTION_CHANGE

法律聲明 | 線上隱私權政策

CollectionEvent - AS3 Flex

類別 x

items

kind

location

oldLocation

CollectionEvent

COLLECTION_CHANGE