eve.fx.print

Class BatchPrinter

java.lang.Object

java.util.Vector

eve.fx.print.BatchPrinter

All Implemented Interfaces:

Printable, RandomPrintable, Serializable, Cloneable, Collection

public class BatchPrinter
extends Vector
implements RandomPrintable

Author:

Michael L Brereton

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
String	documentName
protected Printer	myPrinter
int[]	numPages
PrinterControl	printerControl A default PrinterControl Object that initially has no values set.

Fields inherited from class java.util.Vector

capacityIncrement, elementCount, elementData

Fields inherited from interface eve.fx.print.Printable

UNKNOWN_NUMBER_OF_PAGES

Fields inherited from interface java.io.Serializable

serialVersionUID

Constructor Summary

Constructors

Constructor and Description
BatchPrinter(String docName)

Method Summary

Modifier and Type	Method and Description
void	adjustPrinterProperties(PrinterProperties p) Adjust the PrinterProperties as necessary.
int	countPages(PageFormat page) This is called when printing is about to start and it requests a count of the number of pages that would be necessary to print.
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.
boolean	print(Handle handle, PointGraphics g, 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.
void	releasePage(PointDrawable pd)
boolean	validatePage(PageFormat page, int pageIndex) This should return true if the page with the specified index should be printed.

Methods inherited from class java.util.Vector

add, add, addAll, addAll, addElement, capacity, clear, clone, contains, containsAll, copyInto, elementAt, elements, ensureCapacity, firstElement, get, indexOf, indexOf, insertElementAt, isEmpty, iterator, lastElement, lastIndexOf, lastIndexOf, remove, removeAll, removeAllElements, removeElement, removeElementAt, retainAll, setElementAt, setSize, size, toArray, toArray, toString, trimToSize

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

equals, hashCode

Field Detail

documentName

public String documentName

numPages

public int[] numPages

myPrinter

protected Printer myPrinter

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().

Constructor Detail

BatchPrinter

public BatchPrinter(String docName)

Method Detail

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

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

print

public boolean print(Handle handle,
                     PointGraphics g,
                     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

validatePage

public 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

countPages

public int countPages(PageFormat page)

Description copied from interface: Printable

This is called when printing is about to start and it requests a count of the number of pages that would be necessary to print. If this is unknown then the method should return UNKNOWN_NUMBER_OF_PAGES, but even if it returns a valid number of pages, the validatePage() method will still be called before each page is printed via print().

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

getDocumentName

public String getDocumentName()

Specified by:

getDocumentName 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

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.

releasePage

public void releasePage(PointDrawable pd)

Specified by:

releasePage in interface RandomPrintable