com.lf.commons.printing

Class PrintingManager

java.lang.Object

com.lf.commons.printing.PrintingManager

public class PrintingManager
extends java.lang.Object

Provides printing support for applications based on the JasperReports library.

Printing is possible if the supported libraries are in the classpath (Jasper and iText for PDF export).

Since:

1.6

Version:

$Revision: 1.17 $, $Date: 2016/01/01 15:43:02 $

Author:

Axel Schwolow

Constructor Summary

Constructors

Constructor and Description
PrintingManager() Constuctor method for the manager.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	finalize() Clean-up method to help the gc.
static javax.print.PrintService	findPrinter(java.lang.String name) Looks for a certain print service by its name.
static javax.print.PrintService[]	getAvailablePrinters() Provides the list of printers installed for the system.
boolean	isPDFSupported() Checks if the PDF engine is currently available (iText).
static boolean	isPrinterAvailable(java.lang.String name, boolean checkready) Checks if a certain printer is up and running for this system.
boolean	isPrintingSupported() Checks if the printing engine is currently available (Jasper).
static void	main(java.lang.String[] arg) This may be used especially for debugging purposes.
boolean	preview(boolean merge, javax.print.PrintService service, java.awt.Component comp, boolean openpdf, java.util.Vector<PrintingJob> jobs, BackgroundTask bgtask) Displays the given printing pages using a dialog, pages can be printed/exported from there.
boolean	preview(boolean merge, javax.print.PrintService service, java.awt.Component comp, DockingManager manager, BackgroundTask bgtask, boolean openpdf) Generates the printing pages and prints them using a dialog, pages can be printed/exported from there.
boolean	print(boolean merge, javax.print.PrintService service, DockingManager manager, BackgroundTask bgtask) Generates the printing pages and prints directly using the OS specific printing functionality.
boolean	print(boolean merge, javax.print.PrintService service, java.util.Vector<PrintingJob> jobs) Prints the given printing pages directly using the OS specific printing functionality.
boolean	processAuto(boolean merge, javax.print.PrintService service, java.awt.Component comp, DockingManager manager, BackgroundTask bgtask, boolean preview, boolean openpdf) Processes the given printing job based on the application configuration settings.
static java.lang.String	setupFontDirectory() Sets the directory to find fonts used by JasperReports.
protected void	showNoPagesDialog(java.awt.Component comp) Gives the user a hint that no printing pages are available.
protected void	showPreviewer(javax.print.PrintService service, java.awt.Component comp, java.util.Vector<PrintingJob> jobs, boolean openpdf, BackgroundTask bgtask, boolean merge, DockingManager manager) Shows the preview dialog.

Methods inherited from class java.lang.Object

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

Constructor Detail

PrintingManager

public PrintingManager()

Constuctor method for the manager.

Since:

1.6

Method Detail

finalize

protected void finalize()
                 throws java.lang.Throwable

Clean-up method to help the gc.

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable - Error indication

Since:

1.6

isPrintingSupported

public boolean isPrintingSupported()

Checks if the printing engine is currently available (Jasper).

Returns:

Printing supported?

Since:

1.6

isPDFSupported

public boolean isPDFSupported()

Checks if the PDF engine is currently available (iText).

Returns:

PDF generation supported?

Since:

1.6

getAvailablePrinters

public static javax.print.PrintService[] getAvailablePrinters()

Provides the list of printers installed for the system.

Returns:

The printers

Since:

1.6

isPrinterAvailable

public static boolean isPrinterAvailable(java.lang.String name,
                         boolean checkready)

Checks if a certain printer is up and running for this system.

Parameters:

name - Printer name to check

checkready - Check if printer is ready, too?

Returns:

Printer available?

Since:

1.6

findPrinter

public static javax.print.PrintService findPrinter(java.lang.String name)

Looks for a certain print service by its name.

Parameters:

name - Printer name to check

Returns:

Print service, null if not available

Throws:

java.lang.NullPointerException - If a parameter is null

Since:

1.6

setupFontDirectory

public static java.lang.String setupFontDirectory()

Sets the directory to find fonts used by JasperReports.

The font directory depends on the system (Windows, UNIX, ...)

Returns:

The font path, null if not available

Since:

1.6

print

public boolean print(boolean merge,
            javax.print.PrintService service,
            java.util.Vector<PrintingJob> jobs)

Prints the given printing pages directly using the OS specific printing functionality.

Here no printing preview is displayed. If the jobs shall be merged all pages must have the same size and pixel density. Only the orientation may vary and is automatically converted based on the settings of the first printing job.

Parameters:

merge - Shall the separate jobs be merged?

service - The service to use, per dialog otherwise

jobs - The containers with printing pages

Returns:

Successful?

Since:

1.6

print

public boolean print(boolean merge,
            javax.print.PrintService service,
            DockingManager manager,
            BackgroundTask bgtask)

Generates the printing pages and prints directly using the OS specific printing functionality.

Here no printing preview is displayed. If the jobs shall be merged all pages must have the same size and pixel density. Only the orientation may vary and is automatically converted based on the settings of the first printing job.

Parameters:

merge - Shall the separate jobs be merged?

service - The service to use, per dialog otherwise

manager - The docking component (status bar etc.)

bgtask - The task to generate printing pages, must implement PrintingTask

Returns:

Successful?

Since:

1.6

preview

public boolean preview(boolean merge,
              javax.print.PrintService service,
              java.awt.Component comp,
              boolean openpdf,
              java.util.Vector<PrintingJob> jobs,
              BackgroundTask bgtask)

Displays the given printing pages using a dialog, pages can be printed/exported from there.

Here a printing preview is displayed. If the jobs shall be merged all pages must have the same size and pixel density. Only the orientation may vary and is automatically converted based on the settings of the first printing job.

If the underlying task is specified then the preview may be refreshed by calling the task again with modified parameters like another orientation.

Parameters:

merge - Shall the separate jobs be merged?

service - The service to use, per dialog otherwise

comp - The component to search the parental window

openpdf - Show PDF viewer?

jobs - The containers with printing pages

bgtask - The task to generate printing pages, must implement PrintingTask (optional)

Returns:

Successful?

Throws:

java.lang.NullPointerException - If a parameter is null

Since:

1.6

preview

public boolean preview(boolean merge,
              javax.print.PrintService service,
              java.awt.Component comp,
              DockingManager manager,
              BackgroundTask bgtask,
              boolean openpdf)

Generates the printing pages and prints them using a dialog, pages can be printed/exported from there.

Here a printing preview is displayed. If the jobs shall be merged all pages must have the same size and pixel density. Only the orientation may vary and is automatically converted based on the settings of the first printing job.

If the custom component is specified the dialog is assumed on the screen which is refreshing the printing pages with different parameters.

Parameters:

merge - Shall the separate jobs be merged?

service - The service to use, per dialog otherwise

comp - The component to search the parental window

manager - The docking component (status bar etc.)

bgtask - The task to generate printing pages, must implement PrintingTask

openpdf - Show PDF viewer?

Returns:

Successful?

Throws:

java.lang.NullPointerException - If a parameter is null

Since:

1.6

processAuto

public boolean processAuto(boolean merge,
                  javax.print.PrintService service,
                  java.awt.Component comp,
                  DockingManager manager,
                  BackgroundTask bgtask,
                  boolean preview,
                  boolean openpdf)

Processes the given printing job based on the application configuration settings.

The options can be configured either to display a preview or to print directly. This should be the best way to let the application handle printing consistently.

Parameters:

merge - Shall the separate jobs be merged?

service - The service to use, per dialog otherwise

comp - The component to search the parental window

manager - The docking component (status bar etc.)

bgtask - The task to generate printing pages, must implement PrintingTask

preview - Show the preview? Direct printing otherwise.

openpdf - Show PDF viewer?

Returns:

Successful?

Throws:

java.lang.NullPointerException - If a parameter is null

Since:

1.6

showNoPagesDialog

protected void showNoPagesDialog(java.awt.Component comp)

Gives the user a hint that no printing pages are available.

Parameters:

comp - The component to search the parental window

Since:

1.6

showPreviewer

protected void showPreviewer(javax.print.PrintService service,
                 java.awt.Component comp,
                 java.util.Vector<PrintingJob> jobs,
                 boolean openpdf,
                 BackgroundTask bgtask,
                 boolean merge,
                 DockingManager manager)

Shows the preview dialog.

If the underlying task is specified then the preview may be refreshed by calling the task again with modified parameters like another orientation.

Parameters:

comp - The component to search the parental window

service - The service to use, per dialog otherwise

jobs - The containers with printing pages

openpdf - Show PDF viewer?

bgtask - The task to generate printing pages, must implement PrintingTask (optional)

merge - Shall the separate jobs be merged?

manager - The docking component (status bar etc.)

Since:

1.6

main

public static void main(java.lang.String[] arg)

This may be used especially for debugging purposes.

Parameters:

arg - Array of String objects with console params

Since:

1.6