net.windward.xmlreport

Interface ProcessPrinterAPI

All Superinterfaces:

ProcessReportAPI, ProcessReportAPIBase

All Known Implementing Classes:

ProcessPrinter

public interface ProcessPrinterAPI
extends ProcessReportAPI

Interface for ProcessPrinter.

See Also:

ProcessPrinter

Field Summary

Fields inherited from interface net.windward.xmlreport.ProcessReportAPI

CHARSET_DEFAULT, CHARSET_RTF, CHARSET_UNICODE, COPY_METADATA_ALWAYS, COPY_METADATA_IF_NO_DATASOURCE, COPY_METADATA_NEVER, DATA_MODE_ALL_ATTRIBUTES, DATA_MODE_DATA, DATA_MODE_EMBED, DATA_MODE_INCLUDE_BITMAPS, DATA_MODE_SELECT, ERROR_HANDLING_ALL, ERROR_HANDLING_NONE, ERROR_HANDLING_TRACK_ERRORS, ERROR_HANDLING_VERIFY, HIDDEN_IGNORE_PRINT_RANGE, HIDDEN_SHOW_ALL_ROWS_COLUMNS, HIDDEN_SHOW_HIDDEN_SHEETS, HIDDEN_SHOW_NO_PRINT, HYPHENATE_OFF, HYPHENATE_ON, HYPHENATE_TEMPLATE, LOCALE_DEFAULT, LOCALE_SYSTEM, RENDER_EXTENT_ALL, RENDER_EXTENT_CROP_CONTENT, RENDER_EXTENT_CROP_MARGINS, TAG_STYLE_CONTROL_2007, TAG_STYLE_FIELD, TAG_STYLE_FIELD_2007, TAG_STYLE_TEXT, TYP_CSV, TYP_DOCX, TYP_HTML, TYP_IMAGE, TYP_PDF, TYP_PPTX, TYP_PRINTER, TYP_PS, TYP_RTF, TYP_TXT, TYP_XLSX

Method Summary

Modifier and Type	Method and Description
int	getCopies() Gets the total number of copies to be printed.
PrinterConfiguration.Duplex	getDuplex() Get the printer's duplex setting.
java.lang.String	getFirstPagePrinter() Gets the name of the first page's printer.
int	getFirstPageTray() Gets the tray for the first page.
java.lang.String	getJobName() Get the name of the print job.
java.lang.String	getPrinter() Gets the printer name.
PrinterConfiguration	getPrinterConfiguration() Get the printer configuration for the report.
int	getTray() Gets the tray to be printed to.
void	setCopies(int copies) Sets the total number of copies to be printed.
void	setDuplex(PrinterConfiguration.Duplex value) Set the printer's duplex setting.
void	setFirstPagePrinter(java.lang.String printer) Sets the first page printer.
void	setFirstPageTray(int tray) Sets the tray for the first page.
void	setJobName(java.lang.String name) Set the name of the print job.
void	setPrinter(java.lang.String printer) Sets the printer to the specified printer name.
void	setTray(int tray) Sets the tray to be printed to.

Methods inherited from interface net.windward.xmlreport.ProcessReportAPIBase

batchNext, batchSetup, buildSchema, close, duplicate, findPodsUsed, getBaseDirectory, getCharset, getCopyMetadata, getDataMode, getDataStream, getDescription, getDrillDownInfo, getErrorInfo, getEventHandler, getHiddenMode, getHyphenate, getImportInfo, getKeywords, getLocale, getNumPages, getOutputBuilderData, getParameters, getRenderExtent, getRenderPages, getReport, getReportType, getReportTypeString, getSubject, getTemplateVersion, getTimeout, getTitle, getWriteTags, isCopyEmbeddedObjects, isDebugMode, isLayoutDocument, isPageBasedReport, isPreservePodFraming, isRemoveUnusedFormats, isReportTypeExcel, isReportTypeWord, isTrackImports, isUseExternalOutputBuilder, process, processComplete, processData, processData, processSetup, processSetup, setBaseDirectory, setCharset, setCopyEmbeddedObjects, setCopyMetadata, setDataMode, setDataStream, setDebugMode, setDescription, setDrillDownInfo, setEventHandler, setHiddenMode, setHyphenate, setKeywords, setLayoutDocument, setLocale, setOutputBuilderData, setParameters, setPreservePodFraming, setRemoveUnusedFormats, setRenderExtent, setRenderPages, setSubject, setTemplateVersion, setTimeout, setTitle, setTrackErrors, setTrackImports, setUseExternalOutputBuilder, setWriteTags, updatePods

Method Detail

setPrinter

void setPrinter(java.lang.String printer)

Sets the printer to the specified printer name. The printer name is usually in the form \\server\printer.
If a different printer is associated with the first page, this is the main printer for all pages after the first.

Parameters:

printer - the name of the printer

getPrinter

java.lang.String getPrinter()

Gets the printer name. If a different printer is associated with the first page, this is the main printer for all pages after the first.

Returns:

printer name

setCopies

void setCopies(int copies)

Sets the total number of copies to be printed.

Parameters:

copies - the number of copies to print

getCopies

int getCopies()

Gets the total number of copies to be printed.

Returns:

the number of copies to be printed

setTray

void setTray(int tray)

Sets the tray to be printed to. If a different tray is associated with the first page, this is the main tray for all pages after the first.

Parameters:

tray - main tray

getTray

int getTray()

Gets the tray to be printed to. If a different tray is associated with the first page, this is the main tray for all pages after the first.

Returns:

main tray

setFirstPagePrinter

void setFirstPagePrinter(java.lang.String printer)

Sets the first page printer. Only used when a different printer is required for the first page.

Parameters:

printer - printer name

getFirstPagePrinter

java.lang.String getFirstPagePrinter()

Gets the name of the first page's printer. Only used when a different tray is required for the first page.

Returns:

first-page printer name

setFirstPageTray

void setFirstPageTray(int tray)

Sets the tray for the first page. Only used when a different tray is required for the first page.

Parameters:

tray - first-page tray

getFirstPageTray

int getFirstPageTray()

Gets the tray for the first page. Only used when a different tray is required for the first page.

Returns:

first-page tray

getPrinterConfiguration

PrinterConfiguration getPrinterConfiguration()

Get the printer configuration for the report.

Returns:

Printer configuration used for printing the report.

setJobName

void setJobName(java.lang.String name)

Set the name of the print job. This is an arbitrary name which is passed on to the print job spooler.

Parameters:

name - The print job name.

getJobName

java.lang.String getJobName()

Get the name of the print job.

Returns:

The print job name.

setDuplex

void setDuplex(PrinterConfiguration.Duplex value)

Set the printer's duplex setting.

Parameters:

value - The desired duplex setting.

getDuplex

PrinterConfiguration.Duplex getDuplex()

Get the printer's duplex setting. This returns the currently set value.

Returns:

The duplex setting.