|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.crystaldecisions.sdk.occa.report.document.PrintReportOptions
public class PrintReportOptions
This object provides access to the server-side printing options in the RAS SDK that are available for a report. Server-side printing is available on the server where the RAS SDK is installed.
Printer options are applied in the following order:
PrintOptions
object properties set by the
modifyPrintOptions
method.
PrintReportOptions
object properties set by the
printReport
method.
Note: Print report options are not saved with the report.
Nested Class Summary | |
---|---|
static class |
PrintReportOptions.PageRange
Use this class to specify a printer page range. |
Constructor Summary | |
---|---|
PrintReportOptions()
|
Method Summary | |
---|---|
void |
addPrinterPageRange(PrintReportOptions.PageRange pageRange)
Adds a range of pages to be printed. |
boolean |
getCollated()
Returns true if the printed pages are collated, and false
otherwise. |
java.lang.String |
getJobTitle()
Gets the job title of the print job. |
javax.print.attribute.standard.MediaTray |
getMediaTray()
Returns MediaTray object if the printer has selected tray, null otherwise. |
PrintReportOptions.PageRange |
getNthPrinterPageRange(int idx)
Gets the the specified printer page range. |
int |
getNumberOfCopies()
Gets the number of copies of the report to be printed. |
PaperSize |
getPaperSize()
Gets the paper size. |
PaperSource |
getPaperSource()
Gets the paper source. |
PrinterDuplex |
getPrinterDuplex()
Gets the duplex mode for the print job. |
java.lang.String |
getPrinterName()
Gets the printer name. |
int |
getPrinterPageRangeCount()
Gets the number of printer page ranges. |
void |
removeAllPrinterPageRanges()
Removes all page ranges for this instance of the PrintReportOptions object. |
void |
removeNthPrinterPageRange(int idx)
Removes the specified page range. |
void |
setCollated(boolean collated_)
Sets whether the printed pages are collated. |
void |
setJobTitle(java.lang.String jobTitle)
Sets the title of the print job. |
void |
setMediaTray(javax.print.attribute.standard.MediaTray selectedTray_)
Sets selected tray. |
void |
setNumberOfCopies(int numberOfCopies_)
Sets the number of copies of the report to be printed. |
void |
setPaperSize(PaperSize size)
Sets the paper size. |
void |
setPaperSource(PaperSource source)
Sets the paper source. |
void |
setPrinterDuplex(PrinterDuplex duplex)
Sets the duplex mode for the print job. |
void |
setPrinterName(java.lang.String printerName)
Sets the printer name. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PrintReportOptions()
Method Detail |
---|
public java.lang.String getPrinterName()
Gets the printer name.
String
object that specifies the printer name.public void setPrinterName(java.lang.String printerName)
Sets the printer name.
printerName
- a String
object that specifies the name of the printer to
be set.public PaperSize getPaperSize()
Gets the paper size.
PaperSize
objectpublic void setPaperSize(PaperSize size)
Sets the paper size.
size
- the PaperSize
object whose properties will be set.public PaperSource getPaperSource()
Gets the paper source.
PaperSource
objectpublic void setPaperSource(PaperSource source)
Sets the paper source.
source
- the PaperSource
object whose properties will be set.public PrinterDuplex getPrinterDuplex()
Gets the duplex mode for the print job.
PrinterDuplex
object.public void setPrinterDuplex(PrinterDuplex duplex)
Sets the duplex mode for the print job.
duplex
- the PrinterDuplex
object whose properties will be set.public java.lang.String getJobTitle()
Gets the job title of the print job.
String
object that represents the job title.public void setJobTitle(java.lang.String jobTitle)
Sets the title of the print job.
If this property is not set, the printer will provide a default job title.
jobTitle
- the a String
object that specifies the title of the print job
to be set.public int getPrinterPageRangeCount()
Gets the number of printer page ranges.
int
that specifies the number of page ranges for this instance of
the PrintReportOptions
object.public PrintReportOptions.PageRange getNthPrinterPageRange(int idx)
Gets the the specified printer page range.
This method allows you to access one of the printer page ranges that have been added to the
PrintReportOptions
object. See the
addPrinterPageRange
method for details.
idx
- an int
that specifies the zero-based index of the page range to be
accessed.
PageRange
object specified by the index.public void addPrinterPageRange(PrintReportOptions.PageRange pageRange)
Adds a range of pages to be printed.
You can add multiple printer page ranges to a PrintReportOptions
object. For
example, if you want to print pages 1-2, 4-6, and 7-9, you can add multiple page ranges to
the object by calling the addPrinterPageRange
for each page range. Each page
range will be added in sequence using a zero-based index.
To access any of the printer page ranges, pass in the index to the
getNthPrinterPageRange
method or the
removeNthPrinterPageRange
method.
pageRange
- the PageRange
to be added.public void removeNthPrinterPageRange(int idx)
Removes the specified page range.
This method allows you to access one of the printer page ranges that have been added to the
PrintReportOptions
object. See the
addPrinterPageRange
method for details.
idx
- an int
that specifies zero-based index of the
PageRange
object to be removed.public void removeAllPrinterPageRanges()
Removes all page ranges for this instance of the PrintReportOptions
object.
public int getNumberOfCopies()
Gets the number of copies of the report to be printed.
public void setNumberOfCopies(int numberOfCopies_)
Sets the number of copies of the report to be printed.
numberOfCopies_
- an int
that specifies the number of copies of the
report to be printedpublic boolean getCollated()
Returns true
if the printed pages are collated, and false
otherwise.
true
if the printed pages are collated, and false
otherwise.public void setCollated(boolean collated_)
Sets whether the printed pages are collated.
collated_
- true
if the printed pages are collated, and
false
otherwise.public javax.print.attribute.standard.MediaTray getMediaTray()
Returns MediaTray
object if the printer has selected tray, null otherwise.
MediaTray
object if the printer has selected tray, null otherwise.public void setMediaTray(javax.print.attribute.standard.MediaTray selectedTray_)
Sets selected tray.
selectedTray_
- MediaTray
object.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |