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:

  • 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