Step 3: Building the User Interface

At this point, you've created the components of the StockWatcher project and reviewed its functional requirements and UI design. In this section, you'll build the user interface out of GWT widgets and panels.

1. Select the GWT widgets needed to implement the UI elements.
2. Select the GWT panels needed to layout the UI elements.
3. Embed the application in the host page, StockWatcher.html.
4. Implement the widgets and panels in StockWatcher.java.
5. Test the layout in hosted mode.

GWT shields you from worrying too much about cross-browser incompatibilities. If you construct the interface with GWT widgets and composites, your application will work similarly on the most recent versions of Firefox, Internet Explorer, Opera, and Safari. However, DHTML user interfaces remain remarkably quirky; therefore, you still must test your applications thoroughly on every browser.

1. Selecting GWT widgets to implement the UI elements

First, look at the Widget Gallery and select the GWT widget for each UI element.

In the Widget Gallery the widgets have a default style and so they don't look exactly as they will in the final implementation of StockWatcher. Don't worry about that now. First you'll focus on getting the widgets working. Then, in Applying Styles, you'll change their appearance with CSS.

Stock Data Table

GWT provides a special table widget called a FlexTable. The FlexTable widget creates cells on demand. This is just what you need for the table containing the stock data because you don't know how many stocks the user will add. A table implemented with the FlexTable widget will expand or collapse as the user adds or removes stocks.

Buttons

Whenever possible, GWT defers to browsers' native user interface elements. For instance, a Button widget becomes a true HTML <button> rather than a synthetic button-like widget that's built, for example, from a <div>. This means that GWT buttons render appropriately in different browsers and on different client operating systems. The benefit of using native browser controls is that they are fast, accessible, and most familiar to users. Also, they can be styled with CSS.

Input Box

GWT provides several widgets to create fields that users can type in:

• TextBox widget, a single-line text box
• PassWordTextBox widget, a text box that visually masks input
• TextArea widget, a multi-line text box
• SuggestBox, displays a pre-configured set of items

StockWatcher users will type in a stock code which is single line of text; therefore, implement a TextBox widget.

Label

In contrast with the Button widget, the Label widget does not map to the HTML <label> element, used in HTML forms. Instead it maps to a <div> element which contains arbitrary text, not interpreted as HTML. As a <div> element, it is a block-level element rather than an inline element.

<div class="gwt-Label">Last update : Oct 1, 2008 1:31:48 PM</div>

If you're interested in taking a peek at the API reference for the GWT widgets you'll use to build the StockWatcher interface, click on the links in the table below.

In Depth: If you don't find a widget that meets the functional requirements of your application, you can create your own. For details on creating composite widgets or widgets from scratch using Java or JavaScript, see the Developer's Guide, Creating Custom Widgets.

2. Selecting GWT panels to layout the UI elements

Now that you know what widgets you'll use, you'll decide how to lay them out using GWT panels. GWT provides several types of panels to manage the layout. Panels can be nested within other panels. This is analogous to laying out your web page in HTML using nested div elements or tables. For StockWatcher, you'll use a Horizontal panel nested within a Vertical panel.

Horizontal Panel

The two elements used to add a stock—the input box for typing in a new stock symbol and the Add button—are closely related functionally and you want keep them together visually. To lay them out side-by-side, you'll put the TextBox widget and a Button widget in a horizontal panel. In the Java code, you'll create a new instance of HorizontalPanel and name it addPanel.

Vertical Panel

You want to lay out the remaining elements vertically.

• the FlexTable widget: the stock table
• the Add Stock panel: contains the input box and Add button
• the Label widget: the timestamp

You'll do this with a vertical panel. In the Java code, you'll create a new instance of VerticalPanel and name it mainPanel.

Root Panel

There is one more panel you need which is not visible in the user interface: a Root panel. A Root panel is the container for the dynamics elements of your application. It is at the top of any GWT user interface hierarchy. There are two ways you can use a Root panel, either to generate the entire body of the page or to generate specific elements embedded in the body.

The Root panel works by wrapping an element in the HTML host page. By default (that is, if you don't add any placeholders in the host page) the Root panel wraps the body element. However, you can wrap any element if you name it and then, when you call the Root panel, pass the name as a parameter. You'll see how this works in the next two sections when you do it for StockWatcher.

RootPanel.get()             // Default. Wraps the HTML body element.
RootPanel.get("stockList")  // Wraps any HTML element with an id of "stockList"

A host page can contain multiple Root panels. For example, if you're embedding multiple GWT widgets or panels into a host page, each one can be implemented independently of the others, wrapped in its own Root panel.

3. Embedding the application in the host page

To get the StockWatcher application to run in the browser, you need to embed it in an HTML file, the HTML host page. The host page for the StockWatcher project, StockWatcher.html, was generated by webAppCreator. For the starter application, StockWatcher.html had an empty body element. As a result the Root panel wrapped the entire body element. Everything displayed in the browser was dynamic, built with GWT. If your application had no static elements, you wouldn't need to edit the HTML host page at all.

However, for StockWatcher you will use some static HTML text and an image in addition to the dynamic elements. You will embed the GWT application in the browser page using a placeholder, a <div> element named stockList. This implementation strategy is especially useful for embedding GWT into an existing application.

1. Open the host page, StockWatcher/war/StockWatcher.html.
2. In the head element, change the title text to StockWatcher.
3. In the body element, add an <h1> heading, StockWatcher.
4. In the body element, add a <div> element and give it an id of stockList.
5. Delete the unneeded elements from the starter project application.

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<html>
  <head>
    <meta http-equiv="content-type" content="text/html; charset=UTF-8">

    <link type="text/css" rel="stylesheet" href="StockWatcher.css">

    <title>StockWatcher</title>

    <script type="text/javascript" language="javascript" src="stockwatcher/stockwatcher.nocache.js"></script>
  </head>

  <body>

    <h1>StockWatcher</h1>

    <div id="stockList"></div>

    <iframe src="javascript:''" id="__gwt_historyFrame" tabIndex='-1' style="position:absolute;width:0;height:0;border:0"></iframe>

    <h1>Web Application Starter Project</h1>
    <table align="center">
      <tr>
        <td colspan="2" style="font-weight:bold;">Please enter your name:</td>

      </tr>
      <tr>
        <td id="nameFieldContainer"></td>
        <td id="sendButtonContainer"></td>
      </tr>
    </table>
  </body>
</html>

Note: HTML comments have been omitted for brevity.

4. Implementing widgets and panels

Next you will construct the user interface from GWT widgets and panels.

Most of the UI is displayed as soon as StockWatcher starts up. So you'll implement them in the onModuleLoad method. In this section, you will:

1. Instantiate each widget and panel.
2. Create the table that holds the stock data.
3. Lay out the widgets using the Add Stock panel and the Main panel.
4. Associate the Main panel with the Root panel.
5. Move the cursor focus to the input box.

You can follow this section of the tutorial step-by-step, or you can cut and paste the entire block of code from the Summary at the end.

1. Instantiate each widget and panel

1. Instantiate each widget and panel using class field initializers.
   Open StockWatcher/src/com/google/gwt/sample/stockwatcher/client/StockWatcher.java.
   In StockWatcher.java, replace all the existing code for the starter application with the following code.

   package com.google.gwt.sample.stockwatcher.client;
   
   public class StockWatcher implements EntryPoint {
   
     private VerticalPanel mainPanel = new VerticalPanel();
     private FlexTable stocksFlexTable = new FlexTable();
     private HorizontalPanel addPanel = new HorizontalPanel();
     private TextBox newSymbolTextBox = new TextBox();
     private Button addStockButton = new Button("Add");
     private Label lastUpdatedLabel = new Label();
   
     /**
      * Entry point method.
      */
     public void onModuleLoad() {
       // TODO Create table for stock data.
       // TODO Assemble Add Stock panel.
       // TODO Assemble Main panel.
       // TODO Associate the Main panel with the HTML host page.
       // TODO Move cursor focus to the input box.
   
     }
   
   }

2. Eclipse flags the variable definitions because they cannot be resolved to type.
   Tip: One way you can leverage Eclipse is to use its "suggest" feature to add the required import declarations.
3. Include the corresponding import declarations.
   Click on the X to get suggestions.
   Select "import EntryPoint (com.google.gwt.core.client.EntryPoint)" by pressing return.
4. Resolve all the other errors by declaring the import declarations the same way. If you are not using Eclipse, cut and paste from the highlighted code.

   package com.google.gwt.sample.stockwatcher.client;
   
   import com.google.gwt.core.client.EntryPoint;
   import com.google.gwt.user.client.ui.Button;
   import com.google.gwt.user.client.ui.FlexTable;
   import com.google.gwt.user.client.ui.HorizontalPanel;
   import com.google.gwt.user.client.ui.Label;
   import com.google.gwt.user.client.ui.TextBox;
   import com.google.gwt.user.client.ui.VerticalPanel;
   
   public class StockWatcher implements EntryPoint {
   
     private VerticalPanel mainPanel = new VerticalPanel();
     private FlexTable stocksFlexTable = new FlexTable();
     private HorizontalPanel addPanel = new HorizontalPanel();
     private TextBox newSymbolTextBox = new TextBox();
     private Button addStockButton = new Button("Add");
     private Label lastUpdatedLabel = new Label();
   
     /**
      * Entry point method.
      */
     public void onModuleLoad() {
       // TODO Create table for stock data.
       // TODO Assemble Add Stock panel.
       // TODO Assemble Main panel.
       // TODO Associate the Main panel with the HTML host page.
       // TODO Move cursor focus to the input box.
   
     }
   
   }

2. Create a table for stock data

Implement the table that will hold the stock data. Set up the header row that displays when the user launches StockWatcher. To do this, use the setText method to create labels in the heading of each column: Symbol, Price, Change, Remove.

1. Create table for stock data.
   In the onModuleLoad method, replace the TODO comment with the highlighted code.

   package com.google.gwt.sample.stockwatcher.client;
   
   import com.google.gwt.core.client.EntryPoint;
   import com.google.gwt.user.client.ui.Button;
   import com.google.gwt.user.client.ui.FlexTable;
   import com.google.gwt.user.client.ui.HorizontalPanel;
   import com.google.gwt.user.client.ui.Label;
   import com.google.gwt.user.client.ui.TextBox;
   import com.google.gwt.user.client.ui.VerticalPanel;
   
   public class StockWatcher implements EntryPoint {
   
     private VerticalPanel mainPanel = new VerticalPanel();
     private FlexTable stocksFlexTable = new FlexTable();
     private HorizontalPanel addPanel = new HorizontalPanel();
     private TextBox newSymbolTextBox = new TextBox();
     private Button addStockButton = new Button("Add");
     private Label lastUpdatedLabel = new Label();
   
     /**
      * Entry point method.
      */
     public void onModuleLoad() {
       // Create table for stock data.
       stocksFlexTable.setText(0, 0, "Symbol");
       stocksFlexTable.setText(0, 1, "Price");
       stocksFlexTable.setText(0, 2, "Change");
       stocksFlexTable.setText(0, 3, "Remove");
   
       // TODO Assemble Add Stock panel.
       // TODO Assemble Main panel.
       // TODO Associate the Main panel with the HTML host page.
       // TODO Move cursor focus to the input box.
   
     }
   
   }

3. Lay out the widgets

To lay out the widgets, you'll assemble two panels, the Add Stock panel and the Main panel. First assemble the the Add Stock panel, a horizontal panel which wraps the input box and the Add button. Then assemble the Main panel, a vertical panel that specifies the layout of the stock list table, the Add Stock panel, and the timestamp.

1. Lay out the widgets in the Add Stock panel and the Main panel.
   In the onModuleLoad method, replace the TODO comment with the highlighted code.

   package com.google.gwt.sample.stockwatcher.client;
   
   import com.google.gwt.core.client.EntryPoint;
   import com.google.gwt.user.client.ui.Button;
   import com.google.gwt.user.client.ui.FlexTable;
   import com.google.gwt.user.client.ui.HorizontalPanel;
   import com.google.gwt.user.client.ui.Label;
   import com.google.gwt.user.client.ui.TextBox;
   import com.google.gwt.user.client.ui.VerticalPanel;
   
   public class StockWatcher implements EntryPoint {
   
     private VerticalPanel mainPanel = new VerticalPanel();
     private FlexTable stocksFlexTable = new FlexTable();
     private HorizontalPanel addPanel = new HorizontalPanel();
     private TextBox newSymbolTextBox = new TextBox();
     private Button addStockButton = new Button("Add");
     private Label lastUpdatedLabel = new Label();
   
     /**
      * Entry point method.
      */
     public void onModuleLoad() {
       // Create table for stock data.
       stocksFlexTable.setText(0, 0, "Symbol");
       stocksFlexTable.setText(0, 1, "Price");
       stocksFlexTable.setText(0, 2, "Change");
       stocksFlexTable.setText(0, 3, "Remove");
   
       // Assemble Add Stock panel.
       addPanel.add(newSymbolTextBox);
       addPanel.add(addStockButton);
   
       // Assemble Main panel.
       mainPanel.add(stocksFlexTable);
       mainPanel.add(addPanel);
       mainPanel.add(lastUpdatedLabel);
   
       // TODO Associate the Main panel with the HTML host page.
       // TODO Move cursor focus to the input box.
   
     }
   
   }

4. Associate the Main panel with the Root panel

In order for any GWT widget or panel to be embedded in the HTML host page, it must be contained within a Root panel. Associate the Root panel with Vertical panel, mainPanel. The Root panel wraps the HTML element in StockWatcher's host page that has an id of "stocklist". In this case, it is a <div> element.

1. Associate the Main panel with the host page via the Root panel.
   In the onModuleLoad method, replace the TODO comment with the highlighted code.

   package com.google.gwt.sample.stockwatcher.client;
   
   import com.google.gwt.core.client.EntryPoint;
   import com.google.gwt.user.client.ui.Button;
   import com.google.gwt.user.client.ui.FlexTable;
   import com.google.gwt.user.client.ui.HorizontalPanel;
   import com.google.gwt.user.client.ui.Label;
   import com.google.gwt.user.client.ui.TextBox;
   import com.google.gwt.user.client.ui.VerticalPanel;
   
   public class StockWatcher implements EntryPoint {
   
     private VerticalPanel mainPanel = new VerticalPanel();
     private FlexTable stocksFlexTable = new FlexTable();
     private HorizontalPanel addPanel = new HorizontalPanel();
     private TextBox newSymbolTextBox = new TextBox();
     private Button addStockButton = new Button("Add");
     private Label lastUpdatedLabel = new Label();
   
     /**
      * Entry point method.
      */
     public void onModuleLoad() {
       // Create table for stock data.
       stocksFlexTable.setText(0, 0, "Symbol");
       stocksFlexTable.setText(0, 1, "Price");
       stocksFlexTable.setText(0, 2, "Change");
       stocksFlexTable.setText(0, 3, "Remove");
   
       // Assemble Add Stock panel.
       addPanel.add(newSymbolTextBox);
       addPanel.add(addStockButton);
   
       // Assemble Main panel.
       mainPanel.add(stocksFlexTable);
       mainPanel.add(addPanel);
       mainPanel.add(lastUpdatedLabel);
   
       // Associate the Main panel with the HTML host page.
       RootPanel.get("stockList").add(mainPanel);
   
       // TODO Move cursor focus to the input box.
   
     }
   
   }

   Eclipse flags RootPanel and suggest you include the import declaration.
2. Include the import declaration.

   import com.google.gwt.user.client.ui.RootPanel;

5. Move cursor focus to the input box

Finally, move the cursor focus to the input box so, when StockWatcher loads, the user can begin adding stocks.

1. In the onModuleLoad method, replace the TODO comment with the highlighted code.

   package com.google.gwt.sample.stockwatcher.client;
   
   import com.google.gwt.core.client.EntryPoint;
   import com.google.gwt.user.client.ui.Button;
   import com.google.gwt.user.client.ui.FlexTable;
   import com.google.gwt.user.client.ui.HorizontalPanel;
   import com.google.gwt.user.client.ui.Label;
   import com.google.gwt.user.client.ui.RootPanel;
   import com.google.gwt.user.client.ui.TextBox;
   import com.google.gwt.user.client.ui.VerticalPanel;
   
   public class StockWatcher implements EntryPoint {
   
     private VerticalPanel mainPanel = new VerticalPanel();
     private FlexTable stocksFlexTable = new FlexTable();
     private HorizontalPanel addPanel = new HorizontalPanel();
     private TextBox newSymbolTextBox = new TextBox();
     private Button addStockButton = new Button("Add");
     private Label lastUpdatedLabel = new Label();
   
     /**
      * Entry point method.
      */
     public void onModuleLoad() {
       // Create table for stock data.
       stocksFlexTable.setText(0, 0, "Symbol");
       stocksFlexTable.setText(0, 1, "Price");
       stocksFlexTable.setText(0, 2, "Change");
       stocksFlexTable.setText(0, 3, "Remove");
   
       // Assemble Add Stock panel.
       addPanel.add(newSymbolTextBox);
       addPanel.add(addStockButton);
   
       // Assemble Main panel.
       mainPanel.add(stocksFlexTable);
       mainPanel.add(addPanel);
       mainPanel.add(lastUpdatedLabel);
   
       // Associate the Main panel with the HTML host page.
       RootPanel.get("stockList").add(mainPanel);
   
       // Move cursor focus to the input box.
       newSymbolTextBox.setFocus(true);
   
     }
   
   }

Summary

Here's what you've done to this point.

package com.google.gwt.sample.stockwatcher.client;

import com.google.gwt.core.client.EntryPoint;
import com.google.gwt.user.client.ui.Button;
import com.google.gwt.user.client.ui.FlexTable;
import com.google.gwt.user.client.ui.HorizontalPanel;
import com.google.gwt.user.client.ui.Label;
import com.google.gwt.user.client.ui.RootPanel;
import com.google.gwt.user.client.ui.TextBox;
import com.google.gwt.user.client.ui.VerticalPanel;

public class StockWatcher implements EntryPoint {

  private VerticalPanel mainPanel = new VerticalPanel();
  private FlexTable stocksFlexTable = new FlexTable();
  private HorizontalPanel addPanel = new HorizontalPanel();
  private TextBox newSymbolTextBox = new TextBox();
  private Button addStockButton = new Button("Add");
  private Label lastUpdatedLabel = new Label();

  /**
   * Entry point method.
   */
  public void onModuleLoad() {
    // Create table for stock data.
    stocksFlexTable.setText(0, 0, "Symbol");
    stocksFlexTable.setText(0, 1, "Price");
    stocksFlexTable.setText(0, 2, "Change");
    stocksFlexTable.setText(0, 3, "Remove");

    // Assemble Add Stock panel.
    addPanel.add(newSymbolTextBox);
    addPanel.add(addStockButton);

    // Assemble Main panel.
    mainPanel.add(stocksFlexTable);
    mainPanel.add(addPanel);
    mainPanel.add(lastUpdatedLabel);

    // Associate the Main panel with the HTML host page.
    RootPanel.get("stockList").add(mainPanel);

    // Move cursor focus to the input box.
    newSymbolTextBox.setFocus(true);

  }

}

5. Testing the layout

One benefit of using GWT in your AJAX application development is that you can see the effects of your code changes as soon as you refresh the Hosted Mode browser. So that you can see your changes whether you are developing or debugging, in Eclipse, run StockWatcher in debug mode. Then you'll be able to switch between Java and Debug perspectives without having to relaunch StockWatcher.

1. Save the edited files.
   Save StockWatcher.java
2. Launch StockWatcher in hosted mode.
   From the Eclipse menu bar, select Run > Debug
   If you are not using Eclipse, from the command line enter ant hosted
3. The Hosted Mode browser displays your first iteration of the StockWatcher application.
   
   StockWatcher displays the header of the flex table, the input box and the Add button. You haven't set the text for the Label, yet; so, it isn't displayed. You'll do that after you've implemented the stock refresh mechanism.
4. Leave StockWatcher running in hosted mode.
   In the rest of this tutorial, you'll frequently be testing changes in hosted mode.

Refreshing Hosted Mode

You do not always need to relaunch your application in hosted mode after modifying your source code. Instead, just click the Refresh button in the Hosted Mode browser after saving your changes, and hosted mode will automatically recompile your application and open the new version.

Best Practices: You may notice that your changes take effect sometimes even if you do not refresh hosted mode. This behavior is a result of the way hosted mode interacts with the compiled code, but it is not always reliable. Specifically, it happens only when you make minor changes to existing functions. To ensure your changes are included, make it a habit to always refresh the Hosted Mode browser after making changes .

What's Next

At this point you've built the basic UI components of StockWatcher by implementing GWT widgets and panels. The widgets don't respond to any input yet.

Now you're ready to code event handling on the client. You'll wire up the widgets to listen for events and write the code that responds to those events.

Step 4: Managing Events on the Client