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

Class CheckBoxInput

java.lang.Object

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

uk.ac.ed.epcc.webapp.forms.inputs.AbstractInput<java.lang.String>

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

All Implemented Interfaces:

BinaryInput<java.lang.String>, Input<java.lang.String>, ParseInput<java.lang.String>

public class CheckBoxInput
extends AbstractInput<java.lang.String>
implements ParseInput<java.lang.String>, BinaryInput<java.lang.String>

A checkbox input. One peculiarity of Checkbox input is that it always has a valid state. Inserting an invalid input results in an unchecked state.

Field Summary

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

validators

Constructor Summary

Constructors

Constructor and Description
CheckBoxInput(java.lang.String checked, java.lang.String unchecked)

Method Summary

Modifier and Type	Method and Description
<R> R	accept(InputVisitor<R> vis)
java.lang.String	convert(java.lang.Object o) Perform any supported type conversions to to generate a value of the target type
java.lang.String	getChecked() String value corresponding to a checked input
java.lang.String	getPrettyString(java.lang.String value) Convert a value into a user friendly string.
java.lang.String	getString(java.lang.String value) get a String representation of an Object that is compatible with the way the input is parsed
java.lang.String	getUnChecked()
boolean	isChecked() Is the input checked or not
java.lang.String	parseValue(java.lang.String v) Parse a String into the correct type for this input.
void	setChecked(boolean value) Set the state of the input

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, getKey, 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.ParseInput

getString, parse

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

addValidator, getKey, getValue, isEmpty, removeValidator, setKey, setValue, validate

Constructor Detail

CheckBoxInput

public CheckBoxInput(java.lang.String checked,
                     java.lang.String unchecked)

Method Detail

getChecked

public java.lang.String getChecked()

Description copied from interface: BinaryInput

String value corresponding to a checked input

Specified by:

getChecked in interface BinaryInput<java.lang.String>

Returns:

getUnChecked

public java.lang.String getUnChecked()

isChecked

public boolean isChecked()

Description copied from interface: BinaryInput

Is the input checked or not

Specified by:

isChecked in interface BinaryInput<java.lang.String>

Returns:

parseValue

public java.lang.String parseValue(java.lang.String v)
                            throws ParseException

Description copied from interface: ParseInput

Parse a String into the correct type for this input. This must be compatible with the Input.getString(Object) method.

Specified by:

parseValue in interface ParseInput<java.lang.String>

Returns:

Throws:

ParseException

setChecked

public void setChecked(boolean value)

Description copied from interface: BinaryInput

Set the state of the input

Specified by:

setChecked in interface BinaryInput<java.lang.String>

convert

public java.lang.String convert(java.lang.Object o)
                         throws TypeError

Description copied from interface: Input

Perform any supported type conversions to to generate a value of the target type

Specified by:

convert in interface Input<java.lang.String>

Overrides:

convert in class BaseInput<java.lang.String>

Parameters:

o - Object input

Returns:

target type

Throws:

TypeError

getPrettyString

public java.lang.String getPrettyString(java.lang.String value)

Description copied from interface: Input

Convert a value into a user friendly string. This usually defaults to the same as getString but can be overridden to produce nicer output

Specified by:

getPrettyString in interface Input<java.lang.String>

Overrides:

getPrettyString in class BaseInput<java.lang.String>

Returns:

String

See Also:

ListInput

getString

public java.lang.String getString(java.lang.String value)

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<java.lang.String>

Overrides:

getString in class BaseInput<java.lang.String>

Returns:

String or null if val is null

See Also:

ParseInput

accept

public <R> R accept(InputVisitor<R> vis)
             throws java.lang.Exception

Specified by:

accept in interface Input<java.lang.String>

Throws:

java.lang.Exception