Monday, 11 July 2011

Getting Started with SmartGWT

Introduction to SmartGWT

I recently started working with SmartGWT, a framework based on GWT that provides a comprehensive widget library for your application UI as well as assistance for server-side for data management. You can take look at its pretty functionality at the SmartGWT showcase.

 Creating the GWT project

First step is to download the library from the downloads section. The version I will be using for this tutorial is 2.1 (download directly from here). Extract the ZIP file and in the new directory you will find the framework's documentation, some samples, “Hello World” examples and of course the necessary JAR files. Open the JavaDocs in a new browser tab.

Next we create a new “Web Application Project” in Eclipse. Choose the profound name “SmartGWTIntroProject” for the project and the appropriate packaging. Make sure that the “Use Google Web Toolkt” checkbox is checked (Google's App Engine is not needed, so do not select that). The wizard will look something like this:



Adding the SmartGWT library

After the project skeleton is created, browse through your filesystem to the project's location and create a new folder named “lib”. Copy the “smartgwt.jar” file from the extracted ZIP to the newly created folder and refresh the project in Eclipse, so that the new file appears there. Then configure your project's classpath to include the JAR file (Project → Properties → Java Build Path → Add JARs...). Standard stuff so far. The expanded project in Eclipse should look like this:



Then edit the module xml file (named “SmartGWTIntroProject.gwt.xml”) and add the following line after the standard “inherits” declarations:

1<inherits name="com.smartgwt.SmartGwt"/>

The module xml file will be:


01<?xml version="1.0" encoding="UTF-8"?>
02<module rename-to='smartgwtintroproject'>
03<!-- Inherit the core Web Toolkit stuff.                        -->
04<inherits name='com.google.gwt.user.User'/>
05 
06<!-- Inherit the default GWT style sheet.  You can change       -->
07<!-- the theme of your GWT application by uncommenting          -->
08<!-- any one of the following lines.                            -->
09<!-- <inherits name='com.google.gwt.user.theme.standard.Standard'/> -->
10<!-- <inherits name='com.google.gwt.user.theme.chrome.Chrome'/> -->
11<!-- <inherits name='com.google.gwt.user.theme.dark.Dark'/>     -->
12 
13<!-- Other module inherits                                      -->
14 
15<inherits name="com.smartgwt.SmartGwt"/>
16 
17<!-- Specify the app entry point class.                         -->
18<entry-point class='com.javacodegeeks.smartgwt.client.client.SmartGWTIntroProject'/>
19 
20<!-- Specify the paths for translatable code                    -->
21<source path='client'/>
22<source path='shared'/>
23 
24</module>

This allows GWT to know that your application will be using the SmartGWT library.

UPDATE: The 'com.google.gwt.user.theme.standard.Standard' declaration should be removed or commented out like above, since it conflicts with certain SmartGWT styles.

After this, locate the main HTML inside the “war” folder. Edit that and add the following line before the compiled module declaration :

view sourceprint?
1<script>var isomorphicDir="smartgwtintroproject/sc/";</script>

UPDATE: From version 2.2, there is no longer need to define the isomorpihcDir value. Check the Release Notes for Smart GWT 2.2. However, for this tutorial (version 2.1 used) the declaration is needed.

In the same file, scroll down and find the following lines:

view sourceprint?
1<td id="nameFieldContainer"></td>
2<td id="sendButtonContainer"></td>

Replace those with the following:

1<td id="formContainer"></td>
2<td id="buttonContainer"></td>

Those are the HTML elements that will hold the text item and the button that we will add later.

The full HTML file follows:

01<!doctype html>
02<!-- The DOCTYPE declaration above will set the    -->
03<!-- browser's rendering engine into               -->
04<!-- "Standards Mode". Replacing this declaration  -->
05<!-- with a "Quirks Mode" doctype may lead to some -->
06<!-- differences in layout.                        -->
07 
08<html>
09<head>
10<meta http-equiv="content-type" content="text/html; charset=UTF-8">
11 
12<!--                                                               -->
13<!-- Consider inlining CSS to reduce the number of requested files -->
14<!--                                                               -->
15<link type="text/css" rel="stylesheet" href="SmartGWTIntroProject.css">
16 
17<!--                                           -->
18<!-- Any title is fine                         -->
19<!--                                           -->
20<title>Web Application Starter Project</title>
21 
22<!--                                           -->
23<!-- This script loads your compiled module.   -->
24<!-- If you add any GWT meta tags, they must   -->
25<!-- be added before this line.                -->
26<!--                                           -->
27<script>var isomorphicDir="smartgwtintroproject/sc/";</script> //add this line in own project
28<script type="text/javascript" language="javascript" src="smartgwtintroproject/smartgwtintroproject.nocache.js"></script>
29</head>
30 
31<!--                                           -->
32<!-- The body can have arbitrary html, or      -->
33<!-- you can leave the body empty if you want  -->
34<!-- to create a completely dynamic UI.        -->
35<!--                                           -->
36<body>
37 
38<!-- OPTIONAL: include this if you want history support -->
39<iframe src="javascript:''" id="__gwt_historyFrame" tabIndex='-1' style="position:absolute;width:0;height:0;border:0"></iframe>
40 
41<!-- RECOMMENDED if your web app will not function without JavaScript enabled -->
42<noscript>
43<div style="width: 22em; position: absolute; left: 50%; margin-left: -11em; color: red; background-color: white; border: 1px solid red; padding: 4px; font-family: sans-serif">
44 
45Your web browser must have JavaScript enabled
46in order for this application to display correctly.
47</div>
48 
49</noscript>
50 
51<h1>
52Web Application Starter Project</h1>
53 
54<table align="center">
55<tr>
56<td colspan="2" style="font-weight:bold;">Please enter your name:</td>       
57</tr>
58 
59<tr>
60<td id="formContainer"></td>
61<td id="buttonContainer"></td>
62</tr>
63 
64<tr>
65<td colspan="2" style="color:red;" id="errorLabelContainer"></td>
66</tr>
67 
68</table>
69 
70</body>
71</html> Creating the application entrypoint

When a GWT is created via Eclipse, a lot of auto-generated files are created. One of those is the main Java file in the “client” package, which works as the application's entrypoint. So, remove the generated code and add the following:

01package com.javacodegeeks.smartgwt.client.client;
02 
03import com.google.gwt.core.client.EntryPoint;
04import com.google.gwt.user.client.ui.RootPanel;
05import com.smartgwt.client.util.SC;
06import com.smartgwt.client.widgets.IButton;
07import com.smartgwt.client.widgets.events.ClickEvent;
08import com.smartgwt.client.widgets.events.ClickHandler;
09import com.smartgwt.client.widgets.form.DynamicForm;
10import com.smartgwt.client.widgets.form.fields.TextItem;
11 
12public class SmartGWTIntroProject implements EntryPoint {
13     
14    public void onModuleLoad() {
15         
16        final DynamicForm form = new DynamicForm();
17        final TextItem textItem = new TextItem();
18        textItem.setTitle("Name");
19        form.setFields(textItem);
20        final IButton button = new IButton("Hello");
21         
22        button.addClickHandler(new ClickHandler() {
23            public void onClick(ClickEvent event) {
24                String name = textItem.getValue().toString();
25                SC.say("Hello " + name);
26            }
27        });
28         
29        RootPanel.get("formContainer").add(form);
30        RootPanel.get("buttonContainer").add(button);
31         
32    }
33 
34}

Make sure that the imported packages are as shown above, because SmartGWT uses classes with names same with those of the core GWT framework.

Launching the application
Next, we are ready to launch our application. Choose Run → Run As → Web Application and use your favourite browser to access the provided URL:

http://127.0.0.1:8888/SmartGWTIntroProject.html?gwt.codesvr=127.0.0.1:9997

You should be able to see the following:



That's it. Now you are ready to create some cool applications, powered by SmartGWT.  
Posted by at

1 comment:

  1. Unknown28 September 2013 at 20:57

    Hello, I have a doubt, at the subject "Creating a GWT project", when you say
    " and the appropriate packaging", what exactly have I to put there?.
    Which is the appropriate packaging?
    Thanks

    ReplyDelete

Subscribe to: Post Comments (Atom)