Class CommandLinkTag

java.lang.Object

jakarta.servlet.jsp.tagext.TagSupport

org.deltava.taglib.BrowserInfoTag

org.deltava.taglib.html.ElementTag

org.deltava.taglib.html.LinkTag

org.deltava.taglib.html.CommandLinkTag

All Implemented Interfaces:

jakarta.servlet.jsp.tagext.IterationTag, jakarta.servlet.jsp.tagext.JspTag, jakarta.servlet.jsp.tagext.Tag, Serializable

public class CommandLinkTag
extends LinkTag

A JSP tag to create a link to a Web Site Command.

Since:

1.0

Version:

11.0

Author:

Luke

See Also:

• Serialized Form

Field Summary

Fields inherited from class ElementTag

_classes, _data, _out

Modifier and Type	Field	Description
protected final Collection<String>	_classes
protected final XMLRenderer	_data
protected jakarta.servlet.jsp.JspWriter	_out

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

id, pageContext

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

EVAL_BODY_AGAIN

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

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Constructors

Constructor	Description
CommandLinkTag()

Method Summary

Modifier and Type	Method	Description
int	doEndTag()	Renders the end of the HREF tag to the JSP output stream.
final int	doStartTag()	Renders the start of the HREF tag to the JSP output stream.
void	release()
void	setAuthOnly(boolean authUsersOnly)	Sets whether to render the link for authenticated users only.
void	setDomain(String domain)	Overrides the domain to use for the link.
void	setLink(DatabaseBean db)	Sets the database ID to link to.
void	setLinkID(String id)	Sets the ID parameter for the command invocation.
void	setNoCache(boolean noCache)	Sets whether to append a cache-busting paramter to the URL.
void	setOp(String opName)	Sets the operation parameter for the command invocation.
void	setSort(String sortType)	Sets the sort parameter for the command invocation.
void	setStartDate(ZonedDateTime dt)	Sets the start date if this is linking to a Calendar command.
void	setUrl(String url)	Sets the command name.

Methods inherited from class LinkTag

setAnchor, setExternal, setLabel, setOnClick, setTarget, validateLink

Modifier and Type	Method	Description
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.
protected void	validateLink()	Validates the tag to ensure a URL/onClick event has been set.

Methods inherited from class ElementTag

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

Modifier and Type	Method	Description
protected int	getFormIndexCount()	Gets and increments the current tab index count for the parent form tag.
protected String	getName()	Returns the type of HTML element this tag generated.
protected FormTag	getParentFormTag()	Returns the parent form tag.
void	setClassName(String cName)	Sets the CSS class name of this HTML element.
void	setID(String id)	Sets the ID of this HTML element.
protected void	setNumericAttr(String attrName, int value, int minValue)	Sets a numeric attribute.
void	setPageContext(jakarta.servlet.jsp.PageContext ctxt)
void	setStyle(String style)	Associates a CSS style with this HTML element.

Methods inherited from class BrowserInfoTag

getBrowserContext, passedCAPTCHA

Modifier and Type	Method	Description
protected HTTPContextData	getBrowserContext()	Fetches the browser data.
protected boolean	passedCAPTCHA()	Returns whether the user has passed CAPTCHA validation.

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

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

Methods inherited from class Object

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

Constructor Details

CommandLinkTag

public CommandLinkTag()

Method Details

setLinkID

public void setLinkID(String id)

Sets the ID parameter for the command invocation.

Parameters:

id - the parameter

setLink

public void setLink(DatabaseBean db)

Sets the database ID to link to.

Parameters:

db - a DatabaseBean with the proper database ID

setAuthOnly

public void setAuthOnly(boolean authUsersOnly)

Sets whether to render the link for authenticated users only.

Parameters:

authUsersOnly - TRUE to render only if logged in, otherwise FALSE

setNoCache

public void setNoCache(boolean noCache)

Sets whether to append a cache-busting paramter to the URL.

Parameters:

noCache - TRUE to invalidate cache, otherwise FALSE

setOp

public void setOp(String opName)

Sets the operation parameter for the command invocation.

Parameters:

opName - the operation name

setSort

public void setSort(String sortType)

Sets the sort parameter for the command invocation.

Parameters:

sortType - the sort type

setDomain

public void setDomain(String domain)

Overrides the domain to use for the link.

Parameters:

domain - the domain name

setUrl

public void setUrl(String url)

Sets the command name.

Overrides:

setUrl in class LinkTag

Parameters:

url - the command name

setStartDate

public void setStartDate(ZonedDateTime dt)

Sets the start date if this is linking to a Calendar command.

Parameters:

dt - the calendar start date/time

release

public void release()

Specified by:

release in interface jakarta.servlet.jsp.tagext.Tag

Overrides:

release in class LinkTag

doStartTag

public final int doStartTag()
                     throws jakarta.servlet.jsp.JspException

Renders the start of the HREF tag to the JSP output stream. The HREF tag will not be rendered if the linkID parameter is "0x0".

Specified by:

doStartTag in interface jakarta.servlet.jsp.tagext.Tag

Overrides:

doStartTag in class LinkTag

Returns:

TagSupport.EVAL_BODY_INCLUDE

Throws:

jakarta.servlet.jsp.JspException - if an error occurs

doEndTag

public int doEndTag()
             throws jakarta.servlet.jsp.JspException

Renders the end of the HREF tag to the JSP output stream.

Specified by:

doEndTag in interface jakarta.servlet.jsp.tagext.Tag

Overrides:

doEndTag in class LinkTag

Returns:

TagSupport.EVAL_PAGE

Throws:

jakarta.servlet.jsp.JspException - if an error occurs