Manages display objects that may be used to render data, in a component like ListView or TabBar.

Available since

1.0.0

.

See also:

Static methods

staticwithClass<T, S, B>(displayObjectType:Class<T>, ?update:(target:T, state:S) ‑> Void, ?reset:(target:T, state:S) ‑> Void, ?destroy:T ‑> Void):DisplayObjectRecycler<T, S, B>

Creates a DisplayObjectRecycler that instantiates a display object by instantiating the specified class. The class must have a constructor with zero required arguments.

To instantiate an object with one or more required constructor arguments, use DisplayObjectRecycler.withFunction() instead.

Available since

1.0.0

.

staticwithFactory<T, S, B>(factory:DisplayObjectFactory<T, B>, ?update:(target:T, state:S) ‑> Void, ?reset:(target:T, state:S) ‑> Void):DisplayObjectRecycler<T, S, B>

Creates a DisplayObjectRecycler that instantiates a display object from a DisplayObjectFactory.

Available since

1.3.0

.

staticwithFunction<T, S, B>(create:() ‑> T, ?update:(target:T, state:S) ‑> Void, ?reset:(target:T, state:S) ‑> Void, ?destroy:T ‑> Void):DisplayObjectRecycler<T, S, B>

Creates a DisplayObjectRecycler that instantiates a display object by calling the specified function.

Available since

1.0.0

.

Methods

dynamicreset(target:T, state:S):Void

Prepares a display object to be used again. This method should restore the display object to its original state from when it was returned by create().

Warning: This method is not guaranteed to be called by the parent component when that component is removed from stage (or later when it is garbage collected). If this method must be called to clean up something that would cause a memory leak, you should manually update the appropriate property on the parent component that will cause all instances to be removed, and then validate the parent component. For example, on a ListView, you would set the dataProvider property to null before calling validateNow().

listView.dataProvider = null;
listView.validateNow();
Available since

1.0.0

.

dynamicupdate(target:T, state:S):Void

Updates the properties an existing display object. It may be a display object that was used previously, but it will have been passed to reset() first, to ensure that it has been restored to its original state when it was returned from create().

Available since

1.0.0

.

Inherited Variables

Inherited Methods

Defined by DisplayObjectFactory

dynamiccreate():T

Creates a new display object.

Available since

1.0.0

.

dynamicdestroy(target:T):Void

Destroys/disposes a display object when it will no longer be used.

Warning: This method is not guaranteed to be called by the parent component when that component is removed from stage (or later when it is garbage collected). If this method must be called to clean up something that would cause a memory leak, you should manually update the appropriate property on the parent component that will cause all instances to be removed, and then validate the parent component. For example, on a ListView, you would set the dataProvider property to null before calling validateNow().

listView.dataProvider = null;
listView.validateNow();
Available since

1.0.0

.