Package org.opencms.jsp
Class CmsJspTagParse
java.lang.Object
javax.servlet.jsp.tagext.TagSupport
javax.servlet.jsp.tagext.BodyTagSupport
org.opencms.jsp.CmsJspTagParse
- All Implemented Interfaces:
Serializable
,javax.servlet.jsp.tagext.BodyTag
,javax.servlet.jsp.tagext.IterationTag
,javax.servlet.jsp.tagext.JspTag
,javax.servlet.jsp.tagext.Tag
Implements the
<cms:parse></cms:parse>
tag to allow parsing of nested
HTML with the A_CmsConfiguredHtmlParser
} implementation specified by the "parserClass" attribute.
- Since:
- 6.1.3
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The name of the mandatory Tag attribute for the visitor class an instance of will be guided throught the body content.static final String
Tag name constant for log output.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 -
Method Summary
Modifier and TypeMethodDescriptionint
doEndTag()
Getter for the attribute "noAutoCloseTags" of the <cms:parse> tag.getParam()
Returns the param.Returns the fully qualified class name of theA_CmsConfiguredHtmlParser
class to use for parsing.boolean
Returns if the parse action should be disabled to allow inline editing in the container page editor.parseTagAction
(String content, javax.servlet.jsp.PageContext context, A_CmsConfiguredHtmlParser parser) Internal action method.void
release()
void
setAllowInlineEdit
(boolean allowInlineEdit) Sets if the parse action should be disabled to allow inline editing in the container page editor.void
setNoAutoCloseTags
(String noAutoCloseTagList) Setter for the attribute "noAutoCloseTags" of the <cms:parse> tag.void
Sets the param.void
setParserClass
(String parserClass) Sets the fully qualified class name of theA_CmsConfiguredHtmlParser
class to use for parsing.Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport
doAfterBody, doInitBody, doStartTag, 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
-
Field Details
-
ATT_VISITOR_CLASS
The name of the mandatory Tag attribute for the visitor class an instance of will be guided throught the body content.- See Also:
-
TAG_NAME
Tag name constant for log output.- See Also:
-
-
Constructor Details
-
CmsJspTagParse
public CmsJspTagParse()
-
-
Method Details
-
doEndTag
- Specified by:
doEndTag
in interfacejavax.servlet.jsp.tagext.Tag
- Overrides:
doEndTag
in classjavax.servlet.jsp.tagext.BodyTagSupport
- Returns:
- EVAL_PAGE
- Throws:
javax.servlet.jsp.JspException
- in case something goes wrong- See Also:
-
Tag.doEndTag()
-
getNoAutoCloseTags
Getter for the attribute "noAutoCloseTags" of the <cms:parse> tag.Returns a
String
that consists of the comma-separated upper case tag names for which this tag will not correct missing closing tags.- Returns:
- a String that consists of the comma-separated upper case tag names for which this tag will not correct missing closing tags.
-
getParam
Returns the param.- Returns:
- the param
-
getParserClass
Returns the fully qualified class name of theA_CmsConfiguredHtmlParser
class to use for parsing.- Returns:
- the parserrClass
-
isAllowInlineEdit
Returns if the parse action should be disabled to allow inline editing in the container page editor.- Returns:
true
if the parse action should be disabled to allow inline editing in the container page editor
-
parseTagAction
public String parseTagAction(String content, javax.servlet.jsp.PageContext context, A_CmsConfiguredHtmlParser parser) Internal action method.Parses (and potentially transforms) a HTMl content block.
- Parameters:
content
- the content to be parsed / transformedcontext
- needed for getting the encoding / the localeparser
- the visitor / parser to use- Returns:
- the transformed content
-
release
- Specified by:
release
in interfacejavax.servlet.jsp.tagext.Tag
- Overrides:
release
in classjavax.servlet.jsp.tagext.BodyTagSupport
- See Also:
-
Tag.release()
-
setAllowInlineEdit
Sets if the parse action should be disabled to allow inline editing in the container page editor.- Parameters:
allowInlineEdit
-true
to allow inline editing
-
setNoAutoCloseTags
Setter for the attribute "noAutoCloseTags" of the <cms:parse> tag.Awaits a
String
that consists of the comma-separated upper case tag names for which this tag should not correct missing closing tags.- Parameters:
noAutoCloseTagList
- aString
that consists of the comma-separated upper case tag names for which this tag should not correct missing closing tags
-
setParam
Sets the param.- Parameters:
param
- the param to set
-
setParserClass
Sets the fully qualified class name of theA_CmsConfiguredHtmlParser
class to use for parsing.- Parameters:
parserClass
- the fully qualified class name of theA_CmsConfiguredHtmlParser
class to use for parsing
-