rocks.xmpp.extensions.data.layout.model

Class Page

java.lang.Object

rocks.xmpp.extensions.data.layout.model.Page

public final class Page
extends Object

The implementation of the <page/> element in the http://jabber.org/protocol/xdata-layout namespace.

A page is the top-level layout container for data forms. It may contain sections, which partition the page into smaller parts.

Each page in a data form contains references to a field in the data form, in order to know which fields should be displayed on this page.

This class is immutable.

See Also:

XEP-0141: Data Forms Layout, 3.1 Paging Fields, Section, FieldReference, DataForm.getPages()

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAMESPACE http://jabber.org/protocol/xdata-layout

Constructor Summary

Constructors

Constructor and Description
Page(String label, Collection<FieldReference> fieldReferences) Creates a page.
Page(String label, Collection<FieldReference> fieldReferences, Collection<String> text) Creates a page.
Page(String label, Collection<FieldReference> fieldReferences, Collection<String> text, FieldReference reportedReference) Creates a page.

Method Summary

Modifier and Type	Method and Description
List<FieldReference>	getFieldReferences() Gets the field references.
String	getLabel() Gets the label for this page.
FieldReference	getReportedReference() Gets the reported field reference.
List<Section>	getSections() Gets the sections for this page.
List<String>	getText() Gets additional information for the page.

Methods inherited from class java.lang.Object

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

Field Detail

NAMESPACE

public static final String NAMESPACE

http://jabber.org/protocol/xdata-layout

See Also:

Constant Field Values

Constructor Detail

Page

public Page(String label,
            Collection<FieldReference> fieldReferences)

Creates a page.

Parameters:

label - The label.

fieldReferences - The field references.

Page

public Page(String label,
            Collection<FieldReference> fieldReferences,
            Collection<String> text)

Creates a page.

Parameters:

label - The label.

fieldReferences - The field references.

text - The text.

Page

public Page(String label,
            Collection<FieldReference> fieldReferences,
            Collection<String> text,
            FieldReference reportedReference)

Creates a page.

Parameters:

label - The label.

fieldReferences - The field references.

text - The text.

reportedReference - The reference to a reported field.

Method Detail

getText

public final List<String> getText()

Gets additional information for the page.

Returns:

Additional information.

getFieldReferences

public final List<FieldReference> getFieldReferences()

Gets the field references. These are the fields, which appear on this page.

Returns:

The field references.

getSections

public final List<Section> getSections()

Gets the sections for this page.

Returns:

The sections.

getReportedReference

public final FieldReference getReportedReference()

Gets the reported field reference.

Returns:

The reported field reference.

getLabel

public final String getLabel()

Gets the label for this page.

Returns:

The label.