Package org.apache.pdfbox.printing

Class PDFPageable

  • All Implemented Interfaces:
    java.awt.print.Pageable
    public final class PDFPageable
extends java.awt.print.Book
    Prints a PDF document using its original paper size.
    Author:
    John Hewson

    • Field Summary

      • Fields inherited from interface java.awt.print.Pageable

        UNKNOWN_NUMBER_OF_PAGES

    • Constructor Summary

      Constructors 
      Constructor Description
      PDFPageable​(PDDocument document)
      Creates a new PDFPageable.
      PDFPageable​(PDDocument document, Orientation orientation)
      Creates a new PDFPageable with the given page orientation.
      PDFPageable​(PDDocument document, Orientation orientation, boolean showPageBorder)
      Creates a new PDFPageable with the given page orientation and with optional page borders shown.
      PDFPageable​(PDDocument document, Orientation orientation, boolean showPageBorder, float dpi)
      Creates a new PDFPageable with the given page orientation and with optional page borders shown.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getNumberOfPages()  
      java.awt.print.PageFormat getPageFormat​(int pageIndex)
      Returns the actual physical size of the pages in the PDF file.
      java.awt.print.Printable getPrintable​(int i)  

      • Methods inherited from class java.awt.print.Book

        append, append, setPage

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • PDFPageable

        public PDFPageable​(PDDocument document)
        Creates a new PDFPageable.
        Parameters:
        document - the document to print

      • PDFPageable

        public PDFPageable​(PDDocument document,
                   Orientation orientation)
        Creates a new PDFPageable with the given page orientation.
        Parameters:
        document - the document to print
        orientation - page orientation policy

      • PDFPageable

        public PDFPageable​(PDDocument document,
                   Orientation orientation,
                   boolean showPageBorder)
        Creates a new PDFPageable with the given page orientation and with optional page borders shown. The image will be rasterized at the given DPI before being sent to the printer.
        Parameters:
        document - the document to print
        orientation - page orientation policy
        showPageBorder - true if page borders are to be printed

      • PDFPageable

        public PDFPageable​(PDDocument document,
                   Orientation orientation,
                   boolean showPageBorder,
                   float dpi)
        Creates a new PDFPageable with the given page orientation and with optional page borders shown. The image will be rasterized at the given DPI before being sent to the printer.
        Parameters:
        document - the document to print
        orientation - page orientation policy
        showPageBorder - true if page borders are to be printed
        dpi - if non-zero then the image will be rasterized at the given DPI

    • Method Detail

      • getNumberOfPages

        public int getNumberOfPages()
        Specified by:
        getNumberOfPages in interface java.awt.print.Pageable
        Overrides:
        getNumberOfPages in class java.awt.print.Book

      • getPageFormat

        public java.awt.print.PageFormat getPageFormat​(int pageIndex)
        Returns the actual physical size of the pages in the PDF file. May not fit the local printer.
        Specified by:
        getPageFormat in interface java.awt.print.Pageable
        Overrides:
        getPageFormat in class java.awt.print.Book

      • getPrintable

        public java.awt.print.Printable getPrintable​(int i)
        Specified by:
        getPrintable in interface java.awt.print.Pageable
        Overrides:
        getPrintable in class java.awt.print.Book