Package | org.igniterealtime.xiff.data.forms.enum |
Class | public class FormFieldType |
Inheritance | FormFieldType ![]() |
The following field types represent data "types" that are commonly exchanged between Jabber/XMPP entities. These field types are not intended to be as comprehensive as the datatypes defined in, for example, XML Schema Part 2, nor do they define user interface elements.
See also
Constant | Defined By | ||
---|---|---|---|
BOOLEAN : String = boolean [static]
The field enables an entity to gather or provide an either-or choice between two options. | FormFieldType | ||
FIXED : String = fixed [static]
The field is intended for data description (e.g., human-readable text such as "section"
headers) rather than data gathering or provision. | FormFieldType | ||
HIDDEN : String = hidden [static]
The field is not shown to the form-submitting entity, but instead is returned with
the form. | FormFieldType | ||
JID_MULTI : String = jid-multi [static]
The field enables an entity to gather or provide multiple Jabber IDs. | FormFieldType | ||
JID_SINGLE : String = jid-single [static]
The field enables an entity to gather or provide a single Jabber ID. | FormFieldType | ||
LIST_MULTI : String = list-multi [static]
The field enables an entity to gather or provide one or more options from among many. | FormFieldType | ||
LIST_SINGLE : String = list-single [static]
The field enables an entity to gather or provide one option from among many. | FormFieldType | ||
TEXT_MULTI : String = text-multi [static]
The field enables an entity to gather or provide multiple lines of text. | FormFieldType | ||
TEXT_PRIVATE : String = text-private [static]
The field enables an entity to gather or provide a single line or word of text,
which shall be obscured in an interface (e.g., with multiple instances of the
asterisk character). | FormFieldType | ||
TEXT_SINGLE : String = text-single [static]
The field enables an entity to gather or provide a single line or word of text,
which may be shown in an interface. | FormFieldType |
BOOLEAN | Constant |
public static const BOOLEAN:String = boolean
The field enables an entity to gather or provide an either-or choice between two options. The default value is "false".
FIXED | Constant |
public static const FIXED:String = fixed
The field is intended for data description (e.g., human-readable text such as "section"
headers) rather than data gathering or provision. The value
child SHOULD NOT contain
newlines (the \\n and \\r characters); instead an application SHOULD generate multiple
fixed fields, each with one value
child.
HIDDEN | Constant |
public static const HIDDEN:String = hidden
The field is not shown to the form-submitting entity, but instead is returned with the form. The form-submitting entity SHOULD NOT modify the value of a hidden field, but MAY do so if such behavior is defined for the "using protocol".
JID_MULTI | Constant |
public static const JID_MULTI:String = jid-multi
The field enables an entity to gather or provide multiple Jabber IDs. Each provided JID SHOULD be unique (as determined by comparison that includes application of the Nodeprep, Nameprep, and Resourceprep profiles of Stringprep as specified in XMPP Core), and duplicate JIDs MUST be ignored.
Note: Data provided for fields of type "jid-single" or "jid-multi" MUST contain one or more valid Jabber IDs, where validity is determined by the addressing rules defined in XMPP Core.
JID_SINGLE | Constant |
public static const JID_SINGLE:String = jid-single
The field enables an entity to gather or provide a single Jabber ID.
Note: Data provided for fields of type "jid-single" or "jid-multi" MUST contain one or more valid Jabber IDs, where validity is determined by the addressing rules defined in XMPP Core.
LIST_MULTI | Constant |
public static const LIST_MULTI:String = list-multi
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.
Note: The option
elements in list-multi and list-single fields MUST
be unique, where uniqueness is determined by the value of the 'label' attribute and
the XML character data of the value
element (i.e., both must be unique).
LIST_SINGLE | Constant |
public static const LIST_SINGLE:String = list-single
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.
Note: The option
elements in list-multi and list-single fields MUST
be unique, where uniqueness is determined by the value of the 'label' attribute and
the XML character data of the value
element (i.e., both must be unique).
TEXT_MULTI | Constant |
public static const TEXT_MULTI:String = text-multi
The field enables an entity to gather or provide multiple lines of text.
Note: Data provided for fields of type "text-multi" SHOULD NOT contain any newlines
(the \\n and \\r characters). Instead, the application SHOULD split the data into
multiple strings (based on the newlines inserted by the platform), then specify
each string as the XML character data of a distinct value
element. Similarly,
an application that receives multiple value
elements for a field of
type "text-multi" SHOULD merge the XML character data of the value elements into
one text block for presentation to a user, with each string separated by a
newline character as appropriate for that platform.
TEXT_PRIVATE | Constant |
public static const TEXT_PRIVATE:String = text-private
The field enables an entity to gather or provide a single line or word of text, which shall be obscured in an interface (e.g., with multiple instances of the asterisk character).
TEXT_SINGLE | Constant |
public static const TEXT_SINGLE:String = text-single
The field enables an entity to gather or provide a single line or word of text, which may be shown in an interface. This field type is the default and MUST be assumed if a form-submitting entity receives a field type it does not understand.