Package org.opencms.jsp
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
Used to check the availablity of an XML content item for conditional display.
- Since:
- 6.0.0
- See Also:
-
Field Summary
Fields inherited from class javax.servlet.jsp.tagext.TagSupport
id, pageContext
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 -
Method Summary
Modifier and TypeMethodDescriptionstatic 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.int
doEndTag()
int
Returns the list of elements to check.Returns the list of elements to check.Returns the list of elements to check.Returns the list of elements to check.Returns the locale used for checking.void
release()
void
setIfexists
(String elementList) Sets the list of elements to check for.void
setIfexistsall
(String elementList) Sets the list of elements to check for.void
setIfexistsnone
(String elementList) Sets the list of elements to check for.void
setIfexistsone
(String elementList) Sets the list of elements to check for.void
Sets the locale used for checking.Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue
-
Constructor Details
-
CmsJspTagContentCheck
public CmsJspTagContentCheck()
-
-
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 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
- Specified by:
doEndTag
in interfacejavax.servlet.jsp.tagext.Tag
- Overrides:
doEndTag
in classjavax.servlet.jsp.tagext.TagSupport
- See Also:
-
Tag.doEndTag()
-
doStartTag
- 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
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
Returns the locale used for checking.- Returns:
- the locale used for checking
-
release
- Specified by:
release
in interfacejavax.servlet.jsp.tagext.Tag
- Overrides:
release
in classjavax.servlet.jsp.tagext.TagSupport
- See Also:
-
Tag.release()
-
setIfexists
Sets the list of elements to check for.- Parameters:
elementList
- the list of elements to check for
-
setIfexistsall
Sets the list of elements to check for.- Parameters:
elementList
- the list of elements to check for
-
setIfexistsnone
Sets the list of elements to check for.- Parameters:
elementList
- the list of elements to check for
-
setIfexistsone
Sets the list of elements to check for.- Parameters:
elementList
- the list of elements to check for
-
setLocale
Sets the locale used for checking.- Parameters:
locale
- the locale to set
-