Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
XMLLoadEvent

Package | mx.rpc.events
Class | public class XMLLoadEvent
Inheritance | XMLLoadEvent flash.events.Event
Subclasses | WSDLLoadEvent

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The XMLLoadEvent class is a base class for events that are dispatched when an RPC service successfully loaded an XML document.

Public Properties

| Property | Defined By
--- | --- | ---
|  | location : String The location from which the document was loaded. | XMLLoadEvent
|  | xml : XML The raw XML document. | XMLLoadEvent

Public Methods

| Method | Defined By
--- | --- | ---
|  | XMLLoadEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = true, xml:XML = null, location:String = null) Constructor. | XMLLoadEvent
|  | clone():Event [override] Returns a copy of this XMLLoadEvent object. | XMLLoadEvent
|  | toString():String [override] Returns a String representation of this XMLLoadEvent object. | XMLLoadEvent

Public Constants

| Constant | Defined By
--- | --- | ---
|  | LOAD : String = xmlLoad [static] The LOAD constant defines the value of the type property of the event object for a xmlLoad event. | XMLLoadEvent

Property Detail

location | property

`public var location:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The location from which the document was loaded.

xml | property |

`public var xml:XML`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The raw XML document.

Constructor Detail

XMLLoadEvent | () | Constructor

`public function XMLLoadEvent(type:String, bubbles:Boolean = false, cancelable:Boolean = true, xml:XML = null, location:String = null)`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Constructor.

Parameters

| `type:String` — The event type; indicates the action that triggered the event.
| `bubbles:Boolean` (default = `false`)`` — Specifies whether the event can bubble up the display list hierarchy.
| `cancelable:Boolean` (default = `true`)`` — Specifies whether the behavior associated with the event can be prevented.
| `xml:XML` (default = `null`)`` — The XML document loaded.
| `location:String` (default = `null`)`` — The path used to load the document.

Method Detail

clone | () | method

`override public function clone():Event`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Returns a copy of this XMLLoadEvent object.

Returns

| `Event` — A copy of this XMLLoadEvent object.

toString | () | method |

`override public function toString():String`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Returns a String representation of this XMLLoadEvent object.

Returns

| `String` — A String representation of this XMLLoadEvent object.

Constant Detail

LOAD | Constant

`public static const LOAD:String = xmlLoad`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The LOAD constant defines the value of the `type` property of the event object for a `xmlLoad` event.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | `false`
`cancelable` | `true`
`currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`location` | The location from which the document was loaded.
`target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.
`xml` | The raw XML document.

Sun Mar 5 2017, 03:42 PM +11:00