Packagecom.sibirjak.angara.sequence
Interfacepublic interface ISequence extends ILoaderItem, IProgressInfo, flash.events.IEventDispatcher, org.as3commons.collections.framework.IIterable
SubinterfacesIPagedSequence
ImplementorsSequence, SequenceManager

A sequence enables the controlling of a list of resource loaders.

A sequence can be prioritised, added, removed, stopped, paused or resumed like ordinary loaders. A sequence is the best approach to load lists of display assets such as lists of thumbnails.

A sequence does not support the status LoaderItemStatus.FAILURE. A sequence instead will be marked as LoaderItemStatus.COMPLETE when all contained items are either COMPLETE or FAILURE. if (numItemsLoaded + numItemsFailed == numItems) => status = LoaderItemStatus.COMPLETE.


Public Properties
 PropertyDefined by
 InheriteditemType : String
The type of the loader item.
ILoaderItem
 Inheritedkey : String
Returns the identifying key of the loader item.
ILoaderItem
 InheritednumItems : uint
Returns the number of items to be loaded within the loader item.
IProgressInfo
 InheritednumItemsFailed : uint
Returns the number of items failed within the loader item.
IProgressInfo
 InheritednumItemsLoaded : uint
Returns the number of items loaded within the loader item.
IProgressInfo
 Inheritedprogress : Number
Returns the progress of the loader item as a decimal value between zero and 1.
IProgressInfo
 Inheritedscheduled : Boolean
Returns true, if the item already has been added to the loader manager directly or to a sequence or a sequence manager.
ILoaderItem
 Inheritedstatus : String
The current loading status.
ILoaderItem
Public Methods
 MethodDefined by
  
add(resourceLoader:IResourceLoader, weight:uint = 0):void
Adds a new resource loader to the sequence.
ISequence
  
clear():void
Stops all loaders and removes all loader references from the sequence.
ISequence
 Inherited
pause():void
Marks the item to be ignored by subsequent loader manager queue pulling operations.
ILoaderItem
  
remove(resourceLoader:IResourceLoader):void
Removes a loader from a sequence.
ISequence
 Inherited
resume():void
Marks a prior paused item to be eligible for loader manager queue polling operations.
ILoaderItem
 Inherited
stop():void
Immediately stops loading of the item or its containing items.
ILoaderItem
Method detail
add()method
public function add(resourceLoader:IResourceLoader, weight:uint = 0):void

Adds a new resource loader to the sequence.

Its possible to add resource at any time of loading to a sequence but not after the sequence has been marked as complete.

Parameters
resourceLoader:IResourceLoader — The resource loader to add.
 
weight:uint (default = 0)
clear()method 
public function clear():void

Stops all loaders and removes all loader references from the sequence.

remove()method 
public function remove(resourceLoader:IResourceLoader):void

Removes a loader from a sequence.

This will decrease the number of items by 1 and adjust the sequence's progress value.

Parameters
resourceLoader:IResourceLoader — The resource loader to remove.