Package com.itextpdf.kernel.pdf.annot
Class PdfSquareAnnotation
- java.lang.Object
-
- com.itextpdf.kernel.pdf.PdfObjectWrapper<PdfDictionary>
-
- com.itextpdf.kernel.pdf.annot.PdfAnnotation
-
- com.itextpdf.kernel.pdf.annot.PdfMarkupAnnotation
-
- com.itextpdf.kernel.pdf.annot.PdfSquareAnnotation
-
public class PdfSquareAnnotation extends PdfMarkupAnnotation
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.itextpdf.kernel.pdf.annot.PdfAnnotation
PdfAnnotation.PdfUnknownAnnotation
-
-
Field Summary
-
Fields inherited from class com.itextpdf.kernel.pdf.annot.PdfMarkupAnnotation
inReplyTo, popup
-
Fields inherited from class com.itextpdf.kernel.pdf.annot.PdfAnnotation
Accepted, Canceled, Completed, HIDDEN, HIGHLIGHT_INVERT, HIGHLIGHT_NONE, HIGHLIGHT_OUTLINE, HIGHLIGHT_PUSH, HIGHLIGHT_TOGGLE, INVISIBLE, LOCKED, LOCKED_CONTENTS, Marked, MarkedModel, NO_ROTATE, NO_VIEW, NO_ZOOM, None, page, PRINT, READ_ONLY, Rejected, ReviewModel, STYLE_BEVELED, STYLE_DASHED, STYLE_INSET, STYLE_SOLID, STYLE_UNDERLINE, TOGGLE_NO_VIEW, Unmarked
-
-
Constructor Summary
Constructors Modifier Constructor Description PdfSquareAnnotation(Rectangle rect)
protected
PdfSquareAnnotation(PdfDictionary pdfObject)
Instantiates a newPdfSquareAnnotation
instance based onPdfDictionary
instance, that represents existing annotation object in the document.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PdfDictionary
getBorderEffect()
Gets a border effect dictionary that specifies an effect that shall be applied to the border of the annotations.PdfDictionary
getBorderStyle()
The dictionaries for some annotation types (such as free text and polygon annotations) can include the BS entry.Color
getInteriorColor()
The interior color which is used to fill the annotation's rectangle.PdfArray
getRectangleDifferences()
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.PdfName
getSubtype()
Gets aPdfName
which value is a subtype of this annotation.PdfSquareAnnotation
setBorderEffect(PdfDictionary borderEffect)
Sets a border effect dictionary that specifies an effect that shall be applied to the border of the annotations.PdfSquareAnnotation
setBorderStyle(PdfDictionary borderStyle)
Sets border style dictionary that has more settings than the array specified for the Border entry (PdfAnnotation.getBorder()
).PdfSquareAnnotation
setBorderStyle(PdfName style)
Setter for the annotation's preset border style.PdfSquareAnnotation
setDashPattern(PdfArray dashPattern)
Setter for the annotation's preset dashed border style.PdfSquareAnnotation
setInteriorColor(float[] 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.PdfSquareAnnotation
setInteriorColor(PdfArray 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.PdfSquareAnnotation
setRectangleDifferences(PdfArray rect)
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.-
Methods inherited from class com.itextpdf.kernel.pdf.annot.PdfMarkupAnnotation
getCreationDate, getExternalData, getInReplyTo, getInReplyToObject, getIntent, getOpacity, getPopup, getPopupObject, getReplyType, getRichText, getSubject, getText, setCreationDate, setExternalData, setInReplyTo, setIntent, setOpacity, setPopup, setReplyType, setRichText, setSubject, setText
-
Methods inherited from class com.itextpdf.kernel.pdf.annot.PdfAnnotation
addAssociatedFile, flush, getAppearanceDictionary, getAppearanceObject, getAppearanceState, getAssociatedFiles, getBlendMode, getBorder, getColorObject, getContents, getDate, getDownAppearanceObject, getFlags, getLang, getName, getNonStrokingOpacity, getNormalAppearanceObject, getPage, getPageObject, getRectangle, getRolloverAppearanceObject, getStrokingOpacity, getStructParentIndex, getTitle, hasFlag, isWrappedObjectMustBeIndirect, makeAnnotation, put, remove, resetFlag, setAppearance, setAppearance, setAppearanceState, setBlendMode, setBorder, setBorder, setColor, setColor, setColor, setContents, setContents, setDate, setDownAppearance, setDownAppearance, setFlag, setFlags, setLang, setLayer, setName, setNonStrokingOpacity, setNormalAppearance, setNormalAppearance, setPage, setRectangle, setRolloverAppearance, setRolloverAppearance, setStrokingOpacity, setStructParentIndex, setTitle
-
Methods inherited from class com.itextpdf.kernel.pdf.PdfObjectWrapper
ensureObjectIsAddedToDocument, ensureUnderlyingObjectHasIndirectReference, getPdfObject, isFlushed, makeIndirect, makeIndirect, markObjectAsIndirect, setForbidRelease, setModified, setPdfObject, unsetForbidRelease
-
-
-
-
Constructor Detail
-
PdfSquareAnnotation
public PdfSquareAnnotation(Rectangle rect)
-
PdfSquareAnnotation
protected PdfSquareAnnotation(PdfDictionary pdfObject)
Instantiates a newPdfSquareAnnotation
instance based onPdfDictionary
instance, that represents existing annotation object in the document.- Parameters:
pdfObject
- thePdfDictionary
representing annotation object- See Also:
PdfAnnotation.makeAnnotation(PdfObject)
-
-
Method Detail
-
getSubtype
public PdfName getSubtype()
Description copied from class:PdfAnnotation
Gets aPdfName
which value is a subtype of this annotation. See ISO-320001 12.5.6, "Annotation Types" for the reference to the possible types.- Specified by:
getSubtype
in classPdfAnnotation
- Returns:
- subtype of this annotation.
-
getBorderStyle
public PdfDictionary getBorderStyle()
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 (seePdfAnnotation.getBorder()
). If an annotation dictionary includes the BS entry, then the Border entry is ignored. If annotation includes AP (seePdfAnnotation.getAppearanceDictionary()
) it takes precedence over the BS entry. For more info on BS entry see ISO-320001, Table 166.- Returns:
PdfDictionary
which is a border style dictionary or null if it is not specified.
-
setBorderStyle
public PdfSquareAnnotation setBorderStyle(PdfDictionary borderStyle)
Sets border style dictionary that has more settings than the array specified for the Border entry (PdfAnnotation.getBorder()
). See ISO-320001, Table 166 andgetBorderStyle()
for more info.- Parameters:
borderStyle
- a border style dictionary specifying the line width and dash pattern that shall be used in drawing the annotation’s border.- Returns:
- this
PdfSquareAnnotation
instance.
-
setBorderStyle
public PdfSquareAnnotation setBorderStyle(PdfName style)
Setter for the annotation's preset border style. Possible values arePdfAnnotation.STYLE_SOLID
- A solid rectangle surrounding the annotation.PdfAnnotation.STYLE_DASHED
- A dashed rectangle surrounding the annotation.PdfAnnotation.STYLE_BEVELED
- A simulated embossed rectangle that appears to be raised above the surface of the page.PdfAnnotation.STYLE_INSET
- A simulated engraved rectangle that appears to be recessed below the surface of the page.PdfAnnotation.STYLE_UNDERLINE
- A single line along the bottom of the annotation rectangle.
- Parameters:
style
- The new value for the annotation's border style.- Returns:
- this
PdfSquareAnnotation
instance. - See Also:
getBorderStyle()
-
setDashPattern
public PdfSquareAnnotation setDashPattern(PdfArray dashPattern)
Setter for the annotation's preset dashed border style. This property has affect only ifPdfAnnotation.STYLE_DASHED
style was used for the annotation border style (seesetBorderStyle(PdfName)
. See ISO-320001 8.4.3.6, "Line Dash Pattern" for the format in which dash pattern shall be specified.- Parameters:
dashPattern
- a dash array defining a pattern of dashes and gaps that shall be used in drawing a dashed border.- Returns:
- this
PdfSquareAnnotation
instance.
-
getRectangleDifferences
public PdfArray getRectangleDifferences()
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.- Returns:
- null if not specified, otherwise a
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.
-
setRectangleDifferences
public PdfSquareAnnotation setRectangleDifferences(PdfArray rect)
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.- Parameters:
rect
- aPdfArray
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.- Returns:
- this
PdfSquareAnnotation
instance.
-
getBorderEffect
public PdfDictionary getBorderEffect()
Gets a border effect dictionary that specifies an effect that shall be applied to the border of the annotations.- Returns:
- a
PdfDictionary
, which is a border effect dictionary (see ISO-320001, Table 167).
-
setBorderEffect
public PdfSquareAnnotation setBorderEffect(PdfDictionary borderEffect)
Sets a border effect dictionary that specifies an effect that shall be applied to the border of the annotations.- Parameters:
borderEffect
- aPdfDictionary
which contents shall be specified in accordance to ISO-320001, Table 167.- Returns:
- this
PdfSquareAnnotation
instance.
-
getInteriorColor
public Color getInteriorColor()
The interior color which is used to fill the annotation's rectangle.- Returns:
Color
of eitherDeviceGray
,DeviceRgb
orDeviceCmyk
type which defines interior color of the annotation, or null if interior color is not specified.
-
setInteriorColor
public PdfSquareAnnotation setInteriorColor(PdfArray 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.- Parameters:
interiorColor
- aPdfArray
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 thePdfRedactAnnotation
number of elements shall be equal to 3 (which defines DeviceRGB colour space).- Returns:
- this
PdfSquareAnnotation
instance.
-
setInteriorColor
public PdfSquareAnnotation setInteriorColor(float[] 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.- Parameters:
interiorColor
- an array of floats in the range 0.0 to 1.0.- Returns:
- this
PdfSquareAnnotation
instance.
-
-