Annotation Class Documentation

classAnnotation

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(Pagepage, Stringsubtype, RectinitialRect)

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(Pagepage, Stringsubtype, RectinitialRect, intaddAfter)

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

DisposeChildren

voidDisposeChildren()

Returns:

void

[static initializer]

static void[static initializer]()

delete

synchronized voiddelete(Booleandisposing)

Parameters

disposing: Boolean

Returns:

synchronized void

delete

synchronized voiddelete()

Returns:

synchronized void

equals

booleanequals(Objectrhs)

Parameters

rhs: Object

Returns:

boolean

finalize

voidfinalize()

Returns:

void

generateAppearance

FormgenerateAppearance()

Returns:

Form

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

doublegetAnnotationFeatureLevel()

Returns:

double

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

getColor

ColorgetColor()

Returns:

Color

The color of the annotation.

getContents

StringgetContents()

Returns:

String

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 flags for the annotation.

getInteriorColor

ColorgetInteriorColor()

Returns:

Color

The interior color with which to fill the annotation's line endings.

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

getNormalAppearance

FormgetNormalAppearance()

Returns:

Form

getOpacity

doublegetOpacity()

Returns:

double

The optional constant opacity value that shall be used in painting a Markup annotation.

Opacity is a range from 0.0 (fully transparent) to 1.0 (fully opaque).

getOptionalContentMembershipDict

OptionalContentMembershipDictgetOptionalContentMembershipDict()

Returns:

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

PDFDictgetPDFDict()

Returns:

PDFDict

Retrieve the PDFObject representation of this object

getRect

RectgetRect()

Returns:

Rect

The size and location of the annotation on its page

getSubtype

StringgetSubtype()

Returns:

String

The annotation's subtype

getTitle

StringgetTitle()

Returns:

String

The title of the annotation.

hasRichTextData

booleanhasRichTextData()

Returns:

boolean

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

booleanisCurrentlyVisible(OptionalContentContextocc)

Parameters

occ: OptionalContentContext

Returns:

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

voidsetAnnotationFeatureLevel(doublefeatureLevel)

Parameters

featureLevel: double

Returns:

void

Removes features not supported in the supplied version number.

setColor

voidsetColor(Colorarg0)

Parameters

arg0: Color

Returns:

void

The color of the annotation.

setContents

voidsetContents(Stringarg0)

Parameters

arg0: String

Returns:

void

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

voidsetFlags(java.util.EnumSet< AnnotationFlags >arg0)

Parameters

arg0: java.util.EnumSet< AnnotationFlags >

Returns:

void

The flags for the annotation.

setInteriorColor

voidsetInteriorColor(Colorcolor)

Parameters

color: Color

Returns:

void

The interior color with which to fill the annotation's line endings.

Only RGB colors are allowed.

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

setNormalAppearance

voidsetNormalAppearance(Formform)

Parameters

form: Form

Returns:

void

setOpacity

voidsetOpacity(doubleopacityValue)

Parameters

opacityValue: double

Returns:

void

The optional constant opacity value that shall be used in painting a Markup annotation.

Opacity is a range from 0.0 (fully transparent) to 1.0 (fully opaque).

setOptionalContentMembershipDict

voidsetOptionalContentMembershipDict(OptionalContentMembershipDictocmd)

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

voidsetRect(Rectrect)

Parameters

rect: Rect

Returns:

void

The size and location of the annotation on its page

setTitle

voidsetTitle(Stringtitle)

Parameters

title: String

Returns:

void

The title of the annotation.

toString

StringtoString()

Returns:

String