adapforms.form.elements
Class LabelElement

java.lang.Object
  extended by adapforms.form.elements.FormElement
      extended by adapforms.form.elements.ValueHoldingElement
          extended by adapforms.form.elements.LabelElement

public class LabelElement
extends ValueHoldingElement

Read-only label.

The value type is a String.

Author:
Henrik Gammelmark, geemark@cs.au.dk

Constructor Summary
LabelElement(java.lang.String id, SimpleLabel label)
           
 
Method Summary
 LabelElement clone(java.lang.String id, SimpleLabel label)
          Create a clone of the element, given a new ID and label.
 java.lang.Object convertValue(java.lang.Object rawValue, Localization localization)
          Given a raw input value, perform relevant conversions, so that the type integrity is preserved.
 java.lang.String getDefault()
          Default value to be inserted in the form at instantiation.
 java.lang.Object getInitialValue()
          Get the value this element should be initialized with when the element is instantiated in the form instance.
 java.lang.String marshallValue(java.lang.Object value)
          Given a value of the expected type, convert it to a string representation.
 void setDefault(java.lang.String value)
          See getDefault()
 java.lang.String toString()
          Used for pretty-printing the element.
 
Methods inherited from class adapforms.form.elements.ValueHoldingElement
buildError, buildSingleError, cloneFinalize, getRolesWrite, getValidationRules, isEmptyValue, isReadOnly, isRequired, setReadOnly, setRequired, setRolesWrite, setValidationRules, toStringHelper, validateValue
 
Methods inherited from class adapforms.form.elements.FormElement
cloneFinalize, getElementID, getLabel, getRolesRead, getUIFlags, isRelevant, setRelevant, setRolesRead, setUIFlags
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

LabelElement

public LabelElement(java.lang.String id,
                    SimpleLabel label)
Method Detail

getDefault

public java.lang.String getDefault()
Default value to be inserted in the form at instantiation.


setDefault

public void setDefault(java.lang.String value)
See getDefault()


convertValue

public java.lang.Object convertValue(java.lang.Object rawValue,
                                     Localization localization)
                              throws TypeException
Description copied from class: ValueHoldingElement
Given a raw input value, perform relevant conversions, so that the type integrity is preserved.

Specified by:
convertValue in class ValueHoldingElement
Parameters:
rawValue - Value to convert
localization - Localization to use, when generating problem messages
Throws:
TypeException - If the value cannot be converted

clone

public LabelElement clone(java.lang.String id,
                          SimpleLabel label)
Description copied from class: FormElement
Create a clone of the element, given a new ID and label.

Important: The method should call FormElement.cloneFinalize(FormElement) before returning. This adds common parameters to the clone.

Specified by:
clone in class FormElement

marshallValue

public java.lang.String marshallValue(java.lang.Object value)
                               throws TypeException
Description copied from class: ValueHoldingElement
Given a value of the expected type, convert it to a string representation.

Specified by:
marshallValue in class ValueHoldingElement
Parameters:
value - Value to marshall
Returns:
String representation
Throws:
TypeException - If the given value is not recognized

toString

public java.lang.String toString()
Description copied from class: FormElement
Used for pretty-printing the element. See Form.prettyPrintStructure().

Specified by:
toString in class FormElement

getInitialValue

public java.lang.Object getInitialValue()
Description copied from class: ValueHoldingElement
Get the value this element should be initialized with when the element is instantiated in the form instance.

Specified by:
getInitialValue in class ValueHoldingElement
Returns:
Value to set, or null to set no initial value