ProgressDelegate

Kind of class: public class
Package:
Inherits from:
  • EventDispatcher
Implements:
Classpath: org.asaplibrary.util.progress.ProgressDelegate
File last modified: Wednesday, 11 May 2011, 22:42:25
Class for monitoring progress of objects that don't provide progress events by themselves. This class sends ProgressEvent type events when a change in the monitored class has occurred. Use: - Create functions in the class to be monitored that provide the part and the total of the progress - Construct the delegate with these functions - Add an event listener for ProgressEvent.PROGRESS to the delegate - Call start() to start monitoring the progress, and stop() when monitoring is no longer necessary If the parameter autoStopWhenFull is true, the delegate stops monitoring automatically when the following conditions have been met: - part is equal to total AND - both part and total are greater than zero If this automatic behaviour is insufficient, provide false as parameter to the constructor and self-regulate stopping the delegate.

Summary

Constructor
  • ProgressDelegate (inPartProvider:Function, inTotalProvider:Function, inAutoStopWhenFull:Boolean = true)
    • Constructor
Instance methods

Constructor

ProgressDelegate

function ProgressDelegate(inPartProvider:Function, inTotalProvider:Function, inAutoStopWhenFull:Boolean = true)

Constructor

Parameters
inPartProvider :function that returns the loaded or played part as uint
inTotalProvider :function that returns the total as uint
inAutoStopWhenFull:if true, progress monitoring will stop automatically when at 100%

Instance methods

addProgressHandler

function addProgressHandler(inHandler:Function) : void

Add a handler for ProgressEvent events →

monitorProgress

function monitorProgress(e:Event = null) : void

Monitor the progress, send a ProgressEvent if necessary

removeProgressHandler

function removeProgressHandler(inHandler:Function) : void

Remove a previously added handler for ProgressEvent events →

start

function start() : void

Start monitoring the progress

stop

function stop() : void

Stop monitoring the progress