com.itextpdf.kernel.pdf.annot

Class PdfCircleAnnotation

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.PdfCircleAnnotation

All Implemented Interfaces:

Serializable

public class PdfCircleAnnotation
extends PdfMarkupAnnotation

See Also:

Serialized Form

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

Constructor and Description
PdfCircleAnnotation(PdfDictionary pdfObject) Deprecated. Use PdfAnnotation.makeAnnotation(PdfObject) instead. Will be made protected in 7.1
PdfCircleAnnotation(Rectangle rect)

Method Summary

Modifier and Type	Method and 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 ellipse.
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 circle.
PdfName	getSubtype() Gets a PdfName which value is a subtype of this annotation.
PdfCircleAnnotation	setBorderEffect(PdfDictionary borderEffect) Sets a border effect dictionary that specifies an effect that shall be applied to the border of the annotations.
PdfCircleAnnotation	setBorderStyle(PdfDictionary borderStyle) Sets border style dictionary that has more settings than the array specified for the Border entry (PdfAnnotation.getBorder()).
PdfCircleAnnotation	setBorderStyle(PdfName style) Setter for the annotation's preset border style.
PdfCircleAnnotation	setDashPattern(PdfArray dashPattern) Setter for the annotation's preset dashed border style.
PdfCircleAnnotation	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 ellipse.
PdfCircleAnnotation	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 ellipse.
PdfCircleAnnotation	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 circle.

Methods inherited from class com.itextpdf.kernel.pdf.annot.PdfMarkupAnnotation

getCreationDate, getDefaultAppearance, getExternalData, getIconName, getInReplyTo, getInReplyToObject, getIntent, getJustification, getOpacity, getPopup, getPopupObject, getReplyType, getRichText, getSubject, getText, setCreationDate, setDefaultAppearance, setExternalData, setIconName, setInReplyTo, setIntent, setJustification, setOpacity, setPopup, setReplyType, setRichText, setSubject, setText

Methods inherited from class com.itextpdf.kernel.pdf.annot.PdfAnnotation

flush, getAction, getAdditionalAction, getAppearanceCharacteristics, getAppearanceDictionary, getAppearanceObject, getAppearanceState, getBorder, getColorObject, getContents, getDate, getDownAppearanceObject, getFlags, getName, getNormalAppearanceObject, getOpen, getPage, getPageObject, getQuadPoints, getRectangle, getRolloverAppearanceObject, getStructParentIndex, getTitle, hasFlag, isWrappedObjectMustBeIndirect, makeAnnotation, makeAnnotation, put, remove, resetFlag, setAction, setAdditionalAction, setAppearance, setAppearance, setAppearanceCharacteristics, setAppearanceState, setBorder, setColor, setColor, setColor, setContents, setContents, setDate, setDownAppearance, setDownAppearance, setFlag, setFlags, setLayer, setName, setNormalAppearance, setNormalAppearance, setOpen, setPage, setQuadPoints, setRectangle, setRolloverAppearance, setRolloverAppearance, setStructParentIndex, setTitle

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

ensureObjectIsAddedToDocument, ensureUnderlyingObjectHasIndirectReference, 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

PdfCircleAnnotation

public PdfCircleAnnotation(Rectangle rect)

PdfCircleAnnotation

@Deprecated
public PdfCircleAnnotation(PdfDictionary pdfObject)

Deprecated. Use PdfAnnotation.makeAnnotation(PdfObject) instead. Will be made protected in 7.1

Parameters:

pdfObject - object representing this annotation

Method Detail

getSubtype

public PdfName getSubtype()

Description copied from class: PdfAnnotation

Gets a PdfName 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 class PdfAnnotation

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 (see PdfAnnotation.getBorder()). If an annotation dictionary includes the BS entry, then the Border entry is ignored. If annotation includes AP (see PdfAnnotation.getAppearanceDictionary()) it takes precedence over the BS entry. For more info on BS entry see ISO-320001, Table 166.

Overrides:

getBorderStyle in class PdfAnnotation

Returns:

PdfDictionary which is a border style dictionary or null if it is not specified.

setBorderStyle

public PdfCircleAnnotation 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 and getBorderStyle() for more info.

Overrides:

setBorderStyle in class PdfAnnotation

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 PdfCircleAnnotation instance.

setBorderStyle

public PdfCircleAnnotation setBorderStyle(PdfName style)

Setter for the annotation's preset border style. Possible values are

• PdfAnnotation.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.

See also ISO-320001, Table 166.

Overrides:

setBorderStyle in class PdfAnnotation

Parameters:

style - The new value for the annotation's border style.

Returns:

this PdfCircleAnnotation instance.

See Also:

getBorderStyle()

setDashPattern

public PdfCircleAnnotation setDashPattern(PdfArray dashPattern)

Setter for the annotation's preset dashed border style. This property has affect only if PdfAnnotation.STYLE_DASHED style was used for the annotation border style (see setBorderStyle(PdfName). See ISO-320001 8.4.3.6, “Line Dash Pattern” for the format in which dash pattern shall be specified.

Overrides:

setDashPattern in class PdfAnnotation

Parameters:

dashPattern - a dash array defining a pattern of dashes and gaps that shall be used in drawing a dashed border.

Returns:

this PdfCircleAnnotation 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 circle.

Overrides:

getRectangleDifferences in class PdfMarkupAnnotation

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 PdfCircleAnnotation 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 circle.

Overrides:

setRectangleDifferences in class PdfMarkupAnnotation

Parameters:

rect - 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. 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 PdfCircleAnnotation instance.

getBorderEffect

public PdfDictionary getBorderEffect()

Gets a border effect dictionary that specifies an effect that shall be applied to the border of the annotations.

Overrides:

getBorderEffect in class PdfMarkupAnnotation

Returns:

a PdfDictionary, which is a border effect dictionary (see ISO-320001, Table 167).

setBorderEffect

public PdfCircleAnnotation setBorderEffect(PdfDictionary borderEffect)

Sets a border effect dictionary that specifies an effect that shall be applied to the border of the annotations.

Overrides:

setBorderEffect in class PdfMarkupAnnotation

Parameters:

borderEffect - a PdfDictionary which contents shall be specified in accordance to ISO-320001, Table 167.

Returns:

this PdfCircleAnnotation instance.

getInteriorColor

public Color getInteriorColor()

The interior color which is used to fill the annotation's ellipse.

Overrides:

getInteriorColor in class PdfMarkupAnnotation

Returns:

Color of either DeviceGray, DeviceRgb or DeviceCmyk type which defines interior color of the annotation, or null if interior color is not specified.

setInteriorColor

public PdfCircleAnnotation 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 ellipse.

Overrides:

setInteriorColor in class PdfMarkupAnnotation

Parameters:

interiorColor - a 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 PdfRedactAnnotation number of elements shall be equal to 3 (which defines DeviceRGB colour space).

Returns:

this PdfCircleAnnotation instance.

setInteriorColor

public PdfCircleAnnotation 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 ellipse.

Overrides:

setInteriorColor in class PdfMarkupAnnotation

Parameters:

interiorColor - an array of floats in the range 0.0 to 1.0.

Returns:

this PdfCircleAnnotation instance.