Package org.openpdf.text.pdf

Class PdfAnnotation

java.lang.Object

org.openpdf.text.pdf.PdfObject

org.openpdf.text.pdf.PdfDictionary

org.openpdf.text.pdf.PdfAnnotation

public class PdfAnnotation
extends PdfDictionary

A PdfAnnotation is a note that is associated with a page.

See Also:

• PdfDictionary

Field Summary

Fields

Modifier and Type	Field	Description
static final PdfName	HIGHLIGHT_INVERT	highlight attributename
protected PdfIndirectReference	reference	Reference to this annotation.
protected PdfWriter	writer

Fields inherited from class org.openpdf.text.pdf.PdfDictionary

CATALOG, FONT, hashMap, OUTLINES, PAGE, PAGES

Fields inherited from class org.openpdf.text.pdf.PdfObject

ARRAY, BOOLEAN, bytes, DICTIONARY, INDIRECT, NAME, NOTHING, NULL, NUMBER, STREAM, STRING, TEXT_PDFDOCENCODING, TEXT_UNICODE, type

Constructor Summary

Constructors

Constructor	Description
PdfAnnotation(PdfWriter writer, Rectangle rect)

Method Summary

Modifier and Type	Method	Description
protected static PdfAnnotation	createLink(PdfWriter writer, Rectangle rect, PdfName highlight)	Creates a link.
static PdfAnnotation	createLink(PdfWriter writer, Rectangle rect, PdfName highlight, String namedDestination)	Creates an Annotation with an local destination.
static PdfAnnotation	createLink(PdfWriter writer, Rectangle rect, PdfName highlight, PdfAction action)	Creates an Annotation with an Action.
PdfIndirectReference	getIndirectReference()	Returns an indirect reference to the annotation

Methods inherited from class org.openpdf.text.pdf.PdfDictionary

contains, get, getAsDict, getDirectObject, getKeys, merge, mergeDifferent, put, putAll, putEx, remove, size, toPdf, toString

Methods inherited from class org.openpdf.text.pdf.PdfObject

canBeInObjStm, getBytes, isArray, isDictionary, isName, isNull, isNumber, isString, setContent, type

Methods inherited from class java.lang.Object

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

Field Details

HIGHLIGHT_INVERT

public static final PdfName HIGHLIGHT_INVERT

highlight attributename

writer

protected PdfWriter writer

reference

protected PdfIndirectReference reference

Reference to this annotation.

Since:

2.1.6; was removed in 2.1.5, but restored in 2.1.6

Constructor Details

PdfAnnotation

public PdfAnnotation(PdfWriter writer,
 Rectangle rect)

Method Details

createLink

protected static PdfAnnotation createLink(PdfWriter writer,
 Rectangle rect,
 PdfName highlight)

Creates a link.

Parameters:

writer - PdfWriter

rect - dimensions Rectangle

highlight - the highlight property

Returns:

A PdfAnnotation

createLink

public static PdfAnnotation createLink(PdfWriter writer,
 Rectangle rect,
 PdfName highlight,
 PdfAction action)

Creates an Annotation with an Action.

Parameters:

writer - PdfWriter

rect - dimensions Rectangle

highlight - title for the link

action - action for annotation

Returns:

A PdfAnnotation

createLink

public static PdfAnnotation createLink(PdfWriter writer,
 Rectangle rect,
 PdfName highlight,
 String namedDestination)

Creates an Annotation with an local destination.

Parameters:

writer - PdfWriter

rect - dimensions Rectangle

highlight - title for the link

namedDestination - destination for pdf annotation

Returns:

A PdfAnnotation

getIndirectReference

public PdfIndirectReference getIndirectReference()

Returns an indirect reference to the annotation

Returns:

the indirect reference