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

XMLNotifier  - AS3 Flex
Packagemx.utils
Classpublic class XMLNotifier
InheritanceXMLNotifier Inheritance Object

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Used for watching changes to XML and XMLList objects. Those objects are not EventDispatchers, so if multiple elements want to watch for changes they need to go through this mechanism. Call watchXML(), passing in the same notification function that you would pass to XML.notification. Use unwatchXML() to remove that notification.


Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
Public Methods
 MethodDefined By
  
XMLNotifier(x:XMLNotifierSingleton)
Constructor.
XMLNotifier
  
getInstance():XMLNotifier
[static] Get the singleton instance of the XMLNotifier.
XMLNotifier
 Inherited
hasOwnProperty(name:String):Boolean
Indicates whether an object has a specified property defined.
Object
 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
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
toLocaleString():String
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
toString():String
Returns the string representation of the specified object.
Object
  
unwatchXML(xml:Object, notifiable:IXMLNotifiable):void
Given an XML or XMLList, remove the specified notification function.
XMLNotifier
 Inherited
valueOf():Object
Returns the primitive value of the specified object.
Object
  
watchXML(xml:Object, notifiable:IXMLNotifiable, uid:String = null):void
Given an XML or XMLList, add the notification function to watch for changes.
XMLNotifier
Constructor Detail

XMLNotifier

()Constructor
public function XMLNotifier(x:XMLNotifierSingleton)

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Constructor. XMLNotifier is a singleton class, so you do not use the new operator to create multiple instances of it. Instead, call the static method XMLNotifider.getInstance() to get the sole instance of this class.

Parameters
x:XMLNotifierSingleton
Method Detail

getInstance

()method
public static function getInstance():XMLNotifier

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Get the singleton instance of the XMLNotifier.

Returns
XMLNotifier — The XMLNotifier object.

unwatchXML

()method 
public function unwatchXML(xml:Object, notifiable:IXMLNotifiable):void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Given an XML or XMLList, remove the specified notification function.

Parameters

xml:Object — XML/XMLList object to un-watch.
 
notifiable:IXMLNotifiable — Function notification function.

watchXML

()method 
public function watchXML(xml:Object, notifiable:IXMLNotifiable, uid:String = null):void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Given an XML or XMLList, add the notification function to watch for changes.

Parameters

xml:Object — XML/XMLList object to watch.
 
notifiable:IXMLNotifiable — Function that needs to be called.
 
uid:String (default = null) — UID for object



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

 

Legal Notices | Online Privacy Policy