org.springframework.web.servlet.tags
Class MessageTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      org.springframework.web.servlet.tags.RequestContextAwareTag
          org.springframework.web.servlet.tags.MessageTag

All Implemented Interfaces:

javax.servlet.jsp.tagext.IterationTag, java.io.Serializable, javax.servlet.jsp.tagext.Tag

Direct Known Subclasses:

ThemeTag

public class MessageTag

extends RequestContextAwareTag

Custom 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.

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.

Author:

Rod Johnson, Juergen Hoeller

See Also:

setCode(java.lang.String), setText(java.lang.String), RequestContextAwareTag.setHtmlEscape(java.lang.String), HtmlEscapeTag.setDefaultHtmlEscape(java.lang.String), HtmlEscapeTag.HTML_ESCAPE_CONTEXT_PARAM, Serialized Form

Field Summary

Fields inherited from class org.springframework.web.servlet.tags.RequestContextAwareTag

logger

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() Called by doStartTag to perform the actual work.
protected MessageSource	getMessageSource() Use the application context itself for default message resolution.
protected java.lang.String	getNoSuchMessageExceptionDescription(NoSuchMessageException ex) Return default exception message.
void	release()
void	setCode(java.lang.String code) Set the message code for this tag.
void	setScope(java.lang.String scope) Set the scope to export the var to.
void	setText(java.lang.String text) Set the message text for this tag.
void	setVar(java.lang.String var) Set othe var String under which to bind the variable.
protected void	writeMessage(java.lang.String msg)

Methods inherited from class org.springframework.web.servlet.tags.RequestContextAwareTag

doStartTag, getRequestContext, isHtmlEscape, setHtmlEscape

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

doAfterBody, doEndTag, 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

Constructor Detail

MessageTag

public MessageTag()

Method Detail

setCode

public final void setCode(java.lang.String code)
                   throws javax.servlet.jsp.JspException

Set the message code for this tag.

Throws:

javax.servlet.jsp.JspException

setText

public final void setText(java.lang.String text)
                   throws javax.servlet.jsp.JspException

Set the message text for this tag.

Throws:

javax.servlet.jsp.JspException

setVar

public final void setVar(java.lang.String var)
                  throws javax.servlet.jsp.JspException

Set othe var String under which to bind the variable.

Throws:

javax.servlet.jsp.JspException

setScope

public final void setScope(java.lang.String scope)
                    throws javax.servlet.jsp.JspException

Set the scope to export the var to.

Throws:

javax.servlet.jsp.JspException

doStartTagInternal

protected final int doStartTagInternal()
                                throws java.lang.Exception

Description copied from class: RequestContextAwareTag

Called by doStartTag to perform the actual work.

Overrides:

doStartTagInternal in class RequestContextAwareTag

Returns:

same as TagSupport.doStartTag

Throws:

java.lang.Exception - any exception, any checked one other than a JspException gets wrapped in a JspException by doStartTag

See Also:

TagSupport.doStartTag()

writeMessage

protected void writeMessage(java.lang.String msg)
                     throws java.io.IOException

Throws:

java.io.IOException

getMessageSource

protected MessageSource getMessageSource()

Use the application context itself for default message resolution.

getNoSuchMessageExceptionDescription

protected java.lang.String getNoSuchMessageExceptionDescription(NoSuchMessageException ex)

Return default exception message.

release

public void release()