Access keys

EventXml

Kind of class: class
Inherits from: CoreXml < XML
Implements:
Version: 02/06/07
Author: Aaron Clinger, Mike Creighton
Classpath: org.casaframework.xml.EventXml
File last modified: Wednesday, 07 February 2007, 09:40:44
Events broadcast to listeners:
onData = function (sender:EventSound, src:String) {}
onHttpStatus = function (sender:EventSound, httpStatus:Number) {}
onLoad = function (sender:EventXml, success:Boolean, status:Number) {}

Constructor

EventXml

function EventXml (
text:String)
Parameters:
text:
The XML text parsed to create the new XML object.

Class properties

EVENT_DATA

static EVENT_DATA:String = 'onData'
(read,write)

EVENT_HTTP_STATUS

static EVENT_HTTP_STATUS:String = 'onHttpStatus'
(read,write)

EVENT_LOAD

static EVENT_LOAD:String = 'onLoad'
(read,write)

Instance methods

addEventObserver

function addEventObserver (
scope:Object, eventName:String, eventHandler:String) : Boolean
Registers a function to receive notification when a event handler is invoked.
#
Parameters:
scope :
The target or object in which to subscribe.
#
eventName :
Event name to subscribe to.
#
eventHandler:
[optional] Name of function to recieve the event. If undefined class assumes eventHandler matches eventName.
#
Returns:
Returns true if the observer was established successfully; otherwise false.
#

destroy

function destroy (
) : Void
Removes any internal variables, intervals, enter frames, internal MovieClips and event observers to allow the object to be garbage collected.

Always call destroy() before deleting last object pointer.
#

dispatchEvent

function dispatchEvent (
eventName:String) : Boolean
Reports event to all subscribed objects.
#
Parameters:
eventName:
Event name.
#
param(s) :
[optional] Parameters passed to the function specified by "eventName". Multiple parameters are allowed and should be separated by commas: param1,param2, ...,paramN
#
Returns:
Returns true if observer(s) listening to specifed event were found; otherwise false.
#

removeAllEventObservers

function removeAllEventObservers (
) : Boolean
Removes all observers regardless of scope or event.
#
Returns:
Returns true if observers were successfully removed; otherwise false.
#

removeEventObserver

function removeEventObserver (
scope:Object, eventName:String, eventHandler:String) : Boolean
Removes specific observer for event.
#
Parameters:
scope :
The target or object in which subscribed.
#
eventName :
Event name to unsubscribe to.
#
eventHandler:
[optional] Name of function that recieved the event. If undefined class assumes eventHandler matched eventName.
#
Returns:
Returns true if the observer was successfully found and removed; otherwise false.
#

removeEventObserversForEvent

function removeEventObserversForEvent (
eventName:String) : Boolean
Removes all observers for a specified event.
#
Parameters:
eventName:
Event name to unsubscribe to.
#
Returns:
Returns true if observers were successfully found for specified eventName and removed; otherwise false.
#

removeEventObserversForScope

function removeEventObserversForScope (
scope:Object) : Boolean
Removes all observers in a specified scope.
#
Parameters:
scope:
The target or object in which to unsubscribe.
#
Returns:
Returns true if observers were successfully found in scope and removed; otherwise false.
#