com.dpslink.base.html

Class Link

java.lang.Object

com.dpslink.base.obj.MappedAttributesObject

com.dpslink.base.html.AbstractField

com.dpslink.base.html.Link

All Implemented Interfaces:

java.io.Serializable

public class Link
extends AbstractField

Defines an HTML link or anchor. Although links and anchors are not form fields, they both 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
protected static java.lang.String	HREF_VOID The default href to assign when null is supplied on one of the constructors or the setHref() method.
protected static java.lang.String	LINK The pattern used to create the html for a link or anchor.
private static long	serialVersionUID The class' serialization version id.
static java.lang.String	TARGET_BLANK A constant for the _blank target value.
static java.lang.String	TARGET_PARENT A constant for the _parent target value.
static java.lang.String	TARGET_SELF A constant for the _self target value.
static java.lang.String	TARGET_TOP A constant for the _top target value.

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
Link(java.lang.String href) Constructs a new instance of Link using the supplied parameters.
Link(java.lang.String href, java.lang.String text) Constructs a new instance of Link using the supplied parameters.
Link(java.lang.String href, java.lang.String text, java.lang.String target) Constructs a new instance of Link 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.
java.lang.String	getHRef() Returns the link's href attribute.
java.lang.String	getTarget() Returns the link's target attribute.
java.lang.String	getText() Returns the link's text attribute.
void	setHRef(java.lang.String href) Sets the link's href attribute.
void	setTarget(java.lang.String target) Sets the link's target attribute.
void	setText(java.lang.String text) Sets the link's text attribute.
void	setTextHS(java.lang.String text) Sets the link's text attribute.
java.lang.String	toHTML() Returns a formatted html string for the link'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

LINK

protected static final java.lang.String LINK

The pattern used to create the html for a link or anchor.

See Also:

Constant Field Values

TARGET_BLANK

public static final java.lang.String TARGET_BLANK

A constant for the _blank target value.

See Also:

Constant Field Values

TARGET_PARENT

public static final java.lang.String TARGET_PARENT

A constant for the _parent target value.

See Also:

Constant Field Values

TARGET_SELF

public static final java.lang.String TARGET_SELF

A constant for the _self target value.

See Also:

Constant Field Values

TARGET_TOP

public static final java.lang.String TARGET_TOP

A constant for the _top target value.

See Also:

Constant Field Values

HREF_VOID

protected static final java.lang.String HREF_VOID

The default href to assign when null is supplied on one of the constructors or the setHref() method.

See Also:

Constant Field Values

Constructor Detail

Link

public Link(java.lang.String href)

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

Note: HTML links have an href and no name. HTML anchors have a name and may or may not have an href. To create an anchor, use setName() to set the anchor name.

Parameters:

href - (String) The href for the link. If null is supplied, the default "javascript:void(0)" will be assigned.

Link

public Link(java.lang.String href,
            java.lang.String text)

Constructs a new instance of Link using the supplied parameters. Defaults the target to an empty string.

Note: HTML links have an href and no name. HTML anchors have a name and may or may not have an href. To create an anchor, use setName() to set the anchor name.

Parameters:

href - (String) The href for the link. If null is supplied, the default "javascript:void(0)" will be assigned.

text - (String) The text value to display. The supplied value is auto-encoded for html safe characters. To construct a link 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.

Link

public Link(java.lang.String href,
            java.lang.String text,
            java.lang.String target)

Constructs a new instance of Link using the supplied parameters.

Note: HTML links have an href and no name. HTML anchors have a name and may or may not have an href. To create an anchor, use setName() to set the anchor name.

Parameters:

href - (String) The href for the link. If null is supplied, the default "javascript:void(0)" will be assigned.

text - (String) The text value to display. The supplied value is auto-encoded for html safe characters. To construct a link 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.

target - (String) The target for the link.

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 link's current attribute values. Overrides toHTML in AbstractField. If the href is the default (javascript:void(0)) and no onclick event handler has been specified, then only the text value is returned (no link).

Overrides:

toHTML in class AbstractField

Returns:

String - A formatted html string.

See Also:

AbstractField.toHTML()

getHRef

public java.lang.String getHRef()

Returns the link's href attribute.

Returns:

String - The link's href.

setHRef

public void setHRef(java.lang.String href)

Sets the link's href attribute.

Parameters:

href - (String) The link's href. If null is supplied, the default "javascript:void(0)" will be assigned.

getTarget

public java.lang.String getTarget()

Returns the link's target attribute.

Returns:

String - The link's target.

setTarget

public void setTarget(java.lang.String target)

Sets the link's target attribute.

Parameters:

target - (String) The link's target.

getText

public java.lang.String getText()

Returns the link's text attribute.

Returns:

String - The link's text.

setText

public void setText(java.lang.String text)

Sets the link's text attribute.

Parameters:

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

setTextHS

public void setTextHS(java.lang.String text)

Sets the link's text attribute.

Parameters:

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