Developing the User Interface

#### Search Results

Search

# Developing the User Interface

In the First Steps tutorial, you have developed a small rich internet program step by step. In this tutorial, you have already performed most of the steps required to develop a rich internet application.

The general procedure to develop a rich internet application with Natural for Ajax is as follows:

1. Use Application Designer to design the web pages that form the user interface of your application.

2. Generate a Natural adapter for each page (by saving the page). The adapter is a Natural object that forms the interface between the application code and the web page.

3. Use Natural Studio to write the Natural application programs that contain the business logic and use adapters to exchange data with the web pages.

In this document, the first two steps (design and adapter) are explained in more detail. Step 3 (business logic) is described in the section Developing the Application Code which also addresses advanced topics that are not covered in the tutorial.

This document covers the following topics:

- Starting the Development Workplace

- Creating an Application Designer Project

- Creating a Natural Page

- Specifying Properties for the Natural Page

- Designing the Page

- Binding Properties and Methods

- Previewing the Layout

- Viewing the Protocol

- Saving the Layout

- Generating the Adapter

- Data Type Mapping

- Configuration of Page Layout Errors/Warnings

For detailed information on how to use the Application Designer development workplace, see Development Workplace in the Application Designer documentation. The latest version of the Application Designer documentation is available at https://documentation.softwareag.com/webmethods/application_designer.htm (Empower login required). The information which is provided below describes the most important differences which pertain to Natural for Ajax.

## Starting the Development Workplace

The Application Designer development workplace is the central point for starting tools for layout development.

To start the development workplace

1. Make sure that your application server is running.

2. Invoke your browser and enter the following URL:

       http://<host>:<port>/cisnatural/HTMLBasedGUI/workplace/ide.html

   where <host> is the name of the machine on which your application server is installed and <port> is the port number of your application server.

   Note
   If you have not defined another port number during installation, the default port number is "8080".

## Creating an Application Designer Project

First you create an Application Designer project using the Project Manager. The project contains the layouts of the web pages you design, the files that are generated from the layouts and are required to run your application and additional files that make your application multi language capable and supply help information. See also Creating a Project in the tutorial.

All files in your Application Designer project are stored in one directory on the application server where Natural for Ajax is installed. The name of the directory corresponds to the project name you have chosen. The location of the directory depends on the application server.

## Creating a Natural Page

In order to create the layout of your web pages, you use Application Designer's Layout Painter.

Add a page layout to your project as described in Creating a New Layout in the tutorial (select the template for the Natural page).

Note
More detailed information on creating a layout is provided in the Application Designer documentation at https://documentation.softwareag.com/webmethods/application_designer.htm (Empower login required).

## Specifying Properties for the Natural Page

In order to specify generation options for the new page, you specify values for certain properties that are specific for Natural pages.

To define properties, you select the node natpage in the layout tree of the Layout Painter. The properties for this control are then shown in the properties area at the bottom. When you select the Natural tab in the properties area, you can see the Natural-specific properties.

For information on the properties that are available for a Natural page, see NATPAGE.

## Designing the Page

Design your Natural page by dragging controls and containers from the controls palette onto the corresponding node in the layout tree or to the HTML preview. This has already been explained in the section Writing the GUI Layout of the tutorial.

Note
More detailed information on defining the layout is provided in the Application Designer documentation at https://documentation.softwareag.com/webmethods/application_designer.htm (Empower login required).

## Binding Properties and Methods

Many of the controls you use on your page have properties that can be controlled by the application. Also the controls can raise events that your application may wish to handle. The next step is therefore assigning identifiers to each of these properties and events under which your application can later address them. This procedure is called "binding".

To get an overview which properties and events are bindable to application variables and events, select a control in the layout tree and open the Event Editor as described in the Application Designer documentation at https://documentation.softwareag.com/webmethods/application_designer.htm (Empower login required).

The Event Editor displays only those properties of controls that can be bound to application variables and events. It indicates also which properties are mandatory and must be bound. The usage and meaning of the properties and events is described for each control in Natural Pages Development,

As an example for property and event binding, see the following sections in the First Steps tutorial:

- Using the Property Editor

- Specifying a Name and Method for the Button

## Previewing the Layout

To find out how the current layout definitions are rendered on the page, preview the layout as described in the Application Designer documentation at https://documentation.softwareag.com/webmethods/application_designer.htm (Empower login required).

## Viewing the Protocol

The protocol contains warnings and error messages that might occur while you design and preview your page. For further information, see the Application Designer documentation at https://documentation.softwareag.com/webmethods/application_designer.htm (Empower login required).

## Saving the Layout

Save the page layout as described in Saving Your Layout in the tutorial.

Other than with Java adapters (which are described in the Application Designer documentation), you do not use the Code Assistant (which is part of the Layout Painter) to generate adapter code interactively. For Natural pages the adapter code is generated completely from the page properties and the property and event bindings that you specified previously. An adapter is generated automatically when you save the layout for the first time. It is updated each time you save the layout.

## Generating the Adapter

When you save the layout, a Natural adapter is generated according to the following rules:

Location | The adapter is generated into the subdirectory nat of your project directory. The name of the project directory corresponds to the project name. The location of the directory depends on the application server. See Creating an Application Designer Project.
Name | The name of the adapter is determined by the properties you have set. See Specifying Properties for the Natural Page.
Property identifiers | For each control property that has been bound to an identifier (as described in Binding Properties and Methods) a parameter in the parameter data area of the adapter is generated. The identifier is therefore validated against the Natural naming conventions for user-defined variables and translated to upper-case. If an identifier does not comply to these rules, a warning is generated into the protocol and as a comment into the adapter code. Additionally, the name must comply to the naming conventions for XML entities. This means especially that the name must start with a character. To achieve uniqueness within 32 characters, the last four characters are (if necessary) replaced by an underscore, followed by a three-digit number.
Event identifiers | For each event that can be raised by a control on the page, an event handler skeleton is generated as a comment into the adapter. Caution Some controls raise events whose names are dynamically constructed at runtime. For these events, no handler skeleton can be generated. The control reference contains information about these additional events. The event identifiers are not validated.

When you specify a value for the property natdataarea, then also a Natural Parameter Data Area (PDA) is generated.

## Data Type Mapping

Several Application Designer controls have properties for which a data type can be specified. An example is the FIELD control. It has a `valueprop` property which can be restricted to a certain data type. The data type is used at runtime to validate user input. At generation time (that is, when a Natural adapter is generated for the page), the data type determines the Natural data format of the corresponding adapter parameter.

The following table lists the data types used in Application Designer and the corresponding Natural data formats.

Application Designer | Natural
--- | ---
`color` | `A` or `U` (depending on the NATPAGE property `natsinglebyte`). The string must contain an RGB value, for instance "#FF0000" for the color red.
`date` | `D (YYYYMMDD)`
`float` | `F4`
`int` | `I4`
`long` | `P19`
`time` | `T (HHIISS)`
`timestamp` | `T (YYYYMMDDHHIISST)`
`N n.n` | `Nn.n`
`P n.n` | `Pn.n`
`string` (default) | `A` or `U` dynamic (depending on the NATPAGE property `natsinglebyte`).
`string n` | `An` or `Un` (depending on the NATPAGE property `natsinglebyte`).
`xs:double` | `F8`
`xs:byte` | `I1`
`xs:short` | `I2`

## Configuration of Page Layout Errors/Warnings

The layout protocol contains the information whether a page layout contains errors or warnings. What is considered as error or warning can be configured. An invalid XML file or an XML file from which valid HTML cannot be generated is always treated as an error.

Depending on the problem it often depends on the browser or even the browser version whether the rendering is still as intended or not. The following default settings are a recommendation. In case these settings are lowered, it may happen that in some browser versions the rendering is not as intended.

To provide a better overview, the recommended settings are grouped by the type of problem that is protocoled. The following problems can be configured:

- Problem Group: Valid Value of Properties

- Problem Group: Data and Event Binding

- Problem Group: Height and Width Properties

- Problem Group: Obligatory and Recommended Properties and Controls

- Problem Group: Container - Control Hierarchy

- Problem Group: Property Combination

- Problem Group: Deprecated Controls and Properties

- Problem Group: FOP Layout Definitions

- Problem Group: Runtime Behavior

### Problem Group: Valid Value of Properties

Setting | Explanation
--- | ---
Invalid or missing integer value | The specified value is not a valid integer value.
Invalid edit mask value | The specified edit mask is invalid.
Invalid usage of timestamp type | Datatype timestamp is not supported for all property combinations.
Invalid comma separated list | The property value must be a valid comma separated list.
Invalid hot key value | The specified hotkey is not valid.
Invalid property value | The specified value is not a valid value for this property.

### Problem Group: Data and Event Binding

Setting | Explanation | Sample
--- | --- | ---
Missing obligatory data or event property | A valueprop, method or other mandatory data property is missing. The impact is that no Natural fields are generated in the adapter. | VALUEPROP in FIELD control missing.
Missing recommended data property | A recommended data property is missing. This can have major impacts on the control at runtime. | -/-
Possible unintended usage of default event | When a method is not specified, in many cases a default event will be triggered at runtime. It might be the intended event or not. | FLUSHMETHOD in FIELD control missing.

### Problem Group: Height and Width Properties

Setting | Explanation
--- | ---
Missing HEIGHT, WIDTH or LENGTH properties | HEIGHT, WIDTH or LENGTH property is obligatory for proper rendering.
Missing recommended HEIGHT, WIDTH or LENGTH properties | HEIGHT, WIDTH or LENGTH property is recommended for proper rendering. Missing values might have impacts on the rendering.
Missing ROWCOUNT in GRIDS | ROWCOUNT is missing in a grid control. This usually has major impacts on the sizing of the grids.
Recommended TAKEFULLWIDTH or TAKEFULLHEIGHT missing | Depending on specific property combinations or nesting of controls, the specification of TAKEFULLWIDTH or TAKEFULLHEIGHT is recommended.

### Problem Group: Obligatory and Recommended Properties and Controls

Setting | Explanation | Sample
--- | --- | ---
Missing obligatory property | An obligatory property is missing. | HELPICON control: property HELPID missing.
Missing recommended control definition | Sometimes the proper rendering of a control requires the specification of another control. | HSPLIT control: 2 SPLITCELL controls required.
Missing recommended property | A recommended property is missing. This might have major rendering impacts. | COLAREA: no NAME, TEXTID or VALUEPROP specified.

### Problem Group: Container - Control Hierarchy

Setting | Explanation
--- | ---
Invalid sub node | A control or container has been specified as sub node of another control or controller. But this hierarchy is not supported. This problem can only happen if you are not using Layout Painter as editor.

### Problem Group: Property Combination

Setting | Explanation | Sample
--- | --- | ---
Duplicated definition - design time and runtime | Some properties are supported as design time properties and as runtime properties. But specifying the same property as runtime and as design time property leads to undefined rendering. | AREA controls: NAME and TEXTID are set.
Invalid property combination | The specified combination of properties is not supported. | FIELD control: POPUPPROP is set, but POPUPMETHOD is not set.
Incomplete property combination | Sometimes a property is only supported if also other properties are specified: Supply either all or none. | TEXTGRID* controls: WITHGRIDCOLHEADER is specified, but PROPREFSPROP is not.

### Problem Group: Deprecated Controls and Properties

Setting | Explanation | Sample
--- | --- | ---
Deprecated properties | A deprecated property has been specified. One impact might be that it is simply ignored in the currently supported browsers. | PAGEHEIGHTMINUS in ROWTABSUBPAGES.
Deprecated controls | A deprecated control has been specified. One impact might be that the corresponding HTML is not supported in all browsers or no longer supported in the current browsers at all. | ACTIVEX control.

### Problem Group: FOP Layout Definitions

Setting | Explanation
--- | ---
Missing obligatory properties | An obligatory property in the FOP controls is missing. May have impacts on the *.pdf generation.
Invalid property value | Invalid property value in FOP controls.

### Problem Group: Runtime Behavior

Setting | Explanation | Example
--- | --- | ---
Possibly reduced performance | All single controls may be specified correctly and still the layout might cause performance issues. | Layouts too big.
Invalid TABINDEX values | Specifying invalid tabindex values confuses the browser and leads to unexpected behavior at runtime. | `TABINDEX=-10`.

Important
Export your settings and commit them in your version control system together with the other workspace settings. When creating a new workspace, import your settings. When upgrading your workspace to a new Natural for Ajax runtime version, your settings will be taken over automatically.

### On this page

- Starting the Development Workplace
- Creating an Application Designer Project
- Creating a Natural Page
- Specifying Properties for the Natural Page
- Designing the Page
- Binding Properties and Methods
- Previewing the Layout
- Viewing the Protocol
- Saving the Layout
- Generating the Adapter
- Data Type Mapping
- Configuration of Page Layout Errors/Warnings