uk.ac.ed.epcc.webapp.forms.inputs

Class NumberInput<N extends java.lang.Number>

java.lang.Object

uk.ac.ed.epcc.webapp.forms.inputs.BaseInput<V>

uk.ac.ed.epcc.webapp.forms.inputs.AbstractInput<V>

uk.ac.ed.epcc.webapp.forms.inputs.ParseAbstractInput<N>

uk.ac.ed.epcc.webapp.forms.inputs.NumberInput<N>

Type Parameters:

N - type of result object

All Implemented Interfaces:

BoundedInput<N>, HTML5Input, Input<N>, LengthInput<N>, ParseInput<N>, RangedInput<N>, UnitInput

Direct Known Subclasses:

DoubleInput, IntegerInput, LongInput, RealInput, StorageUnitNumberInput, StorageUnitTextInput

public abstract class NumberInput<N extends java.lang.Number>
extends ParseAbstractInput<N>
implements UnitInput, RangedInput<N>

superclass for all Inputs that return Numbers

Field Summary

Fields

Modifier and Type	Field and Description
protected java.text.NumberFormat	nf

Fields inherited from class uk.ac.ed.epcc.webapp.forms.inputs.BaseInput

validators

Constructor Summary

Constructors

Constructor and Description
NumberInput()

Method Summary

Modifier and Type	Method and Description
java.lang.String	formatRange(N n) format step/range values as used by the input into compatible to the way they are presented.
N	getMax() Maximum valid value null value implies no maximum
N	getMin() Minimum valid value.
N	getStep() Step value defines step value.
java.lang.String	getString(N val) get a String representation of an Object that is compatible with the way the input is parsed
java.lang.String	getType() get the type tag to emit for the corresponding html5 type.
java.lang.String	getUnit() return unit this field is in.
N	setMax(N m) set the maximum value
N	setMin(N m) Set the minimum value
java.text.NumberFormat	setNumberFormat(java.text.NumberFormat n) Set a number format for use with the input
void	setStep(N s)
java.lang.String	setUnit(java.lang.String u) set the units for the field

Methods inherited from class uk.ac.ed.epcc.webapp.forms.inputs.ParseAbstractInput

accept, getBoxWidth, getMaxResultLength, getSingle, setBoxWidth, setMaxResultLength, setSingle

Methods inherited from class uk.ac.ed.epcc.webapp.forms.inputs.AbstractInput

getValue, setKey, setValue

Methods inherited from class uk.ac.ed.epcc.webapp.forms.inputs.BaseInput

addValidator, convert, getKey, getPrettyString, getString, removeValidator, validate, validateInner

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.ac.ed.epcc.webapp.forms.inputs.Input

accept, addValidator, convert, getKey, getPrettyString, getValue, isEmpty, removeValidator, setKey, setValue, validate

Methods inherited from interface uk.ac.ed.epcc.webapp.forms.inputs.ParseInput

getString, parse, parseValue

Field Detail

nf

protected java.text.NumberFormat nf

Constructor Detail

NumberInput

public NumberInput()

Method Detail

getUnit

public java.lang.String getUnit()

return unit this field is in.

Specified by:

getUnit in interface UnitInput

Returns:

String representing unit to use or null if not defined

getMin

public N getMin()

Description copied from interface: BoundedInput

Minimum valid value. null value implies no minimum.

Specified by:

getMin in interface BoundedInput<N extends java.lang.Number>

Returns:

T

getStep

public N getStep()

Description copied from interface: RangedInput

Step value defines step value. Valid values should be a multiple of the setp value. null value implies unconstrained. This is used to drive the html number input.

Specified by:

getStep in interface RangedInput<N extends java.lang.Number>

Returns:

setStep

public void setStep(N s)

getMax

public N getMax()

Description copied from interface: BoundedInput

Maximum valid value null value implies no maximum

Specified by:

getMax in interface BoundedInput<N extends java.lang.Number>

Returns:

T

setMax

public N setMax(N m)

Description copied from interface: BoundedInput

set the maximum value

Specified by:

setMax in interface BoundedInput<N extends java.lang.Number>

Returns:

previous limit

setMin

public N setMin(N m)

Description copied from interface: BoundedInput

Set the minimum value

Specified by:

setMin in interface BoundedInput<N extends java.lang.Number>

Returns:

previous limit

setNumberFormat

public java.text.NumberFormat setNumberFormat(java.text.NumberFormat n)

Set a number format for use with the input

Parameters:

n -

Returns:

NumberFormat previously in use.

setUnit

public java.lang.String setUnit(java.lang.String u)

set the units for the field

Parameters:

u - String reperesenting unit to use

Returns:

previous unit value

getString

public java.lang.String getString(N val)

Description copied from class: BaseInput

get a String representation of an Object that is compatible with the way the input is parsed

Specified by:

getString in interface Input<N extends java.lang.Number>

Overrides:

getString in class BaseInput<N extends java.lang.Number>

Returns:

String or null if val is null

See Also:

ParseInput

formatRange

public java.lang.String formatRange(N n)

Description copied from interface: BoundedInput

format step/range values as used by the input into compatible to the way they are presented. for example a percent input may use 0.0 and 1.0 but present as 0, 100 used to generate HTML5 ranges.

Specified by:

formatRange in interface BoundedInput<N extends java.lang.Number>

Returns:

getType

public java.lang.String getType()

Description copied from interface: HTML5Input

get the type tag to emit for the corresponding html5 type. If this method returns null no type should be used. This is for the case where. a sub-class breaks compatibility and needs to supress a type set in a superclass.

Specified by:

getType in interface HTML5Input

Returns:

name or null;