HTML5 Zone is brought to you in partnership with:

Over 15 years in the industry, built plumbing on early application servers and then started building enterprise applications. I used to read and write Smalltalk before getting into Java. Since Java I've not looked back or into anything else. I also manage projects and teams working on them. Basically I am a technologist... Harsh has posted 1 posts at DZone. You can read more from them at their website. View Full User Profile

Control a Web Page Look and Feel Flow/Logic with JSON

12.13.2013
| 7111 views |
  • submit to reddit

Many a times I've had to create a UI that has a logical flow e.g. show section-1 if option-1 is selected, show section-2 if option-2 is selected. This logic could be complex based on dynamic content including AJAX. For such scenarios JSON can prove a very useful tool.

Static Data - If the data being used to make these decision loops is available at the time of page creation, this logic can be wired in through simple JavaScript

var whatif = document.getElementById("Option").value;
if (whatif == 'option-1') {
  document.getElementById("Section-1").style.display='table';
} else {
  document.getElementById("Section-1").style.display='none';
}

Dynamic Data (JSP) - What about dynamic data? JSP pages are generated on the fly with data refreshed from the database... the JavaScript can work if it is working on the data fetched at the time the page is generated. Another class of applications using dynamic data are AJAX based calls... 

Dynamic Data (using DoJo) - The most popular approach with DoJo, and the one I am referring to here, uses DoJo to replace the innerHTML of a HTML element.

dojo.byId(idname).innerHTML='Loading....';
 var ajaxArgs = {
  url: urlstrdojo+"&getBy="+getBy,
  error: function(type, data, evt){ .. },
  load: function(type, data, evt){
   dojo.byId(idname).innerHTML=data;
  },
  mimetype: "text/plain", preventCache: true
 }; 
dojo.io.bind(ajaxArgs);

Scenario - In a typical MVC application, the DoJo could be called to render a part of the web page. The resulting JSP returned by the action class would have an HTML which will replace a screen element/tag e.g. a Div. What about a case where you want to want to act on the data that was put in this element?

  1.  Page.onLoad does not work since we're using DoJo
  2.  We could force a script to run but that again is clumsy
Example - The user selects a hyperlink on the screen. The hyperlink has a DoJo call to fetch some data. Then based on the data fetched, the user should be alerted or warned and some fields pre-populated. If you return a JSP with HTML in DoJo, you can update a table, but not get more fine grained than that - elegantly!

Using JSON - I think this is where JSON comes to the rescue. The DoJo call can return a JSON object which can be parsed very elegantly..

In your JSP 
<%
   response.setContentType("application/json");
   response.setHeader("Content-Disposition", "inline");
%>

{"option1":"<%=Var1%>", "option2":"<%=Var2%>", "aError":"<%=errorStr%>", 
 "aWarn":"<%=warnStr%>"}

In your DoJo script
load: function(type, data, evt){
 var jsonData = JSON.parse(data);
 var aError = jsonData.aError;
 var aWarn = jsonData.aWarn;
   
 // Return on Error etc
 if (aError != '' ) { alert (ERROR); return; }
   
 // Else other processing
}
Note that JSON can be included through JSON or DoJo libraries.

Conclusion
Having the JSON data allows trapping an error/warning and branching in script as required. One can return finer data and update a part of DOM also.

Published at DZone with permission of its author, Harsh Khanna.

(Note: Opinions expressed in this article and its replies are the opinions of their respective authors and not those of DZone, Inc.)