Jump to: navigation, search

EDT:Tutorial: RUI With DataBase Lesson 4

Revision as of 16:10, 12 December 2011 by Hoffmanp.us.ibm.com (Talk | contribs)

Access a database with EGL Rich UI


< Previous | Next >

Lesson 4: Create the Rich UI handler

Start to build the handler by using EGL wizards and then the Rich UI editor.

You can add widgets to a web page by dragging content to the Design surface of the Rich UI editor. The drag-and-drop and subsequent interaction with the editor updates the source code for the Rich UI handler that you are developing.

Two sources of drag-and-drop content are available:

  • A palette of widget types
  • The EGL Data view, which provides data-type definitions such as EGL Record types. You first drag content from this view and then choose from among the widget types that can display the type of data you selected.


By default, the widget palette is at the right of the editor, and the Data view is at the lower left of the workbench.

In this lesson, you create a Rich UI Handler and add a data grid to display all rows in the database. Later, you will add a grid layout to display the fields in a selected record.

Create the initial layout

To create the handler:

  1. In the PaymentClient project, select the EGLSource folder and click New > Handler.
  2. In the New Rich UI Handler window, enter the following information:
    1. In the EGL source file name field, enter the following name: PaymentFileMaintenance
    2. In the Package field, enter the following name: handlers
    3. Select the Rich UI Handler template
    4. Click Finish.
      New EGL Handler

The new Handler opens in Design view in the Rich UI editor. EGL creates the handlers package for you in the EGLSource folder.The Rich UI editor opens in Design view by default and shows a palette of widgets on the right.

EGL automatically created a grid layout as your initial UI. By default, this widget has four rows and three columns. Compare this layout with the sketch in lesson 1, which uses only four cells.

  1. To reduce the size of the layout, click into it and go to the Properties view, which by default is one of several tabbed pages below the editor pane. On the General page, set the rows property to 2 and the columns property to 2, and then click the Design surface. The Rich UI editor opens in Design view by default and shows a palette of widgets on the right. A later step demonstrates a different way to change the number of rows and columns in a grid layout. The main layout of this Rich UI handler now has a first row, where the handler will display two sets of buttons, and a second row, where the handler will display the following content:  on the left, a list of records, and on the right, a layout for displaying the details of one record.

Create a data grid to hold a set of database rows

Create a data grid by dragging a record array variable onto the Rich UI editor.

To create the data grid:

  1. Create a record array variable.
    1. Click on Window > Show View and select EGL > EGL Data to bring up the EGL Data view. The EGL Data view, which is located by default in the lower left corner of the workbench, lists all of the primitive and record variables for the handler that is currently open in the editor. Right-click the empty space below the entry for the PaymentFileMaintenance file. Click New > EGL Variable. The EGL Data view
    2. In the New EGL Rich UI Data Fields wizard, request a new record variable based on the paymentRec record:
      • Make sure Type Selection is set to Record.
      • Select the paymentRec record. This record should be the only one in the list.
      • In the Array Properties section, select the Array check box. Leave the Size field blank.
      • For Enter the name of the field, enter the following name: allPayments
      • Click Finish.
        The New EGL Rich UI Data Fields wizard

This process creates the following record declaration in the source code for the handler:

  allPayments paymentRec[]; 

In the EGL Data view is now a record variable that you can drag the variable onto the editor.The EGL Data view shows the inputRec variable.

  1. Drag the allPayments record variable from the EGL Data view to the lower left cell of the layout. Dragging a record from the Data view to the layout widget.
    EGL displays the Configure data widgets page of the Insert Data wizard. Use this page to configure the widgets that EGL creates. The widget types depend on the type of fields in the record array that you dragged onto the Design surface.
  2. Make the following changes in the Insert Data wizard:
    1. Under Create Widgets for, leave the default value of Read-only data.
    2. The check boxes under the allPayments variable indicate the fields that are to be used as columns in the display. Clear all the fields by clicking None.
    3. Check the following fields:
      • category
      • description
      • amount
    4. Change the labels for those fields:
      • Change category to Type.
      • Change description to Description.
      • Change amount to Amount due.

The wizard uses these labels as column headers for the grid.

    1. Clear Add support for formatting and validation. Here are the completed settings:The completed Configure data widgets wizard
    2. Click Finish. The empty grid is displayed:
      The empty grid has a header with three columns.
  1. Click into the Properties view:
    1. Ensure that the following title is displayed: DataGrid (allPayments_ui). If not, click into the data grid, ensure that the title is displayed, and click back to the Properties view.
    2. On the General page, change the selectionMode property to SINGLE. This property indicates that the user can select only one row of the grid at a time.
    3. On the Layout page, change the verticalAlignment property to TOP.
      DataGrid Layout properties page
      This property ensures that the allPayments_ui data grid will line up with the detail grid you will add later.
  2. Click the Source tab at the bottom of the editor to see the code that you already created.

Take this opportunity to reduce the width of two columns in the data grid. Specifically, consider the DataGridColumn declarations for the category and amount columns and change the width property from the default 120 pixels to 90 pixels. Here is the data grid declaration after your change:

   allPayments_ui DataGrid {
      layoutData = new GridLayoutData
         { row = 2, column = 1,
             verticalAlignment = GridLayoutLib.VALIGN_TOP},
             columns =[
                new DataGridColumn{name = "category", 
                    displayName = "Type", 
                    width = 90},
                new DataGridColumn{name = "description", 
                    displayName = "Description", 
                    width = 120},
                new DataGridColumn{name = "amount", 
                    displayName = "Amount due", 
                    width = 90}
              ],
              data = allPayments as any[],
              selectionMode = DataGridLib.SINGLE_SELECTION 
          };


Add prototype data in the start function, which is referenced in the onConstructionFunction property of the handler and which runs before the user first accesses the web page. Specifically, assign an array of records to the data property of the data grid:

  function start()
      allPayments_ui.data = 
        [
           new paymentRec{category = 1, description = "test01", amount = 100.00},
           new paymentRec{category = 2, description = "test02", amount = 200.00},
            new paymentRec{category = 3, description = "test03", amount = 300.00}
        ];
  end


Now to preview the file,

  1. To format the file, click Ctrl-Shift-F.
  2. Click the Preview tab.
    Web page with prototype data
  3. Save the file.

Add the first set of buttons

To create the Add, Delete, and Sample buttons on the Design surface:

  1. Click the Design tab.
  2. In the Palette view, go to the Layout drawer and find the GridLayout widget type. Drag a new grid layout to the upper left corner of the main layout. Assign the following name to the new widget: buttonLayout The new grid layout within the handler
  3. Click into the new layout, right click a cell, and notice that you can insert or delete content from the menu.
  4. Click Delete > Row.
  5. Click again into the new layout, right click a cell, and click Delete > Row. A single row remains, with three columns.
  6. Create the Add button:
    1. In the Palette view, go to the Display and Input drawer and then to Button (Dojo). Drag a Dojo Button widget to the leftmost cell of buttonLayout. Dragging a button onto the new GridLayout widget
    2. Assign the following name to the button: addButton
    3. Go to the Properties view:
      • On the General page, change the text property to Add.
      • On the Events page, select the row for the onClick event. A plus sign (+) is displayed at the far right of the line. Click the plus sign and specify the following name for a function that will be invoked when the user clicks the Add button: addRow

The Source view opens to display the addRow function. Rather than complete the function now, finish laying out this section of the web page. Click the Design tab to return to the Design surface.

  1. Create the Delete button:
    1. In the Palette view, go to the Display and Input drawer and then to Button (Dojo). Drag a Dojo Button widget to the middle cell of buttonLayout.
    2. Assign the following name to the button: deleteButton
    3. Go the Properties view for the button:
      • On the General page, change the text property to Delete.
      • On the Events page, assign the following function name to the onClick event: deleteRow
    4. When the deleteRow function is displayed, click the Design tab.
  2. Using the same process as in previous steps, create a Dojo button in the rightmost cell of buttonLayout. Name the button sampleButton, change the text property to Sample, and use the following name for the onClick function: sampleData. The sampleData function is displayed.
  3. Inspect the source code, noting the code that was provided for each of the buttons.
  4. Click the Preview tab. Web page with buttons and prototype data
  5. Save the file.

Add a variable and layout to handle a single row

You previously created an array to hold the database rows. You now declare a variable for a single row and then drag that variable onto the Design surface to create a layout for displaying the row.

To create the variable:

  1. Click the Design tab to display the Design surface.
  2. Right-click the background of the EGL Data view, which is likely to be at the bottom left of the workbench. Click New > Variable.
  3. In the Create a new EGL Data Variable wizard, request a new record variable based on the paymentRec record:
    1. Make sure that Type Selection is set to Record.
    2. Select the paymentRec record.
    3. In the Array Properties section, make sure that the Array check box is cleared.
    4. For Enter the name of the field, enter the following name: selectedPayment The new variable wizard
    5. Click Finish.

As noted in the Preview section of the page shown, the following record declaration is created in the source code for the handler:

selectedPayment paymentRec;

To create the grid layout:

  1. In the Palette view, go to the Layout drawer and find the TitlePane (Dojo) widget type. Drag a new title pane to the lower right cell of the main grid layout, next to the cell that holds the allPayments_ui grid. The TitlePane widget drops in the last cell.
  2. Assign the following name to the title pane: editPane Click OK.
  3. Make the following changes to the properties for the editPane widget:
    • On the General page, change the title property to Payment record
    • On the Position page, change the width property to 350. This value leaves room for error messages.
    • On the Layout page, change the verticalAlignment property to TOP.

The web page should now look like the following image:The web page with the payment record pane

  1. Save the file.
  2. From the EGL Data view, drag the selectedPayment variable to the bracketed area inside the payment record pane. The bracketed area inside the pane. The Configure data widgets wizard is displayed.
  3. Make the following changes:
    1. Under Create Widgets for, select Editable data.
    2. Make sure that the Widget Type for the selectedPayment record is GridLayout.
    3. Change the Label fields as shown in the following table. These labels are used to identify the fields in the display:
Table 1. Revised names for selectedPayment fields
Default name Revised name
paymentID Key:
category Category:
description Description:
amount Amount:
fixedPayment Fixed pmt:
dueDate Due date:
payeeName Payee:
payeeAddress1 Address 1:
payeeAddress2 Address 2:

You must specify colons explicitly, as they are not added automatically to labels.

    1. For the category field, in the Widget Type column, click DojoTextField. A down arrow is displayed. Click the arrow, and then click DojoComboBox.
    2. For the amount field, in the Widget Type column, click DojoTextField. A down arrow is displayed. Click the arrow, and then click DojoCurrencyTextBox. This widget provides some basic formatting for currency.
    3. Ensure that Add support for formatting and validationis checked. The selection creates a Form Manager, which uses the EGL Rich UI Model-View-Controller (MVC) framework to manage Rich UI validation and formatting. Here are the settings: The Configure data widgets wizard with the correct values.
    4. Click Finish.

The new grid layout contains a form.
The new selectedPayment grid has a row for each field in the record.

Note: You might need to click the Refresh button in the upper right corner of the Rich UI editor to see this change:
The refresh button shows two yellow arrows.

  1. Make the Key field read-only:
    1. Repeatedly click the Dojo text field next to the Key label until only that field is surrounded by a dotted line.
      The Category field is highlighted.
    2. In the Properties view, General page, select the readOnly check box. The readOnly check box
  2. For a more uniform appearance, do as follows:
    1. Click the DojoCurrencyTextBox widget for Amount until only that widget is surrounded by a dotted line.
    2. On the Position page of the Properties view, set the width property to 166.

Add the second set of buttons

To add the Clear and Save buttons:

  1. In the Palette view, go to the Layout drawer and find the GridLayout widget type. Drag a new grid layout to the upper right corner of the main layout and assign the following name: detailButtonLayout Dragging a grid layout to the top-right corner of the web page
  2. With the new layout selected, update the number of rows and columns in whichever way you prefer: in the Properties view, or by deleting the rows and columns, or by changing the source code. In any case, ensure that the layout has 1 row and 2 columns.
  3. At the Design surface, create the Clear button:
    1. In the Palette view, go to the Display and Input drawer and then to Button (Dojo). Drag a Dojo button to the first cell of the new layout.
    2. Using the same process as was used earlier, name the button clearButton, change the text property to Clear, and use the following name for the onClick function: clearAllFields. The clearAllFields function is displayed.
  4. Create the Save button:
    1. Click the Design tab.
    2. In the Palette view, go to the Display and Input drawer and then to Button (Dojo). Drag a Dojo button to the second cell of the new layout.
    3. Name the button saveButton and change the text property to Save.
    4. On the Events page, select the onClick event and click the down arrow in the second column to display the available function names. Click selectedPayment_form_Submit, which is a function that EGL created automatically when you dragged the selectedPayment record variable onto the user interface.
    5. Click the Preview tab.
      Web page with five buttons, prototype data, and a form
    6. Save the file, which should match the finished code in Code for PaymentFileMaintenance.egl after lesson 4

Related reference

  • Help topic: Overview of EGL Rich UI
  • Help topic: Rich UI DataGrid and DataGridTooltip
  • Help topic: Rich UI GridLayout
  • Help topic: Rich UI validation and formatting
  • Help topic: Form processing with Rich UI

Lesson checkpoint

In this lesson, you completed the following tasks:

  • Created a Rich UI handler.
  • Created variables in the EGL Data view.
  • Created a data grid by dragging a record array variable onto the editor.
  • Adjusted widgets in the Properties view and by using a menu.
  • Worked in all three tabs of the Rich UI editor, updating the source and previewing the web page.

In the next lesson, you create the service that will access the database.

< Previous | Next >