LinkAnnotation Class Documentation

classLinkAnnotation : Annotation

Namespace:com::datalogics::PDFL

Inherits from:
Annotation

Detailed Description

A link annotation, which features an embedded hyperlink.

Referenced by

LinkAnnotation

Constructor & Destructor Documentation

LinkAnnotation

LinkAnnotation(Pagepage, RectinitialRect)

Parameters

page: Page

The page to which the LinkAnnotation is added.

initialRect: Rect

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

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

LinkAnnotation

LinkAnnotation(Pagepage, RectinitialRect, intaddAfter)

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 LinkAnnotation at a specific index in the page's annotation array.

Member Function Documentation

DisposeChildren

voidDisposeChildren()

Returns:

void

[static initializer]

static void[static initializer]()

copyTo

LinkAnnotationcopyTo(Pagedestination)

Parameters

destination: Page

the page to copy the annotation to. The page may be in the same document as the source annotation or in a different document.

Returns:

the annotation created on the destination page.

Copy a LinkAnnotation to the specified page. The annotation will be centered on the page. To center the annotation at a specific point, use the version of this method that accepts a Point.

This creates a copy of the original LinkAnnotation and puts the copy in the destination page's annotation dictionary. Structural content information associated with the source annotation will not be present in the copy. An exception will be thrown if the annotation cannot be copied to the specified page.

Note: If copying LinkAnnotations between pages in different documents, the source annotation may have a ViewDestination that's invalid in the destiantion document or an Action referring to a ViewDestination that's invalid in the destination document. In these cases, an exception will be thrown.

copyTo

LinkAnnotationcopyTo(Pagedestination, PointcenterPoint)

Parameters

destination: Page

the page to copy the annotation to. The page may be in the same document as the source annotation or in a different document.

centerPoint: Point

the point to center the annotation on.

Returns:

the annotation created on the destination page.

Copy a LinkAnnotation to the specified page and center the annotation on the specified point.

This creates a copy of the original LinkAnnotation and puts the copy in the destination page's annotation dictionary. Structural content information associated with the source annotation will not be present in the copy. An exception will be thrown if the annotation cannot be copied to the specified page.

Note: If copying LinkAnnotations between pages in different documents, the source annotation may have a ViewDestination that's invalid in the destiantion document or an Action referring to a ViewDestination that's invalid in the destination document. In these cases, an exception will be thrown.

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.

getAction

ActiongetAction()

Returns:

Action

The Action object for this link.

Note that setting the Action will wipe out the Link's Destination member a link annotation cannot have both members.

getAnnotationFeatureLevel

doublegetAnnotationFeatureLevel()

Returns:

double

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

getBorderStyle

StringgetBorderStyle()

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"

getBorderStyleDashPattern

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]

getBorderStyleWidth

doublegetBorderStyleWidth()

Returns:

double

The border width in points.

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

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.

getDestination

ViewDestinationgetDestination()

Returns:

ViewDestination

The Destination for this link.

Note that setting the Destination will wipe out the Link's Action member a link annotation cannot have both members.

getFlags

java.util.EnumSet< AnnotationFlags >getFlags()

Returns:

java.util.EnumSet< AnnotationFlags >

The flags for the annotation.

getHighlight

HighlightStylegetHighlight()

Returns:

HighlightStyle

The Highlighstyle for this link.

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.

setAction

voidsetAction(Actionnewaction)

Parameters

newaction: Action

Returns:

void

The Action object for this link.

Note that setting the Action will wipe out the Link's Destination member a link annotation cannot have both members.

setAnnotationFeatureLevel

voidsetAnnotationFeatureLevel(doublefeatureLevel)

Parameters

featureLevel: double

Returns:

void

Removes features not supported in the supplied version number.

setBorderStyle

voidsetBorderStyle(Stringstyle)

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"

setBorderStyleDashPattern

voidsetBorderStyleDashPattern(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]

setBorderStyleWidth

voidsetBorderStyleWidth(doublewidth)

Parameters

width: double

Returns:

void

The border width in points.

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

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.

setDestination

voidsetDestination(ViewDestinationnewdest)

Parameters

newdest: ViewDestination

Returns:

void

The Destination for this link.

Note that setting the Destination will wipe out the Link's Action member a link annotation cannot have both members.

setFlags

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

Parameters

arg0: java.util.EnumSet< AnnotationFlags >

Returns:

void

The flags for the annotation.

setHighlight

voidsetHighlight(HighlightStylestyle)

Parameters

style: HighlightStyle

Returns:

void

The Highlighstyle for this link.

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