Main Page | Packages | Class Tree | Index | Help

xp.data

class XMLConnector

Object
  |
  +--xp.system.DispatcherObject
        |
        +--xp.data.Connector
              |
              +--xp.data.XMLConnector


class XMLConnector
extends Connector

Reads and writes XML documents by using the HTTP GET and POST methods.

The XMLConnector class lets you send or receive XML files using HTTP. You can use ActionScript to bind other components to a data source that returns XML data, allowing communication between the components Event summary for the XMLConnector class
The following table lists events of the XMLConnector class.





EventTypeDescription
xp.events.ProgressEventprogressTriggered while content is loading.
xp.events.EventresultRaised when a result from a call has been received.
xp.events.EventsendRaised when call is made.
xp.events.StatusEventstatusRaised peridodically with status of an operation.
xp.events.ModelChangedEventmodelChangedTriggered when content has been received, support the data binding system.


Author:
ProWin Computers Ltd. - Rob Edgar

Version:
3.0.0.000

See also:


Field Summary

public
direction: String
Indicates whether data is being sent, received, or both.

public
ignoreWhite: Boolean
Indicates whether text nodes containing only white space are discarded during the parsing process.

public
params: XML
Specifies data that will be sent to the server when the next trigger() operation is executed.

public
URL: String
The URL used by the component in HTTP operations.

Fields inherited from class xp.data.Connector

logEnabled, multipleSimultaneousAllowed, results, suppressInvalidCalls

Fields inherited from class xp.system.DispatcherObject

parent

Properties inherited from class xp.data.Connector

callsInProgress, currentItem

Constructor

public
XMLConnector ( )
Create a new XMLConnector instance

Method Summary

public
onRouteEvent ( e: Event )
Pick up events from the XMLLoader object

public
trigger ( ): Boolean
Initiates a remote procedure call

Methods inherited from class xp.data.Connector

onFault, onResult, validateCall

Methods inherited from class xp.system.DispatcherObject

addEventListener, removeEventListener, routeEvent



Field Documentation

direction

public var direction: String
Indicates whether data is being sent, received, or both.

Property; indicates whether data is being sent, received, or both. The values are the following: send XML data for the params property is sent by HTTP POST method to the URL for the XML document. Any data that is returned is ignored. The results property is not set to anything, and there is no result event. Note: The params and results properties and the result event are inherited from the RPC component API. receive No params data is sent to the URL. The URL for the XML document is accessed through HTTP GET, and valid XML data is expected from the URL. send/receive The params data is sent to the URL, and valid XML data is expected from the URL

ignoreWhite

public var ignoreWhite: Boolean
Indicates whether text nodes containing only white space are discarded during the parsing process.

A Boolean value.
When this parameter is set to true, the text nodes that contain only white space are discarded during the parsing process.
Text nodes with leading or trailing white space are unaffected.
The default setting is truew.

params

public var params: XML
Specifies data that will be sent to the server when the next trigger() operation is executed.

Specifies data that will be sent to the server when the next trigger() operation is executed.

URL

public var URL: String
The URL used by the component in HTTP operations.

The URL that this component uses when carrying out HTTP operations.
This URL may be an absolute or relative URL.
The URL is subject to all the standard Flash Player security protections.


Constructor Documentation

XMLConnector

public function XMLConnector()
Create a new XMLConnector instance


Method Documentation

onRouteEvent

public function onRouteEvent(e: Event)
Pick up events from the XMLLoader object

Overrides:

trigger

public function trigger(): Boolean
Initiates a remote procedure call

initiates a remote procedure call.
Each RPC component defines exactly what this involves.
If the operation is successful, the results of the operation appear in the RPC component’s results property.
The trigger() method performs the following steps:
If any data is bound to the params property, the method executes all the bindings to ensure that up-to-date data is available.
This also causes data validation to occur. If the data is not valid and suppressInvalidCalls is set to true, the operation is discontinued. If the operation continues, the send event is emitted. The actual remote call is initiated using the connection method indicated (for example, HTTP).


The documentation was generated from the following file:


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