public class MessageTag extends HtmlEscapingAwareTag implements ArgumentAware
Detects an HTML escaping setting, either on this tag instance, the page level,
or the web.xml
level. Can also apply JavaScript escaping.
If "code" isn't set or cannot be resolved, "text" will be used as default message. Thus, this tag can also be used for HTML escaping of any texts.
Message arguments can be specified via the arguments
attribute or by using nested <spring:argument>
tags.
setCode(java.lang.String)
,
setText(java.lang.String)
,
HtmlEscapingAwareTag.setHtmlEscape(boolean)
,
setJavaScriptEscape(boolean)
,
HtmlEscapeTag.setDefaultHtmlEscape(boolean)
,
WebUtils.HTML_ESCAPE_CONTEXT_PARAM
,
ArgumentTag
Modifier and Type | Field and Description |
---|---|
private java.lang.Object |
arguments |
private java.lang.String |
argumentSeparator |
private java.lang.String |
code |
static java.lang.String |
DEFAULT_ARGUMENT_SEPARATOR
Default separator for splitting an arguments String: a comma (",")
|
private boolean |
javaScriptEscape |
private MessageSourceResolvable |
message |
private java.util.List<java.lang.Object> |
nestedArguments |
private java.lang.String |
scope |
private java.lang.String |
text |
private java.lang.String |
var |
logger, REQUEST_CONTEXT_PAGE_ATTRIBUTE
Constructor and Description |
---|
MessageTag() |
Modifier and Type | Method and Description |
---|---|
void |
addArgument(java.lang.Object argument)
Callback hook for nested spring:argument tags to pass their value
to the parent tag.
|
private java.lang.Object[] |
appendArguments(java.lang.Object[] sourceArguments,
java.lang.Object[] additionalArguments) |
int |
doEndTag()
Resolves the message, escapes it if demanded,
and writes it to the page (or exposes it as variable).
|
protected int |
doStartTagInternal()
Called by doStartTag to perform the actual work.
|
protected MessageSource |
getMessageSource()
Use the current RequestContext's application context as MessageSource.
|
protected java.lang.String |
getNoSuchMessageExceptionDescription(NoSuchMessageException ex)
Return default exception message.
|
void |
release() |
protected java.lang.Object[] |
resolveArguments(java.lang.Object arguments)
Resolve the given arguments Object into an arguments array.
|
protected java.lang.String |
resolveMessage()
Resolve the specified message into a concrete message String.
|
void |
setArguments(java.lang.Object arguments)
Set optional message arguments for this tag, as a comma-delimited
String (each String argument can contain JSP EL), an Object array
(used as argument array), or a single Object (used as single argument).
|
void |
setArgumentSeparator(java.lang.String argumentSeparator)
Set the separator to use for splitting an arguments String.
|
void |
setCode(java.lang.String code)
Set the message code for this tag.
|
void |
setJavaScriptEscape(boolean javaScriptEscape)
Set JavaScript escaping for this tag, as boolean value.
|
void |
setMessage(MessageSourceResolvable message)
Set the MessageSourceResolvable for this tag.
|
void |
setScope(java.lang.String scope)
Set the scope to export the variable to.
|
void |
setText(java.lang.String text)
Set the message text for this tag.
|
void |
setVar(java.lang.String var)
Set PageContext attribute name under which to expose
a variable that contains the resolved message.
|
protected void |
writeMessage(java.lang.String msg)
Write the message to the page.
|
isDefaultHtmlEscape, isHtmlEscape, setHtmlEscape
doCatch, doFinally, doStartTag, getRequestContext
public static final java.lang.String DEFAULT_ARGUMENT_SEPARATOR
private MessageSourceResolvable message
private java.lang.String code
private java.lang.Object arguments
private java.lang.String argumentSeparator
private java.util.List<java.lang.Object> nestedArguments
private java.lang.String text
private java.lang.String var
private java.lang.String scope
private boolean javaScriptEscape
public void setMessage(MessageSourceResolvable message)
If a MessageSourceResolvable is specified, it effectively overrides any code, arguments or text specified on this tag.
public void setCode(java.lang.String code)
public void setArguments(java.lang.Object arguments)
public void setArgumentSeparator(java.lang.String argumentSeparator)
setArguments(java.lang.Object)
public void addArgument(java.lang.Object argument) throws JspTagException
ArgumentAware
addArgument
in interface ArgumentAware
argument
- the result of the nested spring:argument
tagJspTagException
public void setText(java.lang.String text)
public void setVar(java.lang.String var)
setScope(java.lang.String)
,
javax.servlet.jsp.PageContext#setAttribute
public void setScope(java.lang.String scope)
setVar(java.lang.String)
,
TagUtils.SCOPE_PAGE
,
javax.servlet.jsp.PageContext#setAttribute
public void setJavaScriptEscape(boolean javaScriptEscape) throws JspException
JspException
protected final int doStartTagInternal() throws JspException, java.io.IOException
RequestContextAwareTag
doStartTagInternal
in class RequestContextAwareTag
JspException
java.io.IOException
javax.servlet.jsp.tagext.TagSupport#doStartTag
public int doEndTag() throws JspException
JspException
resolveMessage()
,
HtmlUtils.htmlEscape(String)
,
JavaScriptUtils.javaScriptEscape(String)
,
writeMessage(String)
public void release()
protected java.lang.String resolveMessage() throws JspException, NoSuchMessageException
JspException
NoSuchMessageException
private java.lang.Object[] appendArguments(java.lang.Object[] sourceArguments, java.lang.Object[] additionalArguments)
protected java.lang.Object[] resolveArguments(java.lang.Object arguments) throws JspException
arguments
- the specified arguments ObjectJspException
- if argument conversion failedsetArguments(java.lang.Object)
protected void writeMessage(java.lang.String msg) throws java.io.IOException
Can be overridden in subclasses, e.g. for testing purposes.
msg
- the message to writejava.io.IOException
- if writing failedprotected MessageSource getMessageSource()
protected java.lang.String getNoSuchMessageExceptionDescription(NoSuchMessageException ex)