adapforms.form.elements
Class DecimalElement

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

public class DecimalElement
extends ValueHoldingElement

Decimal number entry field.

The value type is a Double.

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

Constructor Summary
DecimalElement(java.lang.String id, SimpleLabel label)
           
 
Method Summary
 DecimalElement clone(java.lang.String id, SimpleLabel label)
          Create a clone of the element, given a new ID and label.
 java.lang.Double convertValue(java.lang.Object rawValue, Localization localization)
          Given a raw input value, perform relevant conversions, so that the type integrity is preserved.
 java.lang.Double getDefault()
          Default value when instantiating the form.
 java.lang.Double getInitialValue()
          Get the value this element should be initialized with when the element is instantiated in the form instance.
 java.lang.Double getMaxValue()
          Maximum value allowed to be entered.
 java.lang.Double getMinValue()
          Minimal value allowed to be entered.
 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.Double value)
          See getDefault()
 void setMaxValue(java.lang.Double value)
          See getMaxValue().
 void setMinValue(java.lang.Double value)
          See getMinValue().
 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

DecimalElement

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

clone

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

getMinValue

public java.lang.Double getMinValue()
Minimal value allowed to be entered.


setMinValue

public void setMinValue(java.lang.Double value)
See getMinValue().


getMaxValue

public java.lang.Double getMaxValue()
Maximum value allowed to be entered.


setMaxValue

public void setMaxValue(java.lang.Double value)
See getMaxValue().


getDefault

public java.lang.Double getDefault()
Default value when instantiating the form.


setDefault

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


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.

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

convertValue

public java.lang.Double 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.Double 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