User Interface Layout Best Practices

In order to present the user with a consistent user interface (UI) certain guidelines or best practices should be followed. The guidelines presented here are intended for the back office (manager) applications. Layout for public-facing screens (such as eCommerce) are typically installation-specific, and may have separate guidelines.

Navigation

OFBiz navigation is separated into four main categories, and some screens may have others. Navigation links should appear only for targets that the user has permission to access.

Main Navigation

This section contains links for frequently used applications. Links to less frequently used applications are kept in secondary navigation. The main navigation area should indicate which application is currently selected.

Secondary Navigation

This section contains links for less frequently used applications. The secondary navigation area should indicate which application is currently selected.

Application Navigation

This section contains the application's title, plus links to screens within the application. Application navigation should indicate which screen is currently selected.

Application Sub Navigation

This section contains links to sub tasks within an application task. It typically appears as a tab bar in the Main Content Area. Sub navigation should indicate which sub task or screen is currently selected.

Main Content Area

The main content area contains a particular task. Putting multiple tasks in the main content area is discouraged, because it leads to a complicated and difficult to understand screen. If multiple tasks are used in a single screen, they should be clearly separated.

Generally speaking, the main content area should contain the following items, going from top to bottom:

1. Optional sub navigation tab bar (mentioned above).
2. Page title, using the h1 style. The page title displayed in the main content area should match the title bar title. This makes a strong connection between screens and bookmarks and browser history.
3. Optional related task buttons, in the button bar style. For instance, a Find screen might have a "Create New" button here.
4. The task area.

Many screens will fall into a few general categories, and those categories are detailed below.

Create or Add Screens

Generally speaking, create or add screens should contain the following items, going from top to bottom:

1. Optional sub navigation tab bar.
2. Page title, using the h1 style.
3. Data entry form, including a Save button.

Avoid having unnecessary controls on the screen. For instance, a create screen should not contain a "Create New" button on it - that would be redundant.

In some cases, create screens also contain a list of created items. That type of screen is discouraged, but if it is used the item data entry screen should be above the item list. In addition, the item data entry screen should be collapsible and initially collapsed.

Find Screens

Generally speaking, find screens should contain the following items, going from top to bottom:

1. Optional sub navigation tab bar.
2. Page title, using the h1 style.
3. Optional related task buttons, in the button bar style. For instance, a "Create New" button.
4. Optional Search Options data entry form. The form should be collapsible.
5. List of found items - the search results.

Using the FindScreenDecorator is recommended - it will insure correct layout and it will reduce screen widget code.

The initial display of search results is controlled by the widget.defaultNoConditionFind property in the widget.properties file. That setting should be respected and not overridden in screen widget code.