Packageorg.igniterealtime.xiff.data.whiteboard
Classpublic class WhiteboardExtension
InheritanceWhiteboardExtension Inheritance Extension Inheritance XMLStanza Inheritance ExtensionContainer
ImplementsIExtension

A message extension for whitboard exchange. This class is the base class for other extension classes such as Path All child whiteboard objects are contained and serialized by this class



Public Properties
 PropertyDefined by
 Inherited_exts : Object
ExtensionContainer
  paths : Array
[read-only] The paths available in this whiteboard message
WhiteboardExtension
 InheritedXMLData : XML
[static]
XMLStanza
 InheritedXMLFactory : XMLDocument
[static]
XMLStanza
Public Methods
 MethodDefined by
  
WhiteboardExtension(parent:XMLNode = null)
WhiteboardExtension
 Inherited
ExtensionContainer
 Inherited
addTextNode(parent:XMLNode, elementName:String, value:String):XMLNode
Adds a simple text node to the parent node specified.
XMLStanza
  
deserialize(node:XMLNode):Boolean
Deserializes the WhiteboardExtension data.
WhiteboardExtension
  
enable():void
[static] Performs the registration of this extension into the extension registry.
WhiteboardExtension
 Inherited
ensureNode(node:XMLNode, elementName:String):XMLNode
Ensures that a node with a specific element name exists in the stanza.
XMLStanza
 Inherited
exists(value:*):Boolean
[static] A helper method to determine if a value is both not null and not undefined.
XMLStanza
 Inherited
ExtensionContainer
 Inherited
getAllExtensionsByNS(ns:String):Array
ExtensionContainer
  
getElementName():String
Gets the element name associated with this extension.
WhiteboardExtension
 Inherited
getExtension(name:String):Extension
ExtensionContainer
 Inherited
getNode():XMLNode
XMLStanza
  
getNS():String
Gets the namespace associated with this extension.
WhiteboardExtension
 Inherited
remove():void
Removes the extension from its parent.
Extension
 Inherited
removeAllExtensions(ns:String):void
ExtensionContainer
 Inherited
ExtensionContainer
 Inherited
replaceTextNode(parent:XMLNode, original:XMLNode, elementName:String, value:String):XMLNode
Replaces one node in the stanza with another simple text node.
XMLStanza
  
serialize(parent:XMLNode):Boolean
Serializes the WhiteboardExtension data to XML for sending.
WhiteboardExtension
 Inherited
setNode(node:XMLNode):Boolean
Sets the XML node that should be used for this stanza's internal XML representation.
XMLStanza
 Inherited
toString():String
Converts the extension stanza XML to a string.
Extension
Public Constants
 ConstantDefined by
  ELEMENT_NAME : String = "x"
[static]
WhiteboardExtension
  NS : String = "xiff:wb"
[static]
WhiteboardExtension
Property detail
pathsproperty
paths:Array  [read-only]

The paths available in this whiteboard message

Implementation
    public function get paths():Array
Constructor detail
WhiteboardExtension()constructor
public function WhiteboardExtension(parent:XMLNode = null)Parameters
parent:XMLNode (default = null)
Method detail
deserialize()method
public function deserialize(node:XMLNode):Boolean

Deserializes the WhiteboardExtension data.

Parameters
node:XMLNode — The XML node associated this data

Returns
Boolean — An indicator as to whether deserialization was successful
enable()method 
public static function enable():void

Performs the registration of this extension into the extension registry.

getElementName()method 
public function getElementName():String

Gets the element name associated with this extension. The element for this extension is "x".

Returns
String — The element name
getNS()method 
public function getNS():String

Gets the namespace associated with this extension. The namespace for the WhiteboardExtension is "xiff:wb".

Returns
String — The namespace
serialize()method 
public function serialize(parent:XMLNode):Boolean

Serializes the WhiteboardExtension data to XML for sending.

Parameters
parent:XMLNode — The parent node that this extension should be serialized into

Returns
Boolean — An indicator as to whether serialization was successful
Constant detail
ELEMENT_NAMEconstant
public static const ELEMENT_NAME:String = "x"
NSconstant 
public static const NS:String = "xiff:wb"