com.itextpdf.forms.util.DrawingUtil Maven / Gradle / Ivy

Go to download
/*
    This file is part of the iText (R) project.
    Copyright (c) 1998-2024 Apryse Group NV
    Authors: Apryse Software.

    This program is offered under a commercial and under the AGPL license.
    For commercial licensing, contact us at https://itextpdf.com/sales.  For AGPL licensing, see below.

    AGPL licensing:
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU Affero General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License
    along with this program.  If not, see .
 */
package com.itextpdf.forms.util;

import com.itextpdf.kernel.pdf.canvas.PdfCanvas;

import java.nio.charset.StandardCharsets;

/**
 * Utility class to draw form fields {@link com.itextpdf.forms.fields.PdfFormField}.
 */
public class DrawingUtil {
    protected static final String check = "0.8 0 0 0.8 0.3 0.5 cm 0 0 m\n" +
            "0.066 -0.026 l\n" +
            "0.137 -0.15 l\n" +
            "0.259 0.081 0.46 0.391 0.553 0.461 c\n" +
            "0.604 0.489 l\n" +
            "0.703 0.492 l\n" +
            "0.543 0.312 0.255 -0.205 0.154 -0.439 c\n" +
            "0.069 -0.399 l\n" +
            "0.035 -0.293 -0.039 -0.136 -0.091 -0.057 c\n" +
            "h\n" +
            "f\n";

    protected static final String circle = "1 0 0 1 0.86 0.5 cm 0 0 m\n" +
            "0 0.204 -0.166 0.371 -0.371 0.371 c\n" +
            "-0.575 0.371 -0.741 0.204 -0.741 0 c\n" +
            "-0.741 -0.204 -0.575 -0.371 -0.371 -0.371 c\n" +
            "-0.166 -0.371 0 -0.204 0 0 c\n" +
            "f\n";


    protected static final String cross = "1 0 0 1 0.80 0.8 cm 0 0 m\n" +
            "-0.172 -0.027 l\n" +
            "-0.332 -0.184 l\n" +
            "-0.443 -0.019 l\n" +
            "-0.475 -0.009 l\n" +
            "-0.568 -0.168 l\n" +
            "-0.453 -0.324 l\n" +
            "-0.58 -0.497 l\n" +
            "-0.59 -0.641 l\n" +
            "-0.549 -0.627 l\n" +
            "-0.543 -0.612 -0.457 -0.519 -0.365 -0.419 c\n" +
            "-0.163 -0.572 l\n" +
            "-0.011 -0.536 l\n" +
            "-0.004 -0.507 l\n" +
            "-0.117 -0.441 l\n" +
            "-0.246 -0.294 l\n" +
            "-0.132 -0.181 l\n" +
            "0.031 -0.04 l\n" +
            "h\n" +
            "f\n";

    protected static final String diamond = "1 0 0 1 0.5 0.12 cm 0 0 m\n" +
            "0.376 0.376 l\n" +
            "0 0.751 l\n" +
            "-0.376 0.376 l\n" +
            "h\n" +
            "f\n";

    protected static final String square = "1 0 0 1 0.835 0.835 cm 0 0 -0.669 -0.67 re\n" +
            "f\n";

    protected static final String star = "0.95 0 0 0.95 0.85 0.6 cm 0 0 m\n" +
            "-0.291 0 l\n" +
            "-0.381 0.277 l\n" +
            "-0.47 0 l\n" +
            "-0.761 0 l\n" +
            "-0.526 -0.171 l\n" +
            "-0.616 -0.448 l\n" +
            "-0.381 -0.277 l\n" +
            "-0.145 -0.448 l\n" +
            "-0.236 -0.171 l\n" +
            "h\n" +
            "f\n";

    private static void drawPdfAAppearanceString(PdfCanvas canvas, float width, float height, float moveX, float moveY,
            String appearanceString) {
        canvas.saveState();
        canvas.resetFillColorRgb();
        canvas.concatMatrix(width, 0, 0, height, moveX, moveY);
        canvas.getContentStream().getOutputStream().writeBytes(appearanceString.getBytes(StandardCharsets.ISO_8859_1));
        canvas.restoreState();
    }

    /**
     * Draws a PDF A compliant check mark in the specified rectangle.
     *
     * @param canvas the canvas to draw on
     * @param width  the width of the rectangle
     * @param height the height of the rectangle
     * @param moveX  the x coordinate of the bottom left corner of the rectangle
     * @param moveY  the y coordinate of the bottom left corner of the rectangle
     */
    public static void drawPdfACheck(PdfCanvas canvas, float width, float height, float moveX, float moveY) {
        drawPdfAAppearanceString(canvas, width, height, moveX, moveY, check);
    }

    /**
     * Draws a PDF A compliant check mark in the specified rectangle.
     *
     * @param canvas the canvas to draw on
     * @param width  the width of the rectangle
     * @param height the height of the rectangle
     */
    public static void drawPdfACheck(PdfCanvas canvas, float width, float height) {
        drawPdfAAppearanceString(canvas, width, height, 0, 0, check);
    }

    /**
     * Draws a PDF A compliant circle in the specified rectangle.
     *
     * @param canvas the canvas to draw on
     * @param width  the width of the rectangle
     * @param height the height of the rectangle
     * @param moveX  the x coordinate of the bottom left corner of the rectangle
     * @param moveY  the y coordinate of the bottom left corner of the rectangle
     */
    public static void drawPdfACircle(PdfCanvas canvas, float width, float height, float moveX, float moveY) {
        drawPdfAAppearanceString(canvas, width, height, moveX, moveY, circle);
    }

    /**
     * Draws a PDF A compliant circle in the specified rectangle.
     *
     * @param canvas the canvas to draw on
     * @param width  the width of the rectangle
     * @param height the height of the rectangle
     */
    public static void drawPdfACircle(PdfCanvas canvas, float width, float height) {
        drawPdfAAppearanceString(canvas, width, height, 0, 0, circle);
    }

    /**
     * Draws a PDF A compliant cross in the specified rectangle.
     *
     * @param canvas the canvas to draw on
     * @param width  the width of the rectangle
     * @param height the height of the rectangle
     * @param moveX  the x coordinate of the bottom left corner of the rectangle
     * @param moveY  the y coordinate of the bottom left corner of the rectangle
     */
    public static void drawPdfACross(PdfCanvas canvas, float width, float height, float moveX, float moveY) {
        drawPdfAAppearanceString(canvas, width, height, moveX, moveY, cross);
    }

    /**
     * Draws a PDF A compliant cross in the specified rectangle.
     *
     * @param canvas the canvas to draw on
     * @param width  the width of the rectangle
     * @param height the height of the rectangle
     */
    public static void drawPdfACross(PdfCanvas canvas, float width, float height) {
        drawPdfAAppearanceString(canvas, width, height, 0, 0, cross);
    }

    /**
     * Draws a PDF A compliant diamond in the specified rectangle.
     *
     * @param canvas the canvas to draw on
     * @param width  the width of the rectangle
     * @param height the height of the rectangle
     * @param moveX  the x coordinate of the bottom left corner of the rectangle
     * @param moveY  the y coordinate of the bottom left corner of the rectangle
     */
    public static void drawPdfADiamond(PdfCanvas canvas, float width, float height, float moveX, float moveY) {
        drawPdfAAppearanceString(canvas, width, height, moveX, moveY, diamond);
    }

    /**
     * Draws a PDF A compliant diamond in the specified rectangle.
     *
     * @param canvas the canvas to draw on
     * @param width  the width of the rectangle
     * @param height the height of the rectangle
     */
    public static void drawPdfADiamond(PdfCanvas canvas, float width, float height) {
        drawPdfAAppearanceString(canvas, width, height, 0, 0, diamond);
    }

    /**
     * Draws a PDF A compliant square in the specified rectangle.
     *
     * @param canvas the canvas to draw on
     * @param width  the width of the rectangle
     * @param height the height of the rectangle
     * @param moveX  the x coordinate of the bottom left corner of the rectangle
     * @param moveY  the y coordinate of the bottom left corner of the rectangle
     */
    public static void drawPdfASquare(PdfCanvas canvas, float width, float height, float moveX, float moveY) {
        drawPdfAAppearanceString(canvas, width, height, moveX, moveY, square);
    }

    /**
     * Draws a PDF A compliant square in the specified rectangle.
     *
     * @param canvas the canvas to draw on
     * @param width  the width of the rectangle
     * @param height the height of the rectangle
     */
    public static void drawPdfASquare(PdfCanvas canvas, float width, float height) {
        drawPdfAAppearanceString(canvas, width, height, 0, 0, square);
    }

    /**
     * Draws a PDF A compliant star in the specified rectangle.
     *
     * @param canvas the canvas to draw on
     * @param width  the width of the rectangle
     * @param height the height of the rectangle
     * @param moveX  the x coordinate of the bottom left corner of the rectangle
     * @param moveY  the y coordinate of the bottom left corner of the rectangle
     */
    public static void drawPdfAStar(PdfCanvas canvas, float width, float height, float moveX, float moveY) {
        drawPdfAAppearanceString(canvas, width, height, moveX, moveY, star);
    }

    /**
     * Draws a PDF A compliant star in the specified rectangle.
     *
     * @param canvas the canvas to draw on
     * @param width  the width of the rectangle
     * @param height the height of the rectangle
     */
    public static void drawPdfAStar(PdfCanvas canvas, float width, float height) {
        drawPdfAAppearanceString(canvas, width, height, 0, 0, star);
    }

    /**
     * Draws a cross with the specified width and height.
     *
     * @param canvas      the canvas to draw on
     * @param width       the width of the rectangle
     * @param height      the height of the rectangle
     * @param borderWidth the width of the border
     */
    public static void drawCross(PdfCanvas canvas, float width, float height, float borderWidth) {
        float offset = borderWidth * 2;
        canvas.
                moveTo((width - height) / 2 + offset, height - offset).
                lineTo((width + height) / 2 - offset, offset).
                moveTo((width + height) / 2 - offset, height - offset).
                lineTo((width - height) / 2 + offset, offset).
                stroke();
    }

    /**
     * Draws a circle with the specified radius.
     *
     * @param canvas  the canvas to draw on
     * @param centerX the x coordinate of the center of the circle
     * @param centerY the y coordinate of the center of the circle
     * @param radius  the radius of the circle
     */
    public static void drawCircle(PdfCanvas canvas, float centerX, float centerY, float radius) {
        canvas
                .circle(centerX, centerY, radius)
                .fill();
    }
}