Class CmsJspTagContentCheck

java.lang.Object
javax.servlet.jsp.tagext.TagSupport
org.opencms.jsp.CmsJspTagContentCheck
All Implemented Interfaces:
Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class CmsJspTagContentCheck extends javax.servlet.jsp.tagext.TagSupport
Used to check the availablity of an XML content item for conditional display.

Since:
6.0.0
See Also:
  • Constructor Details

  • Method Details

    • contentCheckTagAction

      public static boolean contentCheckTagAction(String elementList, String prefix, boolean checkall, boolean checknone, I_CmsXmlDocument content, Locale locale)
      Internal action method to check the elements from the provided XML content item.

      Parameters:
      elementList - the list of elements to check for
      prefix - the Xpath prefix to append the elements to (in case of nested schemas)
      checkall - flag to indicate that all elements should be checked
      checknone - flag to indicate that the check is done for nonexisting elements
      content - the XML content document to check the elements from
      locale - the locale to check the element for
      Returns:
      true if the test succeeds, false if the test fails
    • doEndTag

      public int doEndTag()
      Specified by:
      doEndTag in interface javax.servlet.jsp.tagext.Tag
      Overrides:
      doEndTag in class javax.servlet.jsp.tagext.TagSupport
      See Also:
      • Tag.doEndTag()
    • 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.TagSupport
      Throws:
      javax.servlet.jsp.JspException
      See Also:
      • Tag.doStartTag()
    • getIfexists

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

      Returns:
      the list of elements to check
    • getIfexistsall

      Returns the list of elements to check.

      Returns:
      the list of elements to check
    • getIfexistsnone

      Returns the list of elements to check.

      Returns:
      the list of elements to check
    • getIfexistsone

      Returns the list of elements to check.

      Returns:
      the list of elements to check
    • getLocale

      public String getLocale()
      Returns the locale used for checking.

      Returns:
      the locale used for checking
    • release

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

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

      Parameters:
      elementList - the list of elements to check for
    • setIfexistsall

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

      Parameters:
      elementList - the list of elements to check for
    • setIfexistsnone

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

      Parameters:
      elementList - the list of elements to check for
    • setIfexistsone

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

      Parameters:
      elementList - the list of elements to check for
    • setLocale

      public void setLocale(String locale)
      Sets the locale used for checking.

      Parameters:
      locale - the locale to set