public class ThemeTag extends MessageTag
<theme> tag looks up a theme message in the scope of this page.
Messages are looked up using the ApplicationContext's ThemeSource,
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.
Message arguments can be specified via the arguments attribute or by using nested <spring:argument> tags.
| Attribute | Required? | Runtime Expression? | Description |
|---|---|---|---|
| arguments | false | true | 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). |
| argumentSeparator | false | true | The separator character to be used for splitting the arguments string value; defaults to a 'comma' (','). |
| code | false | true | The code (key) to use when looking up the message. If code is not provided, the text attribute will be used. |
| htmlEscape | false | true | Set HTML escaping for this tag, as boolean value. Overrides the default HTML escaping setting for the current page. |
| javaScriptEscape | false | true | Set JavaScript escaping for this tag, as boolean value. Default is false. |
| message | false | true | A MessageSourceResolvable argument (direct or through JSP EL). |
| scope | false | true | The scope to use when exporting the result to a variable. This attribute is only used when var is also set. Possible values are page, request, session and application. |
| text | false | true | Default text to output when a message for the given code could not be found. If both text and code are not set, the tag will output null. |
| var | false | true | The string to use when binding the result to the page, request, session or application scope. If not specified, the result gets outputted to the writer (i.e. typically directly to the JSP). |
Theme,
ThemeSource,
MessageTag.setCode(java.lang.String),
MessageTag.setText(java.lang.String),
HtmlEscapingAwareTag.setHtmlEscape(boolean),
HtmlEscapeTag.setDefaultHtmlEscape(boolean),
WebUtils.HTML_ESCAPE_CONTEXT_PARAM,
ArgumentTag,
Serialized FormDEFAULT_ARGUMENT_SEPARATORlogger, REQUEST_CONTEXT_PAGE_ATTRIBUTEid, pageContextEVAL_BODY_AGAINEVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE| Constructor and Description |
|---|
ThemeTag() |
| Modifier and Type | Method and Description |
|---|---|
protected MessageSource |
getMessageSource()
Use the theme MessageSource for theme message resolution.
|
protected String |
getNoSuchMessageExceptionDescription(NoSuchMessageException ex)
Return exception message that indicates the current theme.
|
addArgument, doEndTag, doStartTagInternal, release, resolveArguments, resolveMessage, setArguments, setArgumentSeparator, setCode, setJavaScriptEscape, setMessage, setScope, setText, setVar, writeMessagehtmlEscape, isDefaultHtmlEscape, isHtmlEscape, isResponseEncodedHtmlEscape, setHtmlEscapedoCatch, doFinally, doStartTag, getRequestContextdoAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValueprotected MessageSource getMessageSource()
getMessageSource in class MessageTagprotected String getNoSuchMessageExceptionDescription(NoSuchMessageException ex)
getNoSuchMessageExceptionDescription in class MessageTag