com.glaivestone.javax.awt.print
Class TranslatedPrintable

java.lang.Object
  |
  +--com.glaivestone.javax.awt.print.TranslatedPrintable

All Implemented Interfaces:

java.awt.print.Printable

public class TranslatedPrintable

extends java.lang.Object

implements java.awt.print.Printable

This class's sole responsibility is to translate the coordinate system before invoking a canvas's painter. The coordinate system is translated in order to get the desired portion of a canvas to line up with the top of a page.

This class is used by JComponentPrinter.

Version:

1.0

Author:

Gary Gregory

See Also:

com.glaivestone.javax.swing.JComponentPrinter

Field Summary

Fields inherited from interface java.awt.print.Printable

NO_SUCH_PAGE, PAGE_EXISTS

Constructor Summary

TranslatedPrintable(java.awt.print.Printable painter, java.awt.geom.Point2D origin)
Create a new Printable that will translate the drawing done by painter on to the imageable area of a page.

Method Summary

java.awt.geom.Point2D	getOrigin() Get the upper-left corner of the part of the canvas that will be displayed on this page.
java.awt.print.Printable	getPrintable() Get object that will draw the canvas.
int	print(java.awt.Graphics graphics, java.awt.print.PageFormat aPageFormat, int pageIndex) Prints the page at the specified index into the specified Graphics context in the specified format.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TranslatedPrintable

public TranslatedPrintable(java.awt.print.Printable painter,
                           java.awt.geom.Point2D origin)

Create a new Printable that will translate the drawing done by painter on to the imageable area of a page.

Parameters:

painter - The object responsible for drawing the canvas

origin - The point in the canvas that will be mapped to the upper-left corner of the page's imageable area.

Method Detail

print

public int print(java.awt.Graphics graphics,
                 java.awt.print.PageFormat aPageFormat,
                 int pageIndex)
          throws java.awt.print.PrinterException

Prints the page at the specified index into the specified Graphics context in the specified format.

A PrinterJob calls the Printableinterface to request that a page be rendered into the context specified by graphics. The format of the page to be drawn is specified by pageFormat. The zero based index of the requested page is specified by pageIndex. If the requested page does not exist then this method returns NO_SUCH_PAGE; otherwise PAGE_EXISTS is returned.

The Graphics class or subclass implements the PrinterGraphics interface to provide additional information. If the Printable object aborts the print job then it throws a PrinterException.

Specified by:

print in interface java.awt.print.Printable

Parameters:

graphics - the context into which the page is drawn

pageIndex - the zero based index of the page to be drawn

Returns:

PAGE_EXISTS if the page is rendered successfully or NO_SUCH_PAGE if pageIndex specifies a non-existent page.

Throws:

java.awt.print.PrinterException - thrown when the print job is terminated.

getOrigin

public java.awt.geom.Point2D getOrigin()

Get the upper-left corner of the part of the canvas that will be displayed on this page. This corner is lined up with the upper-left of the imageable area of the page.

getPrintable

public java.awt.print.Printable getPrintable()

Get object that will draw the canvas.