Class HtmlEscapingAwareTag
java.lang.Object
jakarta.servlet.jsp.tagext.TagSupport
org.springframework.web.servlet.tags.RequestContextAwareTag
org.springframework.web.servlet.tags.HtmlEscapingAwareTag
- All Implemented Interfaces:
IterationTag,JspTag,Tag,TryCatchFinally,Serializable
- Direct Known Subclasses:
AbstractFormTag,BindErrorsTag,BindTag,EscapeBodyTag,EvalTag,MessageTag,TransformTag,UrlTag
Superclass for tags that output content that might get HTML-escaped.
Provides a "htmlEscape" property for explicitly specifying whether to
apply HTML escaping. If not set, a page-level default (e.g. from the
HtmlEscapeTag) or an application-wide default (the "defaultHtmlEscape"
context-param in web.xml) is used.
- Since:
- 1.1
- Author:
- Juergen Hoeller, Brian Clozel
- See Also:
-
Field Summary
Fields inherited from class org.springframework.web.servlet.tags.RequestContextAwareTag
logger, REQUEST_CONTEXT_PAGE_ATTRIBUTEFields inherited from class jakarta.servlet.jsp.tagext.TagSupport
id, pageContextFields inherited from interface jakarta.servlet.jsp.tagext.IterationTag
EVAL_BODY_AGAINFields inherited from interface jakarta.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected StringhtmlEscape(String content) HTML-encodes the given String, only if the "htmlEscape" setting is enabled.protected booleanReturn the applicable default HTML escape setting for this tag.protected booleanReturn the HTML escaping setting for this tag, or the default setting if not overridden.protected booleanReturn the applicable default for the use of response encoding with HTML escaping for this tag.voidsetHtmlEscape(boolean htmlEscape) Set HTML escaping for this tag, as boolean value.Methods inherited from class org.springframework.web.servlet.tags.RequestContextAwareTag
doCatch, doFinally, doStartTag, doStartTagInternal, getRequestContextMethods inherited from class jakarta.servlet.jsp.tagext.TagSupport
doAfterBody, doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue
-
Constructor Details
-
HtmlEscapingAwareTag
public HtmlEscapingAwareTag()
-
-
Method Details
-
setHtmlEscape
Set HTML escaping for this tag, as boolean value. Overrides the default HTML escaping setting for the current page.- Throws:
JspException- See Also:
-
isHtmlEscape
protected boolean isHtmlEscape()Return the HTML escaping setting for this tag, or the default setting if not overridden.- See Also:
-
isDefaultHtmlEscape
protected boolean isDefaultHtmlEscape()Return the applicable default HTML escape setting for this tag.The default implementation checks the RequestContext's setting, falling back to
falsein case of no explicit default given. -
isResponseEncodedHtmlEscape
protected boolean isResponseEncodedHtmlEscape()Return the applicable default for the use of response encoding with HTML escaping for this tag.The default implementation checks the RequestContext's setting, falling back to
falsein case of no explicit default given.- Since:
- 4.1.2
- See Also:
-
htmlEscape
HTML-encodes the given String, only if the "htmlEscape" setting is enabled.The response encoding will be taken into account if the "responseEncodedHtmlEscape" setting is enabled as well.
- Parameters:
content- the String to escape- Returns:
- the escaped String
- Since:
- 4.1.2
- See Also:
-