Package org.deltava.taglib.html

Class LinkTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

org.deltava.taglib.BrowserInfoTag

org.deltava.taglib.html.ElementTag

org.deltava.taglib.html.LinkTag

All Implemented Interfaces:

Serializable, IterationTag, JspTag, Tag

Direct Known Subclasses:

CommandLinkTag, ScrollTag

public class LinkTag
extends ElementTag

A JSP tag to generate an HTML link.

Since:

1.0

Version:

7.4

Author:

Luke

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.deltava.taglib.html.ElementTag

_classes, _data, _out

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

id, pageContext

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Constructors

Constructor	Description
LinkTag()	Generates a new link tag.

Method Summary

Modifier and Type	Method	Description
int	doEndTag()	Closes this link element by writing an >/A< tag.
int	doStartTag()	Opens this link element by writing an >A< tag.
void	release()	Releases the tag's state variables.
void	setAnchor(String a)	Sets the anchor for this link.
void	setExternal(boolean isExternal)	Marks this link as an external link.
void	setLabel(String label)	Sets the label for this link.
void	setOnClick(String js)	Sets the JavaScript onClick event for this link.
void	setTarget(String targetFrame)	Sets the target frame for this link.
void	setUrl(String url)	Sets the target URL for this link.
protected void	validateLink()	Validates the tag to ensure a URL/onClick event has been set.

Methods inherited from class org.deltava.taglib.html.ElementTag

getFormIndexCount, getName, getParentFormTag, setClassName, setID, setNumericAttr, setPageContext, setStyle

Methods inherited from class org.deltava.taglib.BrowserInfoTag

getBrowserContext

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

doAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setParent, setValue

Methods inherited from class java.lang.Object

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

Constructor Details

LinkTag

public LinkTag()

Generates a new link tag.

Method Details

doStartTag

public int doStartTag()
               throws JspException

Opens this link element by writing an >A< tag.

Specified by:

doStartTag in interface Tag

Overrides:

doStartTag in class ElementTag

Throws:

JspException - if an error occurs;

doEndTag

public int doEndTag()
             throws JspException

Closes this link element by writing an >/A< tag.

Specified by:

doEndTag in interface Tag

Overrides:

doEndTag in class TagSupport

Throws:

JspException - if an I/O error occurs

setUrl

public void setUrl(String url)

Sets the target URL for this link.

Parameters:

url - the target URL

setOnClick

public void setOnClick(String js)

Sets the JavaScript onClick event for this link.

Parameters:

js - the JavaScript code to execute when this link is clicked

setAnchor

public void setAnchor(String a)

Sets the anchor for this link.

Parameters:

a - the anchor

setLabel

public void setLabel(String label)

Sets the label for this link.

Parameters:

label - the link label

setTarget

public void setTarget(String targetFrame)

Sets the target frame for this link.

Parameters:

targetFrame - the target frame name

setExternal

public void setExternal(boolean isExternal)

Marks this link as an external link.

Parameters:

isExternal - TRUE if the link is external, otherwise FALSE

validateLink

protected void validateLink()
                     throws IllegalStateException

Validates the tag to ensure a URL/onClick event has been set.

Throws:

IllegalStateException - if neither a URL nor onClick are present

release

public void release()

Releases the tag's state variables.

Specified by:

release in interface Tag

Overrides:

release in class ElementTag