com.itextpdf.kernel.pdf.PdfAnnotationBorder Maven / Gradle / Ivy
/*
This file is part of the iText (R) project.
Copyright (c) 1998-2021 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.kernel.pdf;
/**
* Specifying the characteristics of the annotation’s border.
* See ISO 32000-1 12.5.2, Table 164 - Entries common to all annotation dictionaries, Key - border.
*
*
* Note (PDF 1.2): The dictionaries for some annotation types can include the BS (border style) entry.
* That entry specifies a border style dictionary that has more settings than this class.
* If an annotation has BS entry, then {@link PdfAnnotationBorder} is ignored.
*/
public class PdfAnnotationBorder extends PdfObjectWrapper {
/** Serial version UID. */
private static final long serialVersionUID = -4058970009483489460L;
/**
* Creates a {@link PdfAnnotationBorder} with three numbers defining the horizontal
* corner radius, vertical corner radius, and border width, all in default user
* space units. If the corner radii are 0, the border has square (not rounded)
* corners; if the border width is 0, no border is drawn.
*
* @param hRadius horizontal corner radius
* @param vRadius vertical corner radius
* @param width width of the border
*/
public PdfAnnotationBorder(float hRadius, float vRadius, float width) {
this(hRadius, vRadius, width, null);
}
/**
* Creates a {@link PdfAnnotationBorder} with three numbers defining the horizontal
* corner radius, vertical corner radius, and border width, all in default user
* space units and a dash pattern for the border lines. If the corner radii are 0,
* the border has square (not rounded) corners; if the border width is 0, no border is drawn.
*
* @param hRadius horizontal corner radius
* @param vRadius vertical corner radius
* @param width width of the border
* @param dash the dash pattern
*/
public PdfAnnotationBorder(float hRadius, float vRadius, float width, PdfDashPattern dash) {
super(new PdfArray(new float[]{hRadius, vRadius, width}));
if (dash != null) {
PdfArray dashArray = new PdfArray();
getPdfObject().add(dashArray);
if (dash.getDash() >= 0) {
dashArray.add(new PdfNumber(dash.getDash()));
}
if (dash.getGap() >= 0) {
dashArray.add(new PdfNumber(dash.getGap()));
}
if (dash.getPhase() >= 0) {
getPdfObject().add(new PdfNumber(dash.getPhase()));
}
}
}
@Override
protected boolean isWrappedObjectMustBeIndirect() {
return false;
}
}