Impression en Java, partie 1

Précédent 1 2 Page 2 Page 2 de 2

Modèles de rendu

Il existe deux modèles d'impression en Java: les Printabletravaux et les Pageabletravaux.

Imprimables

Printableles travaux sont le plus simple des deux modèles d'impression. Ce modèle n'en utilise qu'un PagePainterpour l'ensemble du document. Les pages sont rendues dans l'ordre, en commençant par la page zéro. Lorsque la dernière page s'imprime, vous PagePainterdevez renvoyer la NO_SUCH_PAGEvaleur. Le sous-système d'impression demandera toujours à l'application de rendre les pages dans l'ordre. Par exemple, si votre application est invitée à rendre les pages cinq à sept, le sous-système d'impression demandera toutes les pages jusqu'à la septième page, mais n'imprimera que les pages cinq, six et sept. Si votre application affiche une boîte de dialogue d'impression, le nombre total de pages à imprimer ne sera pas affiché car il est impossible de connaître à l'avance le nombre de pages du document en utilisant ce modèle.

Pageables

Pageableles travaux offrent plus de flexibilité que les Printabletravaux, car chaque page d'un Pageabletravail peut présenter une mise en page différente. Pageableles travaux sont le plus souvent utilisés avec Books, un ensemble de pages qui peuvent avoir différents formats. J'expliquerai la Bookclasse dans un instant.

Un Pageableemploi présente les caractéristiques suivantes:

  • Chaque page peut avoir son propre peintre. Par exemple, vous pourriez avoir un peintre implémenté pour imprimer la page de garde, un autre peintre pour imprimer la table des matières et un troisième pour imprimer le document entier.
  • Vous pouvez définir un format de page différent pour chaque page du livre. Dans un Pageabletravail, vous pouvez mélanger des pages portrait et paysage.
  • Le sous-système d'impression peut demander à votre application d'imprimer des pages dans le désordre et certaines pages peuvent être ignorées si nécessaire. Encore une fois, vous n'avez pas à vous en soucier tant que vous pouvez fournir n'importe quelle page de votre document à la demande.
  • Le Pageabletravail n'a pas besoin de connaître le nombre de pages du document.

Livres

La Bookclasse est également nouvelle depuis la version 1.2 . Cette classe vous permet de créer des documents de plusieurs pages. Chaque page peut avoir son propre format et son propre dessin, vous donnant la flexibilité de créer des documents sophistiqués. Puisque la Bookclasse implémente l' Pageableinterface, vous pouvez implémenter votre propre Bookclasse lorsque la Bookclasse fournie ne dispose pas des fonctionnalités dont vous avez besoin.

Une Bookclasse représente une collection de pages. Lors de sa première création, l' Bookobjet est vide. Pour ajouter des pages, vous utilisez simplement l'une des deux append()méthodes (voir mon explication de cette classe dans la section API pour plus de détails). Les paramètres de cette méthode sont l' PageFormatobjet, qui définit les caractéristiques physiques de la page, et un PagePainterobjet, qui implémente l' Printableinterface. Si vous ne connaissez pas le nombre de pages de votre document, transmettez simplement la UNKNOWN_NUMBER_OF_PAGESvaleur à la append()méthode. Le système d'impression trouvera automatiquement le nombre de pages en appelant tous les peintres de pages du livre jusqu'à ce qu'il reçoive une NO_SUCH_PAGEvaleur.

Définition de l'API

La théorie et la pratique se rencontreront dans cette section. Dans les sections précédentes, nous avons découvert la structure des pages, les unités de mesure et les modèles de rendu. Dans cette section, nous examinerons l'API d'impression Java.

Toutes les classes requises pour imprimer se trouvent dans le java.awt.printpackage, qui est composé de trois interfaces et quatre classes. Les tableaux suivants définissent les classes et les interfaces du package d'impression.

Nom Type La description
Paper Classe Cette classe définit les caractéristiques physiques de la page.
PageFormat Classe PageFormatdéfinit la taille et l'orientation de la page. Il définit également lequel Paperutiliser lors du rendu d'une page.
PrinterJob Classe

Cette classe gère le travail d'impression. Ses responsabilités incluent la création d'un travail d'impression, l'affichage d'une boîte de dialogue d'impression si nécessaire et l'impression du document.

Book Classe

Bookreprésente un document. Un Bookobjet agit comme une collection de pages. Les pages incluses dans le Bookpeuvent avoir des formats identiques ou différents et peuvent utiliser des peintres différents.

Pageable Interface Une Pageableimplémentation représente un ensemble de pages à imprimer. L' Pageableobjet renvoie le nombre total de pages de l'ensemble ainsi que le PageFormatet Printablepour une page spécifiée. La Bookclasse implémente cette interface.
Printable Interface Un peintre de pages doit implémenter l' Printableinterface. Il n'y a qu'une seule méthode dans cette interface, print().
PrinterGraphics Interface L' Graphicsobjet implémente cette interface. PrinterGraphicsfournit la getPrinterJob()méthode pour obtenir le travail d'impression qui a instancié le processus d'impression.

Interface paginable

L' Pageableinterface comprend trois méthodes:

Nom de la méthode La description
int getNumberOfPages() Renvoie le nombre de pages du document.
PageFormat getPageFormat(int pageIndex) Renvoie les pages PageFormatcomme spécifié par pageIndex.
Printable getPrintable(int pageIndex) Renvoie l' Printableinstance responsable du rendu de la page spécifiée par pageIndex.

Interface imprimable

L' Printableinterface propose une méthode et deux valeurs:

Nom Type La description
int print(Graphics graphics, PageFormat pageFormat, int pageIndex) Méthode

Demande que les graphiques gèrent à l'aide du format de page donné rendent la page spécifiée.

NO_SUCH_PAGE Valeur C'est une constante. Renvoyez cette valeur pour indiquer qu'il n'y a plus de pages à imprimer.
PAGE_EXISTS Valeur La print()méthode retourne PAGE_EXISTS. Il indique que la page passée en paramètre à print()a été rendue et existe.

Chaque page peintre doit implémenter l' Printableinterface. Puisqu'il n'y a qu'une seule méthode à implémenter, la création de peintres de pages peut sembler facile. Cependant, rappelez-vous que votre code doit être capable de rendre n'importe quelle page dans ou hors de séquence.

Il y a trois paramètres à print(), y compris Graphics, qui est la même classe utilisée pour dessiner sur l'écran. Puisque la Graphicsclasse implémente l' PrinterGraphicinterface, vous pouvez obtenir le PrinterJobqui instancie ce travail d'impression. Si votre mise en page est complexe et nécessite des fonctionnalités de dessin avancées, vous pouvez convertir le Graphicsparamètre en Graphics2Dobjet. Vous aurez alors accès à l'API Java 2D complète.

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 est un consultant Java indépendant. Il a fondé Infocom en 1988. Depuis, Infocom a développé des applications personnalisées dans des domaines tels que la fabrication, la gestion de documents et la gestion de lignes électriques à grande échelle. Jean-Pierre possède une vaste expérience de la programmation en C, Visual Basic et Java; ce dernier est désormais la langue principale de tous les nouveaux projets. Il dédie cette série à sa mère, décédée alors qu'il écrivait cet article.

En savoir plus sur ce sujet

  • «Impression en Java», Jean-Pierre Dubé ( JavaWorld )
  • Partie 1: Familiarisez-vous avec le modèle d'impression Java (20 octobre 2000)
  • Partie 2: Imprimez votre première page et rendez des documents complexes (1er décembre 2000)
  • Partie 3: Jean-Pierre Dubé présente le framework d'impression qui fonctionne en plus de l'API Java Print (5 janvier 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

  • Probablement le meilleur livre sur Java 2D, ce livre couvre tous les aspects de l'API 2D et fournit également un Graphicscadre pour des compositions 2D avancées: Java 2D API Graphics, Vincent J.Hardy (Prentice Hall, 1999)

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

  • Une excellente introduction à l'API Java 2D «Getting Started with Java 2D», Bill Day ( JavaWorld, juillet 1998)

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

Cette histoire, "Impression en Java, partie 1" a été initialement publiée par JavaWorld.