Package com.reportmill.pdf

Class PDFAnnotation

java.lang.Object

com.reportmill.base.RMObject

com.reportmill.pdf.PDFAnnotation

All Implemented Interfaces:

RMArchiver.Archiving, java.lang.Cloneable

Direct Known Subclasses:

PDFAnnotation.Link

public class PDFAnnotation
extends RMObject

This class represents a PDF annotation (like a hyperlink).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PDFAnnotation.Link	An inner class (and annotation subclass) to support hyperlinks.

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.Map	_map
static char	HighlightInvert
static char	HighlightNone
static char	HighlightOutline
static char	HighlightPush

Constructor Summary

Constructors

Constructor	Description
PDFAnnotation(RMRect aRect)	Creates a new annotation for the given rect.

Method Summary

Modifier and Type	Method	Description
void	resolvePageReferences(PDFPagesTree pages, PDFXTable xref, PDFPage thisPage)	Tells the annotation to resolve page references.
void	setHasBorder(boolean b)	Sets whether the annotation has a border.
void	setHighlightMode(char h)	Sets the highlight mode of the annotaiton.
void	setType(java.lang.String s)	Sets the type of the annotation.
void	writePDF(PDFFile pFile)	Writes the annotation to the given PDF file.

Methods inherited from class com.reportmill.base.RMObject

clone, copy, didChange, didUndo, getAnimAttribute, getClassNameShort, initWithArchiver, undoClone, undoCopy, undoEquals

Methods inherited from class java.lang.Object

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

Field Detail

_map

protected java.util.Map _map

HighlightNone

public static final char HighlightNone

See Also:

Constant Field Values

HighlightInvert

public static final char HighlightInvert

See Also:

Constant Field Values

HighlightOutline

public static final char HighlightOutline

See Also:

Constant Field Values

HighlightPush

public static final char HighlightPush

See Also:

Constant Field Values

Constructor Detail

PDFAnnotation

public PDFAnnotation(RMRect aRect)

Creates a new annotation for the given rect.

Method Detail

setType

public void setType(java.lang.String s)

Sets the type of the annotation.

setHighlightMode

public void setHighlightMode(char h)

Sets the highlight mode of the annotaiton.

setHasBorder

public void setHasBorder(boolean b)

Sets whether the annotation has a border.

resolvePageReferences

public void resolvePageReferences(PDFPagesTree pages,
                                  PDFXTable xref,
                                  PDFPage thisPage)

Tells the annotation to resolve page references.

writePDF

public void writePDF(PDFFile pFile)

Writes the annotation to the given PDF file.