Package org.opencms.jsp

Class CmsJspTagTemplate

java.lang.Object
javax.servlet.jsp.tagext.TagSupport
javax.servlet.jsp.tagext.BodyTagSupport
org.opencms.jsp.CmsJspTagTemplate
All Implemented Interfaces:
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:

  • 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

  • Constructor Summary

    Constructors
    Constructor
    Description
    CmsJspTagTemplate()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    doStartTag()
     
    String
    getElement()
    Returns the selected element.
    String
    getIfexists()
    Returns the list of elements to check.
    String
    getIfexistsall()
    Returns the list of elements to check.
    String
    getIfexistsnone()
    Returns the list of elements to check.
    String
    getIfexistsone()
    Returns the list of elements to check.
    void
    release()
     
    void
    setElement(String element)
    Sets the element target.
    void
    setIfexists(String elements)
    Sets the list of elements to check.
    void
    setIfexistsall(String elements)
    Sets the list of elements to check.
    void
    setIfexistsnone(String elements)
    Sets the list of elements to check.
    void
    setIfexistsone(String elements)
    Sets the list of elements to check.
    static boolean
    templateTagAction(String element, 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

  • Constructor Details

  • Method Details

    • templateTagAction

      public static boolean templateTagAction(String element, 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 String getElement()
      Returns the selected element.

      Returns:
      the selected element

    • getIfexists

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

      Returns:
      the list of elements

    • getIfexistsall

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

      Returns:
      the list of elements

    • getIfexistsnone

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

      Returns:
      the list of elements

    • getIfexistsone

      public 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(String element)
      Sets the element target.

      Parameters:
      element - the target to set

    • setIfexists

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

      Parameters:
      elements - the list of elements

    • setIfexistsall

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

      Parameters:
      elements - the list of elements

    • setIfexistsnone

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

      Parameters:
      elements - the list of elements

    • setIfexistsone

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

      Parameters:
      elements - the list of elements