Class Book

java.lang.Object
java.awt.print.Book
All Implemented Interfaces:
Pageable
public class Book extends Object implements Pageable
The Book class provides a representation of a document in which pages may have different page formats and page painters. This class uses the Pageable interface to interact with a PrinterJob.
See Also:

  • Field Summary

    Fields declared in interface Pageable

    UNKNOWN_NUMBER_OF_PAGES
    Modifier and Type
    Field
    Description
    static final int
    UNKNOWN_NUMBER_OF_PAGES
    This constant is returned from the getNumberOfPages method if a Pageable implementation does not know the number of pages in its set.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Book()
    Creates a new, empty Book.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    append(Printable painter, PageFormat page)
    Appends a single page to the end of this Book.
    void
    append(Printable painter, PageFormat page, int numPages)
    Appends numPages pages to the end of this Book.
    int
    getNumberOfPages()
    Returns the number of pages in this Book.
    PageFormat
    getPageFormat(int pageIndex)
    Returns the PageFormat of the page specified by pageIndex.
    Printable
    getPrintable(int pageIndex)
    Returns the Printable instance responsible for rendering the page specified by pageIndex.
    void
    setPage(int pageIndex, Printable painter, PageFormat page)
    Sets the PageFormat and the Painter for a specified page number.

    Methods declared in class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    Modifier and Type
    Method
    Description
    protected Object
    clone()
    Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
    boolean
    equals(Object o)
    Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
    protected void
    finalize()
    Deprecated, for removal: This API element is subject to removal in a future version.
    May cause performance issues, deadlocks and hangs.
    final Class<? extends Object>
    getClass()
    Answers the unique instance of java.lang.Class which represents the class of the receiver.
    int
    hashCode()
    Answers an integer hash code for the receiver.
    final void
    notify()
    Causes one thread which is waiting on the receiver to be made ready to run.
    final void
    notifyAll()
    Causes all threads which are waiting on the receiver to be made ready to run.
    String
    toString()
    Answers a string containing a concise, human-readable description of the receiver.
    final void
    wait()
    Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
    final void
    wait(long time)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
    final void
    wait(long time, int frac)
    Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

  • Constructor Details

    • Book

      public Book()
      Creates a new, empty Book.

  • Method Details

    • getNumberOfPages

      public int getNumberOfPages()
      Returns the number of pages in this Book.
      Specified by:
      getNumberOfPages in interface Pageable
      Returns:
      the number of pages this Book contains.

    • getPageFormat

      public PageFormat getPageFormat(int pageIndex) throws IndexOutOfBoundsException
      Returns the PageFormat of the page specified by pageIndex.
      Specified by:
      getPageFormat in interface Pageable
      Parameters:
      pageIndex - the zero based index of the page whose PageFormat is being requested
      Returns:
      the PageFormat describing the size and orientation of the page.
      Throws:
      IndexOutOfBoundsException - if the Pageable does not contain the requested page

    • getPrintable

      public Printable getPrintable(int pageIndex) throws IndexOutOfBoundsException
      Returns the Printable instance responsible for rendering the page specified by pageIndex.
      Specified by:
      getPrintable in interface Pageable
      Parameters:
      pageIndex - the zero based index of the page whose Printable is being requested
      Returns:
      the Printable that renders the page.
      Throws:
      IndexOutOfBoundsException - if the Pageable does not contain the requested page

    • setPage

      public void setPage(int pageIndex, Printable painter, PageFormat page) throws IndexOutOfBoundsException
      Sets the PageFormat and the Painter for a specified page number.
      Parameters:
      pageIndex - the zero based index of the page whose painter and format is altered
      painter - the Printable instance that renders the page
      page - the size and orientation of the page
      Throws:
      IndexOutOfBoundsException - if the specified page is not already in this Book
      NullPointerException - if the painter or page argument is null

    • append

      public void append(Printable painter, PageFormat page)
      Appends a single page to the end of this Book.
      Parameters:
      painter - the Printable instance that renders the page
      page - the size and orientation of the page
      Throws:
      NullPointerException - If the painter or page argument is null

    • append

      public void append(Printable painter, PageFormat page, int numPages)
      Appends numPages pages to the end of this Book. Each of the pages is associated with page.
      Parameters:
      painter - the Printable instance that renders the page
      page - the size and orientation of the page
      numPages - the number of pages to be added to the this Book.
      Throws:
      NullPointerException - If the painter or page argument is null