com.dpslink.base.html

Class Text

java.lang.Object

com.dpslink.base.obj.MappedAttributesObject

com.dpslink.base.html.AbstractField

com.dpslink.base.html.Text

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

Password

public class Text
extends AbstractField

Defines an HTML text form field.

See Also:

Serialized Form

Field Summary

Fields

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

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
Text(java.lang.String name) Constructs a new instance of Text using the supplied parameters.
Text(java.lang.String name, int size) Constructs a new instance of Text using the supplied parameters.
Text(java.lang.String name, int size, int maxlen) Constructs a new instance of Text using the supplied parameters.
Text(java.lang.String name, int size, int maxlen, java.lang.String value) Constructs a new instance of Text 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.
int	getMaxLength() Returns the text's max length attribute.
java.lang.String	getOnChange() Returns the text's onchange event handler attribute.
boolean	getReadOnly() Returns the text's readonly state attribute.
int	getSize() Returns the text's size attribute.
java.lang.String	getValue() Returns the text's value attribute.
void	setMaxLength(int maxlen) Sets the text's max length attribute.
void	setOnChange(java.lang.String onchange) Sets the text's onchange event handler attribute.
void	setReadOnly(boolean readonly) Sets the text's readonly state attribute.
void	setSize(int size) Sets the text's size attribute.
void	setValue(java.lang.String value) Sets the text's value attribute.
void	setValueHS(java.lang.String value) Sets the text's value attribute.
java.lang.String	toHTML() Returns a formatted html string for the text'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

TEXT

private static final java.lang.String TEXT

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

See Also:

Constant Field Values

Constructor Detail

Text

public Text(java.lang.String name)

Constructs a new instance of Text using the supplied parameters. Defaults the text size to "1", the maximum length to "1" and the text value to an empty string.

Parameters:

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

Text

public Text(java.lang.String name,
            int size)

Constructs a new instance of Text using the supplied parameters. Defaults the maximum length to the given size and the text value to an empty string.

Parameters:

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

size - (int) The number of visible characters for the text.

Text

public Text(java.lang.String name,
            int size,
            int maxlen)

Constructs a new instance of Text using the supplied parameters. Defaults the text value to an empty string.

Parameters:

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

size - (int) The number of visible characters for the text.

maxlen - (int) The maximum number of characters that can be entered into the field.

Text

public Text(java.lang.String name,
            int size,
            int maxlen,
            java.lang.String value)

Constructs a new instance of Text using the supplied parameters.

Parameters:

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

size - (int) The number of visible characters for the text.

maxlen - (int) The maximum number of characters that can be entered into the field.

value - (String) The text value to display. The supplied value is auto-encoded for html safe characters. To construct a field with text that is already html safe, set this value to an empty string and then use the setValueHS() method to set the html safe text value.

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 text's current attribute values. Overrides toHTML in AbstractField.

Overrides:

toHTML in class AbstractField

Returns:

String - A formatted html string.

See Also:

AbstractField.toHTML()

getMaxLength

public int getMaxLength()

Returns the text's max length attribute.

Returns:

int - The text's max length.

setMaxLength

public void setMaxLength(int maxlen)

Sets the text's max length attribute.

Parameters:

maxlen - (int) The text's max length.

getOnChange

public java.lang.String getOnChange()

Returns the text's onchange event handler attribute.

Returns:

String - The text's onchange event handler.

setOnChange

public void setOnChange(java.lang.String onchange)

Sets the text's onchange event handler attribute.

Parameters:

onchange - (String) The text's onchange event handler.

getReadOnly

public boolean getReadOnly()

Returns the text's readonly state attribute.

Returns:

boolean - The text's readonly state.

setReadOnly

public void setReadOnly(boolean readonly)

Sets the text's readonly state attribute.

Parameters:

readonly - (boolean) The text's readonly state.

getSize

public int getSize()

Returns the text's size attribute.

Returns:

int - The text's size.

setSize

public void setSize(int size)

Sets the text's size attribute.

Parameters:

size - (int) The text's size.

getValue

public java.lang.String getValue()

Returns the text's value attribute.

Returns:

String - The text's value.

setValue

public void setValue(java.lang.String value)

Sets the text's value attribute.

Parameters:

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

setValueHS

public void setValueHS(java.lang.String value)

Sets the text's value attribute.

Parameters:

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