Package | org.igniterealtime.xiff.data.whiteboard |
Class | public class WhiteboardExtension |
Inheritance | WhiteboardExtension ![]() ![]() ![]() ![]() |
Implements | IExtension |
See also
Property | Defined By | ||
---|---|---|---|
paths : Array [read-only]
The paths available in this whiteboard message
| WhiteboardExtension | ||
![]() | xml : XML [override]
Override in order to take care of setting the Namespace and
checking for containing extensions. | Extension |
Method | Defined By | ||
---|---|---|---|
WhiteboardExtension(parent:XML = null) | WhiteboardExtension | ||
![]() |
Add extension to the list of the given namespace and insert to the XML element as a child. | ExtensionContainer | |
![]() | getAllExtensions():Array | ExtensionContainer | |
![]() | getAllExtensionsByNS(nameSpace:String):Array | ExtensionContainer | |
![]() | getAttribute(name:String):String
Convinience method for getting element value from the XML. | XMLStanza | |
![]() | getChildAttribute(elem:String, name:String):String
Convinience method for getting child element attribute value from the XML. | XMLStanza | |
![]() | getChildField(elem:String, name:String):String
Convinience method for getting child element value from the XML. | XMLStanza | |
getElementName():String
Gets the element name associated with this extension. | WhiteboardExtension | ||
![]() | getExtension(elementName:String):IExtension
Get the extension having the given element name. | ExtensionContainer | |
![]() | getField(name:String):String
Convinience method for getting element value from the XML. | XMLStanza | |
getNS():String
Gets the namespace associated with this extension. | WhiteboardExtension | ||
![]() | remove():void
Removes the extension from its parent. | Extension | |
![]() | removeAllExtensions(nameSpace:String):void | ExtensionContainer | |
![]() | removeExtension(extension:IExtension):Boolean | ExtensionContainer | |
![]() | removeFields(name:String):void
Helper method for removing all child elements that have the given name. | XMLStanza | |
![]() | setAttribute(name:String, value:String):void
Convinience method for setting a value to a element in the XML. | XMLStanza | |
![]() | setChildAttribute(elem:String, name:String, value:String):void
Convinience method for setting an attribute for a child element of the XML. | XMLStanza | |
![]() | setChildField(elem:String, name:String, value:String):void
Convinience method for setting a value for a child element of the XML. | XMLStanza | |
![]() | setField(name:String, value:String):void
Convinience method for setting a value to a element in the XML. | XMLStanza | |
![]() | toString():String
Converts the base stanza XML to a string. | XMLStanza |
Constant | Defined By | ||
---|---|---|---|
![]() | DEFAULT_NS : Namespace [static]
Default XML namespace. | XMLStanza | |
ELEMENT_NAME : String = x [static] | WhiteboardExtension | ||
![]() | FLASH_NS : Namespace [static]
| XMLStanza | |
NS : String = xiff:wb [static] | WhiteboardExtension | ||
![]() | STREAM_NS : Namespace [static]
| XMLStanza |
paths | property |
paths:Array
[read-only] The paths available in this whiteboard message
public function get paths():Array
WhiteboardExtension | () | Constructor |
public function WhiteboardExtension(parent:XML = null)
Parameters
parent:XML (default = null )
|
getElementName | () | method |
public function getElementName():String
Gets the element name associated with this extension. The element for this extension is "x".
ReturnsString — The element name
|
getNS | () | method |
public function getNS():String
Gets the namespace associated with this extension. The namespace for the WhiteboardExtension is "xiff:wb".
ReturnsString — The namespace
|
ELEMENT_NAME | Constant |
public static const ELEMENT_NAME:String = x
NS | Constant |
public static const NS:String = xiff:wb