Class PageableRenderer

  • All Implemented Interfaces:
    java.awt.print.Pageable, java.awt.print.Printable, Constants, Renderer
    Direct Known Subclasses:
    PrintRenderer

    public class PageableRenderer
    extends Java2DRenderer
    implements java.awt.print.Pageable
    Renderer that prints through java.awt.PrintJob. The actual printing is handled by Java2DRenderer since both PrintRenderer and AWTRenderer need to support printing.
    • Field Detail

      • PAGES_MODE

        public static final java.lang.String PAGES_MODE
        Printing parameter: the pages to be printed (all, even or odd), datatype: the strings "all", "even" or "odd" or one of PagesMode.*
        See Also:
        Constant Field Values
      • START_PAGE

        public static final java.lang.String START_PAGE
        Printing parameter: the page number (1-based) of the first page to be printed, datatype: a positive Integer
        See Also:
        Constant Field Values
      • END_PAGE

        public static final java.lang.String END_PAGE
        Printing parameter: the page number (1-based) of the last page to be printed, datatype: a positive Integer
        See Also:
        Constant Field Values
      • startNumber

        protected int startNumber
        first valid page number (1-based)
      • endNumber

        protected int endNumber
        last valid page number (1-based)
      • mode

        protected PagesMode mode
        indicates which pages are valid: odd, even or all
    • Constructor Detail

      • PageableRenderer

        public PageableRenderer​(FOUserAgent userAgent)
        Creates a new PageableRenderer.
        Parameters:
        userAgent - the user agent that contains configuration details. This cannot be null.
    • Method Detail

      • getMimeType

        public java.lang.String getMimeType()
        Get the MIME type of the renderer.
        Specified by:
        getMimeType in interface Renderer
        Returns:
        The MIME type of the renderer, may return null if not applicable.
      • processOptions

        private void processOptions​(java.util.Map rendererOptions)
      • getPositiveInteger

        protected int getPositiveInteger​(java.lang.Object o)
        Converts an object into a positive integer value if possible. The method throws an IllegalArgumentException if the value is invalid.
        Parameters:
        o - the object to be converted
        Returns:
        the positive integer
      • stopRenderer

        public void stopRenderer()
                          throws java.io.IOException
        Signals the end of the rendering phase. The renderer should reset to an initial state and dispose of any resources for the completed rendering.
        Specified by:
        stopRenderer in interface Renderer
        Overrides:
        stopRenderer in class Java2DRenderer
        Throws:
        java.io.IOException - If an I/O error occurs
      • rememberPage

        protected void rememberPage​(PageViewport pageViewport)
        Stores the pageViewport in a list of page viewports so they can be rendered later. Subclasses can override this method to filter pages, for example.
        Overrides:
        rememberPage in class Java2DRenderer
        Parameters:
        pageViewport - the page viewport
      • getPageFormat

        public java.awt.print.PageFormat getPageFormat​(int pageIndex)
                                                throws java.lang.IndexOutOfBoundsException
        Specified by:
        getPageFormat in interface java.awt.print.Pageable
        Throws:
        java.lang.IndexOutOfBoundsException
      • getPrintable

        public java.awt.print.Printable getPrintable​(int pageIndex)
                                              throws java.lang.IndexOutOfBoundsException
        Specified by:
        getPrintable in interface java.awt.print.Pageable
        Throws:
        java.lang.IndexOutOfBoundsException