| 
 | Smack | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.jivesoftware.smackx.FormField
public class FormField
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 | |
|---|---|
| static class | FormField.OptionRepresents the available option of a given FormField. | 
| Field Summary | |
|---|---|
| static String | TYPE_BOOLEAN | 
| static String | TYPE_FIXED | 
| static String | TYPE_HIDDEN | 
| static String | TYPE_JID_MULTI | 
| static String | TYPE_JID_SINGLE | 
| static String | TYPE_LIST_MULTI | 
| static String | TYPE_LIST_SINGLE | 
| static String | TYPE_TEXT_MULTI | 
| static String | TYPE_TEXT_PRIVATE | 
| static String | TYPE_TEXT_SINGLE | 
| Constructor Summary | |
|---|---|
| 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 | |
|---|---|
|  void | addOption(FormField.Option option)Adss an available options to the question that the user has in order to answer the question. | 
|  void | addValue(String value)Adds a default value to the question if the question is part of a form to fill out. | 
|  void | addValues(List<String> newValues)Adds a default values to the question if the question is part of a form to fill out. | 
|  String | getDescription()Returns a description that provides extra clarification about the question. | 
|  String | getLabel()Returns the label of the question which should give enough information to the user to fill out the form. | 
|  Iterator<FormField.Option> | getOptions()Returns an Iterator for the available options that the user has in order to answer the question. | 
|  String | getType()Returns an indicative of the format for the data to answer. | 
|  Iterator<String> | getValues()Returns an Iterator for the default values of the question if the question is part of a form to fill out. | 
|  String | getVariable()Returns the variable name that the question is filling out. | 
|  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(String type)Sets an indicative of the format for the data to answer. | 
|  String | toXML() | 
| Methods inherited from class java.lang.Object | 
|---|
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Field Detail | 
|---|
public static final String TYPE_BOOLEAN
public static final String TYPE_FIXED
public static final String TYPE_HIDDEN
public static final String TYPE_JID_MULTI
public static final String TYPE_JID_SINGLE
public static final String TYPE_LIST_MULTI
public static final String TYPE_LIST_SINGLE
public static final String TYPE_TEXT_MULTI
public static final String TYPE_TEXT_PRIVATE
public static final String TYPE_TEXT_SINGLE
| Constructor Detail | 
|---|
public FormField(String variable)
variable - the variable name of the question.public FormField()
| Method Detail | 
|---|
public String getDescription()
If the question is of type FIXED then the description should remain empty.
public String getLabel()
public Iterator<FormField.Option> getOptions()
public boolean isRequired()
public String getType()
public Iterator<String> getValues()
public String getVariable()
public void setDescription(String description)
If the question is of type FIXED then the description should remain empty.
description - provides extra clarification about the question.public void setLabel(String label)
label - the label of the question.public void setRequired(boolean required)
required - if the question must be answered in order to complete the questionnaire.public void setType(String type)
type - an indicative of the format for the data to answer.public void addValue(String value)
value - a default value or an answered value of the question.public void addValues(List<String> newValues)
newValues - default values or an answered values of the question.protected void resetValues()
public void addOption(FormField.Option option)
option - a new available option for the question.public String toXML()
| 
 | Smack | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||