Packagebr.com.stimuli.loading
Classpublic class BulkProgressEvent
InheritanceBulkProgressEvent Inheritance flash.events.ProgressEvent

Language Version : ActionScript 3.0
Since : 15.09.2007
Runtime Versions : AIR 1.0, Flash Player 9.0

An event that holds information about the status of a BulkLoader. As this event subclasses ProgressEvent, you can choose to listen to BulkProgressEvent or ProgressEvent instances, but this class provides more useful information about loading status.



Public Properties
 PropertyDefined By
  bytesTotalCurrent : int
How many bytes have loaded so far.
BulkProgressEvent
  itemsLoaded : int
Number of items already loaded
BulkProgressEvent
  itemsTotal : int
Number of items to be loaded
BulkProgressEvent
  name : String
BulkProgressEvent
  percentLoaded : Number
A number between 0 - 1 that indicates progress regarding bytes
BulkProgressEvent
  ratioLoaded : Number
The ratio (0-1) loaded (number of items loaded / number of items total)
BulkProgressEvent
  weightPercent : Number
A number between 0 - 1 that indicates progress regarding weights
BulkProgressEvent
Public Methods
 MethodDefined By
  
BulkProgressEvent(name:String, bubbles:Boolean = true, cancelable:Boolean = false)
BulkProgressEvent
  
clone():Event
[override]
BulkProgressEvent
  
loadingStatus():String
Returns a String will all available information for this event.
BulkProgressEvent
  
setInfo(bytesLoaded:int, bytesTotal:int, bytesTotalCurrent:int, itemsLoaded:int, itemsTotal:int, weightPercent:Number):void
Sets loading information.
BulkProgressEvent
  
toString():String
[override]
BulkProgressEvent
Public Constants
 ConstantDefined By
  COMPLETE : String = complete
[static]
BulkProgressEvent
  PROGRESS : String = progress
[static]
BulkProgressEvent
Property Detail
bytesTotalCurrentproperty
public var bytesTotalCurrent:int

How many bytes have loaded so far.

itemsLoadedproperty 
public var itemsLoaded:int

Number of items already loaded

itemsTotalproperty 
public var itemsTotal:int

Number of items to be loaded

nameproperty 
public var name:String

percentLoadedproperty 
percentLoaded:Number

A number between 0 - 1 that indicates progress regarding bytes


Implementation
    public function get percentLoaded():Number
    public function set percentLoaded(value:Number):void
ratioLoadedproperty 
ratioLoaded:Number

The ratio (0-1) loaded (number of items loaded / number of items total)


Implementation
    public function get ratioLoaded():Number
    public function set ratioLoaded(value:Number):void
weightPercentproperty 
weightPercent:Number

A number between 0 - 1 that indicates progress regarding weights


Implementation
    public function get weightPercent():Number
    public function set weightPercent(value:Number):void
Constructor Detail
BulkProgressEvent()Constructor
public function BulkProgressEvent(name:String, bubbles:Boolean = true, cancelable:Boolean = false)



Parameters
name:String
 
bubbles:Boolean (default = true)
 
cancelable:Boolean (default = false)
Method Detail
clone()method
override public function clone():Event

Returns
Event
loadingStatus()method 
public function loadingStatus():String

Returns a String will all available information for this event.

Returns
String — A String will loading information.
setInfo()method 
public function setInfo(bytesLoaded:int, bytesTotal:int, bytesTotalCurrent:int, itemsLoaded:int, itemsTotal:int, weightPercent:Number):void

Sets loading information.

Parameters

bytesLoaded:int
 
bytesTotal:int
 
bytesTotalCurrent:int
 
itemsLoaded:int
 
itemsTotal:int
 
weightPercent:Number

toString()method 
override public function toString():String

Returns
String
Constant Detail
COMPLETEConstant
public static const COMPLETE:String = complete

PROGRESSConstant 
public static const PROGRESS:String = progress