Top Description Fields Constructors Methods
org.apache.pdfbox.pdmodel.interactive.annotation

public Class PDAnnotationTextMarkup

extends PDAnnotationMarkup
Class Inheritance
Known Direct Subclasses
org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationUnderline, org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationHighlight, org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationSquiggly, org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationStrikeout
Imports
org.apache.pdfbox.cos.COSDictionary, .COSArray, .COSName

This is the abstract class that represents a text markup annotation introduced in the PDF 1.3 specification, except Squiggly lines in 1.4.
Author
Paul King

Field Summary

Inherited from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup:
RT_GROUPRT_REPLY

Constructor Summary

AccessConstructor and Description
protected
PDAnnotationTextMarkup(String
the subtype the annotation represents
subType
)

Creates a TextMarkup annotation of the specified sub type.

protected
PDAnnotationTextMarkup(COSDictionary
the PDF object to represent as a field.
field
)

Creates a TextMarkup annotation from a COSDictionary, expected to be a correct object definition.

Method Summary

Modifier and TypeMethod and Description
public float[]

Returns:

An array of floats representing the quad points.
getQuadPoints
()

This will retrieve the set of quadpoints which encompass the areas of this annotation.

public final void
setQuadPoints(float[]
an array representing the set of area covered
quadPoints
)

This will set the set of quadpoints which encompass the areas of this annotation.

Inherited from org.apache.pdfbox.pdmodel.interactive.annotation.PDAnnotationMarkup:
getBorderStylegetConstantOpacitygetCreationDategetExternalDatagetInReplyTogetIntentgetPopupgetReplyTypegetRichContentsgetSubjectgetTitlePopupsetBorderStylesetConstantOpacitysetCreationDatesetExternalDatasetInReplyTosetIntentsetPopupsetReplyTypesetRichContentssetSubjectsetTitlePopup

Constructor Detail

PDAnnotationTextMarkupback to summary
protected PDAnnotationTextMarkup(String subType)

Creates a TextMarkup annotation of the specified sub type.

Parameters
subType:String

the subtype the annotation represents

PDAnnotationTextMarkupback to summary
protected PDAnnotationTextMarkup(COSDictionary field)

Creates a TextMarkup annotation from a COSDictionary, expected to be a correct object definition.

Parameters
field:COSDictionary

the PDF object to represent as a field.

Method Detail

getQuadPointsback to summary
public float[] getQuadPoints()

This will retrieve the set of quadpoints which encompass the areas of this annotation.

Returns:float[]

An array of floats representing the quad points.

setQuadPointsback to summary
public final void setQuadPoints(float[] quadPoints)

This will set the set of quadpoints which encompass the areas of this annotation.

Parameters
quadPoints:float[]

an array representing the set of area covered