Packagesystem.process
Classpublic class ActionURLLoader
InheritanceActionURLLoader Inheritance CoreActionLoader Inheritance CoreAction Inheritance Task Inheritance Object
Subclasses CoreConfigLoader, CoreLocalizationLoader

This action process launch the load of a URLLoader object.

Example : 

     import system.events.ActionEvent ;
     import system.process.ActionURLLoader ;
     
     import system.eden ;
     
     import flash.net.URLLoader ;
     import flash.net.URLRequest ;
     
     var url:String = "data/config.eden" ;
     
     var loader:URLLoader = new URLLoader() ;
     
     var start:Function = function( action:Action ):void
     {
        trace( "start" ) ;
     }
     
     var finish:Function = function( e:Event ):void
     {
         trace( "finish" ) ;
         
         var data:= eden.deserialize( process.data ) ;
         
         for (var prop:String in data)
         {
             trace("  > " + prop + " : " + data[prop]) ;
         }
     }
     
     var process:ActionURLLoader = new ActionURLLoader( loader ) ;
     
     process.startIt.connect( start ) ;
     process.finishIt.connect( finish ) ;
     
     process.request = new URLRequest( url ) ;
     
     process.run() ;


Public Properties
 PropertyDefined By
  bytesLoaded : uint
[override] [read-only] Indicates the number of bytes that have been loaded thus far during the load operation.
ActionURLLoader
  bytesTotal : uint
[override] [read-only] Indicates the total number of bytes in the downloaded data.
ActionURLLoader
 Inheritedcache : Boolean
The cache flag of this resource (default is true).
CoreActionLoader
 InheritedcacheParameterName : String
The name of the uri query parameter when the cache attribute is true.
CoreActionLoader
 InheritedchangeIt : Signaler
This signal emit when the notifyChanged method is invoked.
CoreAction
 InheritedclearIt : Signaler
This signal emit when the notifyCleared method is invoked.
CoreAction
 Inheritedcomplete : Signaler
This signal emit when the notifyComplete method is invoked.
CoreActionLoader
  data : *
Indicates the data received from the load operation.
ActionURLLoader
  dataFormat : String
Controls whether the downloaded data is received as - text (URLLoaderDataFormat.TEXT), - raw binary data (URLLoaderDataFormat.BINARY) - URL-encoded variables (URLLoaderDataFormat.VARIABLES).
ActionURLLoader
 InheritedDEFAULT_CACHE_PARAMETER : String = random
[static] The name of the default cache uri query parameter ("random").
CoreActionLoader
 InheritedDEFAULT_DELAY : uint = 8000
[static] The default value of the delay before the ActionEvent.TIMEOUT event (defines in the constructor of the class).
CoreActionLoader
 InheritedDEFAULT_TIMEOUT_POLICY : TimeoutPolicy
[static] The default TimeoutPolicy value used to set the timeoutPolicy member of all new objects of this class.
CoreActionLoader
 Inheriteddelay : uint
[read-only] Indicates the timeout interval duration.
CoreActionLoader
 Inheritederror : Signaler
This signal emit when the notifyError method is invoked.
CoreActionLoader
 InheritedfinishIt : Signaler
This signal emit when the notifyFinished method is invoked.
Task
 InheritedhttpStatus : Signaler
This signal emit when the notifyHttpStatus method is invoked.
CoreActionLoader
 InheritedinfoIt : Signaler
This signal emit when the notifyInfo method is invoked.
CoreAction
 Inheritedinit : Signaler
This signal emit when the notifyInit method is invoked.
CoreActionLoader
  isCollapse : Boolean
Indicated if the console use collapse property or not.
ActionURLLoader
 Inheritedloader : IEventDispatcher
Indicates the loader object of this process.
CoreActionLoader
 Inheritedlogger : Logger
Determinates the internal Logger reference of this Loggable object.
Task
 Inheritedlooping : Boolean
The flag to determinate if the Action object is looped.
CoreAction
 InheritedloopIt : Signaler
This signal emit when the notifyLooped method is invoked.
CoreAction
  maxDepth : uint
Determinates the max depth to collaspe the structure of an object in the console.
ActionURLLoader
  MAX_DEPTH_RANGE : Range
[static] The range of the max depth value.
ActionURLLoader
 Inheritedopen : Signaler
This signal emit when the notifyOpen method is invoked.
CoreActionLoader
  parsing : Boolean
Activate or disactivate parsing (Use this with XML, EDEN, JSON...).
ActionURLLoader
 InheritedpauseIt : Signaler
This signal emit when the notifyPause method is invoked.
CoreAction
 Inheritedphase : String
[read-only] The current phase of the action.
Task
 InheritedprogressIt : Signaler
This signal emit when the notifyProgress method is invoked.
CoreAction
 Inheritedrequest : URLRequest
Indicates the URLRequest object who captures all of the information in a single HTTP request.
CoreActionLoader
 InheritedresumeIt : Signaler
This signal emit when the notifyResumed method is invoked.
CoreAction
 Inheritedrunning : Boolean
[read-only] Indicates true if the process is in progress.
Task
  SPACE : String =
[static] The space string use to format the debugs.
ActionURLLoader
 InheritedstartIt : Signaler
This signal emit when the notifyStarted method is invoked.
Task
 InheritedstopIt : Signaler
This signal emit when the notifyStopped method is invoked.
CoreAction
 InheritedtimeoutIt : Signaler
This signal emit when the notifyTimeOut method is invoked.
CoreAction
 InheritedtimeoutPolicy : TimeoutPolicy
Indicates the timeout policy of the loader.
CoreActionLoader
  verbose : Boolean
Indicates the flag of the verbose mode.
ActionURLLoader
Public Methods
 MethodDefined By
  
ActionURLLoader(loader:URLLoader = null)
Creates a new ActionURLLoader instance.
ActionURLLoader
  
clone():*
[override] Returns a shallow copy of this object.
ActionURLLoader
  
close():void
[override] Cancels a load() method operation that is currently in progress for the Loader instance.
ActionURLLoader
  
enumerate(o:Object):void
Enumerates the specified object.
ActionURLLoader
 Inherited
isLocked():Boolean
Returns true if the object is locked.
Task
 Inherited
lock():void
Locks the object.
Task
 Inherited
notifyChanged():void
Notify when the process is changed.
CoreAction
 Inherited
notifyCleared():void
Notify when the process is cleared.
CoreAction
 Inherited
notifyComplete():void
Notify when the process is complete.
CoreActionLoader
 Inherited
notifyError(error:Object = null):void
Notify when the process failed.
CoreActionLoader
 Inherited
notifyFinished():void
[override] Notify an ActionEvent when the process is finished.
CoreActionLoader
 Inherited
notifyHttpStatus(status:Object = null):void
Notify when the loading process httpstatus is changed..
CoreActionLoader
 Inherited
notifyInfo(info:*):void
Notify a specific information when the process is changed.
CoreAction
 Inherited
notifyInit():void
Notify when the process is initialize.
CoreActionLoader
 Inherited
notifyLooped():void
Notify when the process is looped.
CoreAction
 Inherited
notifyOpen():void
Notify when the process is open.
CoreActionLoader
 Inherited
notifyPaused():void
Notify when the process is paused.
CoreAction
 Inherited
notifyProgress():void
Notify when the process is in progress.
CoreAction
 Inherited
notifyResumed():void
Notify when the process is resumed.
CoreAction
 Inherited
notifyStarted():void
[override] Notify an ActionEvent when the process is started.
CoreActionLoader
 Inherited
notifyStopped():void
Notify when the process is stopped.
CoreAction
 Inherited
notifyTimeOut():void
Notify when the process is out of time.
CoreAction
  
parse():void
Override this method.
ActionURLLoader
 Inherited
register(dispatcher:IEventDispatcher):void
Register the loader object.
CoreActionLoader
 Inherited
run(... arguments):void
[override] Run the process.
CoreActionLoader
 Inherited
setDelay(time:uint, useSeconds:Boolean = false):void
Sets the timeout interval duration.
CoreActionLoader
 Inherited
unlock():void
Unlocks the display.
Task
 Inherited
unregister(dispatcher:IEventDispatcher):void
Unregisters the loader object.
CoreActionLoader
Protected Methods
 MethodDefined By
  
_complete(e:Event):void
[override] Dispatch an Event.COMPLETE event after all the received data is decoded and placed in the data property.
ActionURLLoader
 Inherited
_error(e:ErrorEvent):void
Dispatch an ErrorEvent if a call to load() attempts a server problem (IOErrorEvent or SecurityErrorEvent).
CoreActionLoader
 Inherited
_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
 Inherited
_init(e:Event):void
Invoked when the loading is init.
CoreActionLoader
 Inherited
_open(e:Event):void
Dispatch Event.OPEN event when the download operation commences following a call to the load() method.
CoreActionLoader
 Inherited
_progress(e:ProgressEvent):void
Invoked when the loading is in complete.
CoreActionLoader
  
_run():void
[override] This protected method contains the invokation of the load method of the current loader of this process.
ActionURLLoader
 Inherited
resolveRequest():void
Resolves the request of the loader with the cache query parameter if the cache attribute is true.
CoreActionLoader
 Inherited
setRunning(b:Boolean):void
Changes the running property value.
Task
Property Detail
bytesLoadedproperty
bytesLoaded:uint  [read-only] [override]

Indicates the number of bytes that have been loaded thus far during the load operation.


Implementation
    public function get bytesLoaded():uint
bytesTotalproperty 
bytesTotal:uint  [read-only] [override]

Indicates the total number of bytes in the downloaded data.


Implementation
    public function get bytesTotal():uint
dataproperty 
data:*

Indicates the data received from the load operation.


Implementation
    public function get data():*
    public function set data(value:any):void
dataFormatproperty 
dataFormat:String

Controls whether the downloaded data is received as - text (URLLoaderDataFormat.TEXT), - raw binary data (URLLoaderDataFormat.BINARY) - URL-encoded variables (URLLoaderDataFormat.VARIABLES).


Implementation
    public function get dataFormat():String
    public function set dataFormat(value:String):void
isCollapseproperty 
public var isCollapse:Boolean

Indicated if the console use collapse property or not.

MAX_DEPTH_RANGEproperty 
public static var MAX_DEPTH_RANGE:Range

The range of the max depth value.

maxDepthproperty 
maxDepth:uint

Determinates the max depth to collaspe the structure of an object in the console.


Implementation
    public function get maxDepth():uint
    public function set maxDepth(value:uint):void
parsingproperty 
parsing:Boolean

Activate or disactivate parsing (Use this with XML, EDEN, JSON...).


Implementation
    public function get parsing():Boolean
    public function set parsing(value:Boolean):void
SPACEproperty 
public static var SPACE:String =

The space string use to format the debugs.

verboseproperty 
public var verbose:Boolean

Indicates the flag of the verbose mode.

Constructor Detail
ActionURLLoader()Constructor
public function ActionURLLoader(loader:URLLoader = null)

Creates a new ActionURLLoader instance.

Parameters
loader:URLLoader (default = null) — The URLLoader object to load.
Method Detail
_complete()method
override protected function _complete(e:Event):void

Dispatch an Event.COMPLETE event after all the received data is decoded and placed in the data property.

Parameters

e:Event

_run()method 
override protected function _run():void

This 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 
override public function close():void

Cancels a load() method operation that is currently in progress for the Loader instance.

enumerate()method 
public function enumerate(o:Object):void

Enumerates the specified object.

Parameters

o:Object

parse()method 
public function parse():void

Override this method. Parse your datas when loading is complete.





Mardi Août 16 2011, 02:33 PM +02:00