Package org.opencms.jsp

Class CmsJspTagTemplate

  • 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
    public class CmsJspTagTemplate
extends javax.servlet.jsp.tagext.BodyTagSupport
    Used to select various template elements form a JSP template that is included in another file.

    Since:
    6.0.0
    See Also:
    Serialized Form

    • Field Summary

      • 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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int doStartTag()  
      java.lang.String getElement()
      Returns the selected element.
      java.lang.String getIfexists()
      Returns the list of elements to check.
      java.lang.String getIfexistsall()
      Returns the list of elements to check.
      java.lang.String getIfexistsnone()
      Returns the list of elements to check.
      java.lang.String getIfexistsone()
      Returns the list of elements to check.
      void release()  
      void setElement​(java.lang.String element)
      Sets the element target.
      void setIfexists​(java.lang.String elements)
      Sets the list of elements to check.
      void setIfexistsall​(java.lang.String elements)
      Sets the list of elements to check.
      void setIfexistsnone​(java.lang.String elements)
      Sets the list of elements to check.
      void setIfexistsone​(java.lang.String elements)
      Sets the list of elements to check.
      static boolean templateTagAction​(java.lang.String element, java.lang.String elementlist, boolean checkall, boolean checknone, javax.servlet.ServletRequest req)
      Internal action method.

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

        doAfterBody, doEndTag, doInitBody, getBodyContent, getPreviousOut, setBodyContent

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

        findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, 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

    • Method Detail

      • templateTagAction

        public static boolean templateTagAction​(java.lang.String element,
                                        java.lang.String elementlist,
                                        boolean checkall,
                                        boolean checknone,
                                        javax.servlet.ServletRequest req)
        Internal action method.

        Parameters:
        element - the selected element
        elementlist - list the list of elements to check
        checkall - flag to indicate that all elements should be checked
        checknone - flag to indicate that the check is done for nonexisting elements
        req - the current request
        Returns:
        boolean true if this element should be inclued, false otherwise

      • doStartTag

        public int doStartTag()
        Specified by:
        doStartTag in interface javax.servlet.jsp.tagext.Tag
        Overrides:
        doStartTag in class javax.servlet.jsp.tagext.BodyTagSupport
        See Also:
        Tag.doStartTag()

      • getElement

        public java.lang.String getElement()
        Returns the selected element.

        Returns:
        the selected element

      • getIfexists

        public java.lang.String getIfexists()
        Returns the list of elements to check.

        Returns:
        the list of elements

      • getIfexistsall

        public java.lang.String getIfexistsall()
        Returns the list of elements to check.

        Returns:
        the list of elements

      • getIfexistsnone

        public java.lang.String getIfexistsnone()
        Returns the list of elements to check.

        Returns:
        the list of elements

      • getIfexistsone

        public java.lang.String getIfexistsone()
        Returns the list of elements to check.

        Returns:
        the list of elements

      • release

        public void release()
        Specified by:
        release in interface javax.servlet.jsp.tagext.Tag
        Overrides:
        release in class javax.servlet.jsp.tagext.BodyTagSupport
        See Also:
        Tag.release()

      • setElement

        public void setElement​(java.lang.String element)
        Sets the element target.

        Parameters:
        element - the target to set

      • setIfexists

        public void setIfexists​(java.lang.String elements)
        Sets the list of elements to check.

        Parameters:
        elements - the list of elements

      • setIfexistsall

        public void setIfexistsall​(java.lang.String elements)
        Sets the list of elements to check.

        Parameters:
        elements - the list of elements

      • setIfexistsnone

        public void setIfexistsnone​(java.lang.String elements)
        Sets the list of elements to check.

        Parameters:
        elements - the list of elements

      • setIfexistsone

        public void setIfexistsone​(java.lang.String elements)
        Sets the list of elements to check.

        Parameters:
        elements - the list of elements