Package com.itextpdf.kernel.pdf.annot

Class PdfCaretAnnotation

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

       public class PdfCaretAnnotation extends PdfMarkupAnnotation
      

Field Summary

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
	PdfCaretAnnotation(Rectangle rect)
protected	PdfCaretAnnotation(PdfDictionary pdfObject)	Instantiates a new PdfCaretAnnotation instance based on PdfDictionary instance, that represents existing annotation object in the document.

Method Summary

Modifier and Type	Method	Description
PdfArray	getRectangleDifferences()	A set of four numbers describing the numerical differences between two rectangles: the Rect entry of the annotation and the actual boundaries of the underlying caret.
PdfName	getSubtype()	Gets a PdfName which value is a subtype of this annotation.
PdfString	getSymbol()
PdfCaretAnnotation	setRectangleDifferences(PdfArray rect)	A set of four numbers describing the numerical differences between two rectangles: the Rect entry of the annotation and the actual boundaries of the underlying caret.
PdfCaretAnnotation	setSymbol(PdfString symbol)

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

Constructor Details

PdfCaretAnnotation

             public PdfCaretAnnotation
             (Rectangle rect)
            

PdfCaretAnnotation

             protected PdfCaretAnnotation
             (PdfDictionary pdfObject)
            

Instantiates a new PdfCaretAnnotation 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

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.

setSymbol

             public PdfCaretAnnotation setSymbol
             (PdfString symbol)
            

getSymbol

             public PdfString getSymbol()
            

getRectangleDifferences

             public PdfArray getRectangleDifferences()
            

A set of four numbers describing the numerical differences between two rectangles: the Rect entry of the annotation and the actual boundaries of the underlying caret.

Returns:

null if not specified, otherwise a PdfArray with four numbers which correspond to the differences in default user space between the left, top, right, and bottom coordinates of Rect and those of the inner rectangle, respectively.

setRectangleDifferences

             public PdfCaretAnnotation setRectangleDifferences
             (PdfArray rect)
            

A set of four numbers describing the numerical differences between two rectangles: the Rect entry of the annotation and the actual boundaries of the underlying caret.

Parameters:

rect - a PdfArray with four numbers which correspond to the differences in default user space between the left, top, right, and bottom coordinates of Rect and those of the inner rectangle, respectively. Each value shall be greater than or equal to 0. The sum of the top and bottom differences shall be less than the height of Rect, and the sum of the left and right differences shall be less than the width of Rect.

Returns:

this PdfCaretAnnotation instance.