com.itextpdf.kernel.pdf.annot

Class PdfPolyGeomAnnotation

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

All Implemented Interfaces:

Serializable

public abstract class PdfPolyGeomAnnotation
extends PdfMarkupAnnotation

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static PdfName	Polygon Deprecated. , use PdfName.Polygon instead.
static PdfName	PolyLine Deprecated. , use PdfName.PolyLine instead.

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

Method Summary

Modifier and Type	Method and Description
static PdfPolyGeomAnnotation	createPolygon(Rectangle rect, float[] vertices)
static PdfPolyGeomAnnotation	createPolyLine(Rectangle rect, float[] vertices)
PdfDictionary	getBorderEffect() Gets a border effect dictionary that specifies an effect that shall be applied to the border of the annotations.
PdfDictionary	getBorderStyle() The dictionaries for some annotation types (such as free text and polygon annotations) can include the BS entry.
Color	getInteriorColor() The interior color which is used to fill the annotation's line endings.
PdfArray	getLineEndingStyles()
PdfDictionary	getMeasure()
PdfArray	getPath() PDF 2.0.
PdfArray	getVertices()
PdfPolyGeomAnnotation	setBorderEffect(PdfDictionary borderEffect) Sets a border effect dictionary that specifies an effect that shall be applied to the border of the annotations.
PdfPolyGeomAnnotation	setBorderStyle(PdfDictionary borderStyle) Sets border style dictionary that has more settings than the array specified for the Border entry (PdfAnnotation.getBorder()).
PdfPolyGeomAnnotation	setBorderStyle(PdfName style) Setter for the annotation's preset border style.
PdfPolyGeomAnnotation	setDashPattern(PdfArray dashPattern) Setter for the annotation's preset dashed border style.
PdfPolyGeomAnnotation	setInteriorColor(float[] interiorColor) An array of numbers in the range 0.0 to 1.0 specifying the interior color which is used to fill the annotation's line endings.
PdfPolyGeomAnnotation	setInteriorColor(PdfArray interiorColor) An array of numbers in the range 0.0 to 1.0 specifying the interior color which is used to fill the annotation's line endings.
PdfPolyGeomAnnotation	setLineEndingStyles(PdfArray lineEndingStyles)
PdfPolyGeomAnnotation	setMeasure(PdfDictionary measure)
PdfPolyGeomAnnotation	setPath(PdfArray path) PDF 2.0.
PdfPolyGeomAnnotation	setVertices(float[] vertices)
PdfPolyGeomAnnotation	setVertices(PdfArray vertices)

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

getCreationDate, getExternalData, getInReplyTo, getInReplyToObject, getIntent, getOpacity, getPopup, getPopupObject, getReplyType, getRichText, getSubject, getText, setCreationDate, setExternalData, 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, getSubtype, 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 Detail

Polygon

@Deprecated
public static final PdfName Polygon

Deprecated. , use PdfName.Polygon instead.

PolyLine

@Deprecated
public static final PdfName PolyLine

Deprecated. , use PdfName.PolyLine instead.

Constructor Detail

PdfPolyGeomAnnotation

protected PdfPolyGeomAnnotation(PdfDictionary pdfObject)

Instantiates a new PdfPolyGeomAnnotation 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 Detail

createPolygon

public static PdfPolyGeomAnnotation createPolygon(Rectangle rect,
                                                  float[] vertices)

createPolyLine

public static PdfPolyGeomAnnotation createPolyLine(Rectangle rect,
                                                   float[] vertices)

getVertices

public PdfArray getVertices()

setVertices

public PdfPolyGeomAnnotation setVertices(PdfArray vertices)

setVertices

public PdfPolyGeomAnnotation setVertices(float[] vertices)

getLineEndingStyles

public PdfArray getLineEndingStyles()

setLineEndingStyles

public PdfPolyGeomAnnotation setLineEndingStyles(PdfArray lineEndingStyles)

getMeasure

public PdfDictionary getMeasure()

setMeasure

public PdfPolyGeomAnnotation setMeasure(PdfDictionary measure)

getPath

public PdfArray getPath()

PDF 2.0. An array of n arrays, each supplying the operands for a path building operator (m, l or c). Each of the n arrays shall contain pairs of values specifying the points (x and y values) for a path drawing operation. The first array shall be of length 2 and specifies the operand of a moveto operator which establishes a current point. Subsequent arrays of length 2 specify the operands of lineto operators. Arrays of length 6 specify the operands for curveto operators. Each array is processed in sequence to construct the path.

Returns:

path, or null if path is not set

setPath

public PdfPolyGeomAnnotation setPath(PdfArray path)

PDF 2.0. An array of n arrays, each supplying the operands for a path building operator (m, l or c). Each of the n arrays shall contain pairs of values specifying the points (x and y values) for a path drawing operation. The first array shall be of length 2 and specifies the operand of a moveto operator which establishes a current point. Subsequent arrays of length 2 specify the operands of lineto operators. Arrays of length 6 specify the operands for curveto operators. Each array is processed in sequence to construct the path.

Parameters:

path - the path to set

Returns:

this PdfPolyGeomAnnotation instance

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.

Returns:

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

setBorderStyle

public PdfPolyGeomAnnotation 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.

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 PdfPolyGeomAnnotation instance.

setBorderStyle

public PdfPolyGeomAnnotation 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.

Parameters:

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

Returns:

this PdfPolyGeomAnnotation instance.

See Also:

getBorderStyle()

setDashPattern

public PdfPolyGeomAnnotation 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.

Parameters:

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

Returns:

this PdfPolyGeomAnnotation instance.

getBorderEffect

public PdfDictionary getBorderEffect()

Gets a border effect dictionary that specifies an effect that shall be applied to the border of the annotations.

Returns:

a PdfDictionary, which is a border effect dictionary (see ISO-320001, Table 167).

setBorderEffect

public PdfPolyGeomAnnotation setBorderEffect(PdfDictionary borderEffect)

Sets a border effect dictionary that specifies an effect that shall be applied to the border of the annotations.

Parameters:

borderEffect - a PdfDictionary which contents shall be specified in accordance to ISO-320001, Table 167.

Returns:

this PdfPolyGeomAnnotation instance.

getInteriorColor

public Color getInteriorColor()

The interior color which is used to fill the annotation's line endings.

Returns:

Color of either DeviceGray, DeviceRgb or DeviceCmyk type which defines interior color of the annotation, or null if interior color is not specified.

setInteriorColor

public PdfPolyGeomAnnotation setInteriorColor(PdfArray interiorColor)

An array of numbers in the range 0.0 to 1.0 specifying the interior color which is used to fill the annotation's line endings.

Parameters:

interiorColor - a PdfArray of numbers in the range 0.0 to 1.0. The number of array elements determines the colour space in which the colour is defined: 0 - No colour, transparent; 1 - DeviceGray, 3 - DeviceRGB, 4 - DeviceCMYK. For the PdfRedactAnnotation number of elements shall be equal to 3 (which defines DeviceRGB colour space).

Returns:

this PdfPolyGeomAnnotation instance.

setInteriorColor

public PdfPolyGeomAnnotation setInteriorColor(float[] interiorColor)

An array of numbers in the range 0.0 to 1.0 specifying the interior color which is used to fill the annotation's line endings.

Parameters:

interiorColor - an array of floats in the range 0.0 to 1.0.

Returns:

this PdfPolyGeomAnnotation instance.