tigase.jaxmpp.core.client.xmpp.forms
Class ListMultiField

java.lang.Object
  tigase.jaxmpp.core.client.xml.ElementWrapper
      tigase.jaxmpp.core.client.xmpp.forms.AbstractField<String[]>
          tigase.jaxmpp.core.client.xmpp.forms.ListMultiField

All Implemented Interfaces:

Element, Field<String[]>

public class ListMultiField
extends AbstractField<String[]>

Implementation of list-multi field type.

The field enables an entity to gather or provide one or more options from among many. A form-submitting entity chooses one or more items from among the options presented by the form-processing entity and MUST NOT insert new options. The form-submitting entity MUST NOT modify the order of items as received from the form-processing entity, since the order of items MAY be significant.

Method Summary

void	addFieldValue(String... value) Adds value to field.
void	addOption(String label, String value) Adds option to field.
void	clearOptions() Removes all options.
void	clearValues() Removes all values.
String[]	getFieldValue() Returns value of field.
void	setFieldValue(String[] value) Sets value of field.

Methods inherited from class tigase.jaxmpp.core.client.xmpp.forms.AbstractField

getDesc, getLabel, getType, getVar, isRequired, setDesc, setLabel, setRequired, setVar

Methods inherited from class tigase.jaxmpp.core.client.xml.ElementWrapper

addChild, equals, getAsString, getAttribute, getAttributes, getChildAfter, getChildElementValue, getChildElementValue, getChildren, getChildren, getChildrenNS, getChildrenNS, getFirstChild, getFirstChild, getName, getNextSibling, getParent, getValue, getXMLNS, hashCode, removeAttribute, removeChild, setAttribute, setAttributes, setChildElementValue, setChildElementValue, setParent, setValue, setXMLNS

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

addFieldValue

public void addFieldValue(String... value)
                   throws XMLException

Adds value to field.

Parameters:

value - value to add

Throws:

XMLException

addOption

public void addOption(String label,
                      String value)
               throws XMLException

Adds option to field.

Parameters:

label - label of option

value - value of option

Throws:

XMLException

clearOptions

public void clearOptions()
                  throws XMLException

Removes all options.

Throws:

XMLException

clearValues

public void clearValues()
                 throws XMLException

Removes all values.

Throws:

XMLException

getFieldValue

public String[] getFieldValue()
                       throws XMLException

Returns value of field.

Returns:

value

Throws:

XMLException

setFieldValue

public void setFieldValue(String[] value)
                   throws XMLException

Sets value of field.

Parameters:

value - value of field

Throws:

XMLException