Overview | Package | Class | Use | Tree | Deprecated | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.developmentontheedge.print
Class LargePageable

    java.lang.Object
      com.developmentontheedge.print.LargePageable

All Implemented Interfaces:
  java.awt.print.Pageable

Direct Known Subclasses:
  JPrintableComponent

public class LargePageable
extends java.lang.Object
implements java.awt.print.Pageable

A simple Pageable class that can split a large drawing canvas over multiple pages. The pages in a canvas are laid out on pages going left to right and then top to bottom.

Nested Class Summary
`class` | `LargePageable.TranslatedPrintable` This inner class's sole responsibility is to translate the coordinate system before invoking a canvas's painter.

Field Summary

Fields inherited from interface java.awt.print.Pageable
`UNKNOWN_NUMBER_OF_PAGES`

Constructor Summary
`protected` | `LargePageable()` Create a LargePageable over a canvas whose width and height are zero and whose Printable and PageFormat are null.
`` | `LargePageable(float width, float height, java.awt.print.Printable painter, java.awt.print.PageFormat format)` Create a java.awt.Pageable that will print a canvas over as many pages as are needed.

Method Summary
`int` | `getNumberOfPages()` Returns the number of pages over which the canvas will be drawn.
`protected java.awt.print.PageFormat` | `getPageFormat()`
`java.awt.print.PageFormat` | `getPageFormat(int pageIndex)` Returns the PageFormat of the page specified by pageIndex.
`java.awt.print.Printable` | `getPrintable(int pageIndex)` Returns the `Printable` instance responsible for rendering the page specified by `pageIndex`.
`protected void` | `setPageFormat(java.awt.print.PageFormat pageFormat)` Set the page format for the pages over which the canvas will be drawn.
`protected void` | `setPrintable(java.awt.print.Printable painter)` Set the object responsible for drawing the canvas.
`protected void` | `setSize(float width, float height)` Set the size of the canvas to be drawn.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### LargePageable

    public LargePageable(float width,
                         float height,
                         java.awt.print.Printable painter,
                         java.awt.print.PageFormat format)

  Create a java.awt.Pageable that will print a canvas over as many pages as are needed. A LargePageable can be passed to PrinterJob.setPageable.

Parameters:
  `width` - The width, in 1/72nds of an inch, of the area to print.
  `height` - The height, in 1/72nds of an inch, of the area to print.
  `painter` - The object that will drawn the contents of the canvas.
  `format` - The description of the pages on to which the canvas will be drawn.

### LargePageable

    protected LargePageable()

  Create a LargePageable over a canvas whose width and height are zero and whose Printable and PageFormat are null.

Method Detail

### setPrintable

    protected void setPrintable(java.awt.print.Printable painter)

  Set the object responsible for drawing the canvas.

### setPageFormat

    protected void setPageFormat(java.awt.print.PageFormat pageFormat)

  Set the page format for the pages over which the canvas will be drawn.

### setSize

    protected void setSize(float width,
                           float height)

  Set the size of the canvas to be drawn.

  Parameters:
    `width` - The width, in 1/72nds of an inch, of the area to print.
    `height` - The height, in 1/72nds of an inch, of the area to print.

### getNumberOfPages

    public int getNumberOfPages()

  Returns the number of pages over which the canvas will be drawn.

  Specified by:
    `getNumberOfPages` in interface `java.awt.print.Pageable`

### getPageFormat

    protected java.awt.print.PageFormat getPageFormat()

### getPageFormat

    public java.awt.print.PageFormat getPageFormat(int pageIndex)
                                            throws java.lang.IndexOutOfBoundsException

  Returns the PageFormat of the page specified by pageIndex. For a LargePageable the PageFormat is the same for all pages.

  Specified by:
    `getPageFormat` in interface `java.awt.print.Pageable`
  Parameters:
    `pageIndex` - the zero based index of the page whose PageFormat is being requested
  Returns:
    the PageFormat describing the size and orientation.
  Throws:
    `java.lang.IndexOutOfBoundsException` - the Pageable does not contain the requested page.

### getPrintable

    public java.awt.print.Printable getPrintable(int pageIndex)
                                          throws java.lang.IndexOutOfBoundsException

  Returns the `Printable` instance responsible for rendering the page specified by `pageIndex`. In a LargePageable, all of the pages are drawn with the same Printable. This method however creates a Printable which calls the canvas's Printable. This new Printable is responsible for translating the coordinate system so that the desired part of the canvas hits the page. The LargePageable's pages cover the canvas by going left to right and then top to bottom. In order to change this behavior, override this method.

  Specified by:
    `getPrintable` in interface `java.awt.print.Pageable`
  Parameters:
    `pageIndex` - the zero based index of the page whose Printable is being requested
  Returns:
    the Printable that renders the page.
  Throws:
    `java.lang.IndexOutOfBoundsException` - the Pageable does not contain the requested page.

Overview | Package | Class | Use | Tree | Deprecated | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2001-2003 Biosof.Ru. All Rights Reserved.