GODPAPER | All Packages | All Classes | Index | Frames No Frames |
XMLNotifier

Package | mx.utils
Class | public class XMLNotifier
Inheritance | XMLNotifier 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 Methods

| Method | Defined By
--- | --- | ---
|  | XMLNotifier(x:XMLNotifierSingleton) Constructor. | XMLNotifier
|  | getInstance():XMLNotifier [static] Get the singleton instance of the XMLNotifier. | XMLNotifier
|  | unwatchXML(xml:Object, notifiable:IXMLNotifiable):void Given an XML or XMLList, remove the specified notification function. | XMLNotifier
|  | 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

Thu Jan 16 2014, 01:11 PM +08:00