com.datalogics.PDFL

Class TextMarkupAnnotation

java.lang.Object

com.datalogics.PDFL.Annotation

com.datalogics.PDFL.TextMarkupAnnotation

Direct Known Subclasses:

HighlightAnnotation, UnderlineAnnotation

public class TextMarkupAnnotation
extends Annotation

Annotations that appears as highlighted content when added to a PDF file. Text markup annotations appear as highlights, underlines, or strikeouts when added to a PDF document in a PDF Viewer. When the edited PDF file is opened the markups appear in a pop-up window containing the text of the associated note.

Method Summary

Modifier and Type	Method and Description
void	delete()
java.lang.String	getAnnotatedText(boolean splitLines) The text that is marked by the annotation.
double	getAnnotationFeatureLevel() The minimum PDF version necessary to support the features used in this annotation.
java.util.List<Quad>	getQuads() A list of quads to mark.
void	setAnnotationFeatureLevel(double featureLevel) Removes features not supported in the supplied version number.
void	setQuads(java.util.List<Quad> theQuads) A list of quads to mark.

Methods inherited from class com.datalogics.PDFL.Annotation

equals, generateAppearance, getColor, getContents, getFlags, getInteriorColor, getNormalAppearance, getOpacity, getOptionalContentMembershipDict, getPDFDict, getRect, getSubtype, getTitle, hasRichTextData, isCurrentlyVisible, setColor, setContents, setFlags, setInteriorColor, setNormalAppearance, setOpacity, setOptionalContentMembershipDict, setRect, setTitle, toString

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

delete

public void delete()

Overrides:

delete in class Annotation

getAnnotationFeatureLevel

public double getAnnotationFeatureLevel()

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

Overrides:

getAnnotationFeatureLevel in class Annotation

setAnnotationFeatureLevel

public void setAnnotationFeatureLevel(double featureLevel)

Removes features not supported in the supplied version number.

Overrides:

setAnnotationFeatureLevel in class Annotation

getQuads

public java.util.List<Quad> getQuads()

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

setQuads

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

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

getAnnotatedText

public java.lang.String getAnnotatedText(boolean splitLines)

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.

Parameters:

splitLines - 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:

The text marked by the annotation.