com.dpslink.base.html

Class Textarea

java.lang.Object

com.dpslink.base.obj.MappedAttributesObject

com.dpslink.base.html.AbstractField

com.dpslink.base.html.Textarea

All Implemented Interfaces:

java.io.Serializable

public class Textarea
extends AbstractField

Defines an HTML textarea 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	TEXTAREA The pattern used to create the html for a textarea 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
Textarea(java.lang.String name) Constructs a new instance of Textarea using the supplied parameters.
Textarea(java.lang.String name, int rows, int cols) Constructs a new instance of Textarea using the supplied parameters.
Textarea(java.lang.String name, int rows, int cols, java.lang.String value) Constructs a new instance of Textarea 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	getColumns() Returns the textarea's columns attribute.
java.lang.String	getOnChange() Returns the textarea's onchange event handler attribute.
boolean	getReadOnly() Returns the textarea's readonly state attribute.
int	getRows() Returns the textarea's rows attribute.
java.lang.String	getValue() Returns the textarea's value attribute.
boolean	getWrap() Returns the textarea's wrap state attribute.
void	setColumns(int columns) Sets the textarea's columns attribute.
void	setOnChange(java.lang.String onchange) Sets the textarea's onchange event handler attribute.
void	setReadOnly(boolean readonly) Sets the textarea's readonly state attribute.
void	setRows(int rows) Sets the textarea's rows attribute.
void	setValue(java.lang.String value) Sets the textarea's value attribute.
void	setValueHS(java.lang.String value) Sets the textarea's value attribute.
void	setWrap(boolean wrap) Sets the textarea's wrap state attribute.
java.lang.String	toHTML() Returns a formatted html string for the textarea'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

TEXTAREA

private static final java.lang.String TEXTAREA

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

See Also:

Constant Field Values

Constructor Detail

Textarea

public Textarea(java.lang.String name)

Constructs a new instance of Textarea using the supplied parameters. Defaults the rows to "1", columns to "1", the text value to an empty string and wrapping to "true".

Parameters:

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

Textarea

public Textarea(java.lang.String name,
                int rows,
                int cols)

Constructs a new instance of Textarea using the supplied parameters. Defaults the text value to an empty string and wrapping to "true".

Parameters:

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

rows - (int) The number of rows for the textarea.

cols - (int) The number of columns for the textarea.

Textarea

public Textarea(java.lang.String name,
                int rows,
                int cols,
                java.lang.String value)

Constructs a new instance of Textarea using the supplied parameters. Defaults wrapping to "true".

Parameters:

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

rows - (int) The number of rows for the textarea.

cols - (int) The number of columns for the textarea.

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

Overrides:

toHTML in class AbstractField

Returns:

String - A formatted html string.

See Also:

AbstractField.toHTML()

getColumns

public int getColumns()

Returns the textarea's columns attribute.

Returns:

int - The textarea's columns.

setColumns

public void setColumns(int columns)

Sets the textarea's columns attribute.

Parameters:

columns - (int) The textarea's columns.

getOnChange

public java.lang.String getOnChange()

Returns the textarea's onchange event handler attribute.

Returns:

String - The textarea's onchange event handler.

setOnChange

public void setOnChange(java.lang.String onchange)

Sets the textarea's onchange event handler attribute.

Parameters:

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

getReadOnly

public boolean getReadOnly()

Returns the textarea's readonly state attribute.

Returns:

boolean - The textarea's readonly state.

setReadOnly

public void setReadOnly(boolean readonly)

Sets the textarea's readonly state attribute.

Parameters:

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

getRows

public int getRows()

Returns the textarea's rows attribute.

Returns:

int - The textarea's rows.

setRows

public void setRows(int rows)

Sets the textarea's rows attribute.

Parameters:

rows - (int) The textarea's rows.

getValue

public java.lang.String getValue()

Returns the textarea's value attribute.

Returns:

String - The textarea's value.

setValue

public void setValue(java.lang.String value)

Sets the textarea's value attribute.

Parameters:

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

setValueHS

public void setValueHS(java.lang.String value)

Sets the textarea's value attribute.

Parameters:

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

getWrap

public boolean getWrap()

Returns the textarea's wrap state attribute.

Returns:

boolean - The textarea's wrap state.

setWrap

public void setWrap(boolean wrap)

Sets the textarea's wrap state attribute.

Parameters:

wrap - (boolean) The textarea's wrap state.