| Package | com.sibirjak.angara.core |
| Interface | public interface IProgressInfo extends flash.events.IEventDispatcher |
| Subinterfaces | ILoaderItem, IMonitor |
| Implementors | AbstractProgressInfo |
The progress information contains number of the items to be loaded within an item, the number of items loaded and the number of items failed.
The progress value of the progress information returns the overall progress of the particular loader item. If the item is of type LoaderItemType.LOADER, the progress value returns the progress only of that single item.
| Property | Defined by | ||
|---|---|---|---|
| numItems : uint [read-only]
Returns the number of items to be loaded within the loader item.
| IProgressInfo | ||
| numItemsFailed : uint [read-only]
Returns the number of items failed within the loader item.
| IProgressInfo | ||
| numItemsLoaded : uint [read-only]
Returns the number of items loaded within the loader item.
| IProgressInfo | ||
| progress : Number [read-only]
Returns the progress of the loader item as a decimal value between zero and 1.
| IProgressInfo | ||
| numItems | property |
numItems:uint [read-only]Returns the number of items to be loaded within the loader item.
If the item is of type LoaderItemType.LOADER the number will be always 1.
If the item is of type LoaderItemType.SEQUENCE, the method returns the number of all loaders added to the sequence. Removing a loader from the sequence will decrease this value by 1.
If the item is of type LoaderItemType.SEQUENCE_MANAGER, the method returns the cumulative number of items of all assigned sequences. The value will be calculated at runtime.
Implementation public function get numItems():uint
| numItemsFailed | property |
numItemsFailed:uint [read-only]Returns the number of items failed within the loader item.
If the item is of type LoaderItemType.LOADER the number will be zero initally and 1, if the loader could not successfully finish loading. In this case numItemsLoaded() will return zero.
If the item is of type LoaderItemType.SEQUENCE, the method returns the number of all failed loaders added to the sequence.
If the item is of type LoaderItemType.SEQUENCE_MANAGER, the method returns the cumulative number of failed items of all assigned sequences. The value will be calculated at runtime.
Implementation public function get numItemsFailed():uint
| numItemsLoaded | property |
numItemsLoaded:uint [read-only]Returns the number of items loaded within the loader item.
If the item is of type LoaderItemType.LOADER the number will be zero initally and 1, after the loader has been completed successfully.
If the item is of type LoaderItemType.SEQUENCE, the method returns the number of all completed loaders added to the sequence.
If the item is of type LoaderItemType.SEQUENCE_MANAGER, the method returns the cumulative number of loaded items of all assigned sequences. The value will be calculated at runtime.
Implementation public function get numItemsLoaded():uint
| progress | property |
progress:Number [read-only]Returns the progress of the loader item as a decimal value between zero and 1.
If the item is of type LoaderItemType.LOADER the number will be zero initally and 1, after the loader has been completed successfully. The progress will not be reset if the loader fails e.g. after a progress of 0.5. It is guaranteed, that the progress value is set to 1 at the time the COMPLETE event is dispatched.
If the item is of type LoaderItemType.SEQUENCE, the method returns the overall progress of that sequence. It is possible specify a weight to each added loader to achieve a unbalanced distibution of loader progress values.
If the item is of type LoaderItemType.SEQUENCE_MANAGER, the method returns the arithmetic average of the progress of all assigned sequences. The value will be calculated at runtime.
Implementation public function get progress():Number