Package | org.igniterealtime.xiff.collections.events |
Class | public class CollectionEvent |
Inheritance | CollectionEvent ![]() |
Property | Defined by | ||
---|---|---|---|
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 |
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 |
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
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.
kind | property |
public var kind:String
Indicates the kind of event that occurred.
location | property |
public var 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.
oldLocation | property |
public var 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 | () | constructor |
public function CollectionEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = false, kind:String = null, location:int = -1, oldLocation:int = -1, items:Array = null)
Constructor.
Parameterstype:String |
|
bubbles:Boolean (default = false )
|
|
cancelable:Boolean (default = false )
|
|
kind:String (default = null )
|
|
location:int (default = -1 )
|
|
oldLocation:int (default = -1 )
|
|
items:Array (default = null )
|
COLLECTION_CHANGE | constant |
public static const 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.