com.gnostice.documents.controls.swing.printer

Class DocumentPrinter

java.lang.Object

com.gnostice.documents.controls.swing.printer.DocumentPrinter

All Implemented Interfaces:

Printable, PropertyChangeListener, Serializable, EventListener

public class DocumentPrinter
extends Object
implements Serializable, Printable, PropertyChangeListener

This class represents the multi-format document printer component. Use print() methods to programmatically print a document. Use the showPrintDialog() to enable the end-user to print the document using an interactive dialog.

Example 1: Programmatically print a document

 import java.io.IOException;

import com.gnostice.core.XDocException;
import com.gnostice.documents.controls.swing.printer.DocumentPrinter;

public class DocumentPrintingDemo {
  static { XDocSetup.activate(); }
  
  public static void main(String[] args) {
    try {
      DocumentPrinter prn = new DocumentPrinter();
      
      if (prn.getAvailablePrinterNames().length > 0) {
        // Load a document
        prn.loadDocument("unicode.docx","");
        // Print to default printer
        prn.print();
        // Unload IO resources used for the document
        prn.closeDocument();
      } else {
        System.out.println("No printer found.");
      }
    } catch (XDocException e) {
      // TODO Auto-generated catch block
      e.printStackTrace();
    } catch (IOException e) {
      // TODO Auto-generated catch block
      e.printStackTrace();
    }
  } 
} 
 

Example 2: Use a print dialog to let the end-user to print a document

import java.io.IOException;

import com.gnostice.core.XDocException;
import com.gnostice.documents.controls.swing.printer.DocumentPrinter;

public class DocumentPrintingDemo {
  static { XDocSetup.activate(); }
  
  public static void main(String[] args) {
    try {
      DocumentPrinter prn = new DocumentPrinter();
      
      if (prn.getAvailablePrinterNames().length > 0) {
        // Load a document
        prn.loadDocument("unicode.docx","");
        // Show print dialog to the end-user
        prn.showPrintDialog();        
        // Unload IO resources used for the document
        prn.closeDocument();
      } else {
        System.out.println("No printer found.");
      }
    } catch (XDocException e) {
      // TODO Auto-generated catch block
      e.printStackTrace();
    } catch (IOException e) {
      // TODO Auto-generated catch block
      e.printStackTrace();
    }
  } 
}

See Also:

Serialized Form

Field Summary

Fields inherited from interface java.awt.print.Printable

NO_SUCH_PAGE, PAGE_EXISTS

Constructor Summary

Constructors

Constructor and Description
DocumentPrinter() Creates a new instance of this class.

Method Summary

Modifier and Type	Method and Description
void	addPrintListener(DocumentPrintListener printListener) Adds specified user-class instance to the list of listeners that needs to be notified of printing events.
void	closeDocument() Closes the current document.
String[]	getAvailablePrinterNames() Returns names of printers.
String	getDefaultPrinterName() Returns name of the default printer.
PrinterPreferences	getPreferences() Returns settings of the current printer.
DocumentPrintListener[]	getPrintListeners() Returns user-class instances that need to be notified of printing events.
DocumentPrintSettings	getPrintSettings() Returns print settings.
boolean	isDocumentLoaded() Returns whether a document has been loaded for printing.
void	loadDocument(InputStream inputStream, String password) Loads a document from specified stream after decrypting it with specified password.
void	loadDocument(String fileName, String password) Loads a document from the specified file after decrypting it with specified password.
void	print() Prints the current document to the current printer.
int	print(Graphics g, PageFormat pageFormat, int printJobIndex)
void	print(PageRangeSettings pageRangeSettings, int numOfCopies) Prints the document with specified page range settings for a specified number of times.
void	print(String printerName, PageRangeSettings pageRangeSettings, int numOfCopies) Prints the document specified number of times to specified printer with specified page range settings.
void	propertyChange(PropertyChangeEvent arg0)
void	removePrintListener(DocumentPrintListener printListener) Removes specified user-class instance from the list of listeners that need to be notified of printing events.
void	showCrossPlatformPrintDialog() Displays the cross-platform printing dialog box.
void	showNativePrintDialog() Displays the printing dialog native to the JVM host.
void	showPrintDialog() Displays the print dialog.
void	showPrintDialog(Dialog owner, boolean modal) Displays the printing dialog box with the specified dialog as the parent container.
void	showPrintDialog(Frame owner, boolean modal) Displays the printing dialog box with the specified frame as the parent container.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentPrinter

public DocumentPrinter()
                throws XDocException

Creates a new instance of this class.

Throws:

XDocException - if an error occurs with the instance

Method Detail

loadDocument

public void loadDocument(String fileName,
                         String password)
                  throws FormatNotSupportedException,
                         IncorrectPasswordException,
                         IOException,
                         XDocException

Loads a document from the specified file after decrypting it with specified password.

Parameters:

fileName - pathname of the file

password - password with which the document needs to be decrypted

Throws:

FormatNotSupportedException - if the document format is not supported

IncorrectPasswordException - if the password is not correct

IOException - if an I/O error occurs

XDocException - if an error occurs in processing the document

loadDocument

public void loadDocument(InputStream inputStream,
                         String password)
                  throws FormatNotSupportedException,
                         IncorrectPasswordException,
                         XDocException,
                         IOException

Loads a document from specified stream after decrypting it with specified password.

Parameters:

inputStream - stream from which a document needs to be loaded

password - password with which the document needs to be decrypted

Throws:

FormatNotSupportedException - if the document format is not supported

IncorrectPasswordException - if the password is not correct

XDocException - if an error occurs in processing the document

IOException - if an I/O error occurs

isDocumentLoaded

public boolean isDocumentLoaded()

Returns whether a document has been loaded for printing.

Returns:

true if a document has been loaded; false if otherwise

print

public void print()
           throws XDocException,
                  IOException,
                  PrinterException

Prints the current document to the current printer.

Throws:

XDocException - if an error occurs in processing the document

IOException - if an I/O error occurs

PrinterException - if an error occurs with the printer

print

public int print(Graphics g,
                 PageFormat pageFormat,
                 int printJobIndex)
          throws PrinterException

Specified by:

print in interface Printable

Throws:

PrinterException

print

public void print(PageRangeSettings pageRangeSettings,
                  int numOfCopies)
           throws XDocException,
                  PrinterException,
                  IOException

Prints the document with specified page range settings for a specified number of times.

Parameters:

pageRangeSettings - page range settings

numOfCopies - number of copies

Throws:

XDocException - if an error occurs in processing the document

PrinterException - if an error occurs with the printer

IOException - if an I/O error occurs

print

public void print(String printerName,
                  PageRangeSettings pageRangeSettings,
                  int numOfCopies)
           throws XDocException,
                  PrinterException,
                  IOException

Prints the document specified number of times to specified printer with specified page range settings.

Parameters:

printerName - name of the printer

pageRangeSettings - page range settings

numOfCopies - number of copies

Throws:

XDocException - if an error occurs in processing the document

PrinterException - if an error occurs with the printer

IOException - if an I/O error occurs

closeDocument

public void closeDocument()

Closes the current document.

getAvailablePrinterNames

public String[] getAvailablePrinterNames()

Returns names of printers.

Returns:

array containing the names of the printers

getDefaultPrinterName

public String getDefaultPrinterName()

Returns name of the default printer.

Returns:

name of the default printer

getPrintSettings

public DocumentPrintSettings getPrintSettings()

Returns print settings.

Returns:

current print settings

addPrintListener

public void addPrintListener(DocumentPrintListener printListener)

Adds specified user-class instance to the list of listeners that needs to be notified of printing events.

Parameters:

printListener - user-class instance that needs to be added

removePrintListener

public void removePrintListener(DocumentPrintListener printListener)

Removes specified user-class instance from the list of listeners that need to be notified of printing events.

Parameters:

printListener - user-class instance that needs to be removed

getPrintListeners

public DocumentPrintListener[] getPrintListeners()

Returns user-class instances that need to be notified of printing events.

Returns:

an array containing the user-class instances

showCrossPlatformPrintDialog

public void showCrossPlatformPrintDialog()
                                  throws XDocException,
                                         IOException,
                                         PrinterException

Displays the cross-platform printing dialog box.

Throws:

XDocException - if the component encounters an error

IOException - if an I/O error occurs

PrinterException - if an error occurs in printing

showNativePrintDialog

public void showNativePrintDialog()
                           throws XDocException,
                                  IOException,
                                  PrinterException

Displays the printing dialog native to the JVM host.

Throws:

XDocException - if the component encounters an error

IOException - if an I/O error occurs

PrinterException - if an error occurs in printing

showPrintDialog

public void showPrintDialog()
                     throws XDocException

Displays the print dialog.

Throws:

XDocException - if the component encounters an error

showPrintDialog

public void showPrintDialog(Frame owner,
                            boolean modal)
                     throws XDocException

Displays the printing dialog box with the specified frame as the parent container.

Parameters:

owner - the parent container

modal - whether the dialog box is a model window

Throws:

XDocException - if the component encounters an error

showPrintDialog

public void showPrintDialog(Dialog owner,
                            boolean modal)
                     throws XDocException

Displays the printing dialog box with the specified dialog as the parent container.

Parameters:

owner - parent container

modal - whether the dialog box is a model window

Throws:

XDocException - if the component encounters an error

getPreferences

public PrinterPreferences getPreferences()

Returns settings of the current printer.

Returns:

current printer settings

propertyChange

public void propertyChange(PropertyChangeEvent arg0)

Specified by:

propertyChange in interface PropertyChangeListener