OpenJDK 27 · sun.print.RasterPrinterJob · APIdia, the JavaDoc alternative

Modifier and Type	Class and Description
private static class	RasterPrinterJob.GraphicsState Class to keep state information for redrawing areas "region" is an area at as a high a resolution as possible.

Field Summary

Modifier and Type	Field and Description
protected PrintRequestAttributeSet	attributes attributes used by no-args page and print dialog and print method to communicate state
private BufferedImage	cachedBand
private int	cachedBandHeight
private int	cachedBandWidth Used to minimize GC & reallocation of band when printing
protected boolean	collateAttReq
private int	copiesAttr
public static boolean	debugPrint
private AffineTransform	defaultDeviceTransform
protected String	destinationAttr
private int	deviceHeight
private int	deviceWidth
private static final float	DPI
protected static final int	FILE
private static final String	FORCE_PDL When the system property FORCE_PIPE_PROP has this value then each page of a print job will be rendered through the PDL pipeline.
private static final String	FORCE_PIPE_PROP Useful mainly for debugging, this system property can be used to force the printing code to print using a particular pipeline.
private static final String	FORCE_RASTER When the system property FORCE_PIPE_PROP has this value then each page of a print job will be rendered through the raster pipeline.
public static boolean	forcePDL values obtained from System properties in static initialiser block
public static boolean	forceRaster
private String	jobNameAttr
protected boolean	landscapeRotates270 Device rotation flag, if it support 270, this is set to true;
private static final int	MAX_BAND_SIZE Maximum amount of memory in bytes to use for the buffered image "band".
protected static final int	MAX_UNKNOWN_PAGES Pageable MAX pages
private boolean	mCollate Collation effects the order of the pages printed when multiple copies are requested.
protected String	mDestination
protected int	mDestType
private String	mDocName The name of the job being printed.
protected Pageable	mDocument The document to be printed.
private int	mFirstPage The zero based indices of the first and last pages to be printed.
private int	mLastPage
private int	mNumCopies The number of book copies to be printed.
protected PrintService	myService Service for this job
protected boolean	noJobSheet
private DialogOwner	onTop
protected OutputBin	outputBinAttr
private PageRanges	pageRangesAttr
private long	parentWindowID
protected static final int	PD_ALLPAGES
protected static final int	PD_NOSELECTION
protected static final int	PD_PAGENUMS
protected static final int	PD_SELECTION
protected boolean	performingPrinting Printing cancellation flags
private PrinterGraphicsConfig	pgConfig
private Paper	previousPaper The previous print stream Paper Used to check if the paper size has changed such that the implementation needs to emit the new paper size information into the print stream.
protected static final int	PRINTER
protected PrinterResolution	printerResAttr
private ArrayList<RasterPrinterJob.GraphicsState>	redrawList List of areas & the graphics state for redrawing
private static final String	SHAPE_TEXT_PROP When the system property SHAPE_TEXT_PROP has this value then text is always rendered as a shape, and no attempt is made to match the font through GDI
public static boolean	shapeTextProp
protected Sides	sidesAttr
protected static final int	STREAM
protected boolean	userCancelled
private String	userNameAttr

Access	Constructor and Description
public	RasterPrinterJob()

Method Summary

Modifier and Type	Method and Description
protected abstract void	abortDoc()
private PageFormat	attributeToPageFormat(PrintService service, PrintRequestAttributeSet attSet)
public void	cancel() Implements abstract java.awt.print.PrinterJob.cancel. If a print job is in progress, print() has been called but has not returned, then this signals that the job should be cancelled and the next chance.
protected void	cancelDoc()
private void	clearParentWindowID()
protected Graphics2D	createPathGraphics(PeekGraphics graphics, PrinterJob printerJob, Printable painter, PageFormat pageFormat, int pageIndex) Examine the metrics captured by the `PeekGraphics` instance and if capable of directly converting this print job to the printer's control language or the native OS's graphics primitives, then return a `PathGraphics` to perform that conversion.
protected PeekGraphics	createPeekGraphics(Graphics2D graphics, PrinterJob printerJob) Create and return an object that will gather and hold metrics about the print job.
protected void	debug_println(String str)
public PageFormat	defaultPage(PageFormat page) Implements abstract java.awt.print.PrinterJob.defaultPage. The passed in PageFormat will be copied and altered to describe the default page size and orientation of the PrinterJob's current printer.
protected abstract void	endDoc() Called by the print() method at the end of a print job.
protected abstract void	endPage(PageFormat format, Printable painter, int index) End a page.
protected int	getCollatedCopies() Returns how many times the entire book should be printed by the PrintJob.
public int	getCopies() Implements abstract java.awt.print.PrinterJob.getCopies. Get the number of copies to be printed.
protected int	getCopiesInt()
protected MediaPrintableArea	getDefaultPrintableArea(PageFormat page, double w, double h)
protected int	getFirstPage() Return the zero based index of the first page to be printed in this job.
protected final int	getFromPageAttrib()
public String	getJobName() Implements abstract java.awt.print.PrinterJob.getJobName. Get the name of the document to be printed.
protected String	getJobNameInt()
protected int	getLastPage() Return the zero based index of the last page to be printed in this job.
protected final int	getMaxPageAttrib()
protected MediaSize	getMediaSize(Media media, PrintService service, PageFormat page)
protected final int	getMinPageAttrib()
protected int	getNoncollatedCopies() Returns how many times each page in the book should be consecutively printed by PrintJob.
protected String	getOutputBinValue(Attribute attr)
protected Pageable	getPageable() Return the Pageable describing the pages to be printed.
protected PageFormat	getPageFormatFromAttributes()
private long	getParentWindowID()
protected abstract double	getPhysicalPageHeight(Paper p) Must be obtained from the current printer.
protected abstract double	getPhysicalPageWidth(Paper p) Must be obtained from the current printer.
protected abstract double	getPhysicalPrintableHeight(Paper p) Must be obtained from the current printer.
protected abstract double	getPhysicalPrintableWidth(Paper p) Must be obtained from the current printer.
protected abstract double	getPhysicalPrintableX(Paper p) Must be obtained from the current printer.
protected abstract double	getPhysicalPrintableY(Paper p) Must be obtained from the current printer.
pack-priv synchronized PrinterGraphicsConfig	getPrinterGraphicsConfig()
public PrintService	Returns: the service for this printer job. getPrintService() Overrides java.awt.print.PrinterJob.getPrintService. Returns the service (printer) for this printer job.
protected final int	getSelectAttrib()
protected final int	getToPageAttrib()
public String	getUserName() Implements abstract java.awt.print.PrinterJob.getUserName. Get the name of the printing user.
protected String	getUserNameInt()
protected abstract double	getXRes() Returns the resolution in dots per inch across the width of the page.
protected abstract double	getYRes() Returns the resolution in dots per inch down the height of the page.
protected void	initPrinter()
protected void	initPrinterGraphics(Graphics2D g, Rectangle2D clip) Configure the passed in Graphics2D so that is contains the defined initial settings for a print job.
public boolean	isCancelled() Implements abstract java.awt.print.PrinterJob.isCancelled. Returns `true` if a print job is in progress, but is going to be cancelled at the next opportunity; otherwise returns `false`.
protected boolean	isCollated() Return true if collated copies will be printed as determined in an attribute set.
protected boolean	isSupportedValue(Attribute attrval, PrintRequestAttributeSet attrset)
protected static PrintService	lookupDefaultPrintService()
public PageFormat	Returns: the original `page` object if the dialog is cancelled, or a new PageFormat object containing the format indicated by the user if the dialog is acknowledged pageDialog(PageFormat the default PageFormat presented to the user for modification page) Implements abstract java.awt.print.PrinterJob.pageDialog. Display a dialog to the user allowing the modification of a PageFormat instance.
public PageFormat	pageDialog(final PrintRequestAttributeSet attributes) Overrides java.awt.print.PrinterJob.pageDialog. return a PageFormat corresponding to the updated attributes, or null if the user cancelled the dialog.
public void	print() Implements abstract java.awt.print.PrinterJob.print. Prints a set of pages.
public void	print(PrintRequestAttributeSet attributes) Overrides java.awt.print.PrinterJob.print. Prints a set of pages using the settings in the attribute set.
protected abstract void	printBand(byte[] data, int x, int y, int width, int height) Prints the contents of the array of ints, 'data' to the current page.
public boolean	Returns: false if the user cancels the dialog and true otherwise. printDialog(final PrintRequestAttributeSet to store changed properties. attributes) Overrides java.awt.print.PrinterJob.printDialog. Presents the user a dialog for changing properties of the print job interactively.
public boolean	Returns: false if the user cancels the dialog and true otherwise. printDialog() Implements abstract java.awt.print.PrinterJob.printDialog. Presents the user a dialog for changing properties of the print job interactively.
protected int	Returns: int Printable.PAGE_EXISTS if the page existed and was drawn and Printable.NO_SUCH_PAGE if the page did not exist. printPage(Pageable document, int pageIndex) Print a page from the provided document.
public static String	Returns: the input text, with ignorable whitespace (if any) removed removeControlChars(String the text to process s) Removes ignorable whitespace from the specified text, so that there is no need for platform-specific or font-specific custom whitespace handling, and so that these characters are not treated like control characters which are printed as the missing glyph.
public void	saveState(AffineTransform at, Shape clip, Rectangle2D region, double sx, double sy) save graphics state of a PathGraphics for later redrawing of part of page represented by the region in that state
protected void	setAttributes(PrintRequestAttributeSet attributes)
protected void	setCollated(boolean collate) Set whether copies should be collated or not.
public void	setCopies(int copies) Implements abstract java.awt.print.PrinterJob.setCopies. Set the number of copies to be printed.
protected synchronized void	setGraphicsConfigInfo(AffineTransform at, double pw, double ph)
public void	setJobName(String jobName) Implements abstract java.awt.print.PrinterJob.setJobName. Set the name of the document to be printed.
public void	setPageable(Pageable The document to be printed. It may not be null. document) Implements abstract java.awt.print.PrinterJob.setPageable. The pages in the document to be printed are held by the Pageable instance 'document'.
protected void	setPageRange(int firstPage, int lastPage) Set the range of pages from a Book to be printed.
private void	setParentWindowID(PrintRequestAttributeSet attrs)
public void	setPrintable(Printable Called to render each page of the document. painter) Implements abstract java.awt.print.PrinterJob.setPrintable. The pages in the document to be printed by this PrinterJob are drawn by the Printable object 'painter'.
public void	setPrintable(Printable Called to render each page of the document. painter, PageFormat The size and orientation of each page to be printed. format) Implements abstract java.awt.print.PrinterJob.setPrintable. The pages in the document to be printed by this PrinterJob are drawn by the Printable object 'painter'.
public void	setPrintService(PrintService print service which supports 2D printing. service) Overrides java.awt.print.PrinterJob.setPrintService. Associate this PrinterJob with a new PrintService.
protected void	setXYRes(double x, double y) Set the device resolution.
protected void	spoolToService(PrintService psvc, PrintRequestAttributeSet attributes)
protected abstract void	startDoc() Called by the print() method at the start of a print job.
protected abstract void	startPage(PageFormat format, Printable painter, int index, boolean paperChanged) Begin a new page.
protected void	updateAttributesWithPageFormat(PrintService service, PageFormat page, PrintRequestAttributeSet pageAttributes)
protected void	updatePageAttributes(PrintService service, PageFormat page)
protected void	validateDestination(String dest)
public PageFormat	validatePage(PageFormat page) Implements abstract java.awt.print.PrinterJob.validatePage. The passed in PageFormat is cloned and altered to be usable on the PrinterJob's current printer.
protected void	validatePaper(Paper origPaper, Paper newPaper) updates a Paper object to reflect the current printer's selected paper size and imageable area for that paper size.

Inherited from java.awt.print.PrinterJob:: defaultPage getPageFormat getPrinterJob lookupPrintServices lookupStreamPrintServices

public abstract Class RasterPrinterJob

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary