de.intarsys.pdf.app.annotation

Interface IAnnotationReference

public interface IAnnotationReference

An object designating an annotation within a document.

This can be for example simply a name, referencing an existing object or a full set of descriptions how to create a new one.

Method Summary

Methods

Modifier and Type	Method and Description
PDAnnotation	getAnnotation() The PDAnnotation referenced by this.
PDDocument	getDocument() The PDDocument hosting the PDAnnotation.
Point2D	getPosition() The position of the bounding box of the PDAnnotation.
Point2D	getSize() The size of the bounding box of the PDAnnotation.
boolean	isNew()
boolean	isVisible()

Method Detail

getAnnotation

PDAnnotation getAnnotation()

The PDAnnotation referenced by this.

Evaluating this method may create a new PDAnnotation lazy and modify the PDDocument!

Returns:

The PDAnnotation referenced by this.

getDocument

PDDocument getDocument()

The PDDocument hosting the PDAnnotation.

Returns:

The PDDocument hosting the PDAnnotation.

getPosition

Point2D getPosition()

The position of the bounding box of the PDAnnotation. This may be evaluated even if the PDAnnotation not yet exists without modifying the PDDocument.

Returns:

The position of the bounding box of the PDAnnotation.

getSize

Point2D getSize()

The size of the bounding box of the PDAnnotation. This may be evaluated even if the PDAnnotation not yet exists without modifying the PDDocument.

Returns:

The size of the bounding box of the PDAnnotation.

isNew

boolean isNew()

isVisible

boolean isVisible()