Main Page | Packages | Class Tree | Index | Help

xp.data

class XMLLoader

Object
  |
  +--xp.system.DispatcherObject
        |
        +--xp.data.XMLLoader


class XMLLoader
extends DispatcherObject

An xml document loader

An object for loading xml objects
Event summary for the XMLLoader class
The following table lists events of the XMLLoader class.




EventTypeDescription
xp.events.ProgressEventprogressTriggered while content is loading.
xp.events.ResultEventresultRaised when a result from a call has been received.
xp.events.FaultEventfaultRaised when there has been an error loading or parsing the document.
xp.events.ResultEventloadinvoked by Flash Player when an XML document is received from the server.


Author:
ProWin Computers Ltd. - Rob Edgar

Version:
3.0.0.000

See also:


Fields inherited from class xp.system.DispatcherObject

parent

Constructor

public
XMLLoader ( parent: Object)
Create a new instance

Method Summary

public
load ( url: String, target: XML ): XML
Loads a document (specified by the XML object) from a URL.

public
send ( url: String, params: XML, window: String ): Void
Sends the specified XML object to a URL.

public
sendAndLoad ( url: String, params: XML, target: XML ): XML
Sends the specified XML object to a URL, and loads the server response into another XML object.

Methods inherited from class xp.system.DispatcherObject

addEventListener, removeEventListener, routeEvent



Constructor Documentation

XMLLoader

public function XMLLoader(parent: Object)
Create a new instance

Parameters:
parent
The parent of this object

Method Documentation

load

public function load(url: String,
 target: XML): XML
Loads a document (specified by the XML object) from a URL.

Parameters:
url
A string; the destination URL for the specified XML object. If the SWF file issuing this call is running in a web browser, url must be in the same domain as the SWF file; for details, see the Description section.
target
Returns:
The xml object being loaded

send

public function send(url: String,
 params: XML,
 window: String): Void
Sends the specified XML object to a URL.

Parameters:
url
A string; the destination URL for the specified XML object. If the SWF file issuing this call is running in a web browser, url must be in the same domain as the SWF file; for details, see the Description section.
params
window
String; the browser window to show data that the server returns: _self specifies the current frame in the current window. _blank specifies a new window. _parent specifies the parent of the current frame. _top specifies the top-level frame in the current window. This parameter is optional; if you do not specify a window parameter, it is the same as specifying _self.

sendAndLoad

public function sendAndLoad(url: String,
 params: XML,
 target: XML): XML
Sends the specified XML object to a URL, and loads the server response into another XML object.

Parameters:
url
A string; the destination URL for the specified XML object. If the SWF file issuing this call is running in a web browser, url must be in the same domain as the SWF file; for details, see the Description section.
params
target
An XML object created with the XML constructor method that will receive the return information from the server.
Returns:
The xml object being loaded


The documentation was generated from the following file:


Generated on 10/30/2005 9:34:02 PM by AS2Doc