com.itextpdf.kernel.pdf.annot

Class PdfAnnotation

java.lang.Object

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

com.itextpdf.kernel.pdf.annot.PdfAnnotation

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Pdf3DAnnotation, PdfLinkAnnotation, PdfMarkupAnnotation, PdfPopupAnnotation, PdfPrinterMarkAnnotation, PdfRichMediaAnnotation, PdfScreenAnnotation, PdfTrapNetworkAnnotation, PdfWatermarkAnnotation, PdfWidgetAnnotation

public abstract class PdfAnnotation
extends PdfObjectWrapper<PdfDictionary>

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static PdfString	Accepted
static PdfString	Canceled
static PdfString	Completed
static int	HIDDEN
static PdfName	HIGHLIGHT_INVERT
static PdfName	HIGHLIGHT_NONE Annotation highlighting modes.
static PdfName	HIGHLIGHT_OUTLINE
static PdfName	HIGHLIGHT_PUSH
static PdfName	HIGHLIGHT_TOGGLE
static int	INVISIBLE Annotation flags.
static int	LOCKED
static int	LOCKED_CONTENTS
static PdfString	Marked Annotation states.
static PdfString	MarkedModel Annotation state models.
static int	NO_ROTATE
static int	NO_VIEW
static int	NO_ZOOM
static PdfString	None
protected PdfPage	page
static int	PRINT
static int	READ_ONLY
static PdfString	Rejected
static PdfString	ReviewModel
static PdfName	STYLE_BEVELED
static PdfName	STYLE_DASHED
static PdfName	STYLE_INSET
static PdfName	STYLE_SOLID Annotation highlighting modes.
static PdfName	STYLE_UNDERLINE
static int	TOGGLE_NO_VIEW
static PdfString	Unmarked

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PdfAnnotation(PdfDictionary pdfObject)
protected	PdfAnnotation(Rectangle rect)

Method Summary

Modifier and Type	Method and Description
PdfDictionary	getAction()
PdfDictionary	getAdditionalAction()
PdfDictionary	getAppearanceCharacteristics()
PdfDictionary	getAppearanceDictionary()
PdfDictionary	getAppearanceObject(PdfName appearanceType)
PdfName	getAppearanceState()
PdfArray	getBorder()
PdfDictionary	getBorderStyle()
PdfArray	getColorObject()
PdfString	getContents()
PdfString	getDate()
PdfDictionary	getDownAppearanceObject()
int	getFlags()
PdfString	getName()
PdfDictionary	getNormalAppearanceObject()
boolean	getOpen()
PdfPage	getPage()
PdfDictionary	getPageObject()
PdfArray	getQuadPoints()
PdfArray	getRectangle()
PdfDictionary	getRolloverAppearanceObject()
int	getStructParentIndex()
abstract PdfName	getSubtype()
PdfString	getTitle()
boolean	hasFlag(int flag)
protected boolean	isWrappedObjectMustBeIndirect() Defines if the object behind this wrapper must be an indirect object in the resultant document.
static PdfAnnotation	makeAnnotation(PdfObject pdfObject)
static PdfAnnotation	makeAnnotation(PdfObject pdfObject, PdfAnnotation parent)
PdfAnnotation	put(PdfName key, PdfObject value)
PdfAnnotation	remove(PdfName key)
PdfAnnotation	resetFlag(int flag)
PdfAnnotation	setAction(PdfAction action)
PdfAnnotation	setAdditionalAction(PdfName key, PdfAction action)
PdfAnnotation	setAppearance(PdfName appearanceType, PdfAnnotationAppearance appearance)
PdfAnnotation	setAppearance(PdfName appearanceType, PdfDictionary appearance)
PdfAnnotation	setAppearanceCharacteristics(PdfDictionary characteristics)
PdfAnnotation	setAppearanceState(PdfName as)
PdfAnnotation	setBorder(PdfArray border)
PdfAnnotation	setBorderStyle(PdfDictionary borderStyle)
PdfAnnotation	setBorderStyle(PdfName style) Setter for the annotation's border style.
PdfAnnotation	setColor(Color color)
PdfAnnotation	setColor(float[] color)
PdfAnnotation	setColor(PdfArray color)
PdfAnnotation	setContents(PdfString contents)
PdfAnnotation	setContents(String contents)
PdfAnnotation	setDashPattern(PdfArray dashPattern)
PdfAnnotation	setDate(PdfString date)
PdfAnnotation	setDownAppearance(PdfAnnotationAppearance appearance)
PdfAnnotation	setDownAppearance(PdfDictionary appearance)
PdfAnnotation	setFlag(int flag)
PdfAnnotation	setFlags(int flags)
void	setLayer(IPdfOCG layer) Sets the layer this annotation belongs to.
PdfAnnotation	setName(PdfString name)
PdfAnnotation	setNormalAppearance(PdfAnnotationAppearance appearance)
PdfAnnotation	setNormalAppearance(PdfDictionary appearance)
PdfAnnotation	setOpen(boolean open)
PdfAnnotation	setPage(PdfPage page)
PdfAnnotation	setQuadPoints(PdfArray quadPoints)
PdfAnnotation	setRectangle(PdfArray array)
PdfAnnotation	setRolloverAppearance(PdfAnnotationAppearance appearance)
PdfAnnotation	setRolloverAppearance(PdfDictionary appearance)
PdfAnnotation	setStructParentIndex(int structParentIndex)
PdfAnnotation	setTitle(PdfString title)

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

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

Field Detail

INVISIBLE

public static final int INVISIBLE

Annotation flags.

See Also:

Constant Field Values

HIDDEN

public static final int HIDDEN

See Also:

Constant Field Values

PRINT

public static final int PRINT

See Also:

Constant Field Values

NO_ZOOM

public static final int NO_ZOOM

See Also:

Constant Field Values

NO_ROTATE

public static final int NO_ROTATE

See Also:

Constant Field Values

NO_VIEW

public static final int NO_VIEW

See Also:

Constant Field Values

READ_ONLY

public static final int READ_ONLY

See Also:

Constant Field Values

LOCKED

public static final int LOCKED

See Also:

Constant Field Values

TOGGLE_NO_VIEW

public static final int TOGGLE_NO_VIEW

See Also:

Constant Field Values

LOCKED_CONTENTS

public static final int LOCKED_CONTENTS

See Also:

Constant Field Values

HIGHLIGHT_NONE

public static final PdfName HIGHLIGHT_NONE

Annotation highlighting modes.

HIGHLIGHT_INVERT

public static final PdfName HIGHLIGHT_INVERT

HIGHLIGHT_OUTLINE

public static final PdfName HIGHLIGHT_OUTLINE

HIGHLIGHT_PUSH

public static final PdfName HIGHLIGHT_PUSH

HIGHLIGHT_TOGGLE

public static final PdfName HIGHLIGHT_TOGGLE

STYLE_SOLID

public static final PdfName STYLE_SOLID

Annotation highlighting modes.

STYLE_DASHED

public static final PdfName STYLE_DASHED

STYLE_BEVELED

public static final PdfName STYLE_BEVELED

STYLE_INSET

public static final PdfName STYLE_INSET

STYLE_UNDERLINE

public static final PdfName STYLE_UNDERLINE

Marked

public static final PdfString Marked

Annotation states.

Unmarked

public static final PdfString Unmarked

Accepted

public static final PdfString Accepted

Rejected

public static final PdfString Rejected

Canceled

public static final PdfString Canceled

Completed

public static final PdfString Completed

None

public static final PdfString None

MarkedModel

public static final PdfString MarkedModel

Annotation state models.

ReviewModel

public static final PdfString ReviewModel

page

protected PdfPage page

Constructor Detail

PdfAnnotation

protected PdfAnnotation(Rectangle rect)

PdfAnnotation

protected PdfAnnotation(PdfDictionary pdfObject)

Method Detail

makeAnnotation

public static PdfAnnotation makeAnnotation(PdfObject pdfObject,
                                           PdfAnnotation parent)

getSubtype

public abstract PdfName getSubtype()

setLayer

public void setLayer(IPdfOCG layer)

Sets the layer this annotation belongs to.

Parameters:

layer - the layer this annotation belongs to

setAction

public PdfAnnotation setAction(PdfAction action)

setAdditionalAction

public PdfAnnotation setAdditionalAction(PdfName key,
                                         PdfAction action)

getContents

public PdfString getContents()

setContents

public PdfAnnotation setContents(PdfString contents)

setContents

public PdfAnnotation setContents(String contents)

getPageObject

public PdfDictionary getPageObject()

getPage

public PdfPage getPage()

setPage

public PdfAnnotation setPage(PdfPage page)

getName

public PdfString getName()

setName

public PdfAnnotation setName(PdfString name)

getDate

public PdfString getDate()

setDate

public PdfAnnotation setDate(PdfString date)

getFlags

public int getFlags()

setFlags

public PdfAnnotation setFlags(int flags)

setFlag

public PdfAnnotation setFlag(int flag)

resetFlag

public PdfAnnotation resetFlag(int flag)

hasFlag

public boolean hasFlag(int flag)

getAppearanceDictionary

public PdfDictionary getAppearanceDictionary()

getAppearanceObject

public PdfDictionary getAppearanceObject(PdfName appearanceType)

getNormalAppearanceObject

public PdfDictionary getNormalAppearanceObject()

getRolloverAppearanceObject

public PdfDictionary getRolloverAppearanceObject()

getDownAppearanceObject

public PdfDictionary getDownAppearanceObject()

setAppearance

public PdfAnnotation setAppearance(PdfName appearanceType,
                                   PdfDictionary appearance)

setNormalAppearance

public PdfAnnotation setNormalAppearance(PdfDictionary appearance)

setRolloverAppearance

public PdfAnnotation setRolloverAppearance(PdfDictionary appearance)

setDownAppearance

public PdfAnnotation setDownAppearance(PdfDictionary appearance)

setAppearance

public PdfAnnotation setAppearance(PdfName appearanceType,
                                   PdfAnnotationAppearance appearance)

setNormalAppearance

public PdfAnnotation setNormalAppearance(PdfAnnotationAppearance appearance)

setRolloverAppearance

public PdfAnnotation setRolloverAppearance(PdfAnnotationAppearance appearance)

setDownAppearance

public PdfAnnotation setDownAppearance(PdfAnnotationAppearance appearance)

getAppearanceState

public PdfName getAppearanceState()

setAppearanceState

public PdfAnnotation setAppearanceState(PdfName as)

getBorder

public PdfArray getBorder()

setBorder

public PdfAnnotation setBorder(PdfArray border)

getColorObject

public PdfArray getColorObject()

setColor

public PdfAnnotation setColor(PdfArray color)

setColor

public PdfAnnotation setColor(float[] color)

setColor

public PdfAnnotation setColor(Color color)

getStructParentIndex

public int getStructParentIndex()

setStructParentIndex

public PdfAnnotation setStructParentIndex(int structParentIndex)

getQuadPoints

public PdfArray getQuadPoints()

getOpen

public boolean getOpen()

setOpen

public PdfAnnotation setOpen(boolean open)

setQuadPoints

public PdfAnnotation setQuadPoints(PdfArray quadPoints)

setBorderStyle

public PdfAnnotation setBorderStyle(PdfDictionary borderStyle)

setBorderStyle

public PdfAnnotation setBorderStyle(PdfName style)

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

• STYLE_SOLID - A solid rectangle surrounding the annotation.
• STYLE_DASHED - A dashed rectangle surrounding the annotation.
• STYLE_BEVELED - A simulated embossed rectangle that appears to be raised above the surface of the page.
• STYLE_INSET - A simulated engraved rectangle that appears to be recessed below the surface of the page.
• STYLE_UNDERLINE - A single line along the bottom of the annotation rectangle.

Parameters:

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

Returns:

The annotation which this method was called on.

setDashPattern

public PdfAnnotation setDashPattern(PdfArray dashPattern)

getBorderStyle

public PdfDictionary getBorderStyle()

makeAnnotation

public static PdfAnnotation makeAnnotation(PdfObject pdfObject)

setTitle

public PdfAnnotation setTitle(PdfString title)

getTitle

public PdfString getTitle()

setAppearanceCharacteristics

public PdfAnnotation setAppearanceCharacteristics(PdfDictionary characteristics)

getAppearanceCharacteristics

public PdfDictionary getAppearanceCharacteristics()

getAction

public PdfDictionary getAction()

getAdditionalAction

public PdfDictionary getAdditionalAction()

setRectangle

public PdfAnnotation setRectangle(PdfArray array)

getRectangle

public PdfArray getRectangle()

put

public PdfAnnotation put(PdfName key,
                         PdfObject value)

remove

public PdfAnnotation remove(PdfName key)

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<PdfDictionary>

Returns:

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