package jmri.util.davidflanagan;

import java.awt.*;
import java.awt.event.ActionEvent;
import java.awt.font.FontRenderContext;
import java.awt.font.LineMetrics;
import java.awt.geom.AffineTransform;
import java.awt.geom.Rectangle2D;
import java.awt.image.BufferedImage;
import java.awt.print.*;
import java.io.IOException;
import java.io.Writer;
import java.text.DateFormat;
import java.util.*;
import java.util.List;

import javax.print.attribute.*;
import javax.print.attribute.standard.MediaPrintableArea;
import javax.print.attribute.standard.OrientationRequested;
import javax.swing.*;
import javax.swing.border.EmptyBorder;

import org.python.google.common.annotations.VisibleForTesting;

import jmri.util.JmriJFrame;
import jmri.util.PaperUtils;

/**
 * Provide graphic output to a screen/printer.
 * <p>
 * This is from Chapter 12 of the O'Reilly Java book by David Flanagan with the
 * alligator on the front.
 * <p>
 * This has been extensively modified by Philip Gladstone to improve the print
 * preview functionality and to switch to using the Java 1.8 (maybe 1.2)
 * printing classes. The original code used the Java 1.1 printing classes.
 *
 * @author David Flanagan
 * @author Dennis Miller
 * @author Philip Gladstone
 */
public class HardcopyWriter extends Writer implements Printable {

    // instance variables
    protected PrinterJob printerJob;
    protected PageFormat pageFormat;
    protected Graphics2D printJobGraphics;
    protected Graphics2D page;
    protected String jobname;
    protected String line = "";
    protected int useFontSize = 7;
    protected String time;
    protected Dimension pagesizePixels;
    protected Dimension pagesizePoints;
    protected Font font, headerfont;
    protected String useFontName = "Monospaced";
    protected boolean isMonospacedFont = true;
    protected int useFontStyle = Font.PLAIN;
    protected FontRenderContext neutralFRC;
    protected FontRenderContext actualFRC;
    protected FontMetrics headermetrics;
    protected int x0, y0;
    protected int height, width;
    protected int width_including_right_margin;
    protected int headery;
    protected double titleTop; // Points down from top of page
    protected double leftMargin;
    protected float charwidth;
    protected float lineheight;
    protected float lineascent;
    protected float v_pos = 0; // The offset of the current line from the top margin.
    protected float max_v_pos = 0; // The maximum offset of the current line from the top margin.
    protected int pagenum = 0;
    protected Color color = Color.black;
    protected boolean printHeader = true;

    protected boolean isPreview;
    protected BufferedImage previewImage;
    protected Vector<BufferedImage> pageImages = new Vector<>(3, 3);
    protected JmriJFrame previewFrame;
    protected JPanel previewPanel;
    protected ImageIcon previewIcon = new ImageIcon();
    protected JLabel previewLabel = new JLabel();
    protected JToolBar previewToolBar = new JToolBar();
    protected JButton nextButton;
    protected JButton previousButton;
    protected JButton closeButton;
    protected JLabel pageCount = new JLabel();

    protected Column[] columns = {new Column(0, Integer.MAX_VALUE, Align.LEFT_WRAP)};
    protected int columnIndex = 0;

    protected double pixelScale = 1;
    protected Integer screenResolution;

    protected List<List<PrintCommand>> pageCommands = new ArrayList<>();
    protected List<PrintCommand> currentPageCommands;

    // save state between invocations of write()
    private boolean last_char_was_return = false;

    public static int DPI = 72;
    public static String NO_PRINTING_PRINTER = "skipDialog";

    // Job and Page attributes
    PrintRequestAttributeSet attributes = new HashPrintRequestAttributeSet();

    // constructor modified to add default printer name, page orientation, print header, print duplex, and page size
    // All length parameters are in points. 
    // various combinations of parameters can be set. The paper size/shape is set by the pagesize
    // parameter unless it is null, in which case the specified printer paper size is used.
    // The page orientation is set by the isLandscape parameter unless it is null, in which 
    // case the specified printer page orientation is used.
    /**
     * Constructor for HardcopyWriter
     * 
     * @param frame         The AWT Frame (only required for preview mode) --
     *                      this is used to get the screen resolution.
     * @param jobname       The name to print in the title of the page
     * @param fontName      The name of the font to use (if null, default is
     *                      used)
     * @param fontStyle     The style of the font to use (if null, default is
     *                      used)
     * @param fontsize      The size of the font to use (if null, default is
     *                      used)
     * @param leftmargin    The left margin in points
     * @param rightmargin   The right margin in points
     * @param topmargin     The top margin in points
     * @param bottommargin  The bottom margin in points
     * @param isPreview     Whether to preview the print job
     * @param printerName   The name of the printer to use (if null, default is
     *                      used)
     * @param isLandscape   Whether to print in landscape mode (if null, default
     *                      is used)
     * @param isPrintHeader Whether to print the header (if null, default is
     *                      used)
     * @param sides         The type of duplexing to use (if null, default is
     *                      used)
     * @param pagesize      The size of the page to use (if null, default is
     *                      used)
     * @throws HardcopyWriter.PrintCanceledException If the print job gets
     *                                               cancelled.
     */
    public HardcopyWriter(Frame frame, String jobname, String fontName, Integer fontStyle, Integer fontsize,
            double leftmargin, double rightmargin,
            double topmargin, double bottommargin, boolean isPreview, String printerName, Boolean isLandscape,
            Boolean isPrintHeader, Attribute sides, Dimension pagesize)
            throws HardcopyWriter.PrintCanceledException {

        initalize(frame, jobname, fontName, fontStyle, fontsize, leftmargin, rightmargin, topmargin, bottommargin,
                isPreview, printerName, isLandscape, isPrintHeader, sides, pagesize);
    }

    // this constructor is only used to determine number of character per line
    public HardcopyWriter(String fontName, Integer fontStyle, Integer fontsize, double leftmargin, double rightmargin,
            double topmargin, double bottommargin, Boolean isLandscape, Dimension pagesize)
            throws HardcopyWriter.PrintCanceledException {
        initalize(null, "", fontName, fontStyle, fontsize, leftmargin, rightmargin, topmargin, bottommargin,
                false, NO_PRINTING_PRINTER, isLandscape, false, null, pagesize);
    }

    private void initalize(Frame frame, String jobname, String fontName, Integer fontStyle, Integer fontsize,
            double leftmargin, double rightmargin,
            double topmargin, double bottommargin, boolean isPreview, String printerName, Boolean isLandscape,
            Boolean isPrintHeader, Attribute sides, Dimension pagesize)
            throws HardcopyWriter.PrintCanceledException {

        neutralFRC = new FontRenderContext(
                new AffineTransform(), // No scaling/rotation
                true, // Anti-aliasing
                true // Fractional metrics
        );

        if (isPreview) {
            GraphicsConfiguration gc = frame.getGraphicsConfiguration();
            AffineTransform at = gc.getDefaultTransform();
            pixelScale = at.getScaleX();
        }

        // print header?
        if (isPrintHeader != null) {
            this.printHeader = isPrintHeader;
        }

        this.isPreview = isPreview;

        // Get the screen resolution and cache it. This also allows us to override
        // the default resolution for testing purposes.
        if (frame == null) {
            screenResolution = 100;
        } else {
            getScreenResolution();
        }

        if (pagesize == null) {
            pagesizePixels = getPagesizePixels();
            pagesizePoints = getPagesizePoints();
        } else {
            pixelScale = 1;
            pagesizePoints = pagesize;
            // Assume 100 DPI scale factor. This is used for testing only. If !isPreview, then things
            // are set according to the printer's capabilities.
            screenResolution = 100;
            pagesizePixels = new Dimension(pagesizePoints.width * screenResolution / DPI,
                    pagesizePoints.height * screenResolution / DPI);
        }

        // Save this so that if we print, then we can keep printed stuff out of
        // the left margin.
        this.leftMargin = leftmargin;

        // skip printer selection if preview
        if (!isPreview) {
            printerJob = PrinterJob.getPrinterJob();
            printerJob.setJobName(jobname);
            printerJob.setPrintable(this);

            PageFormat pageFormat = printerJob.defaultPage();

            if (isLandscape != null) {
                pageFormat.setOrientation(isLandscape ? PageFormat.LANDSCAPE : PageFormat.PORTRAIT);
                attributes.add(isLandscape ? OrientationRequested.LANDSCAPE : OrientationRequested.PORTRAIT);
            }

            if (sides != null) {
                attributes.add(sides);
            }

            Paper paper = new Paper();
            if (pagesize != null) {
                paper.setSize(pagesize.width, pagesize.height);
                paper.setImageableArea(0, 0, pagesize.width, pagesize.height);
                pageFormat.setPaper(paper);
            } else {
                // Use the default page size but set the imageable area to the full page size
                paper = pageFormat.getPaper();
                paper.setImageableArea(0, 0, paper.getWidth(), paper.getHeight());
                pageFormat.setPaper(paper);
            }

            attributes.add(new MediaPrintableArea(0.0f, 0.0f, (float) paper.getWidth(), (float) paper.getHeight(),
                    MediaPrintableArea.INCH));

            printerJob.setPrintable(this, pageFormat);

            if (NO_PRINTING_PRINTER.equals(printerName) || printerJob.printDialog(attributes)) {
                PageFormat updatedPf = printerJob.validatePage(pageFormat);

                double widthPts = updatedPf.getPaper().getWidth();
                double heightPts = updatedPf.getPaper().getHeight();
                int orientation = updatedPf.getOrientation();

                if (orientation == PageFormat.LANDSCAPE) {
                    double temp = widthPts;
                    widthPts = heightPts;
                    heightPts = temp;
                }

                pagesizePoints = new Dimension((int) Math.round(widthPts), (int) Math.round(heightPts));
                // For PrinterJob, we often work in points directly.
                // We'll calculate pagesizePixels for compatibility if needed.
                pagesizePixels = new Dimension((int) (pagesizePoints.width * getScreenResolution() / 72.0),
                        (int) (pagesizePoints.height * getScreenResolution() / 72.0));

                if (NO_PRINTING_PRINTER.equals(printerName)) {
                    printerJob = null;
                }
            } else {
                throw new PrintCanceledException("User cancelled print request");
            }
        } else {
            if (isLandscape != null && isLandscape) {
                pagesizePoints = new Dimension(pagesizePoints.height, pagesizePoints.width);
                pagesizePixels = new Dimension(pagesizePixels.height, pagesizePixels.width);
            }
        }

        x0 = (int) leftmargin;
        y0 = (int) topmargin;
        width = pagesizePoints.width - (int) (leftmargin + rightmargin);
        height = pagesizePoints.height - (int) (topmargin + bottommargin);

        // Create a graphics context that we can use to get font metrics
        Graphics2D g = getGraphics();

        actualFRC = g.getFontRenderContext();

        if (fontsize != null) {
            useFontSize = fontsize;
        }

        if (fontName != null) {
            useFontName = fontName;
        }

        if (fontStyle != null) {
            useFontStyle = fontStyle;
        }

        // get body font and font size
        font = new Font(useFontName, useFontStyle, useFontSize);
        g.setFont(font);
        refreshMetrics();

        // header font info
        headerfont = new Font("SansSerif", Font.ITALIC, useFontSize);
        headermetrics = g.getFontMetrics(headerfont);
        headery = y0 - (int) (0.125 * DPI) - headermetrics.getHeight() + headermetrics.getAscent();
        titleTop = headery - headermetrics.getAscent();

        // compute date/time for header
        DateFormat df = DateFormat.getDateTimeInstance(DateFormat.LONG, DateFormat.SHORT);
        df.setTimeZone(TimeZone.getDefault());
        time = df.format(new Date());

        this.jobname = jobname;

        if (isPreview) {
            previewFrame = new JmriJFrame(Bundle.getMessage("PrintPreviewTitle") + " " + jobname);
            previewFrame.getContentPane().setLayout(new BorderLayout());
            toolBarInit();
            previewToolBar.setFloatable(false);
            previewFrame.getContentPane().add(previewToolBar, BorderLayout.NORTH);
            previewPanel = new JPanel();
            previewPanel.setSize((int) (pagesizePixels.width / pixelScale), (int) (pagesizePixels.height / pixelScale));
            // add the panel to the frame and make visible, otherwise creating the image will fail.
            // use a scroll pane to handle print images bigger than the window
            previewFrame.getContentPane().add(new JScrollPane(previewPanel), BorderLayout.CENTER);

            previewFrame.setSize((int) (pagesizePixels.width / pixelScale) + 48,
                    (int) (pagesizePixels.height / pixelScale) + 100);
            previewFrame.setVisible(true);
        }
    }

    /**
     * Get a graphics context for the current page (or the print job graphics
     * context if available) Make sure that this is setup with the appropriate
     * scale factor for the current page.
     * 
     * @return the graphics context
     */
    private Graphics2D getGraphics() {
        Graphics2D g = page;

        if (g != null) {
            return g;
        }

        BufferedImage img = new BufferedImage(pagesizePixels.width, pagesizePixels.height, BufferedImage.TYPE_INT_RGB);
        g = img.createGraphics();
        if (g == null) {
            throw new RuntimeException("Could not get graphics context");
        }
        setupGraphics(g, true);
        return g;
    }

    private void record(PrintCommand cmd) {
        currentPageCommands.add(cmd);
        cmd.execute(page);
    }

    /**
     * Create a print preview toolbar.
     */
    protected void toolBarInit() {
        previousButton = new JButton(Bundle.getMessage("ButtonPreviousPage"));
        previewToolBar.add(previousButton);
        previousButton.addActionListener((ActionEvent actionEvent) -> {
            pagenum--;
            displayPage();
        });
        nextButton = new JButton(Bundle.getMessage("ButtonNextPage"));
        previewToolBar.add(nextButton);
        nextButton.addActionListener((ActionEvent actionEvent) -> {
            pagenum++;
            displayPage();
        });
        pageCount = new JLabel(Bundle.getMessage("HeaderPageNum", pagenum, pageImages.size()));
        pageCount.setBorder(new EmptyBorder(0, 10, 0, 10));
        previewToolBar.add(pageCount);
        closeButton = new JButton(Bundle.getMessage("ButtonClose"));
        previewToolBar.add(closeButton);
        closeButton.addActionListener((ActionEvent actionEvent) -> {
            if (page != null) {
                page.dispose();
            }
            previewFrame.dispose();
        });

        // We want to add the paper size / orientation
        Dimension mediaSize = pagesizePoints;
        if (pagesizePixels.width > pagesizePixels.height) {
            JLabel orientationLabel = new JLabel(Bundle.getMessage("Landscape"));
            orientationLabel.setBorder(new EmptyBorder(0, 10, 0, 0));
            previewToolBar.add(orientationLabel);
            mediaSize = new Dimension(pagesizePoints.height, pagesizePoints.width);
        } else {
            JLabel orientationLabel = new JLabel(Bundle.getMessage("Portrait"));
            orientationLabel.setBorder(new EmptyBorder(0, 10, 0, 0));
            previewToolBar.add(orientationLabel);
        }
        String paperSizeName = PaperUtils.getNameFromPoints(mediaSize.width, mediaSize.height);
        if (paperSizeName != null) {
            try {
                // This converts the paper size name to the appropriate locale
                // but we don't actually know all the possible paper size names.
                paperSizeName = Bundle.getMessage(paperSizeName);
            } catch (MissingResourceException e) {
                log.debug("Paper size name {} not found", paperSizeName);
            }
            JLabel paperSizeLabel = new JLabel(paperSizeName);
            paperSizeLabel.setBorder(new EmptyBorder(0, 5, 0, 10));
            previewToolBar.add(paperSizeLabel);
        }
    }

    /**
     * Display a page image in the preview pane.
     * <p>
     * Not part of the original HardcopyWriter class.
     */
    protected void displayPage() {
        // limit the pages to the actual range
        if (pagenum > pageImages.size()) {
            pagenum = pageImages.size();
        }
        if (pagenum < 1) {
            pagenum = 1;
        }
        // enable/disable the previous/next buttons as appropriate
        previousButton.setEnabled(true);
        nextButton.setEnabled(true);
        if (pagenum == pageImages.size()) {
            nextButton.setEnabled(false);
        }
        if (pagenum == 1) {
            previousButton.setEnabled(false);
        }
        previewImage = pageImages.elementAt(pagenum - 1);
        previewFrame.setVisible(false);
        // previewIcon.setImage(previewImage);
        previewLabel.setIcon(new RetinaIcon(previewImage, pixelScale));
        // put the label in the panel (already has a scroll pane)
        previewPanel.add(previewLabel);
        // set the page count info
        pageCount.setText(Bundle.getMessage("HeaderPageNum", pagenum, pageImages.size()));
        // repaint the frame but don't use pack() as we don't want resizing
        previewFrame.invalidate();
        previewFrame.revalidate();
        previewFrame.setVisible(true);
    }

    /**
     * This function measures the size of the text in the current font. It
     * returns a Rectangle2D.
     * 
     * @param s The string to be measured (no tabs allowed)
     * @return The Rectangle2D object in points
     */

    public Rectangle2D measure(String s) {
        Rectangle2D bounds = font.getStringBounds(s, neutralFRC);
        return bounds;
    }

    /**
     * This function returns the bounding box that includes all of the strings
     * passed (when printed on top of each other)
     * 
     * @param stringList A collection of Strings
     * @return The Rectangle2D object in points
     */

    public Rectangle2D measure(Collection<String> stringList) {
        Rectangle2D bounds = null;
        for (String s : stringList) {
            Rectangle2D b = measure(s);
            if (bounds == null) {
                bounds = b;
            } else {
                bounds.add(b);
            }
        }
        return bounds;
    }

    /**
     * Get the current page size in points (logical units).
     * 
     * @return The printable page area in points
     */
    public Dimension getPrintablePagesizePoints() {
        return new Dimension(width, height);
    }

    /**
     * Function to get the current page size if this is a preview. This is the
     * pagesize in points (logical units). If this is not a preview, it still
     * returns the page size for the display. It makes use of the PaperUtils
     * class to get the default paper size (based on locale and/or printer
     * settings).
     * 
     * @return The page size in points
     */
    private Dimension getPagesizePoints() {
        return PaperUtils.getPaperSizeDimension();
    }

    /**
     * Get the screen resolution in pixels per inch. It caches this so that a
     * single value is used for the entire run of the preview/print.
     * 
     * @return The screen resolution in pixels per inch.
     */
    private int getScreenResolution() {
        if (screenResolution == null) {
            screenResolution = (int) (Toolkit.getDefaultToolkit().getScreenResolution() * pixelScale);
        }
        return screenResolution;
    }

    /**
     * Function to get the current page size if this is a preview. This is the
     * pagesize in pixels (and not points). If this is not a preview, it still
     * returns the page size for the display.
     *
     * @return The page size in pixels
     */
    private Dimension getPagesizePixels() {
        int dpi = getScreenResolution();
        Dimension pagesizePoints = getPagesizePoints();
        return new Dimension(pagesizePoints.width * dpi / DPI, pagesizePoints.height * dpi / DPI);
    }

    /**
     * Function to set the columns for future text output. Output starts in
     * first first column, and advances to the next column on a tab character.
     * This either causes truncation of the text or wrapping to the next line
     * depending on the column alignment type.
     * <p>
     * If no columns are set, then the default is one column, left aligned with
     * the full width of the page
     * </p>
     * 
     * @param columns Array of Column objects
     */
    public void setColumns(Column[] columns) {
        for (int i = 0; i < columns.length; i++) {
            if (columns[i].maxWidth) {
                if (i + 1 < columns.length) {
                    columns[i].width = columns[i + 1].position - columns[i].position;
                } else {
                    columns[i].width = width - columns[i].position;
                }
            }
            if (columns[i].getPosition() + columns[i].getWidth() > width) {
                throw new IllegalArgumentException("Column off edge of page");
            }
        }
        if (columns.length == 0) {
            columns = new Column[]{new Column(0, width, Align.LEFT_WRAP)};
        }
        this.columns = columns;
    }

    /**
     * Function to set Columns based on a {@code Collection<Column>} object
     * <p>
     * If no columns are set, then the default is one column, left aligned with
     * the full width of the page
     * </p>
     * 
     * @param columns Collection of Column objects
     */
    public void setColumns(Collection<Column> columns) {
        setColumns(columns.toArray(new Column[0]));
    }

    /**
     * Send text to Writer output. Note that the text will be aligned to the
     * current column (by default, this is one column, left aligned with the
     * full width of the page)
     *
     * @param buffer block of text characters
     * @param index  position to start printing
     * @param len    length (number of characters) of output
     */
    @Override
    public void write(char[] buffer, int index, int len) {
        synchronized (this.lock) {
            // loop through all characters passed to us

            for (int i = index; i < index + len; i++) {
                // if we haven't begun a new page, do that now
                ensureOnPage();

                // if the character is a line terminator, begin a new line
                // unless its \n after \r
                if (buffer[i] == '\n') {
                    if (!last_char_was_return) {
                        newline();
                    }
                    continue;
                }
                if (buffer[i] == '\r') {
                    newline();
                    last_char_was_return = true;
                    continue;
                } else {
                    last_char_was_return = false;
                }

                if (buffer[i] == '\f') {
                    flush_column();
                    pageBreak();
                }

                if (buffer[i] == '\t') {
                    // If the tab is in the last column, then we treat it as a conventional
                    // tab -- moving forward to the next multiple of 8 character position. Otherwise
                    // we treat it as a column separator.
                    // This only works for monospaced fonts. We also have to be in a left-aligned
                    // column
                    if (columnIndex == columns.length - 1 && columns[columnIndex].alignment.base == Align.LEFT) {
                        // In the last column and it is LEFT aligned
                        int spaces = 1; // Insert one space by default
                        if (isMonospaced()) {
                            spaces = 8 - (line.length() & 7);
                        }

                        line += " ".repeat(spaces);
                        continue;
                    }
                    // Compute where the line should go and output it
                    flush_column();
                    continue;
                }

                // if some other non-printing char, ignore it
                if (Character.isWhitespace(buffer[i]) && !Character.isSpaceChar(buffer[i])) {
                    continue;
                }

                line += buffer[i];
            }
            if (page != null && line.length() > 0) {
                // If we have pending text, flush it now
                flush_column();
            }
        }
    }

    /**
     * Flush the current line to the current column. This may be called
     * recursively if the line is too long for the current column and wrapping
     * is enabled.
     */
    private void flush_column() {
        Column column = columns[columnIndex];

        Rectangle2D bounds = font.getStringBounds(line, neutralFRC);

        int stringStartPos = column.getStartPos(bounds.getWidth());
        int columnWidth = Math.min(column.getWidth(), width - stringStartPos);

        if (bounds.getWidth() > columnWidth) {
            // This text does not fit. This means that we need to split it and wrap it to the next line.

            // First, we need to find where to split the string. 
            // Do this with a binary search to be efficient. We take spaces into account.
            // We want to get the longest possible string that will fit in the column.
            int splitPos = 0;
            int low = 0;
            int high = line.length();
            while (low < high) {
                int mid = (low + high) / 2;
                if (font.getStringBounds(line.substring(0, mid), neutralFRC).getWidth() < columnWidth) {
                    // We know that the first mid characters will fit in the column.
                    low = mid + 1;
                } else {
                    // We know that the first mid characters will not fit in the column.
                    high = mid;
                }
            }
            // low is the first character that causes the string not to fit
            splitPos = low - 1;

            if (column.isWrap()) {
                // We have to back up to a space to avoid splitting a word.
                while (splitPos > 0 && !Character.isSpaceChar(line.charAt(splitPos))) {
                    splitPos--;
                }
                if (splitPos == 0) {
                    // We couldn't find a space to split on, so we have to split on a non-space.
                    splitPos = low - 1;
                }
            }

            if (splitPos < 1) {
                splitPos = 1; // Even if it won't fit, we have to output something.   
            }
            // Now we can split the string and wrap it to the next line.
            String firstLine = line.substring(0, splitPos);
            stringStartPos = column.getStartPos(font.getStringBounds(firstLine, actualFRC).getWidth());

            // We can now output the first line.
            record(new DrawString(firstLine, x0 + stringStartPos, y0 + v_pos + lineascent));

            if (column.isWrap()) {
                // Skip any spaces at the split position
                while (splitPos < line.length() - 1 && Character.isSpaceChar(line.charAt(splitPos))) {
                    splitPos++;
                }
                String secondLine = line.substring(splitPos);
                // We can now output the second line.
                v_pos += lineheight;
                line = secondLine;
                int saveColumnIndex = columnIndex;
                flush_column();
                // This has already advanced the column index, so we back it up
                columnIndex = saveColumnIndex;
                max_v_pos = Math.max(max_v_pos, v_pos);
                v_pos -= lineheight;
            }
        } else {
            record(new DrawString(line, x0 + stringStartPos, y0 + v_pos + lineascent));
        }

        if (columnIndex < columns.length - 1) {
            columnIndex++;
        }

        line = "";
    }

    /**
     * Write a given String with the desired color.
     * <p>
     * Reset the text color back to the default after the string is written.
     * This method is really only good for changing the color of a complete line
     * (or column).
     *
     * @param c the color desired for this String
     * @param s the String
     * @throws java.io.IOException if unable to write to printer
     */
    public void write(Color c, String s) throws IOException {
        ensureOnPage();
        record(new SetColor(c));
        write(s);
        // note that the above write(s) can cause the page to become null!
        if (currentPageCommands != null) {
            record(new SetColor(color)); // reset color
        }
    }

    @Override
    public void flush() {
    }

    /**
     * Handle close event of pane. Modified to clean up the added preview
     * capability.
     */
    @Override
    public void close() {
        synchronized (this.lock) {
            if (page != null) {
                pageBreak();
            }
            if (isPreview) {
                // set up first page for display in preview frame
                // to get the image displayed, put it in an icon and the icon in a label
                pagenum = 1;
                displayPage();
            } else if (printerJob != null) {
                try {
                    // This is where the actual printing happens. I wonder if this should
                    // be spun off into its own task to prevent the GUI from freezing
                    // if the printing process is slow.
                    printerJob.print(attributes);
                } catch (PrinterException e) {
                    log.error("Error printing", e);
                }
            }
        }
    }

    /**
     * Free up resources .
     * <p>
     * Added so that a preview can be canceled.
     */
    public void dispose() {
        synchronized (this.lock) {
            if (page != null) {
                page.dispose();
            }
            if (previewFrame != null) {
                previewFrame.dispose();
            }
            if (printerJob != null) {
                printerJob.cancel();
            }
        }
    }

    /**
     * Set the font to be used for the next write operation. This really only is
     * good for the next line (or column) of output. Use with caution.
     * <p>
     * If any of the parameters are null, the current value will be used.
     * 
     * @param name  the name of the font
     * @param style the style of the font
     * @param size  the size of the font
     */
    public void setFont(String name, Integer style, Integer size) {
        synchronized (this.lock) {
            if (style == null) {
                style = useFontStyle;
            }
            if (size == null) {
                size = useFontSize;
            }
            if (name == null) {
                name = useFontName;
            }
            font = new Font(name, style, size);
            useFontName = name;
            useFontStyle = style;
            useFontSize = size;
            // if a page is pending, set the new font, else newpage() will
            if (currentPageCommands != null) {
                record(new SetFont(font));
                refreshMetrics();
            }
        }
    }

    /**
     * Refresh the font metrics after changing things like font, size, etc.
     */
    private void refreshMetrics() {
        Rectangle2D bounds = font.getStringBounds("m".repeat(100), neutralFRC);
        charwidth = (float) (bounds.getWidth() / 100.0);
        LineMetrics lm = font.getLineMetrics("Your text here", neutralFRC);
        lineheight = lm.getHeight();
        lineascent = lm.getAscent();

        // compute lines and columns within margins
        double widthI = font.getStringBounds("i", neutralFRC).getWidth();
        double widthM = font.getStringBounds("m", neutralFRC).getWidth();

        // Using a tiny epsilon check for double precision stability
        isMonospacedFont = Math.abs(widthI - widthM) < 0.0001;
    }

    /**
     * Get the height of a line of text. This is the amount that the vertical
     * position will advance for each line.
     * 
     * @return the height of a line of text
     */
    public float getLineHeight() {
        return this.lineheight;
    }

    /**
     * Get the size of the font.
     * 
     * @return the size of the font
     */
    public int getFontSize() {
        return this.useFontSize;
    }

    /**
     * Get the width of a character. This is only valid for monospaced fonts.
     * 
     * @return the width of a character, or null if the font is not monospaced
     */
    public Float getCharWidth() {
        // TODO DAB temp fix to prevent NPE when printing non-monospaced fonts
        //        if (!isMonospaced()) {
        //            return null;
        //        }
        return this.charwidth;
    }

    /**
     * Get the ascent of the font. This is the distance from the baseline to the
     * top of the font.
     * 
     * @return the ascent of the font
     */
    public float getLineAscent() {
        return this.lineascent;
    }

    /**
     * sets the default text color
     *
     * @param c the new default text color
     */
    public void setTextColor(Color c) {
        color = c;
        if (currentPageCommands != null) {
            record(new SetColor(c));
        }
    }

    /**
     * End the current page. Subsequent output will be on a new page
     */
    public void pageBreak() {
        synchronized (this.lock) {
            if (isPreview && previewImage != null) {
                pageImages.addElement(previewImage);
            }
            if (page != null) {
                page.dispose();
            }
            page = null;
            currentPageCommands = null;
            previewImage = null;
        }
    }

    /**
     * Return the number of columns of characters that fit on a page.
     *
     * @return the number of characters in a line or null if the font is not
     *         monospaced
     */
    public Integer getCharactersPerLine() {
        // TODO DAB temp fix to prevent NPE when printing non-monospaced fonts
        //        if (!isMonospaced()) {
        //            return null;
        //        }
        int chars_per_line = (int) (width / charwidth);
        return chars_per_line;
    }

    /**
     * This ensures that the required amount of vertical space is available. If
     * not, a page break is inserted.
     * 
     * @param points The amount of vertical space to ensure in points.
     */
    public void ensureVerticalSpace(int points) {
        if (v_pos + points + lineheight >= height) {
            pageBreak();
        }
    }

    /**
     * This leaves the required amount of vertical space. If not enough space is
     * available, a page break is inserted.
     * 
     * @param points The amount of vertical space to leave in points.
     */
    public void leaveVerticalSpace(float points) {
        v_pos += points;
        ensureVerticalSpace(0);
    }

    /**
     * Internal method begins a new line method modified by Dennis Miller to add
     * preview capability
     */
    protected void newline() {
        if (page != null) {
            flush_column();
        }
        line = "";
        columnIndex = 0;
        v_pos = Math.max(v_pos, max_v_pos);
        max_v_pos = 0;
        v_pos += lineheight;
        // Note that text is printed *below* the current v_pos, so we need to
        // check if we have enough space for that line.
        if (v_pos + lineheight >= height) {
            pageBreak();
        }
    }

    /**
     * Ensure that we have a page object. The page is null when we are before
     * the first page, or between pages.
     */
    protected void ensureOnPage() {
        if (page == null) {
            newpage();
        }
    }

    /**
     * Internal method beings a new page and prints the header method modified
     * by Dennis Miller to add preview capability
     */
    private void newpage() {
        pagenum++;
        v_pos = 0;
        currentPageCommands = new ArrayList<>();

        page = getGraphics();

        if (isPreview) {
            previewImage = new BufferedImage(pagesizePixels.width, pagesizePixels.height, BufferedImage.TYPE_INT_RGB);
            page = previewImage.createGraphics();

            setupGraphics(page, true);

            page.setColor(Color.white);
            page.fillRect(0, 0, (int) (pagesizePixels.width * 72.0 / getScreenResolution()),
                    (int) (pagesizePixels.height * 72.0 / getScreenResolution()));
            page.setColor(color);
        } else {
            // We only need this is non-preview mode. 
            pageCommands.add(currentPageCommands);
        }

        if (printHeader) {
            record(new SetFont(headerfont));
            record(new DrawString(jobname, x0, headery));

            FontRenderContext frc = page.getFontMetrics().getFontRenderContext();

            String s = "- " + pagenum + " -"; // print page number centered
            Rectangle2D bounds = headerfont.getStringBounds(s, frc);
            record(new DrawString(s, (int) (x0 + (this.width - bounds.getWidth()) / 2), headery));

            bounds = headerfont.getStringBounds(time, frc);
            record(new DrawString(time, (int) (x0 + width - bounds.getWidth()), headery));

            // draw a line under the header
            int y = headery + headermetrics.getDescent() + 1;
            record(new DrawLine(x0, y, x0 + width, y));
        }
        // set basic font
        record(new SetFont(font));
        refreshMetrics();
    }

    /**
     * Gets all the pages as Images.
     * 
     * @return the current page as a BufferedImage
     */
    public Vector<BufferedImage> getPageImages() {
        return pageImages;
    }

    /**
     * Gets the current page num -- this can be used to determine when a page
     * break has happened. The page number may be increased whenever a newline
     * is printed.
     * 
     * @return the current page number
     */
    public int getPageNum() {
        return pagenum + (page == null ? 1 : 0);
    }

    /**
     * Setup the graphics context for preview. We want the subpixel positioning
     * for text.
     * 
     * @param g2d        the graphics context to setup
     * @param applyScale whether to apply the scale factor
     */
    private void setupGraphics(Graphics2D g2d, boolean applyScale) {
        if (applyScale) {
            double scale = getScreenResolution() / (float) DPI;
            g2d.scale(scale, scale);
        }

        // Enable Antialiasing (Smooths the edges)
        g2d.setRenderingHint(RenderingHints.KEY_TEXT_ANTIALIASING,
                RenderingHints.VALUE_TEXT_ANTIALIAS_ON);

        // Enable Fractional Metrics (Improves character spacing)
        g2d.setRenderingHint(RenderingHints.KEY_FRACTIONALMETRICS,
                RenderingHints.VALUE_FRACTIONALMETRICS_ON);

        // High Quality Rendering
        g2d.setRenderingHint(RenderingHints.KEY_RENDERING,
                RenderingHints.VALUE_RENDER_QUALITY);

        // Set Interpolation for the Image (The most important for images)
        g2d.setRenderingHint(RenderingHints.KEY_INTERPOLATION,
                RenderingHints.VALUE_INTERPOLATION_BICUBIC);

        // Enable Antialiasing (Smooths the edges)
        g2d.setRenderingHint(RenderingHints.KEY_ANTIALIASING,
                RenderingHints.VALUE_ANTIALIAS_ON);
    }

    /**
     * Write a graphic to the printout.
     * <p>
     * This was not in the original class, but was added afterwards by Bob
     * Jacobsen. Modified by D Miller. Modified by P Gladstone. The image well
     * be rendered at 1.5 pixels per point.
     * <p>
     * The image is positioned on the right side of the paper, at the current
     * height.
     *
     * @param c image to write
     * @param i ignored, but maintained for API compatibility
     */
    public void write(Image c, Component i) {
        writeSpecificSize(c, new Dimension((int) (c.getWidth(null) / 1.5), (int) (c.getHeight(null) / 1.5)));
    }

    /**
     * Write the decoder pro icon to the output. Method added by P Gladstone.
     * This actually uses the high resolution image. It also advances the v_pos
     * appropriately (unless no_advance is True)
     * <p>
     * The image is positioned on the right side of the paper, at the current
     * height.
     * 
     * @param no_advance if true, do not advance the v_pos
     * @return The actual size in points of the icon that was rendered.
     */
    public Dimension writeDecoderProIcon(boolean no_advance) {
        ImageIcon hiresIcon =
                new ImageIcon(HardcopyWriter.class.getResource("/resources/decoderpro_large.png"));
        Image icon = hiresIcon.getImage();
        Dimension size = writeSpecificSize(icon, new Dimension(icon.getWidth(null) / 6, icon.getHeight(null) / 6));
        if (!no_advance) {
            // Advance the v_pos by the height of the icon
            v_pos += size.height + lineheight;
        }
        return size;
    }

    /**
     * Write the decoder pro icon to the output. Method added by P Gladstone.
     * This actually uses the high resolution image. It also advances the v_pos
     * appropriately.
     * <p>
     * The image is positioned on the right side of the paper, at the current
     * height.
     *
     * @return The actual size in points of the icon that was rendered.
     */
    public Dimension writeDecoderProIcon() {
        return writeDecoderProIcon(false);
    }

    /**
     * Write an image to the output at the current position, scaled to the
     * required size. More importantly, it does not save the image object in
     * memory, but will re-read it from the disk when it needs to be used. This
     * is needed if there are a lot of large images in a printout.
     * 
     * @param icon         The ImageIconWrapper object to display
     * @param requiredSize The size in points to display the image
     * @return The actual size rendered
     */
    public Dimension writeSpecificSize(ImageIconWrapper icon, Dimension requiredSize) {
        ensureOnPage();

        float widthScale = (float) requiredSize.width / icon.getIconWidth();
        float heightScale = (float) requiredSize.height / icon.getIconHeight();
        float scale = Math.min(widthScale, heightScale);

        Dimension d = new Dimension(Math.round(icon.getIconWidth() * scale), Math.round(icon.getIconHeight() * scale));

        int x = x0 + width - d.width;
        int y = (int) (y0 + v_pos + lineascent);

        if (isPreview) {
            float pixelsPerPoint = getScreenResolution() / (float) DPI;
            Image c = ImageUtils.getScaledInstance(icon.getImage(), (int) (requiredSize.width * pixelsPerPoint),
                    (int) (requiredSize.height * pixelsPerPoint));

            record(new DrawImage(c, x, y, d.width, d.height));
        } else {
            record(new DrawImageIconFile(icon.getPathName(), x, y, d.width, d.height));
        }
        return d;
    }

    /**
     * Write a graphic to the printout at a specific size (in points)
     * <p>
     * This was not in the original class, but was added afterwards by Kevin
     * Dickerson. Heavily modified by P Gladstone. If the image is large and
     * there are many images in the printout, then it probably makes sense to
     * pass in a HardcopyWriter.ImageIconWrapper object instead. This will save
     * memory as it just retains the filename until time comes to actually
     * render the image.
     * <p>
     * The image is positioned on the right side of the paper, at the current
     * height. The image aspect ratio is maintained.
     *
     * @param c            the image to print
     * @param requiredSize the dimensions (in points) to scale the image to. The
     *                     image will fit inside the bounding box.
     * @return the dimensions of the image in points
     */
    public Dimension writeSpecificSize(Image c, Dimension requiredSize) {
        // if we haven't begun a new page, do that now
        ensureOnPage();

        float widthScale = (float) requiredSize.width / c.getWidth(null);
        float heightScale = (float) requiredSize.height / c.getHeight(null);
        float scale = Math.min(widthScale, heightScale);

        Dimension d = new Dimension(Math.round(c.getWidth(null) * scale), Math.round(c.getHeight(null) * scale));

        if (isPreview) {
            float pixelsPerPoint = getScreenResolution() / (float) DPI;
            c = ImageUtils.getScaledInstance(c, (int) (requiredSize.width * pixelsPerPoint),
                    (int) (requiredSize.height * pixelsPerPoint));
            d = new Dimension((int) (c.getWidth(null) / pixelsPerPoint), (int) (c.getHeight(null) / pixelsPerPoint));
        }

        int x = x0 + width - d.width;
        int y = (int) (y0 + v_pos + lineascent);

        record(new DrawImage(c, x, y, d.width, d.height));
        return d;
    }

    /**
     * A Method to allow a JWindow to print itself at the current line position
     * <p>
     * This was not in the original class, but was added afterwards by Dennis
     * Miller.
     * <p>
     * Intended to allow for a graphic printout of the speed table, but can be
     * used to print any window. The JWindow is passed to the method and prints
     * itself at the current line and aligned at the left margin. The calling
     * method should check for sufficient space left on the page and move it to
     * the top of the next page if there isn't enough space.
     * <p>
     * I'm not convinced that this is actually used as the code that invokes it
     * is under a test for Java version before 1.5.
     *
     * @param jW the window to print
     */
    public void write(JWindow jW) {
        // if we haven't begun a new page, do that now
        ensureOnPage();

        int x = x0;
        int y = (int) (y0 + v_pos);
        record(new PrintWindow(jW, x, y));
    }

    /**
     * Draw a line on the printout. Calls to this should be replaced by calls to
     * `writeExactLine` which doesn't offset the line by strange amounts.
     * <p>
     * This was not in the original class, but was added afterwards by Dennis
     * Miller.
     * <p>
     * hStart and hEnd represent the horizontal point positions. The lines
     * actually start in the middle of the character position (to the left) to
     * make it easy to draw vertical lines and space them between printed
     * characters. This is (unfortunately) bad for getting something on the
     * right margin.
     * <p>
     * vStart and vEnd represent the vertical point positions. Horizontal lines
     * are drawn underneath below the vStart position. They are offset so they
     * appear evenly spaced, although they don't take into account any space
     * needed for descenders, so they look best with all caps text. If vStart is
     * set to the current vPos, then the line is under the current row of text.
     *
     * @param vStart vertical starting position
     * @param hStart horizontal starting position
     * @param vEnd   vertical ending position
     * @param hEnd   horizontal ending position
     */
    public void writeLine(float vStart, float hStart, float vEnd, float hEnd) {
        writeExactLine((vStart + (lineheight - lineascent) / 2), hStart - useFontSize / 4.0f,
                (vEnd + (lineheight - lineascent) / 2), hEnd - useFontSize / 4.0f);
    }

    /**
     * Draw a line on the printout.
     * <p>
     * This was not in the original class, but was added afterwards by Philip
     * Gladstone.
     * <p>
     * hStart and hEnd represent the horizontal point positions.
     * <p>
     * vStart and vEnd represent the vertical point positions.
     *
     * @param vStart vertical starting position
     * @param hStart horizontal starting position
     * @param vEnd   vertical ending position
     * @param hEnd   horizontal ending position
     */
    public void writeExactLine(float vStart, float hStart, float vEnd, float hEnd) {
        // if we haven't begun a new page, do that now
        ensureOnPage();

        int xStart = (int) (x0 + hStart);
        int xEnd = (int) (x0 + hEnd);
        int yStart = (int) (y0 + vStart);
        int yEnd = (int) (y0 + vEnd);
        record(new DrawLine(xStart, yStart, xEnd, yEnd));

        // We want to make sure that the lines are within the printable area
        if (xStart < leftMargin) {
            leftMargin = xStart;
        }
    }

    /**
     * Get the current vertical position on the page
     * 
     * @return the current vertical position of the base of the current line on
     *         the page (in points)
     */
    public float getCurrentVPos() {
        return v_pos;
    }

    /**
     * Print vertical borders on the current line at the left and right sides of
     * the page at pixel positions 0 and width. Border lines are one text line
     * in height. ISSUE: Where should these lines be drawn?
     * <p>
     * This was not in the original class, but was added afterwards by Dennis
     * Miller.
     */
    public void writeBorders() {
        writeLine((int) v_pos, 0, (int) (v_pos + lineheight), 0);
        writeLine((int) v_pos, width, (int) (v_pos + lineheight), width);
    }

    /**
     * Increase line spacing by a percentage
     * <p>
     * This method should be invoked immediately after a new HardcopyWriter is
     * created.
     * <p>
     * This method was added to improve appearance when printing tables
     * <p>
     * This was not in the original class, added afterwards by DaveDuchamp.
     *
     * @param percent percentage by which to increase line spacing
     */
    public void increaseLineSpacing(int percent) {
        float delta = (lineheight * percent) / 100;
        lineheight = lineheight + delta;
        lineascent = lineascent + delta;
    }

    /**
     * Returns true if the current font is monospaced
     * 
     * @return true if the current font is monospaced.
     */
    public boolean isMonospaced() {
        return isMonospacedFont;
    }

    /**
     * Get the list of commands for the whole document.
     * 
     * @return the list of commands for the document
     */
    public List<List<PrintCommand>> getPageCommands() {
        return pageCommands;
    }

    public static class PrintCanceledException extends Exception {

        public PrintCanceledException(String msg) {
            super(msg);
        }
    }

    public static class ColumnException extends Exception {
        public ColumnException(String msg) {
            super(msg);
        }
    }

    /**
     * Enum to represent the alignment of text in a column.
     */
    public enum Align {
        LEFT,
        CENTER,
        RIGHT,
        LEFT_WRAP(LEFT),
        CENTER_WRAP(CENTER),
        RIGHT_WRAP(RIGHT);

        private final Align base;

        // Constructor for base values
        Align() {
            this.base = null;
        }

        // Constructor for wrapped values
        Align(Align base) {
            this.base = base;
        }

        /**
         * Gets the base alignment of the column
         * 
         * @return The base alignment of the column
         */
        public Align getBase() {
            return (base == null) ? this : base;
        }

        /**
         * Gets whether the alignment is a wrap alignment
         * 
         * @return true if the alignment is a wrap alignment
         */
        public boolean isWrap() {
            return base != null;
        }
    }

    /**
     * Class to represent a column in the output. This has a start position,
     * width and alignment. This allows left, center or right alignment, with or
     * without wrapping.
     */
    public static class Column {
        int position;
        int width;
        boolean maxWidth = false;
        Align alignment;

        /**
         * Create a Column with specified position, width and alignment
         * 
         * @param position  The position of the column in points
         * @param width     The width of the column in points
         * @param alignment The alignment of the column
         */
        public Column(int position, int width, Align alignment) {
            this.position = position;
            this.width = width;
            this.alignment = alignment;
        }

        /**
         * Create a Column with specified position and alignment. The width will
         * be calculated up to the next column.
         * 
         * @param position  The position of the column in points
         * @param alignment The alignment of the column
         */
        public Column(int position, Align alignment) {
            this.position = position;
            this.maxWidth = true;
            this.alignment = alignment;
        }

        /**
         * Create a Column with specified position and width with LEFT alignment
         * 
         * @param position The position of the column in points
         * @param width    The width of the column in points
         */
        public Column(int position, int width) {
            this(position, width, Align.LEFT);
        }

        /**
         * Sets the width of the column in points
         * 
         * @param width The new width of the column in points
         */
        public void setWidth(int width) {
            this.width = width;
        }

        /**
         * Gets the width of the column in points
         * 
         * @return The width of the column in points
         */
        public int getWidth() {
            return width;
        }

        /**
         * Gets the starting position of text of length strlen (in points)
         * 
         * @param strlen The length of the text in points
         * @return The starting position of the text in points
         */
        public int getStartPos(double strlen) {
            switch (alignment.getBase()) {
                case LEFT:
                    return position;
                case CENTER:
                    return (int) (position + width / 2 - strlen / 2);
                case RIGHT:
                    return (int) (position + width - strlen);
                default:
                    throw new IllegalArgumentException("Unknown alignment: " + alignment);
            }
        }

        /**
         * Gets the starting position of the column in points
         * 
         * @return The starting position of the column in points
         */
        public int getPosition() {
            return position;
        }

        /**
         * Gets the alignment of the column
         * 
         * @return The alignment of the column
         */
        public Align getAlignment() {
            return alignment;
        }

        /**
         * Gets whether the column is a wrap column
         * 
         * @return true if the column is a wrap column
         */
        public boolean isWrap() {
            return alignment.isWrap();
        }

        @Override
        public String toString() {
            return "Column{" + "position=" + position + ", width=" + width + ", alignment=" + alignment + "}";
        }

        /**
         * Stretch the columns to fit the specified width. The columns are
         * assumed to be sorted by position. The input widths are treated as
         * ratios. There is a gap between the columns.
         * 
         * @param columns The columns to stretch
         * @param width   The width to stretch to in points
         * @param gap     The gap between the columns in points
         * @return The stretched columns
         */
        public static ArrayList<Column> stretchColumns(Collection<Column> columns, int width, int gap) {
            ArrayList<Column> newColumns = new ArrayList<>();
            double totalWidth = 0;
            for (Column column : columns) {
                totalWidth += column.getWidth();
            }

            double scale = (width - (columns.size() - 1) * gap) / totalWidth;
            // Two passes -- the first to compute the starting column numbers
            // the second to compute the widths
            int accumulatedGap = 0;
            int accumulatedWidth = 0;
            for (Column column : columns) {
                newColumns.add(new Column((int) Math.round(accumulatedWidth * scale) + accumulatedGap, 0,
                        column.getAlignment()));
                accumulatedWidth += column.getWidth();
                accumulatedGap += gap;
            }

            // Now set the widths
            for (int i = 0; i < newColumns.size(); i++) {
                Column column = newColumns.get(i);
                if (i == newColumns.size() - 1) {
                    column.setWidth(width - column.getPosition());
                } else {
                    column.setWidth(newColumns.get(i + 1).getPosition() - column.getPosition() - gap);
                }
            }

            return newColumns;
        }
    }

    /**
     * Replay the recorded commands to the graphics context. This is called by
     * the PrinterJob.
     */
    @Override
    public int print(Graphics g, PageFormat pf, int pageIndex) throws PrinterException {
        if (pageIndex >= pageCommands.size()) {
            return NO_SUCH_PAGE;
        }

        if (!(g instanceof Graphics2D)) {
            throw new PrinterException("Graphics context is not a Graphics2D object: " + g.getClass().getName());
        }

        Graphics2D g2d = (Graphics2D) g;

        // We already include the margins, but we need to worry about the page header.
        double yOffset = pf.getImageableY();
        if (yOffset > titleTop) {
            // We have to translate down to make sure that the header is on the page
            g2d.translate(0, yOffset - titleTop);
        }
        double xOffset = pf.getImageableX();
        if (xOffset > leftMargin) {
            // We have to translate right to make sure that the left margin is printable.
            g2d.translate(xOffset - leftMargin, 0);
        }
        //g2d.translate(pf.getImageableX(), pf.getImageableY());

        // Setup initial state
        g2d.setFont(font);
        g2d.setColor(color);
        setupGraphics(g2d, false);

        for (PrintCommand cmd : pageCommands.get(pageIndex)) {
            cmd.execute(g2d);
        }

        return PAGE_EXISTS;
    }

    @Override
    public String toString() {
        return "HardcopyWriter(" +
                ", page=" +
                page +
                ", lineheight=" +
                lineheight +
                ", lineascent=" +
                lineascent +
                ", Msize=" +
                measure("M") +
                ", pagesizePoints=" +
                pagesizePoints +
                ", pagesizePixels=" +
                pagesizePixels +
                ")";
    }

    protected interface PrintCommand {
        void execute(Graphics2D g);
    }

    protected static class DrawString implements PrintCommand {
        String s;
        float x, y;

        DrawString(String s, float x, float y) {
            this.s = s;
            this.x = x;
            this.y = y;
        }

        @VisibleForTesting
        public String getString() {
            return s;
        }

        @Override
        public void execute(Graphics2D g) {
            g.drawString(s, x, y);
        }
    }

    protected static class DrawLine implements PrintCommand {
        int x1, y1, x2, y2;

        DrawLine(int x1, int y1, int x2, int y2) {
            this.x1 = x1;
            this.y1 = y1;
            this.x2 = x2;
            this.y2 = y2;
        }

        @Override
        public void execute(Graphics2D g) {
            g.drawLine(x1, y1, x2, y2);
        }
    }

    protected static class DrawImage implements PrintCommand {
        Image img;
        int x, y, width, height;

        DrawImage(Image img, int x, int y, int width, int height) {
            this.img = img;
            this.x = x;
            this.y = y;
            this.width = width;
            this.height = height;
        }

        @Override
        public void execute(Graphics2D g) {
            g.drawImage(img, x, y, width, height, null);
        }
    }

    protected static class DrawImageIconFile implements PrintCommand {
        String pathName;
        int x, y, width, height;

        DrawImageIconFile(String pathName, int x, int y, int width, int height) {
            this.pathName = pathName;
            this.x = x;
            this.y = y;
            this.width = width;
            this.height = height;
        }

        @Override
        public void execute(Graphics2D g) {
            // Convert this into a DrawImage call
            ImageIcon icon = new ImageIcon(pathName);
            Image img = icon.getImage();
            g.drawImage(img, x, y, width, height, null);
        }
    }

    protected static class SetFont implements PrintCommand {
        Font font;

        SetFont(Font font) {
            this.font = font;
        }

        @Override
        public void execute(Graphics2D g) {
            g.setFont(font);
        }
    }

    protected static class SetColor implements PrintCommand {
        Color color;

        SetColor(Color color) {
            this.color = color;
        }

        @Override
        public void execute(Graphics2D g) {
            g.setColor(color);
        }
    }

    protected static class PrintWindow implements PrintCommand {
        JWindow jW;
        int x, y;

        PrintWindow(JWindow jW, int x, int y) {
            this.jW = jW;
            this.x = x;
            this.y = y;
        }

        @Override
        public void execute(Graphics2D g) {
            g.translate(x, y);
            jW.setVisible(true);
            jW.printAll(g);
            jW.setVisible(false);
            jW.dispose();
            g.translate(-x, -y);
        }
    }

    public static class ImageIconWrapper extends ImageIcon {
        String pathName;

        /**
         * Class to save and be able to restore the pathname of an ImageIcon.
         * 
         * @param pathName The filename to construct the ImageIcon for.
         */
        public ImageIconWrapper(String pathName) {
            super(pathName);
            this.pathName = pathName;
        }

        public String getPathName() {
            return pathName;
        }
    }

    private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(HardcopyWriter.class);
}