pdftron.PDF.Annots

Class FreeText

java.lang.Object

pdftron.PDF.Annot

pdftron.PDF.Annots.Markup

pdftron.PDF.Annots.FreeText

public class FreeText
extends Markup

A free text annotation (PDF 1.3) displays text directly on the page. Unlike an ordinary text annotation, a free text annotation has no open or closed state; instead of being displayed in a pop-up window, the text shall be always visible.

Nested Class Summary

Nested classes/interfaces inherited from class pdftron.PDF.Annot

Annot.BorderStyle

Field Summary

Fields

Modifier and Type	Field and Description
static int	e_FreeText This integer list spedifies the intention of the FreeText annotation e_FreeText - The annotation ntended to function as a plain free-text annotation.
static int	e_FreeTextCallout The Constant e_FreeTextCallout.
static int	e_FreeTextTypeWriter The Constant e_FreeTextTypeWriter.
static int	e_Unknown The Constant e_Unknown.

Fields inherited from class pdftron.PDF.Annots.Markup

e_Cloudy, e_None

Fields inherited from class pdftron.PDF.Annot

e_3D, e_Caret, e_Circle, e_down, e_FileAttachment, e_hidden, e_Highlight, e_Ink, e_invisible, e_Line, e_Link, e_locked, e_locked_contents, e_Movie, e_no_rotate, e_no_view, e_no_zoom, e_normal, e_Polygon, e_Polyline, e_Popup, e_print, e_PrinterMark, e_Projection, e_read_only, e_Redact, e_RichMedia, e_rollover, e_Screen, e_Sound, e_Square, e_Squiggly, e_Stamp, e_StrikeOut, e_Text, e_toggle_no_view, e_TrapNet, e_Underline, e_Watermark, e_Widget

Constructor Summary

Constructors

Constructor and Description
FreeText() Creates an empty FreeText annotation.
FreeText(Annot annot) Creates an FreeText annotation and initialize it using given annotation object.
FreeText(Obj d) Creates an FreeText annotation and initialize it using given Cos/SDF object.

Method Summary

Methods

Modifier and Type	Method and Description
static FreeText	create(Doc doc, Rect pos) Creates a new FreeText annotation, in the specified document.
Point	getCalloutLinePoint1() Get p1 of the callout line points of the FreeText annotation.
Point	getCalloutLinePoint2() Get p2 of the callout line points of the FreeText annotation.
Point	getCalloutLinePoint3() Get p3 of the callout line points of the FreeText annotation.
java.lang.String	getDefaultAppearance() Get the default appearance of the FreeText annotation.
int	getEndingStyle() Get the ending style of the callout line of the FreeText Annotation.
double	getFontSize() Returns the font size of the FreeText Annotation.
int	getIntentName() Get the Intent name as an entry from the enum "IntentName" of the annnotation type.
ColorPt	getLineColor() Returns the line and border color of the FreeText Annotation.
int	getLineColorCompNum() Returns the number of color components in the line and border color of the FreeText Annotation.
int	getQuaddingFormat() Get the quading format of the FreeText annotation.
ColorPt	getTextColor() Returns the text color of the FreeText Annotation.
int	getTextColorCompNum() Returns the number of color components in the line and border color of the FreeText Annotation.
void	setCalloutLinePoints(Point p1, Point p2, Point p3) Set the callout line points of the FreeText annotation.
void	setDefaultAppearance(java.lang.String app_str) Set the default appearance of the FreeText annotation.
void	setFontSize(double font_size) Sets the font size of the FreeText Annotation.
void	setIntentName(int mode) Set the Intent name as an entry from the enum "IntentName" of the annnotation type.
void	setLineColor(ColorPt color, int col_comp) Set the line and border color of the FreeText Annotation.
void	setQuaddingFormat(int app_qform) Set the quading format of the FreeText annotation.
void	setTextColor(ColorPt color, int col_comp) Set the text color of the FreeText Annotation.

Methods inherited from class pdftron.PDF.Annots.Markup

getBorderEffect, getBorderEffectIntensity, getContentRect, getCreationDates, getInteriorColor, getInteriorColorCompNum, getOpacity, getPadding, getPopup, getSubject, getTitle, setBorderEffect, SetBorderEffectIntensity, setContentRect, setCreationDates, setInteriorColor, setOpacity, SetPadding, setPopup, setSubject, setTitle

Methods inherited from class pdftron.PDF.Annot

__Create, __GetHandle, __GetRefHandle, create, equals, flatten, getActiveAppearanceState, getAppearance, getAppearance, getAppearance, getBorderStyle, getColorAsCMYK, getColorAsGray, getColorAsRGB, getColorCompNum, getContents, getDate, getFlag, getOptionalContent, getPage, getRect, getSDFObj, GetStructParent, getType, getUniqueID, isMarkup, isValid, refreshAppearance, removeAppearance, resize, setActiveAppearanceState, setAppearance, setAppearance, setAppearance, setBorderStyle, setColor, setContents, setDate, setFlag, setOptionalContent, setPage, setRect, setStructParent, setUniqueID

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

e_FreeText

public static final int e_FreeText

This integer list spedifies the intention of the FreeText annotation e_FreeText - The annotation ntended to function as a plain free-text annotation. A plain free-text annotation is also known as a text box comment. e_FreeTextCallout - The annotation is intended to function as a callout. The callout is associated with an area on the page through the callout line specified in CL. e_FreeTextTypeWriter - The annotation is intended to function as a click-to-type or typewriter object and no callout line is drawn. e_Unknow - Undefined (Userdefined) intent type.

See Also:

Constant Field Values

e_FreeTextCallout

public static final int e_FreeTextCallout

The Constant e_FreeTextCallout.

See Also:

Constant Field Values

e_FreeTextTypeWriter

public static final int e_FreeTextTypeWriter

The Constant e_FreeTextTypeWriter.

See Also:

Constant Field Values

e_Unknown

public static final int e_Unknown

The Constant e_Unknown.

See Also:

Constant Field Values

Constructor Detail

FreeText

public FreeText(Obj d)

Creates an FreeText annotation and initialize it using given Cos/SDF object.

Parameters:

d - input Cos/SDF object

Note:

The constructor does not copy any data, but is instead the logical equivalent of a type cast.

FreeText

public FreeText()

Creates an empty FreeText annotation.

FreeText

public FreeText(Annot annot)
         throws PDFNetException

Creates an FreeText annotation and initialize it using given annotation object.

Parameters:

annot - input annotation object

Throws:

PDFNetException

Note:

The constructor does not copy any data, but is instead the logical equivalent of a type cast.

Method Detail

create

public static FreeText create(Doc doc,
              Rect pos)
                       throws PDFNetException

Creates a new FreeText annotation, in the specified document.

Parameters:

doc - A document to which the FreeText annotation is added.

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

Returns:

A newly created blank FreeText annotation.

Throws:

PDFNetException

getDefaultAppearance

public java.lang.String getDefaultAppearance()
                                      throws PDFNetException

Get the default appearance of the FreeText annotation.

Returns:

A string representing the default appearance of the FreeText annotation.

Throws:

PDFNetException

Note:

The default appearance string shall be used in formatting the text.The annotation dictionary’s Appearance (AP) entry, if present, shall take precedence over this entry.

setDefaultAppearance

public void setDefaultAppearance(java.lang.String app_str)
                          throws PDFNetException

Set the default appearance of the FreeText annotation.

Parameters:

app_str - A string representing the default appearance of the FreeText annotation.

Throws:

PDFNetException

Note:

The default appearance string shall be used in formatting the text.The annotation dictionary’s Appearance (AP) entry, if present, shall take precedence over this entry.

getQuaddingFormat

public int getQuaddingFormat()
                      throws PDFNetException

Get the quading format of the FreeText annotation.

Returns:

A int code indicating the quading format of the FreeText annotation.

Throws:

PDFNetException

Note:

The int code specifies the form of quadding (justification) that shall be used in displaying the annotation’s text: 0Left-justified 1Centered 2Right-justified Default value: 0 (left-justified).

setQuaddingFormat

public void setQuaddingFormat(int app_qform)
                       throws PDFNetException

Set the quading format of the FreeText annotation. (Optional; PDF 1.4)

Parameters:

app_qform - the new quadding format

Throws:

PDFNetException

Note:

The int code specifies the form of quadding (justification) that shall be used in displaying the annotation’s text: 0Left-justified 1Centered 2Right-justified Default value: 0 (left-justified).

getCalloutLinePoint1

public Point getCalloutLinePoint1()
                           throws PDFNetException

Get p1 of the callout line points of the FreeText annotation.

Returns:

Three point objects if the line is bent or two point objects if the line is straight.

Throws:

PDFNetException

Note:

The returning values are two or three Point objects specifying a callout line attached to the free text annotation. Three Point objects represent the starting, knee point, and ending coordinates of the line in default user space, two Point objects represent the starting and ending coordinates of the line., If the line is straight, i.e. only has two points, two valid points will be returned in p1 and p2, the p3 will be a point with negative x and y coordinate values.

getCalloutLinePoint2

public Point getCalloutLinePoint2()
                           throws PDFNetException

Get p2 of the callout line points of the FreeText annotation.

Returns:

Three point objects if the line is bent or two point objects if the line is straight.

Throws:

PDFNetException

Note:

The returning values are two or three Point objects specifying a callout line attached to the free text annotation. Three Point objects represent the starting, knee point, and ending coordinates of the line in default user space, two Point objects represent the starting and ending coordinates of the line., If the line is straight, i.e. only has two points, two valid points will be returned in p1 and p2, the p3 will be a point with negative x and y coordinate values.

getCalloutLinePoint3

public Point getCalloutLinePoint3()
                           throws PDFNetException

Get p3 of the callout line points of the FreeText annotation.

Returns:

Three point objects if the line is bent or two point objects if the line is straight.

Throws:

PDFNetException

Note:

The returning values are two or three Point objects specifying a callout line attached to the free text annotation. Three Point objects represent the starting, knee point, and ending coordinates of the line in default user space, two Point objects represent the starting and ending coordinates of the line., If the line is straight, i.e. only has two points, two valid points will be returned in p1 and p2, the p3 will be a point with negative x and y coordinate values.

setCalloutLinePoints

public void setCalloutLinePoints(Point p1,
                        Point p2,
                        Point p3)
                          throws PDFNetException

Set the callout line points of the FreeText annotation. (Optional; meaningful only if IT is FreeTextCallout; PDF 1.6)

Parameters:

p1 - The staring point.

p2 - The ending point.

p3 - The kee point.

Throws:

PDFNetException

Note:

The three Point objects specify a callout line attached to the free text annotation. The three Point objects represent the starting, knee point, and ending coordinates of the line in default user space.

getIntentName

public int getIntentName()
                  throws PDFNetException

Get the Intent name as an entry from the enum "IntentName" of the annnotation type.

Returns:

the intent name

Throws:

PDFNetException

Note:

The intent name describes the intent of the free text annotation. The following values shall be valid: e_FreeText - The annotation is intended to function as a plain free-text annotation. A plain free-text annotation is also known as a text box comment. e_FreeTextCallout - The annotation is intended to function as a callout. The callout is associated with an area on the page through the callout line specified in CL. e_FreeTextTypeWriter - The annotation is intended to function as a click-to-type or typewriter object and no callout line is drawn. Default value: e_FreeText

setIntentName

public void setIntentName(int mode)
                   throws PDFNetException

Set the Intent name as an entry from the enum "IntentName" of the annnotation type. (Optional; PDF 1.4)

Parameters:

mode - The intent name of the annotation as an entry from the enum "IntentJName".

Throws:

PDFNetException

Note:

The intent name describes the intent of the free text annotation. The following values shall be valid: e_FreeText - The annotation is intended to function as a plain free-text annotation. A plain free - text annotation is also known as a text box comment. e_FreeTextCallout - The annotation is intended to function as a callout. The callout is associated with an area on the page through the callout line specified in CL. e_FreeTextTypeWriter - The annotation is intended to function as a click-to-type or typewriter object and no callout line is drawn. Default value: e_FreeText

getEndingStyle

public int getEndingStyle()
                   throws PDFNetException

Get the ending style of the callout line of the FreeText Annotation.

Returns:

The ending style represented as one of the entries of the enum "EndingStyle"

Throws:

PDFNetException

Note:

The ending style specifies the line ending style that shall be used in drawing the callout line specified in CallOut Line Points (CL). The enum entry shall specify the line ending style for the endpoint defined by the starting point(p1) of the CallOut Line Points. Default value: e_None.

setTextColor

public void setTextColor(ColorPt color,
                int col_comp)
                  throws PDFNetException

Set the text color of the FreeText Annotation.

Parameters:

color - ColorPt object representing the color.

col_comp - number of colorant components in ColorPt object.

Throws:

PDFNetException

Note:

Current implementation of this method creates a non-standard entry in the annotation dictionary and uses it to generate the appearance stream. Make sure you call RefreshAppearance() after changing text or line color, and remember that editing the annotation in other PDF application will produce different appearance.

getTextColor

public ColorPt getTextColor()
                     throws PDFNetException

Returns the text color of the FreeText Annotation.

Returns:

the text color

Throws:

PDFNetException

Note:

Current implementation of this method uses a non-standard entry in the annotation dictionary and will not return meaningful results when called on annotations not created with PDFTron software.

getTextColorCompNum

public int getTextColorCompNum()
                        throws PDFNetException

Returns the number of color components in the line and border color of the FreeText Annotation.

Returns:

the text color comp num

Throws:

PDFNetException

setLineColor

public void setLineColor(ColorPt color,
                int col_comp)
                  throws PDFNetException

Set the line and border color of the FreeText Annotation.

Parameters:

color - ColorPt object representing the color.

col_comp - number of colorant components in ColorPt object.

Throws:

PDFNetException

Note:

Current implementation of this method creates a non-standard entry in the annotation dictionary and uses it to generate the appearance stream. Make sure you call RefreshAppearance() after changing text or line color, and remember that editing the annotation in other PDF application will produce different appearance.

getLineColor

public ColorPt getLineColor()
                     throws PDFNetException

Returns the line and border color of the FreeText Annotation.

Returns:

the line color

Throws:

PDFNetException

Note:

Current implementation of this method uses a non-standard entry in the annotation dictionary and will not return meaningful results when called on annotations not created with PDFTron software.

getLineColorCompNum

public int getLineColorCompNum()
                        throws PDFNetException

Returns the number of color components in the line and border color of the FreeText Annotation.

Returns:

the line color comp num

Throws:

PDFNetException

setFontSize

public void setFontSize(double font_size)
                 throws PDFNetException

Sets the font size of the FreeText Annotation.

Parameters:

font_size - font size

Throws:

PDFNetException

getFontSize

public double getFontSize()
                   throws PDFNetException

Returns the font size of the FreeText Annotation.

Returns:

the font size

Throws:

PDFNetException