UnderlineAnnotation Class Documentation

class UnderlineAnnotation : TextMarkupAnnotation

Namespace:com::datalogics::PDFL

Inherits from:
TextMarkupAnnotation

Detailed Description

A type of text markup annotation, for underlining text. Text markup annotations added to a PDF file appear as highlights, underlines, or strikeouts. The Underline Annotation appears PDF document as underlined text when the documnent is opened in a PDF Viewer.

Constructor & Destructor Documentation

UnderlineAnnotation

UnderlineAnnotation(Page page, int addAfter, java.util.List< Quad > quadList)

Parameters

page: Page

The page to which the UnderlineAnnotation is added.

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.

quadList: java.util.List< Quad >

A list of quads to underline. Each quad encompasses a word or group of contiguous words in the text underlying the annotation.

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

UnderlineAnnotation

UnderlineAnnotation(Page page, java.util.List< Quad > quadList)

Parameters

page: Page

The page to which the UnderlineAnnotation is added.

quadList: java.util.List< Quad >

A list of quads to underline. Each quad encompasses a word or group of contiguous words in the text underlying the annotation.

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

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

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.

getAnnotatedText

String getAnnotatedText(boolean splitLines)

Parameters

splitLines: boolean

If true, text corresponding to each quadrilateral will be separated by CRLF characters. If false, text corresponding to each quadrilateral will be separated by spaces.

Returns:

String

The text marked by the annotation.

The text that is marked by the annotation. Marked text is defined as text which falls within one or more of the quadrilaterals specified by the annotation's QuadPoints entry. If the annotation marks partial words, only those portions of the word that are bounded within the QuadPoints array will be returned. If the annotation marks partial characters, the characters that fall partially within the annotation bounds may not be returned.

getAnnotationFeatureLevel

double getAnnotationFeatureLevel()

Returns:

double

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

getColor

Color getColor()

Returns:

Color

The color of the annotation.

getContents

String getContents()

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

Color getInteriorColor()

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

Form getNormalAppearance()

Returns:

Form

getOpacity

double getOpacity()

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

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

Retrieve the PDFObject representation of this object

getRect

Rect getRect()

Returns:

Rect

The size and location of the annotation on its page

getSubtype

String getSubtype()

Returns:

String

The annotation's subtype

getTitle

String getTitle()

Returns:

String

The title of the annotation.

hasRichTextData

boolean hasRichTextData()

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

boolean isCurrentlyVisible(OptionalContentContext occ)

Parameters

occ: OptionalContentContext

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.

setColor

void setColor(Color arg0)

Parameters

arg0: Color

Returns:

void

The color of the annotation.

setContents

void setContents(String arg0)

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

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

Parameters

arg0: java.util.EnumSet< AnnotationFlags >

Returns:

void

The flags for the annotation.

setInteriorColor

void setInteriorColor(Color color)

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

void setNormalAppearance(Form form)

Parameters

form: Form

Returns:

void

setOpacity

void setOpacity(double opacityValue)

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

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.

setQuads

void setQuads(java.util.List< Quad > theQuads)

Parameters

theQuads: java.util.List< Quad >

Returns:

void

A list of quads to mark. Each quad encompasses a word or group of contiguous words in the text underlying the annotation.

setRect

void setRect(Rect rect)

Parameters

rect: Rect

Returns:

void

The size and location of the annotation on its page

setTitle

void setTitle(String title)

Parameters

title: String

Returns:

void

The title of the annotation.

toString

String toString()

Returns:

String