| <!DOCTYPE html> |
| <html lang="en"> |
| <head> |
| <meta charset="UTF-8"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"/> |
| <meta name="Date-Revision-yyyymmdd" content="20140918"/> |
| <meta http-equiv="Content-Language" content="en"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| |
| <title>text tag</title> |
| |
| <link href="//fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,600,700,400italic,600italic,700italic" rel="stylesheet" type="text/css"> |
| <link href="//netdna.bootstrapcdn.com/font-awesome/4.0.3/css/font-awesome.css" rel="stylesheet"> |
| <link href="/css/main.css" rel="stylesheet"> |
| <link href="/css/custom.css" rel="stylesheet"> |
| <link href="/css/syntax.css" rel="stylesheet"> |
| |
| <script src="//code.jquery.com/jquery-1.11.0.min.js"></script> |
| <script type="text/javascript" src="/bootstrap/js/bootstrap.js"></script> |
| <script type="text/javascript" src="/js/community.js"></script> |
| |
| <!-- Matomo --> |
| <script> |
| var _paq = window._paq = window._paq || []; |
| /* tracker methods like "setCustomDimension" should be called before "trackPageView" */ |
| /* We explicitly disable cookie tracking to avoid privacy issues */ |
| _paq.push(['disableCookies']); |
| _paq.push(['trackPageView']); |
| _paq.push(['enableLinkTracking']); |
| (function() { |
| var u="//analytics.apache.org/"; |
| _paq.push(['setTrackerUrl', u+'matomo.php']); |
| _paq.push(['setSiteId', '41']); |
| var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; |
| g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s); |
| })(); |
| </script> |
| <!-- End Matomo Code --> |
| </head> |
| <body> |
| |
| <a href="https://github.com/apache/struts" class="github-ribbon"> |
| <img decoding="async" loading="lazy" style="position: absolute; right: 0; border: 0;" width="149" height="149" src="https://github.blog/wp-content/uploads/2008/12/forkme_right_red_aa0000.png?resize=149%2C149" class="attachment-full size-full" alt="Fork me on GitHub" data-recalc-dims="1"> |
| </a> |
| |
| <header> |
| <nav> |
| <div role="navigation" class="navbar navbar-default navbar-fixed-top"> |
| <div class="container"> |
| <div class="navbar-header"> |
| <button type="button" data-toggle="collapse" data-target="#struts-menu" class="navbar-toggle"> |
| Menu |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| <a href="/index.html" class="navbar-brand logo"><img src="/img/struts-logo.svg"></a> |
| </div> |
| <div id="struts-menu" class="navbar-collapse collapse"> |
| <ul class="nav navbar-nav"> |
| <li class="dropdown"> |
| <a data-toggle="dropdown" href="#" class="dropdown-toggle"> |
| Home<b class="caret"></b> |
| </a> |
| <ul class="dropdown-menu"> |
| <li><a href="/index.html">Welcome</a></li> |
| <li><a href="/download.cgi">Download</a></li> |
| <li><a href="/releases.html">Releases</a></li> |
| <li><a href="/announce-2024.html">Announcements</a></li> |
| <li><a href="http://www.apache.org/licenses/">License</a></li> |
| <li><a href="https://www.apache.org/foundation/thanks.html">Thanks!</a></li> |
| <li><a href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li> |
| <li><a href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy Policy</a></li> |
| </ul> |
| </li> |
| <li class="dropdown"> |
| <a data-toggle="dropdown" href="#" class="dropdown-toggle"> |
| Support<b class="caret"></b> |
| </a> |
| <ul class="dropdown-menu"> |
| <li><a href="/mail.html">User Mailing List</a></li> |
| <li><a href="https://issues.apache.org/jira/browse/WW">Issue Tracker</a></li> |
| <li><a href="/security.html">Reporting Security Issues</a></li> |
| <li><a href="/commercial-support.html">Commercial Support</a></li> |
| <li class="divider"></li> |
| <li><a href="https://cwiki.apache.org/confluence/display/WW/Migration+Guide">Version Notes</a></li> |
| <li><a href="https://cwiki.apache.org/confluence/display/WW/Security+Bulletins">Security Bulletins</a></li> |
| <li class="divider"></li> |
| <li><a href="/maven/project-info.html">Maven Project Info</a></li> |
| <li><a href="/maven/struts2-core/dependencies.html">Struts Core Dependencies</a></li> |
| <li><a href="/maven/struts2-plugins/modules.html">Plugin Dependencies</a></li> |
| </ul> |
| </li> |
| <li class="dropdown"> |
| <a data-toggle="dropdown" href="#" class="dropdown-toggle"> |
| Documentation<b class="caret"></b> |
| </a> |
| <ul class="dropdown-menu"> |
| <li><a href="/birdseye.html">Birds Eye</a></li> |
| <li><a href="/primer.html">Key Technologies</a></li> |
| <li><a href="/kickstart.html">Kickstart FAQ</a></li> |
| <li><a href="https://cwiki.apache.org/confluence/display/WW/Home">Wiki</a></li> |
| <li class="divider"></li> |
| <li><a href="/getting-started/">Getting Started</a></li> |
| <li><a href="/security/">Security Guide</a></li> |
| <li><a href="/core-developers/">Core Developers Guide</a></li> |
| <li><a href="/tag-developers/">Tag Developers Guide</a></li> |
| <li><a href="/maven-archetypes/">Maven Archetypes</a></li> |
| <li><a href="/plugins/">Plugins</a></li> |
| <li><a href="/maven/struts2-core/apidocs/index.html">Struts Core API</a></li> |
| <li><a href="/tag-developers/tag-reference.html">Tag reference</a></li> |
| <li><a href="https://cwiki.apache.org/confluence/display/WW/FAQs">FAQs</a></li> |
| <li><a href="http://cwiki.apache.org/S2PLUGINS/home.html">Plugin registry</a></li> |
| </ul> |
| </li> |
| <li class="dropdown"> |
| <a data-toggle="dropdown" href="#" class="dropdown-toggle"> |
| Contributing<b class="caret"></b> |
| </a> |
| <ul class="dropdown-menu"> |
| <li><a href="/youatstruts.html">You at Struts</a></li> |
| <li><a href="/helping.html">How to Help FAQ</a></li> |
| <li><a href="/dev-mail.html">Development Lists</a></li> |
| <li class="divider"></li> |
| <li><a href="/submitting-patches.html">Submitting patches</a></li> |
| <li><a href="/builds.html">Source Code and Builds</a></li> |
| <li><a href="/coding-standards.html">Coding standards</a></li> |
| <li><a href="/contributors/">Contributors Guide</a></li> |
| <li class="divider"></li> |
| <li><a href="/release-guidelines.html">Release Guidelines</a></li> |
| <li><a href="/bylaws.html">PMC Charter</a></li> |
| <li><a href="/volunteers.html">Volunteers</a></li> |
| <li><a href="https://gitbox.apache.org/repos/asf?p=struts.git">Source Repository</a></li> |
| <li><a href="/updating-website.html">Updating the website</a></li> |
| </ul> |
| </li> |
| <li class="apache"><a href="http://www.apache.org/"><img src="/img/apache.png"></a></li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| </nav> |
| </header> |
| |
| |
| <article class="container"> |
| <section class="col-md-12"> |
| <a class="edit-on-gh" href="https://github.com/apache/struts-site/edit/master/source/tag-developers/text-tag.md" title="Edit this page on GitHub">Edit on GitHub</a> |
| |
| <a href="tag-reference.html" title="back to Tag Reference"><< back to Tag Reference</a> |
| |
| <h1 id="text">text</h1> |
| |
| <p>Please make sure you have read the <a href="tag-syntax">Tag Syntax</a> document and understand how tag attribute syntax works.</p> |
| |
| <h2 id="description">Description</h2> |
| |
| <p>Render a I18n text message.</p> |
| |
| <p>The message must be in a resource bundle with the same name as the action that it is associated with. In practice this |
| means that you should create a properties file in the same package as your Java class with the same name as your class, |
| but with <code class="language-plaintext highlighter-rouge">.properties</code> extension.</p> |
| |
| <p>If the named message is not found in a property file, then the body of the tag will be used as default message. If no body |
| is used, then the stack can be searched, and if a value is returned, it will written to the output. |
| If no value is found on the stack, the key of the message will be written out.</p> |
| |
| <p>For more details on using resource bundles with Struts 2 read the <a href="../core-developers/localization">localization guide</a>.</p> |
| |
| <p>Render a I18n text message</p> |
| |
| <h2 id="attributes">Attributes</h2> |
| |
| <table class="tag-reference"> |
| <tr> |
| <td colspan="6"><h4>Dynamic Attributes Allowed:</h4> false</td> |
| </tr> |
| <tr> |
| <td colspan="6"><hr /></td> |
| </tr> |
| <tr> |
| <th class="tag-header"><h4>Name</h4></th> |
| <th class="tag-header"><h4>Required</h4></th> |
| <th class="tag-header"><h4>Default</h4></th> |
| <th class="tag-header"><h4>Evaluated</h4></th> |
| <th class="tag-header"><h4>Type</h4></th> |
| <th class="tag-header"><h4>Description</h4></th> |
| </tr> |
| <tr> |
| <td class="tag-attribute">escapeCsv</td> |
| <td class="tag-attribute">false</td> |
| <td class="tag-attribute">false</td> |
| <td class="tag-attribute">false</td> |
| <td class="tag-attribute">Boolean</td> |
| <td class="tag-attribute">Whether to escape CSV (useful to escape a value for a column)</td> |
| </tr> |
| <tr> |
| <td class="tag-attribute">escapeHtml</td> |
| <td class="tag-attribute">false</td> |
| <td class="tag-attribute">false</td> |
| <td class="tag-attribute">false</td> |
| <td class="tag-attribute">Boolean</td> |
| <td class="tag-attribute">Whether to escape HTML</td> |
| </tr> |
| <tr> |
| <td class="tag-attribute">escapeJavaScript</td> |
| <td class="tag-attribute">false</td> |
| <td class="tag-attribute">false</td> |
| <td class="tag-attribute">false</td> |
| <td class="tag-attribute">Boolean</td> |
| <td class="tag-attribute">Whether to escape Javascript</td> |
| </tr> |
| <tr> |
| <td class="tag-attribute">escapeXml</td> |
| <td class="tag-attribute">false</td> |
| <td class="tag-attribute">false</td> |
| <td class="tag-attribute">false</td> |
| <td class="tag-attribute">Boolean</td> |
| <td class="tag-attribute">Whether to escape XML</td> |
| </tr> |
| <tr> |
| <td class="tag-attribute">name</td> |
| <td class="tag-attribute"><strong>true</strong></td> |
| <td class="tag-attribute"></td> |
| <td class="tag-attribute">false</td> |
| <td class="tag-attribute">String</td> |
| <td class="tag-attribute">Name of resource property to fetch</td> |
| </tr> |
| <tr> |
| <td class="tag-attribute">performClearTagStateForTagPoolingServers</td> |
| <td class="tag-attribute">false</td> |
| <td class="tag-attribute">false</td> |
| <td class="tag-attribute">false</td> |
| <td class="tag-attribute">Boolean</td> |
| <td class="tag-attribute">Whether to clear all tag state during doEndTag() processing (if applicable)</td> |
| </tr> |
| <tr> |
| <td class="tag-attribute">var</td> |
| <td class="tag-attribute">false</td> |
| <td class="tag-attribute"></td> |
| <td class="tag-attribute">false</td> |
| <td class="tag-attribute">String</td> |
| <td class="tag-attribute">Name used to reference the value pushed into the Value Stack (scope: action).</td> |
| </tr> |
| </table> |
| |
| <blockquote> |
| <p><strong>NOTE</strong>: When the <code class="language-plaintext highlighter-rouge">var</code> attribute is used with the <code class="language-plaintext highlighter-rouge">text</code> tag, the tag’s generated value <strong>will not</strong> be written out to the |
| visible page (it will only be placed into the action scope).</p> |
| </blockquote> |
| |
| <h2 id="examples">Examples</h2> |
| |
| <blockquote> |
| <p>Accessing messages from a given bundle (the i18n Shop example bundle in the first example) and using bundle defined |
| through the framework in the second example.</p> |
| </blockquote> |
| |
| <div class="language-jsp highlighter-rouge"><div class="highlight"><pre class="highlight"><code> <span class="c"><!-- First Example --></span> |
| <span class="nt"><s:i</span>18n name="struts.action.test.i18n.Shop"<span class="nt">></span> |
| <span class="nt"><s:text </span><span class="na">name=</span><span class="s">"main.title"</span><span class="nt">/></span> |
| <span class="nt"></s:i18n></span> |
| |
| <span class="c"><!-- Second Example --></span> |
| <span class="nt"><s:text </span><span class="na">name=</span><span class="s">"main.title"</span> <span class="nt">/></span> |
| |
| <span class="c"><!-- Third Examlpe --></span> |
| <span class="nt"><s:text </span><span class="na">name=</span><span class="s">"i18n.label.greetings"</span><span class="nt">></span> |
| <span class="nt"><s:param ></span>Mr Smith<span class="nt"></s:param></span> |
| <span class="nt"></s:text></span> |
| </code></pre></div></div> |
| |
| <h3 id="other-example">Other example</h3> |
| |
| <div class="language-jsp highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nt"><s:text </span><span class="na">name=</span><span class="s">"format.money"</span><span class="nt">><s:param </span><span class="na">name=</span><span class="s">"value"</span><span class="na"> value=</span><span class="s">"myMoneyValue"</span><span class="nt">/></s:text></span> |
| </code></pre></div></div> |
| |
| <p>where the following is in a regular (possibly locale-specific) properties file:</p> |
| |
| <div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>format.money={0,number,currency} |
| </code></pre></div></div> |
| |
| <p>For more about formatting text, see</p> |
| |
| <ol> |
| <li> |
| <p><a href="http://java.sun.com/j2se/1.4.2/docs/api/java/text/MessageFormat">http://java.sun.com/j2se/1.4.2/docs/api/java/text/MessageFormat.html</a></p> |
| </li> |
| <li> |
| <p><a href="http://java.sun.com/docs/books/tutorial/i18n/format/decimalFormat">http://java.sun.com/docs/books/tutorial/i18n/format/decimalFormat.html</a></p> |
| </li> |
| </ol> |
| |
| <h3 id="if-you-wish-to-use-i18n-in-your-tag-attributes">If you wish to use i18n in your tag attributes</h3> |
| |
| <p>This will <strong>not</strong> work:</p> |
| |
| <div class="language-jsp highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nt"><s:textfield </span><span class="na">name=</span><span class="s">"lastName"</span><span class="na"> label=</span><span class="s">"<s:text name="</span>person.lastName"<span class="nt">/></span>" ../> |
| </code></pre></div></div> |
| |
| <p>Instead, you should use the <code class="language-plaintext highlighter-rouge">getText()</code> method that you inherit when your Action extends <code class="language-plaintext highlighter-rouge">ActionSupport</code>:</p> |
| |
| <div class="language-jsp highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nt"><s:textfield </span><span class="na">name=</span><span class="s">"lastName"</span><span class="na"> label=</span><span class="s">"getText('person.lastName')"</span> ..<span class="nt">/></span> |
| </code></pre></div></div> |
| |
| </section> |
| </article> |
| |
| |
| <footer class="container"> |
| <div class="col-md-12"> |
| Copyright © 2000-2022 <a href="https://www.apache.org/">The Apache Software Foundation</a>. |
| Apache Struts, Struts, Apache, the Apache feather logo, and the Apache Struts project logos are |
| trademarks of The Apache Software Foundation. All Rights Reserved. |
| </div> |
| <div class="col-md-12">Logo and website design donated by <a href="https://softwaremill.com/">SoftwareMill</a>.</div> |
| </footer> |
| |
| <script>!function (d, s, id) { |
| var js, fjs = d.getElementsByTagName(s)[0]; |
| if (!d.getElementById(id)) { |
| js = d.createElement(s); |
| js.id = id; |
| js.src = "//platform.twitter.com/widgets.js"; |
| fjs.parentNode.insertBefore(js, fjs); |
| } |
| }(document, "script", "twitter-wjs");</script> |
| <script src="https://apis.google.com/js/platform.js" async="async" defer="defer"></script> |
| |
| <div id="fb-root"></div> |
| |
| <script>(function (d, s, id) { |
| var js, fjs = d.getElementsByTagName(s)[0]; |
| if (d.getElementById(id)) return; |
| js = d.createElement(s); |
| js.id = id; |
| js.src = "//connect.facebook.net/en_GB/all.js#xfbml=1"; |
| fjs.parentNode.insertBefore(js, fjs); |
| }(document, 'script', 'facebook-jssdk'));</script> |
| |
| |
| </body> |
| </html> |