Ajax Tags

Dojo plugin is deprecated

Icon

The Dojo plugin will be deprecated on Struts 2.1

Struts 2.0 versus Struts 2.1 and the Dojo tags

Icon

The easiest way to get documentation for Struts 2.0 Dojo tag usage is to look at older Struts 2 documentation, like the Struts 2.0.11 Ajax tags wiki documentation.

Please check that documentation and the Dojo tag examples in the showcase app of the appropriate Struts 2 version before asking questions on the struts-user mailing list!

THE WIKI IS NOT VERSIONABLE (in a practical way).

The documentation here is for the most current Struts 2, not necessarily the most current release. We try to add version-specific documentation notes but have undoubtedly missed some locations.

Description

To use the AJAX tags from 2.1 on you must:

Include the Dojo Plugin distributed with Struts 2 in your /WEB-INF/lib folder.
Add <%@ taglib prefix="sx" uri="/struts-dojo-tags" %> to your page.
Include the head tag on the page, which can be configured for performance or debugging purposes.

Handling AJAX Responses

The following attributes affect the handling of all ajax responses.

Attribute	Default Value	Description
parseContent	true	When true, Dojo will parse the response into an XHTML Document Object and traverse the nodes searching for Dojo Widget markup. The parse and traversal is performed prior to inserting the nodes into the DOM. This attribute must be enabled to nest Dojo widgets (dojo tags) within responses. There's significant processing involved to create and parse the document so switch this feature off when not required. Note also that the response must be valid XHTML for cross-browser support and widgets must have unique IDs.
separateScripts	true	When true, Dojo will extract the <script> tags from the response, concatenate the extracted code into one block, create a new Function whose body is the extracted code and immediately invoke the function. The invocation is performed after the DOM has been updated with the XHTML. The function is executed within the scope of the widget (that is, the this variable points to the widget instance). When false, Dojo will extract the <script> tags from the response, concatenate the extracted code into one block and: in IE: invoke window.execScript() on the code in other browsers: create a <script> node containing the code and insert that node into the DOM This invocation occurs after the DOM has been updated with the XHTML. Note that scripts may not be executed if it is not valid to create a <script> node in the DOM at the destination.
executeScripts	false	When true, Dojo will extract code from the <script> tags from the response and execute it based on the separateScripts value. When false, the XHTML response is inserted into the DOM and <script> nodes are ignored.

Icon

It's possible that the updated DOM will not include <script> nodes even though the inline code has been executed.

Icon

Ensure the response is XHTML-compliant (including, for example, thead and tbody tags in tables).
If you intend to run inline javascript:
*Ensure the javascript can be concatenated and executed in one block,
*set executeScripts=true,
*set separateScripts=true (the reliable option)

Topics

Most of the AJAX tags use Dojo topics for event notification and communication between them, to learn about topics visit Dojo's documentation

Examples

Examples can be found on the documentation for each tag in the UI Tag Reference page, for additional examples see Ajax and JavaScript Recipes and the Showcase application distributed with Struts 2.