com.itextpdf.kernel.pdf

Class PdfAnnotationBorder

java.lang.Object

com.itextpdf.kernel.pdf.PdfObjectWrapper<PdfArray>

com.itextpdf.kernel.pdf.PdfAnnotationBorder

public class PdfAnnotationBorder
extends PdfObjectWrapper<PdfArray>

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 PdfAnnotationBorder is ignored.

Constructor Summary

Constructors

Constructor and Description
PdfAnnotationBorder(float hRadius, float vRadius, float width) Creates a PdfAnnotationBorder with three numbers defining the horizontal corner radius, vertical corner radius, and border width, all in default user space units.
PdfAnnotationBorder(float hRadius, float vRadius, float width, PdfDashPattern dash) Creates a 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.

Method Summary

Modifier and Type	Method and Description
protected boolean	isWrappedObjectMustBeIndirect() Defines if the object behind this wrapper must be an indirect object in the resultant document.

Methods inherited from class com.itextpdf.kernel.pdf.PdfObjectWrapper

ensureObjectIsAddedToDocument, ensureUnderlyingObjectHasIndirectReference, flush, getPdfObject, isFlushed, makeIndirect, makeIndirect, markObjectAsIndirect, setForbidRelease, setModified, setPdfObject, unsetForbidRelease

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PdfAnnotationBorder

public PdfAnnotationBorder(float hRadius,
                           float vRadius,
                           float width)

Creates a 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.

Parameters:

hRadius - horizontal corner radius

vRadius - vertical corner radius

width - width of the border

PdfAnnotationBorder

public PdfAnnotationBorder(float hRadius,
                           float vRadius,
                           float width,
                           PdfDashPattern dash)

Creates a 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.

Parameters:

hRadius - horizontal corner radius

vRadius - vertical corner radius

width - width of the border

dash - the dash pattern

Method Detail

isWrappedObjectMustBeIndirect

protected boolean isWrappedObjectMustBeIndirect()

Description copied from class: PdfObjectWrapper

Defines if the object behind this wrapper must be an indirect object in the resultant document.

If this method returns true it doesn't necessarily mean that object must be in the indirect state at any moment, but rather defines that when the object will be written to the document it will be transformed into indirect object if it's not indirect yet.

Return value of this method shouldn't depend on any logic, it should return always true or false.

Specified by:

isWrappedObjectMustBeIndirect in class PdfObjectWrapper<PdfArray>

Returns:

true if in the resultant document the object behind the wrapper must be indirect, otherwise false.