|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object javax.servlet.jsp.tagext.TagSupport org.springframework.web.servlet.tags.RequestContextAwareTag org.springframework.web.servlet.tags.HtmlEscapingAwareTag org.springframework.web.servlet.tags.MessageTag
public class MessageTag
Custom JSP tag to look up a message in the scope of this page. Messages are looked up using the ApplicationContext, and thus should support internationalization.
Regards a 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.
setCode(java.lang.String)
,
setText(java.lang.String)
,
HtmlEscapingAwareTag.setHtmlEscape(java.lang.String)
,
setJavaScriptEscape(java.lang.String)
,
HtmlEscapeTag.setDefaultHtmlEscape(java.lang.String)
,
WebUtils.HTML_ESCAPE_CONTEXT_PARAM
,
Serialized FormField Summary |
---|
Fields inherited from class org.springframework.web.servlet.tags.RequestContextAwareTag |
---|
logger, REQUEST_CONTEXT_PAGE_ATTRIBUTE |
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 | |
---|---|
MessageTag()
|
Method Summary | |
---|---|
protected int |
doStartTagInternal()
Resolves the message, escapes it if demanded, and writes it to the page (or exposes it as variable). |
protected MessageSource |
getMessageSource()
Use the application context itself for default message resolution. |
protected String |
getNoSuchMessageExceptionDescription(NoSuchMessageException ex)
Return default exception message. |
protected String |
resolveMessage()
Resolve the specified message into a concrete message String. |
void |
setArguments(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 |
setCode(String code)
Set the message code for this tag. |
void |
setJavaScriptEscape(String javaScriptEscape)
Set JavaScript escaping for this tag, as boolean value. |
void |
setMessage(Object message)
Set the MessageSourceResolvable for this tag. |
void |
setScope(String scope)
Set the scope to export the variable to. |
void |
setText(String text)
Set the message text for this tag. |
void |
setVar(String var)
Set PageContext attribute name under which to expose a variable that contains the resolved message. |
protected void |
writeMessage(String msg)
Write the message to the page. |
Methods inherited from class org.springframework.web.servlet.tags.HtmlEscapingAwareTag |
---|
isHtmlEscape, setHtmlEscape |
Methods inherited from class org.springframework.web.servlet.tags.RequestContextAwareTag |
---|
doCatch, doFinally, doStartTag, getRequestContext |
Methods inherited from class javax.servlet.jsp.tagext.TagSupport |
---|
doAfterBody, doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public MessageTag()
Method Detail |
---|
public void setMessage(Object message)
If a MessageSourceResolvable is specified, it effectively overrides any code, arguments or text specified on this tag.
public void setCode(String code)
public void setArguments(Object arguments)
public void setText(String text)
public void setVar(String var)
setScope(java.lang.String)
,
JspContext.setAttribute(java.lang.String, java.lang.Object)
public void setScope(String scope)
setVar(java.lang.String)
,
TagUtils.SCOPE_PAGE
,
JspContext.setAttribute(java.lang.String, java.lang.Object)
public void setJavaScriptEscape(String javaScriptEscape) throws JspException
JspException
protected final int doStartTagInternal() throws JspException, IOException
doStartTagInternal
in class RequestContextAwareTag
JspException
IOException
resolveMessage()
,
HtmlUtils.htmlEscape(String)
,
JavaScriptUtils.javaScriptEscape(String)
,
writeMessage(String)
protected String resolveMessage() throws JspException, NoSuchMessageException
JspException
NoSuchMessageException
protected void writeMessage(String msg) throws IOException
Can be overridden in subclasses, e.g. for testing purposes.
msg
- the message to write
IOException
- if writing failedprotected MessageSource getMessageSource()
protected String getNoSuchMessageExceptionDescription(NoSuchMessageException ex)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |