ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
mx.rpc.events 

XMLLoadEvent  - AS3 Flex
Packagemx.rpc.events
Classpublic class XMLLoadEvent
InheritanceXMLLoadEvent Inheritance Event Inheritance Object
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
 PropertyDefined By
 Inheritedbubbles : Boolean
[read-only] Indicates whether an event is a bubbling event.
Event
 Inheritedcancelable : Boolean
[read-only] Indicates whether the behavior associated with the event can be prevented.
Event
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcurrentTarget : Object
[read-only] The object that is actively processing the Event object with an event listener.
Event
 InheritedeventPhase : uint
[read-only] The current phase in the event flow.
Event
  location : String
The location from which the document was loaded.
XMLLoadEvent
 Inheritedtarget : Object
[read-only] The event target.
Event
 Inheritedtype : String
[read-only] The type of event.
Event
  xml : XML
The raw XML document.
XMLLoadEvent
Public Methods
 MethodDefined 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
 Inherited
formatToString(className:String, ... arguments):String
A utility function for implementing the toString() method in custom ActionScript 3.0 Event classes.
Event
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 Inherited
isDefaultPrevented():Boolean
Checks whether the preventDefault() method has been called on the event.
Event
 Inherited
isPrototypeOf(theClass:Object):Boolean
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
preventDefault():void
Cancels an event's default behavior if that behavior can be canceled.
Event
 Inherited
propertyIsEnumerable(name:String):Boolean
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
stopImmediatePropagation():void
Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
Event
 Inherited
stopPropagation():void
Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
Event
 Inherited
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
  
toString():String
[override] Returns a String representation of this XMLLoadEvent object.
XMLLoadEvent
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
Public Constants
 ConstantDefined 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:

PropertyValue
bubblesfalse
cancelabletrue
currentTargetThe 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.
locationThe location from which the document was loaded.
targetThe 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.
xmlThe raw XML document.



© 2014 Adobe Systems Incorporated. All rights reserved.
Thu Dec 4 2014, 05:50 PM -08:00
 

 

Legal Notices | Online Privacy Policy