| Package | org.igniterealtime.xiff.data.whiteboard |
| Class | public class WhiteboardExtension |
| Inheritance | WhiteboardExtension Extension XMLStanza ExtensionContainer |
| Implements | IExtension |
| Property | Defined by | ||
|---|---|---|---|
![]() | _exts : Object | ExtensionContainer | |
| paths : Array [read-only]
The paths available in this whiteboard message
| WhiteboardExtension | ||
![]() | XMLData : XML [static]
| XMLStanza | |
![]() | XMLFactory : XMLDocument [static]
| XMLStanza | |
| Method | Defined by | ||
|---|---|---|---|
|
WhiteboardExtension(parent:XMLNode = null)
| WhiteboardExtension | ||
![]() | ExtensionContainer | ||
![]() |
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 | ||
![]() |
ensureNode(node:XMLNode, elementName:String):XMLNode
Ensures that a node with a specific element name exists in the stanza.
| XMLStanza | |
![]() |
exists(value:*):Boolean
[static]
A helper method to determine if a value is both not null
and not undefined.
| XMLStanza | |
![]() |
getAllExtensions():Array
| ExtensionContainer | |
![]() |
getAllExtensionsByNS(ns:String):Array
| ExtensionContainer | |
|
getElementName():String
Gets the element name associated with this extension.
| WhiteboardExtension | ||
![]() |
getExtension(name:String):Extension
| ExtensionContainer | |
![]() |
getNode():XMLNode
| XMLStanza | |
|
getNS():String
Gets the namespace associated with this extension.
| WhiteboardExtension | ||
![]() |
remove():void
Removes the extension from its parent.
| Extension | |
![]() |
removeAllExtensions(ns:String):void
| ExtensionContainer | |
![]() |
removeExtension(ext:IExtension):Boolean
| ExtensionContainer | |
![]() |
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 | ||
![]() |
setNode(node:XMLNode):Boolean
Sets the XML node that should be used for this stanza's internal XML representation.
| XMLStanza | |
![]() |
toString():String
Converts the extension stanza XML to a string.
| Extension | |
| Constant | Defined by | ||
|---|---|---|---|
| ELEMENT_NAME : String = "x" [static]
| WhiteboardExtension | ||
| NS : String = "xiff:wb" [static]
| WhiteboardExtension | ||
| paths | property |
paths:Array [read-only]The paths available in this whiteboard message
Implementation public function get paths():Array
| WhiteboardExtension | () | constructor |
public function WhiteboardExtension(parent:XMLNode = null)Parameters
parent:XMLNode (default = null) |
| deserialize | () | method |
public function deserialize(node:XMLNode):BooleanDeserializes the WhiteboardExtension data.
Parametersnode:XMLNode — The XML node associated this data
|
Boolean — An indicator as to whether deserialization was successful
|
| enable | () | method |
public static function enable():voidPerforms the registration of this extension into the extension registry.
| getElementName | () | method |
public function getElementName():StringGets the element name associated with this extension. The element for this extension is "x".
ReturnsString — The element name
|
| getNS | () | method |
public function getNS():StringGets the namespace associated with this extension. The namespace for the WhiteboardExtension is "xiff:wb".
ReturnsString — The namespace
|
| serialize | () | method |
public function serialize(parent:XMLNode):BooleanSerializes the WhiteboardExtension data to XML for sending.
Parametersparent:XMLNode — The parent node that this extension should be serialized into
|
Boolean — An indicator as to whether serialization was successful
|
| ELEMENT_NAME | constant |
public static const ELEMENT_NAME:String = "x"
| NS | constant |
public static const NS:String = "xiff:wb"