org.openmrs.web.taglib

Class OpenmrsMessageTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

javax.servlet.jsp.tagext.BodyTagSupport

org.openmrs.web.taglib.OpenmrsRequestContextAwareBodyTag

org.openmrs.web.taglib.OpenmrsHtmlEscapingAwareTag

org.openmrs.web.taglib.OpenmrsMessageTag

All Implemented Interfaces:

Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class OpenmrsMessageTag
extends OpenmrsHtmlEscapingAwareTag

Custom JSP tag to look up a message in the scope of the page. This is based on the Spring message tag. It extends functionality of Spring's message tag by adding the ability to place text inside the tag body and specifying the locale of the text. Any text, placed between start and end tags will be treated as the default message within the locale specified in within the locale attribute (or the system default locale if the locale attribute is not specified).

As spring:message tag, this also retrieves the message from bundle with the given code, but (in addition) this tag uses its body text when the code cannot be resolved. If the body value also is not specified, the value of the text attribute is used. If there is no message in the bundle and no text attribute value or tag body text, then the message code is displayed, if it is set; otherwise null. If both text attribute and body text are present (shouldn't happen, but could by mistake), then this tag uses the body text before checking the text attribute. With this tag user can define default text for a locale other than the system default by using locale attribute. If locale attribute is not specified, then the system default locale (e.g., "en") will be used. HTML escaping is also supported by this tag.

This tag also supports customization of messages writing behavior. To change its default behavior, set the TagWriterBehavior property with a custom implementation of the TagMessageWriterBehavior interface.

For example, if you put the following:

<openmrs:message code="wrong.code" >Some text </openmrs:message>

and there is no message that can be resolved by given code, then output will be "Some text". You may also specify the fallback in spring-ish style using text attribute as follows:

<openmrs:message code="wrong.code" text="Some other text" />

Using locale attribute of tag you can specify the locale of fallback text provided by message tag. You could write the tag like:

<openmrs:message code="foo.greeting" locale="fr">Bonjour</openmrs:message>

meaning that the message supplied with the tag is in the "fr" locale. If the user is viewing in English, then the message within the English message bundle with the code foo.greeting would be displayed.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ARGUMENT_SEPARATOR Default separator for splitting an arguments String: a comma (",")
static TagMessageWriterBehavior	DEFAULT_WRITER_BEHAVIOUR Default behavior used for writing resolved messages into output
static TagMessageWriterBehavior	tagWriterBehavior Tag writing behavior instance used for customization of resolved messages rendering

Fields inherited from class org.openmrs.web.taglib.OpenmrsRequestContextAwareBodyTag

logger

Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport

bodyContent

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

id, pageContext

Fields inherited from interface javax.servlet.jsp.tagext.BodyTag

EVAL_BODY_BUFFERED, EVAL_BODY_TAG

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

Constructors

Constructor and Description
OpenmrsMessageTag()

Method Summary

Modifier and Type	Method and Description
protected int	doEndTagInternal() Called by doEndTag to perform the actual work.
protected org.springframework.context.MessageSource	getMessageSource() Use the current RequestContext's application context as MessageSource.
protected String	getNoSuchMessageExceptionDescription(org.springframework.context.NoSuchMessageException ex) Return default exception message.
protected Object[]	resolveArguments(Object arguments)
protected String	resolveMessage() Resolve the specified message or code or text or tag body into a concrete message string.
void	setArguments(Object arguments)
void	setArgumentSeparator(String argumentSeparator)
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	setLocale(String locale) Sets the locale of the supplied message.
void	setMessage(Object message)
void	setScope(String scope)
static void	setTagWriterBehavior(TagMessageWriterBehavior tagWriterBehavior) Sets tag writer behavior to customize rendering of resolved messages
void	setText(String text) Set the message text for this tag.
void	setVar(String var)
protected void	writeMessage(String message) Writes the message to the page.

Methods inherited from class org.openmrs.web.taglib.OpenmrsHtmlEscapingAwareTag

isDefaultHtmlEscape, isHtmlEscape, setHtmlEscape

Methods inherited from class org.openmrs.web.taglib.OpenmrsRequestContextAwareBodyTag

doEndTag, doStartTag, getRequestContext

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

doAfterBody, doInitBody, getBodyContent, getPreviousOut, release, setBodyContent

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

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

Methods inherited from interface javax.servlet.jsp.tagext.Tag

getParent, setPageContext, setParent

Field Detail

DEFAULT_ARGUMENT_SEPARATOR

public static final String DEFAULT_ARGUMENT_SEPARATOR

Default separator for splitting an arguments String: a comma (",")

See Also:

Constant Field Values

DEFAULT_WRITER_BEHAVIOUR

public static final TagMessageWriterBehavior DEFAULT_WRITER_BEHAVIOUR

Default behavior used for writing resolved messages into output

tagWriterBehavior

public static TagMessageWriterBehavior tagWriterBehavior

Tag writing behavior instance used for customization of resolved messages rendering

Constructor Detail

OpenmrsMessageTag

public OpenmrsMessageTag()

Method Detail

setMessage

public void setMessage(Object message)

See Also:

MessageTag.setMessage(MessageSourceResolvable)

setCode

public void setCode(String code)

Set the message code for this tag.

setArguments

public void setArguments(Object arguments)

See Also:

MessageTag.setArguments(Object)

setArgumentSeparator

public void setArgumentSeparator(String argumentSeparator)

See Also:

MessageTag.setArgumentSeparator(String)

setText

public void setText(String text)

Set the message text for this tag.

setVar

public void setVar(String var)

See Also:

MessageTag.setVar(String)

setScope

public void setScope(String scope)

See Also:

MessageTag.setScope(String)

setLocale

public void setLocale(String locale)

Sets the locale of the supplied message. If no text passed in or given text can not be recognized as locale, then default value of locale attribute of this tag will not be changed

Parameters:

locale - the locale string to set

setJavaScriptEscape

public void setJavaScriptEscape(String javaScriptEscape)
                         throws javax.servlet.jsp.JspException

Set JavaScript escaping for this tag, as boolean value. Default is "false".

Throws:

javax.servlet.jsp.JspException

doEndTagInternal

protected int doEndTagInternal()
                        throws javax.servlet.jsp.JspException,
                               IOException

Description copied from class: OpenmrsRequestContextAwareBodyTag

Called by doEndTag to perform the actual work.

Specified by:

doEndTagInternal in class OpenmrsRequestContextAwareBodyTag

Returns:

same as BodyTagSupport.doEndTag

Throws:

javax.servlet.jsp.JspException

IOException

See Also:

MessageTag.doStartTagInternal()

Expected Behavior:

Should evaluate specified message resolvable

Should resolve message by code

Should resolve message in locale that different from default

Should return code if no message resolved

Should use body content as fallback if no message resolved

Should use text attribute as fallback if no message resolved

Should use body content in prior to text attribute as fallback if no message resolved

Should ignore fallbacks if tag locale differs from context locale

resolveMessage

protected String resolveMessage()
                         throws javax.servlet.jsp.JspException

Resolve the specified message or code or text or tag body into a concrete message string. The returned message string should be unescaped.

Throws:

javax.servlet.jsp.JspException

resolveArguments

protected Object[] resolveArguments(Object arguments)
                             throws javax.servlet.jsp.JspException

Throws:

javax.servlet.jsp.JspException

See Also:

MessageTag.resolveArguments(Object)

writeMessage

protected void writeMessage(String message)
                     throws IOException

Writes the message to the page. Before actual writing occurs, it calls method on static instance of tag writer behavior to customize the message which will be written.

Parameters:

message - the message to write

Throws:

IOException - if writing error occurs

getMessageSource

protected org.springframework.context.MessageSource getMessageSource()

Use the current RequestContext's application context as MessageSource.

getNoSuchMessageExceptionDescription

protected String getNoSuchMessageExceptionDescription(org.springframework.context.NoSuchMessageException ex)

Return default exception message.

setTagWriterBehavior

public static void setTagWriterBehavior(TagMessageWriterBehavior tagWriterBehavior)

Sets tag writer behavior to customize rendering of resolved messages

Parameters:

tagWriterBehavior - the tagWriterBehavior to set