com.itextpdf.kernel.pdf.annot

Class PdfInkAnnotation

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

All Implemented Interfaces:

Serializable

public class PdfInkAnnotation
extends PdfMarkupAnnotation

See Also:

Serialized Form

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

Constructor and Description
PdfInkAnnotation(PdfDictionary pdfObject) Deprecated. Use PdfAnnotation.makeAnnotation(PdfObject) instead. Will be made protected in 7.1
PdfInkAnnotation(Rectangle rect)
PdfInkAnnotation(Rectangle rect, PdfArray inkList)

Method Summary

Modifier and Type	Method and Description
PdfDictionary	getBorderStyle() The dictionaries for some annotation types (such as free text and polygon annotations) can include the BS entry.
PdfName	getSubtype() Gets a PdfName which value is a subtype of this annotation.
PdfInkAnnotation	setBorderStyle(PdfDictionary borderStyle) Sets border style dictionary that has more settings than the array specified for the Border entry (PdfAnnotation.getBorder()).
PdfInkAnnotation	setBorderStyle(PdfName style) Setter for the annotation's preset border style.
PdfInkAnnotation	setDashPattern(PdfArray dashPattern) Setter for the annotation's preset dashed border style.

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, getColorObject, getContents, getDate, getDownAppearanceObject, getFlags, getName, getNormalAppearanceObject, getOpen, getPage, getPageObject, getQuadPoints, getRectangle, getRolloverAppearanceObject, getStructParentIndex, getTitle, hasFlag, isWrappedObjectMustBeIndirect, makeAnnotation, makeAnnotation, put, remove, resetFlag, setAction, setAdditionalAction, setAppearance, setAppearance, setAppearanceCharacteristics, setAppearanceState, setBorder, setColor, setColor, setColor, setContents, setContents, setDate, setDownAppearance, setDownAppearance, setFlag, setFlags, setLayer, setName, setNormalAppearance, setNormalAppearance, setOpen, setPage, setQuadPoints, 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

Constructor Detail

PdfInkAnnotation

public PdfInkAnnotation(Rectangle rect)

PdfInkAnnotation

public PdfInkAnnotation(Rectangle rect,
                        PdfArray inkList)

PdfInkAnnotation

@Deprecated
public PdfInkAnnotation(PdfDictionary pdfObject)

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

Parameters:

pdfObject - object representing this annotation

Method Detail

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.

getBorderStyle

public PdfDictionary getBorderStyle()

The dictionaries for some annotation types (such as free text and polygon annotations) can include the BS entry. That entry specifies a border style dictionary that has more settings than the array specified for the Border entry (see PdfAnnotation.getBorder()). If an annotation dictionary includes the BS entry, then the Border entry is ignored. If annotation includes AP (see PdfAnnotation.getAppearanceDictionary()) it takes precedence over the BS entry. For more info on BS entry see ISO-320001, Table 166.

Overrides:

getBorderStyle in class PdfAnnotation

Returns:

PdfDictionary which is a border style dictionary or null if it is not specified.

setBorderStyle

public PdfInkAnnotation setBorderStyle(PdfDictionary borderStyle)

Sets border style dictionary that has more settings than the array specified for the Border entry (PdfAnnotation.getBorder()). See ISO-320001, Table 166 and getBorderStyle() for more info.

Overrides:

setBorderStyle in class PdfAnnotation

Parameters:

borderStyle - a border style dictionary specifying the line width and dash pattern that shall be used in drawing the annotation’s border.

Returns:

this PdfInkAnnotation instance.

setBorderStyle

public PdfInkAnnotation setBorderStyle(PdfName style)

Setter for the annotation's preset border style. Possible values are

• PdfAnnotation.STYLE_SOLID - A solid rectangle surrounding the annotation.
• PdfAnnotation.STYLE_DASHED - A dashed rectangle surrounding the annotation.
• PdfAnnotation.STYLE_BEVELED - A simulated embossed rectangle that appears to be raised above the surface of the page.
• PdfAnnotation.STYLE_INSET - A simulated engraved rectangle that appears to be recessed below the surface of the page.
• PdfAnnotation.STYLE_UNDERLINE - A single line along the bottom of the annotation rectangle.

See also ISO-320001, Table 166.

Overrides:

setBorderStyle in class PdfAnnotation

Parameters:

style - The new value for the annotation's border style.

Returns:

this PdfInkAnnotation instance.

See Also:

getBorderStyle()

setDashPattern

public PdfInkAnnotation setDashPattern(PdfArray dashPattern)

Setter for the annotation's preset dashed border style. This property has affect only if PdfAnnotation.STYLE_DASHED style was used for the annotation border style (see setBorderStyle(PdfName). See ISO-320001 8.4.3.6, “Line Dash Pattern” for the format in which dash pattern shall be specified.

Overrides:

setDashPattern in class PdfAnnotation

Parameters:

dashPattern - a dash array defining a pattern of dashes and gaps that shall be used in drawing a dashed border.

Returns:

this PdfInkAnnotation instance.