| Package | mx.events |
| Class | public class CollectionEvent |
| Inheritance | CollectionEvent  Event Object |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Related API Elements
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | bubbles : Boolean [read-only]
Indicates whether an event is a bubbling event. | Event | |
| cancelable : Boolean [read-only]
Indicates whether the behavior associated with the event can be prevented. | Event | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| currentTarget : Object [read-only]
The object that is actively processing the Event object with an event listener. | Event | |
| eventPhase : uint [read-only]
The current phase in the event flow. | 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 [read-only]
The event target. | Event | |
| type : String [read-only]
The type of event. | Event | |
| Method | Defined By | ||
|---|---|---|---|
CollectionEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, kind:String = null, location:int = -1, oldLocation:int = -1, items:Array = null)
Constructor. | CollectionEvent | ||
|
Duplicates an instance of an Event subclass. | Event | |
|
A utility function for implementing the toString() method in custom
ActionScript 3.0 Event classes. | Event | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Checks whether the preventDefault() method has been called on the event. | Event | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Cancels an event's default behavior if that behavior can be canceled. | Event | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Prevents processing of any event listeners in the current node and any subsequent nodes in
the event flow. | Event | |
|
Prevents processing of any event listeners in nodes subsequent to the current node in the
event flow. | Event | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns a string containing all the properties of the Event object. | Event | |
|
Returns the primitive value of the specified object. | Object | |
| Constant | Defined By | ||
|---|---|---|---|
| COLLECTION_CHANGE : String = "collectionChange" [static]
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 | property |
public var items:Array| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | 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.
The default value is [ ].
Related API Elements
kind | property |
public var kind:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | 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.
The default value is null.
Related API Elements
location | property |
public var location:int| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | 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.
The default value is -1.
Related API Elements
oldLocation | property |
public var oldLocation:int| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | 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.
The default value is -1.
CollectionEvent | () | Constructor |
public function CollectionEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, kind:String = null, location:int = -1, oldLocation:int = -1, items:Array = null)| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Constructor.
Parameterstype:String — The event type; indicates the action that triggered the event.
| |
bubbles:Boolean (default = false) | |
cancelable:Boolean (default = false) | |
kind:String (default = null)null, which indicates that the kind is unknown.
| |
location:int (default = -1)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)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)items property.
When the kind is CollectionEventKind.REFRESH
or CollectionEventKind.RESET, this Array has zero length.
|
COLLECTION_CHANGE | Constant |
public static const COLLECTION_CHANGE:String = "collectionChange"| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | 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 |
Wed Nov 21 2018, 06:34 AM -08:00