Printable Page Behavior Usage Guideline Bookmark this Guideline Printable Page


RCUI Document Version 5.0.1 for Oracle® Fusion Middleware 11g Release 1 Patch Set 1 (11.1.1.2.0)
Last Updated 08-Feb-2011

A "Printable Page" is a print output version of application page content, stripped of extraneous user interface elements. Stripped (removed) interface elements include those that support the user's need to interact with the application.

Guideline Contents

Note: Images in this guideline are provided as a general reference, and may not be exact representations of FusionFX pages.

Related Guidelines

Guideline Section For Information About
All    

Related ADF Elements

Refer to the ADF Faces Rich Client demos page to find demos and tag documentation for the ADF elements related to this component:

ADF Element Notes
af:showPrintablePageBehavior Shows a printable page.
af:commandButton Generates an action.

General Principles Bookmark this Heading Return to Top

Purpose:

A printable page is used to optimize information for printing.

Example:

The initial page could contain a class roster in a table with scroll bars and controls for editing the information, whereas the printable page would contain the entire class roster without scroll bars and without many other UI elements.

Usage:

  • Printable pages omit certain UI elements to show only those that communicate relevant information.
  • The content on every page can be printed using browser print functions. Product teams should reserve the printable page option for specific pages in an application where it is expected that users need the content to be optimized for printing, such as an order confirmation page.
  • FusionFX applications rely on browser print settings to control print orientation, scaling, and other print options. Printable pages are previewed on the screen before printing—either in an external window or on a separate browser tab, depending on browser preferences.

Printable Page Methods Bookmark this Heading Return to Top

FusionFX applications may include two printable page methods, both of which rely on browser print settings:

  • Basic Printable Page—The printable page is assembled based on application default settings; the user then selects a browser print option.
  • Print Object—The printable page includes all of the object's data, even though it is not all displayed on the current page.
Note: "Basic Printable Page" functionality corresponds to the af:showPrintablePageBehavior component provided by the ADF framework. "Print Object" functionality is entirely the responsibility of application developers, as the framework does not provide any functionality for it.

Both types of printable page follow the same rules for removal and retention of UI elements. See the Printable Page Elements section for details.

Basic Printable Page Bookmark this Heading Return to Top

The basic printable page follows common Web site practice:

  • After creating or viewing an object, the page displays an action/navigation button or a page-level Actions menu option labeled "Printable Page".
  • The Printable Page button should be provided only where users need content to be optimized for printing, such as reports, receipts, and activity logs.
  • The printable page appears in an external window or on a separate browser tab and displays all the summary information, but without unnecessary UI elements. See Printable Page Elements below for details.
  • The user relies on the browser print controls to print the page, and the browser Close controls to dismiss the window.

Basic printable page: form page example

Basic Printable Page - Form Page Example

Print Object Bookmark this Heading Return to Top

The Print Object page allows users to print all data associated with an object, regardless of whether it is displayed on a single page:

  • On completion of a guided process—or after creating, editing, or viewing an object—the page displays summary or other object-related information and a "Print {ObjectType}" button in one or more section-level toolbars, with a label such as "Print Report".
  • The "Print {ObjectType}" toolbar button should be provided only where the basic printable page option does not include all the required data in printed format.
  • The resulting printable page displays all of the object's information in an external window or a separate browser tab, but without unnecessary UI elements. See Printable Page Elements below for details.
  • Printable pages for some objects, such as reports and contracts, may scroll extensively.
  • If users need more control over printed output, product teams should provide a list of print options in a dialog or separate page, where the user can select page elements to include or omit from the printable page.
  • The user relies on the browser print controls to print the page, and the browser Close controls to dismiss the window.

Print Object Example, in which clicking the 'Print Content' button on a page opens the object  information in an external window for printing.

Print Object Example

Note: Printable page functionality is not recommended for long-running reports in Oracle applications where the processing time required can be significant (such as reports which run on concurrent processes).

Printable Page Elements Bookmark this Heading Return to Top

Elements Removed by Default Bookmark this Heading Return to Top

Printable pages use the following principles when removing content:

  • All content in the Global, Primary, and Secondary Layers is omitted, along with any content in auxiliary content regions. See the Page Layout guideline for details on content regions and layers.
  • Action and navigation controls within the main content region are either omitted or disabled.
  • If product teams place custom content (such as an image) within the region or pane containing the Printable Page button, that content is retained unless product teams provide custom print options to remove it.

The UI elements listed in the following table are removed by default. The table notes conditions where product teams may consider retaining some of these elements:

Element Notes
Branding May be required by product marketing.
Global links  
Breadcrumbs If needed to show page location in the application, breadcrumb links should be disabled to block navigation within the printable page.
Tab bars  
Train stops  
Menus  
Toolbars  
Overflow icons and panels  
Scroll bars  
Accordion All accordion pane contents are removed.
Panel Splitter Only splitter pane contents in view are printed.
Trees Tree may be printed if specified in print options.
Disclosure icons Only expanded contents are printed unless specified in print options. Consider retaining Disclosure icons if a hidden section could lead to misinterpretation of data.
Navigation links Navigation links (af:goLink) are hidden in printable pages, but drill-down links on object names (af:commandLink) are disabled instead. Developers should use drill-down links for lists of object names if they are relevant to the printable page, such as a list of online purchases.
Action/Navigation buttons  
Action icons  

Elements Modified by Default Bookmark this Heading Return to Top

The following elements in the pane or region containing the Printable Page button are converted to read-only format by default:

Element Notes
Tables Only records in view are printed from basic printable page, and the record range is displayed if the printed record set is incomplete. Entire set of records may be printed using the Print Object option.
Select Choice lists  
Checkboxes  
Select Radio  
Updateable fields  

Elements That May Be Removed Bookmark this Heading Return to Top

The following elements are retained by default when they appear in the region or pane containing the Printable Page button, but product teams should consider removing them as specified below:

Element Remove When . . .
Page header The user prints only a section of data using print options.
Section headers The user prints a different section of data using print options.
Instruction text The instructions are not useful to help interpret the data.
Key Notation The information is not relevant to the printable page.
Field labels The field is omitted.
Page Stamps The information is not relevant to the printable page.
Context Region The information is not relevant to the printable page.
Panel Boxes The information is not relevant to the printable page.
Links Drill-down links on object names (af:commandLink) are disabled by default. Developers may omit them when those object names are not relevant to the printable page.