|
Openfire 3.8.2 Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.jivesoftware.openfire.forms.spi.XFormFieldImpl
FormField
@Deprecated public class XFormFieldImpl
A concrete FormField capable of sending itself to a writer and recover its state from an XMPP stanza.
Field Summary |
---|
Fields inherited from interface org.jivesoftware.openfire.forms.FormField |
---|
TYPE_BOOLEAN, TYPE_FIXED, TYPE_HIDDEN, TYPE_JID_MULTI, TYPE_JID_SINGLE, TYPE_LIST_MULTI, TYPE_LIST_SINGLE, TYPE_TEXT_MULTI, TYPE_TEXT_PRIVATE, TYPE_TEXT_SINGLE |
Constructor Summary | |
---|---|
XFormFieldImpl()
Deprecated. |
|
XFormFieldImpl(String variable)
Deprecated. |
Method Summary | |
---|---|
void |
addOption(String label,
String value)
Deprecated. Adds an available option to the question that the user has in order to answer the question. |
void |
addValue(String value)
Deprecated. Adds a default value to the question if the question is part of a form to fill out. |
org.dom4j.Element |
asXMLElement()
Deprecated. |
void |
clearValues()
Deprecated. Removes all the values of the field. |
String |
getDescription()
Deprecated. Returns a description that provides extra clarification about the question. |
String |
getLabel()
Deprecated. Returns the label of the question which should give enough information to the user to fill out the form. |
String |
getName()
Deprecated. |
String |
getNamespace()
Deprecated. |
String |
getType()
Deprecated. Returns an indicative of the format for the data to answer. |
Iterator<String> |
getValues()
Deprecated. Returns an Iterator for the default values of the question if the question is part of a form to fill out. |
String |
getVariable()
Deprecated. Returns the variable name that the question is filling out. |
boolean |
isRequired()
Deprecated. Returns true if the question must be answered in order to complete the questionnaire. |
void |
parse(org.dom4j.Element formElement)
Deprecated. |
void |
setDescription(String description)
Deprecated. Sets a description that provides extra clarification about the question. |
void |
setLabel(String label)
Deprecated. Sets the label of the question which should give enough information to the user to fill out the form. |
void |
setName(String name)
Deprecated. |
void |
setNamespace(String namespace)
Deprecated. |
void |
setRequired(boolean required)
Deprecated. Sets if the question must be answered in order to complete the questionnaire. |
void |
setType(String type)
Deprecated. Sets an indicative of the format for the data to answer. |
String |
toString()
Deprecated. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public XFormFieldImpl()
public XFormFieldImpl(String variable)
Method Detail |
---|
public String getNamespace()
public void setNamespace(String namespace)
public String getName()
public void setName(String name)
public org.dom4j.Element asXMLElement()
public void addValue(String value)
FormField
addValue
in interface FormField
value
- a default value or an answered value of the question.public void clearValues()
FormField
clearValues
in interface FormField
public void addOption(String label, String value)
FormField
addOption
in interface FormField
label
- a label that represents the option.value
- the value of the option.public void setType(String type)
FormField
setType
in interface FormField
type
- an indicative of the format for the data to answer.public void setRequired(boolean required)
FormField
setRequired
in interface FormField
required
- if the question must be answered in order to complete the questionnaire.public void setLabel(String label)
FormField
setLabel
in interface FormField
label
- the label of the question.public void setDescription(String description)
FormField
If the question is of type FIXED then the description should remain empty.
setDescription
in interface FormField
description
- provides extra clarification about the question.public boolean isRequired()
FormField
isRequired
in interface FormField
public String getVariable()
FormField
getVariable
in interface FormField
public Iterator<String> getValues()
FormField
getValues
in interface FormField
public String getType()
FormField
getType
in interface FormField
public String getLabel()
FormField
getLabel
in interface FormField
public String getDescription()
FormField
If the question is of type FIXED then the description should remain empty.
getDescription
in interface FormField
public void parse(org.dom4j.Element formElement)
public String toString()
toString
in class Object
|
Openfire 3.8.2 Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |