Javaでの印刷、パート1

前へ12ページ2 2/2ページ

モデルのレンダリング

Javaには、PrintableジョブとPageableジョブの2つの印刷モデルがあります。

印刷物

Printableジョブは、2つの印刷モデルの中でより単純です。このモデルPagePainterは、ドキュメント全体に1つだけを使用します。ページは、ページ0から順番にレンダリングされます。最後のページが印刷されたらPagePainterNO_SUCH_PAGE値を返す必要があります。印刷サブシステムは、アプリケーションがページを順番にレンダリングすることを常に要求します。例として、アプリケーションが5〜7ページをレンダリングするように要求された場合、印刷サブシステムは7ページまでのすべてのページを要求しますが、5、6、および7ページのみを印刷します。アプリケーションに印刷ダイアログボックスが表示されている場合、このモデルを使用しているドキュメントのページ数を事前に知ることはできないため、印刷される合計ページ数は表示されません。

Pageables

PageableジョブのPrintable各ページはPageable異なるレイアウトを特徴とする可能性があるため、ジョブはジョブよりも柔軟性があります。PageableジョブはBook、さまざまな形式を持つことができるページのコレクションであるsで最もよく使用されます。Bookクラスについては後ほど説明します。

Pageableジョブは次の特性があります。

  • 各ページには、独自のペインターを含めることができます。たとえば、表紙を印刷するためのペインター、目次を印刷するための別のペインター、およびドキュメント全体を印刷するための3番目のペインターを実装できます。
  • ブックのページごとに異なるページ形式を設定できます。Pageable仕事、あなたは縦向きと横向きのページを混在させることができます。
  • 印刷サブシステムは、アプリケーションにページを順番どおりに印刷しないように要求する場合があり、必要に応じて一部のページがスキップされる場合があります。繰り返しになりますが、ドキュメント内の任意のページをオンデマンドで提供できる限り、これについて心配する必要はありません。
  • Pageableジョブは、文書内にあるページ数を知る必要はありません。

また、バージョン1.2以降の新機能はBookクラスです。このクラスを使用すると、複数ページのドキュメントを作成できます。各ページには独自のフォーマットと独自のペインターを設定できるため、洗練されたドキュメントを柔軟に作成できます。以来Bookクラスが実装Pageableインタフェース、独自の実装ができBook提供された場合、クラスのBookクラスは、あなたが必要とする機能を欠いています。

Bookこのクラスは、ページのコレクションを表します。最初に作成されたとき、Bookオブジェクトは空です。ページを追加するには、2つのappend()メソッドのいずれかを使用するだけです(詳細については、APIセクションのこのクラスの説明を参照してください)。このメソッドのパラメーターは、PageFormatページの物理的特性を定義するPagePainterオブジェクトと、Printableインターフェースを実装するオブジェクトです。ドキュメントのページ数がわからない場合は、UNKNOWN_NUMBER_OF_PAGES値をappend()メソッドに渡すだけです。プリンタシステムは、NO_SUCH_PAGE値を受け取るまで本のすべてのページペインタを呼び出すことにより、ページ数を自動的に検出します。

API定義

このセクションでは、理論と実践について説明します。前のセクションでは、ページ構造、測定単位、およびレンダリングモデルについて学習しました。このセクションでは、Java印刷APIについて説明します。

印刷に必要なすべてのクラスjava.awt.printは、3つのインターフェイスと4つのクラスで構成されるパッケージに含まれています。次の表は、印刷パッケージのクラスとインターフェイスを定義しています。

名前 タイプ 説明
Paper クラス このクラスは、ページの物理的特性を定義します。
PageFormat クラス PageFormatページのサイズと向きを定義します。またPaper、ページをレンダリングするときにどちらを使用するかを定義します。
PrinterJob クラス

このクラスは、印刷ジョブを管理します。その責任には、印刷ジョブの作成、必要に応じた印刷ダイアログボックスの表示、およびドキュメントの印刷が含まれます。

Book クラス

Bookドキュメントを表します。Bookオブジェクトは、ページの集合として機能します。に含まれるページは、Book同一または異なるフォーマットを持つことができ、異なるペインターを使用できます。

Pageable インターフェース Pageable実装は、印刷するページのセットを表します。Pageable対象は、だけでなく、セットの総ページ数を返すPageFormatと、Printable指定したページのために。Bookクラスは、このインタフェースを実装しています。
Printable インターフェース ページペインタはPrintableインターフェイスを実装する必要があります。このインターフェースには、メソッドが1つだけありますprint()
PrinterGraphics インターフェース Graphicsオブジェクトは、このインタフェースを実装しています。印刷プロセスをインスタンス化したプリンタージョブを取得PrinterGraphicsするgetPrinterJob()方法を提供します。

ページング可能なインターフェース

Pageableインターフェースは三つの方法があります。

メソッド名 説明
int getNumberOfPages() ドキュメントのページ数を返します。
PageFormat getPageFormat(int pageIndex) PageFormat指定されたページを返しますpageIndex
Printable getPrintable(int pageIndex) Printable指定されたページのレンダリングを担当するインスタンスを返しますpageIndex

印刷可能なインターフェース

このPrintableインターフェースは、1つのメソッドと2つの値を備えています。

名前 タイプ 説明
int print(Graphics graphics, PageFormat pageFormat, int pageIndex) 方法

指定されたページ形式を使用してグラフィックスハンドルが指定されたページをレンダリングするように要求します。

NO_SUCH_PAGE これは定数です。この値を返すと、印刷するページがこれ以上ないことを示します。
PAGE_EXISTS print()メソッドが返しますPAGE_EXISTS。これは、パラメータとして渡されたページprint()がレンダリングされ、存在することを示します。

Every page painter must implement the Printable interface. Since there is only one method to implement, creating page painters may seem easy. However, remember that your code must be able to render any page in or out of sequence.

There are three parameters to print(), including Graphics, which is the same class used to draw on the screen. Since the Graphics class implements the PrinterGraphic interface, you can obtain the PrinterJob that instantiated this print job. If your page layout is complex and requires some advanced drawing features, you can cast the Graphics parameter to a Graphics2D object. You will then have access to the full 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は、独立したJavaコンサルタントです。彼は1988年にInfocomを設立しました。それ以来、Infocomは製造、ドキュメント管理、大規模な電力線管理などの分野でカスタムアプリケーションを開発してきました。Jean-Pierreは、C、Visual Basic、およびJavaで幅広いプログラミング経験があります。後者は現在、すべての新しいプロジェクトの主要言語です。彼はこの記事を書いている間に亡くなった母親にこのシリーズを捧げます。

このトピックの詳細

  • 「Javaでの印刷」、Jean-PierreDubé(JavaWorld
  • パート1:Java印刷モデルについて理解する(2000年10月20日)
  • パート2:最初のページを印刷して複雑なドキュメントをレンダリングする(2000年12月1日)
  • パート3:Jean-PierreDubéがJava Print API上で機能する印刷フレームワークを紹介します(2001年1月5日)
  • 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

  • おそらくJava2Dに関する最高の本であり、この本は2D APIのすべての側面をカバーしGraphics、高度な2D構成のフレームワークも提供します。Java2DAPIグラフィックス、 Vincent J. Hardy(Prentice Hall、1999)

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

  • Java 2DAPIGettingStartedwith Java 2D」の優れた紹介、Bill Day(JavaWorld、1998年7月)

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

このストーリー「Javaでの印刷、パート1」は、もともとJavaWorldによって発行されました。