Drucken in Java, Teil 1

Zurück 1 2 Page 2 Seite 2 von 2

Modelle rendern

In Java gibt es zwei Druckmodelle: PrintableJobs und PageableJobs.

Ausdrucke

PrintableJobs sind das einfachere der beiden Druckmodelle. Dieses Modell verwendet nur eine PagePainterfür das gesamte Dokument. Die Seiten werden nacheinander gerendert, beginnend mit Seite Null. Wenn die letzte Seite gedruckt wird, PagePaintermüssen Sie den NO_SUCH_PAGEWert zurückgeben. Das Drucksubsystem fordert die Anwendung immer auf, die Seiten nacheinander zu rendern. Wenn Ihre Anwendung beispielsweise aufgefordert wird, die Seiten fünf bis sieben zu rendern, fordert das Drucksubsystem alle Seiten bis zur siebten Seite an, druckt jedoch nur die Seiten fünf, sechs und sieben. Wenn in Ihrer Anwendung ein Druckdialogfeld angezeigt wird, wird die Gesamtzahl der zu druckenden Seiten nicht angezeigt, da die Anzahl der Seiten im Dokument mit diesem Modell nicht im Voraus bekannt ist.

Pageables

PageableJobs bieten mehr Flexibilität als PrintableJobs, da jede Seite in einem PageableJob ein anderes Layout aufweisen kann. PageableJobs werden am häufigsten mit Books verwendet, einer Sammlung von Seiten, die unterschiedliche Formate haben können. Ich werde die BookKlasse gleich erklären .

Ein PageableJob hat folgende Eigenschaften:

  • Jede Seite kann einen eigenen Maler haben. Sie könnten beispielsweise einen Maler zum Drucken des Deckblatts implementieren lassen, einen anderen Maler zum Drucken des Inhaltsverzeichnisses und einen dritten zum Drucken des gesamten Dokuments.
  • Sie können für jede Seite im Buch ein anderes Seitenformat festlegen. In einem PageableJob können Sie Hoch- und Querformatseiten mischen.
  • Das Drucksubsystem fordert Ihre Anwendung möglicherweise auf, Seiten außerhalb der Reihenfolge zu drucken, und einige Seiten werden bei Bedarf möglicherweise übersprungen. Auch hier müssen Sie sich keine Sorgen machen, solange Sie bei Bedarf eine Seite in Ihrem Dokument bereitstellen können.
  • Der PageableJob muss nicht wissen, wie viele Seiten das Dokument enthält.

Bücher

Ebenfalls neu seit Version 1.2 ist die BookKlasse. Mit dieser Klasse können Sie mehrseitige Dokumente erstellen. Jede Seite kann ein eigenes Format und einen eigenen Maler haben, sodass Sie flexibel anspruchsvolle Dokumente erstellen können. Da die BookKlasse die PageableSchnittstelle implementiert , können Sie Ihre eigene BookKlasse implementieren, wenn der bereitgestellten BookKlasse die erforderlichen Funktionen fehlen.

Eine BookKlasse repräsentiert eine Sammlung von Seiten. Beim ersten Erstellen ist das BookObjekt leer. Zum Hinzufügen von Seiten verwenden Sie einfach eine der beiden append()Methoden (weitere Informationen finden Sie in meiner Erläuterung dieser Klasse im API-Abschnitt). Die Parameter dieser Methode sind das PageFormatObjekt, das die physikalischen Eigenschaften der Seite definiert, und ein PagePainterObjekt, das die PrintableSchnittstelle implementiert . Wenn Sie die Anzahl der Seiten in Ihrem Dokument nicht kennen, übergeben Sie den UNKNOWN_NUMBER_OF_PAGESWert einfach an die append()Methode. Das Druckersystem ermittelt automatisch die Anzahl der Seiten, indem es alle Seitenmaler im Buch anruft, bis es einen NO_SUCH_PAGEWert erhält .

API-Definition

Theorie und Praxis werden sich in diesem Abschnitt treffen. In den vorherigen Abschnitten haben wir uns mit Seitenstruktur, Maßeinheiten und Rendering-Modellen vertraut gemacht. In diesem Abschnitt werden wir uns die Java-Druck-API ansehen.

Alle zum Drucken erforderlichen Klassen befinden sich im java.awt.printPaket, das aus drei Schnittstellen und vier Klassen besteht. Die folgenden Tabellen definieren die Klassen und Schnittstellen des Druckpakets.

Name Art Beschreibung
Paper Klasse Diese Klasse definiert die physikalischen Eigenschaften der Seite.
PageFormat Klasse PageFormatDefiniert die Größe und Ausrichtung der Seite. Außerdem wird definiert, welche Paperbeim Rendern einer Seite verwendet werden soll.
PrinterJob Klasse

Diese Klasse verwaltet den Druckauftrag. Zu seinen Aufgaben gehören das Erstellen eines Druckauftrags, das Anzeigen eines Druckdialogfelds bei Bedarf und das Drucken des Dokuments.

Book Klasse

Bookrepräsentiert ein Dokument. Ein BookObjekt fungiert als Sammlung von Seiten. Die in der BookDose enthaltenen Seiten können identische oder unterschiedliche Formate haben und unterschiedliche Maler verwenden.

Pageable Schnittstelle Eine PageableImplementierung repräsentiert eine Reihe von Seiten, die gedruckt werden sollen. Das PageableObjekt gibt die Gesamtzahl der Seiten im Satz sowie das PageFormatund Printablefür eine bestimmte Seite zurück. Die BookKlasse implementiert diese Schnittstelle.
Printable Schnittstelle Ein Seitenmaler muss die PrintableSchnittstelle implementieren . Es gibt nur eine Methode in dieser Schnittstelle print().
PrinterGraphics Schnittstelle Das GraphicsObjekt implementiert diese Schnittstelle. PrinterGraphicsBietet die getPrinterJob()Methode zum Abrufen des Druckerauftrags, der den Druckvorgang instanziiert hat.

Pageable Schnittstelle

Die PageableSchnittstelle enthält drei Methoden:

Methodenname Beschreibung
int getNumberOfPages() Gibt die Anzahl der Seiten im Dokument zurück.
PageFormat getPageFormat(int pageIndex) Gibt die von PageFormatangegebenen Seiten zurück pageIndex.
Printable getPrintable(int pageIndex) Gibt die PrintableInstanz zurück, die für das Rendern der angegebenen Seite verantwortlich ist pageIndex.

Druckbare Oberfläche

Die PrintableSchnittstelle verfügt über eine Methode und zwei Werte:

Name Art Beschreibung
int print(Graphics graphics, PageFormat pageFormat, int pageIndex) Methode

Fordert das Grafikhandle mit dem angegebenen Seitenformat auf, die angegebene Seite zu rendern.

NO_SUCH_PAGE Wert Dies ist eine Konstante. Geben Sie diesen Wert zurück, um anzuzeigen, dass keine Seiten mehr gedruckt werden müssen.
PAGE_EXISTS Wert Die print()Methode gibt zurück PAGE_EXISTS. Es zeigt an, dass die als Parameter übergebene Seite print()gerendert wurde und existiert.

Jeder Seitenmaler muss die PrintableSchnittstelle implementieren . Da es nur eine Methode zum Implementieren gibt, kann das Erstellen von Seitenmalern einfach erscheinen. Denken Sie jedoch daran, dass Ihr Code in der Lage sein muss, jede Seite in oder außerhalb der Reihenfolge zu rendern.

Es gibt drei Parameter print(), einschließlich Graphicsderselben Klasse, die zum Zeichnen auf dem Bildschirm verwendet wird. Da die GraphicsKlasse die PrinterGraphicSchnittstelle implementiert , können Sie PrinterJobdiejenige erhalten, die diesen Druckauftrag instanziiert hat. Wenn Ihr Seitenlayout komplex ist und einige erweiterte Zeichenfunktionen erfordert, können Sie den GraphicsParameter in ein Graphics2DObjekt umwandeln. Sie haben dann Zugriff auf die vollständige Java 2D-API.

Before you start using the Graphics object, note that the coordinates are not translated to the top left corner of the printable area. Refer to Figure 3 to find the location of the default origin.

(0, 0) appears at the top left corner of the printer margins. To print a 1-by-1-inch rectangle, 1 inch from both top and left margins, you would use the following code:

1: public int print (Graphics graphics, PageFormat pageFormat, int pageIndex) { 2: Graphics2D graphics2D = (Graphics2D) graphics; 3: Rectangle2D.Double rectangle = new Rectangle2D.Double (); 4: rectangle.setRect (pageFormat.getImageableX () + 72, 5: pageFormat.getImageableY () + 72, 6: 72, 7: 72); 8: graphics2D.draw (rectangle); 9: return (PAGE_EXISTS); }

From the previous example, we see that we must manually translate the origin of the rectangle so that it prints at the top of the printable area as in Figure 1. To simplify the code, we could translate the coordinates once and use (0, 0) as the origin of the printable area. By modifying the previous example, we get:

1: public int print (Graphics graphics, PageFormat pageFormat, int pageIndex) { 2: Graphics2D graphics2D = (Graphics2D) graphics; 3: graphics2D.translate (pageFormat.getImageableX (), pageFormat.getImageableY ()); 4: Rectangle2D.Double rectangle = new Rectangle2D.Double (); 5: rectangle.setRect (72, 72, 72, 72); 6: graphics2D.draw (rectangle); 7: return (PAGE_EXISTS); 8: }

Using the translate() method in line 3, we can translate the coordinates and set our origin (0, 0) at the top of the printable area. From this point on, our code will be simplified.

PrinterGraphics interface

The PrinterGraphics interface consists of one method:

Method name Description
PrinterJob getPrinterJob() Returns the PrinterJob for this rendering request and is implemented by the Graphics class

Paper class

Eight methods make up the Paper class:

Method name Description
double getHeight() This method returns the page's physical height in points (1 inch = 72 points). For example, if you are printing on a letter-size page, the return value will be 792 points, or 11 inches.
double getImageableHeight() This method returns the page's imageable height. The imageable height is the height of the print area that you may draw on. See Figure 1 for a graphical view of the imageable area.
double getImageableWidth() This method returns a page's imageable width (the width of the print area that you may draw on). See Figure 1 for a graphical view of the imageable area.
double getImageableX() This method returns the x origin of the imageable area. Since there is no support for margins, the return value represents the left margin.
double getImageableY() This method returns the y origin of the imageable area. The value returned from this method is equivalent to the top margin.
double getWidth() This method returns the page's physical width in points. If you print on a letter-size paper, the width is 8.5 inches, or 612 points.
void setImageableArea(double x, double y, double width, double height) This method sets the imageable area and specifies the margins on the page. Actually, the API provides no method to set the margins explicitly; you have to calculate them yourself.
void setSize(double width, double height) This method sets the physical page size. To define an 8.5-by-11-inch sheet, you would supply 612 and 792 points. Note that the default size is LETTER.

Before we move on to the next section, remember that the Paper class defines the page's physical characteristics. The PageFormat class represents all the page's characteristics, such as page orientation, size, and the paper type. This class is always passed as a parameter to the Printable interface's print() method. Use Paper to obtain the imageable area location, size, and page orientation along with a transformation matrix.

PageFormat class

The PageFormat consists of 12 methods:

Method name Description
double getHeight() This method returns the page's physical height in points (1 inch = 72 points). If your page measures 8.5 by 11 inches, then the return value will be 792 points, or 11 inches.
double getImageableHeight() This method returns the page's imageable height, which is the height of the print area on which you may draw. See Figure 1 for a graphical view of the imageable area.
double getImageableWidth() This method returns the page's imageable width -- the width of the print area on which you may draw. Figure 1 illustrates a graphical view of the imageable area.
double getImageableX() This method returns the x origin of the imageable area.
double getImageableY() This method returns the imageable area's y origin.
double getWidth() This method returns the page's physical width in points. If you print on letter-sized paper, the width is 8.5 inches, or 612 points.
double getHeight() This method returns the page's physical height in points. For example, letter-sized paper is 11 inches in height, or 792 points.
double[] getMatrix() This method returns a transformation matrix that translates user space into the requested page orientation. The return value is in the format required by the AffineTransform constructor.
int getOrientation() This method returns the orientation of the page as either PORTRAIT or LANDSCAPE.
void setOrientation(int orientation) This method sets the orientation of the page, using the constants PORTRAIT and LANDSCAPE.
Paper getPaper() This method returns the Paper object associated with the page format. Refer to the previous section for a description of the Paper class.
void setPaper(Paper paper) This method sets the Paper object that will be used by the PageFormat class. PageFormat must have access to the physical page characteristics to complete this task.

This concludes the description of the page classes. The next class that we will study is the PrinterJob.

PrinterJob class

The PrinterJob class controls the printing process. It can both instantiate and control a print job. Below you will find a definition of the class:

Method name Description
abstract void cancel() This method cancels the current print job. You can validate the cancellation with the isCancel() method.
abstract boolean isCancelled() This method returns true if the job is cancelled.
PageFormat defaultPage() This method returns the default page format for the PrinterJob.
abstract PageFormat defaultPage(PageFormat page) This method clones the PageFormat passed in parameters and modifies the clone to create the default PageFormat.
abstract int getCopies() This method returns the number of copies that the print job will print.
abstract void setCopies(int copies) This method sets the number of copies that the job will print. Note that if you show a print dialog box, users can alter the number of copies (see the pageDialog method).
abstract String getJobName() This method returns the job name.
static PrinterJob getPrinterJob() This method creates and returns a new PrinterJob.
abstract String getUserName() This method returns the user name associated with the print job.
abstract PageFormat pageDialog(PageFormat page) This method displays a dialog that allows the user to modify the PageFormat. The PageFormat, passed in parameters, sets the fields of the dialog. If the user cancels the dialog, then the original PageFormat will be returned. But if the user accepts the parameters, then a new PageFormat will be created and returned. Since it will not show the same parameters on all operating systems, you must be careful when using the pageDialog.
abstract void setPageable(Pageable document) This method queries the document to obtain the total number of pages. The Pageable will also return the PageFormat and the Printable object for each page. See the definition of the Pageable interface for more information.
abstract void setPrintable(Printable painter) This method sets the Painter object that will render the pages to be printed. A Painter object is an object that implements the Printable class and its print() method.
abstract void setPrintable(Printable painter, PageFormat format) This method completes the same tasks as abstract void setPrintable(Printable painter), except that you supply the PageFormat that the Painter will use. As indicated in the definition of the Printable interface, the print() method passes a PageFormat object as the first parameter.
abstract void print() This method prints the document. It actually calls the print() method of the Painter previously assigned to this print job.
abstract void setJobName(String jobName) This method sets the name of the print job.
abstract boolean printDialog() This method displays a print dialog box that allows the user to change the print parameters. Note that this interaction's result will not be returned to your program. Instead, it will be passed to the peer operating system.
abstract PageFormat validatePage(PageFormat page) This method will validate the PageFormat passed in parameters. If the printer cannot use the PageFormat that you supplied, then a new one that conforms to the printer will be returned.

Book class

Seven methods make up the Book class:

>

Method name Description
void append(Printable painter, PageFormat page) This method appends a page to the Book. The painter and the PageFormat for that page are passed in parameters.
void append(Printable painter, PageFormat page, int numPages) This method completes the same tasks as void append(Printable painter, PageFormat page), except that you specify the number of pages.
int getNumberOfPages() This method returns the number of pages currently in the Book.
PageFormat getPageFormat(int pageIndex) This method returns the PageFormat object for a given page.
Printable getPrintable(int pageIndex) This method returns the painter for a given page.
void setPage(int pageIndex, Printable painter, PageFormat page) This method sets the painter and the PageFormat for a given page already in the book.

The printing recipe

The recipe for printing is very simple. First, create a PrinterJob object:

PrinterJob printJob = PrinterJob.getPrinterJob ();

Next, using the setPrintable() method of the PrinterJob, assign the Painter object to the PrinterJob. Note that a Painter object is one that implements the Printable interface.

printJob.setPrintable (Painter);

Or you could set the PageFormat along with the Painter :

printJob.setPrintable (Painter, pageFormat);

Finally, the Painter object must implement the print() method:

public int print (Graphics g, PageFormat pageFormat, int page)

Here the first parameter is the graphics handle that you will use to render the page, the pageFormat is the format that will be used for the current page, and the last parameter is the page number that must be rendered.

That's all there is to it -- for simple printing, that is.

Introduction to the framework

The print framework that we will build in this series will be completely independent of the Java printing API. It will allow for greater flexibility in producing different outputs. Its structure will allow you to create documents, pages, and print objects. You will be able to add print objects to a page while adding pages to a document. By using this structure, you will be able to easily implement export features to PDF or HTML files, or print directly to the printer using the print API. But the main goal of the framework is to simplify the creation of printed documents. When you print using the print API, you only end up with a graphic canvas to draw on. It fails to address the concepts of paragraphs, images, drawings, graphics, tables, or running headers and footers. Because you must compute the (x, y) origin, the width and height of the printable area, setting margins is a chore. Our print framework will address all of these weaknesses.

Conclusion

We covered a lot of ground in this first part. We looked at measurement units, the structure of page, the two rendering models (Pageable and Printable), and Books, and we concluded with a detailed explanation of the printing API. Next month, we'll focus primarily on code, as we will be putting everything into practice. We will also look at the issues that arise when printing on multiple platforms. Looking ahead to Part 3, I will explain in detail the design and implementation of the framework.

Jean-Pierre Dube ist ein unabhängiger Java-Berater. Er gründete Infocom im Jahr 1988. Seitdem hat Infocom kundenspezifische Anwendungen in Bereichen wie Fertigung, Dokumentenmanagement und Management von Stromleitungen in großem Maßstab entwickelt. Jean-Pierre verfügt über umfangreiche Programmiererfahrung in C, Visual Basic und Java. Letzteres ist jetzt die Hauptsprache für alle neuen Projekte. Er widmet diese Serie seiner Mutter, die während des Schreibens dieses Artikels verstorben ist.

Erfahren Sie mehr über dieses Thema

  • "Drucken in Java", Jean-Pierre Dubé ( JavaWorld )
  • Teil 1: Machen Sie sich mit dem Java-Druckmodell vertraut (20. Oktober 2000)
  • Teil 2: Drucken Sie Ihre erste Seite und rendern Sie komplexe Dokumente (1. Dezember 2000)
  • Teil 3: Jean-Pierre Dubé stellt das Druckframework vor, das auf der Java Print API basiert (5. Januar 2001).
  • Part 4: Code the print framework
  • (February 2, 2001)
  • Part 5: Discover the print framework's support classes
  • (March 2, 2001)
  • You will find tons of books covering Java AWT, but none will cover this subject to the extent of this book. If you're writing GUIs, you must have this book next to your computer: Graphic Java 2, Mastering The JFCAWT, Volume 1, David M. Geary (Prentice Hall, 1998)

    //www.amazon.com/exec/obidos/ASIN/0130796662/javaworld

  • This book was helpful when Java 1.1 came out, and was the first to talk about printing in Java: Migrating from Java 1.0 to Java 1.1, Daniel I. Joshi and Pavel A. Vorobiev (Ventana Communications Group, 1997)

    //www.amazon.com/exec/obidos/ASIN/1566046866/javaworld

  • Dieses Buch ist wahrscheinlich das beste Buch zu Java 2D. Es behandelt alle Aspekte der 2D-API und bietet auch einen GraphicsRahmen für fortgeschrittene 2D-Kompositionen: Java 2D API Graphics, Vincent J. Hardy (Prentice Hall, 1999)

    //www.amazon.com/exec/obidos/ASIN/0130142662/javaworld

  • Eine hervorragende Einführung in die Java 2D-API "Erste Schritte mit Java 2D", Bill Day ( JavaWorld, Juli 1998)

    //www.javaworld.com/javaworld/jw-07-1998/jw-07-media.html

Diese Geschichte "Drucken in Java, Teil 1" wurde ursprünglich von JavaWorld veröffentlicht.