Package org.opencms.jsp
Class CmsJspTagDecorate
java.lang.Object
javax.servlet.jsp.tagext.TagSupport
javax.servlet.jsp.tagext.BodyTagSupport
org.opencms.jsp.CmsJspTagDecorate
- 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:decorate></cms:decorate>
tag to decorate HTML content with configurated decoration maps.- Since:
- 6.1.3
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The name of the default decorator configuration.static final String
The property to store the decorator classname .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 TypeMethodDescriptiondecorateTagAction
(String content, String configFile, String locale, javax.servlet.ServletRequest req) Internal action method.int
doEndTag()
getFile()
Returns the file name.Returns the locale name.Getter for the attribute "noAutoCloseTags" of the <cms:parse> tag.boolean
Returns if the parse action should be disabled to allow inline editing in the container page editor.void
setAllowInlineEdit
(boolean allowInlineEdit) Sets if the parse action should be disabled to allow inline editing in the container page editor.void
Sets the file name.void
Sets the locale name.void
setNoAutoCloseTags
(String noAutoCloseTagList) Setter for the attribute "noAutoCloseTags" of the <cms:parse> tag.Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport
doAfterBody, doInitBody, doStartTag, getBodyContent, getPreviousOut, release, 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
-
DEFAULT_DECORATOR_CONFIGURATION
The name of the default decorator configuration.- See Also:
-
PROPERTY_CATEGORY
The property to store the decorator classname .- See Also:
-
-
Constructor Details
-
CmsJspTagDecorate
public CmsJspTagDecorate()
-
-
Method Details
-
decorateTagAction
public String decorateTagAction(String content, String configFile, String locale, javax.servlet.ServletRequest req) Internal action method.DEcorates a HTMl content block.
- Parameters:
content
- the content to be decoratedconfigFile
- the config filelocale
- the locale to use for decoration or NOLOCALE if not locale should be usedreq
- the current request- Returns:
- the decorated content
-
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()
-
getFile
Returns the file name.- Returns:
- the file name
-
getLocale
Returns the locale name.- Returns:
- the locale name
-
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.
-
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
-
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
-
setFile
Sets the file name.- Parameters:
file
- the file name
-
setLocale
Sets the locale name.- Parameters:
locale
- the locale name
-
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.
-