2009 Marty Hall

The Dojo JavaScript Toolkit j p Part I: Ajax Support

( j (Dojo 1.3 Version) ) Originals of Slides and Source Code for Examples: http://courses.coreservlets.com/Course-Materials/ajax.html p j
Customized Java EE Training: http://courses.coreservlets.com/
Servlets, JSP, Struts, JSF/MyFaces/Facelets, Ajax, GWT, Spring, Hibernate/JPA, Java 5 & 6. Developed and taught by well-known author and developer. At public venues or onsite at your location.

2009 Marty Hall

For live Ajax & GWT training, see training courses at http://courses.coreservlets.com/. t htt // l t /
Taught by the author of Core Servlets and JSP, More Servlets and JSP and this tutorial. Available at public JSP, tutorial venues, or customized versions can be held on-site at your organization.
C Courses d developed and t l d d taught b M t H ll ht by Marty Hall Courses developed and taught by coreservlets.com experts (edited by Marty)
Java 6, intermediate/beginning servlets/JSP, advanced servlets/JSP, Struts, JSF 1.x & 2.0, Ajax, GWT, custom mix of topics Ajax courses can concentrate on 1EE Training: http://courses.coreservlets.com/ or survey several Customized Java library (jQuery, Prototype/Scriptaculous, Ext-JS, Dojo, Google Closure)

Servlets,Hibernate/JPA, EJB3, Ruby/Rails Spring, JSP, Struts, JSF/MyFaces/Facelets, Ajax, GWT, Spring, Hibernate/JPA, Java 5 & 6. Contact [email protected] for details Developed and taught by well-known author and developer. At public venues or onsite at your location.

Topics in This Section

Overview of Dojo Installation and documentation Quick summary of dojo.query and selectors The dojo.xhrGet function and variants
Basics Options O ti Sending data Inserting HTML Handling JSON data

Comparing Ajax support to other libraries p g j pp

Prototype, jQuery, Ext-JS
5

2009 Marty Hall

Introduction
Customized Java EE Training: http://courses.coreservlets.com/
Servlets, JSP, Struts, JSF/MyFaces/Facelets, Ajax, GWT, Spring, Hibernate/JPA, Java 5 & 6. Developed and taught by well-known author and developer. At public venues or onsite at your location.

Overview of Dojo
Core
Utilities for Ajax, CSS querying, DOM manipulation, cross-browser event handling, and general JavaScript programming Very similar to jQuery

Dijit j
Large set of rich GUI components Much more extensive than jQuery UI

D j X DojoX
Charts, graphs, vector graphics, fancy widgets Similar to the jQuery Plugins
7

Core Utilities
dojo.query("css selector")
Returns a NodeList of matching DOM elements.
Almost identical to $("css selector") in jQuery.

dojo xhrGet({options}) dojo.xhrGet({options})

Makes an Ajax GET request. Also dojo.xhrPost, etc.
Moderately similar to $.ajax({options}) in jQuery y j ({ }) j y

Example
dojo.xhrGet({ url: "address", load: responseHandler });

dojo addOnLoad(function) dojo.addOnLoad(function)

Calls function after DOM loaded.
Almost identical to $( u ct o ) in jQuery ost de t ca $(function) jQue y

dojo.require("dojo.libraryName")
8

Loads Dojo libraries on the fly

Downloading and Installation

Download
http://download.dojotoolkit.org/ Choose Download latest Stable Release, then dojo release x.y.z.zip dojo release x.y.z.tar.gz dojo-release-x.y.z.zip or dojo-release-x.y.z.tar.gz
This tutorial uses release 1.3.1

Installation
Unzip release file, creating 3 subfolders: dojo, dijit, dojox
Folders are quite large, but core file (dojo.js) is small. Other files are loaded on-the-fly based on dojo.require statements.

Copy 3 folders to WebContent/scripts of Eclipse project

Online documentation
http://dojotoolkit.org/docs
9

Browser Compatibility
Firefox
Core: 1.5 or later (vs 2.0 for jQuery) Dijit: 2.0 or later (same as jQuery)

Internet Explorer
6.0 or later (same as jQuery)

Safari
3.1 or later (vs. 3.0 for jQuery)

Opera
Core: 9.6 or later (vs. 9.0 for jQuery) Dijit: not supported!

Chrome
1.0 or later
10

Industry Usage

11

Approximately 40% of matches to prototype and JavaScript were false positives such as build a prototype with JavaScript. So, discount the Prototype graph by about 40%.

2009 Marty Hall

dojo.query dojo query & Selectors: Basics

Note: brief intro only. More details in next tutorial section.

Customized Java EE Training: http://courses.coreservlets.com/

Servlets, JSP, Struts, JSF/MyFaces/Facelets, Ajax, GWT, Spring, Hibernate/JPA, Java 5 & 6. Developed and taught by well-known author and developer. At public venues or onsite at your location.

Selecting DOM Elements

Idea
Use dojo.query("css selector") to get a set of DOM elements
Then, perform operations on each (see next page)

Examples
dojo.query("#some-id")
Return 1-element set (or empty set) of element with id Simplest use and most common for Ajax (note the #!) use, # !) Can also use dojo.byId("some-id") to get single element

dojo.query("p")
Return all p elements

dojo.query(".blah")
Return all elements that have class="blah"

dojo.query("li b span.blah")
13

Return all <span class="blah"> elements that are inside b elements, that in turn are inside li elements

Manipulating DOM Elements

Common functions on matched elements
d j dojo.query("selector").forEach(function) (" l t ") f E h(f ti )
Calls function on each element. this set to element.

dojo.query("selector").addClass("name")
Adds CSS class name to each. Also removeClass toggleClass each removeClass,

dojo.query("selector").wipeOut().play()
Makes invisible. Also wipeIn, fadeOut, fadeIn, etc.

dojo query("selector") onclick(function) dojo.query( selector ).onclick(function)

Adds onclick handler. Also onchange, onmouseover, etc.

dojo.query("selector").html("<tag>some html</tag>")
Sets the innerHTML of each element element.
Must use dojo.require("dojo.NodeList-html");

dojo.byId("some-id").value
Returns value of input element. Notice no #. #.

Chaining
14

dojo.query("a").onclick(f1).addClass("name").forEach(f2)

Example: Randomizing Background Colors (JavaScript)

dojo.require("dojo.NodeList-fx");
Loads extra JavaScript on the fly. Like smart window.onload. Explained in next section. ti The main two needed for basics apps are dojo.NodeList-fx and dojo.NodeList-html. The online docs tell you if a certain function necessitates a dojo require statement dojo.require statement.

dojo.addOnLoad(function() { dojo.query("#button1").onclick(randomizeHeadings); dojo.query("#button2").onclick(revertHeadings); });

Sets onclick handlers

15

Example: Randomizing Colors (JavaScript Continued)

Call setRandomStyle function on each h3 element function randomizeHeadings() { dojo.query( h3 ).forEach(setRandomStyle); dojo query("h3") forEach(setRandomStyle); dojo.query("h3.green").wipeOut().play(); Slowly hide every h3 that has CSS style green. } Note difference from jQuery approach: wipeOut returns an Animation, which you then call play on.

function setRandomStyle(heading) { dojo.query(heading).addClass(randomStyle()); d j (h di ) ddCl ( d St l ()) }

Add red, yellow or green CSS names to each

16

Example: Randomizing Colors (JavaScript Continued)

function randomStyle() { var styles = ["red", "yellow", "green"]; [ red yellow green ]; return(randomElement(styles)); } function randomElement(array) { var index = Math.floor(Math.random()*array.length); return(array[index]); } function revertHeadings() { u ct o e e t ead gs() dojo.query("h3.green").wipeIn().play(); dojo.query("h3").removeClass("red") ( y ) .removeClass("yellow") .removeClass("green"); }
17

Example: Randomizing Colors (Style Sheet)

.red { background-color: red } .yellow { background-color: yellow } yellow .green { background-color: green }
Names set by setRandomStyles function

18

Example: Eclipse Setup

Servlet and auxiliary code called by Ajax examples.

Copied from Dojo download. To start with, you only need to load dojo/dojo.js. Other files brought in via dojo.require statements. j q

Written for next example in this chapter. Written for this example. Written for example in next chapter.

JSP pages called by Ajax examples.

19

Example: Randomizing Colors (HTML)

<head><title>Dojo Basics</title> <link rel="stylesheet" Core Dojo. The dojo.require statements href="./css/styles.css" cause on-the-fly loading of additional files. type="text/css"/> <script src="./scripts/dojo/dojo.js" type="text/javascript"></script> <script src="./scripts/dojo-basics.js" < i t " / i t /d j b i j " type="text/javascript"></script> </head>

20

Example: Randomizing Colors (HTML Continued)

<h3>Foo, bar, <h3>Foo bar baz</h3> <h3>Blah, blah, blah</h3> <h3>Yadda, yadda, yadda</h3> <h3>Foo, bar, <h3>Foo bar baz</h3> <h3>Blah, blah, blah</h3> <h3>Yadda, yadda, yadda</h3> <h3>Foo, b <h3>F bar, b </h3> baz</h3> <h3>Blah, blah, blah</h3> <h3>Yadda, yadda, yadda</h3> <form action="#"> # <input type="button" id="button1" value="Randomize Headings"/> <input type="button" id="button2" value="Revert Headings"/> </form>

The ids to which onclick handlers were attached.

21

Example: Randomizing Colors (Results)

After Randomize Headings. Some headings turned green, then gradually disappeared.

22

When page originally loaded, or after Revert Headings

Understanding Operations on Sets of Elements

Instead of this
function randomizeHeadings() { dojo.query("h3").forEach(setRandomStyle); dojo.query("h3.green").wipeOut().play(); dojo query("h3 green") wipeOut() play(); } y ( g) function setRandomStyle(heading) { dojo.query(heading).addClass(randomStyle()); }

Why cant I simply do this?

function randomizeHeadings() { dojo.query("h3").addClass(randomStyle()); d j ("h3") ddCl ( d St l ()) dojo.query("h3.green").wipeOut().play(); }

23

2009 Marty Hall

dojo.xhrGet: Basics
Customized Java EE Training: http://courses.coreservlets.com/
Servlets, JSP, Struts, JSF/MyFaces/Facelets, Ajax, GWT, Spring, Hibernate/JPA, Java 5 & 6. Developed and taught by well-known author and developer. At public venues or onsite at your location.

dojo.xhrGet: Basic Syntax

dojo.xhrGet(optionsObject)
Minimal form: dojo.xhrGet({url: "address", load: funct});
Also dojo.xhrPost, dojo.xhrPut, dojo.xhrDelete, etc.

Handler function gets response text. Response text is text considered a string unless you use handleAs option.

Options for dojo.xhrGet({}) j ({ })

Almost-always used
url, load

Other common options

content, error, preventCache, handleAs

25

Data-Centric Ajax with and without Toolkits

With basic JavaScript
function getRequestObject() { if (window.XMLHttpRequest) { return(new XMLHttpRequest()); } else if (window.ActiveXObject) { return(new ActiveXObject("Microsoft.XMLHTTP")); } else { return(null); } } function sendRequest() { var request = getRequestObject(); request.onreadystatechange = function() { someFunct(request); }; request.open("GET", "some-url", true); request.send(null); }
26

Data-Centric Ajax with and without Toolkits

jQuery (handler passed response text)
$.ajax({url: "address", success: handlerFunct});

Prototype (handler passed response object)

new Ajax.Request("address", {onSuccess: handlerFunct});

Ext (handler passed response object)

Ext.Ajax.request({url: "address", success: handlerFunct});

Dojo (handler passed response text)

dojo.xhrGet({url: " dd d j h G t({ l "address", " load: handlerFunct});
27

dojo.xhrGet Example Code: JavaScript

function showTime1() { dojo.xhrGet({ dojo xhrGet({ url: "show-time.jsp", load: showAlert, preventCache: true }); } function showAlert(text) { ( ); alert(text); }

The preventCache option is not required, but is a convenient option when the same URL (including query data) yields different responses. This way, you dont have to send Cache-Control and Pragma headers from server.

This is the response text, but you can declare a second argument (ioArgs) if you want the response object (XmlHttpRequest) and other information. Also note that the latest Firefox does not let you pass native functions here, so you cannot use alert instead , y of showAlert for the success parameter.

28

dojo.xhrGet Example Code: HTML

<head><title>Dojo and Ajax</title> Ajax</title>... <script src="./scripts/dojo/dojo.js" type="text/javascript"></script> <script src="./scripts/dojo-ajax.js" src=" /scripts/dojo ajax js" type="text/javascript"></script> </head> <body>... <b d > <fieldset> <legend>dojo.xhrGet: Basics (Using explicit onclick handler in HTML)</legend> ) / <form action="#"> <input type="button" value="Show Time" onclick="showTime1()"/> </form> </fieldset>

29

dojo.xhrGet Example Code: JSP

It is now <%= new java.util.Date() %>

30

dojo.xhrGet : Results

31

Registering Event Handlers in JavaScript

Basic approach
Previous example set the onclick handler in the HTML. Although this is common with other Ajax libraries, Dojo (and jQuery) advocate setting it in the JavaScript instead
Often referred to as unobtrusive JavaScript: no explicit JavaScript anywhere in the HTML page

Dojo support
dojo.addOnLoad(function() {});
Function runs after the DOM is loaded, but does not wait , for images, as with window.onload Use this approach to set up all event handlers

dojo query("#some-id") onclick(someHandler); dojo.query( #some id ).onclick(someHandler);

Assigns onclick handler. Handler is passed a DOMEvent with characteristics that are unified across browsers
32

Redoing Time Alert: JavaScript

dojo.addOnLoad(function() { dojo.query("#time-button-1").onclick(showTime1); dojo query("#time button 1") onclick(showTime1); }); function showTime1() { dojo.xhrGet({ url: "show-time.jsp", load: showAlert, preventCache: true }); } function showAlert(text) { alert(text); }

These two functions are unchanged from previous example.

33

Redoing Time Alert: HTML

<fieldset> <legend>dojo.xhrGet: Basics ( l d d j h G t i (Registering i t i onclick handler in JavaScript)</legend> <form action="#"> <input type="button" value="Show Time" id="time-button-1"/> </form> </f > </fieldset>

34

Redoing Time Alert: Results

Works exactly the same as previous example example.

35

2009 Marty Hall

dojo.xhrGet: dojo xhrGet: Sending Data g

Customized Java EE Training: http://courses.coreservlets.com/
Servlets, JSP, Struts, JSF/MyFaces/Facelets, Ajax, GWT, Spring, Hibernate/JPA, Java 5 & 6. Developed and taught by well-known author and developer. At public venues or onsite at your location.

Ajax Functions
dojo.xhrGet({options})
Make a GET request

dojo.xhrPost({options})
M k a POST request Make

dojo.xhr("method", {options}, hasBody)

Lets you send arbitrary HTTP commands

dojo.xhrPut, dojo.xhrDelete
Make a PUT or DELETE request Unsupported on many servers

dojo.rawXhrPost, dojo.rawXhrPut j , j
Sends a POST or PUT request, but lets you provide the raw data for the body of the request
37

Overview
dojo.xhrGet({ url: , load: , content: });
Content value is an object: query string gets built out of property names and URL-encoded property values
O end of URL f ajax.xhrGet; On d f for j hG t in POST body for dojo.xhrPost See later example for building the string automatically using the form option Works identically to parameters option in Prototype or data option in jQuery data

Examples
dojo.xhrGet({ content: { param1: "foo bar!", j ({ p , param2: "baz"}});
38

Content Example: JavaScript

dojo.addOnLoad(function() { dojo.query( #params button 1 ).onclick(showParams1); dojo query("#params-button-1") onclick(showParams1); }); function showAlert(text) { alert(text); }
Same function used in earlier examples.

39

function showParams1() { dojo. dojo.xhrGet({ Get({ url: "show-params.jsp", content: { param1: "foo", p param2: "bar" }, load: showAlert }); }

The preventCache option is not used since the same data always results in the same response.

Content Example: HTML

<fieldset> <fi ld t> <legend>dojo.xhrGet: The 'content' Option</legend> <form action="#"> <input type="button" value="Show Params" id="params-button-1"/> </form> </fieldset>

40

Content Example: JSP

param1 is ${param.param1}, param2 is ${param param2} ${param.param2}.

41

Content Example: Results

42

 2009 Marty Hall

dojo.xhrGet: Options
Customized Java EE Training: http://courses.coreservlets.com/
Servlets, JSP, Struts, JSF/MyFaces/Facelets, Ajax, GWT, Spring, Hibernate/JPA, Java 5 & 6. Developed and taught by well-known author and developer. At public venues or onsite at your location.

Overview
Options (almost) always used: url, load
dojo.xhrGet({url: "some-address", load: someFunc});
load is not strictly required; you might want to just fire off some data to the server and not display anything p y y g Options apply equally to dojo.xhrPost and others

Common options: example

dojo.xhrGet({ url: "address", load: successHandlerFunction, , content: { param1: "foo bar", param2: "baz"}, error: errorHandlerFunction, preventCache: t tC h true, handleAs: "json" });
44

Options
Name content t t Description
Data t D t to send t server, in the form on an object with param names d to i th f bj t ith and raw (non-escaped) param values. The object property names become request param names and property values get URLencoded and become request param values. & and = inserted automatically. Sent in the appropriate place depending on t ti ll S t i th i t l d di whether it is GET or POST. Function to be called if request fails due to server error, expired timeout, or exception thrown from main response handler. Function gets passed 2 args: the data returned from the server (formatted according to the handleAs property), and an ioArgs object. The ioArgs object has many properties, but most useful are args, query, url, and xhr. Id of a form whose fields will be serialized to form the query data. Function to be called whether or not request was successful. More common t use separate load and error properties. M to t l d d ti The format in which to pass the response to the handler function. Legal values are text, json, xml, json-comment-optional, jsoncomment-filtered, and javascript.

Default Empty E t

error

None

form handle handleAs

45

None None "text"

Options (Continued)
Name headers h d load Description
Extra E t HTTP request headers to be sent to the server. th d t b t t th Function to be called if request succeeds. Function gets passed 2 args: the data returned from the server (formatted according to the handleAs property), and an ioArgs object. The ioArgs object p p y), g j g j has many properties, but most useful are args, query, url, and xhr. use GET and you could get different responses back from the same data If true then the URL is appended with a data. true, dojo.preventCache parameter with a timestamp that changes with each request. Should the request be synchronous? Use synchronous requests with caution since they lock up the browser. Timeout in milliseconds. If request takes longer, the error handler will be called instead of the load handler. The address to req est Sho ld be a relati e URL request. Should relative URL.

Default None N None

preventCache Is browser prohibited from caching the page? Set to true if you

false

sync timeout url

false Infinity None

46

 2009 Marty Hall

Inserting Results into HTML: The html Function

Customized Java EE Training: http://courses.coreservlets.com/
Servlets, JSP, Struts, JSF/MyFaces/Facelets, Ajax, GWT, Spring, Hibernate/JPA, Java 5 & 6. Developed and taught by well-known author and developer. At public venues or onsite at your location.

Content-Centric Ajax with and without Toolkits

jQuery
function ajaxResult(address, resultRegion) { $(resultRegion).load(address); }

Prototype
function ajaxResult(address, resultRegion) { new Ajax.Updater(resultRegion, address); j p g }

Dojo
N explicit support for content-centric Ajax. Response No li it tf t t t i Aj R handler uses html to do the insert.

Ext-JS
48

function ajaxResult(address, resultRegion) { Ext.get(resultRegion).load({ url: address}); }

Reading Textfield Values

1. Use dojo.byId("some-id").value
Note that there is no # before the ID, since you are not doing a CSS match, but rather using a shortcut for document.getElementById Also note that Dojo has no way of looking up values directly from a NodeList resulting from a Dojo query. I.e., thi I nothing equivalent to jQ i l t t jQuerys $("# $("#some-id").val(). id") l()

2. Supply values to content property

No need to escape values first
dojo.xhrGet({ content: { param1: dojo.byId("id1").value });

Sh t t Shortcut
See upcoming section on form property
49

Ajax with HTML Insertion: JavaScript (Setup)

dojo.require("dojo.NodeList-html"); dojo.addOnLoad(function() { dojo.query("#params-button-2") .onclick(showParams2); li k( h P 2) });

50

Ajax with HTML Insertion: JavaScript (Main Code)

function showParams2() { field1 and field2 are textfield ids (not names) dojo.xhrGet({ dojo xhrGet({ url: "show-params.jsp", content: { param1: dojo.byId("field1").value, param2: dojo byId("field2") value } dojo.byId("field2").value }, load: function(text) { insertText(text, "#result1"); } }); id of div whose innerHTML will become the result text. } function insertText(text, selector) { dojo.query(selector).html(text); }
51

HTML Insertion: HTML Page

<fieldset> <legend>dojo.xhrGet: HTML Insertion</legend> <form action="#"> param1: <input type="text" id="field1"/> <br/> param2: <input type="text" id="field2"/> <br/> <input type butto put type="button" value="Show Params" a ue S o a a s id="params-button-2"/> <h2 id="result1"></h2> </form> / </fieldset>
52

HTML Insertion: JSP

param1 is ${param.param1}, param2 is ${param param2} ${param.param2}.

Unchanged from previous example

53

HTML Insertion: Results

54

HTML Insertion: Comparing Prototype, jQuery Prototype jQuery, and Dojo

Prototype
function ajaxResult(address, resultRegion) { new Ajax.Updater(resultRegion, address); }

jQuery
function ajaxResult(address, resultRegion) { $(resultRegion).load(address); }

D j (also need d j Dojo ( l d dojo.require) i )

function ajaxResult(address, resultRegion) j ({ , dojo.xhrGet({ url: address, load: function(text) { insertText(text, resultRegion); } }); } function insertText(text, selector) { dojo.query(selector).html(text); }

55

2009 Marty Hall

Building Parameter Strings Automatically with form

Customized Java EE Training: http://courses.coreservlets.com/
Servlets, JSP, Struts, JSF/MyFaces/Facelets, Ajax, GWT, Spring, Hibernate/JPA, Java 5 & 6. Developed and taught by well-known author and developer. At public venues or onsite at your location.

Using form Option

Idea
You specify a form, and Dojo automatically builds query string from all appropriate input elements. The element names (not ids) become the param names

Syntax
dojo.xhrGet({ url: , load: , form: "some-id" }); j G ({ , ,
Note: no # before the id

Advantages
One simple option, no matter how many input elements Only takes values of active elements (e.g., unchecked radio buttons or checkboxes are ignored) Giving names to input elements is familiar to HTML developers

57

form Example: JavaScript

dojo.require("dojo.NodeList-html"); dojo.addOnLoad(function() { dojo.query("#params-button-3") .onclick(showParams3); onclick(showParams3); }); function showParams3() { dojo.xhrGet({ u : s o pa a s.jsp , url: "show-params.jsp", form: "form1", load: function(text) { ( , # ); insertText(text, "#result2"); } }); }

58

form Example: HTML

<fieldset> <legend>dojo.xhrGet: Simplifying Params with 'form'</legend> <form action="#" id="form1"> action= # id= form1 > param1: <input type="text" name="param1"/> <br/> param2: <input type="text" name="param2"/> <br/> b / <input type="button" value="Show Params" id="params-button-3"/> <h2 id="result2"></h2> / </form> </fieldset>
59

form Example: JSP

param1 is ${param.param1}, param2 is ${param param2} ${param.param2}.

Unchanged from previous examples

60

form Example: Results

61

2009 Marty Hall

Handling H dli JSON Data D t

Customized Java EE Training: http://courses.coreservlets.com/
Servlets, JSP, Struts, JSF/MyFaces/Facelets, Ajax, GWT, Spring, Hibernate/JPA, Java 5 & 6. Developed and taught by well-known author and developer. At public venues or onsite at your location.

Approach
Server
Returns JSON object with no extra parens. E.g.:
{ cto: "Resig ", ceo: "Gates ", coo: "Ellison" }

Code that calls dojo xhrGet dojo.xhrGet

Specifies json for handleAs. E.g.:
dojo.xhrGet({url: address, load: handler, handleAs: "json"}); j ({ j })

Response handler
Receives JavaScript data as first argument. No need for parsing or eval. Must build HTML from result. E.g.: i l M b ild f l E
function handler(companyExecutives) { dojo.query("#some-id") .html("<b>Chief Technology Officer is " + companyExecutives.cto + "</b>"); }

63

JSON Example Code: Core JavaScript

dojo.require("dojo.NodeList-html"); dojo.addOnLoad(); dojo addOnLoad( ); function showNums() { j ({ dojo.xhrGet({ url: "show-nums", handleAs: "json", load: showNumberList, preventCache: true }); }

Strings

64

function showNumberList(jsonData) { var list = makeList(jsonData.fg, jsonData.bg, jsonData.fontSize, jsonData fontSize jsonData.numbers); int dojo.query("#result3").html(list); Array of doubles }

JSON Example Code: Auxiliary JavaScript

function makeList(fg, bg, fontSize, nums) { return( listStartTags(fg, bg, fontSize) + listItems(nums) + listEndTags()); } function li tSt tT f ti listStartTags(fg, b (f bg, f tSi ) { fontSize) return( "<div style='color:" + fg + "; " + "background-color:" + bg + "; " + "font-size:" + fontSize + "px'>\n" + "<ul>\n"); }
65

JSON Example Code: Auxiliary JavaScript (Continued)

function listItems(items) { var result = ""; ; for(var i=0; i<items.length; i++) { result = result + "<li>" + items[i] + "</li>\n"; } return(result); } function listEndTags() { return("</ul></div>"); }

66

JSON Example Code: HTML

<fieldset> <fi ld t> <legend>dojo.xhrGet: Treating Response as JSON</legend> <form action="#"> <input type="button" value="Show Nums" id nums button /> id="nums-button"/> <div id="result3"></div> </form> </fieldset> </fi ld t>

67

JSON Example Code: Servlet

public class ShowNumbers extends HttpServlet { public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { response.setHeader("Cache-Control", "no-cache"); response.setHeader("Pragma", "no-cache"); p ( g , ) String fg = ColorUtils.randomColor(); request.setAttribute("fg", fg); String bg = ColorUtils.randomColor(); request.setAttribute( bg , request.setAttribute("bg", bg); String fontSize = "" + (10 + ColorUtils.randomInt(30)); request.setAttribute("fontSize", fontSize); double[] nums = { Math random() Math random() Math random() }; Math.random(), Math.random(), Math.random() request.setAttribute("nums", nums); response.setContentType("application/json"); String outputPage = "/WEB-INF/results/show-nums.jsp"; RequestDispatcher dispatcher = request.getRequestDispatcher(outputPage); dispatcher.include(request, response); }}

68

JSON Example Code: JSP

{ fg: "${fg}", bg: "${b }" b "${bg}", fontSize: ${fontSize}, numbers: [ ${nums[0]}, ${nums[1]}, ${nums[2]}] { [ ]}, { [ ]}, { [ ]}] }

Notes
No enclosing parens. Dojo will wrap in parens and then pass to eval (or equivalent functionality) eval Types
fg and bg: Strings f tSi fontSize: i t int numbers: Array of doubles
69

JSON Example Code: Auxiliary Java Code

public class ColorUtils { p private static String[] colors = { g[] "aqua", "black", "blue", "fuchsia", "gray", "green", "lime", "maroon", "navy", "olive", "purple", "red", "silver", "teal", "white", "yellow" }; /** A random number between 0 and range-1, inclusive. */ public static int randomInt(int range) { return(new Random().nextInt(range)); } /** One of the official HTML color names, at random. */ public static String randomColor() { return(colors[randomInt(colors.length)]); ( l [ d ( l l h)]) } }
70

JSON Example: Results

71

2009 Marty Hall

Wrap-up
Customized Java EE Training: http://courses.coreservlets.com/
Servlets, JSP, Struts, JSF/MyFaces/Facelets, Ajax, GWT, Spring, Hibernate/JPA, Java 5 & 6. Developed and taught by well-known author and developer. At public venues or onsite at your location.

Best JavaScript Libraries p

General JS programming
Leader: Prototype Leader (only): GWT

Traditional Ajax support

Tie Leader: GWT 2nd tier: DWR, JSON-RPC

Other programming (Java) Server communication DOM manipulation

Leader: jQuery
Oth copying jQuery approach and Others i jQ h d closing gap. jQuery released CSS matching library separately (http://sizzlejs.com)

Usage in industry
Leader: jQuery 2nd tier: Ext-JS, Dojo, YUI, Prototype, Scriptaculous, GWT

Rich GUIs
Leaders: Ext-JS, YUI, Dojo 2nd tier: jQuery UI GWT UI,

Looking ahead
All these entries are likely to c ge s g c change significantly y Lurking on the horizon: Google Closure library

Familiarity to JS developers
73

Lowest: GWT

Books and References

Dojo: The Definitive Guide
by Matthew A. Russell

Mastering Dojo
b C i Ri k et al by Craig Riecke l

Concise Guide to Dojo

by Leslie M. Orchard M

http://dojotoolkit.org/docs
Moderately complete Moderately well organized Large number of explicit examples

74

Summary
Assigning event handlers programmatically
dojo.addOnLoad(function() { dojo.query("#some-id").onclick(someFunction); });

General Ajax requests (data-centric Ajax)

dojo.xhrGet({ url: "relative-address", , load: handlerFunction, form: "form-id, handleAs: "json" });

Inserting HTML (content-centric Ajax)

dojo.require("dojo.NodeList-html"); dojo.xhrGet({ (omit handleAs) }); function h dl F f ti handlerFunction(text) { ti (t t) dojo.query("#some-id").html(text); }

75

2009 Marty Hall

Questions?
Customized Java EE Training: http://courses.coreservlets.com/
Servlets, JSP, Struts, JSF/MyFaces/Facelets, Ajax, GWT, Spring, Hibernate/JPA, Java 5 & 6. Developed and taught by well-known author and developer. At public venues or onsite at your location.