oracle.dss.thin.beans.dataView
Class PrintOptions

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

All Implemented Interfaces:

CheckpointState, ErrorHandlerCallback, ThinBean, ThinBeanUI

Direct Known Subclasses:

PrinterFriendlyView

public class PrintOptions

extends ThinBeanDialog

The ThinBeanUI for the Print Options dialog. The Print Options dialog presents options for printing a thin presentation bean. This PrintOptions generates a BIConstants.INIT_PRINTER_FRIENDLY_VIEW_EVENT, which contains the information that the dialog gathers from a user. Set an EventTarget for the event to direct it to the Printer-Friendly View. The Printer-Friendly View is a presentation of the view that is appropriate for printing. Users use the print feature of the browser to print the view.

The PrintOptions generates the following events:

• BIConstants.INIT_PRINTER_FRIENDLY_VIEW_EVENT -- Pass this event to the generateOnClickSubmit method to get Javascript that generates this event. Set the return value as the ON_CLICK_ATTR of the UIX button or link, to provide OK navigation for this PrintOptions. Set an EventTarget to direct this event to the PrinterFriendlyView.
• BIConstants.CANCEL_EVENT -- Pass this event to the generateOnClickSubmit method to get Javascript that generates this event. Set the return value as the ON_CLICK_ATTR of the UIX button or link, to provide Cancel navigation for this PrintOptions. Set an EventTarget to direct this event to the application page to navigate to when users choose Cancel.

The PrintOptions handles the following event:

• BIConstants.INIT_EVENT - This dialog handles this event by sending an InitEvent to any registered listeners. Call the setView methid to set the thin presentation bean to print. The event is generated by the InitEventDataObject that you set on the button or hyperlink that you create to invoke this ThinDialog.

For more information about using the Print Options dialog, see the "Print Options Dialog" topic in the BI Beans Help system.

See Also:

setView(oracle.dss.thin.beans.dataView.ThinDataviewCommon), PrinterFriendlyView, BaseThinBeanUI.generateOnClickSubmit(java.lang.String), InitEventDataObject, ThinDataviewCommon

Field Summary

static java.lang.String	PRINT_PAPER_ORIENTATION_LANDSCAPE Paper orientation: Landscape.
static java.lang.String	PRINT_PAPER_ORIENTATION_PORTRAIT Paper orientation: Portrait.
static java.lang.String	PRINT_PAPER_SIZE_A4 Paper size: A4.
static java.lang.String	PRINT_PAPER_SIZE_FOLIO Paper size: Folio.
static java.lang.String	PRINT_PAPER_SIZE_LEGAL Paper size: Legal.
static java.lang.String	PRINT_PAPER_SIZE_LETTER 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

PrintOptions()
Constructor.

Method Summary

int	getPrintColumnBlockSize() Retrieves the number of columns to print on each physical page.
java.util.Vector	getPrintHPos() Retrieves information about the logical pages to print.
java.lang.String	getPrintPaperOrientation() Retrieves the paper orientation for printing.
java.lang.String	getPrintPaperSize() Retrieves the paper size for printing.
java.lang.String	getPrintRange() Retrieves the range of logical pages to print for the PrintOptions.
int	getPrintRowBlockSize() Retrieves the number of rows to print on each physical page.
ThinDataviewCommon	getView() Retrieves the view that will be printed based on options that are set in this PrintOptions.
int	handleEvent(QueryParameterProvider provider) Handles a thin-bean event.
boolean	isPrintColumnBlockSizeUsed() Indicates whether the PrintColumnBlockSize property has been explicitly set.
boolean	isPrintRowBlockSizeUsed() Indicates whether the PrintRowBlockSize property has been explicitly set.
void	setPrintColumnBlockSize(int size) Specifies the number of columns to print on each physical page.
void	setPrintColumnBlockSizeUsed(boolean used) Specifies whether the PrintColumnBlockSize property has been explicitly set.
void	setPrintHPos(java.util.Vector hPosList) Specifies the logical pages to print.
void	setPrintPaperOrientation(java.lang.String orientation) Specifies the paper orientation for printing.
void	setPrintPaperSize(java.lang.String paperSize) Specifies the paper size for printing.
void	setPrintRange(java.lang.String pageRange) Specifies the range logical page to export for the PrintOptions.
void	setPrintRowBlockSize(int size) Specifies the number of rows to print on each physical page.
void	setPrintRowBlockSizeUsed(boolean used) Specifies whether the PrintRowBlockSize property has been explicitly set.
void	setView(ThinDataviewCommon view) Specifies the view to print, based on the options that are specified in this PrintOptions.

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

Field Detail

PRINT_PAPER_SIZE_LETTER

public static final java.lang.String PRINT_PAPER_SIZE_LETTER

Paper size: Letter.

PRINT_PAPER_SIZE_LEGAL

public static final java.lang.String PRINT_PAPER_SIZE_LEGAL

Paper size: Legal.

PRINT_PAPER_SIZE_A4

public static final java.lang.String PRINT_PAPER_SIZE_A4

Paper size: A4.

PRINT_PAPER_SIZE_FOLIO

public static final java.lang.String PRINT_PAPER_SIZE_FOLIO

Paper size: Folio.

PRINT_PAPER_ORIENTATION_PORTRAIT

public static final java.lang.String PRINT_PAPER_ORIENTATION_PORTRAIT

Paper orientation: Portrait.

PRINT_PAPER_ORIENTATION_LANDSCAPE

public static final java.lang.String PRINT_PAPER_ORIENTATION_LANDSCAPE

Paper orientation: Landscape.

Constructor Detail

PrintOptions

public PrintOptions()

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 ThinBeanDialog

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

setView

public void setView(ThinDataviewCommon view)

Specifies the view to print, based on the options that are specified in this PrintOptions. Call this method as you initialize this PrintOptions.

Parameters:

view - The view to print.

getView

public ThinDataviewCommon getView()

Retrieves the view that will be printed based on options that are set in this PrintOptions.

Returns:

The view to print.

getPrintRange

public java.lang.String getPrintRange()

Retrieves the range of logical pages to print for the PrintOptions. A logical page is the page of data that is associated with a set of page dimension members.

Returns:

A constant that represents the range of pages to print. Valid constants are listed in the See Also section.

See Also:

ThinBeanDialog.ALL_PAGES, ThinBeanDialog.CURRENT_PAGE, ThinBeanDialog.SELECTED_PAGES

setPrintRange

public void setPrintRange(java.lang.String pageRange)

Specifies the range logical page to export for the PrintOptions. A logical page is the page of data that is associated with a set of page dimension members. By default, this option is set to the current page.

Parameters:

pageRange - A constant that represents the range of pages to print. Valid constants are listed in the See Also section.

See Also:

ThinBeanDialog.ALL_PAGES, ThinBeanDialog.CURRENT_PAGE, ThinBeanDialog.SELECTED_PAGES

getPrintHPos

public java.util.Vector getPrintHPos()

Retrieves information about the logical pages to print. This method retrieves a vector of hierarchical position information of page dimension members for the logical pages to print.

Returns:

A vector of HPos information of the page dimension members that identify the logical pages to print.

setPrintHPos

public void setPrintHPos(java.util.Vector hPosList)

Specifies the logical pages to print. This method specifies the hierarchical position information of the page dimension members that identify the logical pages to print.

Parameters:

hPosList - A vector of HPos information of the page dimension members that identify the logical pages to print.

getPrintPaperSize

public java.lang.String getPrintPaperSize()

Retrieves the paper size for printing.

Returns:

A constant that represents the paper size. Valid constants are listed in the See Also section.

See Also:

PRINT_PAPER_SIZE_LETTER, PRINT_PAPER_SIZE_LEGAL, PRINT_PAPER_SIZE_A4, PRINT_PAPER_SIZE_FOLIO

setPrintPaperSize

public void setPrintPaperSize(java.lang.String paperSize)

Specifies the paper size for printing.

Parameters:

paperSize - A constant that represents the paper size. Valid constants are listed in the See Also section.

See Also:

PRINT_PAPER_SIZE_LETTER, PRINT_PAPER_SIZE_LEGAL, PRINT_PAPER_SIZE_A4, PRINT_PAPER_SIZE_FOLIO

getPrintPaperOrientation

public java.lang.String getPrintPaperOrientation()

Retrieves the paper orientation for printing.

Returns:

A constant that represents the paper orientation. Valid constants are listed in the See Also section.

See Also:

PRINT_PAPER_ORIENTATION_PORTRAIT, PRINT_PAPER_ORIENTATION_LANDSCAPE

setPrintPaperOrientation

public void setPrintPaperOrientation(java.lang.String orientation)

Specifies the paper orientation for printing.

Parameters:

orientation - A constant that represents the paper orientation. Valid constants are listed in the See Also section.

See Also:

PRINT_PAPER_ORIENTATION_PORTRAIT, PRINT_PAPER_ORIENTATION_LANDSCAPE

setPrintRowBlockSize

public void setPrintRowBlockSize(int size)

Specifies the number of rows to print on each physical page.

Parameters:

size - The number of rows to print on each physical page.

getPrintRowBlockSize

public int getPrintRowBlockSize()

Retrieves the number of rows to print on each physical page.

Returns:

The number of rows to print on each physical page.

setPrintColumnBlockSize

public void setPrintColumnBlockSize(int size)

Specifies the number of columns to print on each physical page.

Parameters:

size - The number of columns to print on each physical page.

getPrintColumnBlockSize

public int getPrintColumnBlockSize()

Retrieves the number of columns to print on each physical page.

Returns:

The number of columns to print on each physical page.

setPrintRowBlockSizeUsed

public void setPrintRowBlockSizeUsed(boolean used)

Specifies whether the PrintRowBlockSize property has been explicitly set. When this method returns true, then the property value is used in printing.

The setPrintRowBlockSize method calls this method.

Parameters:

used - true if the property has been explicitly set, false if it has not.

isPrintRowBlockSizeUsed

public boolean isPrintRowBlockSizeUsed()

Indicates whether the PrintRowBlockSize property has been explicitly set. When this method returns true, then the property value is used in printing.

Returns:

true if the property has been explicitly set, false if it has not.

setPrintColumnBlockSizeUsed

public void setPrintColumnBlockSizeUsed(boolean used)

Specifies whether the PrintColumnBlockSize property has been explicitly set. When this method returns true, then the property value is used in printing.

The setPrintColumnBlockSize method calls this method.

Parameters:

used - true if the property has been explicitly set, false if it has not.

isPrintColumnBlockSizeUsed

public boolean isPrintColumnBlockSizeUsed()

Indicates whether the PrintColumnBlockSize property has been explicitly set. When this method returns true, then the property value is used in printing.

Returns:

true if the property has been explicitly set, false if it has not.