Class PDAnnotationCircle

java.lang.Object

org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotation

org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup

org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquareCircle

org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationCircle

All Implemented Interfaces:

COSObjectable

public class PDAnnotationCircle
extends PDAnnotationSquareCircle

Author:

Paul King

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SUB_TYPE	The type of annotation.

Fields inherited from class PDAnnotationMarkup

RT_GROUP, RT_REPLY

Constructor Summary

Constructors

Constructor	Description
PDAnnotationCircle()
PDAnnotationCircle(COSDictionary field)	Creates a circle annotation from a COSDictionary, expected to be a correct object definition.

Method Summary

Modifier and Type	Method	Description
void	constructAppearances()	Create the appearance entry for this annotation.
void	constructAppearances(PDDocument document)	Create the appearance entry for this annotation.
void	setCustomAppearanceHandler(PDAppearanceHandler appearanceHandler)	Set a custom appearance handler for generating the annotations appearance streams.

Methods inherited from class PDAnnotationSquareCircle

getBorderEffect, getInteriorColor, getRectDifference, getRectDifferences, setBorderEffect, setInteriorColor, setRectDifference, setRectDifferences, setRectDifferences

Methods inherited from class PDAnnotationMarkup

getBorderStyle, getConstantOpacity, getCreationDate, getExternalData, getInReplyTo, getIntent, getPopup, getReplyType, getRichContents, getSubject, getTitlePopup, setBorderStyle, setConstantOpacity, setCreationDate, setExternalData, setInReplyTo, setIntent, setPopup, setReplyType, setRichContents, setSubject, setTitlePopup

Methods inherited from class PDAnnotation

createAnnotation, equals, getAnnotationFlags, getAnnotationName, getAppearance, getAppearanceState, getBorder, getColor, getColor, getContents, getCOSObject, getModifiedDate, getNormalAppearanceStream, getOptionalContent, getPage, getRectangle, getStructParent, getSubtype, hashCode, isHidden, isInvisible, isLocked, isLockedContents, isNoRotate, isNoView, isNoZoom, isPrinted, isReadOnly, isToggleNoView, setAnnotationFlags, setAnnotationName, setAppearance, setAppearanceState, setAppearanceState, setBorder, setColor, setContents, setHidden, setInvisible, setLocked, setLockedContents, setModifiedDate, setModifiedDate, setNoRotate, setNoView, setNoZoom, setOptionalContent, setPage, setPrinted, setReadOnly, setRectangle, setStructParent, setSubtype, setToggleNoView

Methods inherited from class Object

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

Field Details

SUB_TYPE

public static final String SUB_TYPE

The type of annotation.

See Also:

• Constant Field Values

Constructor Details

PDAnnotationCircle

public PDAnnotationCircle()

PDAnnotationCircle

public PDAnnotationCircle(COSDictionary field)

Creates a circle annotation from a COSDictionary, expected to be a correct object definition.

Parameters:

field - the PDF object to represent as a field.

Method Details

setCustomAppearanceHandler

public void setCustomAppearanceHandler(PDAppearanceHandler appearanceHandler)

Set a custom appearance handler for generating the annotations appearance streams.

Parameters:

appearanceHandler - custom appearance handler

constructAppearances

public void constructAppearances()

Description copied from class: PDAnnotation

Create the appearance entry for this annotation. Not having it may prevent display in some viewers. This method is for overriding in subclasses, the default implementation does nothing.

Specified by:

constructAppearances in class PDAnnotationSquareCircle

constructAppearances

public void constructAppearances(PDDocument document)

Description copied from class: PDAnnotation

Create the appearance entry for this annotation. Not having it may prevent display in some viewers. This method is for overriding in subclasses, the default implementation does nothing.

Overrides:

constructAppearances in class PDAnnotation

Parameters:

document - the related document