Package com.itextpdf.kernel.pdf.annot

Class PdfTextMarkupAnnotation

java.lang.Object

com.itextpdf.kernel.pdf.PdfObjectWrapper<PdfDictionary>

com.itextpdf.kernel.pdf.annot.PdfAnnotation

com.itextpdf.kernel.pdf.annot.PdfMarkupAnnotation

com.itextpdf.kernel.pdf.annot.PdfTextMarkupAnnotation

       public class PdfTextMarkupAnnotation extends PdfMarkupAnnotation
      

Field Summary

Fields

Modifier and Type	Field	Description
static final PdfName	MarkupHighlight	Subtypes
static final PdfName	MarkupSquiggly
static final PdfName	MarkupStrikeout
static final PdfName	MarkupUnderline

Fields inherited from class com.itextpdf.kernel.pdf.annot.PdfMarkupAnnotation

inReplyTo, popup

Fields inherited from class com.itextpdf.kernel.pdf.annot.PdfAnnotation

Accepted, Canceled, Completed, HIDDEN, HIGHLIGHT_INVERT, HIGHLIGHT_NONE, HIGHLIGHT_OUTLINE, HIGHLIGHT_PUSH, HIGHLIGHT_TOGGLE, INVISIBLE, LOCKED, LOCKED_CONTENTS, Marked, MarkedModel, NO_ROTATE, NO_VIEW, NO_ZOOM, None, page, PRINT, READ_ONLY, Rejected, ReviewModel, STYLE_BEVELED, STYLE_DASHED, STYLE_INSET, STYLE_SOLID, STYLE_UNDERLINE, TOGGLE_NO_VIEW, Unmarked

Constructor Summary

Constructors

Modifier	Constructor	Description
	PdfTextMarkupAnnotation(Rectangle rect, PdfName subtype, float[] quadPoints)
protected	PdfTextMarkupAnnotation(PdfDictionary pdfObject)	Instantiates a new PdfTextMarkupAnnotation instance based on PdfDictionary instance, that represents existing annotation object in the document.

Method Summary

Modifier and Type	Method	Description
static PdfTextMarkupAnnotation	createHighLight(Rectangle rect, float[] quadPoints)	Creates a text markup annotation of highlight style subtype.
static PdfTextMarkupAnnotation	createSquiggly(Rectangle rect, float[] quadPoints)	Creates a text markup annotation of squiggly-underline type.
static PdfTextMarkupAnnotation	createStrikeout(Rectangle rect, float[] quadPoints)	Creates a text markup annotation of strikeout style subtype.
static PdfTextMarkupAnnotation	createUnderline(Rectangle rect, float[] quadPoints)	Creates a text markup annotation of underline style subtype.
PdfArray	getQuadPoints()	An array of 8 × n numbers specifying the coordinates of n quadrilaterals in default user space.
PdfName	getSubtype()	Gets a PdfName which value is a subtype of this annotation.
PdfTextMarkupAnnotation	setQuadPoints(PdfArray quadPoints)	Sets n quadrilaterals in default user space by passing an PdfArray of 8 × n numbers.

Methods inherited from class com.itextpdf.kernel.pdf.annot.PdfMarkupAnnotation

getCreationDate, getExternalData, getInReplyTo, getInReplyToObject, getIntent, getOpacity, getPopup, getPopupObject, getReplyType, getRichText, getSubject, getText, setCreationDate, setExternalData, setInReplyTo, setIntent, setOpacity, setPopup, setReplyType, setRichText, setSubject, setText

Methods inherited from class com.itextpdf.kernel.pdf.annot.PdfAnnotation

addAssociatedFile, flush, getAppearanceDictionary, getAppearanceObject, getAppearanceState, getAssociatedFiles, getBlendMode, getBorder, getColorObject, getContents, getDate, getDownAppearanceObject, getFlags, getLang, getName, getNonStrokingOpacity, getNormalAppearanceObject, getPage, getPageObject, getRectangle, getRolloverAppearanceObject, getStrokingOpacity, getStructParentIndex, getTitle, hasFlag, isWrappedObjectMustBeIndirect, makeAnnotation, put, remove, resetFlag, setAppearance, setAppearance, setAppearanceState, setBlendMode, setBorder, setBorder, setColor, setColor, setColor, setContents, setContents, setDate, setDownAppearance, setDownAppearance, setFlag, setFlags, setLang, setLayer, setName, setNonStrokingOpacity, setNormalAppearance, setNormalAppearance, setPage, setRectangle, setRolloverAppearance, setRolloverAppearance, setStrokingOpacity, setStructParentIndex, setTitle

Methods inherited from class com.itextpdf.kernel.pdf.PdfObjectWrapper

ensureObjectIsAddedToDocument, ensureUnderlyingObjectHasIndirectReference, getPdfObject, isFlushed, makeIndirect, makeIndirect, markObjectAsIndirect, setForbidRelease, setModified, setPdfObject, unsetForbidRelease

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

MarkupHighlight

             public static final PdfName MarkupHighlight
            

Subtypes

MarkupUnderline

             public static final PdfName MarkupUnderline
            

MarkupStrikeout

             public static final PdfName MarkupStrikeout
            

MarkupSquiggly

             public static final PdfName MarkupSquiggly
            

Constructor Details

PdfTextMarkupAnnotation

             public PdfTextMarkupAnnotation
             (Rectangle rect, PdfName subtype, float[] quadPoints)
            

PdfTextMarkupAnnotation

             protected PdfTextMarkupAnnotation
             (PdfDictionary pdfObject)
            

Instantiates a new PdfTextMarkupAnnotation instance based on PdfDictionary instance, that represents existing annotation object in the document.

Parameters:

pdfObject - the PdfDictionary representing annotation object

See Also:

• PdfAnnotation.makeAnnotation(PdfObject)

Method Details

createHighLight

             public static PdfTextMarkupAnnotation createHighLight
             (Rectangle rect, float[] quadPoints)
            

Creates a text markup annotation of highlight style subtype.

IMPORTANT NOTE on quadPoints argument: According to Table 179 in ISO 32000-1, the QuadPoints array lists the vertices in counterclockwise order and the text orientation is defined by the first and second vertex. This basically means QuadPoints is specified as lower-left, lower-right, top-right, top-left. HOWEVER, Adobe's interpretation (tested at least with Acrobat 10, Acrobat 11, Reader 11) is top-left, top-right, lower-left, lower-right (Z-shaped order). This means that if the QuadPoints array is specified according to the standard, the rendering is not as expected. Other viewers seem to follow Adobe's interpretation. Hence we recommend to use and expect QuadPoints array in Z-order, just as Acrobat and probably most other viewers expect.

Parameters:

rect - the annotation rectangle, defining the location of the annotation on the page in default user space units.

quadPoints - An array of 8 × n numbers specifying the coordinates of n quadrilaterals in default user space. Each quadrilateral shall encompasses a word or group of contiguous words in the text underlying the annotation. The text is oriented with respect to the edge connecting first two vertices.

Returns:

created PdfTextMarkupAnnotation of Highlight type.

createUnderline

             public static PdfTextMarkupAnnotation createUnderline
             (Rectangle rect, float[] quadPoints)
            

Creates a text markup annotation of underline style subtype.

IMPORTANT NOTE on quadPoints argument: According to Table 179 in ISO 32000-1, the QuadPoints array lists the vertices in counterclockwise order and the text orientation is defined by the first and second vertex. This basically means QuadPoints is specified as lower-left, lower-right, top-right, top-left. HOWEVER, Adobe's interpretation (tested at least with Acrobat 10, Acrobat 11, Reader 11) is top-left, top-right, lower-left, lower-right (Z-shaped order). This means that if the QuadPoints array is specified according to the standard, the rendering is not as expected. Other viewers seem to follow Adobe's interpretation. Hence we recommend to use and expect QuadPoints array in Z-order, just as Acrobat and probably most other viewers expect.

Parameters:

rect - the annotation rectangle, defining the location of the annotation on the page in default user space units.

quadPoints - An array of 8 × n numbers specifying the coordinates of n quadrilaterals in default user space. Each quadrilateral shall encompasses a word or group of contiguous words in the text underlying the annotation. The text is oriented with respect to the edge connecting first two vertices.

Returns:

created PdfTextMarkupAnnotation of Underline type.

createStrikeout

             public static PdfTextMarkupAnnotation createStrikeout
             (Rectangle rect, float[] quadPoints)
            

Creates a text markup annotation of strikeout style subtype.

IMPORTANT NOTE on quadPoints argument: According to Table 179 in ISO 32000-1, the QuadPoints array lists the vertices in counterclockwise order and the text orientation is defined by the first and second vertex. This basically means QuadPoints is specified as lower-left, lower-right, top-right, top-left. HOWEVER, Adobe's interpretation (tested at least with Acrobat 10, Acrobat 11, Reader 11) is top-left, top-right, lower-left, lower-right (Z-shaped order). This means that if the QuadPoints array is specified according to the standard, the rendering is not as expected. Other viewers seem to follow Adobe's interpretation. Hence we recommend to use and expect QuadPoints array in Z-order, just as Acrobat and probably most other viewers expect.

Parameters:

rect - the annotation rectangle, defining the location of the annotation on the page in default user space units.

quadPoints - An array of 8 × n numbers specifying the coordinates of n quadrilaterals in default user space. Each quadrilateral shall encompasses a word or group of contiguous words in the text underlying the annotation. The text is oriented with respect to the edge connecting first two vertices.

Returns:

created PdfTextMarkupAnnotation of Strikeout type.

createSquiggly

             public static PdfTextMarkupAnnotation createSquiggly
             (Rectangle rect, float[] quadPoints)
            

Creates a text markup annotation of squiggly-underline type.

IMPORTANT NOTE on quadPoints argument: According to Table 179 in ISO 32000-1, the QuadPoints array lists the vertices in counterclockwise order and the text orientation is defined by the first and second vertex. This basically means QuadPoints is specified as lower-left, lower-right, top-right, top-left. HOWEVER, Adobe's interpretation (tested at least with Acrobat 10, Acrobat 11, Reader 11) is top-left, top-right, lower-left, lower-right (Z-shaped order). This means that if the QuadPoints array is specified according to the standard, the rendering is not as expected. Other viewers seem to follow Adobe's interpretation. Hence we recommend to use and expect QuadPoints array in Z-order, just as Acrobat and probably most other viewers expect.

Parameters:

rect - the annotation rectangle, defining the location of the annotation on the page in default user space units.

quadPoints - An array of 8 × n numbers specifying the coordinates of n quadrilaterals in default user space. Each quadrilateral shall encompasses a word or group of contiguous words in the text underlying the annotation. The text is oriented with respect to the edge connecting first two vertices.

Returns:

created PdfTextMarkupAnnotation of squiggly-underline type.

getSubtype

             public PdfName getSubtype()
            

Description copied from class: PdfAnnotation

Gets a PdfName which value is a subtype of this annotation. See ISO-320001 12.5.6, "Annotation Types" for the reference to the possible types.

Specified by:

getSubtype in class PdfAnnotation

Returns:

subtype of this annotation.

getQuadPoints

             public PdfArray getQuadPoints()
            

An array of 8 × n numbers specifying the coordinates of n quadrilaterals in default user space. Quadrilaterals are used to define a word or group of contiguous words in the text underlying the text markup annotation.

IMPORTANT NOTE: According to Table 179 in ISO 32000-1, the QuadPoints array lists the vertices in counterclockwise order and the text orientation is defined by the first and second vertex. This basically means QuadPoints is specified as lower-left, lower-right, top-right, top-left. HOWEVER, Adobe's interpretation (tested at least with Acrobat 10, Acrobat 11, Reader 11) is top-left, top-right, lower-left, lower-right (Z-shaped order). This means that if the QuadPoints array is specified according to the standard, the rendering is not as expected. Other viewers seem to follow Adobe's interpretation. Hence we recommend to use and expect QuadPoints array in Z-order, just as Acrobat and probably most other viewers expect.

Returns:

an PdfArray of 8 × n numbers specifying the coordinates of n quadrilaterals.

setQuadPoints

             public PdfTextMarkupAnnotation setQuadPoints
             (PdfArray quadPoints)
            

Sets n quadrilaterals in default user space by passing an PdfArray of 8 × n numbers. Quadrilaterals are used to define a word or group of contiguous words in the text underlying the text markup annotation.

IMPORTANT NOTE: According to Table 179 in ISO 32000-1, the QuadPoints array lists the vertices in counterclockwise order and the text orientation is defined by the first and second vertex. This basically means QuadPoints is specified as lower-left, lower-right, top-right, top-left. HOWEVER, Adobe's interpretation (tested at least with Acrobat 10, Acrobat 11, Reader 11) is top-left, top-right, lower-left, lower-right (Z-shaped order). This means that if the QuadPoints array is specified according to the standard, the rendering is not as expected. Other viewers seem to follow Adobe's interpretation. Hence we recommend to use and expect QuadPoints array in Z-order, just as Acrobat and probably most other viewers expect.

Parameters:

quadPoints - an PdfArray of 8 × n numbers specifying the coordinates of n quadrilaterals.

Returns:

this PdfTextMarkupAnnotation instance.