LineAnnotation Class Documentation

class LineAnnotation : Annotation

Namespace:com::datalogics::PDFL

Inherits from:
Annotation

Detailed Description

The line annotation displays a single straight line on a PDF page. When opened it displays a pop-up window containing the text of an associated note, placed at specific x/y coordinates for starting and ending points of the line.

Constructor & Destructor Documentation

LineAnnotation

LineAnnotation(Page page, Rect initialRect, Point startPoint, Point endPoint)

Parameters

page: Page

The page to which the LineAnnotation is added.

initialRect: Rect

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

startPoint: Point

The starting coordinate of the line, in user space.

endPoint: Point

The ending coordinate of the line, in user space.

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

LineAnnotation

LineAnnotation(Page page, Rect initialRect, Point startPoint, Point endPoint, 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.

startPoint: Point

The starting coordinate of the line, in user space.

endPoint: Point

The ending coordinate of the line, in user space.

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 LineAnnotation 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 new Form containing the generated appearance, or null if the appearance could not be generated (for example, due to an invalid border style).

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 necessary to support the features used in this annotation.

getBorderStyle

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"

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

double getBorderStyleWidth()

Returns:

double

The border width in points.

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

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.

getEndPoint

Point getEndPoint()

Returns:

Point

The ending coordinate of the line, in user space.

If the line has leader lines, the end point represents the ending point of the leader line rather than the line itself.

getEndPointEndingStyle

LineEndingStyle getEndPointEndingStyle()

Returns:

LineEndingStyle

The ending style applied to the end point of the line (for example, an arrowhead, circle, or square).

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.

getStartPoint

Point getStartPoint()

Returns:

Point

The starting coordinate of the line, in user space.

If the line has leader lines, the start point represents the starting point of the leader line rather than the line itself.

getStartPointEndingStyle

LineEndingStyle getStartPointEndingStyle()

Returns:

LineEndingStyle

The ending style applied to the start point of the line (for example, an arrowhead, circle, or square).

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

Returns:

void

Removes features not supported in the supplied version number.

setBorderStyle

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"

setBorderStyleDashPattern

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]

setBorderStyleWidth

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.

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.

setEndPoint

void setEndPoint(Point endPoint)

Parameters

endPoint: Point

Returns:

void

The ending coordinate of the line, in user space.

If the line has leader lines, the end point represents the ending point of the leader line rather than the line itself.

setEndPointEndingStyle

void setEndPointEndingStyle(LineEndingStyle style)

Parameters

style: LineEndingStyle

Returns:

void

The ending style applied to the end point of the line (for example, an arrowhead, circle, or square).

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.

setStartPoint

void setStartPoint(Point startPoint)

Parameters

startPoint: Point

Returns:

void

The starting coordinate of the line, in user space.

If the line has leader lines, the start point represents the starting point of the leader line rather than the line itself.

setStartPointEndingStyle

void setStartPointEndingStyle(LineEndingStyle style)

Parameters

style: LineEndingStyle

Returns:

void

The ending style applied to the start point of the line (for example, an arrowhead, circle, or square).

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.