FormField (smack-extensions 4.4.0-alpha2 API)

java.lang.Object
- org.jivesoftware.smackx.xdata.FormField

All Implemented Interfaces:

org.jivesoftware.smack.packet.Element, org.jivesoftware.smack.packet.FullyQualifiedElement, org.jivesoftware.smack.packet.NamedElement
```
public final class FormField
extends java.lang.Object
implements org.jivesoftware.smack.packet.FullyQualifiedElement
```
Represents a field of a form. The field could be used to represent a question to complete, a completed question or a data returned from a search. The exact interpretation of the field depends on the context where the field is used.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`FormField.Builder`
`static class`	`FormField.Description`
`static class`	`FormField.Option` Represents the available option of a given FormField.
`static class`	`FormField.Required`
`static class`	`FormField.Type` Form Field Types as defined in XEP-4 § 3.3.
`static class`	`FormField.Value`

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ELEMENT`
`static java.lang.String`	`FORM_TYPE` The constant String "FORM_TYPE".
`static java.lang.String`	`NAMESPACE`
`static javax.xml.namespace.QName`	`QNAME`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FormField.Builder`	`asBuilder()`
`FormField.Builder`	`buildAnswer()`
`static FormField.Builder`	`builder()`
`static FormField.Builder`	`builder(java.lang.String fieldName)`
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getDescription()` Returns a description that provides extra clarification about the question.
`java.lang.String`	`getElementName()`
`java.lang.String`	`getFirstValue()` Returns the first value of this form field or `null`.
`java.util.Date`	`getFirstValueAsDate()` Parses the first value of this form field as XEP-0082 date/time format and returns a date instance or `null`.
`FormFieldChildElement`	`getFormFieldChildElement(javax.xml.namespace.QName qname)`
`java.util.List<FormFieldChildElement>`	`getFormFieldChildElements(javax.xml.namespace.QName qname)`
`java.lang.String`	`getLabel()` Returns the label of the question which should give enough information to the user to fill out the form.
`java.lang.String`	`getNamespace()`
`java.util.List<FormField.Option>`	`getOptions()` Returns a List of the available options that the user has in order to answer the question.
`javax.xml.namespace.QName`	`getQName()`
`FormField.Type`	`getType()` Returns an indicative of the format for the data to answer.
`java.util.List<java.lang.CharSequence>`	`getValues()` Returns a List of the default values of the question if the question is part of a form to fill out.
`java.util.List<java.lang.String>`	`getValuesAsString()` Returns the values a String.
`java.lang.String`	`getVariable()` Returns the field's name, also known as the variable name in case this is an filled out answer form.
`int`	`hashCode()`
`static FormField`	`hiddenFormType(java.lang.String value)`
`boolean`	`isRequired()` Returns true if the question must be answered in order to complete the questionnaire.
`org.jivesoftware.smack.util.XmlStringBuilder`	`toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jivesoftware.smack.packet.Element
toXML, toXML

- Field Detail
  - ELEMENT
```
public static final java.lang.String ELEMENT
```
    See Also:
    
    Constant Field Values
  - NAMESPACE
```
public static final java.lang.String NAMESPACE
```
    See Also:
    
    Constant Field Values
  - QNAME
```
public static final javax.xml.namespace.QName QNAME
```
  - FORM_TYPE
```
public static final java.lang.String FORM_TYPE
```
    The constant String "FORM_TYPE".
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getDescription
```
public java.lang.String getDescription()
```
    Returns a description that provides extra clarification about the question. This information could be presented to the user either in tool-tip, help button, or as a section of text before the question.
    If the question is of type FIXED then the description should remain empty.
    
    Returns:
    
    description that provides extra clarification about the question.
  - getLabel
```
public java.lang.String getLabel()
```
    Returns the label of the question which should give enough information to the user to fill out the form.
    
    Returns:
    
    label of the question.
  - getOptions
```
public java.util.List<FormField.Option> getOptions()
```
    Returns a List of the available options that the user has in order to answer the question.
    
    Returns:
    
    List of the available options.
  - isRequired
```
public boolean isRequired()
```
    Returns true if the question must be answered in order to complete the questionnaire.
    
    Returns:
    
    true if the question must be answered in order to complete the questionnaire.
  - getType
```
public FormField.Type getType()
```
    Returns an indicative of the format for the data to answer.
    
    Returns:
    
    format for the data to answer.
    
    See Also:
    
    FormField.Type
  - getValues
```
public java.util.List<java.lang.CharSequence> getValues()
```
    Returns a List of the default values of the question if the question is part of a form to fill out. Otherwise, returns a List of the answered values of the question.
    
    Returns:
    
    a List of the default values or answered values of the question.
  - getValuesAsString
```
public java.util.List<java.lang.String> getValuesAsString()
```
    Returns the values a String. Note that you should use getValues() whenever possible instead of this method.
    
    Returns:
    
    a list of Strings representing the values
    
    Since:
    
    4.3
    
    See Also:
    
    getValues()
  - getFirstValue
```
public java.lang.String getFirstValue()
```
    Returns the first value of this form field or null.
    
    Returns:
    
    the first value or null
    
    Since:
    
    4.3
  - getFirstValueAsDate
```
public java.util.Date getFirstValueAsDate()
                                   throws java.text.ParseException
```
    Parses the first value of this form field as XEP-0082 date/time format and returns a date instance or null.
    
    Returns:
    
    a Date instance representing the date/time information of the first value of this field.
    
    Throws:
    
    java.text.ParseException - if parsing fails.
    
    Since:
    
    4.3.0
  - getVariable
```
public java.lang.String getVariable()
```
    Returns the field's name, also known as the variable name in case this is an filled out answer form.
    According to XEP-4 § 3.2 the variable name (the 'var' attribute) "uniquely identifies the field in the context of the form" (if the field is not of type 'fixed', in which case the field "MAY possess a 'var' attribute")
    
    Returns:
    
    the field's name.
  - getFormFieldChildElement
```
public FormFieldChildElement getFormFieldChildElement(javax.xml.namespace.QName qname)
```
  - getFormFieldChildElements
```
public java.util.List<FormFieldChildElement> getFormFieldChildElements(javax.xml.namespace.QName qname)
```
  - getElementName
```
public java.lang.String getElementName()
```
    Specified by:
    
    getElementName in interface org.jivesoftware.smack.packet.NamedElement
  - getNamespace
```
public java.lang.String getNamespace()
```
    Specified by:
    
    getNamespace in interface org.jivesoftware.smack.packet.FullyQualifiedElement
  - getQName
```
public javax.xml.namespace.QName getQName()
```
    Specified by:
    
    getQName in interface org.jivesoftware.smack.packet.FullyQualifiedElement
  - buildAnswer
```
public FormField.Builder buildAnswer()
```
  - asBuilder
```
public FormField.Builder asBuilder()
```
  - toXML
```
public org.jivesoftware.smack.util.XmlStringBuilder toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace)
```
    Specified by:
    
    toXML in interface org.jivesoftware.smack.packet.Element
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - hiddenFormType
```
public static FormField hiddenFormType(java.lang.String value)
```
  - builder
```
public static FormField.Builder builder(java.lang.String fieldName)
```
  - builder
```
public static FormField.Builder builder()
```

Class FormField

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.jivesoftware.smack.packet.Element

Field Detail

ELEMENT

NAMESPACE

QNAME

FORM_TYPE

Method Detail

getDescription

getLabel

getOptions

isRequired

getType

getValues

getValuesAsString

getFirstValue

getFirstValueAsDate

getVariable

getFormFieldChildElement

getFormFieldChildElements

getElementName

getNamespace

getQName

buildAnswer

asBuilder

toXML

equals

hashCode

hiddenFormType

builder

builder