Package org.opencms.jsp
Class CmsJspTagContentCheck
- java.lang.Object
-
- javax.servlet.jsp.tagext.TagSupport
-
- org.opencms.jsp.CmsJspTagContentCheck
-
- All Implemented Interfaces:
java.io.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:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description CmsJspTagContentCheck()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static boolean
contentCheckTagAction(java.lang.String elementList, java.lang.String prefix, boolean checkall, boolean checknone, I_CmsXmlDocument content, java.util.Locale locale)
Internal action method to check the elements from the provided XML content item.int
doEndTag()
int
doStartTag()
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.java.lang.String
getLocale()
Returns the locale used for checking.void
release()
void
setIfexists(java.lang.String elementList)
Sets the list of elements to check for.void
setIfexistsall(java.lang.String elementList)
Sets the list of elements to check for.void
setIfexistsnone(java.lang.String elementList)
Sets the list of elements to check for.void
setIfexistsone(java.lang.String elementList)
Sets the list of elements to check for.void
setLocale(java.lang.String locale)
Sets the locale used for checking.
-
-
-
Constructor Detail
-
CmsJspTagContentCheck
public CmsJspTagContentCheck()
-
-
Method Detail
-
contentCheckTagAction
public static boolean contentCheckTagAction(java.lang.String elementList, java.lang.String prefix, boolean checkall, boolean checknone, I_CmsXmlDocument content, java.util.Locale locale)
Internal action method to check the elements from the provided XML content item.- Parameters:
elementList
- the list of elements to check forprefix
- the Xpath prefix to append the elements to (in case of nested schemas)checkall
- flag to indicate that all elements should be checkedchecknone
- flag to indicate that the check is done for nonexisting elementscontent
- the XML content document to check the elements fromlocale
- 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 interfacejavax.servlet.jsp.tagext.Tag
- Overrides:
doEndTag
in classjavax.servlet.jsp.tagext.TagSupport
- See Also:
Tag.doEndTag()
-
doStartTag
public int doStartTag() throws javax.servlet.jsp.JspException
- Specified by:
doStartTag
in interfacejavax.servlet.jsp.tagext.Tag
- Overrides:
doStartTag
in classjavax.servlet.jsp.tagext.TagSupport
- Throws:
javax.servlet.jsp.JspException
- See Also:
Tag.doStartTag()
-
getIfexists
public java.lang.String getIfexists()
Returns the list of elements to check.- Returns:
- the list of elements to check
-
getIfexistsall
public java.lang.String getIfexistsall()
Returns the list of elements to check.- Returns:
- the list of elements to check
-
getIfexistsnone
public java.lang.String getIfexistsnone()
Returns the list of elements to check.- Returns:
- the list of elements to check
-
getIfexistsone
public java.lang.String getIfexistsone()
Returns the list of elements to check.- Returns:
- the list of elements to check
-
getLocale
public java.lang.String getLocale()
Returns the locale used for checking.- Returns:
- the locale used for checking
-
release
public void release()
- Specified by:
release
in interfacejavax.servlet.jsp.tagext.Tag
- Overrides:
release
in classjavax.servlet.jsp.tagext.TagSupport
- See Also:
Tag.release()
-
setIfexists
public void setIfexists(java.lang.String elementList)
Sets the list of elements to check for.- Parameters:
elementList
- the list of elements to check for
-
setIfexistsall
public void setIfexistsall(java.lang.String elementList)
Sets the list of elements to check for.- Parameters:
elementList
- the list of elements to check for
-
setIfexistsnone
public void setIfexistsnone(java.lang.String elementList)
Sets the list of elements to check for.- Parameters:
elementList
- the list of elements to check for
-
setIfexistsone
public void setIfexistsone(java.lang.String elementList)
Sets the list of elements to check for.- Parameters:
elementList
- the list of elements to check for
-
setLocale
public void setLocale(java.lang.String locale)
Sets the locale used for checking.- Parameters:
locale
- the locale to set
-
-