<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">

Overview

Package

Class

Tree

Deprecated

Index

Help

Oracle™ Business Intelligence Beans Java API Reference
Release 10g (9.0.4)
Part number B12159_01

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.dss.thin.beans.dataView
Class PrinterFriendlyView

java.lang.Object
  |
  +--oracle.dss.thin.beans.BaseThinBeanUI
        |
        +--oracle.dss.thin.beans.ThinBeanDialog
              |
              +--oracle.dss.thin.beans.dataView.PrintOptions
                    |
                    +--oracle.dss.thin.beans.dataView.PrinterFriendlyView

All Implemented Interfaces:: CheckpointState, ErrorHandlerCallback, ThinBean, ThinBeanUI

public class PrinterFriendlyView
extends PrintOptions

The ThinBeanUI for the Printer-Friendly View. The Printer-Friendly View presents a view in a form that is appropriate for printing. The print feature of the browser actually prints the view.

The PrinterFriendlyView is initialized through the BIConstants.INIT_PRINTER_FRIENDLY_VIEW_EVENT. The PrintOptions typically generates this event.

The PrinterFriendlyView page is designed to show only the view that is to be printed. The page does not contain any links that allow the end user to go to another page of the application. Therefore, the end user must use the back button to move back into the application's normal page flow. If you want the view to appear in a page with other items, such as navigation, a logo, or a standard title, then set a PrinterFriendlyViewCallback on this PrinterFriendlyView. The <PrinterFriendlyView sends the printable view to the callback, and the callback renders the page.

The PrinterFriendlyView does not generate any events. It handles the following event:

BIConstants.INIT_PRINTER_FRIENDLY_VIEW_EVENT -- This PrinterFriendlyView handles this event by preparing the view for printing. It then sends an InitEvent to any registered ThinViewListener implementations. Call the setView method to specify the view to print. The event is generated by the PrintOptions.generateOnClickSubmit method. It should be generated when a user clicks OK in the Print Options dialog.

For more information about using the Printer-Friendly View, see the "Printer-Friendly View" topic in the BI Beans Help system.

See Also:: PrintOptions, ThinDataviewCommon

Fields inherited from class oracle.dss.thin.beans.dataView.PrintOptions

PRINT_PAPER_ORIENTATION_LANDSCAPE, PRINT_PAPER_ORIENTATION_PORTRAIT, PRINT_PAPER_SIZE_A4, PRINT_PAPER_SIZE_FOLIO, PRINT_PAPER_SIZE_LEGAL, PRINT_PAPER_SIZE_LETTER

Fields inherited from class oracle.dss.thin.beans.ThinBeanDialog

ALL_PAGES, CURRENT_PAGE, SELECTED_PAGES

Fields inherited from interface oracle.dss.thin.beans.ThinBeanUI

EVENT_HANDLED, EVENT_NOT_HANDLED, EVENT_RESPONSE_DONE

Constructor Summary
`PrinterFriendlyView()` Constructor.

Method Summary
`PrinterFriendlyViewCallback`	`getPrinterFriendlyViewCallback()` Retrieves the registered `PrinterFriendlyViewCallback` for this `PrinterFriendlyView`.
`int`	`getTotalHorizontalMargins()` Retrieves the sum of the left and right margin to be used when the view is printed.
`int`	`getTotalVerticalMargins()` Retrieves the sum of the top and bottom margin to be used when the view is printed.
`int`	`handleEvent(QueryParameterProvider provider)` Handles a thin-bean event.
`void`	`setPrinterFriendlyViewCallback(PrinterFriendlyViewCallback callback)` Registers a `PrinterFriendlyViewCallback` with this `PrinterFriendlyView`.
`void`	`setTotalHorizonalMargins(int horizontalMargins)` Specifies the sum of the left and right margin to be used when the view is printed.
`void`	`setTotalVerticalMargins(int verticalMargins)` Specifies the sum of the top and bottom margin to be used when the view is printed.

Methods inherited from class oracle.dss.thin.beans.dataView.PrintOptions

getPrintColumnBlockSize, getPrintHPos, getPrintPaperOrientation, getPrintPaperSize, getPrintRange, getPrintRowBlockSize, getView, isPrintColumnBlockSizeUsed, isPrintRowBlockSizeUsed, setPrintColumnBlockSize, setPrintColumnBlockSizeUsed, setPrintHPos, setPrintPaperOrientation, setPrintPaperSize, setPrintRange, setPrintRowBlockSize, setPrintRowBlockSizeUsed, setView

Methods inherited from class oracle.dss.thin.beans.ThinBeanDialog

addThinBeanDialogListener, removeThinBeanDialogListener

Methods inherited from class oracle.dss.thin.beans.BaseThinBeanUI

addErrorHandler, checkpointState, generateOnClickSubmit, getCheckpointState, getEventTarget, getLocale, getState, getThinBeanName, removeErrorHandler, setBaseState, setCheckpointState, setEventTarget, setLocale, setState, setThinBeanName

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PrinterFriendlyView

public PrinterFriendlyView()

Constructor.

Method Detail

handleEvent

public int handleEvent(QueryParameterProvider provider)
                throws ThinException

Description copied from interface: ThinBeanUI

Handles a thin-bean event. This ThinBeanUI handles events where the value of the source query parameter is the ThinBeanName for this thin bean.

You can examine the source query parameter to determine the thin bean whose handleEvent to call. Or you can call the handleEvent for each thin bean, checking the return from this method to discover which thin bean handled the event. Alternately, you can register thin beans with the ServletRequestHandler and call the handleEvent method of the ServletRequestHandler. The ServletRequestHandler will then route the event to the proper thin bean.

For more information about thin-bean events, see the BI Beans Help system.

Overrides:: handleEvent in class PrintOptions

Following copied from interface: oracle.dss.thin.beans.ThinBeanUI

Parameters:: provider - The QueryParameterProvider for the HTTPServletRequest that is being handled.
Returns:: A constant that indicates whether this ThinBeanUI handled any events. Constants are listed in the See Also section.
Throws:: ThinException - If an error occurs that interrupts event handling.
See Also:: ThinBeanUI.EVENT_NOT_HANDLED, ThinBeanUI.EVENT_HANDLED, ThinBeanUI.EVENT_RESPONSE_DONE, ServletRequestHandler

setPrinterFriendlyViewCallback

public void setPrinterFriendlyViewCallback(PrinterFriendlyViewCallback callback)

Registers a PrinterFriendlyViewCallback with this PrinterFriendlyView. If a PrinterFriendlyViewCallback is registered, then the PrinterFriendlyView asks the callback to render the printer-friendly page. The application then has the opportunity to render custom HTML around the printable view.

The PrinterFriendlyViewCallback is null by default.

Parameters:: callback - The callback that should render the HTML page.

getPrinterFriendlyViewCallback

public PrinterFriendlyViewCallback getPrinterFriendlyViewCallback()

Retrieves the registered PrinterFriendlyViewCallback for this PrinterFriendlyView. If a PrinterFriendlyViewCallback is registered, then this PrinterFriendlyView asks the callback to render the printer-friendly page. The application then has the opportunity to render custom HTML around the printable view.