com.aowagie.text.pdf

Class PdfAnnotation

java.lang.Object

com.aowagie.text.pdf.PdfObject

com.aowagie.text.pdf.PdfDictionary

com.aowagie.text.pdf.PdfAnnotation

Direct Known Subclasses:

PdfFormField

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 and Description
protected boolean	annotation
static int	FLAGS_PRINT flagvalue
protected boolean	form
protected HashMap	templates
protected boolean	used Holds value of property used.
protected PdfWriter	writer

Fields inherited from class com.aowagie.text.pdf.PdfDictionary

hashMap

Fields inherited from class com.aowagie.text.pdf.PdfObject

ARRAY, bytes, INDIRECT, STREAM, TEXT_UNICODE, type

Constructor Summary

Constructors

Constructor and Description
PdfAnnotation(PdfWriter writer, float llx, float lly, float urx, float ury, PdfAction action) Constructs a new PdfAnnotation of subtype link (Action).
PdfAnnotation(PdfWriter writer, float llx, float lly, float urx, float ury, PdfString title, PdfString content) Constructs a new PdfAnnotation of subtype text.

Method Summary

Modifier and Type	Method and Description
static PdfAnnotation	createScreen(PdfWriter writer, Rectangle rect, String clipTitle, PdfFileSpecification fs, String mimeType, boolean playOnDisplay) Creates a screen PdfAnnotation
PdfIndirectReference	getIndirectReference() Returns an indirect reference to the annotation
int	getPlaceInPage() Getter for property placeInPage.
HashMap	getTemplates()
boolean	isAnnotation() Getter for property annotation.
boolean	isForm() Getter for property form.
boolean	isUsed() Getter for property used.
void	setAction(PdfAction action)
void	setAppearanceState(String state)
void	setBorder(com.aowagie.text.pdf.PdfBorderArray border)
void	setBorderStyle(com.aowagie.text.pdf.PdfBorderDictionary border)
void	setColor(Color color)
void	setDefaultAppearanceString(PdfContentByte cb)
void	setFlags(int flags)
void	setHighlighting(PdfName highlight) Sets the annotation's highlighting mode.
void	setLayer(PdfOCG layer) Sets the layer this annotation belongs to.
void	setMKAlternateCaption(String caption)
void	setMKAlternateIcon(PdfTemplate template)
void	setMKBackgroundColor(Color color)
void	setMKBorderColor(Color color)
void	setMKNormalCaption(String caption)
void	setMKNormalIcon(PdfTemplate template)
void	setMKRolloverCaption(String caption)
void	setMKRolloverIcon(PdfTemplate template)
void	setMKRotation(int rotation)
void	setMKTextPosition(int tp)
void	setName(String name) Sets the name of the annotation.
void	setPage(int page)
void	setPlaceInPage(int placeInPage) Places the annotation in a specified page that must be greater or equal to the current one.
void	setPopup(PdfAnnotation popup)
void	setRotate(int v)
void	setTitle(String title)
void	setUsed() Setter for property used.

Methods inherited from class com.aowagie.text.pdf.PdfDictionary

get, getAsArray, getAsDict, getAsName, getAsNumber, getAsString, getDirectObject, getKeys, isCatalog, isFont, isOutlineTree, isPage, isPages, put, remove, size, toPdf, toString

Methods inherited from class com.aowagie.text.pdf.PdfObject

getBytes, getIndRef, isArray, isBoolean, isDictionary, isIndirect, isName, isNull, isNumber, isStream, isString, setContent, setIndRef, type

Methods inherited from class java.lang.Object

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

Field Detail

FLAGS_PRINT

public static final int FLAGS_PRINT

flagvalue

See Also:

Constant Field Values

writer

protected PdfWriter writer

templates

protected HashMap templates

form

protected boolean form

annotation

protected boolean annotation

used

protected boolean used

Holds value of property used.

Constructor Detail

PdfAnnotation

public PdfAnnotation(PdfWriter writer,
                     float llx,
                     float lly,
                     float urx,
                     float ury,
                     PdfString title,
                     PdfString content)

Constructs a new PdfAnnotation of subtype text.

Parameters:

writer - writer to put

llx - position llx to put

lly - position lly to put

urx - position urx to put

ury - position ury to put

title - title to put

content - content to put

PdfAnnotation

public PdfAnnotation(PdfWriter writer,
                     float llx,
                     float lly,
                     float urx,
                     float ury,
                     PdfAction action)

Constructs a new PdfAnnotation of subtype link (Action).

Parameters:

writer - writer to put

llx - position llx to put

lly - position lly to put

urx - position urx to put

ury - position ury to put

action - action to put

Method Detail

createScreen

public static PdfAnnotation createScreen(PdfWriter writer,
                                         Rectangle rect,
                                         String clipTitle,
                                         PdfFileSpecification fs,
                                         String mimeType,
                                         boolean playOnDisplay)
                                  throws IOException

Creates a screen PdfAnnotation

Parameters:

writer - Writer to create

rect - Rectangle to create

clipTitle - Cliptitle to create

fs - FileSpecification to create

mimeType - Mimetype to set

playOnDisplay - PlayOnDisplay to set

Returns:

a screen PdfAnnotation

Throws:

IOException - Exception of a I/O

getIndirectReference

public PdfIndirectReference getIndirectReference()

Returns an indirect reference to the annotation

Returns:

the indirect reference

setDefaultAppearanceString

public void setDefaultAppearanceString(PdfContentByte cb)

setFlags

public void setFlags(int flags)

setBorder

public void setBorder(com.aowagie.text.pdf.PdfBorderArray border)

setBorderStyle

public void setBorderStyle(com.aowagie.text.pdf.PdfBorderDictionary border)

setHighlighting

public void setHighlighting(PdfName highlight)

Sets the annotation's highlighting mode. The values can be HIGHLIGHT_NONE, HIGHLIGHT_INVERT, HIGHLIGHT_OUTLINE and HIGHLIGHT_PUSH;

Parameters:

highlight - the annotation's highlighting mode

setAppearanceState

public void setAppearanceState(String state)

setColor

public void setColor(Color color)

setTitle

public void setTitle(String title)

setPopup

public void setPopup(PdfAnnotation popup)

setAction

public void setAction(PdfAction action)

isUsed

public boolean isUsed()

Getter for property used.

Returns:

Value of property used.

setUsed

public void setUsed()

Setter for property used.

getTemplates

public HashMap getTemplates()

isForm

public boolean isForm()

Getter for property form.

Returns:

Value of property form.

isAnnotation

public boolean isAnnotation()

Getter for property annotation.

Returns:

Value of property annotation.

setPage

public void setPage(int page)

getPlaceInPage

public int getPlaceInPage()

Getter for property placeInPage.

Returns:

Value of property placeInPage.

setPlaceInPage

public void setPlaceInPage(int placeInPage)

Places the annotation in a specified page that must be greater or equal to the current one. With PdfStamper the page can be any. The first page is 1.

Parameters:

placeInPage - New value of property placeInPage.

setRotate

public void setRotate(int v)

setMKRotation

public void setMKRotation(int rotation)

setMKBorderColor

public void setMKBorderColor(Color color)

setMKBackgroundColor

public void setMKBackgroundColor(Color color)

setMKNormalCaption

public void setMKNormalCaption(String caption)

setMKRolloverCaption

public void setMKRolloverCaption(String caption)

setMKAlternateCaption

public void setMKAlternateCaption(String caption)

setMKNormalIcon

public void setMKNormalIcon(PdfTemplate template)

setMKRolloverIcon

public void setMKRolloverIcon(PdfTemplate template)

setMKAlternateIcon

public void setMKAlternateIcon(PdfTemplate template)

setMKTextPosition

public void setMKTextPosition(int tp)

setLayer

public void setLayer(PdfOCG layer)

Sets the layer this annotation belongs to.

Parameters:

layer - the layer this annotation belongs to

setName

public void setName(String name)

Sets the name of the annotation. With this name the annotation can be identified among all the annotations on a page (it has to be unique).

Parameters:

name - name to set