Packagecouk.markstar.starrequests.requests
Classpublic class LoadXMLRequest
InheritanceLoadXMLRequest Inheritance AbstractRequest Inheritance Object

A request to load an XML file.



Public Properties
 PropertyDefined By
 Inheritedcancelled : ISignal
[read-only] The instance of the failed signal for this request
AbstractRequest
  completed : ISignal
[override] [read-only] The instance of the completed signal for this request
LoadXMLRequest
 Inheritedfailed : ISignal
[read-only] The instance of the failed signal for this request
AbstractRequest
 Inheritedprogress : ISignal
[read-only] The instance of the progress signal for this request
AbstractRequest
 Inheritedstarted : ISignal
[read-only] The instance of the started signal for this request
AbstractRequest
Protected Properties
 PropertyDefined By
  _loader : URLLoader
LoadXMLRequest
  _url : String
LoadXMLRequest
Public Methods
 MethodDefined By
  
LoadXMLRequest(url:String)
LoadXMLRequest
  
cancel():void
[override] Call this function to cancel the request.
LoadXMLRequest
  
send():void
[override] Call this function to execute the request.
LoadXMLRequest
Protected Methods
 MethodDefined By
 Inherited
cleanup():void
A cleanup function.
AbstractRequest
 Inherited
dispatchFailed(message:String):void
Helper function for sending the failed signal.
AbstractRequest
Property Detail
_loaderproperty
protected var _loader:URLLoader

_urlproperty 
protected var _url:String

completedproperty 
completed:ISignal  [read-only] [override]

The instance of the completed signal for this request


Implementation
    public function get completed():ISignal

Example
The following code demonstrates a listener for the completed signal:
           protected function completedListener( xml:XML ):void
           {
           // function implementation
           }
           
Constructor Detail
LoadXMLRequest()Constructor
public function LoadXMLRequest(url:String)

Parameters
url:String — The URL of the XML file to load.
Method Detail
cancel()method
override public function cancel():void

Call this function to cancel the request. The cleanup method is then executed. This method should be overridden in subclasses, but ensure to call super.cancel() when overriding. Note that it is recommended to call super.cancel at the end of the method in the subclass.

send()method 
override public function send():void

Call this function to execute the request. The started and progress signals are both dispatched. This method should be overridden in subclasses, but ensure to call super.send() when overriding.