| java.lang.Object
 org.xmpp.forms.FormField
| FormField | | public class FormField (Code) | | 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.
author:
Gaston Dombiak |
| Inner Class :public static class Option | |
| Inner Class :public enum Type | |
| Constructor Summary | |
| | FormField(Element element)
|
| Method Summary | |
| public void | addOption(String label, String value)
Adds an available option to the question that the user has in order to answer
the question. | | public void | addValue(Object value)
Adds a default value to the question if the question is part of a form to fill out. | | public void | clearValues()
Removes all the values of the field. | | public String | getDescription()
Returns a description that provides extra clarification about the question. | | public String | getLabel()
Returns the label of the question which should give enough information to the user to
fill out the form. | | public List<Option> | getOptions()
Returns the available options to answer for this question. | | public Type | getType()
Returns an indicative of the format for the data to answer. | | public List<String> | getValues()
Returns an Iterator for the default values of the question if the question is part
of a form to fill out. | | public String | getVariable()
Returns the variable name that the question is filling out. | | public boolean | isRequired()
Returns true if the question must be answered in order to complete the questionnaire. | | public void | setDescription(String description)
Sets a description that provides extra clarification about the question. | | public void | setLabel(String label)
Sets the label of the question which should give enough information to the user to
fill out the form. | | public void | setRequired(boolean required)
Sets if the question must be answered in order to complete the questionnaire. | | public void | setType(Type type)
Sets an indicative of the format for the data to answer. | | public void | setVariable(String var)
Sets the attribute that uniquely identifies the field in the context of the form. |
| FormField | | FormField(Element element)(Code) | | |
| addOption | | public void addOption(String label, String value)(Code) | | Adds an available option to the question that the user has in order to answer
the question.
Parameters:
label - a label that represents the option.
Parameters:
value - the value of the option. |
| addValue | | public void addValue(Object value)(Code) | | 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. |
| clearValues | | public void clearValues()(Code) | | Removes all the values of the field.
|
| getDescription | | public String getDescription()(Code) | | 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.
description that provides extra clarification about the question. |
| getLabel | | public String getLabel()(Code) | | Returns the label of the question which should give enough information to the user to
fill out the form.
label of the question. |
| getOptions | | public List<Option> getOptions()(Code) | | Returns the available options to answer for this question. The returned options cannot
be modified but they will be updated if the underlying DOM object gets updated.
the available options to answer for this question. |
| getType | | public Type getType()(Code) | | Returns an indicative of the format for the data to answer. Valid formats are:
- text-single -> single line or word of text
- text-private -> instead of showing the user what they typed, you show ***** to
protect it
- text-multi -> multiple lines of text entry
- list-single -> given a list of choices, pick one
- list-multi -> given a list of choices, pick one or more
- boolean -> 0 or 1, true or false, yes or no. Default value is 0
- fixed -> fixed for putting in text to show sections, or just advertise your web
site in the middle of the form
- hidden -> is not given to the user at all, but returned with the questionnaire
- jid-single -> Jabber ID - choosing a JID from your roster, and entering one based
on the rules for a JID.
- jid-multi -> multiple entries for JIDs
format for the data to answer. |
| getValues | | public List<String> getValues()(Code) | | Returns an Iterator for the default values of the question if the question is part
of a form to fill out. Otherwise, returns an Iterator for the answered values of
the question.
an Iterator for the default values or answered values of the question. |
| getVariable | | public String getVariable()(Code) | | Returns the variable name that the question is filling out.
the variable name of the question. |
| isRequired | | public boolean isRequired()(Code) | | Returns true if the question must be answered in order to complete the questionnaire.
true if the question must be answered in order to complete the questionnaire. |
| setDescription | | public void setDescription(String description)(Code) | | 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)(Code) | | 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)(Code) | | 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. |
| setType | | public void setType(Type type)(Code) | | Sets an indicative of the format for the data to answer. Valid formats are:
- text-single -> single line or word of text
- text-private -> instead of showing the user what they typed, you show ***** to
protect it
- text-multi -> multiple lines of text entry
- list-single -> given a list of choices, pick one
- list-multi -> given a list of choices, pick one or more
- boolean -> 0 or 1, true or false, yes or no. Default value is 0
- fixed -> fixed for putting in text to show sections, or just advertise your web
site in the middle of the form
- hidden -> is not given to the user at all, but returned with the questionnaire
- jid-single -> Jabber ID - choosing a JID from your roster, and entering one based
on the rules for a JID.
- jid-multi -> multiple entries for JIDs
Parameters:
type - an indicative of the format for the data to answer. |
| setVariable | | public void setVariable(String var)(Code) | | Sets the attribute that uniquely identifies the field in the context of the form. If the
field is of type "fixed" then the variable is optional.
Parameters:
var - the unique identifier of the field in the context of the form. |
|
|