eve.fx.print

Class PrintableObject

java.lang.Object

eve.fx.points.CellPrinter

eve.fx.print.PrintableObject

All Implemented Interfaces:

AlignmentConstants, PointDrawable, PrintCellConstants, Printable, RandomPrintable

Direct Known Subclasses:

PrintPages

public abstract class PrintableObject
extends CellPrinter
implements RandomPrintable

A very useful base class for implementing a Printable object, which can then be printed via a PrintJob.

Field Summary

Fields

Modifier and Type	Field and Description
String	documentName
protected double	drawDPI This is 360 by default, but you can change it to any value you want.
protected static FontManager	fontManager
protected FontManager	myFontManager
protected Printer	myPrinter
PageFormat	preferredFormat
PrinterControl	printerControl A default PrinterControl Object that initially has no values set.

Fields inherited from class eve.fx.points.CellPrinter

dontFreeAfterPrint, page

Fields inherited from interface eve.fx.print.Printable

UNKNOWN_NUMBER_OF_PAGES

Fields inherited from interface eve.fx.AlignmentConstants

BOTTOM, CELLFLAG, CELLMASK, CENTER, CONTROLMASK, DONTCHANGE, DONTFILL, DONTSTRETCH, EAST, FILL, GROW, HCENTER, HCONTRACT, HEXPAND, HFILL, HGROW, HSHRINK, HSTRETCH, INITIALLY_CLOSED, INITIALLY_MINIMIZED, INITIALLY_PREFERRED_SIZE, LEFT, NORTH, NORTHEAST, NORTHWEST, RIGHT, SHRINK, SOUTH, SOUTHEAST, SOUTHWEST, STRETCH, TAG_BACKGROUND_IMAGE, TAG_BORDER, TAG_FIXEDSIZE, TAG_INSETS, TAG_MAXIMUMSIZE, TAG_MINIMUMSIZE, TAG_PREFERREDSIZE, TAG_RECT, TAG_SPAN, TAG_TEXTSIZE, TOP, VCENTER, VCONTRACT, VEXPAND, VFILL, VGROW, VSHRINK, VSTRETCH, WEST

Constructor Summary

Constructors

Constructor and Description
PrintableObject()

Method Summary

Modifier and Type	Method and Description
void	adjustPrinterProperties(PrinterProperties p) Adjust the PrinterProperties as necessary.
int	countPages(PageFormat pf) By default this returns UNKNOWN_NUMBER_OF_PAGES.
String	getDocumentName()
PointDrawable	getPage(PageFormat pf, int pageIndex) Get a PointDrawable for a particular page.
PageFormat	getPreferredFormat() Return the preferred format for printing, or null if there is no preferred format.
protected double	getXdpiFor(int pageIndex)
protected double	getYdpiFor(int pageIndex)
boolean	print(Handle handle, PointGraphics pg, PageFormat page, PointRect areaOnPage, int pageIndex) This is called for each page as the document is being printed.
void	printingComplete() This is called after printing is complete and indicates that the Printable object can release resources associated with it.
void	printingStarting(Printer printer) This is called before printing starts and before countPages() is called.
protected void	setupForPage(PointGraphics pg) Setup the PrintCells within the CellPrinter.
protected abstract boolean	setupForPage(PointGraphics pg, PageFormat format, int pageIndex)
abstract boolean	validatePage(PageFormat page, int pageIndex) This should return true if the page with the specified index should be printed.

Methods inherited from class eve.fx.points.CellPrinter

addCell, addFullImageablePanel, addMarginedPanel, addMarginedPanel, addMarginedPanel, checkSetup, completeSetup, doPrint, doPrint, draw, free, getCurrentCell, getCurrentPage, isSetupFor, print, reset, setPageFormat, setup

Methods inherited from class java.lang.Object

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

Methods inherited from interface eve.fx.print.RandomPrintable

releasePage

Field Detail

documentName

public String documentName

preferredFormat

public PageFormat preferredFormat

printerControl

public PrinterControl printerControl

A default PrinterControl Object that initially has no values set. Any set values in this Object is applied to the PrinterProperties in adjustPrinterProperties().

myPrinter

protected Printer myPrinter

myFontManager

protected FontManager myFontManager

fontManager

protected static FontManager fontManager

drawDPI

protected double drawDPI

This is 360 by default, but you can change it to any value you want. It is used by getXdpiFor() and getYdpiFor().

Constructor Detail

PrintableObject

public PrintableObject()

Method Detail

printingStarting

public void printingStarting(Printer printer)

Description copied from interface: Printable

This is called before printing starts and before countPages() is called.

Specified by:

printingStarting in interface Printable

getPreferredFormat

public PageFormat getPreferredFormat()

Description copied from interface: Printable

Return the preferred format for printing, or null if there is no preferred format.

Specified by:

getPreferredFormat in interface Printable

getDocumentName

public String getDocumentName()

Specified by:

getDocumentName in interface Printable

adjustPrinterProperties

public void adjustPrinterProperties(PrinterProperties p)

Adjust the PrinterProperties as necessary. By default this applies any values set in printerControl.

Specified by:

adjustPrinterProperties in interface Printable

getXdpiFor

protected double getXdpiFor(int pageIndex)

getYdpiFor

protected double getYdpiFor(int pageIndex)

setupForPage

protected abstract boolean setupForPage(PointGraphics pg,
                                        PageFormat format,
                                        int pageIndex)

validatePage

public abstract boolean validatePage(PageFormat page,
                                     int pageIndex)

Description copied from interface: Printable

This should return true if the page with the specified index should be printed. Within this method you can call transform() on the page.

Specified by:

validatePage in interface Printable

setupForPage

protected final void setupForPage(PointGraphics pg)

Description copied from class: CellPrinter

Setup the PrintCells within the CellPrinter. Use getCurrentPage() to get the current page format. Do not alter that PageFormat. After you complete the setup you can either return or you can call completeSetup() after which the absolute positions of all the cells would be set. You can then make any changes as may be necessary before returning.

Specified by:

setupForPage in class CellPrinter

print

public final boolean print(Handle handle,
                           PointGraphics pg,
                           PageFormat page,
                           PointRect areaOnPage,
                           int pageIndex)

Description copied from interface: Printable

This is called for each page as the document is being printed.

Specified by:

print in interface Printable

countPages

public int countPages(PageFormat pf)

By default this returns UNKNOWN_NUMBER_OF_PAGES.

Specified by:

countPages in interface Printable

printingComplete

public void printingComplete()

Description copied from interface: Printable

This is called after printing is complete and indicates that the Printable object can release resources associated with it.

Specified by:

printingComplete in interface Printable

getPage

public PointDrawable getPage(PageFormat pf,
                             int pageIndex)

Description copied from interface: RandomPrintable

Get a PointDrawable for a particular page. This method may modify the provided PageFormat.

Specified by:

getPage in interface RandomPrintable

Parameters:

pf - the PageFormat to be used.

pageIndex - the index of the page - starting from zero.

Returns:

the PointDrawable or null if the page does not exist.