com.crystaldecisions.sdk.occa.report.document
Interface IPrintOptions

All Superinterfaces:
IClone
All Known Implementing Classes:
PrintOptions

public interface IPrintOptions
extends IClone

This interface allows you to get and set the print options for a report. This information includes: content height, content width, driver name, page margins, paper orientation, paper size, paper source, port name, printer duplex, and printer name.


Nested Class Summary
static class IPrintOptions.PrinterType
          For internal use only.
static class IPrintOptions.ScaleOptionType
          For internal use only.
 
Method Summary
 boolean getCenter()
          For internal use only
 int getContentHeight()
           Gets the report content height.
 int getContentWidth()
           Gets the report content width.
 boolean getDissociatePageSizeAndPrinterPaperSize()
           Gets a value that indicates whether the report page size is dissociated from printer paper sizes.
 java.lang.String getDriverName()
           Gets the driver name.
 boolean getFitHorizontalPages()
          For internal use only
 IPageMargins getPageMargins()
           Gets the page margins.
 PaperOrientation getPaperOrientation()
           Gets the paper orientation.
 PaperSize getPaperSize()
           Gets the paper size.
 PaperSource getPaperSource()
           Gets the paper source.
 java.lang.String getPortName()
           Gets the port name.
 PrinterDuplex getPrinterDuplex()
           Gets the printer duplex.
 java.lang.String getPrinterName()
           Gets the printer name.
 IPrintOptions.PrinterType getPrinterType()
          For internal use only
 IPrintOptions.ScaleOptionType getScaleOption()
          For internal use only
 void setCenter(boolean bCenter)
          For internal use only
 void setDissociatePageSizeAndPrinterPaperSize(boolean bDissociatePageSizeAndPrinterPaperSize)
           Sets a value that indicates whether the report page size is dissociated from printer paper sizes.
 void setFitHorizontalPages(boolean bFitHorizontalPages)
          For internal use only
 void setPageMargins(IPageMargins pageMargins)
           Sets the page margins.
 void setPaperOrientation(PaperOrientation orientation)
           Sets the paper orientation.
 void setPaperSize(PaperSize size)
           Sets the paper size.
 void setPaperSource(PaperSource source)
           Sets the paper source.
 void setPrinterDuplex(PrinterDuplex duplex)
           Sets the printer duplex.
 void setPrinterName(java.lang.String printerName)
           Sets the printer name.
 void setScaleOption(IPrintOptions.ScaleOptionType scaleOption)
          For internal use only
 

Method Detail

getDriverName

java.lang.String getDriverName()

Gets the driver name.

Returns:
the driver name

getPortName

java.lang.String getPortName()

Gets the port name.

Returns:
the port name

getPrinterName

java.lang.String getPrinterName()

Gets the printer name.

Returns:
the printer name

getPageMargins

IPageMargins getPageMargins()

Gets the page margins.

Returns:
a reference to the IPageMargins object

getContentWidth

int getContentWidth()

Gets the report content width.

Returns:
the report content width

getContentHeight

int getContentHeight()

Gets the report content height.

Returns:
the report content height

getPaperOrientation

PaperOrientation getPaperOrientation()

Gets the paper orientation.

Returns:
a reference to the PaperOrientation object

getPaperSize

PaperSize getPaperSize()

Gets the paper size.

Returns:
a reference to the PaperSize object

getPaperSource

PaperSource getPaperSource()

Gets the paper source.

Returns:
a reference to the PaperSource object

getPrinterDuplex

PrinterDuplex getPrinterDuplex()

Gets the printer duplex.

Returns:
a reference to the PrinterDuplex object

getPrinterType

IPrintOptions.PrinterType getPrinterType()
For internal use only


getDissociatePageSizeAndPrinterPaperSize

boolean getDissociatePageSizeAndPrinterPaperSize()

Gets a value that indicates whether the report page size is dissociated from printer paper sizes.

Returns:
True if report page size is dissociated from printer paper sizes, and false otherwise.

getFitHorizontalPages

boolean getFitHorizontalPages()
For internal use only


getCenter

boolean getCenter()
For internal use only


getScaleOption

IPrintOptions.ScaleOptionType getScaleOption()
For internal use only


setPrinterName

void setPrinterName(java.lang.String printerName)

Sets the printer name.

Parameters:
printerName - the name of the printer to be set

setPageMargins

void setPageMargins(IPageMargins pageMargins)

Sets the page margins.

Note: As of the Report Application Server 12 SDK, the PrintOutputController.modifyPageMargins method must be used to set all page margins to the default value 0. Attempts to set all page margins to 0 using the PrintOutputController.modifyPrintOptions method are ignored.

Parameters:
pageMargins - the IPageMargins object whose properties will be set

setPaperOrientation

void setPaperOrientation(PaperOrientation orientation)

Sets the paper orientation.

Parameters:
orientation - the PaperOrientation object whose properties will be set

setPaperSize

void setPaperSize(PaperSize size)

Sets the paper size.

Parameters:
size - the PaperSize object whose properties will be set

setPaperSource

void setPaperSource(PaperSource source)

Sets the paper source.

Parameters:
source - the PaperSource object whose properties will be set

setPrinterDuplex

void setPrinterDuplex(PrinterDuplex duplex)

Sets the printer duplex.

Parameters:
duplex - the PrinterDuplex object whose properties will be set

setDissociatePageSizeAndPrinterPaperSize

void setDissociatePageSizeAndPrinterPaperSize(boolean bDissociatePageSizeAndPrinterPaperSize)

Sets a value that indicates whether the report page size is dissociated from printer paper sizes. Setting this property to true allows you to control the height and width of the report independent of the paper size specified. This can be useful when the report is viewed electronically, such as on a Web Site. Note: Set to true if using custom page sizes for web-based pagination.

Parameters:
bDissociatePageSizeAndPrinterPaperSize - true to dissociate, false otherwise

setFitHorizontalPages

void setFitHorizontalPages(boolean bFitHorizontalPages)
For internal use only


setCenter

void setCenter(boolean bCenter)
For internal use only


setScaleOption

void setScaleOption(IPrintOptions.ScaleOptionType scaleOption)
For internal use only