rocks.xmpp.extensions.data.model

Class DataForm.Field

java.lang.Object

rocks.xmpp.extensions.data.model.DataForm.Field

All Implemented Interfaces:

Comparable<DataForm.Field>

Enclosing class:

DataForm

public static final class DataForm.Field
extends Object
implements Comparable<DataForm.Field>

A form field.

See Also:

3.2 The Field Element

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DataForm.Field.Type Defines field types.

Constructor Summary

Constructors

Constructor and Description
Field(DataForm.Field.Type type) Creates a field.
Field(DataForm.Field.Type type, String var, String... values) Creates a field.

Method Summary

Modifier and Type	Method and Description
int	compareTo(DataForm.Field o)
String	getDescription() Gets a natural-language description of the field, intended for presentation in a user-agent (e.g., as a "tool-tip", help button, or explanatory text provided near the field).
String	getLabel() Gets the field label.
Media	getMedia() Gets the media element.
List<DataForm.Option>	getOptions() Gets the options if the field type is DataForm.Field.Type.LIST_SINGLE or DataForm.Field.Type.LIST_MULTI.
DataForm.Field.Type	getType() Gets the field type.
Validation	getValidation() Gets the validation for this field.
List<String>	getValues() Gets the values of the field.
String	getVar() Gets a unique identifier for the field in the context of the form.
boolean	isRequired() If the field as required in order for the form to be considered valid.
void	setDescription(String description) Sets a description of the field.
void	setLabel(String label) Sets the field label.
void	setMedia(Media media) Sets a media element.
void	setRequired(boolean required) Sets the field as required.
void	setType(DataForm.Field.Type type) Sets the field type.
void	setValidation(Validation validation) Sets the validation for this field.
void	setVar(String var) Sets a unique identifier for the field in the context of the form.

Methods inherited from class java.lang.Object

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

Constructor Detail

Field

public Field(DataForm.Field.Type type)

Creates a field.

Parameters:

type - The field type.

Field

public Field(DataForm.Field.Type type,
             String var,
             String... values)

Creates a field.

Parameters:

type - The field type.

var - The unique identifier for the field.

values - The values.

Method Detail

getType

public DataForm.Field.Type getType()

Gets the field type.

Returns:

The field type.

setType

public void setType(DataForm.Field.Type type)

Sets the field type.

Parameters:

type - The type.

getVar

public String getVar()

Gets a unique identifier for the field in the context of the form.

Returns:

The var attribute.

See Also:

setVar(String)

setVar

public void setVar(String var)

Sets a unique identifier for the field in the context of the form.

Parameters:

var - The var attribute.

See Also:

getVar()

getLabel

public String getLabel()

Gets the field label.

Returns:

The label.

See Also:

setLabel(String)

setLabel

public void setLabel(String label)

Sets the field label.

Parameters:

label - The label.

See Also:

getLabel()

getOptions

public List<DataForm.Option> getOptions()

Gets the options if the field type is DataForm.Field.Type.LIST_SINGLE or DataForm.Field.Type.LIST_MULTI.

Returns:

The options.

getValues

public List<String> getValues()

Gets the values of the field. Fields of type DataForm.Field.Type.LIST_MULTI, DataForm.Field.Type.JID_MULTI or DataForm.Field.Type.TEXT_MULTI may contain multiple values.

Returns:

The values.

getMedia

public Media getMedia()

Gets the media element.

Returns:

The media element.

See Also:

setMedia(rocks.xmpp.extensions.data.mediaelement.model.Media)

setMedia

public void setMedia(Media media)

Sets a media element.

Parameters:

media - The media element.

See Also:

getMedia()

getDescription

public String getDescription()

Gets a natural-language description of the field, intended for presentation in a user-agent (e.g., as a "tool-tip", help button, or explanatory text provided near the field).

Returns:

The description.

See Also:

setDescription(String)

setDescription

public void setDescription(String description)

Sets a description of the field.

Parameters:

description - The description.

See Also:

getDescription()

getValidation

public Validation getValidation()

Gets the validation for this field.

Returns:

The validation.

See Also:

XEP-0122: Data Forms Validation

setValidation

public void setValidation(Validation validation)

Sets the validation for this field.

Parameters:

validation - The validation.

See Also:

XEP-0122: Data Forms Validation

isRequired

public boolean isRequired()

If the field as required in order for the form to be considered valid.

Returns:

True, if the field is required.

See Also:

setRequired(boolean)

setRequired

public void setRequired(boolean required)

Sets the field as required.

Parameters:

required - If the field is required.

See Also:

isRequired()

compareTo

public int compareTo(DataForm.Field o)

Specified by:

compareTo in interface Comparable<DataForm.Field>