View source

class HierarchicalCollectionEvent

package feathers.events

extends Event

@:directlyUsed

Events dispatched by hierarchical collections.

Available since

1.0.0

.

See also:

  • feathers.data.IHierarhicalCollection

Static variables

@:value("addItem")staticinlineread onlyADD_ITEM:EventType<HierarchicalCollectionEvent> = "addItem"

The HierarchicalCollectionEvent.ADD_ITEM event type is dispatched when an item is added to a collection.

Available since

1.0.0

.

See also:

@:value("filterChange")staticinlineread onlyFILTER_CHANGE:EventType<HierarchicalCollectionEvent> = "filterChange"

The HierarchicalCollectionEvent.FILTER_CHANGE event type is dispatched when a filter function has been applied to or removed from a collection.

Available since

1.0.0

.

See also:

@:value("removeAll")staticinlineread onlyREMOVE_ALL:EventType<HierarchicalCollectionEvent> = "removeAll"

The HierarchicalCollectionEvent.REMOVE_ALL event type is dispatched when all items are removed from the collection simulatanously by calling removeAll() on the collection.

Available since

1.0.0

.

See also:

@:value("removeItem")staticinlineread onlyREMOVE_ITEM:EventType<HierarchicalCollectionEvent> = "removeItem"

The HierarchicalCollectionEvent.REMOVE_ITEM event type is dispatched when an item is removed from a collection.

Available since

1.0.0

.

See also:

@:value("replaceItem")staticinlineread onlyREPLACE_ITEM:EventType<HierarchicalCollectionEvent> = "replaceItem"

The HierarchicalCollectionEvent.REPLACE_ITEM event type is dispatched when an item is replaced in a collection.

Available since

1.0.0

.

See also:

@:value("reset")staticinlineread onlyRESET:EventType<HierarchicalCollectionEvent> = "reset"

The HierarchicalCollectionEvent.RESET event type is dispatched when the entire underlying data structure is replaced.

Available since

1.0.0

.

@:value("sortChange")staticinlineread onlySORT_CHANGE:EventType<HierarchicalCollectionEvent> = "sortChange"

The HierarchicalCollectionEvent.SORT_CHANGE event type is dispatched when a sort compare function has been applied to or removed from a collection.

Available since

1.0.0

.

See also:

@:value("updateAll")staticinlineread onlyUPDATE_ALL:EventType<HierarchicalCollectionEvent> = "updateAll"

The HierarchicalCollectionEvent.UPDATE_ALL event type is dispatched when the updateAll() method is called on the collection.

Available since

1.0.0

.

See also:

@:value("updateItem")staticinlineread onlyUPDATE_ITEM:EventType<HierarchicalCollectionEvent> = "updateItem"

The HierarchicalCollectionEvent.UPDATE_ITEM event type is dispatched when the updateAt() method is called on the collection.

Available since

1.0.0

.

See also:

Static methods

@:value({ cancelable : false, bubbles : false, removedItem : null, addedItem : null })staticdispatch(dispatcher:IEventDispatcher, type:String, location:Array<Int>, ?addedItem:Dynamic, ?removedItem:Dynamic, bubbles:Bool = false, cancelable:Bool = false):Bool

Dispatches a pooled event with the specified properties.

HierarchicalCollectionEvent.dispatch(component, Event.ADD_ITEM, 0, item);
Available since

1.0.0

.

Constructor

@:value({ cancelable : false, bubbles : false, removedItem : null, addedItem : null })new(type:String, location:Array<Int>, ?addedItem:Dynamic, ?removedItem:Dynamic, bubbles:Bool = false, cancelable:Bool = false)

Creates a new HierarchicalCollectionEvent object with the given arguments.

Available since

1.0.0

.

See also:

Variables

addedItem:Dynamic

The item that was added to the collection, or null, if no item was added.

Available since

1.0.0

.

location:Array<Int>

The location of the item in the collection that is associated with this event, or null, if there is no specific item.

Available since

1.0.0

.

removedItem:Dynamic

The item that was removed from the collection, or null, if no item was removed.

Available since

1.0.0

.

Methods