Package com.uc4.api

Class FormItemLabel

java.lang.Object

com.uc4.api.AbstractFormItem

com.uc4.api.FormItemLabel

All Implemented Interfaces:

IFormItem

public class FormItemLabel
extends AbstractFormItem

This class represents a label in a Form.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
java.lang.String	getId()	ID has to be null for labels
java.lang.String	getValue()	Returns the current value.
boolean	isLabel()	Returns true if this form item is a label.
boolean	isRequired()	Returns true if an input is required.
void	setValue(java.lang.String value)	Sets a new value for this field.

Methods inherited from class com.uc4.api.AbstractFormItem

getLabel, isFixed, isList, isNewLine, isNumber, isText, isUppercase, isValid

Methods inherited from class java.lang.Object

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

Constructor Detail

FormItemLabel

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

Constructs a FormItemLabel from the specified XML element.

Parameters:

element - XML 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

Overrides:

isLabel in class AbstractFormItem

Returns:

Boolean indicating if this item is label

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.

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.

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

Overrides:

isRequired in class AbstractFormItem

Returns:

Boolean indicating if a value is required to process the form

getId

public java.lang.String getId()

ID has to be null for labels

Specified by:

getId in interface IFormItem

Overrides:

getId in class AbstractFormItem

Returns:

String representing the ID