Packagecom.sibirjak.angara.core
Classpublic class AbstractProgressInfo
InheritanceAbstractProgressInfo Inheritance flash.events.EventDispatcher
ImplementsIProgressInfo
SubclassesAbstractLoaderItem, Monitor

Abstract implementation of the IProgressInfo interface.



Public Properties
 PropertyDefined by
  numItems : uint
[read-only] Returns the number of items to be loaded within the loader item.
AbstractProgressInfo
  numItemsFailed : uint
[read-only] Returns the number of items failed within the loader item.
AbstractProgressInfo
  numItemsLoaded : uint
[read-only] Returns the number of items loaded within the loader item.
AbstractProgressInfo
  progress : Number
[read-only] Returns the progress of the loader item as a decimal value between zero and 1.
AbstractProgressInfo
Protected Properties
 PropertyDefined by
  _numItems : uint = 0
The number of items added.
AbstractProgressInfo
  _numItemsFailed : uint = 0
The number of items failed loading.
AbstractProgressInfo
  _numItemsLoaded : uint = 0
The number of items alredy loaded.
AbstractProgressInfo
  _progress : Number = 0
The overall progress of the item.
AbstractProgressInfo
Property detail
_numItemsproperty
protected var _numItems:uint = 0

The number of items added.

numItemsproperty 
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
_numItemsFailedproperty 
protected var _numItemsFailed:uint = 0

The number of items failed loading.

numItemsFailedproperty 
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
_numItemsLoadedproperty 
protected var _numItemsLoaded:uint = 0

The number of items alredy loaded.

numItemsLoadedproperty 
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
_progressproperty 
protected var _progress:Number = 0

The overall progress of the item.

progressproperty 
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