Package org.loboevolution.pdfview.annotation

Class PDFAnnotation

java.lang.Object

org.loboevolution.pdfview.annotation.PDFAnnotation

Direct Known Subclasses:

LinkAnnotation, StampAnnotation, 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).

Author Katja Sondermann

Since:

03.07.2009 **************************************************************************

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PDFAnnotation.ANNOTATION_TYPE

Field Summary

Fields

Modifier and Type	Field	Description
static final String	GOTO	Definition of some annotation sub-types
static final String	GOTOE	Constant GOTOE="GoToE"
static final String	GOTOR	Constant GOTOR="GoToR"
static final String	URI	Constant URI="URI"

Constructor Summary

Constructors

Modifier	Constructor	Description
	PDFAnnotation(PDFObject annotObject)	********************************************************************** Constructor
protected	PDFAnnotation(PDFObject annotObject, PDFAnnotation.ANNOTATION_TYPE type)	********************************************************************** Constructor

Method Summary

Modifier and Type	Method	Description
static PDFAnnotation	createAnnotation(PDFObject parent)	********************************************************************** Create a new PDF annotation object.
List<PDFCmd>	getPageCommandsForAnnotation()	Get list of pdf commands for this annotation
protected AffineTransform	getScalingTransformation(Rectangle2D.Float bbox)	getScalingTransformation.
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 java.lang.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

Constant GOTOE="GoToE"

See Also:

• Constant Field Values

GOTOR

public static final String GOTOR

Constant GOTOR="GoToR"

See Also:

• Constant Field Values

URI

public static final String URI

Constant URI="URI"

See Also:

• Constant Field Values

Constructor Details

PDFAnnotation

public PDFAnnotation(PDFObject annotObject)
              throws IOException

********************************************************************** Constructor

Parameters:

annotObject - - the PDFObject which contains the annotation description

Throws:

IOException - if any.

PDFAnnotation

protected PDFAnnotation(PDFObject annotObject,
 PDFAnnotation.ANNOTATION_TYPE type)
                 throws IOException

********************************************************************** Constructor

Parameters:

annotObject - - the PDFObject which contains the annotation description

type - a PDFAnnotation.ANNOTATION_TYPE object.

Throws:

IOException - if any.

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 - a PDFObject object.

Returns:

PDFAnnotation a PDFAnnotation object.

Throws:

IOException - if any.

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.

Returns:

a Rectangle2D.Float object.

Throws:

IOException - if any.

toString

public String toString()

Overrides:

toString in class Object

getPageCommandsForAnnotation

public List<PDFCmd> getPageCommandsForAnnotation()

Get list of pdf commands for this annotation

Returns:

a List object.

getScalingTransformation

protected AffineTransform getScalingTransformation(Rectangle2D.Float bbox)

getScalingTransformation.

Parameters:

bbox - a Rectangle2D.Float object.

Returns:

a AffineTransform object.