DataForm (Smack 4.1.9 API)

java.lang.Object
- org.jivesoftware.smackx.xdata.packet.DataForm

All Implemented Interfaces:

Element, ExtensionElement, NamedElement
```
public class DataForm
extends Object
implements ExtensionElement
```
Represents a form that could be use for gathering data as well as for reporting data returned from a search.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`DataForm.Item` Represents items of reported data.
`static class`	`DataForm.ReportedData` Represents the fields that will be returned from a search.
`static class`	`DataForm.Type`

Field Summary

Fields
Modifier and Type Field and Description

static String ELEMENT

static String NAMESPACE

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

Constructor Summary

Constructors
Constructor and Description

DataForm(DataForm.Type type)

Constructors
Constructor and Description
`DataForm(DataForm.Type type)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addExtensionElement(Element element)`
`void`	`addField(FormField field)` Adds a new field as part of the form.
`void`	`addInstruction(String instruction)` Adds a new instruction to the list of instructions that explain how to fill out the form and what the form is about.
`void`	`addItem(DataForm.Item item)` Adds a new item returned from a search.
`static DataForm`	`from(Stanza packet)`
`String`	`getElementName()` Returns the root element name.
`List<Element>`	`getExtensionElements()`
`FormField`	`getField(String variableName)` Return the form field with the given variable name or null.
`List<FormField>`	`getFields()` Returns a List of the fields that are part of the form.
`FormField`	`getHiddenFormTypeField()` Returns the hidden FORM_TYPE field or null if this data form has none.
`List<String>`	`getInstructions()` Returns a List of the list of instructions that explain how to fill out the form and what the form is about.
`List<DataForm.Item>`	`getItems()` Returns a List of the items returned from a search.
`String`	`getNamespace()` Returns the root element XML namespace.
`DataForm.ReportedData`	`getReportedData()` Returns the fields that will be returned from a search.
`String`	`getTitle()` Returns the description of the data.
`DataForm.Type`	`getType()` Returns the meaning of the data within the context.
`boolean`	`hasHiddenFormTypeField()` Returns true if this DataForm has at least one FORM_TYPE field which is hidden.
`void`	`setInstructions(List<String> instructions)` Sets the list of instructions that explain how to fill out the form and what the form is about.
`void`	`setReportedData(DataForm.ReportedData reportedData)` Sets the fields that will be returned from a search.
`void`	`setTitle(String title)` Sets the description of the data.
`XmlStringBuilder`	`toXML()` 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
  - NAMESPACE
```
public static final String NAMESPACE
```
    See Also:
    
    Constant Field Values
  - ELEMENT
```
public static final String ELEMENT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DataForm
```
public DataForm(DataForm.Type type)
```
- Method Detail
  - getType
```
public DataForm.Type getType()
```
    Returns the meaning of the data within the context. The data could be part of a form to fill out, a form submission or data results.
    
    Returns:
    
    the form's type.
  - getTitle
```
public String getTitle()
```
    Returns the description of the data. It is similar to the title on a web page or an X window. You can put a on either a form to fill out, or a set of data results.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>description of the data.</dd> </dl> </li> </ul> <a name="getInstructions--">  </a> <ul class="blockList"> <li class="blockList"> <h4>getInstructions</h4> <pre>public <a href="http://docs.oracle.com/javase/1.7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/1.7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> <a href="../../../../../src-html/org/jivesoftware/smackx/xdata/packet/DataForm.html#line.109">getInstructions</a>()</pre> <div class="block">Returns a List of the list of instructions that explain how to fill out the form and what the form is about. The dataform could include multiple instructions since each instruction could not contain newlines characters. Join the instructions together in order to show them to the user.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>a List of the list of instructions that explain how to fill out the form.</dd> </dl> </li> </ul> <a name="getReportedData--">  </a> <ul class="blockList"> <li class="blockList"> <h4>getReportedData</h4> <pre>public <a href="../../../../../org/jivesoftware/smackx/xdata/packet/DataForm.ReportedData.html" title="class in org.jivesoftware.smackx.xdata.packet">DataForm.ReportedData</a> <a href="../../../../../src-html/org/jivesoftware/smackx/xdata/packet/DataForm.html#line.120">getReportedData</a>()</pre> <div class="block">Returns the fields that will be returned from a search.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>fields that will be returned from a search.</dd> </dl> </li> </ul> <a name="getItems--">  </a> <ul class="blockList"> <li class="blockList"> <h4>getItems</h4> <pre>public <a href="http://docs.oracle.com/javase/1.7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/jivesoftware/smackx/xdata/packet/DataForm.Item.html" title="class in org.jivesoftware.smackx.xdata.packet">DataForm.Item</a>> <a href="../../../../../src-html/org/jivesoftware/smackx/xdata/packet/DataForm.html#line.129">getItems</a>()</pre> <div class="block">Returns a List of the items returned from a search.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>a List of the items returned from a search.</dd> </dl> </li> </ul> <a name="getFields--">  </a> <ul class="blockList"> <li class="blockList"> <h4>getFields</h4> <pre>public <a href="http://docs.oracle.com/javase/1.7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/jivesoftware/smackx/xdata/FormField.html" title="class in org.jivesoftware.smackx.xdata">FormField</a>> <a href="../../../../../src-html/org/jivesoftware/smackx/xdata/packet/DataForm.html#line.140">getFields</a>()</pre> <div class="block">Returns a List of the fields that are part of the form.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>a List of the fields that are part of the form.</dd> </dl> </li> </ul> <a name="getField-java.lang.String-">  </a> <ul class="blockList"> <li class="blockList"> <h4>getField</h4> <pre>public <a href="../../../../../org/jivesoftware/smackx/xdata/FormField.html" title="class in org.jivesoftware.smackx.xdata">FormField</a> <a href="../../../../../src-html/org/jivesoftware/smackx/xdata/packet/DataForm.html#line.153">getField</a>(<a href="http://docs.oracle.com/javase/1.7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> variableName)</pre> <div class="block">Return the form field with the given variable name or null.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>variableName</code> - </dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>the form field or null.</dd> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>4.1</dd> </dl> </li> </ul> <a name="getElementName--">  </a> <ul class="blockList"> <li class="blockList"> <h4>getElementName</h4> <pre>public <a href="http://docs.oracle.com/javase/1.7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/jivesoftware/smackx/xdata/packet/DataForm.html#line.164">getElementName</a>()</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/jivesoftware/smack/packet/NamedElement.html#getElementName--">NamedElement</a></code></span></div> <div class="block">Returns the root element name.</div> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code><a href="../../../../../org/jivesoftware/smack/packet/NamedElement.html#getElementName--">getElementName</a></code> in interface <code><a href="../../../../../org/jivesoftware/smack/packet/NamedElement.html" title="interface in org.jivesoftware.smack.packet">NamedElement</a></code></dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>the element name.</dd> </dl> </li> </ul> <a name="getNamespace--">  </a> <ul class="blockList"> <li class="blockList"> <h4>getNamespace</h4> <pre>public <a href="http://docs.oracle.com/javase/1.7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/jivesoftware/smackx/xdata/packet/DataForm.html#line.168">getNamespace</a>()</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/jivesoftware/smack/packet/ExtensionElement.html#getNamespace--">ExtensionElement</a></code></span></div> <div class="block">Returns the root element XML namespace.</div> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code><a href="../../../../../org/jivesoftware/smack/packet/ExtensionElement.html#getNamespace--">getNamespace</a></code> in interface <code><a href="../../../../../org/jivesoftware/smack/packet/ExtensionElement.html" title="interface in org.jivesoftware.smack.packet">ExtensionElement</a></code></dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>the namespace.</dd> </dl> </li> </ul> <a name="setTitle-java.lang.String-">  </a> <ul class="blockList"> <li class="blockList"> <h4>setTitle</h4> <pre>public void <a href="../../../../../src-html/org/jivesoftware/smackx/xdata/packet/DataForm.html#line.178">setTitle</a>(<a href="http://docs.oracle.com/javase/1.7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> title)</pre> <div class="block">Sets the description of the data. It is similar to the title on a web page or an X window. You can put a <title/> on either a form to fill out, or a set of data results.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>title</code> - description of the data.</dd> </dl> </li> </ul> <a name="setInstructions-java.util.List-">  </a> <ul class="blockList"> <li class="blockList"> <h4>setInstructions</h4> <pre>public void <a href="../../../../../src-html/org/jivesoftware/smackx/xdata/packet/DataForm.html#line.189">setInstructions</a>(<a href="http://docs.oracle.com/javase/1.7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="http://docs.oracle.com/javase/1.7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>> instructions)</pre> <div class="block">Sets the list of instructions that explain how to fill out the form and what the form is about. The dataform could include multiple instructions since each instruction could not contain newlines characters.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>instructions</code> - list of instructions that explain how to fill out the form.</dd> </dl> </li> </ul> <a name="setReportedData-org.jivesoftware.smackx.xdata.packet.DataForm.ReportedData-">  </a> <ul class="blockList"> <li class="blockList"> <h4>setReportedData</h4> <pre>public void <a href="../../../../../src-html/org/jivesoftware/smackx/xdata/packet/DataForm.html#line.198">setReportedData</a>(<a href="../../../../../org/jivesoftware/smackx/xdata/packet/DataForm.ReportedData.html" title="class in org.jivesoftware.smackx.xdata.packet">DataForm.ReportedData</a> reportedData)</pre> <div class="block">Sets the fields that will be returned from a search.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>reportedData</code> - the fields that will be returned from a search.</dd> </dl> </li> </ul> <a name="addField-org.jivesoftware.smackx.xdata.FormField-">  </a> <ul class="blockList"> <li class="blockList"> <h4>addField</h4> <pre>public void <a href="../../../../../src-html/org/jivesoftware/smackx/xdata/packet/DataForm.html#line.207">addField</a>(<a href="../../../../../org/jivesoftware/smackx/xdata/FormField.html" title="class in org.jivesoftware.smackx.xdata">FormField</a> field)</pre> <div class="block">Adds a new field as part of the form.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>field</code> - the field to add to the form.</dd> </dl> </li> </ul> <a name="addInstruction-java.lang.String-">  </a> <ul class="blockList"> <li class="blockList"> <h4>addInstruction</h4> <pre>public void <a href="../../../../../src-html/org/jivesoftware/smackx/xdata/packet/DataForm.html#line.225">addInstruction</a>(<a href="http://docs.oracle.com/javase/1.7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> instruction)</pre> <div class="block">Adds a new instruction to the list of instructions that explain how to fill out the form and what the form is about. The dataform could include multiple instructions since each instruction could not contain newlines characters.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>instruction</code> - the new instruction that explain how to fill out the form.</dd> </dl> </li> </ul> <a name="addItem-org.jivesoftware.smackx.xdata.packet.DataForm.Item-">  </a> <ul class="blockList"> <li class="blockList"> <h4>addItem</h4> <pre>public void <a href="../../../../../src-html/org/jivesoftware/smackx/xdata/packet/DataForm.html#line.236">addItem</a>(<a href="../../../../../org/jivesoftware/smackx/xdata/packet/DataForm.Item.html" title="class in org.jivesoftware.smackx.xdata.packet">DataForm.Item</a> item)</pre> <div class="block">Adds a new item returned from a search.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>item</code> - the item returned from a search.</dd> </dl> </li> </ul> <a name="addExtensionElement-org.jivesoftware.smack.packet.Element-">  </a> <ul class="blockList"> <li class="blockList"> <h4>addExtensionElement</h4> <pre>public void <a href="../../../../../src-html/org/jivesoftware/smackx/xdata/packet/DataForm.html#line.242">addExtensionElement</a>(<a href="../../../../../org/jivesoftware/smack/packet/Element.html" title="interface in org.jivesoftware.smack.packet">Element</a> element)</pre> </li> </ul> <a name="getExtensionElements--">  </a> <ul class="blockList"> <li class="blockList"> <h4>getExtensionElements</h4> <pre>public <a href="http://docs.oracle.com/javase/1.7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><<a href="../../../../../org/jivesoftware/smack/packet/Element.html" title="interface in org.jivesoftware.smack.packet">Element</a>> <a href="../../../../../src-html/org/jivesoftware/smackx/xdata/packet/DataForm.html#line.246">getExtensionElements</a>()</pre> </li> </ul> <a name="getHiddenFormTypeField--">  </a> <ul class="blockList"> <li class="blockList"> <h4>getHiddenFormTypeField</h4> <pre>public <a href="../../../../../org/jivesoftware/smackx/xdata/FormField.html" title="class in org.jivesoftware.smackx.xdata">FormField</a> <a href="../../../../../src-html/org/jivesoftware/smackx/xdata/packet/DataForm.html#line.256">getHiddenFormTypeField</a>()</pre> <div class="block">Returns the hidden FORM_TYPE field or null if this data form has none.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the hidden FORM_TYPE field or null.</dd> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>4.1</dd> </dl> </li> </ul> <a name="hasHiddenFormTypeField--">  </a> <ul class="blockList"> <li class="blockList"> <h4>hasHiddenFormTypeField</h4> <pre>public boolean <a href="../../../../../src-html/org/jivesoftware/smackx/xdata/packet/DataForm.html#line.270">hasHiddenFormTypeField</a>()</pre> <div class="block">Returns true if this DataForm has at least one FORM_TYPE field which is hidden. This method is used for sanity checks.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>true if there is at least one field which is hidden.</dd> </dl> </li> </ul> <a name="toXML--">  </a> <ul class="blockList"> <li class="blockList"> <h4>toXML</h4> <pre>public <a href="../../../../../org/jivesoftware/smack/util/XmlStringBuilder.html" title="class in org.jivesoftware.smack.util">XmlStringBuilder</a> <a href="../../../../../src-html/org/jivesoftware/smackx/xdata/packet/DataForm.html#line.275">toXML</a>()</pre> <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/jivesoftware/smack/packet/Element.html#toXML--">Element</a></code></span></div> <div class="block">Returns the XML representation of this Element.</div> <dl> <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> <dd><code><a href="../../../../../org/jivesoftware/smack/packet/Element.html#toXML--">toXML</a></code> in interface <code><a href="../../../../../org/jivesoftware/smack/packet/Element.html" title="interface in org.jivesoftware.smack.packet">Element</a></code></dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>the stanza(/packet) extension as XML.</dd> </dl> </li> </ul> <a name="from-org.jivesoftware.smack.packet.Stanza-">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>from</h4> <pre>public static <a href="../../../../../org/jivesoftware/smackx/xdata/packet/DataForm.html" title="class in org.jivesoftware.smackx.xdata.packet">DataForm</a> <a href="../../../../../src-html/org/jivesoftware/smackx/xdata/packet/DataForm.html#line.308">from</a>(<a href="../../../../../org/jivesoftware/smack/packet/Stanza.html" title="class in org.jivesoftware.smack.packet">Stanza</a> packet)</pre> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>packet</code> - </dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>the DataForm or null</dd> </dl> </li> </ul> </li> </ul> </li> </ul> </div> </div>   <div class="bottomNav"><a name="navbar.bottom">  </a> <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> <a name="navbar.bottom.firstrow">  </a> <ul class="navList" title="Navigation"> <li><a href="../../../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="class-use/DataForm.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../../index-all.html">Index</a></li> <li><a href="../../../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li>Prev Class</li> <li><a href="../../../../../org/jivesoftware/smackx/xdata/packet/DataForm.Item.html" title="class in org.jivesoftware.smackx.xdata.packet"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?org/jivesoftware/smackx/xdata/packet/DataForm.html" target="_top">Frames</a></li> <li><a href="DataForm.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li><a href="#nested.class.summary">Nested</a> | </li> <li><a href="#field.summary">Field</a> | </li> <li><a href="#constructor.summary">Constr</a> | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li><a href="#field.detail">Field</a> | </li> <li><a href="#constructor.detail">Constr</a> | </li> <li><a href="#method.detail">Method</a></li> </ul> </div> <a name="skip.navbar.bottom">  </a></div>  </body> </html>

Class DataForm

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NAMESPACE

ELEMENT

Constructor Detail

DataForm

Method Detail

getType

getTitle