Package org.apache.fop.render.afp

Class AFPPainter

    • Constructor Detail

      • AFPPainter

        public AFPPainter​(AFPDocumentHandler documentHandler)
        Default constructor.
        Parameters:
        documentHandler - the parent document 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

      • createDefaultImageProcessingHints

        protected java.util.Map createDefaultImageProcessingHints​(org.apache.xmlgraphics.image.loader.ImageSessionContext sessionContext)
        Creates the default map of processing hints for the image loading framework.
        Overrides:
        createDefaultImageProcessingHints in class AbstractIFPainter<AFPDocumentHandler>
        Parameters:
        sessionContext - the session context for access to resolution information
        Returns:
        the default processing hints

      • 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

      • drawImage

        protected void drawImage​(org.apache.xmlgraphics.image.loader.Image image,
                         java.awt.Rectangle rect,
                         RenderingContext context,
                         boolean convert,
                         java.util.Map additionalHints)
                  throws java.io.IOException,
                         org.apache.xmlgraphics.image.loader.ImageException
        Draws an image using a suitable image handler.
        Overrides:
        drawImage in class AbstractIFPainter<AFPDocumentHandler>
        Parameters:
        image - the image to be painted (it needs to of a supported image flavor)
        rect - the rectangle in which to paint the image
        context - a suitable rendering context
        convert - true to run the image through image conversion if that is necessary
        additionalHints - additional image processing hints
        Throws:
        java.io.IOException - in case of an I/O error while handling/writing the image
        org.apache.xmlgraphics.image.loader.ImageException - if an error occurs while converting the image to a suitable format

      • 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

      • 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

      • 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
        Description copied from class: AbstractIFPainter
        Draws a border rectangle. The border segments are specified through BorderProps instances.
        Specified by:
        drawBorderRect in interface IFPainter
        Overrides:
        drawBorderRect in class AbstractIFPainter<AFPDocumentHandler>
        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<AFPDocumentHandler>
        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

      • 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

      • saveGraphicsState

        protected void saveGraphicsState()
                          throws java.io.IOException
        Saves the graphics state of the rendering engine.
        Throws:
        java.io.IOException - if an I/O error occurs

      • restoreGraphicsState

        protected void restoreGraphicsState()
                             throws java.io.IOException
        Restores the last graphics state of the rendering engine.
        Throws:
        java.io.IOException - if an I/O error occurs

      • 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

      • isBackgroundRequired

        public boolean isBackgroundRequired​(BorderProps bpsBefore,
                                    BorderProps bpsAfter,
                                    BorderProps bpsStart,
                                    BorderProps bpsEnd)
        TODO Painter-specific rounded borders logic required background drawing to be made optional. A future refactoring of the rounded borders code should aim to make the need for this abstraction obsolete
        Specified by:
        isBackgroundRequired in interface IFPainter
        Overrides:
        isBackgroundRequired in class AbstractIFPainter<AFPDocumentHandler>
        Parameters:
        bpsBefore - the before border
        bpsAfter - the after border
        bpsStart - the start border
        bpsEnd - the end border
        Returns:
        true if and only if background drawing is required