| <!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>Freemarker Support</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="/highlighter/github-theme.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> |
| </head> |
| <body> |
| |
| <a href="http://github.com/apache/struts" class="github-ribbon"> |
| <img style="position: absolute; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_red_aa0000.png" alt="Fork me on GitHub"> |
| </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.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> |
| </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 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><a href="/contributors/">Contributors Guide</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="https://cwiki.apache.org/confluence/display/WW/Contributors+Guide">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 href="index.html" title="back to Core Developers Guide"><< back to Core Developers Guide</a> |
| <a class="edit-on-gh" href="https://github.com/apache/struts-site/edit/master/source/core-developers/freemarker-support.md" title="Edit this page on GitHub">Edit on GitHub</a> |
| <h1 id="freemarker-support">Freemarker Support</h1> |
| |
| <p>Freemarker views can be rendered using a result type <code class="highlighter-rouge">freemarker</code>.</p> |
| |
| <h2 id="configure-your-action-to-use-the-freemarker-result-type">Configure your action to use the freemarker result type</h2> |
| |
| <p>The <code class="highlighter-rouge">freemarker</code> result type is defined in <code class="highlighter-rouge">struts-default.xml</code>, so normally you just include it, and define your results to use <code class="highlighter-rouge">type="freemarker"</code>.</p> |
| |
| <div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nt"><include</span> <span class="na">file=</span><span class="s">"struts-default.xml"</span><span class="nt">/></span> |
| ... |
| <span class="nt"><action</span> <span class="na">name=</span><span class="s">"test"</span> <span class="na">class=</span><span class="s">"package.Test"</span><span class="nt">></span> |
| <span class="nt"><result</span> <span class="na">name=</span><span class="s">"success"</span> <span class="na">type=</span><span class="s">"freemarker"</span><span class="nt">></span>/WEB-INF/views/testView.ftl<span class="nt"></result></span> |
| <span class="nt"></action></span> |
| ... |
| |
| </code></pre></div></div> |
| |
| <h2 id="property-resolution">Property Resolution</h2> |
| |
| <p>Your action properties are automatically resolved - just like in a velocity view.</p> |
| |
| <p><strong>for example</strong></p> |
| |
| <p><code class="highlighter-rouge">${name}</code> will result in <code class="highlighter-rouge">stack.findValue("name")</code>, which <em>generally</em> results in <code class="highlighter-rouge">action.getName()</code> being executed.</p> |
| |
| <p>A search process is used to resolve the variable, searching the following scopes in order, until a value is found:</p> |
| |
| <ul> |
| <li>freemarker variables</li> |
| <li>value stack</li> |
| <li>request attributes</li> |
| <li>session attributes</li> |
| <li>servlet context attributes</li> |
| </ul> |
| |
| <h2 id="objects-in-the-context">Objects in the Context</h2> |
| |
| <p>The following variables exist in the FreeMarker views:</p> |
| |
| <ul> |
| <li><code class="highlighter-rouge">req</code> - the current <code class="highlighter-rouge">HttpServletRequest</code></li> |
| <li><code class="highlighter-rouge">res</code> - the current <code class="highlighter-rouge">HttpServletResponse</code></li> |
| <li><code class="highlighter-rouge">stack</code> - the current <code class="highlighter-rouge">OgnlValueStack</code></li> |
| <li><code class="highlighter-rouge">ognl</code> - the <code class="highlighter-rouge">OgnlTool</code> instance |
| <ul> |
| <li>This class contains useful methods to execute OGNL expressions against arbitary objects, and a method to generate a select list using |
| the <code class="highlighter-rouge"><s:select/></code> pattern. (i.e. taking the name of the list property, a listKey and listValue)</li> |
| </ul> |
| </li> |
| <li><code class="highlighter-rouge">struts</code> - an instance of <code class="highlighter-rouge">StrutsBeanWrapper</code></li> |
| <li><code class="highlighter-rouge">action</code> - the current Struts action</li> |
| <li><code class="highlighter-rouge">exception</code> - <em>optional</em> the Exception instance, if the view is a JSP exception or Servlet exception view</li> |
| </ul> |
| |
| <h2 id="freemarker-configuration-with-recent-releases">FreeMarker configuration with recent releases</h2> |
| |
| <p>To configure the freemarker engine that Struts uses, just add a file <code class="highlighter-rouge">freemarker.properties</code> to the classpath. The supported properties |
| are those that the Freemarker Configuration object expects - see the <a href="https://freemarker.apache.org/docs/api/freemarker/template/Configuration.html#setSetting-java.lang.String-java.lang.String-">Freemarker documentation</a> |
| for these.</p> |
| |
| <div class="highlighter-rouge"><div class="highlight"><pre class="highlight"><code>default_encoding=ISO-8859-1 |
| template_update_delay=5 |
| locale=no_NO |
| </code></pre></div></div> |
| |
| <h2 id="using-struts-ui-tags---or-any-jsp-tag-library">Using struts UI tags - or any JSP Tag Library</h2> |
| |
| <p>Freemarker has builtin support for using any JSP taglib. You can use JSP taglibs in FreeMarker even if</p> |
| <ul> |
| <li>your servlet container has no support for JSP, or</li> |
| <li>you didn’t specify the taglib in your web.xml - note how in the example below we refer to the taglib by its webapp-absolute URL, |
| so no configuration in web.xml is needed.</li> |
| </ul> |
| |
| <pre><code class="language-ftl"><#assign s=JspTaglibs["/WEB-INF/struts.tld"] /> |
| |
| <@s.form method="'post'" name="'inputform'" action="'save.action'" > |
| <@s.hidden name="'id'" /> |
| <@s.textarea label="'Details'" name="'details'" rows=5 cols=40 /> |
| <@s.submit value="'Save'" align="center" /> |
| </@s.form> |
| |
| </code></pre> |
| |
| <p><em>NOTE</em>: numeric properties for tags MUST be numbers, not strings. as in the rows and cols properties above. if you use <code class="highlighter-rouge">cols="40"</code> you will |
| receive an exception. Other than that, the freemarker tag container behaves as you would expect.</p> |
| |
| <h2 id="dynamic-attributes-support">Dynamic attributes support</h2> |
| |
| <p>You can specify dynamic attributes with Struts 2 tags like this:</p> |
| |
| <pre><code class="language-ftl"><@s.textfield name="test" dynamicAttributes={"placeholder":"input","foo":"bar"}/> |
| </code></pre> |
| |
| <p>or like this:</p> |
| |
| <pre><code class="language-ftl"><@s.textfield name="test" placeholder="input" foo="bar"/> |
| </code></pre> |
| |
| <p>and for both case, it will be parsed into:</p> |
| |
| <div class="language-html highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nt"><input</span> <span class="na">type=</span><span class="s">"text"</span> <span class="na">name=</span><span class="s">"test"</span> <span class="na">value=</span><span class="s">""</span> <span class="na">id=</span><span class="s">"test"</span> <span class="na">placeholder=</span><span class="s">"input"</span> <span class="na">foo=</span><span class="s">"bar"</span><span class="nt">/></span> |
| |
| </code></pre></div></div> |
| |
| <p>You can also use OGNL expressions with dynamic tags like below:</p> |
| |
| <pre><code class="language-ftl"><@s.textfield name="test" placeholder="input" foo="checked: %{bar}"/> |
| </code></pre> |
| |
| <p>When using attributes with hyphens, use the below syntax (you can also leave the single quotes from false if you want)</p> |
| |
| <pre><code class="language-ftl"><@s.form dynamicAttributes={'data-ajax':'false'}> |
| ... |
| </@s.form> |
| </code></pre> |
| |
| </section> |
| </article> |
| |
| |
| <footer class="container"> |
| <div class="col-md-12"> |
| Copyright © 2000-2018 <a href="http://www.apache.org/">The Apache Software Foundation </a>. |
| All Rights Reserved. |
| </div> |
| <div class="col-md-12"> |
| Apache Struts, Struts, Apache, the Apache feather logo, and the Apache Struts project logos are |
| trademarks of The Apache Software Foundation. |
| </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> |