Container Objects

Overview

This section describes the standard properties and behaviors for Modules, Windows, Canvases, Blocks, and Regions.

These characteristics may be set in the following ways:

For details of the implementation of these properties, see the Oracle E-Business Suite Developer's Guide.

The following objects are discussed in this chapter:

Modules

Module properties establish an overall framework for the look and feel of each form.

For information on implementing modules, see the Oracle E-Business Suite Developer's Guide.

Display Attributes

The coordinate system is established to allow any form to render the same size regardless of screen resolution. "Real" coordinates are used, because they are based on a logical, not physical, measure (OMS-71002). The following picture shows the relevant Oracle Forms settings: Coordinate System is set to Real, Real Unit is set to Inch, Character Cell Width is set to .1, and Height is set to .25.

the picture is described in the document text

(OMS-73001) The character cell height and width values (0.1" and 0.25," respectively), which govern the grid to which all items are snapped, are derived as follows:

(OMS-73900) Ruler settings determine the spacing and alignment of all elements in the Oracle Forms. It is crucial that these settings are established correctly before any layout is performed and that the "Grid Snap" setting is enabled.

All references relative to cell positioning in this manual are based upon the following ruler settings:

The following picture shows these correct Oracle Forms ruler settings, which must be set for every canvas being developed.

the picture is described in the document text

These settings allow objects to be drawn snapped to a character cell grid, with well defined "rows" and "columns." Use of this character cell grid facilitates rapid building of, and often more aesthetically pleasing, screens than could otherwise be achieved if no grid were imposed.

Functional Attributes

The following settings determine some basic interaction rules for all forms:

Related Topics

Validation Models

Windows

The MDI window inherits the look and feel of the GUI in which it is running. Within the MDI, all windows inherit Oracle's look and feel, which has specific characteristics for fonts, window bevel, and window manager buttons. This section describes features common to all Oracle E-Business Suite windows, as well as behaviors for modal and non-modal windows.

For information on implementing windows, see the Oracle E-Business Suite Developer's Guide.

General Look and Feel

Visual Attributes

All applications windows share the following visual attributes:

Icons

Icons that are shown in the window title bar are determined in the following manner:

Titles

Each window in a form must be titled uniquely. (OMS-73012).

In addition, detail windows should display context information in the window title. For example, "Benefits - John Doe" (OMS-58505).

Scroll Bars

No scroll bars are attached to individual windows within the MDI window, although the MDI window itself may have them (scroll bars may appear inside the window, attached to canvases, blocks, or items). (OMS-73013).

Toolbars

The toolbar is attached to the MDI window, not to any individual product window.

Window Style

Most application windows appear inside the MDI window ("Document" style) except dialogs and the Folder tool palette ("Dialog" style).

Size

Guidelines and limits for window size are as follows:

Position

The following points pertain to window position:

Button Placement

Sequence buttons for non-modal windows as follows:

the picture is described in the document text

the picture is described in the document text

Non-Modal Windows

Non-modal windows are used for the display of most application entities. A non-modal window allows the user to interact with any other window, as well as the toolbar and the menu.

For information on implementing non-modal windows, see the Oracle E-Business Suite Developer's Guide.

Position

The position of a non-modal window is determined as follows:

Title

You should adhere to the following standards and suggestions when choosing titles for non-modal windows:

Closing

The following standards determine how non-modal windows should behave when closing:

Resizing

Guidelines for resizing windows are as follows:

Menus

All windows inherit the menu. (OMS-73045)

Find Windows

A Find window is a type of window that enables the user to locate one or more records without having to invoke Query By Example. For example, a Receiving form may allow a user to enter various criteria to locate one or more receiving headers that match the criteria, then subsequently allow the user to operate on each retrieved header and its associated lines.

A Find window should be used in the following situations (OMS-73645):

Other blocks may use an LOV (called a "Row LOV") that shows all possible records a user can query.

The following picture shows a Find window opened centered on its Results window.

the picture is described in the document text

For information on implementing Find windows, see the Oracle E-Business Suite Developer's Guide.

Characteristics and layout of the Find Window

Find windows should have the following characteristics:

Buttons

Find windows have the following buttons (OMS-73050):

Variable Description
Clear Clears the Find window for entering new search criteria. Defaults should be reapplied.
New Places the cursor on a new record in the transaction block. If the form allows entry of more than one entity or if the action can be made clearer, this button can be more fully qualified, such as "New RFQ" or "New Quotation" (there can be more than one button beginning with "New" in the window).
If the form does not allow entry of new data, do not include this button. However, a gap should be left between the Clear and Find buttons.
Find Performs the query with the current criteria. This is the default button for the window.

Search Behaviors

Row LOV Windows

When the user invokes View Find in certain cases a Row LOV window appears.

A Row LOV should be used in the following situations (OMS-73557):

The following figure shows a Row LOV Window opened for its Results window.

the picture is described in the document text

A "Row LOV" is a specific type of LOV that shows all possible records the user can query. In general, Row LOVs should follow the standards for LOVs as well as specific title standards for Row LOVs.

Modal Windows

Modal windows force the user to work within a single window, then either accept or cancel the changes they have made. Modal windows should only be used when a user is required to enter specific information to complete an action. Modal windows use the Dialog Block mechanism to control access and navigation.

For information on implementing modal windows, see the Oracle E-Business Suite Developer's Guide.

Position

Modal windows are always opened centered on the MDI window or centered relative to other windows. (OMS-60053).

Title

Modal window titles should be closely related to the labels of the widgets that open them. (OMS-73558)

Menus and Toolbar

Modal windows have the menu associated with them, but the user cannot have access to it. There are a few legacy screens that allow limited access to the toolbar and menu, but no new instances should be designed or coded. (OMS-73057)

Because the menu is not accessible from a modal window, function-key access to the following actions must be supported (OMS-73058):

If the modal window allows multiple records, then the following should also be enabled via function keys:

All other function keys should issue a "beep" when the user attempts to invoke them.

Closing

Modal windows are generally closed in response to the user pressing a button that concludes work in that window, although the window close box may still be used. Typical close actions and how they are used are as follows (OMS-73060):

Variable Description
OK or Done Closes the window. In some cases, it may perform a save as well.

Note: A specific verb can be substituted in place of "OK." For instance, in a window designed to record additional information before posting, buttons of "Post" and "Cancel" are clearer to the user than just "OK" and "Cancel."

Cancel Clears the data without asking for confirmation, and closes the window.
Apply Processes the changes made in the window, but does not close it.
Window Close Box Performs the same action as "Cancel."

Size

Modal windows do not allow resize, maximization, or minimization. (OMS-73061)

Semi-Modal Windows

This term refers to one window in a set of two or more windows opened among which the user can navigate as a modal group. In this case, a user may not return to a calling window until an action is completed or canceled, but needs to be able to move among multiple windows for doing that action. In those cases, "Semi-Modal" windows are used.

After invoking a "Semi-Modal" window, the user may move among the subset of windows freely, but cannot move back to the calling window without completing or canceling the action (typically with Done or Cancel buttons). Clicking on the calling window results in a "beep," and the user's previous position is restored. (OMS-73561)

Semi-modal windows are not a native Oracle Forms feature. See the Oracle E-Business Suite Developer's Guide for further information.

Related Topics

Context Blocks

View Find

Lists of Values (LOV)

Dialog Blocks

Implicit Saves

Canvases

Canvases are the surfaces on which all interface items are placed. In general, all canvases share the following property:

This section describes aspects of canvases that depend on whether the canvas is a content canvas or a stacked canvas. For information on Tab canvases, see Regions.

For information on implementing canvases, see the Oracle E-Business Suite Developer's Guide.

Content Canvases

Each window contains one content canvas, which fully occupies the window. Additional stacked and Tab canvases may be displayed in front of the content canvas.

Display Characteristics

Content canvases have the following display characteristics:

Size

The size should be the same as the window it will be shown in. (OMS-73565)

Stacked Canvases

Stacked canvases are the mechanism for placing content in a portion of the window which may be alternated to show another set of content. One or more stacked canvases may be displayed in front of the content canvas of a particular window. If needed, a stacked canvas may fully occupy a window.

For information on implementing stacked canvases, see the Oracle E-Business Suite Developer's Guide.

Display Characteristics

Stacked canvases should adhere to these display characteristics:

Size

The Size should be set to the exact size necessary to contain all of the items on the canvas. (OMS-73567)

View

The View specifies the size of the view port in which the stacked canvas will be displayed. Ideally it is the same as the canvas size, otherwise scrolling is implied.

Scrolling should be avoided if possible, but if required, it must be limited to twice the width or height of the viewport. (OMS-73122)

Sequence

When multiple stacked canvases occupy the same window, and may overlap, the sequence must be set so that the proper canvases, or portions of canvases, are displayed.

Scroll Bar

If a stacked canvas is scrollable, then a scroll bar must be enabled. Also, if any canvas requires a scroll bar in Tab regions, all of the stacked canvases corresponding to that Tab region should then have a scroll bar. Canvases in single-record formats scroll vertically; those in multi-record formats scroll horizontally. Never allow both vertical and horizontal scrolling of a stacked canvas, except when needed to display a graphic image. (OMS-73267)

Blocks

Most properties of blocks are form-specific, such as the ability to insert or update data. Only basic cosmetic properties are common to all.

For information on implementing blocks, see the Oracle E-Business Suite Developer's Guide.

General Block Rules

Title

Block titles should be displayed and chosen according to the following guidelines:

Titles for a block are rendered automatically as the title attributes of a "frame" object. This can be either a full square container, or a zero-height frame that renders as a horizontal line for delimiting blocks. The visual properties of these titles are inherited from the Oracle Application Object Library property classes.

Note: These settings apply specifically to titles that are displayed with a frame. Appropriate settings must be applied when the title is a display item, check box or radio button.

Context Blocks

Each non-modal window must be designed so that a user can maintain context merely by viewing that single window. This is necessary because of the multitude of windows, possibly across several forms, that may be on the screen at any one time. Also, because a user may iconify the window containing the context of the data in the current window, each window must display its own scope. The window title is the preferred way to show context, but when it cannot meaningfully or fully display the context for a window, additional context is displayed in a context block.

the picture is described in the document text

Context Block Characteristics

Context blocks should have the following characteristics:

Dialog Blocks

Dialog blocks are the blocks presented in modal windows. They require the user to interact with them before proceeding with other windows of the application.

Dialog Block Characteristics

Dialog blocks should have the following characteristics:

Enabled Functions

Most standard Oracle Forms functions do not apply in a Dialog block. However, some functions may be enabled under certain conditions.

Navigation

Navigation to items outside a dialog block must be prevented while the modal window is open. The following guidelines prevent the user from navigating out of a Dialog block (OMS-73074):

Single-Record Blocks

Single-record blocks allow the user to see many attributes of a single record. The single-record format should be used when only one record is possible or the user only works with one record, or when it is necessary that the user see many attributes of one record at the same time.

Single-Record Block Layout

Querying

Clearing

In cases where there is only one record possible, Edit Clear Record and Edit Clear Block should automatically requery that one record. These functions should issue a "beep" in this situation to indicate that their behavior is different from normal. (OMS-73077)

Multi-Record Blocks

Multi-record blocks allow the user to see as many records of an entity as possible, usually at the tradeoff of seeing fewer attributes of each record simultaneously. For general information on when multi-record formats should be used, refer to the section General Design and Layout.

For information on implementing Multi-Record Blocks, see the Oracle E-Business Suite Developer's Guide.

Scroll Bar

Multi-record blocks display a record scroll bar, as follows (OMS-73078):

Current Record Indicator

(OMS-73178) All multi-record blocks have an indicator to point out the current record. The indicator looks and behaves in the following ways (OMS-73079):

the picture is described in the document text

(OMS-73080) If the block supports a "drill-down" capability, then the indicator has the same characteristics as above, except for the following (OMS-73580):

In both cases, single-clicking or double-clicking on the indicator should move the cursor to the first navigable field of the appropriate record.

For information on implementing the Current Record Indicator, see the Oracle E-Business Suite Developer's Guide.

Layout

Querying

Combination Blocks

Combination blocks are hybrid formats, where fields are presented in both multi-record ("Summary") and single-record ("Detail") formats. The Summary and Detail formats are each presented in their own non-modal window. For general information on when Combination blocks should be used, refer to General Design and Layout.

For information on implementing Combination blocks, see the Oracle E-Business Suite Developer's Guide.

Combination Block Windows

The Summary and Detail windows of a Combination block should behave as follows:

Behavior of Combination Blocks

The Summary and Detail blocks of a Combination block should behave in the following manner:

Buttons

Besides any product-specific buttons, the following buttons may also be coded on the Summary window (OMS-73592):

Variable Description
New Creates a new record. Adding a new row by pressing a "New" button will automatically bring the user to the Detail window. The button label may be qualified, such as "New Line," if necessary to clarify its intended function.
Open Moves the cursor to the detail window. The "Open" button should always open to the detail level of the block that contains the button. For example, if the user has navigated to the line level of a Purchase Order and chooses the "Open" button in that window, then the details for the line should be displayed.

Buttons on the Detail window may include additional actions not available from the Summary window.

Gateways

Gateways offer the user flexible methods to locate, view, and operate on records. They are employed for all the major entities of a product, such as Purchase Orders, Sales Orders, Journals, and Quality Plans. The gateway is the first set of windows that a user sees when interacting with any of these entities. It is comprised of a Combination block and a Find window, with the following unique characteristics:

Workbenches

A workbench is a gateway with sufficient functionality that the user will likely be able to accomplish much of their job from this form. It would typically be left open during a user's entire work session for repeated use.

The following picture shows the set of windows (Find, Summary, and Detail windows) associated with a gateway.

the picture is described in the document text

Note: The above picture is not intended to illustrate the actual position in which these windows initially open.

Folder Blocks

A Folder block is a block that allows the user to customize the set of columns and records displayed for a specific entity. It can be thought of as a "file cabinet" that holds all the records of a certain object, with each individual "Folder" being a specific subset of those records shown in a specific way. For example, if a developer provides a Folder block that shows "Requisitions," then a user could create a Folder called "Unapproved Requisitions" which only shows those requisitions with status "Unapproved," and displays the "Creation Date," "Preparer," and "Next Approver" fields. One or more Folder definitions can be saved per entity, such that screens can be designed appropriately for different tasks. Each Folder is, of course, restricted to data that the user is allowed to view based on the security rules of the product.

Folder Functions

The Folder functions can be invoked from the Folder pull-down menu, the right-mouse menu, or the Folder Tool palette. A profile (Folders: Allow Customization) allows system administrators to prevent individual users from accessing all Folder tools other than Open. Following is a list of the Folder functions and their corresponding Folder Tool palette buttons (where applicable).

Note: Some Folder menu items do not function when you are in QBE mode.

Variable Description
New Creates a new Folder. The user must enter a new, unique (per entity and user) Folder name.
Open Loads a previously defined Folder. A user can select from a list of his own Folders and any public Folders for the current entity.
Save Saves the current Folder. If it has never been named, this function reverts to the "Save As" functionality.
Save As Allows a user to save a Folder, specifying a name, whether it should autoquery upon loading, whether it should serve as the default for the user upon entry to this form, whether other users can use the same definition, and if the current query should be retained. Folder names must be unique per user. If a user modifies someone else's public Folder in any way, saving makes it a private definition. However, opening a public Folder, and saving it as the Default, with no other changes, merely saves the reference of the Folder as the private default.
Delete Allows a user to delete any Folder for the current entity that they created. If another user is referencing the Folder as their default, that reference is deleted as well.
Show Field Opens an LOV displaying fields that can be shown (and are not currently shown). Selecting a value adds the field after the current cursor position.
Hide Field Removes the current field. The cursor moves to the field sequenced after the field that was just hidden.
Move Right In multi-record blocks, swaps the current field with the one to its right. In single-record blocks, moves the current field one character cell to the right.
Move Left In multi-record blocks, swaps the current field with the one to its left. In single-record blocks, moves the current field one character cell to the left.
Move Up In single-record blocks, moves the current field one character cell up.
Move Down In single-record blocks, moves the current field one character cell down.
Widen Field Increases the width of the current field, up to a maximum size of 20 inches, in 0.2 inch increments.
Shrink Field Decreases the width of the current field, to a minimum size of 0.3 inches, in 0.2 inch increments.
Change Prompt Allows the user to alter the prompt of the current field. While in the Prompt modal window, Default allows quick recovery of the prompt initially specified by the developer. Prompts which start with "-" do not appear at runtime. This allows fields to have a prompt associated with them for selecting the field when showing a field, but the prompt is not displayed on the field itself.
Autosize All Resizes displayed fields based on a sample of values for the field in the block, ensuring that no field is smaller than the width of its prompt (in a multi-row block). The number of records is determined by selecting one of the three options: 10, 50, or 100.
Sort Data... Invokes a modal dialog that allows the user to specify the order and the fields by which to sort the data in the table. Sorting is limited to the first three columns only.
View Query Allows the user to view the "where" clause of the Folder.
Reset Query Clears the current "where" clause.
Folder Tools Shows the Folder Tools palette.

Folder Cosmetics

Developer Folders

A developer may employ the Folder technology to present different layouts to the user, but not expose the Folder functions. In that case, the Folder menu remains disabled, and no Folder title or Open Folder icon is displayed.

Direct Manipulation

In multi-record folder blocks, the following actions are supported by manipulating the prompt above each column:

Find Blocks

A Find block is a block where users can only enter an already-existing primary key to view and maintain details (child records) of one specific master record. Find blocks are very similar to Find windows, except that the search criteria is limited and appears in the same window as the results, and the search is for details of a particular master record. For the situations that Find blocks address, a separate Find window is not appropriate.

Note: The term "Find block" in the Standards refers to the case discussed in this section and should not be confused with the block underlying a Find window.

Appearance of Find Blocks

The following standards apply to the appearance of a Find block:

Behavior of Find Blocks

Alternative Blocks

Normally it is desirable to show all blocks for an entity in a single window, if possible. When all the blocks cannot be shown at once, then "alternative blocks" can be employed.

Use the Tab control to show multiple blocks within the same window when they all cannot be rendered simultaneously. (OMS-73203)

Master-Detail Characteristics

Master-Detail relations describe how detail records behave as a result of changes to Master records. For more information on Master-Detail Characteristics, see the Oracle E-Business Suite Developer's Guide.

Titles

To indicate master-detail relations, and for general clarity, try to repeat the master block name in the Detail block title. For instance, use "Order Lines" rather than just "Lines." (OMS-73559)

Coordination

Coordination between master and Detail blocks should follow these standards:

Masterless Operations

A user cannot enter or query detail records until in the context of a master record. (OMS-73110)

Other Rules and Behaviors

The following are other things to keep in mind when implementing Master and Detail blocks in your forms:

Related Topics

Modal Windows

Single-Record Block Prompts

Text Items

Display Items

Multi-Record Formats

Multi-Record Block Prompts

Combination Blocks

Non-Modal Windows

Non-Modal Windows, Position

Tab Regions

Regions

Regions are logical groups of fields, represented with either the frame or tab control.

For information on implementing regions, see the Oracle E-Business Suite Developer's Guide.

Title

You should adhere to the following standards and suggestions when choosing titles for frames and tabs:

Navigation

Navigation within and between regions should follow these rules:

The following picture illustrates navigation order between regions and within a region.

the picture is described in the document text

Frames in Single-Record Formats

Appearance

Frames in single-record blocks should have the following look:

Overflow Regions

Overflow regions show additional detail about the current record of a multi-record block in a single-record format below the multi-record fields.

For general information on when overflow regions should be used, refer to the section on Overflow Regions.

Position

You should use the following standards when creating overflow regions:

Cosmetics

The region is always drawn without a surrounding frame if it is clear that the fields pertain to the current record of the multi-record block, and no title is necessary. (OMS-73819)

Navigation

Navigation in overflow regions is determined as follows:

Other Behaviors

Frames in Multi-Record Blocks

Appearance

Frames in multi-record blocks should have the following look:

Regions that Scroll

Scrolling to additional fields is not desirable, because it involves complex hand-eye coordination, and can be very frustrating if commonly used fields are always out of sight.

Important: Avoid scrolling to additional fields whenever possible.

Scrolling of regions should only be employed under the following conditions: (OMS-73220)

If a region must scroll, then the following rules apply:

Tab Regions

A block with multiple regions containing many fields and controls that cannot be displayed simultaneously uses a series of tabs to display each region one at a time within a single boundary. The tab control area usually spans the entire width of a given form. The block content should be logically divided among these regions such that the title of each tab reflects the grouping of items within it. In prior releases of Oracle E-Business Suite (then called Oracle Applications) these were referred to as "Alternative regions" and were controlled by a poplist.

The tab control is provided by a widget that positions the tab UI mechanism at the top of a set of regions and allows the user to navigate directly to a specific region by selecting one of those tabs. The region then is redisplayed to reflect the user's choice by raising the selected tab to the front.

Important: A note about conversion: Forms that previously used an alternative region poplist control should all be converted to tab controls. The major exception is the case where a poplist has been used to control a list of available queries (this is referred to as a "Query Control Poplist"). This is not considered true alternative region behavior since the contents of each region also reflect a change in the block content, not just the portion of the block being shown. In this case, leave the poplist control in place and add the label "Show:" in front of it. If the situation is further complicated by the need to show alternative regions within the query, then consider separating the controls, placing a tab region within the poplist control.

An example of a tab region (the multi-row case) is displayed in the following figure:

the picture is described in the document text

Layout

Behavior

Related Topics

Overflow Regions