| <!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>Tag Developers Guide</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 class="edit-on-gh" href="https://github.com/apache/struts-site/edit/master/source/tag-developers/ajax-head-template.md" title="Edit this page on GitHub">Edit on GitHub</a> |
| |
| <h1 id="ajax-head-template">ajax head template</h1> |
| |
| <blockquote> |
| <p>NOTE: Ajax template (Dojo plugin) is deprecated and won’t be supported any longer.</p> |
| </blockquote> |
| |
| <p>The ajax <a href="dojo-head-tag.html">head</a> template builds upon the <a href="head-tag.html">xhtml head template</a> by providing additional |
| JavaScript includes for the <a href="http://dojotoolkit.org">Dojo Toolkit</a>, which is used by the <a href="ajax-a-template.html">ajax a template</a>, |
| <a href="ajax-div-template.html">ajax div template</a>, and the <a href="">ajax tabbedPanel template</a>. It is required to use this tag, |
| <code class="highlighter-rouge"><ww:head theme="ajax"/></code> , in your HTML <code class="highlighter-rouge"><head></code> block if you wish to use AJAX feature. The contents of <strong>head.ftl</strong> are:</p> |
| |
| <figure class="highlight"><pre><code class="language-html" data-lang="html"><span class="nt"><</span><span class="err">#</span><span class="na">--</span> |
| <span class="err">/*</span> |
| <span class="err">*</span> <span class="err">$</span><span class="na">Id</span><span class="err">$</span> |
| <span class="err">*</span> |
| <span class="err">*</span> <span class="na">Licensed</span> <span class="na">to</span> <span class="na">the</span> <span class="na">Apache</span> <span class="na">Software</span> <span class="na">Foundation</span> <span class="err">(</span><span class="na">ASF</span><span class="err">)</span> <span class="na">under</span> <span class="na">one</span> |
| <span class="err">*</span> <span class="na">or</span> <span class="na">more</span> <span class="na">contributor</span> <span class="na">license</span> <span class="na">agreements</span><span class="err">.</span> <span class="na">See</span> <span class="na">the</span> <span class="na">NOTICE</span> <span class="na">file</span> |
| <span class="err">*</span> <span class="na">distributed</span> <span class="na">with</span> <span class="na">this</span> <span class="na">work</span> <span class="na">for</span> <span class="na">additional</span> <span class="na">information</span> |
| <span class="err">*</span> <span class="na">regarding</span> <span class="na">copyright</span> <span class="na">ownership</span><span class="err">.</span> <span class="na">The</span> <span class="na">ASF</span> <span class="na">licenses</span> <span class="na">this</span> <span class="na">file</span> |
| <span class="err">*</span> <span class="na">to</span> <span class="na">you</span> <span class="na">under</span> <span class="na">the</span> <span class="na">Apache</span> <span class="na">License</span><span class="err">,</span> <span class="na">Version</span> <span class="na">2</span><span class="err">.</span><span class="na">0</span> <span class="err">(</span><span class="na">the</span> |
| <span class="err">*</span> <span class="err">"</span><span class="na">License</span><span class="err">");</span> <span class="na">you</span> <span class="na">may</span> <span class="na">not</span> <span class="na">use</span> <span class="na">this</span> <span class="na">file</span> <span class="na">except</span> <span class="na">in</span> <span class="na">compliance</span> |
| <span class="err">*</span> <span class="na">with</span> <span class="na">the</span> <span class="na">License</span><span class="err">.</span> <span class="na">You</span> <span class="na">may</span> <span class="na">obtain</span> <span class="na">a</span> <span class="na">copy</span> <span class="na">of</span> <span class="na">the</span> <span class="na">License</span> <span class="na">at</span> |
| <span class="err">*</span> |
| <span class="err">*</span> <span class="na">http:</span><span class="err">//</span><span class="na">www</span><span class="err">.</span><span class="na">apache</span><span class="err">.</span><span class="na">org</span><span class="err">/</span><span class="na">licenses</span><span class="err">/</span><span class="na">LICENSE-2</span><span class="err">.</span><span class="na">0</span> |
| <span class="err">*</span> |
| <span class="err">*</span> <span class="na">Unless</span> <span class="na">required</span> <span class="na">by</span> <span class="na">applicable</span> <span class="na">law</span> <span class="na">or</span> <span class="na">agreed</span> <span class="na">to</span> <span class="na">in</span> <span class="na">writing</span><span class="err">,</span> |
| <span class="err">*</span> <span class="na">software</span> <span class="na">distributed</span> <span class="na">under</span> <span class="na">the</span> <span class="na">License</span> <span class="na">is</span> <span class="na">distributed</span> <span class="na">on</span> <span class="na">an</span> |
| <span class="err">*</span> <span class="err">"</span><span class="na">AS</span> <span class="na">IS</span><span class="err">"</span> <span class="na">BASIS</span><span class="err">,</span> <span class="na">WITHOUT</span> <span class="na">WARRANTIES</span> <span class="na">OR</span> <span class="na">CONDITIONS</span> <span class="na">OF</span> <span class="na">ANY</span> |
| <span class="err">*</span> <span class="na">KIND</span><span class="err">,</span> <span class="na">either</span> <span class="na">express</span> <span class="na">or</span> <span class="na">implied</span><span class="err">.</span> <span class="na">See</span> <span class="na">the</span> <span class="na">License</span> <span class="na">for</span> <span class="na">the</span> |
| <span class="err">*</span> <span class="na">specific</span> <span class="na">language</span> <span class="na">governing</span> <span class="na">permissions</span> <span class="na">and</span> <span class="na">limitations</span> |
| <span class="err">*</span> <span class="na">under</span> <span class="na">the</span> <span class="na">License</span><span class="err">.</span> |
| <span class="err">*/</span> |
| <span class="na">--</span><span class="nt">></span> |
| <span class="nt"><script </span><span class="na">language=</span><span class="s">"JavaScript"</span> <span class="na">type=</span><span class="s">"text/javascript"</span><span class="nt">></span> |
| <span class="c1">// Dojo configuration</span> |
| <span class="nx">djConfig</span> <span class="o">=</span> <span class="p">{</span> |
| <span class="na">isDebug</span><span class="p">:</span> <span class="nx">$</span><span class="p">{</span><span class="nx">parameters</span><span class="p">.</span><span class="nx">debug</span><span class="p">?</span><span class="k">default</span><span class="p">(</span><span class="kc">false</span><span class="p">)?</span><span class="nx">string</span><span class="p">},</span> |
| <span class="nx">bindEncoding</span><span class="p">:</span> <span class="s2">"${parameters.encoding}"</span> |
| <span class="o"><</span><span class="err">#</span><span class="k">if</span> <span class="nx">parameters</span><span class="p">.</span><span class="nx">baseRelativePath</span><span class="p">?</span><span class="nx">if_exists</span> <span class="o">!=</span> <span class="s2">""</span><span class="o">></span> |
| <span class="p">,</span><span class="nx">baseRelativePath</span><span class="p">:</span> <span class="s2">"<@s.url value='${parameters.baseRelativePath}' includeParams='none' encode='false' />"</span> |
| <span class="p">,</span><span class="nx">baseScriptUri</span><span class="p">:</span> <span class="s2">"<@s.url value='${parameters.baseRelativePath}' includeParams='none' encode='false' />"</span> |
| <span class="o"><</span><span class="err">#</span><span class="k">else</span><span class="o">></span> |
| <span class="p">,</span><span class="na">baseRelativePath</span><span class="p">:</span> <span class="s2">"${base}/struts/dojo/"</span> |
| <span class="p">,</span><span class="na">baseScriptUri</span><span class="p">:</span> <span class="s2">"${base}/struts/dojo/"</span> |
| <span class="o"><</span><span class="sr">/#if> </span><span class="err"> |
| </span> <span class="o"><</span><span class="err">#</span><span class="k">if</span> <span class="nx">parameters</span><span class="p">.</span><span class="nx">locale</span><span class="p">?</span><span class="nx">if_exists</span> <span class="o">!=</span> <span class="s2">""</span><span class="o">></span> |
| <span class="p">,</span><span class="nx">locale</span><span class="p">:</span> <span class="s2">"${parameters.locale}"</span> |
| <span class="o"><</span><span class="sr">/#if</span><span class="err">> |
| </span> <span class="o"><</span><span class="err">#</span><span class="k">if</span> <span class="nx">parameters</span><span class="p">.</span><span class="nx">extraLocales</span><span class="p">?</span><span class="nx">exists</span><span class="o">></span> |
| <span class="p">,</span><span class="nx">extraLocale</span><span class="p">:</span> <span class="p">[</span> |
| <span class="o"><</span><span class="err">#</span><span class="nx">list</span> <span class="nx">parameters</span><span class="p">.</span><span class="nx">extraLocales</span> <span class="k">as</span> <span class="nx">locale</span><span class="o">></span> |
| <span class="s2">"${locale}"</span><span class="o"><</span><span class="err">#</span><span class="k">if</span> <span class="nx">locale_has_next</span><span class="o">></span><span class="p">,</span><span class="o"><</span><span class="sr">/#if</span><span class="err">> |
| </span> <span class="o"><</span><span class="sr">/#list</span><span class="err">> |
| </span> <span class="p">]</span> |
| <span class="o"><</span><span class="sr">/#if</span><span class="err">> |
| </span> <span class="p">,</span><span class="na">parseWidgets</span> <span class="p">:</span> <span class="nx">$</span><span class="p">{</span><span class="nx">parameters</span><span class="p">.</span><span class="nx">parseContent</span><span class="p">?</span><span class="nx">string</span><span class="p">}</span> |
| |
| <span class="p">};</span> |
| <span class="nt"></script></span> |
| |
| <span class="nt"><</span><span class="err">#</span><span class="na">if</span> <span class="na">parameters</span><span class="err">.</span><span class="na">compressed</span><span class="err">?</span><span class="na">default</span><span class="err">(</span><span class="na">true</span><span class="err">)</span><span class="nt">></span> |
| <span class="nt"><</span><span class="err">#</span><span class="na">assign</span> <span class="na">dojoFile=</span><span class="s">"dojo.js"</span><span class="nt">></span> |
| <span class="nt"><</span><span class="err">#</span><span class="na">else</span><span class="nt">></span> |
| <span class="nt"><</span><span class="err">#</span><span class="na">assign</span> <span class="na">dojoFile=</span><span class="s">"dojo.js.uncompressed.js"</span><span class="nt">></span> |
| <span class="nt"></</span><span class="err">#</span><span class="nt">if></span> |
| |
| <span class="nt"><</span><span class="err">#</span><span class="na">if</span> <span class="na">parameters</span><span class="err">.</span><span class="na">cache</span><span class="err">?</span><span class="na">default</span><span class="err">(</span><span class="na">true</span><span class="err">)</span><span class="nt">></span> |
| <span class="nt"><</span><span class="err">#</span><span class="na">assign</span> <span class="na">profile=</span><span class="s">"struts_"</span><span class="nt">></span> |
| <span class="nt"><</span><span class="err">#</span><span class="na">else</span><span class="nt">></span> |
| <span class="nt"><</span><span class="err">#</span><span class="na">assign</span> <span class="na">profile=</span><span class="s">""</span><span class="nt">></span> |
| <span class="nt"></</span><span class="err">#</span><span class="nt">if></span> |
| |
| <span class="nt"><</span><span class="err">#</span><span class="na">if</span> <span class="na">parameters</span><span class="err">.</span><span class="na">baseRelativePath</span><span class="err">?</span><span class="na">if_exists</span> <span class="err">!=</span> <span class="err">""</span><span class="nt">></span> |
| <span class="nt"><script </span><span class="na">language=</span><span class="s">"JavaScript"</span> <span class="na">type=</span><span class="s">"text/javascript"</span> |
| <span class="na">src=</span><span class="s">"<@s.url value='${parameters.baseRelativePath}/${profile}${dojoFile}' includeParams='none' encode='false' />"</span><span class="nt">></script></span> |
| <span class="nt"><</span><span class="err">#</span><span class="na">else</span><span class="nt">></span> |
| <span class="nt"><script </span><span class="na">language=</span><span class="s">"JavaScript"</span> <span class="na">type=</span><span class="s">"text/javascript"</span> |
| <span class="na">src=</span><span class="s">"${base}/struts/dojo/${profile}${dojoFile}"</span><span class="nt">></script></span> |
| <span class="nt"></</span><span class="err">#</span><span class="nt">if></span> |
| |
| <span class="nt"><script </span><span class="na">language=</span><span class="s">"JavaScript"</span> <span class="na">type=</span><span class="s">"text/javascript"</span> |
| <span class="na">src=</span><span class="s">"${base}/struts/ajax/dojoRequire.js"</span><span class="nt">></script></span> |
| <span class="nt"><</span><span class="err">#</span><span class="na">if</span> <span class="na">parameters</span><span class="err">.</span><span class="na">debug</span><span class="err">?</span><span class="na">default</span><span class="err">(</span><span class="na">false</span><span class="err">)</span><span class="nt">></span> |
| <span class="nt"><script </span><span class="na">language=</span><span class="s">"JavaScript"</span> <span class="na">type=</span><span class="s">"text/javascript"</span><span class="nt">></span> |
| <span class="nx">dojo</span><span class="p">.</span><span class="nx">hostenv</span><span class="p">.</span><span class="nx">writeIncludes</span><span class="p">(</span><span class="kc">true</span><span class="p">);</span> |
| <span class="nt"></script></span> |
| <span class="nt"></</span><span class="err">#</span><span class="nt">if></span> |
| <span class="nt"><link</span> <span class="na">rel=</span><span class="s">"stylesheet"</span> <span class="na">href=</span><span class="s">"${base}/struts/xhtml/styles.css"</span> <span class="na">type=</span><span class="s">"text/css"</span><span class="nt">/></span> |
| |
| <span class="nt"><script </span><span class="na">language=</span><span class="s">"JavaScript"</span> <span class="na">src=</span><span class="s">"${base}/struts/utils.js"</span> <span class="na">type=</span><span class="s">"text/javascript"</span><span class="nt">></script></span> |
| <span class="nt"><script </span><span class="na">language=</span><span class="s">"JavaScript"</span> <span class="na">src=</span><span class="s">"${base}/struts/xhtml/validation.js"</span> <span class="na">type=</span><span class="s">"text/javascript"</span><span class="nt">></script></span> |
| <span class="nt"><script </span><span class="na">language=</span><span class="s">"JavaScript"</span> <span class="na">src=</span><span class="s">"${base}/struts/css_xhtml/validation.js"</span> <span class="na">type=</span><span class="s">"text/javascript"</span><span class="nt">></script></span></code></pre></figure> |
| |
| <blockquote> |
| <p>If you are having trouble getting the AJAX theme to work, you should include the above JavaScript in your page manually, |
| changing “isDebug: false” to “isDebug: true”. This will log out debugging information directly to the screen.</p> |
| </blockquote> |
| |
| <p>Note that Dojo is configured to use the same character encoding specified in <code class="highlighter-rouge">struts.xml</code> , typically UTF-8. For a simple |
| example of how to use the <a href="dojo-head-tag.html">head</a> tag with the AJAX theme, simply do the following in your HTML:</p> |
| |
| <figure class="highlight"><pre><code class="language-html" data-lang="html"><span class="nt"><</span><span class="err">%@</span> <span class="na">taglib</span> <span class="na">prefix=</span><span class="s">"s"</span> <span class="na">uri=</span><span class="s">"/struts-tags"</span> <span class="err">%</span><span class="nt">></span> |
| <span class="nt"><</span><span class="err">%@</span> <span class="na">taglib</span> <span class="na">prefix=</span><span class="s">"sx"</span> <span class="na">uri=</span><span class="s">"/struts-dojo-tags"</span> <span class="err">%</span><span class="nt">></span> |
| <span class="c"><!--// START SNIPPET: common-include--></span> |
| <span class="nt"><sx:head</span> <span class="na">cache=</span><span class="s">"false"</span><span class="nt">/></span> |
| <span class="c"><!--// END SNIPPET: common-include--></span></code></pre></figure> |
| |
| <blockquote> |
| <p>The above sample is from Struts trunk; for 2.0.6 you should use <code class="highlighter-rouge"><s:head debug="true"/></code>.</p> |
| </blockquote> |
| |
| </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> |
