tigase.jaxmpp.core.client.xmpp.forms

## Class ListSingleField

- java.lang.Object
- - tigase.jaxmpp.core.client.xml.ElementWrapper
  - - tigase.jaxmpp.core.client.xmpp.forms.AbstractField<String>
    - - tigase.jaxmpp.core.client.xmpp.forms.ListSingleField

- All Implemented Interfaces:
    Element, Field<String>

      public class ListSingleField
      extends AbstractField<String>

  Implementation of list-single field type.

  > The field enables an entity to gather or provide one option from among many. A form-submitting entity chooses one item from among the options presented by the form-processing entity and MUST NOT insert new options.

- - ### Field Summary

    - ### Fields inherited from class tigase.jaxmpp.core.client.xmpp.forms.AbstractField

      `VAR_COMPARATOR`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `addOption(String label, String value)` Adds option to field.
    `void` | `clearOptions()` Removes all options.
    `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, findChild, getAsString, getAttribute, getAttributes, getChildAfter, getChildElementValue, getChildElementValue, getChildren, getChildren, getChildrenNS, getChildrenNS, getFirstChild, getFirstChild, getName, getNextSibling, getParent, getValue, getWrappedElement, getXMLNS, hashCode, removeAttribute, removeChild, setAttribute, setAttributes, setChildElementValue, setChildElementValue, setParent, setValue, setXMLNS, toString`

    - ### Methods inherited from class java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

- - ### Method Detail

    - #### 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`

    - #### 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`

Copyright © 2006–2020 Tigase. All rights reserved.