Package org.apache.fop.render.pdf

Class PDFPainter

    • Constructor Detail

      • PDFPainter

        public PDFPainter​(PDFDocumentHandler documentHandler,
                  PDFLogicalStructureHandler logicalStructureHandler)
        Default constructor.
        Parameters:
        documentHandler - the parent document handler
        logicalStructureHandler - the logical structure handler

    • Method Detail

      • startViewport

        public void startViewport​(java.awt.geom.AffineTransform transform,
                          java.awt.Dimension size,
                          java.awt.Rectangle clipRect)
                   throws IFException
        Starts a new viewport, establishing a new coordinate system. A viewport has a size and can optionally be clipped. Corresponds to SVG's svg element.
        Parameters:
        transform - the transformation matrix establishing the new coordinate system
        size - the size of the viewport
        clipRect - the clipping rectangle (may be null)
        Throws:
        IFException - if an error occurs while handling this element

      • endViewport

        public void endViewport()
                 throws IFException
        Ends the current viewport and restores the previous coordinate system.
        Throws:
        IFException - if an error occurs while handling this element

      • startGroup

        public void startGroup​(java.awt.geom.AffineTransform transform,
                       java.lang.String layer)
                throws IFException
        Starts a new group of graphical elements. Corresponds to SVG's g element.
        Parameters:
        transform - the transformation matrix establishing the new coordinate system
        layer - an optional layer label (or null if none)
        Throws:
        IFException - if an error occurs while handling this element

      • endGroup

        public void endGroup()
              throws IFException
        Ends the current group and restores the previous coordinate system (and layer).
        Throws:
        IFException - if an error occurs while handling this element

      • drawImage

        public void drawImage​(java.lang.String uri,
                      java.awt.Rectangle rect)
               throws IFException
        Draws an image identified by a URI inside a given rectangle. This is the equivalent to an fo:external-graphic in XSL-FO.
        Parameters:
        uri - the image's URI
        rect - the rectangle in which the image shall be painted
        Throws:
        IFException - if an error occurs while handling this event

      • addStructTreeBBox

        private void addStructTreeBBox​(java.awt.Rectangle rect)

      • drawImageUsingURI

        protected void drawImageUsingURI​(java.lang.String uri,
                                 java.awt.Rectangle rect)
        Description copied from class: AbstractIFPainter
        Default drawing method for handling an image referenced by a URI.
        Overrides:
        drawImageUsingURI in class AbstractIFPainter<PDFDocumentHandler>
        Parameters:
        uri - the image's URI
        rect - the rectangle in which to paint the image

      • prepareImageMCID

        private void prepareImageMCID​(PDFStructElem structElem)

      • placeImage

        private void placeImage​(java.awt.Rectangle rect,
                        PDFXObject xobj)
        Places a previously registered image at a certain place on the page.
        Parameters:
        rect - the rectangle for the image
        xobj - the image XObject

      • placeImageAccess

        private void placeImageAccess​(java.awt.Rectangle rect,
                              PDFXObject xobj)
        Places a previously registered image at a certain place on the page - Accessibility version
        Parameters:
        rect - the rectangle for the image
        xobj - the image XObject

      • drawImage

        public void drawImage​(org.w3c.dom.Document doc,
                      java.awt.Rectangle rect)
               throws IFException
        Draws an image (represented by a DOM document) inside a given rectangle. This is the equivalent to an fo:instream-foreign-object in XSL-FO.
        Parameters:
        doc - the DOM document containing the foreign object
        rect - the rectangle in which the image shall be painted
        Throws:
        IFException - if an error occurs while handling this event

      • format

        protected static java.lang.String format​(int value)
        Formats a integer value (normally coordinates in millipoints) to a String.
        Parameters:
        value - the value (in millipoints)
        Returns:
        the formatted value

      • clipRect

        public void clipRect​(java.awt.Rectangle rect)
              throws IFException
        Restricts the current clipping region with the given rectangle.
        Parameters:
        rect - the rectangle's coordinates and extent
        Throws:
        IFException - if an error occurs while handling this event

      • clipBackground

        public void clipBackground​(java.awt.Rectangle rect,
                           BorderProps bpsBefore,
                           BorderProps bpsAfter,
                           BorderProps bpsStart,
                           BorderProps bpsEnd)
                    throws IFException
        Restricts the current clipping region to the inner border.
        Parameters:
        rect - the rectangle's coordinates and extent
        bpsBefore - the border segment on the before-side (top)
        bpsAfter - the border segment on the after-side (bottom)
        bpsStart - the border segment on the start-side (left)
        bpsEnd - the border segment on the end-side (right)
        Throws:
        IFException - if an error occurs while handling this event

      • fillRect

        public void fillRect​(java.awt.Rectangle rect,
                     java.awt.Paint fill)
              throws IFException
        Fills a rectangular area.
        Parameters:
        rect - the rectangle's coordinates and extent
        fill - the fill paint
        Throws:
        IFException - if an error occurs while handling this event

      • drawBorderRect

        public void drawBorderRect​(java.awt.Rectangle rect,
                           BorderProps top,
                           BorderProps bottom,
                           BorderProps left,
                           BorderProps right,
                           java.awt.Color innerBackgroundColor)
                    throws IFException
        Draws a border rectangle. The border segments are specified through BorderProps instances.
        Specified by:
        drawBorderRect in interface IFPainter
        Overrides:
        drawBorderRect in class AbstractIFPainter<PDFDocumentHandler>
        Parameters:
        rect - the rectangle's coordinates and extent
        top - the border segment on the top edge
        bottom - the border segment on the bottom edge
        left - the border segment on the left edge
        right - the border segment on the right edge
        innerBackgroundColor - the color of the inner background
        Throws:
        IFException - if an error occurs while handling this event

      • drawLine

        public void drawLine​(java.awt.Point start,
                     java.awt.Point end,
                     int width,
                     java.awt.Color color,
                     RuleStyle style)
              throws IFException
        Draws a line. NOTE: Currently, only horizontal lines are implemented!
        Specified by:
        drawLine in interface IFPainter
        Overrides:
        drawLine in class AbstractIFPainter<PDFDocumentHandler>
        Parameters:
        start - the start point of the line
        end - the end point of the line
        width - the line width
        color - the line color
        style - the line style (using the Constants.EN_* constants for the rule-style property)
        Throws:
        IFException - if an error occurs while handling this event

      • getTypeface

        private Typeface getTypeface​(java.lang.String fontName)

      • drawText

        public void drawText​(int x,
                     int y,
                     int letterSpacing,
                     int wordSpacing,
                     int[][] dp,
                     java.lang.String text)
              throws IFException
        Draws text. The initial coordinates (x and y) point to the starting point at the normal baseline of the font. The parameters letterSpacing, wordSpacing and the array dx are optional and can be used to influence character positioning (for example, for kerning).
        Parameters:
        x - X-coordinate of the starting point of the text
        y - Y-coordinate of the starting point of the text
        letterSpacing - additional spacing between characters (may be 0)
        wordSpacing - additional spacing between words (may be 0)
        dp - an array of 4-tuples, expressing [X,Y] placment adjustments and [X,Y] advancement adjustments, in that order (may be null); if not null, then adjustments.length must be the same as text.length()
        text - the text
        Throws:
        IFException - if an error occurs while handling this event

      • drawTextWithDX

        private void drawTextWithDX​(int x,
                            int y,
                            java.lang.String text,
                            FontTriplet triplet,
                            int letterSpacing,
                            int wordSpacing,
                            int[] dx)
                     throws IFException
        Throws:
        IFException

      • drawTextWithDP

        private void drawTextWithDP​(int x,
                            int y,
                            java.lang.String text,
                            FontTriplet triplet,
                            int letterSpacing,
                            int wordSpacing,
                            int[][] dp)

      • maybeWordOffsetX

        private double maybeWordOffsetX​(double wox,
                                char ch,
                                Direction dir)

      • selectAndMapSingleByteFont

        private int selectAndMapSingleByteFont​(Typeface tf,
                                       java.lang.String fontName,
                                       float fontSize,
                                       PDFTextUtil textutil,
                                       int ch)