com.itextpdf.kernel.pdf.annot

Class PdfFreeTextAnnotation

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

All Implemented Interfaces:

Serializable

public class PdfFreeTextAnnotation
extends PdfMarkupAnnotation

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	CENTERED
static int	LEFT_JUSTIFIED Text justification options.
static int	RIGHT_JUSTIFIED

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
PdfFreeTextAnnotation(PdfDictionary pdfObject) Deprecated. Use PdfAnnotation.makeAnnotation(PdfObject) instead. Will be made protected in 7.1
PdfFreeTextAnnotation(Rectangle rect, PdfString contents) Creates new instance
PdfFreeTextAnnotation(Rectangle rect, String appearanceString) Deprecated. unintuitive, will be removed in 7.1 use PdfFreeTextAnnotation(Rectangle, PdfString) instead

Method Summary

Modifier and Type	Method and Description
PdfDictionary	getBorderEffect() 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.
PdfArray	getCalloutLine()
PdfString	getDefaultAppearance() The default appearance string that shall be used in formatting the text.
PdfString	getDefaultStyleString()
int	getJustification() A code specifying the form of quadding (justification) that is used in displaying the annotation's text: 0 - Left-justified, 1 - Centered, 2 - Right-justified.
PdfName	getLineEndingStyle()
PdfArray	getRectangleDifferences() A set of four numbers describing the numerical differences between two rectangles: the Rect entry of the annotation and the inner rectangle where the annotation's text should be displayed
PdfName	getSubtype() Gets a PdfName which value is a subtype of this annotation.
PdfFreeTextAnnotation	setBorderEffect(PdfDictionary borderEffect) Sets a border effect dictionary that specifies an effect that shall be applied to the border of the annotations.
PdfFreeTextAnnotation	setBorderStyle(PdfDictionary borderStyle) Sets border style dictionary that has more settings than the array specified for the Border entry (PdfAnnotation.getBorder()).
PdfFreeTextAnnotation	setBorderStyle(PdfName style) Setter for the annotation's preset border style.
PdfFreeTextAnnotation	setCalloutLine(float[] calloutLine)
PdfFreeTextAnnotation	setCalloutLine(PdfArray calloutLine)
PdfFreeTextAnnotation	setDashPattern(PdfArray dashPattern) Setter for the annotation's preset dashed border style.
PdfFreeTextAnnotation	setDefaultAppearance(AnnotationDefaultAppearance da)
PdfFreeTextAnnotation	setDefaultAppearance(PdfString appearanceString) The default appearance string that shall be used in formatting the text.
PdfFreeTextAnnotation	setDefaultStyleString(PdfString defaultStyleString)
PdfFreeTextAnnotation	setJustification(int justification) A code specifying the form of quadding (justification) that is used in displaying the annotation's text: 0 - Left-justified, 1 - Centered, 2 - Right-justified.
PdfFreeTextAnnotation	setLineEndingStyle(PdfName lineEndingStyle)
PdfFreeTextAnnotation	setRectangleDifferences(PdfArray rect) A set of four numbers describing the numerical differences between two rectangles: the Rect entry of the annotation and the inner rectangle where the annotation's text should be displayed

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

getCreationDate, getExternalData, getIconName, getInReplyTo, getInReplyToObject, getIntent, getInteriorColor, getOpacity, getPopup, getPopupObject, getReplyType, getRichText, getSubject, getText, setCreationDate, setExternalData, setIconName, setInReplyTo, setIntent, setInteriorColor, setInteriorColor, setOpacity, setPopup, 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

Field Detail

LEFT_JUSTIFIED

public static final int LEFT_JUSTIFIED

Text justification options.

See Also:

Constant Field Values

CENTERED

public static final int CENTERED

See Also:

Constant Field Values

RIGHT_JUSTIFIED

public static final int RIGHT_JUSTIFIED

See Also:

Constant Field Values

Constructor Detail

PdfFreeTextAnnotation

public PdfFreeTextAnnotation(Rectangle rect,
                             PdfString contents)

Creates new instance

Parameters:

rect - - rectangle that specifies annotation position and bounds on page

contents - - the displayed text

PdfFreeTextAnnotation

@Deprecated
public PdfFreeTextAnnotation(Rectangle rect,
                                         String appearanceString)

Deprecated. unintuitive, will be removed in 7.1 use PdfFreeTextAnnotation(Rectangle, PdfString) instead

Creates new instance

Parameters:

rect - - bounding rectangle of annotation

appearanceString - - appearance string of annotation

PdfFreeTextAnnotation

@Deprecated
public PdfFreeTextAnnotation(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.

getDefaultStyleString

public PdfString getDefaultStyleString()

setDefaultStyleString

public PdfFreeTextAnnotation setDefaultStyleString(PdfString defaultStyleString)

getDefaultAppearance

public PdfString getDefaultAppearance()

The default appearance string that shall be used in formatting the text. See ISO-32001 12.7.3.3, “Variable Text”.

Overrides:

getDefaultAppearance in class PdfMarkupAnnotation

Returns:

a PdfString that specifies the default appearance, or null if default appereance is not specified.

setDefaultAppearance

public PdfFreeTextAnnotation setDefaultAppearance(PdfString appearanceString)

The default appearance string that shall be used in formatting the text. See ISO-32001 12.7.3.3, “Variable Text”.

Overrides:

setDefaultAppearance in class PdfMarkupAnnotation

Parameters:

appearanceString - a PdfString that specifies the default appearance.

Returns:

this PdfFreeTextAnnotation instance.

setDefaultAppearance

public PdfFreeTextAnnotation setDefaultAppearance(AnnotationDefaultAppearance da)

getCalloutLine

public PdfArray getCalloutLine()

setCalloutLine

public PdfFreeTextAnnotation setCalloutLine(float[] calloutLine)

setCalloutLine

public PdfFreeTextAnnotation setCalloutLine(PdfArray calloutLine)

getLineEndingStyle

public PdfName getLineEndingStyle()

setLineEndingStyle

public PdfFreeTextAnnotation setLineEndingStyle(PdfName lineEndingStyle)

getJustification

public int getJustification()

A code specifying the form of quadding (justification) that is used in displaying the annotation's text: 0 - Left-justified, 1 - Centered, 2 - Right-justified. Default value: 0 (left-justified).

Overrides:

getJustification in class PdfMarkupAnnotation

Returns:

a code specifying the form of quadding (justification), returns the default value if not explicitly specified.

setJustification

public PdfFreeTextAnnotation setJustification(int justification)

A code specifying the form of quadding (justification) that is used in displaying the annotation's text: 0 - Left-justified, 1 - Centered, 2 - Right-justified. Default value: 0 (left-justified).

Overrides:

setJustification in class PdfMarkupAnnotation

Parameters:

justification - a code specifying the form of quadding (justification).

Returns:

this PdfFreeTextAnnotation 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.

Overrides:

getBorderStyle in class PdfAnnotation

Returns:

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

setBorderStyle

public PdfFreeTextAnnotation 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 PdfFreeTextAnnotation instance.

setBorderStyle

public PdfFreeTextAnnotation 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 PdfFreeTextAnnotation instance.

See Also:

getBorderStyle()

setDashPattern

public PdfFreeTextAnnotation 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 PdfFreeTextAnnotation instance.

getRectangleDifferences

public PdfArray getRectangleDifferences()

A set of four numbers describing the numerical differences between two rectangles: the Rect entry of the annotation and the inner rectangle where the annotation's text should be displayed

Overrides:

getRectangleDifferences in class PdfMarkupAnnotation

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 PdfFreeTextAnnotation setRectangleDifferences(PdfArray rect)

A set of four numbers describing the numerical differences between two rectangles: the Rect entry of the annotation and the inner rectangle where the annotation's text should be displayed

Overrides:

setRectangleDifferences in class PdfMarkupAnnotation

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

getBorderEffect

public PdfDictionary getBorderEffect()

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

Overrides:

getBorderEffect in class PdfMarkupAnnotation

Returns:

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

setBorderEffect

public PdfFreeTextAnnotation setBorderEffect(PdfDictionary borderEffect)

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

Overrides:

setBorderEffect in class PdfMarkupAnnotation

Parameters:

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

Returns:

this PdfFreeTextAnnotation instance.