com.dpslink.base.html

Class Span

java.lang.Object

com.dpslink.base.obj.MappedAttributesObject

com.dpslink.base.html.AbstractField

com.dpslink.base.html.Span

All Implemented Interfaces:

java.io.Serializable

public class Span
extends AbstractField

Defines an HTML span. Although spans are not form fields, they exhibit attributes and behaviors similar to a form field. This class therefore intentionally extends AbstractField.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private static long	serialVersionUID The class' serialization version id.
protected static java.lang.String	SPAN The pattern used to create the html for a span.

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
Span() Constructs a new instance of Span using the supplied parameters.
Span(java.lang.String text) Constructs a new instance of Span 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.
java.lang.String	getText() Returns the span's text attribute.
void	setText(java.lang.String text) Sets the span's text attribute.
void	setTextHS(java.lang.String text) Sets the span's text attribute.
java.lang.String	toHTML() Returns a formatted html string for the span's current attribute values.

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

formatAttr, 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

SPAN

protected static final java.lang.String SPAN

The pattern used to create the html for a span.

See Also:

Constant Field Values

Constructor Detail

Span

public Span()

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

Span

public Span(java.lang.String text)

Constructs a new instance of Span using the supplied parameters.

Parameters:

text - (String) The text value to display. The supplied value is auto-encoded for html safe characters. To construct a span with text that is already html safe, set this value to an empty string and then use the setTextHS() 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.

toHTML

public java.lang.String toHTML()

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

Overrides:

toHTML in class AbstractField

Returns:

String - A formatted html string.

See Also:

AbstractField.toHTML()

getText

public java.lang.String getText()

Returns the span's text attribute.

Returns:

String - The span's text.

setText

public void setText(java.lang.String text)

Sets the span's text attribute.

Parameters:

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

setTextHS

public void setTextHS(java.lang.String text)

Sets the span's text attribute.

Parameters:

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