| Package | system.process |
| Class | public class CoreActionLoader |
| Inheritance | CoreActionLoader CoreAction Task Object |
| Subclasses | ActionLoader, ActionURLLoader, ActionURLStream, SoundLoader |
| Property | Defined By | ||
|---|---|---|---|
| bytesLoaded : uint [read-only]
Indicates the number of bytes that have been loaded thus far during the load operation. | CoreActionLoader | ||
| bytesTotal : uint [read-only]
Indicates the total number of bytes in the downloaded data. | CoreActionLoader | ||
| cache : Boolean
The cache flag of this resource (default is true). | CoreActionLoader | ||
| cacheParameterName : String
The name of the uri query parameter when the cache attribute is true. | CoreActionLoader | ||
![]() | changeIt : Signaler
This signal emit when the notifyChanged method is invoked. | CoreAction | |
![]() | clearIt : Signaler
This signal emit when the notifyCleared method is invoked. | CoreAction | |
| complete : Signaler
This signal emit when the notifyComplete method is invoked. | CoreActionLoader | ||
| DEFAULT_CACHE_PARAMETER : String = random [static]
The name of the default cache uri query parameter ("random"). | CoreActionLoader | ||
| DEFAULT_DELAY : uint = 8000 [static]
The default value of the delay before the ActionEvent.TIMEOUT event (defines in the constructor of the class). | CoreActionLoader | ||
| DEFAULT_TIMEOUT_POLICY : TimeoutPolicy [static]
The default TimeoutPolicy value used to set the timeoutPolicy member of all new objects of this class. | CoreActionLoader | ||
| delay : uint [read-only]
Indicates the timeout interval duration. | CoreActionLoader | ||
| error : Signaler
This signal emit when the notifyError method is invoked. | CoreActionLoader | ||
![]() | finishIt : Signaler
This signal emit when the notifyFinished method is invoked. | Task | |
| httpStatus : Signaler
This signal emit when the notifyHttpStatus method is invoked. | CoreActionLoader | ||
![]() | infoIt : Signaler
This signal emit when the notifyInfo method is invoked. | CoreAction | |
| init : Signaler
This signal emit when the notifyInit method is invoked. | CoreActionLoader | ||
| loader : IEventDispatcher
Indicates the loader object of this process. | CoreActionLoader | ||
![]() | logger : Logger
Determinates the internal Logger reference of this Loggable object. | Task | |
![]() | looping : Boolean
The flag to determinate if the Action object is looped. | CoreAction | |
![]() | loopIt : Signaler
This signal emit when the notifyLooped method is invoked. | CoreAction | |
| open : Signaler
This signal emit when the notifyOpen method is invoked. | CoreActionLoader | ||
![]() | pauseIt : Signaler
This signal emit when the notifyPause method is invoked. | CoreAction | |
![]() | phase : String [read-only]
The current phase of the action. | Task | |
![]() | progressIt : Signaler
This signal emit when the notifyProgress method is invoked. | CoreAction | |
| request : URLRequest
Indicates the URLRequest object who captures all of the information in a single HTTP request. | CoreActionLoader | ||
![]() | resumeIt : Signaler
This signal emit when the notifyResumed method is invoked. | CoreAction | |
![]() | running : Boolean [read-only]
Indicates true if the process is in progress. | Task | |
![]() | startIt : Signaler
This signal emit when the notifyStarted method is invoked. | Task | |
![]() | stopIt : Signaler
This signal emit when the notifyStopped method is invoked. | CoreAction | |
![]() | timeoutIt : Signaler
This signal emit when the notifyTimeOut method is invoked. | CoreAction | |
| timeoutPolicy : TimeoutPolicy
Indicates the timeout policy of the loader. | CoreActionLoader | ||
| Method | Defined By | ||
|---|---|---|---|
CoreActionLoader(loader:IEventDispatcher = null)
Creates a new CoreActionLoader instance. | CoreActionLoader | ||
clone():* [override]
Returns a shallow copy of this object. | CoreActionLoader | ||
close():void
Cancels a load() method operation that is currently in progress for the Loader instance. | CoreActionLoader | ||
![]() | isLocked():Boolean
Returns true if the object is locked. | Task | |
![]() | lock():void
Locks the object. | Task | |
![]() | notifyChanged():void
Notify when the process is changed. | CoreAction | |
![]() | notifyCleared():void
Notify when the process is cleared. | CoreAction | |
notifyComplete():void
Notify when the process is complete. | CoreActionLoader | ||
notifyError(error:Object = null):void
Notify when the process failed. | CoreActionLoader | ||
notifyFinished():void [override]
Notify an ActionEvent when the process is finished. | CoreActionLoader | ||
notifyHttpStatus(status:Object = null):void
Notify when the loading process httpstatus is changed.. | CoreActionLoader | ||
![]() | notifyInfo(info:*):void
Notify a specific information when the process is changed. | CoreAction | |
notifyInit():void
Notify when the process is initialize. | CoreActionLoader | ||
![]() | notifyLooped():void
Notify when the process is looped. | CoreAction | |
notifyOpen():void
Notify when the process is open. | CoreActionLoader | ||
![]() | notifyPaused():void
Notify when the process is paused. | CoreAction | |
![]() | notifyProgress():void
Notify when the process is in progress. | CoreAction | |
![]() | notifyResumed():void
Notify when the process is resumed. | CoreAction | |
notifyStarted():void [override]
Notify an ActionEvent when the process is started. | CoreActionLoader | ||
![]() | notifyStopped():void
Notify when the process is stopped. | CoreAction | |
![]() | notifyTimeOut():void
Notify when the process is out of time. | CoreAction | |
register(dispatcher:IEventDispatcher):void
Register the loader object. | CoreActionLoader | ||
run(... arguments):void [override]
Run the process. | CoreActionLoader | ||
setDelay(time:uint, useSeconds:Boolean = false):void
Sets the timeout interval duration. | CoreActionLoader | ||
![]() | unlock():void
Unlocks the display. | Task | |
unregister(dispatcher:IEventDispatcher):void
Unregisters the loader object. | CoreActionLoader | ||
| Method | Defined By | ||
|---|---|---|---|
_complete(e:Event):void
Invoked when the loading is complete. | CoreActionLoader | ||
_error(e:ErrorEvent):void
Dispatch an ErrorEvent if a call to load() attempts a server problem (IOErrorEvent or SecurityErrorEvent). | CoreActionLoader | ||
_httpStatus(e:HTTPStatusEvent):void
Dispatch HTTPStatusEvent if a call to load() attempts to access data over HTTP and the current Flash Player environment is able to detect and return the status code for the request. | CoreActionLoader | ||
_init(e:Event):void
Invoked when the loading is init. | CoreActionLoader | ||
_open(e:Event):void
Dispatch Event.OPEN event when the download operation commences following a call to the load() method. | CoreActionLoader | ||
_progress(e:ProgressEvent):void
Invoked when the loading is in complete. | CoreActionLoader | ||
_run():void
This protected method contains the invokation of the load method of the current loader of this process. | CoreActionLoader | ||
resolveRequest():void
Resolves the request of the loader with the cache query parameter if the cache attribute is true. | CoreActionLoader | ||
![]() | setRunning(b:Boolean):void
Changes the running property value. | Task | |
| bytesLoaded | property |
bytesLoaded:uint [read-only] Indicates the number of bytes that have been loaded thus far during the load operation.
public function get bytesLoaded():uint| bytesTotal | property |
bytesTotal:uint [read-only] Indicates the total number of bytes in the downloaded data.
public function get bytesTotal():uint| cache | property |
public var cache:BooleanThe cache flag of this resource (default is true).
| cacheParameterName | property |
public var cacheParameterName:StringThe name of the uri query parameter when the cache attribute is true. By default the DEFAULT_CACHE_PARAMETER const is used.
| complete | property |
complete:SignalerThis signal emit when the notifyComplete method is invoked.
public function get complete():Signaler public function set complete(value:Signaler):void| DEFAULT_CACHE_PARAMETER | property |
public static var DEFAULT_CACHE_PARAMETER:String = random
The name of the default cache uri query parameter ("random").
In the loader request you can set an other parameter name with the property cacheParameterName.
| DEFAULT_DELAY | property |
public static var DEFAULT_DELAY:uint = 8000The default value of the delay before the ActionEvent.TIMEOUT event (defines in the constructor of the class).
| DEFAULT_TIMEOUT_POLICY | property |
public static var DEFAULT_TIMEOUT_POLICY:TimeoutPolicyThe default TimeoutPolicy value used to set the timeoutPolicy member of all new objects of this class.
| delay | property |
delay:uint [read-only] Indicates the timeout interval duration.
public function get delay():uint| error | property |
error:SignalerThis signal emit when the notifyError method is invoked.
public function get error():Signaler public function set error(value:Signaler):void| httpStatus | property |
httpStatus:SignalerThis signal emit when the notifyHttpStatus method is invoked.
public function get httpStatus():Signaler public function set httpStatus(value:Signaler):void| init | property |
init:SignalerThis signal emit when the notifyInit method is invoked.
public function get init():Signaler public function set init(value:Signaler):void| loader | property |
loader:IEventDispatcherIndicates the loader object of this process.
public function get loader():IEventDispatcher public function set loader(value:IEventDispatcher):void| open | property |
open:SignalerThis signal emit when the notifyOpen method is invoked.
public function get open():Signaler public function set open(value:Signaler):void| request | property |
request:URLRequestIndicates the URLRequest object who captures all of the information in a single HTTP request.
public function get request():URLRequest public function set request(value:URLRequest):void| timeoutPolicy | property |
timeoutPolicy:TimeoutPolicyIndicates the timeout policy of the loader.
public function get timeoutPolicy():TimeoutPolicy public function set timeoutPolicy(value:TimeoutPolicy):voidSee also
| CoreActionLoader | () | Constructor |
public function CoreActionLoader(loader:IEventDispatcher = null)Creates a new CoreActionLoader instance.
Parametersloader:IEventDispatcher (default = null) — The loader reference.
|
| _complete | () | method |
protected function _complete(e:Event):voidInvoked when the loading is complete.
Parameters
e:Event |
| _error | () | method |
protected function _error(e:ErrorEvent):voidDispatch an ErrorEvent if a call to load() attempts a server problem (IOErrorEvent or SecurityErrorEvent).
Parameters
e:ErrorEvent |
| _httpStatus | () | method |
protected function _httpStatus(e:HTTPStatusEvent):voidDispatch HTTPStatusEvent if a call to load() attempts to access data over HTTP and the current Flash Player environment is able to detect and return the status code for the request.
Parameters
e:HTTPStatusEvent |
| _init | () | method |
protected function _init(e:Event):voidInvoked when the loading is init.
Parameters
e:Event |
| _open | () | method |
protected function _open(e:Event):voidDispatch Event.OPEN event when the download operation commences following a call to the load() method.
Parameters
e:Event |
| _progress | () | method |
protected function _progress(e:ProgressEvent):voidInvoked when the loading is in complete.
Parameters
e:ProgressEvent |
| _run | () | method |
protected function _run():voidThis protected method contains the invokation of the load method of the current loader of this process.
| clone | () | method |
override public function clone():*Returns a shallow copy of this object.
Returns* — a shallow copy of this object.
|
| close | () | method |
public function close():voidCancels a load() method operation that is currently in progress for the Loader instance.
| notifyComplete | () | method |
public function notifyComplete():voidNotify when the process is complete.
| notifyError | () | method |
public function notifyError(error:Object = null):voidNotify when the process failed.
Parameters
error:Object (default = null) |
| notifyFinished | () | method |
override public function notifyFinished():voidNotify an ActionEvent when the process is finished.
| notifyHttpStatus | () | method |
public function notifyHttpStatus(status:Object = null):voidNotify when the loading process httpstatus is changed..
Parameters
status:Object (default = null) |
| notifyInit | () | method |
public function notifyInit():voidNotify when the process is initialize.
| notifyOpen | () | method |
public function notifyOpen():voidNotify when the process is open.
| notifyStarted | () | method |
override public function notifyStarted():voidNotify an ActionEvent when the process is started.
| register | () | method |
public function register(dispatcher:IEventDispatcher):voidRegister the loader object.
Parameters
dispatcher:IEventDispatcher |
| resolveRequest | () | method |
protected function resolveRequest():voidResolves the request of the loader with the cache query parameter if the cache attribute is true.
| run | () | method |
override public function run(... arguments):voidRun the process.
Parameters
... arguments |
| setDelay | () | method |
public function setDelay(time:uint, useSeconds:Boolean = false):voidSets the timeout interval duration.
Parameters
time:uint — The time interval of the timeout limit.
| |
useSeconds:Boolean (default = false) — This optional boolean indicates if the time parameter is in seconds or milliseconds.
|
| unregister | () | method |
public function unregister(dispatcher:IEventDispatcher):voidUnregisters the loader object.
Parameters
dispatcher:IEventDispatcher |