Module java.desktop
Package java.awt.print

Class Book

  • All Implemented Interfaces:
    Pageable

    public classBookextendsObjectimplementsPageable
    TheBook class provides a representation of a document in which pages may have different page formats and page painters. This class uses thePageable interface to interact with aPrinterJob.
    See Also:
    Pageable,PrinterJob

    • Constructor Detail

      • Book

        public Book()
        Creates a new, emptyBook.

    • Method Detail

      • getNumberOfPages

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

      • getPrintable

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

      • setPage

        public void setPage(int pageIndex,Printable painter,PageFormat page)             throwsIndexOutOfBoundsException
        Sets thePageFormat and thePainter for a specified page number.
        Parameters:
        pageIndex - the zero based index of the page whose painter and format is altered
        painter - thePrintable instance that renders the page
        page - the size and orientation of the page
        Throws:
        IndexOutOfBoundsException - if the specified page is not already in thisBook
        NullPointerException - if thepainter orpage argument isnull

      • append

        public void append(Printable painter,PageFormat page)
        Appends a single page to the end of thisBook.
        Parameters:
        painter - thePrintable instance that renders the page
        page - the size and orientation of the page
        Throws:
        NullPointerException - If thepainter orpage argument isnull

      • append

        public void append(Printable painter,PageFormat page,                   int numPages)
        AppendsnumPages pages to the end of thisBook. Each of the pages is associated withpage.
        Parameters:
        painter - thePrintable instance that renders the page
        page - the size and orientation of the page
        numPages - the number of pages to be added to the thisBook.
        Throws:
        NullPointerException - If thepainter orpage argument isnull