InkAnnotation Class

class InkAnnotation : Annotation

Namespace:com::datalogics::PDFL

Inherits from:: Annotation

Detailed Description

A type of annotation allowing a user to edit a PDF document. Ink annotations in a PDF file allow a user to work with a PDF document displayed on a screen just as if it were on paper, such as scribbling notes in the margins, or circling or underlining text. These types of annotations require a stylus or pen used on a tablet device.

Uses types

Annotation Color Form OptionalContentContext OptionalContentMembershipDict PDFDict Page Point Rect

Constructor & Destructor Documentation

InkAnnotation(Page page, Rect initialRect)

Parameters

page: Page: The page to which the InkAnnotation is added.
initialRect: Rect: A rectangle specifying the annotation's bounds, specified in user space coordinates.

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

InkAnnotation(Page page, Rect initialRect, int addAfter)

Parameters

page: Page: The page to which the annotation is added.
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. To add the annotation to the end of the array, pass a value of -2 or use the alternate version of this constructor that does not take an index (this is generally what you should do unless you have a need to place the annotation at a special location in the array). Passing a value of -1 adds the annotation to the beginning of the array. Passing other negative values produces undefined results.

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

Member Function Documentation

void addScribble(java.util.List< Point > scribble)

Parameters

scribble: java.util.List< Point >: The array of points, in order, that define the vertices of the scribble in user space coordinates, to add to the ink annotation.

Returns:

void

The vertices that define one of many scribbles in an ink annotation, in user space.

synchronized void delete(Boolean disposing)

Parameters

disposing: Boolean

Returns:

synchronized void

synchronized void delete()

Returns:

synchronized void

boolean equals(Object rhs)

Parameters

rhs: Object

Returns:

boolean

void finalize()

Returns:

void

Form generateAppearance()

Returns:

Form

A new Form representing the annotation's appearance, or NULL if the graphic state could not be configured (for example, an invalid dash array).

Generate a new appearance stream with the current annotation properties. Builds the visual representation of the ink annotation from its scribbles, stroke color, and border style. The annotation's Rect is updated to match the bounding box of the content.

double getAnnotationFeatureLevel()

Returns:

double

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

String getBorderStyle()

Returns:

String

The border style.

Can be one of:
S - Solid

D - Dashed. The dash pattern is specified as an array (see DashPattern)

B - Beveled

I - Inset

U - Underline

Other border styles may be defined in the future. Default is "S"

java.util.List< Double > getBorderStyleDashPattern()

Returns:

java.util.List< Double >

An array defining a pattern of dashes and gaps to be used in drawing a dashed border (border style D).

The dash array is a series of numbers that specify the lengths of alternating dashes and gaps. Lengths must be nonnegative, and are expressed in user space units.

Default value is [3]

double getBorderStyleWidth()

Returns:

double

The border width in points.

If this value is 0, no border is drawn. The default is 1.0.

Color getColor()

Returns:

Color

The annotation's color.

The color of the annotation.

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.

java.util.EnumSet< AnnotationFlags > getFlags()

Returns:

java.util.EnumSet< AnnotationFlags >

The annotation's flags.

The flags for the annotation.

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.

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.

int getNumScribbles()

Returns:

int

The number of scribbles in the ink annotation.

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).

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.

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.

Rect getRect()

Returns:

Rect

The annotation's bounding rectangle in user space coordinates.

The size and location of the annotation on its page.

java.util.List< Point > getScribble(int index)

Parameters

index: int: The index of the scribble to get.

Returns:

java.util.List< Point >

An array of points, in order, that define the indexed scribble of the ink annotation, in user space coordinates.

String getSubtype()

Returns:

String

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

The annotation's subtype.

String getTitle()

Returns:

String

The title string.

The title of the annotation.

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.

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.

void removeScribble(int index)

Parameters

index: int: The array of points, in order, that define the vertices of the scribble in user space coordinates, to remove from the ink annotation.

Returns:

void

The vertices that define one of many scribbles in an ink annotation, in user space.

void setAnnotationFeatureLevel(double featureLevel)

Parameters

featureLevel: double

Returns:

void

Removes features not supported in the supplied version number.

void setBorderStyle(String style)

Parameters

style: String

Returns:

void

The border style.

Can be one of:
S - Solid

D - Dashed. The dash pattern is specified as an array (see DashPattern)

B - Beveled

I - Inset

U - Underline

Other border styles may be defined in the future. Default is "S"

void setBorderStyleDashPattern(java.util.List< Double > dashPattern)

Parameters

dashPattern: java.util.List< Double >

Returns:

void

An array defining a pattern of dashes and gaps to be used in drawing a dashed border (border style D).

The dash array is a series of numbers that specify the lengths of alternating dashes and gaps. Lengths must be nonnegative, and are expressed in user space units.

Default value is [3]

void setBorderStyleWidth(double width)

Parameters

width: double

Returns:

void

The border width in points.

If this value is 0, no border is drawn. The default is 1.0.

void setColor(Color color)

Parameters

color: Color: The new color to set.

Returns:

void

The color of the annotation.

void setContents(String contents)

Parameters

contents: String: The new text contents.

Returns:

void

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.

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.

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.

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).

void setOptionalContentMembershipDict(OptionalContentMembershipDict ocmd)

Parameters

ocmd: OptionalContentMembershipDict: the OptionalContentMembershipDict

Returns:

void

The OptionalContentMembershipDict property for this Annotation.

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

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.

void setTitle(String title)

Parameters

title: String: The new title string.

Returns:

void

The title of the annotation.

String toString()

Returns:

String

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

Returns a string representation of this annotation.