com.uc4.api

Class FormItemLabel

java.lang.Object

com.uc4.api.FormItemLabel

All Implemented Interfaces:

IFormItem

public class FormItemLabel
extends java.lang.Object
implements IFormItem

This class represents a label in a Form.

Constructor Summary

Constructors

Constructor and Description
FormItemLabel(org.w3c.dom.Element labelElement) Constructs a FormItemLabel from the specified XML element.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getId() Returns the internal ID of this field.
java.lang.String	getLabel() Returns the label of the field.
java.lang.String	getValue() Returns the current value.
boolean	isLabel() Returns true if this form item is a label.
boolean	isList() Returns true if this form item is a list.
boolean	isNumber() Returns true if this form item is a number field.
boolean	isRequired() Returns true if an input is required.
boolean	isText() Returns true if this form item is a text input field.
boolean	isValid() Tests if the current value a valid input for this field.
void	setValue(java.lang.String value) Sets a new value for this field.

Methods inherited from class java.lang.Object

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

Constructor Detail

FormItemLabel

public FormItemLabel(org.w3c.dom.Element labelElement)

Constructs a FormItemLabel from the specified XML element.

Parameters:

labelElement - Element

Method Detail

isLabel

public boolean isLabel()

Description copied from interface: IFormItem

Returns true if this form item is a label.

Specified by:

isLabel in interface IFormItem

Returns:

Boolean indicating if this item is label

isText

public boolean isText()

Description copied from interface: IFormItem

Returns true if this form item is a text input field. A cast to FormItemText can be done if this method returns true.

Specified by:

isText in interface IFormItem

Returns:

Boolean indicating if this item is a text input field

isNumber

public boolean isNumber()

Description copied from interface: IFormItem

Returns true if this form item is a number field. A cast to FormItemNumber can be done if this method returns true.

Specified by:

isNumber in interface IFormItem

Returns:

Boolean indicating if this item is a number field

isList

public boolean isList()

Description copied from interface: IFormItem

Returns true if this form item is a list. A cast to FormItemList can be done if this method returns true.

Specified by:

isList in interface IFormItem

Returns:

Boolean indicating if this item is a list

getLabel

public java.lang.String getLabel()

Description copied from interface: IFormItem

Returns the label of the field.

Specified by:

getLabel in interface IFormItem

Returns:

Label of the field

setValue

public void setValue(java.lang.String value)

Description copied from interface: IFormItem

Sets a new value for this field. This method can throw an exception if the input is not valid.

Specified by:

setValue in interface IFormItem

Parameters:

value - New value

getValue

public java.lang.String getValue()

Description copied from interface: IFormItem

Returns the current value. If a default value is set this method can be used to read the default value.

Specified by:

getValue in interface IFormItem

Returns:

Value of this field

isRequired

public boolean isRequired()

Description copied from interface: IFormItem

Returns true if an input is required. In this case the value cannot be an empty String.

Specified by:

isRequired in interface IFormItem

Returns:

Boolean indicating if a value is required to process the form

getId

public java.lang.String getId()

Description copied from interface: IFormItem

Returns the internal ID of this field.

Specified by:

getId in interface IFormItem

Returns:

String representing the ID

isValid

public boolean isValid()

Description copied from interface: IFormItem

Tests if the current value a valid input for this field.

Specified by:

isValid in interface IFormItem

Returns:

Boolean indicating if this IFormItem is valid.