UnderlineAnnotation Class

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.

Uses types

Annotation Color Form OptionalContentContext OptionalContentMembershipDict PDFDict Page Quad Rect

Constructor & Destructor Documentation

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

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 object representing the underline appearance. The caller takes ownership of the returned object.

Generate a new appearance stream for this underline annotation. Creates a Form containing stroked line paths for each quad in the annotation. The underline width is based on the font size of the text found within each quad, and the annotation's color is used as the stroke color.

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.

double getAnnotationFeatureLevel()

Returns:

double

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

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.

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.

java.util.List< Quad > getQuads()

Returns:

java.util.List< Quad >

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

Rect getRect()

Returns:

Rect

The annotation's bounding rectangle in user space coordinates.

The size and location of the annotation on its page.

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 setAnnotationFeatureLevel(double featureLevel)

Parameters

featureLevel: double

Returns:

void

Removes features not supported in the supplied version number.

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

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.