com.dpslink.base.html

Class Checkbox

java.lang.Object

com.dpslink.base.obj.MappedAttributesObject

com.dpslink.base.html.AbstractField

com.dpslink.base.html.Checkbox

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

Radio

public class Checkbox
extends AbstractField

Defines an HTML checkbox form field.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	CHECKBOX The pattern used to create the html for a checkbox form field.
private static long	serialVersionUID The class' serialization version id.

Fields inherited from class com.dpslink.base.html.AbstractField

PARAM

Fields inherited from class com.dpslink.base.obj.MappedAttributesObject

ivHashCode, ivHashFlds, ivObjAttrs

Constructor Summary

Constructors

Constructor and Description
Checkbox(java.lang.String name) Constructs a new instance of Checkbox using the supplied parameters.
Checkbox(java.lang.String name, java.lang.String value) Constructs a new instance of Checkbox using the supplied parameters.
Checkbox(java.lang.String name, java.lang.String value, boolean checked) Constructs a new instance of Checkbox using the supplied parameters.
Checkbox(java.lang.String name, java.lang.String value, boolean checked, java.lang.String stylecls) Constructs a new instance of Checkbox using the supplied parameters.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Compares the given object to this object and determines if the two are equal.
protected java.lang.String	formatAttr(java.lang.String attr) Returns a formatted html string for the requested attribute value.
boolean	getChecked() Returns the checkbox's checked state attribute.
java.lang.String	getText() Returns the text attribute.
java.lang.String	getValue() Returns the checkbox's value attribute.
void	setChecked(boolean checked) Sets the checkbox's checked state attribute.
void	setText(java.lang.String text) Sets the text attribute.
void	setTextHS(java.lang.String text) Sets the text attribute.
void	setValue(java.lang.String value) Sets the checkbox's value attribute.
java.lang.String	toHTML() Returns a formatted html string for the checkbox's current attribute values.

Methods inherited from class com.dpslink.base.html.AbstractField

getDisabled, getId, getName, getOnBlur, getOnClick, getOnDblClick, getOnFocus, getOnKeyDown, getOnKeyPress, getOnKeyUp, getOnMouseOut, getOnMouseOver, getStyleCls, getStyleStr, setDisabled, setId, setName, setOnBlur, setOnClick, setOnDblClick, setOnFocus, setOnKeyDown, setOnKeyPress, setOnKeyUp, setOnMouseOut, setOnMouseOver, setStyleCls, setStyleStr

Methods inherited from class com.dpslink.base.obj.MappedAttributesObject

cloneMapAttributes, formatValue, formatValue, getHashFields, getMapArrayList, getMapAttributes, getMapBigDecimal, getMapBoolean, getMapDate, getMapDouble, getMapInteger, getMapLong, getMapMapped, getMapObject, getMapShort, getMapString, getMapString, getMapStringBuffer, getMapStringBuilder, getMapTime, getMapTimestamp, getMapVector, hashCode, setHashFields, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMap, setMapAttributes, setMapObject, setMapTime, setMapTimestamp, toStringArray

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

CHECKBOX

private static final java.lang.String CHECKBOX

The pattern used to create the html for a checkbox form field.

See Also:

Constant Field Values

Constructor Detail

Checkbox

public Checkbox(java.lang.String name)

Constructs a new instance of Checkbox using the supplied parameters. Defaults the checkbox value to "ON", the checked state to "unchecked" and the style class to "checkbox".

Parameters:

name - (String) The form field name for the checkbox.

Checkbox

public Checkbox(java.lang.String name,
                java.lang.String value)

Constructs a new instance of Checkbox using the supplied parameters. Defaults the checkbox checked state to "unchecked" and the style class to "checkbox".

Parameters:

name - (String) The form field name for the checkbox.

value - (String) The value returned for a checked checkbox.

Checkbox

public Checkbox(java.lang.String name,
                java.lang.String value,
                boolean checked)

Constructs a new instance of Checkbox using the supplied parameters. Defaults the style class to "checkbox".

Parameters:

name - (String) The form field name for the checkbox.

value - (String) The value returned for a checked checkbox.

checked - (boolean) true to set the initial state of the checkbox to "checked", otherwise false.

Checkbox

public Checkbox(java.lang.String name,
                java.lang.String value,
                boolean checked,
                java.lang.String stylecls)

Constructs a new instance of Checkbox using the supplied parameters.

Parameters:

name - (String) The form field name for the checkbox.

value - (String) The value returned for a checked checkbox.

checked - (boolean) true to set the initial state of the checkbox to "checked", otherwise false.

stylecls - (String) The checkbox's style class.

Method Detail

equals

public boolean equals(java.lang.Object obj)

Compares the given object to this object and determines if the two are equal. Equality is based on formatted html.

Specified by:

equals in class MappedAttributesObject

Parameters:

obj - (Object) The object to compare with this object.

Returns:

boolean - true if the specified object is equal to this object, otherwise false.

formatAttr

protected java.lang.String formatAttr(java.lang.String attr)

Returns a formatted html string for the requested attribute value. Overrides formatAttr in AbstractField.

Overrides:

formatAttr in class AbstractField

Returns:

String - A formatted html string.

See Also:

AbstractField.formatAttr(java.lang.String)

toHTML

public java.lang.String toHTML()

Returns a formatted html string for the checkbox's current attribute values. Overrides toHTML in AbstractField.

Overrides:

toHTML in class AbstractField

Returns:

String - A formatted html string.

See Also:

AbstractField.toHTML()

getChecked

public boolean getChecked()

Returns the checkbox's checked state attribute.

Returns:

boolean - The checkbox's checked state.

setChecked

public void setChecked(boolean checked)

Sets the checkbox's checked state attribute.

Parameters:

checked - (boolean) The checkbox's checked state.

getText

public java.lang.String getText()

Returns the text attribute.

Returns:

String - The text.

setText

public void setText(java.lang.String text)

Sets the text attribute.

Parameters:

text - (String) The text. The supplied value is encoded for html safe characters.

setTextHS

public void setTextHS(java.lang.String text)

Sets the text attribute.

Parameters:

text - (String) The text. The supplied value is assumed to contain html safe characters. No additional encoding is done.

getValue

public java.lang.String getValue()

Returns the checkbox's value attribute.

Returns:

String - The checkbox's value.

setValue

public void setValue(java.lang.String value)

Sets the checkbox's value attribute.

Parameters:

value - (String) The checkbox's value.