PdfSquareAnnotation.java
/*
This file is part of the iText (R) project.
Copyright (c) 1998-2025 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 <https://www.gnu.org/licenses/>.
*/
package com.itextpdf.kernel.pdf.annot;
import com.itextpdf.kernel.colors.Color;
import com.itextpdf.kernel.colors.DeviceCmyk;
import com.itextpdf.kernel.colors.DeviceGray;
import com.itextpdf.kernel.colors.DeviceRgb;
import com.itextpdf.kernel.geom.Rectangle;
import com.itextpdf.kernel.pdf.PdfArray;
import com.itextpdf.kernel.pdf.PdfDictionary;
import com.itextpdf.kernel.pdf.PdfName;
import com.itextpdf.kernel.pdf.PdfObject;
public class PdfSquareAnnotation extends PdfMarkupAnnotation {
public PdfSquareAnnotation(Rectangle rect) {
super(rect);
}
/**
* Instantiates a new {@link PdfSquareAnnotation} instance based on {@link PdfDictionary}
* instance, that represents existing annotation object in the document.
*
* @param pdfObject the {@link PdfDictionary} representing annotation object
* @see PdfAnnotation#makeAnnotation(PdfObject)
*/
protected PdfSquareAnnotation(PdfDictionary pdfObject) {
super(pdfObject);
}
@Override
public PdfName getSubtype() {
return PdfName.Square;
}
/**
* The dictionaries for some annotation types (such as free text and polygon annotations) can include the BS entry.
* That entry specifies a border style dictionary that has more settings than the array specified for the Border
* entry (see {@link PdfAnnotation#getBorder()}). If an annotation dictionary includes the BS entry, then the Border
* entry is ignored. If annotation includes AP (see {@link PdfAnnotation#getAppearanceDictionary()}) it takes
* precedence over the BS entry. For more info on BS entry see ISO-320001, Table 166.
* @return {@link PdfDictionary} which is a border style dictionary or null if it is not specified.
*/
public PdfDictionary getBorderStyle() {
return getPdfObject().getAsDictionary(PdfName.BS);
}
/**
* Sets border style dictionary that has more settings than the array specified for the Border entry ({@link PdfAnnotation#getBorder()}).
* See ISO-320001, Table 166 and {@link #getBorderStyle()} for more info.
* @param borderStyle a border style dictionary specifying the line width and dash pattern that shall be used
* in drawing the annotation���s border.
* @return this {@link PdfSquareAnnotation} instance.
*/
public PdfSquareAnnotation setBorderStyle(PdfDictionary borderStyle) {
return (PdfSquareAnnotation) put(PdfName.BS, borderStyle);
}
/**
* Setter for the annotation's preset border style. Possible values are
* <ul>
* <li>{@link PdfAnnotation#STYLE_SOLID} - A solid rectangle surrounding the annotation.
* <li>{@link PdfAnnotation#STYLE_DASHED} - A dashed rectangle surrounding the annotation.
* <li>{@link PdfAnnotation#STYLE_BEVELED} - A simulated embossed rectangle that appears to be raised above the surface of the page.
* <li>{@link PdfAnnotation#STYLE_INSET} - A simulated engraved rectangle that appears to be recessed below the surface of the page.
* <li>{@link PdfAnnotation#STYLE_UNDERLINE} - A single line along the bottom of the annotation rectangle.
* </ul>
* See also ISO-320001, Table 166.
* @param style The new value for the annotation's border style.
* @return this {@link PdfSquareAnnotation} instance.
* @see #getBorderStyle()
*/
public PdfSquareAnnotation setBorderStyle(PdfName style) {
return setBorderStyle(BorderStyleUtil.setStyle(getBorderStyle(), style));
}
/**
* Setter for the annotation's preset dashed border style. This property has affect only if {@link PdfAnnotation#STYLE_DASHED}
* style was used for the annotation border style (see {@link #setBorderStyle(PdfName)}.
* See ISO-320001 8.4.3.6, "Line Dash Pattern" for the format in which dash pattern shall be specified.
* @param dashPattern a dash array defining a pattern of dashes and gaps that
* shall be used in drawing a dashed border.
* @return this {@link PdfSquareAnnotation} instance.
*/
public PdfSquareAnnotation setDashPattern(PdfArray dashPattern) {
return setBorderStyle(BorderStyleUtil.setDashPattern(getBorderStyle(), dashPattern));
}
/**
* A set of four numbers describing the numerical differences between two rectangles:
* the Rect entry of the annotation and the actual boundaries of the underlying square.
*
* @return null if not specified, otherwise a {@link PdfArray} with four numbers which correspond to the
* differences in default user space between the left, top, right, and bottom coordinates of Rect and those
* of the inner rectangle, respectively.
*/
public PdfArray getRectangleDifferences() {
return getPdfObject().getAsArray(PdfName.RD);
}
/**
* A set of four numbers describing the numerical differences between two rectangles:
* the Rect entry of the annotation and the actual boundaries of the underlying square.
*
* @param rect a {@link PdfArray} with four numbers which correspond to the differences in default user space between
* the left, top, right, and bottom coordinates of Rect and those of the inner rectangle, respectively.
* Each value shall be greater than or equal to 0. The sum of the top and bottom differences shall be
* less than the height of Rect, and the sum of the left and right differences shall be less than
* the width of Rect.
* @return this {@link PdfSquareAnnotation} instance.
*/
public PdfSquareAnnotation setRectangleDifferences(PdfArray rect) {
return (PdfSquareAnnotation) put(PdfName.RD, rect);
}
/**
* Gets a border effect dictionary that specifies an effect that shall be applied to the border of the annotations.
* @return a {@link PdfDictionary}, which is a border effect dictionary (see ISO-320001, Table 167).
*/
public PdfDictionary getBorderEffect() {
return getPdfObject().getAsDictionary(PdfName.BE);
}
/**
* Sets a border effect dictionary that specifies an effect that shall be applied to the border of the annotations.
*
* @param borderEffect a {@link PdfDictionary} which contents shall be specified in accordance to ISO-320001, Table 167.
* @return this {@link PdfSquareAnnotation} instance.
*/
public PdfSquareAnnotation setBorderEffect(PdfDictionary borderEffect) {
return (PdfSquareAnnotation) put(PdfName.BE, borderEffect);
}
/**
* The interior color which is used to fill the annotation's rectangle.
*
* @return {@link Color} of either {@link DeviceGray}, {@link DeviceRgb} or {@link DeviceCmyk} type which defines
* interior color of the annotation, or null if interior color is not specified.
*/
public Color getInteriorColor() {
return InteriorColorUtil.parseInteriorColor(getPdfObject().getAsArray(PdfName.IC));
}
/**
* An array of numbers in the range 0.0 to 1.0 specifying the interior color
* which is used to fill the annotation's rectangle.
*
* @param interiorColor a {@link PdfArray} of numbers in the range 0.0 to 1.0. The number of array elements determines
* the colour space in which the colour is defined: 0 - No colour, transparent; 1 - DeviceGray,
* 3 - DeviceRGB, 4 - DeviceCMYK. For the {@link PdfRedactAnnotation} number of elements shall be
* equal to 3 (which defines DeviceRGB colour space).
* @return this {@link PdfSquareAnnotation} instance.
*/
public PdfSquareAnnotation setInteriorColor(PdfArray interiorColor) {
return (PdfSquareAnnotation) put(PdfName.IC, interiorColor);
}
/**
* An array of numbers in the range 0.0 to 1.0 specifying the interior color
* which is used to fill the annotation's rectangle.
*
* @param interiorColor an array of floats in the range 0.0 to 1.0.
* @return this {@link PdfSquareAnnotation} instance.
*/
public PdfSquareAnnotation setInteriorColor(float[] interiorColor) {
return setInteriorColor(new PdfArray(interiorColor));
}
}