Grails and Dojo
Download as PPT, PDF7 likes3,098 views
The document provides an overview of using AJAX capabilities in Grails applications with the Dojo JavaScript library. It discusses getting started with Dojo in Grails, Grails AJAX tags for basic AJAX functionality, rendering JSON responses from controllers, and how Grails supports more complex Dojo widgets and functionality beyond basic AJAX.
![formRemote Creates a <form> that will submit all input fields via AJAX. <g:formRemote url="[action:'formRemoteCall']" name="form2" update="message" onLoading="toggleSpinner(true)" onLoaded="toggleSpinner(false)" > User: <input name="user" type="text"></input> <input type="submit" value="formRemote Call"></input> </g:formRemote> def formRemoteCall = { log.debug("${actionName} Action called with ${params.user}") render "You called ${actionName} in ${controllerName} with ${params.user}" }](https://image.slidesharecdn.com/grails-and-dojo-1193166840375049-1/85/Grails-and-Dojo-13-320.jpg)
![submitToRemote Same as formRemote, just the submit logic is executed on a specific submit button, not all submit buttons. <g:javascript library="dojo" /> <g:javascript> dojo.require("dojo.io.IframeIO"); </g:javascript> <g:form url="[action:'submitToRemoteCall']" id="form2" enctype="multipart/form-data"> File: <input name="someFile" type="file"></input> <g:submitToRemote value="Submit Upload" name="form2" action="submitToRemoteUpload" update="[success:'message',failure:'error']" /> </g:form>](https://image.slidesharecdn.com/grails-and-dojo-1193166840375049-1/85/Grails-and-Dojo-14-320.jpg)
![remoteField Creates an <input> field that submits itself automatically <g:remoteField before="if (this.value.length < 3) return false;" action="quickSearch" update="tableContent" name="search" paramName="search"/> <span id="spinner" style="display:none;"> <img src="${createLinkTo(dir:'images',file:'spinner_mac.gif')}" alt="Spinner" /> </span> def quickSearch = { def devices = Device.findAllByModelLike("%${params.search}%", [max:20, sort :"model", order:'asc']) render(template:'tableContent', model:[deviceList:devices]) }](https://image.slidesharecdn.com/grails-and-dojo-1193166840375049-1/85/Grails-and-Dojo-16-320.jpg)
![Render() is your best friend Whether you render pure text, html or JSON/XML formatted text, render() does it all. Creating simple responses is quick and easy: render "This is easy.“ render "{font:{id:10, name:'Arial'}}" If you got larger, more complex responses, use a template to keep it clean: render(template:'podcastList', model:[podcasts:Podcast. findAll ()])](https://image.slidesharecdn.com/grails-and-dojo-1193166840375049-1/85/Grails-and-Dojo-22-320.jpg)
![Rendering JSON JSON is faster than XML, it should be AJAJ XML is evil, don’t use it Really, guess what’s faster: <?xml version="1.0" encoding="ISO-8859-1"?><linked-hash-map> <entry> <string>identifier</string> <string>id</string> </entry> <entry> <string>items</string> <list> <linked-hash-map> <entry> <string>id</string> <long>1</long> </entry> <entry> <string>url</string> <string>http://url1/rss</string> </entry> </linked-hash-map> <linked-hash-map> <entry> <string>id</string> <long>2</long> </entry> <entry> <string>url</string> <string>http://url2/rss</string> </entry> </linked-hash-map> <linked-hash-map> <entry> <string>id</string> <long>3</long> </entry> <entry> <string>url</string> <string>http://url3/rss</string> </entry> </linked-hash-map> <linked-hash-map> <entry> <string>id</string> <long>4</long> </entry> <entry> <string>url</string> <string>http://url4/rss</string> </entry> </linked-hash-map> <linked-hash-map> <entry> <string>id</string> <long>5</long> </entry> <entry> <string>url</string> <string>http://url5/rss</string> </entry> </linked-hash-map> <linked-hash-map> <entry> <string>id</string> <long>6</long> </entry> <entry> <string>url</string> <string>http://url6/rss</string> </entry> </linked-hash-map> <linked-hash-map> <entry> <string>id</string> <long>7</long> </entry> <entry> <string>url</string> <string>http://url7/rss</string> </entry> </linked-hash-map> <linked-hash-map> <entry> <string>id</string> <long>8</long> </entry> <entry> <string>url</string> <string>http://url8/rss</string> </entry> </linked-hash-map> <linked-hash-map> <entry> <string>id</string> <long>9</long> </entry> <entry> <string>url</string> <string>http://url9/rss</string> </entry> </linked-hash-map> <linked-hash-map> <entry> <string>id</string> <long>10</long> </entry> <entry> <string>url</string> <string>http://url10/rss</string> </entry> </linked-hash-map> </list> </entry> </linked-hash-map> {"identifier":"id","items":[{"id":1,"url":"http://url1/rss"},{"id":2,"url":"http://url2/rss"},{"id":3,"url":"http://url3/rss"},{"id":4,"url":"http://url4/rss"},{"id":5,"url":"http://url5/rss"},{"id":6,"url":"http://url6/rss"},{"id":7,"url":"http://url7/rss"},{"id":8,"url":"http://url8/rss"},{"id":9,"url":"http://url9/rss"},{"id":10,"url":"http://url10/rss"}]} XML or JSON?](https://image.slidesharecdn.com/grails-and-dojo-1193166840375049-1/85/Grails-and-Dojo-23-320.jpg)
![JSON is easy to read, too { "identifier":"id", "items": [ { "id":1, "url":"http://url1/rss" }, { "id":2, "url":"http://url2/rss" }, { "id":3, "url":"http://url3/rss" }, { "id":4, "url":"http://url4/rss" } ] }](https://image.slidesharecdn.com/grails-and-dojo-1193166840375049-1/85/Grails-and-Dojo-24-320.jpg)
![Dojo ComboBox & Grails Grails Action def comboboxConverterData = { def items = [] def podcasts = Podcast.findAll(); podcasts.each { podcast -> items << [id:podcast.id, url:podcast.feedURL] } def json = [identifier:"id", items: items] render json as JSON } Using the Grails Converter simplifies the creation of the expected json structure.](https://image.slidesharecdn.com/grails-and-dojo-1193166840375049-1/85/Grails-and-Dojo-30-320.jpg)
![Dojo FilterSelect & Grails Grails Action – the same…but! def filterSelectData = { def items = [] def podcasts = Podcast.findAll(); podcasts.each { podcast -> items << [id:podcast.id, url:podcast.feedURL] } def json = [identifier:"id", items: items] render json as JSON } Once the user has chosen a label from the list, the identifier (here: podcast.id value) will be used as the value of the widget.](https://image.slidesharecdn.com/grails-and-dojo-1193166840375049-1/85/Grails-and-Dojo-32-320.jpg)
![Dojo Tree & Grails Grails Action def treeData = { def items = [] def children = [] (1..3).each { children << [_reference:"${it}"] } def podcasts = Podcast.findAll(); podcasts.each { podcast -> items << [id:podcast.id, url:podcast.feedURL, children:children ] } def json = [ identifier:"id" , label:'url', items: items] render json as JSON }](https://image.slidesharecdn.com/grails-and-dojo-1193166840375049-1/85/Grails-and-Dojo-34-320.jpg)
Grails and Dojo
- 2. About Sven Using Groovy & Grails since Aug 2006 Grails Podcast, Groovy Series Working at Yahoo!, Inc Find out yourself www.svenhaiges.de
- 3. Goals You know how to get started! You know how AJAX is supported by Grails Tags, Libraries, Abstraction Layer You know why Groovy & Grails support your AJAX development, using Dojo Controllers & Actions, render(), Builders, Templates Tipps, gotchas, further resources
- 5. Getting started… Install Grails – done! Install Dojo Best download from dojotoolkit.org Place in web-app/js Or use the CDN version of dojo, no installation on your own server! ‘grails install-dojo’ installs dojo 0.4.3 !
- 6. How to add Dojo to your pages 0.4.3: Load the dojo core library in your pages <g:javascript library="dojo" /> Want to use dojo 0.9? Just use CDN: <script type="text/javascript" djConfig="isDebug: true" src="http://o.aolcdn.com/dojo/0.9.0/dojo/dojo.xd.js"></script> <script type="text/javascript"> dojo.addOnLoad(function(){ alert('loaded, all good'); }); </script>
- 7. Understanding Grails & AJAX What a surprise, Grails can serve JavaScript, too! Grails supports AJAX with special tags that provide basic AJAX support for these libraries: prototype, Yahoo! UI, Dojo Abstraction Layer Dojo currently has to be installed separately, Y UI and Prototype come with.
- 8. Dojo is more than AJAX Many say AJAX but really mean AJAX + Widgets. Dojo is very strong in Widgets. Besides this, you get way more: package system, animations, utilities, ShrinkSafe… But: you have to code this in your own code, in javascript. No tags can help you here.
- 9. Learning Path Get familiar with Grails Use some Grails AJAX Tags in your pages, see what source code they generate Experiment with your own Javascript / Dojo code Really understand JavaScript & CSS
- 10. Grails AJAX Tags
- 12. remoteLink Creates an <a> Link, submits the request via AJAX and is capable of replacing a div upon response. Several onXXX Methods to customize the call. <div id="message"></div> <g:remoteLink action="remoteLinkCallId" id="1" update="message"> AJAX Call, id=1 </g:remoteLink> def remoteLinkCallId = { log.debug("${actionName} Action called with ${params.id}") render "You called ${actionName} in ${controllerName} with ${params.id}" }
- 13. formRemote Creates a <form> that will submit all input fields via AJAX. <g:formRemote url="[action:'formRemoteCall']" name="form2" update="message" onLoading="toggleSpinner(true)" onLoaded="toggleSpinner(false)" > User: <input name="user" type="text"></input> <input type="submit" value="formRemote Call"></input> </g:formRemote> def formRemoteCall = { log.debug("${actionName} Action called with ${params.user}") render "You called ${actionName} in ${controllerName} with ${params.user}" }
- 14. submitToRemote Same as formRemote, just the submit logic is executed on a specific submit button, not all submit buttons. <g:javascript library="dojo" /> <g:javascript> dojo.require("dojo.io.IframeIO"); </g:javascript> <g:form url="[action:'submitToRemoteCall']" id="form2" enctype="multipart/form-data"> File: <input name="someFile" type="file"></input> <g:submitToRemote value="Submit Upload" name="form2" action="submitToRemoteUpload" update="[success:'message',failure:'error']" /> </g:form>
- 15. submitToRemote Form uploads require us to send the response in an HTML textarea field! def submitToRemoteUpload = { def f = request.getFile('someFile') if(f.empty) { render "No file!" } else { def fileName = f.getOriginalFilename() render(text:"<html><body><textarea>You called ${actionName} in ${controllerName} with file ${fileName}</textarea></body></html>", contentType:"text/html", encoding:"UTF-8") } }
- 16. remoteField Creates an <input> field that submits itself automatically <g:remoteField before="if (this.value.length < 3) return false;" action="quickSearch" update="tableContent" name="search" paramName="search"/> <span id="spinner" style="display:none;"> <img src="${createLinkTo(dir:'images',file:'spinner_mac.gif')}" alt="Spinner" /> </span> def quickSearch = { def devices = Device.findAllByModelLike("%${params.search}%", [max:20, sort :"model", order:'asc']) render(template:'tableContent', model:[deviceList:devices]) }
- 17. remoteField list.gsp <table> <thead> <tr> ... </tr> </thead> <tbody id="tableContent"> <g:each in="${deviceList}" var="device"> ... </g:each> </tbody> </table> _tableContent.gsp <g:each in="${deviceList}" var="device"> <tr> <td>${device.id}</td> ... </tr> </g:each>
- 18. onXXX Methods
- 19. Grails AJAX Tags Basic AJAX functionality, good to get started or for very easy use cases More complex stuff: master dojo define the content you send yourself 0.9 Complex UI changes
- 20. Grails AJAX Tags do not provide Support for Dijit Widgets … but Grails is the ideal server part for many data-hungry widgets – next section.
- 22. Render() is your best friend Whether you render pure text, html or JSON/XML formatted text, render() does it all. Creating simple responses is quick and easy: render "This is easy.“ render "{font:{id:10, name:'Arial'}}" If you got larger, more complex responses, use a template to keep it clean: render(template:'podcastList', model:[podcasts:Podcast. findAll ()])
- 23. Rendering JSON JSON is faster than XML, it should be AJAJ XML is evil, don’t use it Really, guess what’s faster: <?xml version="1.0" encoding="ISO-8859-1"?><linked-hash-map> <entry> <string>identifier</string> <string>id</string> </entry> <entry> <string>items</string> <list> <linked-hash-map> <entry> <string>id</string> <long>1</long> </entry> <entry> <string>url</string> <string>http://url1/rss</string> </entry> </linked-hash-map> <linked-hash-map> <entry> <string>id</string> <long>2</long> </entry> <entry> <string>url</string> <string>http://url2/rss</string> </entry> </linked-hash-map> <linked-hash-map> <entry> <string>id</string> <long>3</long> </entry> <entry> <string>url</string> <string>http://url3/rss</string> </entry> </linked-hash-map> <linked-hash-map> <entry> <string>id</string> <long>4</long> </entry> <entry> <string>url</string> <string>http://url4/rss</string> </entry> </linked-hash-map> <linked-hash-map> <entry> <string>id</string> <long>5</long> </entry> <entry> <string>url</string> <string>http://url5/rss</string> </entry> </linked-hash-map> <linked-hash-map> <entry> <string>id</string> <long>6</long> </entry> <entry> <string>url</string> <string>http://url6/rss</string> </entry> </linked-hash-map> <linked-hash-map> <entry> <string>id</string> <long>7</long> </entry> <entry> <string>url</string> <string>http://url7/rss</string> </entry> </linked-hash-map> <linked-hash-map> <entry> <string>id</string> <long>8</long> </entry> <entry> <string>url</string> <string>http://url8/rss</string> </entry> </linked-hash-map> <linked-hash-map> <entry> <string>id</string> <long>9</long> </entry> <entry> <string>url</string> <string>http://url9/rss</string> </entry> </linked-hash-map> <linked-hash-map> <entry> <string>id</string> <long>10</long> </entry> <entry> <string>url</string> <string>http://url10/rss</string> </entry> </linked-hash-map> </list> </entry> </linked-hash-map> {"identifier":"id","items":[{"id":1,"url":"http://url1/rss"},{"id":2,"url":"http://url2/rss"},{"id":3,"url":"http://url3/rss"},{"id":4,"url":"http://url4/rss"},{"id":5,"url":"http://url5/rss"},{"id":6,"url":"http://url6/rss"},{"id":7,"url":"http://url7/rss"},{"id":8,"url":"http://url8/rss"},{"id":9,"url":"http://url9/rss"},{"id":10,"url":"http://url10/rss"}]} XML or JSON?
- 24. JSON is easy to read, too { "identifier":"id", "items": [ { "id":1, "url":"http://url1/rss" }, { "id":2, "url":"http://url2/rss" }, { "id":3, "url":"http://url3/rss" }, { "id":4, "url":"http://url4/rss" } ] }
- 25. JSON is easy to create, too Then work with it in you app: render(builder:'json') { element(imagePath: " /app/myimage.png") } {"element":{"imagePath":"/app/myimage.png"}} dojo.io.iframe.send( { url: "/some/url", form: dojo.byId('formImage'), handleAs: " json ", method: "POST", handle: function(response, ioArgs) { var fileName = response.elementImage.fileName; } });
- 26. Using converter & Render Converts domain objects to JSON import grails.converters.JSON def podcastJSON = { def podcast = Podcast.get(1) render podcast as JSON } { "id":1, "class":"Podcast", "author":"Author1", "feedURL":"http://url1/rss" }
- 27. Special Dojo Widgets & Grails
- 28. Data-hungry widgets ComboBox Provides a list of acceptable values but user can still enter his own value. Has a value, just like a textbox. FilteringSelect Much like ComboBox, but has label/value like a select. Will set ‘identifier’ as value of selected label. Tree
- 29. Dojo ComboBox & Grails GSP <div dojoType="dojo.data.ItemFileReadStore" jsId="stateStore" url="<g:createLink controller="widget" action="comboboxConverterData“ />"> </div> <input dojoType="dijit.form.ComboBox" store="stateStore" hasDownArrow="false" value="" searchAttr="url" name=“feed" onChange="setValue" />
- 30. Dojo ComboBox & Grails Grails Action def comboboxConverterData = { def items = [] def podcasts = Podcast.findAll(); podcasts.each { podcast -> items << [id:podcast.id, url:podcast.feedURL] } def json = [identifier:"id", items: items] render json as JSON } Using the Grails Converter simplifies the creation of the expected json structure.
- 31. Dojo FilterSelect & Grails GSP <div dojoType="dojo.data.ItemFileReadStore" jsId="feedStore" url="<g:createLink controller="widget" action="filterSelectData" />"> </div> <input dojoType="dijit.form.FilteringSelect" id="chooser" store="feedStore" searchAttr="url" name="feed" autocomplete="true" pageSize="5" />
- 32. Dojo FilterSelect & Grails Grails Action – the same…but! def filterSelectData = { def items = [] def podcasts = Podcast.findAll(); podcasts.each { podcast -> items << [id:podcast.id, url:podcast.feedURL] } def json = [identifier:"id", items: items] render json as JSON } Once the user has chosen a label from the list, the identifier (here: podcast.id value) will be used as the value of the widget.
- 33. Dojo Tree & Grails GSP <div dojoType="dojo.data.ItemFileReadStore" jsId="treeStore" url="<g:createLink controller="widget" action="treeData" />"> </div> <div dojoType="dijit.Tree" store="treeStore" childrenAttr="children" labelAttr="url"> </div>
- 34. Dojo Tree & Grails Grails Action def treeData = { def items = [] def children = [] (1..3).each { children << [_reference:"${it}"] } def podcasts = Podcast.findAll(); podcasts.each { podcast -> items << [id:podcast.id, url:podcast.feedURL, children:children ] } def json = [ identifier:"id" , label:'url', items: items] render json as JSON }
- 36. Resources Download Dojo, check the test directories for tons of examples Dojo API Tool soon available for 0.9 http://www.dojotoolkit.org/api Converters Plugin http://www.grails.org/Converters+Plugin Dynamic Controller Methods, incl. render() grails.org/Controller+Dynamic+Methods
- 37. Resources JSON Formatter http://www.curiousconcept.com/jsonformatter Blogs blogs blogs Grails Podcast http://hansamann.podspot.de/rss
- 38. THX Y IM/SKYPE hansamann