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

All Implemented Interfaces:

Serializable

public class PdfTextMarkupAnnotation
extends PdfMarkupAnnotation

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static PdfName	MarkupHighlight Subtypes
static PdfName	MarkupSquiggly
static PdfName	MarkupStrikeout
static 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

Constructor and Description
PdfTextMarkupAnnotation(PdfDictionary pdfObject) Deprecated. Use PdfAnnotation.makeAnnotation(PdfObject) instead. Will be made protected in 7.1
PdfTextMarkupAnnotation(Rectangle rect, PdfName subtype, float[] quadPoints)

Method Summary

Modifier and Type	Method and 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

getBorderEffect, getCreationDate, getDefaultAppearance, getExternalData, getIconName, getInReplyTo, getInReplyToObject, getIntent, getInteriorColor, getJustification, getOpacity, getPopup, getPopupObject, getRectangleDifferences, getReplyType, getRichText, getSubject, getText, setBorderEffect, setCreationDate, setDefaultAppearance, setExternalData, setIconName, setInReplyTo, setIntent, setInteriorColor, setInteriorColor, setJustification, setOpacity, setPopup, setRectangleDifferences, setReplyType, setRichText, setSubject, setText

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

flush, getAction, getAdditionalAction, getAppearanceCharacteristics, getAppearanceDictionary, getAppearanceObject, getAppearanceState, getBorder, getBorderStyle, getColorObject, getContents, getDate, getDownAppearanceObject, getFlags, getName, getNormalAppearanceObject, getOpen, getPage, getPageObject, getRectangle, getRolloverAppearanceObject, getStructParentIndex, getTitle, hasFlag, isWrappedObjectMustBeIndirect, makeAnnotation, makeAnnotation, put, remove, resetFlag, setAction, setAdditionalAction, setAppearance, setAppearance, setAppearanceCharacteristics, setAppearanceState, setBorder, setBorderStyle, setBorderStyle, setColor, setColor, setColor, setContents, setContents, setDashPattern, setDate, setDownAppearance, setDownAppearance, setFlag, setFlags, setLayer, setName, setNormalAppearance, setNormalAppearance, setOpen, setPage, setRectangle, setRolloverAppearance, setRolloverAppearance, 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 Detail

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 Detail

PdfTextMarkupAnnotation

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

PdfTextMarkupAnnotation

@Deprecated
public PdfTextMarkupAnnotation(PdfDictionary pdfObject)

Deprecated. Use PdfAnnotation.makeAnnotation(PdfObject) instead. Will be made protected in 7.1

Parameters:

pdfObject - object representing this annotation

Method Detail

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.

Overrides:

getQuadPoints in class PdfAnnotation

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.

Overrides:

setQuadPoints in class PdfAnnotation

Parameters:

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

Returns:

this PdfTextMarkupAnnotation instance.