com.interface21.web.servlet.tags
Class MessageTag

java.lang.Object
  |
  +--javax.servlet.jsp.tagext.TagSupport
        |
        +--com.interface21.web.servlet.tags.RequestContextAwareTag
              |
              +--com.interface21.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(boolean), HtmlEscapeTag.setDefaultHtmlEscape(boolean), HtmlEscapeTag.HTML_ESCAPE_CONTEXT_PARAM, Serialized Form

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
 int doStartTag()
          Create and set the current RequestContext.
protected  MessageSource getMessageSource()
          Use the application context itself for default message resolution.
protected  java.lang.String getNoSuchMessageExceptionDescription(NoSuchMessageException ex)
          Return default exception message.
 void setCode(java.lang.String code)
          Set the message code for this tag.
 void setText(java.lang.String text)
          Set the message text for this tag.
protected  void writeMessage(java.lang.String msg)
           
 
Methods inherited from class com.interface21.web.servlet.tags.RequestContextAwareTag
getRequestContext, isHtmlEscape, setHtmlEscape
 
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

MessageTag

public MessageTag()
Method Detail

setCode

public final void setCode(java.lang.String code)
Set the message code for this tag.

setText

public final void setText(java.lang.String text)
Set the message text for this tag.

doStartTag

public final int doStartTag()
                     throws javax.servlet.jsp.JspException
Description copied from class: RequestContextAwareTag
Create and set the current RequestContext. Note: Do not forget to call super.doStartTag() in subclasses!
Overrides:
doStartTag in class RequestContextAwareTag

writeMessage

protected void writeMessage(java.lang.String msg)
                     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.


Rod Johnson and Spring contributors 2001-2003.