Form (Smack 4.1.9 API)

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

Direct Known Subclasses:

ConfigureForm, SubscribeForm
```
public class Form
extends Object
```
Represents a Form for gathering data. The form could be of the following types:
- form -> Indicates a form to fill out.
- submit -> The form is filled out, and this is the data that is being returned from the form.
- cancel -> The form was cancelled. Tell the asker that piece of information.
- result -> Data results being returned from a search, or some other query.
Depending of the form's type different operations are available. For example, it's only possible to set answers if the form is of type "submit".
See Also:

XEP-0004 Data Forms

Constructor Summary

Constructors
Constructor and Description
`Form(DataForm.Type type)` Creates a new Form of a given type from scratch.
`Form(DataForm dataForm)` Creates a new Form that will wrap an existing DataForm.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addField(FormField field)` Adds a new field to complete as part of the form.
`Form`	`createAnswerForm()` Returns a new Form to submit the completed values.
`DataForm`	`getDataFormToSend()` Returns a DataForm that serves to send this Form to the server.
`FormField`	`getField(String variable)` Returns the field of the form whose variable matches the specified variable.
`List<FormField>`	`getFields()` Returns a List of the fields that are part of the form.
`static Form`	`getFormFrom(Stanza packet)` Returns a new ReportedData if the stanza(/packet) is used for gathering data and includes an extension that matches the elementName and namespace "x","jabber:x:data".
`String`	`getInstructions()` Returns the instructions that explain how to fill out the form and what the form is about.
`String`	`getTitle()` Returns the description of the data.
`DataForm.Type`	`getType()` Returns the meaning of the data within the context.
`void`	`setAnswer(String variable, boolean value)` Sets a new boolean value to a given form's field.
`void`	`setAnswer(String variable, double value)` Sets a new double value to a given form's field.
`void`	`setAnswer(String variable, float value)` Sets a new float value to a given form's field.
`void`	`setAnswer(String variable, int value)` Sets a new int value to a given form's field.
`void`	`setAnswer(String variable, List<String> values)` Sets a new values to a given form's field.
`void`	`setAnswer(String variable, long value)` Sets a new long value to a given form's field.
`void`	`setAnswer(String variable, String value)` Sets a new String value to a given form's field.
`void`	`setDefaultAnswer(String variable)` Sets the default value as the value of a given form's field.
`void`	`setInstructions(String instructions)` Sets instructions that explain how to fill out the form and what the form is about.
`void`	`setTitle(String title)` Sets the description of the data.

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

- Constructor Detail
  - Form
```
public Form(DataForm dataForm)
```
    Creates a new Form that will wrap an existing DataForm. The wrapped DataForm must be used for gathering data.
    
    Parameters:
    
    dataForm - the data form used for gathering data.
  - Form
```
public Form(DataForm.Type type)
```
    Creates a new Form of a given type from scratch.
    
    Parameters:
    
    type - the form's type (e.g. form, submit,cancel,result).
- Method Detail
  - getFormFrom
```
public static Form getFormFrom(Stanza packet)
```
    Returns a new ReportedData if the stanza(/packet) is used for gathering data and includes an extension that matches the elementName and namespace "x","jabber:x:data".
    
    Parameters:
    
    packet - the stanza(/packet) used for gathering data.
    
    Returns:
    
    the data form parsed from the stanza(/packet) or null if there was not a form in the packet.
  - addField
```
public void addField(FormField field)
```
    Adds a new field to complete as part of the form.
    
    Parameters:
    
    field - the field to complete.
  - setAnswer
```
public void setAnswer(String variable,
                      String value)
```
    Sets a new String value to a given form's field. The field whose variable matches the requested variable will be completed with the specified value. If no field could be found for the specified variable then an exception will be raised.
    If the value to set to the field is not a basic type (e.g. String, boolean, int, etc.) you can use this message where the String value is the String representation of the object.
    
    Parameters:
    
    variable - the variable name that was completed.
    
    value - the String value that was answered.
    
    Throws:
    
    IllegalStateException - if the form is not of type "submit".
    
    IllegalArgumentException - if the form does not include the specified variable or if the answer type does not correspond with the field type..
  - setAnswer
```
public void setAnswer(String variable,
                      int value)
```
    Sets a new int value to a given form's field. The field whose variable matches the requested variable will be completed with the specified value. If no field could be found for the specified variable then an exception will be raised.
    
    Parameters:
    
    variable - the variable name that was completed.
    
    value - the int value that was answered.
    
    Throws:
    
    IllegalStateException - if the form is not of type "submit".
    
    IllegalArgumentException - if the form does not include the specified variable or if the answer type does not correspond with the field type.
  - setAnswer
```
public void setAnswer(String variable,
                      long value)
```
    Sets a new long value to a given form's field. The field whose variable matches the requested variable will be completed with the specified value. If no field could be found for the specified variable then an exception will be raised.
    
    Parameters:
    
    variable - the variable name that was completed.
    
    value - the long value that was answered.
    
    Throws:
    
    IllegalStateException - if the form is not of type "submit".
    
    IllegalArgumentException - if the form does not include the specified variable or if the answer type does not correspond with the field type.
  - setAnswer
```
public void setAnswer(String variable,
                      float value)
```
    Sets a new float value to a given form's field. The field whose variable matches the requested variable will be completed with the specified value. If no field could be found for the specified variable then an exception will be raised.
    
    Parameters:
    
    variable - the variable name that was completed.
    
    value - the float value that was answered.
    
    Throws:
    
    IllegalStateException - if the form is not of type "submit".
    
    IllegalArgumentException - if the form does not include the specified variable or if the answer type does not correspond with the field type.
  - setAnswer
```
public void setAnswer(String variable,
                      double value)
```
    Sets a new double value to a given form's field. The field whose variable matches the requested variable will be completed with the specified value. If no field could be found for the specified variable then an exception will be raised.
    
    Parameters:
    
    variable - the variable name that was completed.
    
    value - the double value that was answered.
    
    Throws:
    
    IllegalStateException - if the form is not of type "submit".
    
    IllegalArgumentException - if the form does not include the specified variable or if the answer type does not correspond with the field type.
  - setAnswer
```
public void setAnswer(String variable,
                      boolean value)
```
    Sets a new boolean value to a given form's field. The field whose variable matches the requested variable will be completed with the specified value. If no field could be found for the specified variable then an exception will be raised.
    
    Parameters:
    
    variable - the variable name that was completed.
    
    value - the boolean value that was answered.
    
    Throws:
    
    IllegalStateException - if the form is not of type "submit".
    
    IllegalArgumentException - if the form does not include the specified variable or if the answer type does not correspond with the field type.
  - setAnswer
```
public void setAnswer(String variable,
                      List<String> values)
```
    Sets a new values to a given form's field. The field whose variable matches the requested variable will be completed with the specified values. If no field could be found for the specified variable then an exception will be raised.
    The Objects contained in the List could be of any type. The String representation of them (i.e. #toString) will be actually used when sending the answer to the server.
    
    Parameters:
    
    variable - the variable that was completed.
    
    values - the values that were answered.
    
    Throws:
    
    IllegalStateException - if the form is not of type "submit".
    
    IllegalArgumentException - if the form does not include the specified variable.
  - setDefaultAnswer
```
public void setDefaultAnswer(String variable)
```
    Sets the default value as the value of a given form's field. The field whose variable matches the requested variable will be completed with its default value. If no field could be found for the specified variable then an exception will be raised.
    
    Parameters:
    
    variable - the variable to complete with its default value.
    
    Throws:
    
    IllegalStateException - if the form is not of type "submit".
    
    IllegalArgumentException - if the form does not include the specified variable.
  - 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 variable)
```
    Returns the field of the form whose variable matches the specified variable. The fields of type FIXED will never be returned since they do not specify a variable.
    
    Parameters:
    
    variable - the variable to look for in the form fields.
    
    Returns:
    
    the field of the form whose variable matches the specified variable.
  - getInstructions
```
public String getInstructions()
```
    Returns the instructions that explain how to fill out the form and what the form is about.
    
    Returns:
    
    instructions that explain how to fill out the form.
  - 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="getType--">  </a> <ul class="blockList"> <li class="blockList"> <h4>getType</h4> <pre>public <a href="../../../../org/jivesoftware/smackx/xdata/packet/DataForm.Type.html" title="enum in org.jivesoftware.smackx.xdata.packet">DataForm.Type</a> <a href="../../../../src-html/org/jivesoftware/smackx/xdata/Form.html#line.401">getType</a>()</pre> <div class="block">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.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the form's type.</dd> </dl> </li> </ul> <a name="setInstructions-java.lang.String-">  </a> <ul class="blockList"> <li class="blockList"> <h4>setInstructions</h4> <pre>public void <a href="../../../../src-html/org/jivesoftware/smackx/xdata/Form.html#line.411">setInstructions</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 instructions that explain how to fill out the form and what the form is about.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>instructions</code> - instructions that explain how to fill out the form.</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/Form.html#line.430">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="getDataFormToSend--">  </a> <ul class="blockList"> <li class="blockList"> <h4>getDataFormToSend</h4> <pre>public <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/Form.html#line.441">getDataFormToSend</a>()</pre> <div class="block">Returns a DataForm that serves to send this Form to the server. If the form is of type submit, it may contain fields with no value. These fields will be removed since they only exist to assist the user while editing/completing the form in a UI.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the wrapped DataForm.</dd> </dl> </li> </ul> <a name="createAnswerForm--">  </a> <ul class="blockListLast"> <li class="blockList"> <h4>createAnswerForm</h4> <pre>public <a href="../../../../org/jivesoftware/smackx/xdata/Form.html" title="class in org.jivesoftware.smackx.xdata">Form</a> <a href="../../../../src-html/org/jivesoftware/smackx/xdata/Form.html#line.487">createAnswerForm</a>()</pre> <div class="block">Returns a new Form to submit the completed values. The new Form will include all the fields of the original form except for the fields of type FIXED. Only the HIDDEN fields will include the same value of the original form. The other fields of the new form MUST be completed. If a field remains with no answer when sending the completed form, then it won't be included as part of the completed form.<p> The reason why the fields with variables are included in the new form is to provide a model for binding with any UI. This means that the UIs will use the original form (of type "form") to learn how to render the form, but the UIs will bind the fields to the form of type submit.</div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>a Form to submit the completed values.</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/Form.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/FormField.html" title="class in org.jivesoftware.smackx.xdata"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?org/jivesoftware/smackx/xdata/Form.html" target="_top">Frames</a></li> <li><a href="Form.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>Nested | </li> <li>Field | </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>Field | </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 Form

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Form

Form

Method Detail

getFormFrom

addField

setAnswer

setAnswer

setAnswer

setAnswer

setAnswer

setAnswer

setAnswer

setDefaultAnswer

getFields

getField

getInstructions

getTitle