Package com.jalios.jcms.taglib

Class UrlTag

  • All Implemented Interfaces:
    java.io.Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag
    Direct Known Subclasses:
    LinkTag
    public class UrlTag
extends javax.servlet.jsp.tagext.BodyTagSupport
    Output an url using the given parameters. This tag is not a BodyTag but extends BodyTagSupport to allow the LinkTag to benefit from all the computation provided by the UrlTag.
    Since:
    jcms-5.7
    Author:
    Olivier Jaquemet
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String BASE_URL
      Use this request attribute to force a specific base URL to be used in the UrlTag, if this value is specified, it will supercede any other value.

      • Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport

        bodyContent

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

        id, pageContext

      • Fields inherited from interface javax.servlet.jsp.tagext.BodyTag

        EVAL_BODY_BUFFERED, EVAL_BODY_TAG

      • 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
      UrlTag()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int doAfterBody()  
      int doEndTag()  
      int doStartTag()  
      protected java.lang.String getBaseURL​(javax.servlet.http.HttpServletRequest request)  
      void printUrl​(javax.servlet.http.HttpServletRequest request, java.io.Writer out, java.util.Locale locale)
      Prints URL using parameter of this tag.
      void setAnchor​(java.lang.String anchor)  
      void setBaseUrl​(java.lang.String baseURL)  
      void setData​(Data data)  
      void setId​(java.lang.String id)  
      void setParamNames​(java.lang.String[] names)  
      void setParamRemove​(java.lang.String[] remove)  
      void setParams​(java.lang.String params)  
      void setParamValues​(java.lang.String[] values)  
      void setUpdate​(boolean update)  

      • Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport

        doInitBody, getBodyContent, getPreviousOut, release, setBodyContent

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

        findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setPageContext, setParent, setValue

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface javax.servlet.jsp.tagext.Tag

        getParent, setPageContext, setParent

    • Field Detail

      • BASE_URL

        public static final java.lang.String BASE_URL
        Use this request attribute to force a specific base URL to be used in the UrlTag, if this value is specified, it will supercede any other value.
        See Also:
        Constant Field Values

    • Constructor Detail

      • UrlTag

        public UrlTag()

    • Method Detail

      • setData

        public void setData​(Data data)

      • setId

        public void setId​(java.lang.String id)
        Overrides:
        setId in class javax.servlet.jsp.tagext.TagSupport

      • setBaseUrl

        public void setBaseUrl​(java.lang.String baseURL)

      • setUpdate

        public void setUpdate​(boolean update)

      • setParamNames

        public void setParamNames​(java.lang.String[] names)

      • setParamValues

        public void setParamValues​(java.lang.String[] values)

      • setParamRemove

        public void setParamRemove​(java.lang.String[] remove)

      • setParams

        public void setParams​(java.lang.String params)

      • setAnchor

        public void setAnchor​(java.lang.String anchor)

      • printUrl

        public void printUrl​(javax.servlet.http.HttpServletRequest request,
                     java.io.Writer out,
                     java.util.Locale locale)
              throws java.lang.Exception
        Prints URL using parameter of this tag.
        Parameters:
        request - the current HttpServletRequest
        out - the current JspWriter
        locale - the user Locale
        Throws:
        java.lang.Exception
        Since:
        jcms-5.7.0

      • getBaseURL

        protected java.lang.String getBaseURL​(javax.servlet.http.HttpServletRequest request)

      • doStartTag

        public int doStartTag()
               throws javax.servlet.jsp.JspException
        Specified by:
        doStartTag in interface javax.servlet.jsp.tagext.Tag
        Overrides:
        doStartTag in class javax.servlet.jsp.tagext.BodyTagSupport
        Throws:
        javax.servlet.jsp.JspException

      • doAfterBody

        public int doAfterBody()
                throws javax.servlet.jsp.JspException
        Specified by:
        doAfterBody in interface javax.servlet.jsp.tagext.IterationTag
        Overrides:
        doAfterBody in class javax.servlet.jsp.tagext.BodyTagSupport
        Throws:
        javax.servlet.jsp.JspException

      • doEndTag

        public int doEndTag()
             throws javax.servlet.jsp.JspException
        Specified by:
        doEndTag in interface javax.servlet.jsp.tagext.Tag
        Overrides:
        doEndTag in class javax.servlet.jsp.tagext.BodyTagSupport
        Throws:
        javax.servlet.jsp.JspException