com.datalogics.PDFL

Class FreeTextAnnotation

java.lang.Object

com.datalogics.PDFL.Annotation

com.datalogics.PDFL.FreeTextAnnotation

public class FreeTextAnnotation
extends Annotation

The free text annotation allows a user to place text directly on a PDF page. An ordinary text annotation appears in a pop up window, and is attached to an icon; it represents a note added to a PDF file, and can be opened for viewing, or closed. But a free text annotation always appears open on the page. A free text annotation can be included anywhere in a PDF file by specifying the location and the CallOutLine points.

Constructor Summary

Constructors

Constructor and Description
FreeTextAnnotation(Page page, Rect initialRect, java.lang.String defaultAppearance) Create a new FreeTextAnnotation at the end of a page's annotation array.
FreeTextAnnotation(Page page, Rect initialRect, java.lang.String defaultAppearance, int addAfter) Create a new FreeTextAnnotation at a specific index in the page's annotation array.

Method Summary

Modifier and Type	Method and Description
void	delete()
Form	generateAppearance() Generate a new appearance stream with the current annotation properties.
double	getAnnotationFeatureLevel() The minimum PDF version necessary to support the features used in this annotation.
java.lang.String	getBorderStyle()
java.util.List<java.lang.Double>	getBorderStyleDashPattern()
double	getBorderStyleWidth()
Color	getColor() Deprecated.
java.lang.String	getDefaultAppearance() The default appearance string to be used in formatting the text.
java.lang.String	getFontFace() Get Font face for the text
double	getFontSize() Get font size for the text;
HorizontalAlignment	getQuadding() A code specifiying the form of quadding (justification) to be used in displaying the annotation's text.
Color	getTextColor() The text color which used for drawing text
void	setAnnotationFeatureLevel(double featureLevel) Removes features not supported in the supplied version number.
void	setBorderStyle(java.lang.String style)
void	setBorderStyleDashPattern(java.util.List<java.lang.Double> dashPattern)
void	setBorderStyleWidth(double width)
void	setColor(Color arg0) Deprecated.
void	setDefaultAppearance(java.lang.String arg0) The default appearance string to be used in formatting the text.
void	setFontFace(java.lang.String fontName) Set Font face for the text
void	setFontSize(double fontSize) Set font size for text
void	setQuadding(HorizontalAlignment quadding) A code specifiying the form of quadding (justification) to be used in displaying the annotation's text.
void	setTextColor(Color textColor)

Methods inherited from class com.datalogics.PDFL.Annotation

equals, getContents, getFlags, getInteriorColor, getNormalAppearance, getOpacity, getOptionalContentMembershipDict, getPDFDict, getRect, getSubtype, getTitle, hasRichTextData, isCurrentlyVisible, setContents, setFlags, setInteriorColor, setNormalAppearance, setOpacity, setOptionalContentMembershipDict, setRect, setTitle, toString

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FreeTextAnnotation

public FreeTextAnnotation(Page page,
                          Rect initialRect,
                          java.lang.String defaultAppearance)

Create a new FreeTextAnnotation at the end of a page's annotation array. To create a FreeTextAnnotation and place it elsewhere in the page's annotation array, use the version of the constructor that takes an array position.

Parameters:

page - The page to which the FreeTextAnnotation is added.

initialRect - A rectangle specifying the annotation's bounds, specified in user space coordinates.

defaultAppearance - The default appearance string to be used in formatting the text.

FreeTextAnnotation

public FreeTextAnnotation(Page page,
                          Rect initialRect,
                          java.lang.String defaultAppearance,
                          int addAfter)

Create a new FreeTextAnnotation at a specific index in the page's annotation array.

Parameters:

page - The page to which the annotation is added.

initialRect - A rectangle specifying the annotation's bounds, specified in user space coordinates.

defaultAppearance - The default appearance string to be used in formatting the text.

addAfter - Where to add the annotation in the page's annotation array. To add the annotation to the end of the array, pass a value of -2 or use the alternate version of this constructor that does not take an index (this is generally what you should do unless you have a need to place the annotation at a special location in the array). Passing a value of -1 adds the annotation to the beginning of the array. Passing other negative values produces undefined results.

Method Detail

delete

public void delete()

Overrides:

delete in class Annotation

getDefaultAppearance

public java.lang.String getDefaultAppearance()

The default appearance string to be used in formatting the text.

setDefaultAppearance

public void setDefaultAppearance(java.lang.String arg0)

The default appearance string to be used in formatting the text.

getQuadding

public HorizontalAlignment getQuadding()

A code specifiying the form of quadding (justification) to be used in displaying the annotation's text.

setQuadding

public void setQuadding(HorizontalAlignment quadding)

A code specifiying the form of quadding (justification) to be used in displaying the annotation's text.

getAnnotationFeatureLevel

public double getAnnotationFeatureLevel()

The minimum PDF version necessary to support the features used in this annotation.

Overrides:

getAnnotationFeatureLevel in class Annotation

setAnnotationFeatureLevel

public void setAnnotationFeatureLevel(double featureLevel)

Removes features not supported in the supplied version number.

Overrides:

setAnnotationFeatureLevel in class Annotation

generateAppearance

public Form generateAppearance()

Generate a new appearance stream with the current annotation properties.

The resulting Form can then be used to set the annotation's appearance, such as by calling SetNormalAppearance.

Overrides:

generateAppearance in class Annotation

setFontSize

public void setFontSize(double fontSize)

Set font size for text

getFontSize

public double getFontSize()

Get font size for the text;

Returns:

current font size

setFontFace

public void setFontFace(java.lang.String fontName)

Set Font face for the text

getFontFace

public java.lang.String getFontFace()

Get Font face for the text

Returns:

current Font face

getColor

@Deprecated
public Color getColor()

Deprecated.

(Deprecated, function will be removed, use GetInterriorColor instead) The color of the annotation. This method the same to the GetInterriorColor method.

Overrides:

getColor in class Annotation

setColor

@Deprecated
public void setColor(Color arg0)

Deprecated.

(Deprecated, function will be removed, use SetInterriorColor instead) The color of the annotation. This method the same to the SetInterriorColor method.

Overrides:

setColor in class Annotation

getTextColor

public Color getTextColor()

The text color which used for drawing text

Returns:

color Freetext Annotation's text

setTextColor

public void setTextColor(Color textColor)

• The text color which used for drawing text

getBorderStyleWidth

public double getBorderStyleWidth()

setBorderStyleWidth

public void setBorderStyleWidth(double width)

getBorderStyle

public java.lang.String getBorderStyle()

setBorderStyle

public void setBorderStyle(java.lang.String style)

getBorderStyleDashPattern

public java.util.List<java.lang.Double> getBorderStyleDashPattern()

setBorderStyleDashPattern

public void setBorderStyleDashPattern(java.util.List<java.lang.Double> dashPattern)