org.jivesoftware.smackx.xdatalayout.packet

Class DataLayout

java.lang.Object

org.jivesoftware.smackx.xdatalayout.packet.DataLayout

All Implemented Interfaces:

Element, ExtensionElement, NamedElement

public class DataLayout
extends Object
implements ExtensionElement

DataLayout Extension according to XEP-0141: Data Forms Layout. Defines a backwards-compatible extension to the XMPP Data Forms protocol that enables an application to specify form layouts, including the layout of form fields, sections within pages, and subsections within sections.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DataLayout.DataFormLayoutElement
static class	DataLayout.Fieldref
static class	DataLayout.Reportedref
static class	DataLayout.Section
static class	DataLayout.Text

Field Summary

Fields

Modifier and Type	Field and Description
static String	ELEMENT
static String	NAMESPACE

Constructor Summary

Constructors

Constructor and Description
DataLayout(String label) Data layout constructor.

Method Summary

Modifier and Type	Method and Description
String	getElementName() Returns the root element name.
String	getLabel() Gets the value of the label property.
String	getNamespace() Returns the root element XML namespace.
List<DataLayout.DataFormLayoutElement>	getPageLayout() Gets the value of the pageLayout property.
XmlStringBuilder	toXML(String enclosingNamespace) Returns the XML representation of this Element.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ELEMENT

public static final String ELEMENT

See Also:

Constant Field Values

NAMESPACE

public static final String NAMESPACE

See Also:

Constant Field Values

Constructor Detail

DataLayout

public DataLayout(String label)

Data layout constructor.

Parameters:

label -

Method Detail

getPageLayout

public List<DataLayout.DataFormLayoutElement> getPageLayout()

Gets the value of the pageLayout property.

Objects of the following type(s) are allowed in the list: String, DataLayout.Section, DataLayout.Fieldref and DataLayout.Reportedref

Returns:

list of DataFormLayoutElements.

getLabel

public String getLabel()

Gets the value of the label property.

Returns:

possible object is String

getElementName

public String getElementName()

Description copied from interface: NamedElement

Returns the root element name.

Specified by:

getElementName in interface NamedElement

Returns:

the element name.

getNamespace

public String getNamespace()

Description copied from interface: ExtensionElement

Returns the root element XML namespace.

Specified by:

getNamespace in interface ExtensionElement

Returns:

the namespace.

toXML

public XmlStringBuilder toXML(String enclosingNamespace)

Description copied from interface: Element

Returns the XML representation of this Element. This method takes an optional argument for the enclosing namespace which may be null or the empty String if the value is not known.

Specified by:

toXML in interface Element

Parameters:

enclosingNamespace - the enclosing namespace or null.

Returns:

the stanza extension as XML.