Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
CollectionEventKind

Package | mx.events
Class | public final class CollectionEventKind
Inheritance | CollectionEventKind Object

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The CollectionEventKind class contains constants for the valid values of the mx.events.CollectionEvent class `kind` property. These constants indicate the kind of change that was made to the collection.

See also

mx.events.CollectionEvent

Public Constants

| Constant | Defined By
--- | --- | ---
|  | ADD : String = add [static] Indicates that the collection added an item or items. | CollectionEventKind
|  | MOVE : String = move [static] Indicates that the item has moved from the position identified by the CollectionEvent oldLocation property to the position identified by the location property. | CollectionEventKind
|  | REFRESH : String = refresh [static] Indicates that the collection applied a sort, a filter, or both. | CollectionEventKind
|  | REMOVE : String = remove [static] Indicates that the collection removed an item or items. | CollectionEventKind
|  | REPLACE : String = replace [static] Indicates that the item at the position identified by the CollectionEvent location property has been replaced. | CollectionEventKind
|  | RESET : String = reset [static] Indicates that the collection has changed so drastically that a reset is required. | CollectionEventKind
|  | UPDATE : String = update [static] Indicates that one or more items were updated within the collection. | CollectionEventKind

Constant Detail

ADD | Constant

`public static const ADD:String = add`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Indicates that the collection added an item or items.

MOVE | Constant |

`public static const MOVE:String = move`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Indicates that the item has moved from the position identified by the CollectionEvent `oldLocation` property to the position identified by the `location` property.

REFRESH | Constant |

`public static const REFRESH:String = refresh`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Indicates that the collection applied a sort, a filter, or both. This change can potentially be easier to handle than a RESET.

REMOVE | Constant |

`public static const REMOVE:String = remove`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Indicates that the collection removed an item or items.

REPLACE | Constant |

`public static const REPLACE:String = replace`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Indicates that the item at the position identified by the CollectionEvent `location` property has been replaced.

RESET | Constant |

`public static const RESET:String = reset`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Indicates that the collection has changed so drastically that a reset is required.

UPDATE | Constant |

`public static const UPDATE:String = update`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Indicates that one or more items were updated within the collection. The affected item(s) are stored in the `items` property.

Sun Mar 5 2017, 03:42 PM +11:00