Class PDFAnnotation

java.lang.Object

org.openpdf.renderer.annotation.PDFAnnotation

Direct Known Subclasses:

LinkAnnotation, MarkupAnnotation, WidgetAnnotation

public class PDFAnnotation
extends Object

Encapsulate a PDF annotation. This is only the super-class of PDF annotations, which has an "unknown" annotation type. Use the createAnnotation() method for getting an annotation of the correct type (if implemented).

Since:

03.07.2009

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PDFAnnotation.Flags

Field Summary

Fields

Modifier and Type	Field	Description
private final String	annotationName
private String	appearanceState
private final String	contents
private Integer	flags
static final String	GOTO	Definition of some annotation sub-types
static final String	GOTOE
static final String	GOTOR
private String	modified
private final PDFObject	pdfObj
private final Rectangle2D.Float	rect
private final String	subType
private final AnnotationType	type
static final String	URI

Constructor Summary

Constructors

Constructor	Description
PDFAnnotation(PDFObject annotObject)	Constructor
PDFAnnotation(PDFObject annotObject, AnnotationType type)	Constructor

Method Summary

Modifier and Type	Method	Description
static PDFAnnotation	createAnnotation(PDFObject parent)	Create a new PDF annotation object.
String	getAnnotationName()
String	getAppearanceState()
String	getContents()
Integer	getFlags()
String	getModified()
List<PDFCmd>	getPageCommandsForAnnotation()	Get list of pdf commands for this annotation
PDFObject	getPdfObj()	Get the PDF Object which contains the annotation values
Rectangle2D.Float	getRect()	Get the rectangle on which the annotation should be applied to
protected AffineTransform	getScalingTransformation(Rectangle2D.Float bbox)
String	getSubType()
AnnotationType	getType()	Get the annotation type
boolean	isFlagSet(PDFAnnotation.Flags flag)
Rectangle2D.Float	parseRect(PDFObject obj)	Get a Rectangle2D.Float representation for a PDFObject that is an array of four Numbers.
String	toString()

Methods inherited from class Object

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

Field Details

GOTO

public static final String GOTO

Definition of some annotation sub-types

See Also:

• Constant Field Values

GOTOE

public static final String GOTOE

See Also:

• Constant Field Values

GOTOR

public static final String GOTOR

See Also:

• Constant Field Values

URI

public static final String URI

See Also:

• Constant Field Values

pdfObj

private final PDFObject pdfObj

type

private final AnnotationType type

rect

private final Rectangle2D.Float rect

subType

private final String subType

contents

private final String contents

annotationName

private final String annotationName

modified

private String modified

flags

private Integer flags

appearanceState

private String appearanceState

Constructor Details

PDFAnnotation

public PDFAnnotation(PDFObject annotObject)
              throws IOException

Constructor

Parameters:

annotObject - - the PDFObject which contains the annotation description

Throws:

IOException

PDFAnnotation

public PDFAnnotation(PDFObject annotObject,
 AnnotationType type)
              throws IOException

Constructor

Parameters:

annotObject - - the PDFObject which contains the annotation description

Throws:

IOException

Method Details

createAnnotation

public static PDFAnnotation createAnnotation(PDFObject parent)
                                      throws IOException

Create a new PDF annotation object. Currently supported annotation types:

Link annotation

Parameters:

parent -

Returns:

PDFAnnotation

Throws:

IOException

parseRect

public Rectangle2D.Float parseRect(PDFObject obj)
                            throws IOException

Get a Rectangle2D.Float representation for a PDFObject that is an array of four Numbers.

Parameters:

obj - a PDFObject that represents an Array of exactly four Numbers.

Throws:

IOException

getPdfObj

public PDFObject getPdfObj()

Get the PDF Object which contains the annotation values

Returns:

PDFObject

getType

public AnnotationType getType()

Get the annotation type

Returns:

int

getRect

public Rectangle2D.Float getRect()

Get the rectangle on which the annotation should be applied to

Returns:

Rectangle2D.Float

getSubType

public String getSubType()

getAnnotationName

public String getAnnotationName()

getAppearanceState

public String getAppearanceState()

getContents

public String getContents()

getFlags

public Integer getFlags()

isFlagSet

public boolean isFlagSet(PDFAnnotation.Flags flag)

getModified

public String getModified()

toString

public String toString()

Overrides:

toString in class Object

getPageCommandsForAnnotation

public List<PDFCmd> getPageCommandsForAnnotation()

Get list of pdf commands for this annotation

Returns:

getScalingTransformation

protected AffineTransform getScalingTransformation(Rectangle2D.Float bbox)