* Licensed to the Apache Software Foundation (ASF) under one or more

* contributor license agreements.  See the NOTICE file distributed with

* this work for additional information regarding copyright ownership.

* The ASF licenses this file to You under the Apache License, Version 2.0

* (the "License"); you may not use this file except in compliance with

* the License.  You may obtain a copy of the License at

*

*      http://www.apache.org/licenses/LICENSE-2.0

*

* Unless required by applicable law or agreed to in writing, software

* distributed under the License is distributed on an "AS IS" BASIS,

* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

* See the License for the specific language governing permissions and

* limitations under the License.

*/

/* $Id: PCLRenderer.java 932497 2010-04-09 16:34:29Z vhennebert $ */

* There are some commonalities with AbstractPathOrientedRenderer but it's not possible

* to derive from it due to PCL's restrictions. We may need an additional common subclass to

* avoid methods copied from AbstractPathOrientedRenderer. Or we wait until after the IF redesign.

*/

* Renderer for the PCL 5 printer language. It also uses HP GL/2 for certain graphic elements.

*/

    /** logging instance */

    private static Log log = LogFactory.getLog(PCLRenderer.class);

    /** The MIME type for PCL */

    public static final String MIME_TYPE = MimeConstants.MIME_PCL_ALT;

    /** The OutputStream to write the PCL stream to */

    protected OutputStream out;

    /** The PCL generator */

    protected PCLGenerator gen;

    private boolean ioTrouble = false;

    private final Stack graphicContextStack = new Stack();

    private GraphicContext graphicContext = new GraphicContext();

    private PCLPageDefinition currentPageDefinition;

    private int currentPrintDirection = 0;

    private GeneralPath currentPath = null;

    private java.awt.Color currentFillColor = null;

    /**

     * Utility class which enables all sorts of features that are not directly connected to the

     * normal rendering process.

     */

    private PCLRenderingUtil pclUtil;

    /** contains the pageWith of the last printed page */

    private long pageWidth = 0;

    /** contains the pageHeight of the last printed page */

    private long pageHeight = 0;

    /**

     * Create the PCL renderer

     */

    public PCLRenderer() {

    }

    /** {@inheritDoc} */

    public void setUserAgent(FOUserAgent agent) {

        super.setUserAgent(agent);

        this.pclUtil = new PCLRenderingUtil(getUserAgent());

    }

    PCLRenderingUtil getPCLUtil() {

        return this.pclUtil;

    }

    /**

     * Configures the renderer to trade speed for quality if desired. One example here is the way

     * that borders are rendered.

     * @param qualityBeforeSpeed true if quality is more important than speed

     */

    public void setQualityBeforeSpeed(boolean qualityBeforeSpeed) {

        pclUtil.setRenderingMode(qualityBeforeSpeed

                ? PCLRenderingMode.QUALITY : PCLRenderingMode.SPEED);

    }

    /**

     * Controls whether PJL commands shall be generated by the PCL renderer.

     * @param disable true to disable PJL commands

     */

    public void setPJLDisabled(boolean disable) {

        pclUtil.setPJLDisabled(disable);

    }

    /**

     * Indicates whether PJL generation is disabled.

     * @return true if PJL generation is disabled.

     */

    public boolean isPJLDisabled() {

        return pclUtil.isPJLDisabled();

    }

    /**

     * Controls whether all text should be generated as bitmaps or only text for which there's

     * no native font.

     * @param allTextAsBitmaps true if all text should be painted as bitmaps

     */

    public void setAllTextAsBitmaps(boolean allTextAsBitmaps) {

        pclUtil.setAllTextAsBitmaps(allTextAsBitmaps);

    }

    /**

     * {@inheritDoc}

     */

    public void setupFontInfo(FontInfo inFontInfo) {

        //Don't call super.setupFontInfo() here!

        //The PCLRenderer uses the Java2D FontSetup which needs a special font setup

        //create a temp Image to test font metrics on

        fontInfo = inFontInfo;

        Graphics2D graphics2D = Java2DFontMetrics.createFontMetricsGraphics2D();

        FontCollection[] fontCollections = new FontCollection[] {

                new Base14FontCollection(graphics2D),

                new InstalledFontCollection(graphics2D),

                new ConfiguredFontCollection(getFontResolver(), getFontList())

        };

        userAgent.getFactory().getFontManager().setup(

                getFontInfo(), fontCollections);

    }

    /**

     * Central exception handler for I/O exceptions.

     * @param ioe IOException to handle

     */

    protected void handleIOTrouble(IOException ioe) {

        if (!ioTrouble) {

            RendererEventProducer eventProducer = RendererEventProducer.Provider.get(

                    getUserAgent().getEventBroadcaster());

            eventProducer.ioError(this, ioe);

            ioTrouble = true;

        }

    }

    /** {@inheritDoc} */

    public Graphics2DAdapter getGraphics2DAdapter() {

        return new PCLGraphics2DAdapter();

    }

    /** @return the GraphicContext used to track coordinate system transformations */

    public GraphicContext getGraphicContext() {

        return this.graphicContext;

    }

    /** @return the target resolution */

    protected int getResolution() {

        int resolution = Math.round(userAgent.getTargetResolution());

        if (resolution <= 300) {

            return 300;

        } else {

            return 600;

        }

    }

    /** {@inheritDoc} */

    public void startRenderer(OutputStream outputStream) throws IOException {

        log.debug("Rendering areas to PCL...");

        this.out = outputStream;

        this.gen = new PCLGenerator(out, getResolution());

        if (!isPJLDisabled()) {

            gen.universalEndOfLanguage();

            gen.writeText("@PJL COMMENT Produced by " + userAgent.getProducer() + "\n");

            if (userAgent.getTitle() != null) {

                gen.writeText("@PJL JOB NAME = \"" + userAgent.getTitle() + "\"\n");

            }

            gen.writeText("@PJL SET RESOLUTION = " + getResolution() + "\n");

            gen.writeText("@PJL ENTER LANGUAGE = PCL\n");

        }

        gen.resetPrinter();

        gen.setUnitOfMeasure(getResolution());

        gen.setRasterGraphicsResolution(getResolution());

    }

    /** {@inheritDoc} */

    public void stopRenderer() throws IOException {

        gen.separateJobs();

        gen.resetPrinter();

        if (!isPJLDisabled()) {

            gen.universalEndOfLanguage();

        }

    }

    /** {@inheritDoc} */

    public String getMimeType() {

        return MIME_TYPE;

    }

    /** {@inheritDoc} */

    public void renderPage(PageViewport page) throws IOException, FOPException {

        saveGraphicsState();

        //Paper source

        String paperSource = page.getForeignAttributeValue(PCLElementMapping.PCL_PAPER_SOURCE);

        if (paperSource != null) {

            gen.selectPaperSource(Integer.parseInt(paperSource));

        }

        //Output bin

        String outputBin = page.getForeignAttributeValue(PCLElementMapping.PCL_OUTPUT_BIN);

        if (outputBin != null) {

            gen.selectOutputBin(Integer.parseInt(outputBin));

        }

        // Is Page duplex?

        String pageDuplex = page.getForeignAttributeValue(PCLElementMapping.PCL_DUPLEX_MODE);

        if (pageDuplex != null) {

            gen.selectDuplexMode(Integer.parseInt(pageDuplex));

        }

        //Page size

        final long pagewidth = Math.round(page.getViewArea().getWidth());

        final long pageheight = Math.round(page.getViewArea().getHeight());

        selectPageFormat(pagewidth, pageheight);

        super.renderPage(page);

        //Eject page

        gen.formFeed();

        restoreGraphicsState();

    }

    private void selectPageFormat(long pagewidth, long pageheight) throws IOException {

        //Only set the page format if it changes (otherwise duplex printing won't work)

        if ((pagewidth != this.pageWidth) || (pageheight != this.pageHeight))  {

            this.pageWidth = pagewidth;

            this.pageHeight = pageheight;

            this.currentPageDefinition = PCLPageDefinition.getPageDefinition(

                    pagewidth, pageheight, 1000);

            if (this.currentPageDefinition == null) {

                this.currentPageDefinition = PCLPageDefinition.getDefaultPageDefinition();

                log.warn("Paper type could not be determined. Falling back to: "

                        + this.currentPageDefinition.getName());

            }

            if (log.isDebugEnabled()) {

                log.debug("page size: " + currentPageDefinition.getPhysicalPageSize());

                log.debug("logical page: " + currentPageDefinition.getLogicalPageRect());

            }

            if (this.currentPageDefinition.isLandscapeFormat()) {

                gen.writeCommand("&l1O"); //Landscape Orientation

            } else {

                gen.writeCommand("&l0O"); //Portrait Orientation

            }

            gen.selectPageSize(this.currentPageDefinition.getSelector());

            gen.clearHorizontalMargins();

            gen.setTopMargin(0);

        }

    }

    /** Saves the current graphics state on the stack. */

    protected void saveGraphicsState() {

        graphicContextStack.push(graphicContext);

        graphicContext = (GraphicContext)graphicContext.clone();

    }

    /** Restores the last graphics state from the stack. */

    protected void restoreGraphicsState() {

        graphicContext = (GraphicContext)graphicContextStack.pop();

    }

    /**

     * Clip an area. write a clipping operation given coordinates in the current

     * transform. Coordinates are in points.

     *

     * @param x the x coordinate

     * @param y the y coordinate

     * @param width the width of the area

     * @param height the height of the area

     */

    protected void clipRect(float x, float y, float width, float height) {

        //PCL cannot clip (only HP GL/2 can)

    }

    private Point2D transformedPoint(float x, float y) {

        return transformedPoint(Math.round(x), Math.round(y));

    }

    private Point2D transformedPoint(int x, int y) {

        return PCLRenderingUtil.transformedPoint(x, y, graphicContext.getTransform(),

                currentPageDefinition, currentPrintDirection);

    }

    private void changePrintDirection() {

        AffineTransform at = graphicContext.getTransform();

        int newDir;

        try {

            newDir = PCLRenderingUtil.determinePrintDirection(at);

            if (newDir != this.currentPrintDirection) {

                this.currentPrintDirection = newDir;

                gen.changePrintDirection(this.currentPrintDirection);

            }

        } catch (IOException ioe) {

            handleIOTrouble(ioe);

        }

    }

    /**

     * {@inheritDoc}

     */

    protected void startVParea(CTM ctm, Rectangle2D clippingRect) {

        saveGraphicsState();

        AffineTransform at = new AffineTransform(ctm.toArray());

        graphicContext.transform(at);

        changePrintDirection();

        if (log.isDebugEnabled()) {

            log.debug("startVPArea: " + at + " --> " + graphicContext.getTransform());

        }

    }

    /**

     * {@inheritDoc}

     */

    protected void endVParea() {

        restoreGraphicsState();

        changePrintDirection();

        if (log.isDebugEnabled()) {

            log.debug("endVPArea() --> " + graphicContext.getTransform());

        }

    }

    /**

     * Handle block traits.

     * The block could be any sort of block with any positioning

     * so this should render the traits such as border and background

     * in its position.

     *

     * @param block the block to render the traits

     */

    protected void handleBlockTraits(Block block) {

        int borderPaddingStart = block.getBorderAndPaddingWidthStart();

        int borderPaddingBefore = block.getBorderAndPaddingWidthBefore();

        float startx = currentIPPosition / 1000f;

        float starty = currentBPPosition / 1000f;

        float width = block.getIPD() / 1000f;

        float height = block.getBPD() / 1000f;

        startx += block.getStartIndent() / 1000f;

        startx -= block.getBorderAndPaddingWidthStart() / 1000f;

        width += borderPaddingStart / 1000f;

        width += block.getBorderAndPaddingWidthEnd() / 1000f;

        height += borderPaddingBefore / 1000f;

        height += block.getBorderAndPaddingWidthAfter() / 1000f;

        drawBackAndBorders(block, startx, starty, width, height);

    }

    /**

     * {@inheritDoc}

     * @todo Copied from AbstractPathOrientedRenderer

     */

    protected void handleRegionTraits(RegionViewport region) {

        Rectangle2D viewArea = region.getViewArea();

        float startx = (float)(viewArea.getX() / 1000f);

        float starty = (float)(viewArea.getY() / 1000f);

        float width = (float)(viewArea.getWidth() / 1000f);

        float height = (float)(viewArea.getHeight() / 1000f);

        if (region.getRegionReference().getRegionClass() == FO_REGION_BODY) {

            currentBPPosition = region.getBorderAndPaddingWidthBefore();

            currentIPPosition = region.getBorderAndPaddingWidthStart();

        }

        drawBackAndBorders(region, startx, starty, width, height);

    }

    /**

     * {@inheritDoc}

     */

    protected void renderText(final TextArea text) {

        renderInlineAreaBackAndBorders(text);

        String fontname = getInternalFontNameForArea(text);

        final int fontsize = text.getTraitAsInteger(Trait.FONT_SIZE);

        //Determine position

        int saveIP = currentIPPosition;

        final int rx = currentIPPosition + text.getBorderAndPaddingWidthStart();

        int bl = currentBPPosition + text.getOffset() + text.getBaselineOffset();

        try {

            final Color col = (Color)text.getTrait(Trait.COLOR);

            boolean pclFont = pclUtil.isAllTextAsBitmaps()

                    ? false

                    : HardcodedFonts.setFont(gen, fontname, fontsize, text.getText());

            if (pclFont) {

                //this.currentFill = col;

                if (col != null) {

                    //useColor(ct);

                    gen.setTransparencyMode(true, false);

                    gen.selectGrayscale(col);

                }

                saveGraphicsState();

                graphicContext.translate(rx, bl);

                setCursorPos(0, 0);

                gen.setTransparencyMode(true, true);

                if (text.hasUnderline()) {

                    gen.writeCommand("&d0D");

                }

                super.renderText(text); //Updates IPD and renders words and spaces

                if (text.hasUnderline()) {

                    gen.writeCommand("&d@");

                }

                restoreGraphicsState();

            } else {

                //Use Java2D to paint different fonts via bitmap

                final Font font = getFontFromArea(text);

                final int baseline = text.getBaselineOffset();

                //for cursive fonts, so the text isn't clipped

                int extraWidth = font.getFontSize() / 3;

                final FontMetricsMapper mapper = (FontMetricsMapper)fontInfo.getMetricsFor(

                        font.getFontName());

                int maxAscent = mapper.getMaxAscent(font.getFontSize()) / 1000;

                final int additionalBPD = maxAscent - baseline;

                Graphics2DAdapter g2a = getGraphics2DAdapter();

                final Rectangle paintRect = new Rectangle(

                        rx, currentBPPosition + text.getOffset() - additionalBPD,

                        text.getIPD() + extraWidth, text.getBPD() + additionalBPD);

                RendererContext rc = createRendererContext(paintRect.x, paintRect.y,

                        paintRect.width, paintRect.height, null);

                Map atts = new java.util.HashMap();

                atts.put(ImageHandlerUtil.CONVERSION_MODE, ImageHandlerUtil.CONVERSION_MODE_BITMAP);

                atts.put(SRC_TRANSPARENCY, "true");

                rc.setProperty(RendererContextConstants.FOREIGN_ATTRIBUTES, atts);

                Graphics2DImagePainter painter = new Graphics2DImagePainter() {

                    public void paint(Graphics2D g2d, Rectangle2D area) {

                        g2d.setFont(mapper.getFont(font.getFontSize()));

                        g2d.translate(0, baseline + additionalBPD);

                        g2d.scale(1000, 1000);

                        g2d.setColor(col);

                        Java2DRenderer.renderText(text, g2d, font);

                        renderTextDecoration(g2d, mapper, fontsize, text, 0, 0);

                    }

                    public Dimension getImageSize() {

                        return paintRect.getSize();

                    }

                };

                g2a.paintImage(painter, rc,

                        paintRect.x, paintRect.y, paintRect.width, paintRect.height);

                currentIPPosition = saveIP + text.getAllocIPD();

            }

        } catch (IOException ioe) {

            handleIOTrouble(ioe);

        }

    }

    /**

     * Paints the text decoration marks.

     * @param g2d Graphics2D instance to paint to

     * @param fm Current typeface

     * @param fontsize Current font size

     * @param inline inline area to paint the marks for

     * @param baseline position of the baseline

     * @param startx start IPD

     */

    private static void renderTextDecoration(Graphics2D g2d,

                    FontMetrics fm, int fontsize, InlineArea inline,

                    int baseline, int startx) {

        boolean hasTextDeco = inline.hasUnderline()

                || inline.hasOverline()

                || inline.hasLineThrough();

        if (hasTextDeco) {

            float descender = fm.getDescender(fontsize) / 1000f;

            float capHeight = fm.getCapHeight(fontsize) / 1000f;

            float lineWidth = (descender / -4f) / 1000f;

            float endx = (startx + inline.getIPD()) / 1000f;

            if (inline.hasUnderline()) {

                Color ct = (Color) inline.getTrait(Trait.UNDERLINE_COLOR);

                g2d.setColor(ct);

                float y = baseline - descender / 2f;

                g2d.setStroke(new BasicStroke(lineWidth));

                g2d.draw(new Line2D.Float(startx / 1000f, y / 1000f,

                        endx, y / 1000f));

            }

            if (inline.hasOverline()) {

                Color ct = (Color) inline.getTrait(Trait.OVERLINE_COLOR);

                g2d.setColor(ct);

                float y = (float)(baseline - (1.1 * capHeight));

                g2d.setStroke(new BasicStroke(lineWidth));

                g2d.draw(new Line2D.Float(startx / 1000f, y / 1000f,

                        endx, y / 1000f));

            }

            if (inline.hasLineThrough()) {

                Color ct = (Color) inline.getTrait(Trait.LINETHROUGH_COLOR);

                g2d.setColor(ct);

                float y = (float)(baseline - (0.45 * capHeight));

                g2d.setStroke(new BasicStroke(lineWidth));

                g2d.draw(new Line2D.Float(startx / 1000f, y / 1000f,

                        endx, y / 1000f));

            }

        }

    }

    /**

     * Sets the current cursor position. The coordinates are transformed to the absolute position

     * on the logical PCL page and then passed on to the PCLGenerator.

     * @param x the x coordinate (in millipoints)

     * @param y the y coordinate (in millipoints)

     */

    void setCursorPos(float x, float y) {

        try {

            Point2D transPoint = transformedPoint(x, y);

            gen.setCursorPos(transPoint.getX(), transPoint.getY());

        } catch (IOException ioe) {

            handleIOTrouble(ioe);

        }

    }

    /** Clip using the current path. */

    protected void clip() {

        if (currentPath == null) {

            throw new IllegalStateException("No current path available!");

        }

        //TODO Find a good way to do clipping. PCL itself cannot clip.

        currentPath = null;

    }

    /**

     * Closes the current subpath by appending a straight line segment from

     * the current point to the starting point of the subpath.

     */

    protected void closePath() {

        currentPath.closePath();

    }

    /**

     * Appends a straight line segment from the current point to (x, y). The

     * new current point is (x, y).

     * @param x x coordinate

     * @param y y coordinate

     */

    protected void lineTo(float x, float y) {

        if (currentPath == null) {

            currentPath = new GeneralPath();

        }

        currentPath.lineTo(x, y);

    }

    /**

     * Moves the current point to (x, y), omitting any connecting line segment.

     * @param x x coordinate

     * @param y y coordinate

     */

    protected void moveTo(float x, float y) {

        if (currentPath == null) {

            currentPath = new GeneralPath();

        }

        currentPath.moveTo(x, y);

    }

    /**

     * Fill a rectangular area.

     * @param x the x coordinate (in pt)

     * @param y the y coordinate (in pt)

     * @param width the width of the rectangle

     * @param height the height of the rectangle

     */

    protected void fillRect(float x, float y, float width, float height) {

        try {

            setCursorPos(x * 1000, y * 1000);

            gen.fillRect((int)(width * 1000), (int)(height * 1000),

                    this.currentFillColor);

        } catch (IOException ioe) {

            handleIOTrouble(ioe);

        }

    }

    /**

     * Sets the new current fill color.

     * @param color the color

     */

    protected void updateFillColor(java.awt.Color color) {

        this.currentFillColor = color;

    }

    /**

     * {@inheritDoc}

     */

    protected void renderWord(WordArea word) {

        //Font font = getFontFromArea(word.getParentArea());

        String s = word.getWord();

        try {

            gen.writeText(s);

        } catch (IOException ioe) {

            handleIOTrouble(ioe);

        }

        super.renderWord(word);

    }

    /**

     * {@inheritDoc}

     */

    protected void renderSpace(SpaceArea space) {

        AbstractTextArea textArea = (AbstractTextArea)space.getParentArea();

        String s = space.getSpace();

        char sp = s.charAt(0);

        Font font = getFontFromArea(textArea);

        int tws = (space.isAdjustable()

                ? textArea.getTextWordSpaceAdjust()

                        + 2 * textArea.getTextLetterSpaceAdjust()

                : 0);

        double dx = (font.getCharWidth(sp) + tws) / 100f;

        try {

            gen.writeCommand("&a+" + gen.formatDouble2(dx) + "H");

        } catch (IOException ioe) {

            handleIOTrouble(ioe);

        }

        super.renderSpace(space);

    }

    /**

     * Render an inline viewport.

     * This renders an inline viewport by clipping if necessary.

     * @param viewport the viewport to handle

     * @todo Copied from AbstractPathOrientedRenderer

     */

    public void renderViewport(Viewport viewport) {

        float x = currentIPPosition / 1000f;

        float y = (currentBPPosition + viewport.getOffset()) / 1000f;

        float width = viewport.getIPD() / 1000f;

        float height = viewport.getBPD() / 1000f;

        // TODO: Calculate the border rect correctly.

        float borderPaddingStart = viewport.getBorderAndPaddingWidthStart() / 1000f;

        float borderPaddingBefore = viewport.getBorderAndPaddingWidthBefore() / 1000f;

        float bpwidth = borderPaddingStart

                + (viewport.getBorderAndPaddingWidthEnd() / 1000f);

        float bpheight = borderPaddingBefore

                + (viewport.getBorderAndPaddingWidthAfter() / 1000f);

        drawBackAndBorders(viewport, x, y, width + bpwidth, height + bpheight);

        if (viewport.getClip()) {

            saveGraphicsState();

            clipRect(x + borderPaddingStart, y + borderPaddingBefore, width, height);

        }

        super.renderViewport(viewport);

        if (viewport.getClip()) {

            restoreGraphicsState();

        }

    }

    /**

     * {@inheritDoc}

     */

    protected void renderBlockViewport(BlockViewport bv, List children) {

        // clip and position viewport if necessary

        // save positions

        int saveIP = currentIPPosition;

        int saveBP = currentBPPosition;

        CTM ctm = bv.getCTM();

        int borderPaddingStart = bv.getBorderAndPaddingWidthStart();

        int borderPaddingBefore = bv.getBorderAndPaddingWidthBefore();

        //This is the content-rect

        float width = bv.getIPD() / 1000f;

        float height = bv.getBPD() / 1000f;

        if (bv.getPositioning() == Block.ABSOLUTE

                || bv.getPositioning() == Block.FIXED) {

            //For FIXED, we need to break out of the current viewports to the

            //one established by the page. We save the state stack for restoration

            //after the block-container has been painted. See below.

            List breakOutList = null;

            if (bv.getPositioning() == Block.FIXED) {

                breakOutList = breakOutOfStateStack();

            }

            AffineTransform positionTransform = new AffineTransform();

            positionTransform.translate(bv.getXOffset(), bv.getYOffset());

            //"left/"top" (bv.getX/YOffset()) specify the position of the content rectangle

            positionTransform.translate(-borderPaddingStart, -borderPaddingBefore);

            saveGraphicsState();

            //Viewport position

            concatenateTransformationMatrix(UnitConv.mptToPt(positionTransform));

            //Background and borders

            float bpwidth = (borderPaddingStart + bv.getBorderAndPaddingWidthEnd()) / 1000f;

            float bpheight = (borderPaddingBefore + bv.getBorderAndPaddingWidthAfter()) / 1000f;

            drawBackAndBorders(bv, 0, 0, width + bpwidth, height + bpheight);

            //Shift to content rectangle after border painting

            AffineTransform contentRectTransform = new AffineTransform();

            contentRectTransform.translate(borderPaddingStart, borderPaddingBefore);

            concatenateTransformationMatrix(UnitConv.mptToPt(contentRectTransform));

            //Clipping

            if (bv.getClip()) {

                clipRect(0f, 0f, width, height);

            }

            saveGraphicsState();

            //Set up coordinate system for content rectangle

            AffineTransform contentTransform = ctm.toAffineTransform();

            concatenateTransformationMatrix(UnitConv.mptToPt(contentTransform));

            currentIPPosition = 0;

            currentBPPosition = 0;

            renderBlocks(bv, children);

            restoreGraphicsState();

            restoreGraphicsState();

            if (breakOutList != null) {

                restoreStateStackAfterBreakOut(breakOutList);

            }

            currentIPPosition = saveIP;

            currentBPPosition = saveBP;

        } else {

            currentBPPosition += bv.getSpaceBefore();

            //borders and background in the old coordinate system

            handleBlockTraits(bv);

            //Advance to start of content area

            currentIPPosition += bv.getStartIndent();

            CTM tempctm = new CTM(containingIPPosition, currentBPPosition);

            ctm = tempctm.multiply(ctm);

            //Now adjust for border/padding

            currentBPPosition += borderPaddingBefore;

            Rectangle2D clippingRect = null;

            if (bv.getClip()) {

                clippingRect = new Rectangle(currentIPPosition, currentBPPosition,

                        bv.getIPD(), bv.getBPD());

            }

            startVParea(ctm, clippingRect);

            currentIPPosition = 0;

            currentBPPosition = 0;

            renderBlocks(bv, children);

            endVParea();

            currentIPPosition = saveIP;

            currentBPPosition = saveBP;

            currentBPPosition += (bv.getAllocBPD());

        }

        //currentFontName = saveFontName;

    }

    /** {@inheritDoc} */

    protected void renderReferenceArea(Block block) {

        //TODO This is the same code as in AbstractPathOrientedRenderer

        //So there's some optimization potential but not otherwise PCLRenderer is a little

        //difficult to derive from AbstractPathOrientedRenderer. Maybe an additional layer

        //between PrintRenderer and AbstractPathOrientedRenderer is necessary.

        // save position and offset

        int saveIP = currentIPPosition;

        int saveBP = currentBPPosition;

        //Establish a new coordinate system

        AffineTransform at = new AffineTransform();

        at.translate(currentIPPosition, currentBPPosition);

        at.translate(block.getXOffset(), block.getYOffset());

        at.translate(0, block.getSpaceBefore());

        if (!at.isIdentity()) {

            saveGraphicsState();

            concatenateTransformationMatrix(UnitConv.mptToPt(at));

        }

        currentIPPosition = 0;

        currentBPPosition = 0;

        handleBlockTraits(block);

        List children = block.getChildAreas();

        if (children != null) {

            renderBlocks(block, children);

        }

        if (!at.isIdentity()) {

            restoreGraphicsState();

        }

        // stacked and relative blocks effect stacking

        currentIPPosition = saveIP;

        currentBPPosition = saveBP;

    }

    /** {@inheritDoc} */

    protected void renderFlow(NormalFlow flow) {

        //TODO This is the same code as in AbstractPathOrientedRenderer

        //So there's some optimization potential but not otherwise PCLRenderer is a little

        //difficult to derive from AbstractPathOrientedRenderer. Maybe an additional layer

        //between PrintRenderer and AbstractPathOrientedRenderer is necessary.

        // save position and offset

        int saveIP = currentIPPosition;

        int saveBP = currentBPPosition;

        //Establish a new coordinate system

        AffineTransform at = new AffineTransform();

        at.translate(currentIPPosition, currentBPPosition);

        if (!at.isIdentity()) {

            saveGraphicsState();

            concatenateTransformationMatrix(UnitConv.mptToPt(at));

        }

        currentIPPosition = 0;

        currentBPPosition = 0;

        super.renderFlow(flow);

        if (!at.isIdentity()) {

            restoreGraphicsState();

        }

        // stacked and relative blocks effect stacking

        currentIPPosition = saveIP;

        currentBPPosition = saveBP;

    }

    /**

     * Concatenates the current transformation matrix with the given one, therefore establishing

     * a new coordinate system.

     * @param at the transformation matrix to process (coordinates in points)

     */

    protected void concatenateTransformationMatrix(AffineTransform at) {

        if (!at.isIdentity()) {

            graphicContext.transform(UnitConv.ptToMpt(at));

            changePrintDirection();

        }

    }

    private List breakOutOfStateStack() {

        log.debug("Block.FIXED --> break out");

        List breakOutList = new java.util.ArrayList();

        while (!this.graphicContextStack.empty()) {

            breakOutList.add(0, this.graphicContext);

            restoreGraphicsState();

        }

        return breakOutList;

    }

    private void restoreStateStackAfterBreakOut(List breakOutList) {

        log.debug("Block.FIXED --> restoring context after break-out");

        for (int i = 0, c = breakOutList.size(); i < c; i++) {

            saveGraphicsState();

            this.graphicContext = (GraphicContext)breakOutList.get(i);

        }

    }

    /** {@inheritDoc} */

    protected RendererContext createRendererContext(int x, int y, int width, int height,

            Map foreignAttributes) {

        RendererContext context = super.createRendererContext(

                x, y, width, height, foreignAttributes);

        context.setProperty(PCLRendererContextConstants.PCL_COLOR_CANVAS,

                Boolean.valueOf(pclUtil.isColorCanvasEnabled()));

        return context;

    }

    /** {@inheritDoc} */

    public void renderImage(Image image, Rectangle2D pos) {

        drawImage(image.getURL(), pos, image.getForeignAttributes());

    }

    private static final ImageFlavor[] FLAVORS = new ImageFlavor[]

                                             {ImageFlavor.GRAPHICS2D,

                                              ImageFlavor.BUFFERED_IMAGE,

                                              ImageFlavor.RENDERED_IMAGE,

                                              ImageFlavor.XML_DOM};

    /**

     * Draw an image at the indicated location.

     * @param uri the URI/URL of the image

     * @param pos the position of the image

     * @param foreignAttributes an optional Map with foreign attributes, may be null

     */

    protected void drawImage(String uri, Rectangle2D pos, Map foreignAttributes) {

        uri = URISpecification.getURL(uri);

        Rectangle posInt = new Rectangle(

                (int)pos.getX(),

                (int)pos.getY(),

                (int)pos.getWidth(),

                (int)pos.getHeight());

        Point origin = new Point(currentIPPosition, currentBPPosition);

        int x = origin.x + posInt.x;

        int y = origin.y + posInt.y;

        ImageManager manager = getUserAgent().getFactory().getImageManager();

        ImageInfo info = null;

        try {

            ImageSessionContext sessionContext = getUserAgent().getImageSessionContext();

            info = manager.getImageInfo(uri, sessionContext);

            //Only now fully load/prepare the image

            Map hints = ImageUtil.getDefaultHints(sessionContext);

            org.apache.xmlgraphics.image.loader.Image img = manager.getImage(

                    info, FLAVORS, hints, sessionContext);

            //...and process the image

            if (img instanceof ImageGraphics2D) {

                ImageGraphics2D imageG2D = (ImageGraphics2D)img;

                RendererContext context = createRendererContext(

                        posInt.x, posInt.y,

                        posInt.width, posInt.height, foreignAttributes);

                getGraphics2DAdapter().paintImage(imageG2D.getGraphics2DImagePainter(),

                        context, x, y, posInt.width, posInt.height);

            } else if (img instanceof ImageRendered) {

                ImageRendered imgRend = (ImageRendered)img;

                RenderedImage ri = imgRend.getRenderedImage();

                setCursorPos(x, y);

                gen.paintBitmap(ri,

                        new Dimension(posInt.width, posInt.height),

                        false);

            } else if (img instanceof ImageXMLDOM) {

                ImageXMLDOM imgXML = (ImageXMLDOM)img;

                renderDocument(imgXML.getDocument(), imgXML.getRootNamespace(),

                        pos, foreignAttributes);

            } else {

                throw new UnsupportedOperationException("Unsupported image type: " + img);

            }

        } catch (ImageException ie) {

            ResourceEventProducer eventProducer = ResourceEventProducer.Provider.get(

                    getUserAgent().getEventBroadcaster());

            eventProducer.imageError(this, (info != null ? info.toString() : uri), ie, null);

        } catch (FileNotFoundException fe) {

            ResourceEventProducer eventProducer = ResourceEventProducer.Provider.get(

                    getUserAgent().getEventBroadcaster());

            eventProducer.imageNotFound(this, (info != null ? info.toString() : uri), fe, null);

        } catch (IOException ioe) {

            ResourceEventProducer eventProducer = ResourceEventProducer.Provider.get(

                    getUserAgent().getEventBroadcaster());

            eventProducer.imageIOError(this, (info != null ? info.toString() : uri), ioe, null);

        }

    }

    /** {@inheritDoc} */

    public void renderForeignObject(ForeignObject fo, Rectangle2D pos) {

        Document doc = fo.getDocument();

        String ns = fo.getNameSpace();

        renderDocument(doc, ns, pos, fo.getForeignAttributes());

    }

    /**

     * Common method to render the background and borders for any inline area.

     * The all borders and padding are drawn outside the specified area.

     * @param area the inline area for which the background, border and padding is to be

     * rendered

     * @todo Copied from AbstractPathOrientedRenderer

     */

    protected void renderInlineAreaBackAndBorders(InlineArea area) {

        float x = currentIPPosition / 1000f;

        float y = (currentBPPosition + area.getOffset()) / 1000f;

        float width = area.getIPD() / 1000f;

        float height = area.getBPD() / 1000f;

        float borderPaddingStart = area.getBorderAndPaddingWidthStart() / 1000f;

        float borderPaddingBefore = area.getBorderAndPaddingWidthBefore() / 1000f;

        float bpwidth = borderPaddingStart

                + (area.getBorderAndPaddingWidthEnd() / 1000f);

        float bpheight = borderPaddingBefore

                + (area.getBorderAndPaddingWidthAfter() / 1000f);

        if (height != 0.0f || bpheight != 0.0f && bpwidth != 0.0f) {

            drawBackAndBorders(area, x, y - borderPaddingBefore

                                , width + bpwidth

                                , height + bpheight);

        }

    }

    /**

     * Draw the background and borders. This draws the background and border

     * traits for an area given the position.

     *

     * @param area the area whose traits are used

     * @param startx the start x position

     * @param starty the start y position

     * @param width the width of the area

     * @param height the height of the area

     */

    protected void drawBackAndBorders(Area area, float startx, float starty,

            float width, float height) {

        BorderProps bpsBefore = (BorderProps) area.getTrait(Trait.BORDER_BEFORE);

        BorderProps bpsAfter = (BorderProps) area.getTrait(Trait.BORDER_AFTER);

        BorderProps bpsStart = (BorderProps) area.getTrait(Trait.BORDER_START);

        BorderProps bpsEnd = (BorderProps) area.getTrait(Trait.BORDER_END);

        // draw background

        Trait.Background back;

        back = (Trait.Background) area.getTrait(Trait.BACKGROUND);

        if (back != null) {

            // Calculate padding rectangle

            float sx = startx;

            float sy = starty;

            float paddRectWidth = width;

            float paddRectHeight = height;

            if (bpsStart != null) {

                sx += bpsStart.width / 1000f;

                paddRectWidth -= bpsStart.width / 1000f;

            }

            if (bpsBefore != null) {

                sy += bpsBefore.width / 1000f;

                paddRectHeight -= bpsBefore.width / 1000f;

            }

            if (bpsEnd != null) {

                paddRectWidth -= bpsEnd.width / 1000f;

            }

            if (bpsAfter != null) {

                paddRectHeight -= bpsAfter.width / 1000f;

            }

            if (back.getColor() != null) {

                updateFillColor(back.getColor());

                fillRect(sx, sy, paddRectWidth, paddRectHeight);

            }

            // background image

            if (back.getImageInfo() != null) {

                ImageSize imageSize = back.getImageInfo().getSize();

                saveGraphicsState();

                clipRect(sx, sy, paddRectWidth, paddRectHeight);

                int horzCount = (int) ((paddRectWidth * 1000 / imageSize.getWidthMpt()) + 1.0f);

                int vertCount = (int) ((paddRectHeight * 1000 / imageSize.getHeightMpt()) + 1.0f);

                if (back.getRepeat() == EN_NOREPEAT) {

                    horzCount = 1;

                    vertCount = 1;

                } else if (back.getRepeat() == EN_REPEATX) {

                    vertCount = 1;

                } else if (back.getRepeat() == EN_REPEATY) {

                    horzCount = 1;

                }

                // change from points to millipoints

                sx *= 1000;

                sy *= 1000;

                if (horzCount == 1) {

                    sx += back.getHoriz();

                }

                if (vertCount == 1) {

                    sy += back.getVertical();

                }

                for (int x = 0; x < horzCount; x++) {

                    for (int y = 0; y < vertCount; y++) {

                        // place once

                        Rectangle2D pos;

                        // Image positions are relative to the currentIP/BP

                        pos = new Rectangle2D.Float(

                                sx - currentIPPosition

                                    + (x * imageSize.getWidthMpt()),

                                sy - currentBPPosition

                                    + (y * imageSize.getHeightMpt()),

                                imageSize.getWidthMpt(),

                                imageSize.getHeightMpt());

                        drawImage(back.getURL(), pos, null);

                    }

                }

                restoreGraphicsState();

            }

        }

        Rectangle2D.Float borderRect = new Rectangle2D.Float(startx, starty, width, height);

        drawBorders(borderRect, bpsBefore, bpsAfter, bpsStart, bpsEnd);

    }

    /**

     * Draws borders.

     * @param borderRect the border rectangle

     * @param bpsBefore the border specification on the before side

     * @param bpsAfter the border specification on the after side

     * @param bpsStart the border specification on the start side

     * @param bpsEnd the border specification on the end side

     */

    protected void drawBorders(Rectangle2D.Float borderRect,

            final BorderProps bpsBefore, final BorderProps bpsAfter,

            final BorderProps bpsStart, final BorderProps bpsEnd) {

        if (bpsBefore == null && bpsAfter == null && bpsStart == null && bpsEnd == null) {

            return; //no borders to paint

        }

        if (PCLRenderingMode.SPEED == pclUtil.getRenderingMode()) {

            drawFastBorders(borderRect, bpsBefore, bpsAfter, bpsStart, bpsEnd);

        } else {

            drawQualityBorders(borderRect, bpsBefore, bpsAfter, bpsStart, bpsEnd);

        }

    }

    /**

     * Draws borders. Borders are drawn as shaded rectangles with no clipping.

     * @param borderRect the border rectangle

     * @param bpsBefore the border specification on the before side

     * @param bpsAfter the border specification on the after side

     * @param bpsStart the border specification on the start side

     * @param bpsEnd the border specification on the end side

     */

    protected void drawFastBorders(Rectangle2D.Float borderRect,

            final BorderProps bpsBefore, final BorderProps bpsAfter,

            final BorderProps bpsStart, final BorderProps bpsEnd) {

        float startx = borderRect.x;

        float starty = borderRect.y;

        float width = borderRect.width;

        float height = borderRect.height;

        if (bpsBefore != null) {

            float borderWidth = bpsBefore.width / 1000f;

            updateFillColor(bpsBefore.color);

            fillRect(startx, starty, width, borderWidth);

        }

        if (bpsAfter != null) {

            float borderWidth = bpsAfter.width / 1000f;

            updateFillColor(bpsAfter.color);

            fillRect(startx, (starty + height - borderWidth),

                    width, borderWidth);

        }

        if (bpsStart != null) {

            float borderWidth = bpsStart.width / 1000f;

            updateFillColor(bpsStart.color);

            fillRect(startx, starty, borderWidth, height);

        }

        if (bpsEnd != null) {

            float borderWidth = bpsEnd.width / 1000f;

            updateFillColor(bpsEnd.color);

            fillRect((startx + width - borderWidth), starty, borderWidth, height);

        }

    }

    /**

     * Draws borders. Borders are drawn in-memory and painted as a bitmap.

     * @param borderRect the border rectangle

     * @param bpsBefore the border specification on the before side

     * @param bpsAfter the border specification on the after side

     * @param bpsStart the border specification on the start side

     * @param bpsEnd the border specification on the end side

     */

    protected void drawQualityBorders(Rectangle2D.Float borderRect,

            final BorderProps bpsBefore, final BorderProps bpsAfter,

            final BorderProps bpsStart, final BorderProps bpsEnd) {

        Graphics2DAdapter g2a = getGraphics2DAdapter();

        final Rectangle.Float effBorderRect = new Rectangle2D.Float(

                 0,

                 0,

                 borderRect.width,

                 borderRect.height);

        final Rectangle paintRect = new Rectangle(

                Math.round(borderRect.x * 1000f),

                Math.round(borderRect.y * 1000f),

                (int)Math.floor(borderRect.width * 1000f) + 1,

                (int)Math.floor(borderRect.height * 1000f) + 1);

        //Add one pixel wide safety margin around the paint area

        int pixelWidth = (int)Math.round(UnitConv.in2mpt(1) / userAgent.getTargetResolution());

        final int xoffset = Math.round(-effBorderRect.x * 1000f) + pixelWidth;

        final int yoffset = pixelWidth;

        paintRect.x += xoffset;

        paintRect.y += yoffset;

        paintRect.width += 2 * pixelWidth;

        paintRect.height += 2 * pixelWidth;

        RendererContext rc = createRendererContext(paintRect.x, paintRect.y,

                paintRect.width, paintRect.height, null);

        Map atts = new java.util.HashMap();

        atts.put(ImageHandlerUtil.CONVERSION_MODE, ImageHandlerUtil.CONVERSION_MODE_BITMAP);

        atts.put(SRC_TRANSPARENCY, "true");

        rc.setProperty(RendererContextConstants.FOREIGN_ATTRIBUTES, atts);

        Graphics2DImagePainter painter = new Graphics2DImagePainter() {

            public void paint(Graphics2D g2d, Rectangle2D area) {

                g2d.translate(xoffset, yoffset);

                g2d.scale(1000, 1000);