DataForm (Smack 4.3.0 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.
`boolean`	`addFields(Collection<FormField> fieldsToAdd)` Add the given fields to this 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)` Get data form from stanza.
`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`	`hasField(String variableName)` Check if a form field with the given variable name exists.
`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(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
  - 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 <title/> on either a form to fill out, or a set of data results.
    
    Returns:
    
    description of the data.
  - getInstructions
```
public 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. 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.
    
    Returns:
    
    a List of the list of instructions that explain how to fill out the form.
  - getReportedData
```
public DataForm.ReportedData getReportedData()
```
    Returns the fields that will be returned from a search.
    
    Returns:
    
    fields that will be returned from a search.
  - getItems
```
public List<DataForm.Item> getItems()
```
    Returns a List of the items returned from a search.
    
    Returns:
    
    a List of the items returned from a search.
  - getFields
```
public List<FormField> getFields()
```
    Returns a List of the fields that are part of the form.
    
    Returns:
    
    a List of the fields that are part of the form.
  - getField
```
public FormField getField(String variableName)
```
    Return the form field with the given variable name or null.
    
    Parameters:
    
    variableName -
    
    Returns:
    
    the form field or null.
    
    Since:
    
    4.1
  - hasField
```
public boolean hasField(String variableName)
```
    Check if a form field with the given variable name exists.
    
    Parameters:
    
    variableName -
    
    Returns:
    
    true if a form field with the variable name exists, false otherwise.
    
    Since:
    
    4.2
  - 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.
  - setTitle
```
public void setTitle(String title)
```
    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.
    
    Parameters:
    
    title - description of the data.
  - setInstructions
```
public void setInstructions(List<String> instructions)
```
    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.
    
    Parameters:
    
    instructions - list of instructions that explain how to fill out the form.
  - setReportedData
```
public void setReportedData(DataForm.ReportedData reportedData)
```
    Sets the fields that will be returned from a search.
    
    Parameters:
    
    reportedData - the fields that will be returned from a search.
  - addField
```
public void addField(FormField field)
```
    Adds a new field as part of the form.
    
    Parameters:
    
    field - the field to add to the form.
  - addFields
```
public boolean addFields(Collection<FormField> fieldsToAdd)
```
    Add the given fields to this form.
    
    Parameters:
    
    fieldsToAdd -
    
    Returns:
    
    true if a field was overridden.
    
    Since:
    
    4.3.0
  - addInstruction
```
public 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. The dataform could include multiple instructions since each instruction could not contain newlines characters.
    
    Parameters:
    
    instruction - the new instruction that explain how to fill out the form.
  - addItem
```
public void addItem(DataForm.Item item)
```
    Adds a new item returned from a search.
    
    Parameters:
    
    item - the item returned from a search.
  - addExtensionElement
```
public void addExtensionElement(Element element)
```
  - getExtensionElements
```
public List<Element> getExtensionElements()
```
  - getHiddenFormTypeField
```
public FormField getHiddenFormTypeField()
```
    Returns the hidden FORM_TYPE field or null if this data form has none.
    
    Returns:
    
    the hidden FORM_TYPE field or null.
    
    Since:
    
    4.1
  - hasHiddenFormTypeField
```
public boolean hasHiddenFormTypeField()
```
    Returns true if this DataForm has at least one FORM_TYPE field which is hidden. This method is used for sanity checks.
    
    Returns:
    
    true if there is at least one field which is hidden.
  - 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.
  - from
```
public static DataForm from(Stanza packet)
```
    Get data form from stanza.
    
    Parameters:
    
    packet -
    
    Returns:
    
    the DataForm or null

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

getInstructions

getReportedData

getItems

getFields

getField

hasField

getElementName

getNamespace

setTitle

setInstructions

setReportedData

addField

addFields

addInstruction

addItem

addExtensionElement

getExtensionElements

getHiddenFormTypeField

hasHiddenFormTypeField

toXML

from