DispatchableXml
Kind of class: | class |
---|---|
Inherits from: | CoreXml < XML |
Implements: | |
Known subclasses: | |
Version: | 04/03/07 |
Author: | Aaron Clinger |
Classpath: | org.casalib.xml.DispatchableXml |
File last modified: | Monday, 01 December 2008, 13:34:40 |
Base XML that includes org.casalib.event.EventDispatcher and extends CoreXml.
Summary
Constructor
- DispatchableXml (text:String)
Instance methods
- addEventObserver (scope:Object, eventName:String, eventHandler:String) : Boolean
- Registers a function to receive notification when a event handler is invoked.
- removeEventObserver (scope:Object, eventName:String, eventHandler:String) : Boolean
- Removes specific observer for event.
- removeEventObserversForEvent (eventName:String) : Boolean
- Removes all observers for a specified event.
- removeEventObserversForScope (scope:Object) : Boolean
- Removes all observers in a specified scope.
- removeAllEventObservers : Boolean
- Removes all observers regardless of scope or event.
- dispatchEvent (eventName:String) : Boolean
Constructor
DispatchableXml
function DispatchableXml (text:String)Parameters:text:The XML text parsed to create the new XML object.Instance methods
addEventObserver
function addEventObserver (scope:Object, eventName:String, eventHandler:String) : BooleanRegisters a function to receive notification when a event handler is invoked.#Returns:- Returns {VISDOC_CODE_BLOCK_4} if the observer was established successfully; otherwise {VISDOC_CODE_BLOCK_5}.#
Specified by:destroy
function destroy () : VoidRemoves any internal variables, intervals, enter frames, internal MovieClips and event observers to allow the object to be garbage collected.#
Always call {VISDOC_CODE_BLOCK_0} before deleting last object pointer.Overrides:Specified by:dispatchEvent
function dispatchEvent (eventName:String) : BooleanReports event to all subscribed objects.#Returns:- Returns {VISDOC_CODE_BLOCK_0} if observer(s) listening to specifed event were found; otherwise {VISDOC_CODE_BLOCK_1}.#
Specified by:removeAllEventObservers
function removeAllEventObservers () : BooleanRemoves all observers regardless of scope or event.#Returns:- Returns {VISDOC_CODE_BLOCK_16} if observers were successfully removed; otherwise {VISDOC_CODE_BLOCK_17}.#
removeEventObserver
function removeEventObserver (scope:Object, eventName:String, eventHandler:String) : BooleanRemoves specific observer for event.#Returns:- Returns {VISDOC_CODE_BLOCK_8} if the observer was successfully found and removed; otherwise {VISDOC_CODE_BLOCK_9}.#
removeEventObserversForEvent
function removeEventObserversForEvent (eventName:String) : BooleanRemoves all observers for a specified event.#removeEventObserversForScope
function removeEventObserversForScope (scope:Object) : BooleanRemoves all observers in a specified scope.#
- removeAllEventObservers : Boolean
- removeEventObserversForScope (scope:Object) : Boolean
- removeEventObserversForEvent (eventName:String) : Boolean
- removeEventObserver (scope:Object, eventName:String, eventHandler:String) : Boolean