Annotation Class Documentation

class Annotation

Namespace:com::datalogics::PDFL

Derived classes:
CircleAnnotation, FreeTextAnnotation, InkAnnotation, LineAnnotation, LinkAnnotation, PolyLineAnnotation, PolygonAnnotation, Redaction, SquareAnnotation, TextMarkupAnnotation

Detailed Description

Associates an object with its location on a page of a PDF document. An annotation associates an object such as a note, sound, or movie with a location on a page of a PDF document, or provides a way to interact with the user by means of the mouse and keyboard.

Referenced by

AnnotationCircleAnnotationFreeTextAnnotationHighlightAnnotationInkAnnotationLineAnnotationLinkAnnotationPagePolyLineAnnotationPolygonAnnotationRedactionSquareAnnotationTextMarkupAnnotationUnderlineAnnotation

Constructor & Destructor Documentation

Annotation

Annotation(Page page, String subtype, Rect initialRect)

Parameters

page: Page

The page to which the annotation is added.

subtype: String

The type of the annotation.

initialRect: Rect

A rectangle specifying the annotation's bounds, specified in user space coordinates.

Create a new Annotation at the end of a page's annotation array. To create an annotation and place it elsewhere in the page's annotation array, use the version of the constructor that takes an array position.

Annotation

Annotation(Page page, String subtype, Rect initialRect, int addAfter)

Parameters

page: Page

The page to which the annotation is added.

subtype: String

The type of the annotation.

initialRect: Rect

A rectangle specifying the annotation's bounds, specified in user space coordinates.

addAfter: int

Where to add the annotation in the page's annotation array.

Create a new Annotation at a specific index in the page's annotation array.

Member Function Documentation

delete

synchronized void delete(Boolean disposing)

Parameters

disposing: Boolean

Returns:

synchronized void

delete

synchronized void delete()

Returns:

synchronized void

equals

boolean equals(Object rhs)

Parameters

rhs: Object

Returns:

boolean

finalize

void finalize()

Returns:

void

generateAppearance

Form generateAppearance()

Returns:

Form

A Form representing the visual appearance, or null if the appearance could not be generated.

Generate a new appearance stream with the current annotation properties. The resulting Form can then be used to set the annotation's appearance, such as by calling SetNormalAppearance.

getAnnotationFeatureLevel

double getAnnotationFeatureLevel()

Returns:

double

The minimum PDF version level (e.g. 1.3, 1.4, or 1.5).

The minimum PDF version necessary to support the features used in this annotation.

getColor

Color getColor()

Returns:

Color

The annotation's color.

The color of the annotation.

getContents

String getContents()

Returns:

String

The annotation's text contents.

The text contents of the annotation. The text to be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation's contents in human-readable form.

getFlags

java.util.EnumSet< AnnotationFlags > getFlags()

Returns:

java.util.EnumSet< AnnotationFlags >

The annotation's flags.

The flags for the annotation.

getInteriorColor

Color getInteriorColor()

Returns:

Color

The interior fill color, or null if no interior color is set.

The interior color with which to fill the annotation's rectangle or circle. The color of the border itself can be retrieved from Annotation.Color.

getNormalAppearance

Form getNormalAppearance()

Returns:

Form

A Form representing the annotation's normal appearance, or null if no normal appearance has been set.

The normal appearance of the annotation, represented as a Form XObject.

getOpacity

double getOpacity()

Returns:

double

The opacity value for this annotation.

The constant opacity value used in painting a Markup annotation. Opacity is a range from 0.0 (fully transparent) to 1.0 (fully opaque).

getOptionalContentMembershipDict

OptionalContentMembershipDict getOptionalContentMembershipDict()

Returns:

OptionalContentMembershipDict

the OptionalContentMembershipDict

The OptionalContentMembershipDict property for this Annotation.

Setting this property will attach the Annotation to an OptionalContentMembershipDict; it will then be associated with the OptionalContentGroups and be subject to the VisibilityPolicy and VisibilityExpression of that MembershipDict.

By setting this property to null, the Annotation is detached from any OptionalContentMembershipDict.

getPDFDict

PDFDict getPDFDict()

Returns:

PDFDict

The PDFDict associated with this annotation.

The underlying PDF dictionary for this annotation. Retrieves the PDFDict representation of this annotation object.

getRect

Rect getRect()

Returns:

Rect

The annotation's bounding rectangle in user space coordinates.

The size and location of the annotation on its page.

getSubtype

String getSubtype()

Returns:

String

The subtype string (e.g. "Circle", "Square", "Line").

The annotation's subtype.

getTitle

String getTitle()

Returns:

String

The title string.

The title of the annotation.

hasRichTextData

boolean hasRichTextData()

Returns:

boolean

true if the annotation contains Rich Text String content.

Checks the annotation for Rich Text String content (PDFReference 1.7 Section 8.6.2). Annotations that contain Rich Text String content and do not have a normal appearance set will not be visible when rendering the page.

isCurrentlyVisible

boolean isCurrentlyVisible(OptionalContentContext occ)

Parameters

occ: OptionalContentContext

The optional content context in which to check visibility.

Returns:

boolean

true if the annotation is currently visible.

Tests whether an annotation is visible in a given optional content context, considering the current ON-OFF states of the optional-content groups in the optional-content dictionary (OCMD) and the dictionary's visibility policy.

If the annotation occurs more than once within the content, this method only checks the visibility of the first occurrence of the annotation.

This method determines visibility without considering the visbility of the Content object that the annotation belongs to. To determine the visibility of an annotation while taking the Content's visibility into consideration, use the alternate version of this method.

setAnnotationFeatureLevel

void setAnnotationFeatureLevel(double featureLevel)

Parameters

featureLevel: double

The target PDF version level. Features requiring a higher version will be removed.

Returns:

void

Removes features not supported in the supplied version number.

setColor

void setColor(Color color)

Parameters

color: Color

The new color to set.

Returns:

void

The color of the annotation.

setContents

void setContents(String contents)

Parameters

contents: String

The new text contents.

Returns:

void

The text contents of the annotation. The text to be displayed for the annotation or, if this type of annotation does not display text, an alternate description of the annotation's contents in human-readable form.

setFlags

void setFlags(java.util.EnumSet< AnnotationFlags > flags)

Parameters

flags: java.util.EnumSet< AnnotationFlags >

The new annotation flags to set.

Returns:

void

The flags for the annotation.

setInteriorColor

void setInteriorColor(Color color)

Parameters

color: Color

The new interior fill color. Pass null to remove the interior color.

Returns:

void

The interior color with which to fill the annotation's rectangle or circle. Only RGB colors are allowed.

The color of the border itself can be retrieved from Annotation.Color.

setNormalAppearance

void setNormalAppearance(Form form)

Parameters

form: Form

The Form to use as the annotation's normal appearance.

Returns:

void

The normal appearance of the annotation, represented as a Form XObject.

setOpacity

void setOpacity(double opacityValue)

Parameters

opacityValue: double

The new opacity value to set.

Returns:

void

The constant opacity value used in painting a Markup annotation. Opacity is a range from 0.0 (fully transparent) to 1.0 (fully opaque).

setOptionalContentMembershipDict

void setOptionalContentMembershipDict(OptionalContentMembershipDict ocmd)

Parameters

ocmd: OptionalContentMembershipDict

the OptionalContentMembershipDict

Returns:

void

The OptionalContentMembershipDict property for this Annotation.

Setting this property will attach the Annotation to an OptionalContentMembershipDict; it will then be associated with the OptionalContentGroups and be subject to the VisibilityPolicy and VisibilityExpression of that MembershipDict.

By setting this property to null, the Annotation is detached from any OptionalContentMembershipDict.

setRect

void setRect(Rect rect)

Parameters

rect: Rect

The new bounding rectangle in user space coordinates.

Returns:

void

The size and location of the annotation on its page.

setTitle

void setTitle(String title)

Parameters

title: String

The new title string.

Returns:

void

The title of the annotation.

toString

String toString()

Returns:

String

A string describing this annotation, including its type and rectangle.

Returns a string representation of this annotation.