类 com.foxit.sdk.pdf.annots.FreeText 继承关系图:

Public 成员函数
	FreeText ()
	构造函数。

	FreeText (Annot annot)
	构造函数，使用父类对象。更多...

void	allowTextOverflow (boolean is_text_overflow) throws com.foxit.sdk.PDFException
	决定是否允许自由文本的文本溢出。更多...

synchronized void	delete ()
	直接清除C++相关资源。更多...

int	getAlignment () throws com.foxit.sdk.PDFException

int	getCalloutLineEndingStyle () throws com.foxit.sdk.PDFException
	获取标注线起点的线条结束样式。更多...

PointFArray	getCalloutLinePoints () throws com.foxit.sdk.PDFException
	获取标注线点。更多...

DefaultAppearance	getDefaultAppearance () throws com.foxit.sdk.PDFException
	获取默认外观数据。更多...

long	getFillColor () throws com.foxit.sdk.PDFException
	获取填充颜色。更多...

RectF	getInnerRect () throws com.foxit.sdk.PDFException
	获取内部矩形。更多...

int	getRotation () throws com.foxit.sdk.PDFException
	获取当前旋转值（顺时针）。更多...

Matrix2D	getTextMatrix () throws com.foxit.sdk.PDFException

void	rotate (int rotation) throws com.foxit.sdk.PDFException
	从当前状态按指定旋转值（顺时针）旋转当前注释。更多...

void	setAlignment (int alignment) throws com.foxit.sdk.PDFException

void	setCalloutLineEndingStyle (int ending_style) throws com.foxit.sdk.PDFException
	设置标注线起点的线条结束样式。更多...

void	setCalloutLinePoints (PointFArray point_array) throws com.foxit.sdk.PDFException
	设置标注线的点。更多...

boolean	setDefaultAppearance (DefaultAppearance default_ap) throws com.foxit.sdk.PDFException
	设置默认外观数据。更多...

void	setFillColor (long fill_color) throws com.foxit.sdk.PDFException
	设置填充颜色。更多...

void	setInnerRect (RectF inner_rect) throws com.foxit.sdk.PDFException
	设置内部矩形。更多...

void	setRotation (int rotation) throws com.foxit.sdk.PDFException
	设置旋转值（顺时针）。更多...

void	setTextMatrix (Matrix2D text_matrix) throws com.foxit.sdk.PDFException

Public 成员函数继承自 com.foxit.sdk.pdf.annots.Markup
	Markup ()
	构造函数

	Markup (Annot annot)
	构造函数，使用父类对象。更多...

Note	addReply () throws com.foxit.sdk.PDFException
	在回复列表的末尾添加新回复。更多...

void	addRichText (String content, RichTextStyle style) throws com.foxit.sdk.PDFException
	在末尾添加新的富文本字符串。更多...

Note	addStateAnnot (String title, int model, int state) throws com.foxit.sdk.PDFException
	添加新的状态注释。更多...

float	getBorderOpacity () throws com.foxit.sdk.PDFException
	获取注释的边框透明度。更多...

DateTime	getCreationDateTime () throws com.foxit.sdk.PDFException
	获取创建日期时间。更多...

float	getFillOpacity () throws com.foxit.sdk.PDFException
	获取注释的填充透明度。更多...

MarkupArray	getGroupElements () throws com.foxit.sdk.PDFException
	从当前标记注释所属的组中获取一个元素（作为标记注释）。更多...

Markup	getGroupHeader () throws com.foxit.sdk.PDFException
	获取当前标记注释所属组的头注释（作为主注释）。更多...

String	getIntent () throws com.foxit.sdk.PDFException
	获取意图名称。更多...

float	getOpacity () throws com.foxit.sdk.PDFException
	获取不透明度值。更多...

Popup	getPopup () throws com.foxit.sdk.PDFException
	获取相关的弹出注释。更多...

Note	getReply (int index) throws com.foxit.sdk.PDFException
	按索引获取回复。更多...

int	getReplyCount () throws com.foxit.sdk.PDFException
	计算所有回复。更多...

String	getRichTextContent (int index) throws com.foxit.sdk.PDFException
	获取指定索引的富文本字符串的文本字符串。更多...

int	getRichTextCount () throws com.foxit.sdk.PDFException
	获取富文本字符串的数量。更多...

RichTextStyle	getRichTextStyle (int index) throws com.foxit.sdk.PDFException
	获取指定索引的富文本字符串的样式数据。更多...

NoteArray	getStateAnnots (int model) throws com.foxit.sdk.PDFException
	获取指定状态模型中的所有状态注释。更多...

String	getSubject () throws com.foxit.sdk.PDFException
	获取主题字符串。更多...

String	getTitle () throws com.foxit.sdk.PDFException
	获取标题字符串。更多...

void	insertRichText (int index, String content, RichTextStyle style) throws com.foxit.sdk.PDFException
	在指定索引位置插入新的富文本字符串。更多...

boolean	isGrouped () throws com.foxit.sdk.PDFException
	检查当前标记注释是否在组中。更多...

boolean	removeAllReplies () throws com.foxit.sdk.PDFException
	删除所有回复。更多...

boolean	removeAllStateAnnots () throws com.foxit.sdk.PDFException
	移除所有状态注释。更多...

boolean	removePopup () throws com.foxit.sdk.PDFException
	删除相关的弹出注释。更多...

boolean	removeReply (int index) throws com.foxit.sdk.PDFException
	按索引删除回复。更多...

void	removeRichText (int index) throws com.foxit.sdk.PDFException
	移除指定索引的富文本字符串。更多...

void	setBorderOpacity (float opacity) throws com.foxit.sdk.PDFException
	设置注释的边框透明度。更多...

void	setCreationDateTime (DateTime date_time) throws com.foxit.sdk.PDFException
	设置创建日期时间。更多...

void	setFillOpacity (float opacity) throws com.foxit.sdk.PDFException
	设置注释的填充透明度。更多...

void	setIntent (String intent) throws com.foxit.sdk.PDFException
	设置意图名称。更多...

void	setOpacity (float opacity) throws com.foxit.sdk.PDFException
	设置不透明度值。更多...

void	setPopup (Popup popup) throws com.foxit.sdk.PDFException
	设置相关的弹出注释。更多...

void	setRichTextContent (int index, String content) throws com.foxit.sdk.PDFException
	设置指定索引的富文本字符串的文本字符串。更多...

void	setRichTextStyle (int index, RichTextStyle style) throws com.foxit.sdk.PDFException
	设置指定索引的富文本字符串的样式数据。更多...

void	setSubject (String subject) throws com.foxit.sdk.PDFException
	设置主题字符串。更多...

void	setTitle (String title) throws com.foxit.sdk.PDFException
	设置标题字符串。更多...

boolean	ungroup () throws com.foxit.sdk.PDFException
	将当前标记注释从其所属的组中解组。更多...

Public 成员函数继承自 com.foxit.sdk.pdf.annots.Annot
	Annot ()
	构造函数。

	Annot (Annot annot)
	构造函数，使用另一个注释对象。更多...

	Annot (PDFPage page, PDFDictionary annot_dict) throws com.foxit.sdk.PDFException
	构造函数，使用PDF页面和注释的PDF字典。更多...

PDFStream	getAppearanceStream (int type, String appearance_state) throws com.foxit.sdk.PDFException
	获取具有指定类型和状态的注释外观流。更多...

long	getBorderColor () throws com.foxit.sdk.PDFException
	获取边框颜色。更多...

BorderInfo	getBorderInfo () throws com.foxit.sdk.PDFException
	获取边框信息。更多...

String	getContent () throws com.foxit.sdk.PDFException
	获取内容。更多...

RectI	getDeviceRect (Matrix2D matrix) throws com.foxit.sdk.PDFException
	获取设备坐标系统中的注释矩形。更多...

PDFDictionary	getDict () throws com.foxit.sdk.PDFException
	获取注释的字典对象。更多...

Matrix2D	getDisplayMatrix (Matrix2D page_display_matrix) throws com.foxit.sdk.PDFException
	获取显示矩阵，从到目标设备坐标系统。更多...

int	getFlags () throws com.foxit.sdk.PDFException
	获取注释标志。更多...

int	getIndex () throws com.foxit.sdk.PDFException
	获取当前注释在其所属页面中的索引。更多...

DateTime	getModifiedDateTime () throws com.foxit.sdk.PDFException
	获取最后修改日期时间。更多...

PDFDictionary	getOptionalContent () throws com.foxit.sdk.PDFException
	获取注释可选内容的PDF字典。更多...

PDFPage	getPage () throws com.foxit.sdk.PDFException
	获取相关的PDF页面。更多...

RectF	getRect () throws com.foxit.sdk.PDFException
	获取矩形，以表示。更多...

int	getType () throws com.foxit.sdk.PDFException
	获取当前注释的实际注释类型。更多...

String	getUniqueID () throws com.foxit.sdk.PDFException
	获取唯一ID。更多...

boolean	hasProperty (int property) throws com.foxit.sdk.PDFException
	当前注释是否具有指定的注释属性。更多...

boolean	isEmpty ()
	检查当前对象是否为空。更多...

boolean	isMarkup () throws com.foxit.sdk.PDFException
	检查当前注释是否为标记注释。更多...

boolean	move (RectF rect) throws com.foxit.sdk.PDFException
	将当前注释移动到新位置，由中的新矩形指定。更多...

boolean	move (RectF rect, boolean is_reset_appearance) throws com.foxit.sdk.PDFException
	将当前注释移动到新位置，由中的新矩形指定。更多...

boolean	removeProperty (int property) throws com.foxit.sdk.PDFException
	删除指定的注释属性。更多...

boolean	resetAppearanceStream () throws com.foxit.sdk.PDFException
	重置外观流。更多...

boolean	resetAppearanceStream (boolean is_generate_new_appearance_obj) throws com.foxit.sdk.PDFException
	重置外观流。更多...

void	setBorderColor (long color) throws com.foxit.sdk.PDFException
	设置边框颜色。更多...

void	setBorderInfo (BorderInfo border) throws com.foxit.sdk.PDFException
	设置边框信息。更多...

void	setContent (String content) throws com.foxit.sdk.PDFException
	设置内容。更多...

void	setFlags (int flags) throws com.foxit.sdk.PDFException
	设置注释标志。更多...

void	setModifiedDateTime (DateTime date_time) throws com.foxit.sdk.PDFException
	设置最后修改日期时间。更多...

void	setUniqueID (String unique_id) throws com.foxit.sdk.PDFException
	设置唯一ID。更多...

额外继承的成员函数
静态 Public 属性继承自 com.foxit.sdk.pdf.annots.Markup
static final int	e_EndingStyleButt = 6
	端点处垂直于线条本身的短线。

static final int	e_EndingStyleCircle = 2
	用注释的内部颜色填充的圆形（如果有）。

static final int	e_EndingStyleClosedArrow = 5
	两条短线以锐角相交（如OpenArrow样式），并由第三条线连接，形成用注释的内部颜色填充的三角形闭合箭头（如果有）。

static final int	e_EndingStyleDiamond = 3
	用注释的内部颜色填充的菱形（如果有）。

static final int	e_EndingStyleNone = 0
	无特殊线条端点。

static final int	e_EndingStyleOpenArrow = 4
	两条短线以锐角相交形成开放箭头。

static final int	e_EndingStyleRClosedArrow = 8
	与ClosedArrow方向相反的三角形闭合箭头。

static final int	e_EndingStyleROpenArrow = 7
	与OpenArrow方向相反的两条短线。

static final int	e_EndingStyleSlash = 9
	端点处与线条垂直方向约顺时针30度的短线。

static final int	e_EndingStyleSquare = 1
	用注释的内部颜色填充的正方形（如果有）。

static final int	e_MeasureTypeA = 3
	面积的测量。

static final int	e_MeasureTypeD = 2
	任意方向距离的测量。

static final int	e_MeasureTypeS = 5
	直线斜率的测量。

static final int	e_MeasureTypeT = 4
	角度的测量。

static final int	e_MeasureTypeX = 0
	沿x轴变化的测量。

static final int	e_MeasureTypeY = 1
	沿y轴变化的测量。

static final int	e_StateAccepted = 3
	（与状态模型com.foxit.sdk.pdf.annots.Markup.e_StateModelReview 一起使用）用户同意更改。

static final int	e_StateCancelled = 5
	（与状态模型com.foxit.sdk.pdf.annots.Markup.e_StateModelReview 一起使用）更改已被取消。

static final int	e_StateCompleted = 6
	（与状态模型com.foxit.sdk.pdf.annots.Markup.e_StateModelReview 一起使用）更改已完成。

static final int	e_StateDeferred = 7
	（与状态模型com.foxit.sdk.pdf.annots.Markup.e_StateModelReview 一起使用）更改已延期。

static final int	e_StateFuture = 8
	（与状态模型com.foxit.sdk.pdf.annots.Markup.e_StateModelReview 一起使用）更改将在将来进行。

static final int	e_StateMarked = 1
	（与状态模型com.foxit.sdk.pdf.annots.Markup.e_StateModelMarked 一起使用）注释已被用户标记。

static final int	e_StateModelMarked = 1
	标记注释状态模型：已标记。

static final int	e_StateModelReview = 2
	标记注释状态模型：审阅。

static final int	e_StateNone = 0
	（与状态模型com.foxit.sdk.pdf.annots.Markup.e_StateModelReview 一起使用）用户没有对更改表示任何意见。

static final int	e_StateRejected = 4
	（与状态模型com.foxit.sdk.pdf.annots.Markup.e_StateModelReview 一起使用）用户不同意更改。

static final int	e_StateUnmarked = 2
	（与状态模型com.foxit.sdk.pdf.annots.Markup.e_StateModelMarked 一起使用）注释尚未被用户标记。

静态 Public 属性继承自 com.foxit.sdk.pdf.annots.Annot
static final int	e_3D = 25
	注释类型：3D注释。<PDF参考1.7>中的标准注释之一。

static final int	e_AppearanceTypeDown = 2
	注释的按下外观。

static final int	e_AppearanceTypeNormal = 0
	注释的正常外观。

static final int	e_AppearanceTypeRollover = 1
	注释的悬停外观。

static final int	e_Caret = 14
	注释类型：插入符注释。<PDF参考1.7>中的标准注释之一。

static final int	e_Circle = 6
	注释类型：圆形注释。<PDF参考1.7>中的标准注释之一。

static final int	e_FileAttachment = 17
	注释类型：文件附件注释。<PDF参考1.7>中的标准注释之一。

static final int	e_FlagHidden = 0x0002
	注释标志：隐藏。更多...

static final int	e_FlagInvisible = 0x0001
	注释标志：不可见。更多...

static final int	e_FlagLocked = 0x0080
	注释标志：锁定。更多...

static final int	e_FlagLockedContents = 0x0200
	注释标志：锁定内容。更多...

static final int	e_FlagNoRotate = 0x0010
	注释标志：无旋转。更多...

static final int	e_FlagNoView = 0x0020
	注释标志：无视图。更多...

static final int	e_FlagNoZoom = 0x0008
	注释标志：无缩放。更多...

static final int	e_FlagPrint = 0x0004
	注释标志：打印。更多...

static final int	e_FlagReadOnly = 0x0040
	注释标志：只读。更多...

static final int	e_FlagToggleNoView = 0x0100
	注释标志：切换无视图。更多...

static final int	e_FreeText = 3
	注释类型：自由文本注释。<PDF参考1.7>中的标准注释之一。

static final int	e_Highlight = 9
	注释类型：高亮注释。<PDF参考1.7>中的标准注释之一。

static final int	e_HighlightingInvert = 1
	高亮模式：反转，即反转注释矩形的内容。

static final int	e_HighlightingNone = 0
	高亮模式：无高亮。

static final int	e_HighlightingOutline = 2
	高亮模式：轮廓，即反转注释的边框。

static final int	e_HighlightingPush = 3
	高亮模式：按下，即显示注释的按下外观（如果有）。

static final int	e_HighlightingToggle = 4
	高亮模式：切换。这仅对小组件注释有用。

static final int	e_Ink = 15
	注释类型：墨迹注释。<PDF参考1.7>中的标准注释之一。

static final int	e_Line = 4
	注释类型：直线注释。<PDF参考1.7>中的标准注释之一。

static final int	e_Link = 2
	注释类型：链接注释。<PDF参考1.7>中的标准注释之一。

static final int	e_MKEntryBackgroundColor = 2
	背景颜色条目。MK字典中的"BG"。

static final int	e_MKEntryBorderColor = 1
	边框颜色条目。MK字典中的"BC"。

static final int	e_MKEntryDownCaption = 5
	按下标题（或备用标题）条目。MK字典中的"AC"。更多...

static final int	e_MKEntryDownIcon = 8
	按下图标（或备用图标）条目。MK字典中的"IX"。更多...

static final int	e_MKEntryIconCaptionRelation = 10
	图标和标题关系条目。MK字典中的"TP"。更多...

static final int	e_MKEntryIconFit = 9
	图标适配信息条目。MK字典中的"IF"。更多...

static final int	e_MKEntryNormalCaption = 3
	正常标题条目。MK字典中的"CA"。更多...

static final int	e_MKEntryNormalIcon = 6
	正常图标条目。MK字典中的"I"。更多...

static final int	e_MKEntryRolloverCaption = 4
	悬停标题条目。MK字典中的"RC"。更多...

static final int	e_MKEntryRolloverIcon = 7
	悬停图标条目。MK字典中的"RI"。更多...

static final int	e_MKEntryRotation = 0
	旋转条目。MK字典中的"R"。

static final int	e_MKRelationCaptionAboveIcon = 3
	标题在图标上方。

static final int	e_MKRelationCaptionBelowIcon = 2
	标题在图标下方。

static final int	e_MKRelationCaptionLeft = 5
	标题在图标左侧。

static final int	e_MKRelationCaptionOvrlayOnIcon = 6
	标题直接覆盖在图标上。

static final int	e_MKRelationCaptionRight = 4
	标题在图标右侧。

static final int	e_MKRelationNoCaption = 1
	无标题；仅图标。

static final int	e_MKRelationNoIcon = 0
	无图标；仅标题。

static final int	e_Movie = 19
	注释类型：电影注释。<PDF参考1.7>中的标准注释之一。

static final int	e_Note = 1
	注释类型：注记注释，即"文本"注释 - <PDF参考1.7>中的标准注释之一。

static final int	e_PagingSeal = 29
	注释类型：分页印章注释。福昕PDF SDK自定义注释类型（非标准注释类型）。

static final int	e_Polygon = 7
	注释类型：多边形注释。<PDF参考1.7>中的标准注释之一。

static final int	e_PolyLine = 8
	注释类型：折线注释。<PDF参考1.7>中的标准注释之一。

static final int	e_Popup = 26
	注释类型：弹出注释。<PDF参考1.7>中的标准注释之一。

static final int	e_PrinterMark = 22
	注释类型：印刷标记注释。<PDF参考1.7>中的标准注释之一。

static final int	e_PropertyBorderColor = 2
	注释属性：边框颜色。更多...

static final int	e_PropertyCreationDate = 1
	注释属性：创建日期。更多...

static final int	e_PropertyFillColor = 3
	注释属性：填充颜色更多...

static final int	e_PropertyModifiedDate = 0
	注释属性：修改日期。

static final int	e_PSInk = 16
	注释类型：压力敏感墨迹注释。

static final int	e_Redact = 27
	注释类型：编辑注释。

static final int	e_RichMedia = 28
	注释类型：富媒体注释。

static final int	e_Screen = 21
	注释类型：屏幕注释。<PDF参考1.7>中的标准注释之一。

static final int	e_Sound = 18
	注释类型：声音注释。<PDF参考1.7>中的标准注释之一。

static final int	e_Square = 5
	注释类型：矩形注释。<PDF参考1.7>中的标准注释之一。

static final int	e_Squiggly = 11
	注释类型：波浪线注释。<PDF参考1.7>中的标准注释之一。

static final int	e_Stamp = 13
	注释类型：印章注释。<PDF参考1.7>中的标准注释之一。

static final int	e_StrikeOut = 12
	注释类型：删除线注释。<PDF参考1.7>中的标准注释之一。

static final int	e_TrapNet = 23
	注释类型：陷阱网络注释。<PDF参考1.7>中的标准注释之一。

static final int	e_Underline = 10
	注释类型：下划线注释。<PDF参考1.7>中的标准注释之一。

static final int	e_UnknownType = 0
	注释类型：未知。

static final int	e_Watermark = 24
	注释类型：水印注释。<PDF参考1.7>中的标准注释之一。

static final int	e_Widget = 20
	注释类型：小组件注释。<PDF参考1.7>中的标准注释之一。更多...

详细描述

自由文本注释直接在页面上显示文本。因此自由文本注释不需要相关的弹出注释来显示文本。
自由文本注释是一种标记注释，所以类FreeText 派生自类Markup ，并且还提供了获取/设置自由文本注释属性和重置自由文本注释外观流的函数。

注解: 对于新创建的自由文本注释，如果用户直接调用函数Annot.resetAppearanceStream 而不设置任何属性，将使用默认外观：
边框宽度 = 1.0，边框样式 = com.foxit.sdk.pdf.annots.BorderInfo.e_Solid ，边框颜色 = 0xFFFF0000（红色），不透明度 = 1.0，对齐方式 = 0（左对齐），默认外观标志 = com.foxit.sdk.pdf.annots.DefaultAppearance.e_FlagFont | com.foxit.sdk.pdf.annots.DefaultAppearance.e_FlagTextColor | com.foxit.sdk.pdf.annots.DefaultAppearance.e_FlagFontSize ，默认外观字体基于com.foxit.sdk.common.Font.e_StdIDHelvetica 创建，默认外观文本大小 = 12，默认外观文本颜色 = 0xFF0000FF（蓝色）。

参见: Markup

构造及析构函数说明

◆ FreeText()

com.foxit.sdk.pdf.annots.FreeText.FreeText ( Annot annot )

构造函数，使用父类对象。

参数

[in] annot 父类对象。

成员函数说明

◆ allowTextOverflow()

void com.foxit.sdk.pdf.annots.FreeText.allowTextOverflow ( boolean is_text_overflow ) throws com.foxit.sdk.PDFException

决定是否允许自由文本的文本溢出。

对于标注对象和文本框对象，如果未调用此函数，默认情况下标注或文本框的文本允许溢出。对于打字机对象，如果未调用此函数，默认情况下打字机的文本不允许溢出。

参数

[in]

is_text_overflow

决定当自由文本矩形的大小小于文本内容大小时，是否允许文本内容溢出的布尔值：

true表示文本内容允许溢出。在这种情况下，溢出的文本内容将被截断。
false表示文本内容不允许溢出。在这种情况下，标注矩形将自动适应以包含整个文本内容。

返回: 无。

◆ delete()

synchronized void com.foxit.sdk.pdf.annots.FreeText.delete ( )

直接清除C++相关资源。

返回: 无。

注解: 一旦这个接口被调用，这个对象将不能再被使用。

重载 com.foxit.sdk.pdf.annots.Markup .

◆ getAlignment()

int com.foxit.sdk.pdf.annots.FreeText.getAlignment ( ) throws com.foxit.sdk.PDFException

弃用:: 当前函数自福昕PDF SDK 8.2起已被弃用。此属性将不再对自由文本注释的外观产生任何影响。要获取对齐属性，请调用函数Markup.getRichTextStyle 。有关RichText相关函数的更多详细信息，请参考Markup 。

此属性对自由文本注释的外观有影响。

返回: 对齐值。请参考从com.foxit.sdk.common.Constants.e_AlignmentLeft 开始的值，这将是这些值中的一个。

◆ getCalloutLineEndingStyle()

int com.foxit.sdk.pdf.annots.FreeText.getCalloutLineEndingStyle ( ) throws com.foxit.sdk.PDFException

获取标注线起点的线条结束样式。

只有当自由文本注释的意图名称为"FreeTextCallout"时，此自由文本注释才能具有线条结束样式属性，且此属性对这种自由文本注释的外观有影响。

返回: 起点的线条结束样式。请参考从com.foxit.sdk.pdf.annots.Markup.e_EndingStyleNone 开始的值，这将是这些值中的一个。

◆ getCalloutLinePoints()

PointFArray com.foxit.sdk.pdf.annots.FreeText.getCalloutLinePoints ( ) throws com.foxit.sdk.PDFException

获取标注线点。

只有当自由文本注释的意图名称为"FreeTextCallout"时，此自由文本注释才能具有标注线点属性，且此属性对这种自由文本注释的外观有影响。对于标注线，它可以包含2个或3个点：

2个点表示标注线的起点和终点。
3个点表示标注线的起点、拐点和终点。

返回: 表示标注自由文本注释的标注线所用点的点数组。

◆ getDefaultAppearance()

DefaultAppearance com.foxit.sdk.pdf.annots.FreeText.getDefaultAppearance ( ) throws com.foxit.sdk.PDFException

获取默认外观数据。

此属性对自由文本注释的外观有影响。默认外观数据可用于格式化文本。

返回: 默认外观数据。

◆ getFillColor()

long com.foxit.sdk.pdf.annots.FreeText.getFillColor ( ) throws com.foxit.sdk.PDFException

获取填充颜色。

此属性对自由文本注释的外观有影响。填充颜色用于填充文本框的背景，也用于某些标注线结束样式：
"Square"、"Circle"、"Diamond"、"ClosedArrow"、"RClosedArrow"。

返回: 填充颜色。格式：0xRRGGBB。如果找不到填充颜色，将返回0x000000。

◆ getInnerRect()

RectF com.foxit.sdk.pdf.annots.FreeText.getInnerRect ( ) throws com.foxit.sdk.PDFException

获取内部矩形。

此属性对自由文本注释的外观有影响。对于自由文本注释，内部矩形是应该显示注释文本的位置。内部矩形可能与注释矩形相同或小于注释矩形，但绝不应大于注释矩形。

返回: 内部矩形。

◆ getRotation()

int com.foxit.sdk.pdf.annots.FreeText.getRotation ( ) throws com.foxit.sdk.PDFException

获取当前旋转值（顺时针）。

返回: 当前旋转值（顺时针）。请参考从com.foxit.sdk.common.Constants.e_Rotation0 开始的值，这将是这些值中的一个。

◆ getTextMatrix()

Matrix2D com.foxit.sdk.pdf.annots.FreeText.getTextMatrix ( ) throws com.foxit.sdk.PDFException

弃用:: 当前函数自福昕PDF SDK 7.4起已被弃用。此属性将不再对注释外观产生任何影响。

此属性对自由文本注释的外观有影响。此属性可用于改变文本显示的倾斜度。

返回: 默认外观中用于文本的矩阵。

◆ rotate()

void com.foxit.sdk.pdf.annots.FreeText.rotate ( int rotation ) throws com.foxit.sdk.PDFException

从当前状态按指定旋转值（顺时针）旋转当前注释。

参数

[in] rotation 表示用于从当前状态顺时针旋转当前注释的度数的旋转值。请参考从com.foxit.sdk.common.Constants.e_Rotation0 开始的值，这应该是这些值中的一个，除了com.foxit.sdk.common.Constants.e_RotationUnknown 。特别地，如果输入值是com.foxit.sdk.common.Constants.e_Rotation0 （意味着不旋转当前注释），当前函数将不执行任何操作。

返回: true表示成功，而false表示失败。

◆ setAlignment()

void com.foxit.sdk.pdf.annots.FreeText.setAlignment ( int alignment ) throws com.foxit.sdk.PDFException

弃用:: 当前函数自福昕PDF SDK 8.2起已被弃用。此属性将不再对自由文本注释的外观产生任何影响。要设置对齐属性，请调用函数Markup.setRichTextStyle 。有关RichText相关函数的更多详细信息，请参考Markup 。

此属性对自由文本注释的外观有影响。如果用户希望新的对齐方式对注释外观产生效果，请在设置新对齐方式后调用函数Annot.resetAppearanceStream 。

参数

[in] alignment 新的对齐值。请参考从com.foxit.sdk.common.Constants.e_AlignmentLeft 开始的值，这应该是这些值中的一个。
如果使用其他值进行设置，默认将使用com.foxit.sdk.common.Constants.e_AlignmentLeft 。

返回: 无。

◆ setCalloutLineEndingStyle()

void com.foxit.sdk.pdf.annots.FreeText.setCalloutLineEndingStyle ( int ending_style ) throws com.foxit.sdk.PDFException

设置标注线起点的线条结束样式。

只有当自由文本注释的意图名称为"FreeTextCallout"时，此自由文本注释才能具有线条结束样式属性，且此属性对这种自由文本注释的外观有影响。
如果用户希望新的线条结束样式对注释外观产生效果，请在设置新线条结束样式后调用函数Annot.resetAppearanceStream 。

参数

[in] ending_style 要设置的起点线条结束样式。请参考从 com.foxit.sdk.pdf.annots.Markup.e_EndingStyleNone 开始的值，这应该是这些值中的一个。

返回: 无。

◆ setCalloutLinePoints()

void com.foxit.sdk.pdf.annots.FreeText.setCalloutLinePoints ( PointFArray point_array ) throws com.foxit.sdk.PDFException

设置标注线的点。

只有当自由文本注释的意图名称为"FreeTextCallout"时，此自由文本注释才能具有标注线点属性，且此属性对这种自由文本注释的外观有影响。对于标注线，它可以包含2个或3个点：

2个点表示标注线的起点和终点。
3个点表示标注线的起点、拐点和终点。

如果用户希望新的标注线点对注释外观产生效果，请在设置新标注线点后调用函数Annot.resetAppearanceStream 。

参数

[in] point_array 指定标注线起点、拐点（如果有）和终点的新点数组。元素数量应为2或3： 2个点表示起点和终点；3个点表示起点、拐点和终点。
如果元素数量超过3，只有前3个点将被用于设置标注线。

返回: 无。

◆ setDefaultAppearance()

boolean com.foxit.sdk.pdf.annots.FreeText.setDefaultAppearance ( DefaultAppearance default_ap ) throws com.foxit.sdk.PDFException

设置默认外观数据。

此属性对自由文本注释的外观有影响。默认外观数据可用于格式化文本。
如果用户希望新的默认外观数据对注释外观产生效果，请在设置新默认外观数据后调用函数Annot.resetAppearanceStream 。

参数

[in] default_ap 要设置的新默认外观数据。输入数据的flags可用于决定哪些信息将用新数据更新；对于那些不更新的数据，它们将继续使用旧数据。

返回

true表示成功，而false表示失败。特别地，如果参数default_ap包含任何不正确的值，此函数将返回false，例如：

输入数据的flags包含com.foxit.sdk.pdf.annots.DefaultAppearance.e_FlagFont 但输入数据的font无效。
输入数据的flags包含com.foxit.sdk.pdf.annots.DefaultAppearance.e_FlagFontSize 但输入数据的text size不大于零。

◆ setFillColor()

void com.foxit.sdk.pdf.annots.FreeText.setFillColor ( long fill_color ) throws com.foxit.sdk.PDFException

设置填充颜色。

此属性对自由文本注释的外观有影响。填充颜色用于填充文本框的背景，也用于某些标注线结束样式：
"Square"、"Circle"、"Diamond"、"ClosedArrow"、"RClosedArrow"。
如果用户希望新的填充颜色对注释外观产生效果，请在设置新填充颜色后调用函数Annot.resetAppearanceStream 。

参数

[in] fill_color 要设置的新填充颜色。格式：0xRRGGBB。

返回: 无。

◆ setInnerRect()

void com.foxit.sdk.pdf.annots.FreeText.setInnerRect ( RectF inner_rect ) throws com.foxit.sdk.PDFException

设置内部矩形。

此属性对自由文本注释的外观有影响。对于自由文本注释，内部矩形是应该显示注释文本的位置。内部矩形可能与注释矩形相同或小于注释矩形，但绝不应大于注释矩形。
如果用户希望新的内部矩形对注释外观产生效果，请在设置新内部矩形后调用函数Annot.resetAppearanceStream 。

参数

[in] inner_rect 要设置的新内部矩形。它应该与注释矩形相同或小于注释矩形。

返回: 无。

◆ setRotation()

void com.foxit.sdk.pdf.annots.FreeText.setRotation ( int rotation ) throws com.foxit.sdk.PDFException

设置旋转值（顺时针）。

此属性对自由文本注释的外观有影响。如果用户希望新的旋转对注释外观产生效果，请在设置新旋转后调用函数 Annot.resetAppearanceStream 。

参数

[in] rotation 要设置给当前自由文本注释的新旋转值（顺时针）。请参考从com.foxit.sdk.common.Constants.e_Rotation0 开始的值，这应该是这些值中的一个，除了com.foxit.sdk.common.Constants.e_RotationUnknown 。

返回: 无。

◆ setTextMatrix()

void com.foxit.sdk.pdf.annots.FreeText.setTextMatrix ( Matrix2D text_matrix ) throws com.foxit.sdk.PDFException

弃用:: 当前函数自福昕PDF SDK 7.4起已被弃用。此属性将不再对注释外观产生任何影响。

此属性对自由文本注释的外观有影响。此属性可用于改变文本显示的倾斜度。
如果用户希望新的文本矩阵对注释外观产生效果，请在设置新文本矩阵后调用函数Annot.resetAppearanceStream 。

参数

[in] text_matrix 新的文本矩阵。

返回: 无。

Public 成员函数

额外继承的成员函数

详细描述

构造及析构函数说明

◆ FreeText()

成员函数说明

◆ allowTextOverflow()

◆ delete()

◆ getAlignment()

◆ getCalloutLineEndingStyle()

◆ getCalloutLinePoints()

◆ getDefaultAppearance()

◆ getFillColor()

◆ getInnerRect()

◆ getRotation()

◆ getTextMatrix()

◆ rotate()

◆ setAlignment()

◆ setCalloutLineEndingStyle()

◆ setCalloutLinePoints()

◆ setDefaultAppearance()

◆ setFillColor()

◆ setInnerRect()

◆ setRotation()

◆ setTextMatrix()