com.itextpdf.text.pdf.pdfcleanup.PdfCleanUpLocation Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of itext-xtra Show documentation
iText Xtra, part of iText a Free Java-PDF library
The newest version!
/*
 *
 * This file is part of the iText (R) project.
    Copyright (c) 1998-2022 iText Group NV
 * Authors: Bruno Lowagie, Paulo Soares, et al.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License version 3
 * as published by the Free Software Foundation with the addition of the
 * following permission added to Section 15 as permitted in Section 7(a):
 * FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY
 * ITEXT GROUP. ITEXT GROUP DISCLAIMS THE WARRANTY OF NON INFRINGEMENT
 * OF THIRD PARTY RIGHTS
 *
 * 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 http://www.gnu.org/licenses or write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA, 02110-1301 USA, or download the license from the following URL:
 * http://itextpdf.com/terms-of-use/
 *
 * The interactive user interfaces in modified source and object code versions
 * of this program must display Appropriate Legal Notices, as required under
 * Section 5 of the GNU Affero General Public License.
 *
 * In accordance with Section 7(b) of the GNU Affero General Public License,
 * a covered work must retain the producer line in every PDF that is created
 * or manipulated using iText.
 *
 * You can be released from the requirements of the license by purchasing
 * a commercial license. Buying such a license is mandatory as soon as you
 * develop commercial activities involving the iText software without
 * disclosing the source code of your own applications.
 * These activities include: offering paid services to customers as an ASP,
 * serving PDFs on the fly in a web application, shipping iText with a closed
 * source product.
 *
 * For more information, please contact iText Software Corp. at this
 * address: [email protected]
 */
package com.itextpdf.text.pdf.pdfcleanup;

import com.itextpdf.text.BaseColor;
import com.itextpdf.text.Rectangle;

/**
 * Defines the region to be erased in a PDF document.
 *
 * @since 5.5.4
 */
public class PdfCleanUpLocation {

    private int page;
    private Rectangle region;
    private BaseColor cleanUpColor;

    /**
     * Constructs a {@link com.itextpdf.text.pdf.pdfcleanup.PdfCleanUpLocation} object.
     *
     * @param page   specifies the number of the page which the region belongs to.
     * @param region represents the boundaries of the area to be erased.
     */
    public PdfCleanUpLocation(int page, Rectangle region) {
        this.page = page;
        this.region = region;
    }

    /**
     * Constructs a {@link com.itextpdf.text.pdf.pdfcleanup.PdfCleanUpLocation} object.
     *
     * @param page         specifies the number of the page which the region belongs to.
     * @param region       represents the boundaries of the area to be erased.
     * @param cleanUpColor a color used to fill the area after erasing it. If null
     *                     the erased area left uncolored.
     */
    public PdfCleanUpLocation(int page, Rectangle region, BaseColor cleanUpColor) {
        this(page, region);
        this.cleanUpColor = cleanUpColor;
    }

    /**
     * @return the number of the page which the region belongs to.
     */
    public int getPage() {
        return page;
    }

    /**
     * @return A {@link com.itextpdf.text.Rectangle} representing the boundaries of the area to be erased.
     */
    public Rectangle getRegion() {
        return region;
    }

    /**
     * Returns a color used to fill the area after erasing it. If null the erased area left uncolored.
     *
     * @return a color used to fill the area after erasing it.
     */
    public BaseColor getCleanUpColor() {
        return cleanUpColor;
    }
}