blob: 4e610689ad5f57d19aa3de88e88993c110385dc2 [file] [log] [blame]
<!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-2021.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-theme.md" title="Edit this page on GitHub">Edit on GitHub</a>
<a href="themes-and-templates.html" title="back to Themes and Templates"><< back to Themes and Templates</a>
<h1 id="ajax-theme">ajax theme</h1>
<blockquote>
<p>NOTE: Ajax template (Dojo plugin) is deprecated and won’t be supported any longer.</p>
</blockquote>
<p>The ajax theme extends the <a href="xhtml-theme.html">xhtml theme</a> with AJAX features. The theme uses the popular DOJO
AJAX/JavaScript toolkit. AJAX features include:</p>
<ul>
<li><a href="../core-developers/ajax-client-side-validation.html">AJAX Client Side Validation</a></li>
<li>Remote <a href="form-tag.html">form</a> submission support (works with the <a href="dojo-submit-tag.html">submit</a> tag as well)</li>
<li>An advanced <a href="dojo-div-tag.html">div</a> template that provides dynamic reloading of partial HTML</li>
<li>An advanced <a href="dojo-a-tag.html">a</a> template that provides the ability to load and evaluate JavaScript remotely</li>
<li>An AJAX-only <a href="dojo-tabbedpanel-tag.html">tabbedpanel</a> implementation</li>
<li>A rich pub-sub event model</li>
<li>Interactive autocomplete tag</li>
</ul>
<blockquote>
<p>See also: <a href="ajax-tags.html">Ajax tags</a></p>
</blockquote>
<h2 id="browser-compatibility">Browser Compatibility</h2>
<p>AJAX (as a technology) uses a browser-side scripting component that varies between browsers (and sometimes versions).
To hide those differences from the developer, we utilize the dojo toolkit (<a href="http://www.dojotoolkit.org">http://www.dojotoolkit.org</a>).
Several browsers are supported by dojo, and any UI’s created with the ajax theme should act the same way for supported
browsers. The supported browsers are:</p>
<ul>
<li>IE 5.5+</li>
<li>FF 1.0+</li>
<li>Latest Safari (on up-to-date OS versions)</li>
<li>Latest Opera</li>
<li>Latest Konqueror</li>
</ul>
<h2 id="extending-the-ajax-theme">Extending the AJAX Theme</h2>
<p>The wrapping technique utilized by the ajax theme is much like <a href="xhtml-theme.html">xhtml theme</a>, but the <code class="highlighter-rouge">controlheader.ftl</code>
is a wee bit different.</p>
<pre><code class="language-ftl">&lt;#if parameters.label?if_exists != ""&gt;
&lt;#include "/${parameters.templateDir}/xhtml/controlheader.ftl" /&gt;
&lt;/#if&gt;
&lt;#if parameters.form?exists &amp;&amp; parameters.form.validate?default(false) == true&gt;
&lt;#-- can't mutate the data model in freemarker --&gt;
&lt;#if parameters.onblur?exists&gt;
${tag.addParameter('onblur', "validate(this);${parameters.onblur}")}
&lt;#else&gt;
${tag.addParameter('onblur', "validate(this);")}
&lt;/#if&gt;
&lt;/#if&gt;
</code></pre>
<p>The header provides for <a href="../core-developers/ajax-client-side-validation.html">AJAX Client Side Validation</a> by checking
if the <code class="highlighter-rouge">validate</code> attribute is set to true. If it is, a validation request is made on each <code class="highlighter-rouge">onblur</code> event
for a HTML <a href="struts-tags.html">Struts Tags</a>. Some people don’t like the <code class="highlighter-rouge">onblur</code> behavior; they would rather a more
advanced timer (say, 200ms) be kicked off after every keystroke. You can override this template and provide that
type of behavior if you would like.</p>
<h2 id="special-interest">Special Interest</h2>
<p>Three ajax_xhtml templates of special interest are <code class="highlighter-rouge">head</code>, <code class="highlighter-rouge">div</code> , and <code class="highlighter-rouge">a</code>.</p>
<blockquote>
<p>Especially with the ajax theme, it is important to use the <a href="dojo-head-tag.html">head</a> tag.
(See the <a href="ajax-head-template.html">ajax head template</a> for more information.) Without it, AJAX support may not be set
up properly.</p>
</blockquote>
<ul>
<li><a href="ajax-head-template.html">ajax head template</a></li>
<li><a href="ajax-div-template.html">ajax div template</a></li>
<li><a href="ajax-a-template.html">ajax a template</a></li>
</ul>
<blockquote>
<p>In addition to these templates, be familiar with the <a href="ajax-event-system.html">ajax event system</a> provided by
the framework and Dojo.</p>
</blockquote>
</section>
</article>
<footer class="container">
<div class="col-md-12">
Copyright &copy; 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>