rocks.xmpp.extensions.data.layout.model

Class Section

java.lang.Object

rocks.xmpp.extensions.data.layout.model.Section

public final class Section
extends Object

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

A section is used to partition a page.

This class is immutable.

See Also:

XEP-0141: Data Forms Layout, 3.2 Sectioning Fields, Page.getSections()

Constructor Summary

Constructors

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

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

Section

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

Creates a section.

Parameters:

label - The label.

fieldReferences - The field references.

Section

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

Creates a section.

Parameters:

label - The label.

fieldReferences - The field references.

text - The text.

Section

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

Creates a section.

Parameters:

label - The label.

fieldReferences - The field references.

text - The text.

reportedReference - The reference to a reported field.

Method Detail

getLabel

public String getLabel()

Gets the label of the section.

Returns:

The label.

getText

public List<String> getText()

Gets additional information for the section.

Returns:

Additional information.

getFieldReferences

public List<FieldReference> getFieldReferences()

Gets the field references. These are the fields, which appear in this section.

Returns:

The field references.

getSections

public List<Section> getSections()

Gets nested sub-sections.

Returns:

The nested sub-sections.

getReportedReference

public FieldReference getReportedReference()

Gets the reported field reference.

Returns:

The reported field reference.