adapforms.form.elements
Class DateElement

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

public class DateElement
extends ValueHoldingElement

Holds a single date.

The value type is a java.util.Date with only the date part set.

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

Constructor Summary
DateElement(java.lang.String id, SimpleLabel label)
           
 
Method Summary
 DateElement clone(java.lang.String id, SimpleLabel label)
          Create a clone of the element, given a new ID and label.
 java.util.Date convertValue(java.lang.Object rawValue, Localization localization)
          Given a raw input value, perform relevant conversions, so that the type integrity is preserved.
static java.lang.String getExpectedFormat()
          A string representing the format expected for raw string dates.
 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.
 java.lang.String toString()
          Used for pretty-printing the element.
 java.util.List<ValidationProblem> validateValue(java.lang.Object value, Localization localization)
          Given a converted (see ValueHoldingElement.convertValue(java.lang.Object, adapforms.runtime.i18n.Localization)) value, check if it is valid.
 
Methods inherited from class adapforms.form.elements.ValueHoldingElement
buildError, buildSingleError, cloneFinalize, getRolesWrite, getValidationRules, isEmptyValue, isReadOnly, isRequired, setReadOnly, setRequired, setRolesWrite, setValidationRules, toStringHelper
 
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

DateElement

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

clone

public DateElement 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

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

validateValue

public java.util.List<ValidationProblem> validateValue(java.lang.Object value,
                                                       Localization localization)
Description copied from class: ValueHoldingElement
Given a converted (see ValueHoldingElement.convertValue(java.lang.Object, adapforms.runtime.i18n.Localization)) value, check if it is valid. This enables the element to perform simple validation.

Overrides:
validateValue in class ValueHoldingElement
Parameters:
value - Value to validate
localization - Localization to use, when generating problem messages
Returns:
null or empty list if ok, problem list otherwise.

convertValue

public java.util.Date 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

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

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

getExpectedFormat

public static java.lang.String getExpectedFormat()
A string representing the format expected for raw string dates. Example: dd/MM/yyyy