FormField (Smack 4.3.0 API)

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

All Implemented Interfaces:

Element, NamedElement
```
public class FormField
extends Object
implements NamedElement
```
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.Option` Represents the available option of a given FormField.
`static class`	`FormField.Type` Form Field Types as defined in XEP-4 § 3.3.

Field Summary

Fields
Modifier and Type Field and Description

static String ELEMENT

static String FORM_TYPE
The constant String "FORM_TYPE".

Fields
Modifier and Type	Field and Description
`static String`	`ELEMENT`
`static String`	`FORM_TYPE` The constant String "FORM_TYPE".

Constructor Summary

Constructors
Constructor and Description
`FormField()` Creates a new FormField of type FIXED.
`FormField(String variable)` Creates a new FormField with the variable name that uniquely identifies the field in the context of the form.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addOption(FormField.Option option)` Adss an available options to the question that the user has in order to answer the question.
`void`	`addValue(CharSequence value)` Adds a default value to the question if the question is part of a form to fill out.
`void`	`addValue(Date date)` Adds the given Date as XEP-0082 formated string by invoking `addValue(CharSequence)` after the date instance was formated.
`void`	`addValues(List<? extends CharSequence> newValues)` Adds a default values to the question if the question is part of a form to fill out.
`boolean`	`equals(Object obj)`
`String`	`getDescription()` Returns a description that provides extra clarification about the question.
`String`	`getElementName()` Returns the root element name.
`String`	`getFirstValue()` Returns the first value of this form fold or `null`.
`Date`	`getFirstValueAsDate()` Parses the first value of this form field as XEP-0082 date/time format and returns a date instance or `null`.
`String`	`getLabel()` Returns the label of the question which should give enough information to the user to fill out the form.
`List<FormField.Option>`	`getOptions()` Returns a List of the available options that the user has in order to answer the question.
`FormField.Type`	`getType()` Returns an indicative of the format for the data to answer.
`ValidateElement`	`getValidateElement()` Get validate element.
`List<CharSequence>`	`getValues()` Returns a List of the default values of the question if the question is part of a form to fill out.
`List<String>`	`getValuesAsString()` Returns the values a String.
`String`	`getVariable()` Returns the variable name that the question is filling out.
`int`	`hashCode()`
`boolean`	`isRequired()` Returns true if the question must be answered in order to complete the questionnaire.
`protected void`	`resetValues()` Removes all the values of the field.
`void`	`setDescription(String description)` Sets a description that provides extra clarification about the question.
`void`	`setLabel(String label)` Sets the label of the question which should give enough information to the user to fill out the form.
`void`	`setRequired(boolean required)` Sets if the question must be answered in order to complete the questionnaire.
`void`	`setType(FormField.Type type)` Sets an indicative of the format for the data to answer.
`void`	`setValidateElement(ValidateElement validateElement)` Set validate element.
`XmlStringBuilder`	`toXML(String enclosingNamespace)` Returns the XML representation of this Element.

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

- Field Detail
  - ELEMENT
```
public static final String ELEMENT
```
    See Also:
    
    Constant Field Values
  - FORM_TYPE
```
public static final String FORM_TYPE
```
    The constant String "FORM_TYPE".
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FormField
```
public FormField(String variable)
```
    Creates a new FormField with the variable name that uniquely identifies the field in the context of the form.
    
    Parameters:
    
    variable - the variable name of the question.
  - FormField
```
public FormField()
```
    Creates a new FormField of type FIXED. The fields of type FIXED do not define a variable name.
- Method Detail
  - getDescription
```
public 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 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 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 List<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 List<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 String getFirstValue()
```
    Returns the first value of this form fold or null.
    
    Returns:
    
    the first value or null
    
    Since:
    
    4.3
  - getFirstValueAsDate
```
public Date getFirstValueAsDate()
                         throws 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:
    
    ParseException - if parsing fails.
    
    Since:
    
    4.3.0
  - getVariable
```
public String getVariable()
```
    Returns the variable name that the question is filling out.
    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 variable name of the question.
  - getValidateElement
```
public ValidateElement getValidateElement()
```
    Get validate element.
    
    Returns:
    
    the validateElement
  - setDescription
```
public void setDescription(String description)
```
    Sets 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.
    
    Parameters:
    
    description - provides extra clarification about the question.
  - setLabel
```
public void setLabel(String label)
```
    Sets the label of the question which should give enough information to the user to fill out the form.
    
    Parameters:
    
    label - the label of the question.
  - setRequired
```
public void setRequired(boolean required)
```
    Sets if the question must be answered in order to complete the questionnaire.
    
    Parameters:
    
    required - if the question must be answered in order to complete the questionnaire.
  - setValidateElement
```
public void setValidateElement(ValidateElement validateElement)
```
    Set validate element.
    
    Parameters:
    
    validateElement - the validateElement to set
  - setType
```
public void setType(FormField.Type type)
```
    Sets an indicative of the format for the data to answer.
    This method will throw an IllegalArgumentException if type is 'fixed'. To create FormFields of type 'fixed' use FormField() instead.
    
    Parameters:
    
    type - an indicative of the format for the data to answer.
    
    Throws:
    
    IllegalArgumentException - if type is 'fixed'.
    
    See Also:
    
    FormField.Type
  - addValue
```
public void addValue(CharSequence value)
```
    Adds a default value to the question if the question is part of a form to fill out. Otherwise, adds an answered value to the question.
    
    Parameters:
    
    value - a default value or an answered value of the question.
  - addValue
```
public void addValue(Date date)
```
    Adds the given Date as XEP-0082 formated string by invoking addValue(CharSequence) after the date instance was formated.
    
    Parameters:
    
    date - the date instance to add as XEP-0082 formated string.
    
    Since:
    
    4.3.0
  - addValues
```
public void addValues(List<? extends CharSequence> newValues)
```
    Adds a default values to the question if the question is part of a form to fill out. Otherwise, adds an answered values to the question.
    
    Parameters:
    
    newValues - default values or an answered values of the question.
  - resetValues
```
protected void resetValues()
```
    Removes all the values of the field.
  - addOption
```
public void addOption(FormField.Option option)
```
    Adss an available options to the question that the user has in order to answer the question.
    
    Parameters:
    
    option - a new available option for the question.
  - getElementName
```
public String getElementName()
```
    Description copied from interface: NamedElement
    
    Returns the root element name.
    
    Specified by:
    
    getElementName in interface NamedElement
    
    Returns:
    
    the element name.
  - 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.
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class FormField

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ELEMENT

FORM_TYPE

Constructor Detail

FormField

FormField

Method Detail

getDescription

getLabel

getOptions

isRequired

getType

getValues

getValuesAsString

getFirstValue

getFirstValueAsDate

getVariable

getValidateElement

setDescription

setLabel

setRequired

setValidateElement

setType

addValue

addValue

addValues

resetValues

addOption

getElementName

toXML

equals

hashCode