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

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

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

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

void	enableCaption (boolean cap) throws com.foxit.sdk.PDFException
	设置用于决定当前直线注释的内容是否应该在外观中复制为标题的标志。更多...

PointF	getCaptionOffset () throws com.foxit.sdk.PDFException
	获取标题偏移值。更多...

int	getCaptionPositionType () throws com.foxit.sdk.PDFException
	获取标题的位置类型。更多...

PointF	getEndPoint () throws com.foxit.sdk.PDFException
	获取终点。更多...

float	getLeaderLineExtensionLength () throws com.foxit.sdk.PDFException
	获取引导线延伸的长度。更多...

float	getLeaderLineLength () throws com.foxit.sdk.PDFException
	获取引导线的长度。更多...

float	getLeaderLineOffset () throws com.foxit.sdk.PDFException
	获取引导线偏移的长度。更多...

int	getLineEndStyle () throws com.foxit.sdk.PDFException
	获取终点的线条结束样式。更多...

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

float	getMeasureConversionFactor (int measure_type) throws com.foxit.sdk.PDFException
	获取用于测量的转换因子。更多...

String	getMeasureRatio () throws com.foxit.sdk.PDFException
	获取用于测量的比例比率字符串。更多...

String	getMeasureRatioW () throws com.foxit.sdk.PDFException
	获取用于测量的比例比率Unicode字符串。更多...

String	getMeasureUnit (int measure_type) throws com.foxit.sdk.PDFException
	获取用于测量的单位显示标签。更多...

String	getMeasureUnitW (int measure_type) throws com.foxit.sdk.PDFException
	获取用于测量的单位显示标签（Unicode字符串格式）。更多...

PointF	getStartPoint () throws com.foxit.sdk.PDFException
	获取起点。更多...

long	getStyleFillColor () throws com.foxit.sdk.PDFException
	Get fill color for ending styles. 更多...

boolean	hasCaption () throws com.foxit.sdk.PDFException
	检查当前直线注释的内容是否应该在外观中复制为标题。更多...

void	setCaptionOffset (PointF offset) throws com.foxit.sdk.PDFException
	设置标题偏移值。更多...

void	setCaptionPositionType (int cap_position) throws com.foxit.sdk.PDFException
	设置标题的位置类型。更多...

void	setEndPoint (PointF point) throws com.foxit.sdk.PDFException
	设置终点。更多...

void	setLeaderLineExtensionLength (float extension_length) throws com.foxit.sdk.PDFException
	设置引导线延伸的长度。更多...

void	setLeaderLineLength (float length) throws com.foxit.sdk.PDFException
	设置引导线的长度。更多...

void	setLeaderLineOffset (float offset) throws com.foxit.sdk.PDFException
	设置引导线偏移的长度。更多...

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

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

void	setMeasureConversionFactor (int measure_type, float factor) throws com.foxit.sdk.PDFException
	设置用于测量的转换因子。更多...

void	setMeasureRatio (String ratio) throws com.foxit.sdk.PDFException
	设置用于测量的比例比率字符串。更多...

void	setMeasureUnit (int measure_type, String unit) throws com.foxit.sdk.PDFException
	设置用于测量的单位显示标签。更多...

void	setStartPoint (PointF point) throws com.foxit.sdk.PDFException
	设置起点。更多...

void	setStyleFillColor (long color) throws com.foxit.sdk.PDFException
	设置结束样式的填充颜色。更多...

Public 成员函数继承自 com.foxit.sdk.pdf.annots.Markup
	Markup (Annot annot)
	构造函数，使用父类对象。更多...

	Markup ()
	构造函数

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
	添加新的状态注释。更多...

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

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 (PDFPage page, PDFDictionary annot_dict) throws com.foxit.sdk.PDFException
	构造函数，使用PDF页面和注释的PDF字典。更多...

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

	Annot ()
	构造函数。

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

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.common.Base
synchronized void	delete ()
	直接清除C++相关资源。更多...

额外继承的成员函数
静态 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>中的标准注释之一。更多...

详细描述

直线注释在页面上显示一条直线。
直线注释是一种标记注释，所以类Line 派生自类Markup ，并且还提供了获取/设置直线注释属性和重置直线注释外观流的函数。
对于直线注释，需要起点和终点。因此，在重置其外观流之前，请确保直线注释具有有效的起点和终点；否则直线注释无法重置外观流。

注解: 对于新创建的直线注释，如果用户在设置必需的起点和终点属性后直接调用函数 Annot.resetAppearanceStream 而不设置任何其他属性，将使用默认外观：
边框宽度 = 2.0，边框样式 = com.foxit.sdk.pdf.annots.BorderInfo.e_Solid ，边框颜色 = 0xFFFF0000（红色），不透明度 = 1，直线起始/结束样式 = "None"，未启用标题。

参见: Markup

构造及析构函数说明

◆ Line()

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

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

参数

[in] annot 父类对象。

成员函数说明

◆ delete()

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

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

返回: 无。

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

◆ enableCaption()

void com.foxit.sdk.pdf.annots.Line.enableCaption ( boolean cap ) throws com.foxit.sdk.PDFException

设置用于决定当前直线注释的内容是否应该在外观中复制为标题的标志。

此属性对直线注释的外观有影响。如果用户希望效果在注释外观中显示，请在此函数后调用函数Annot.resetAppearanceStream 。

参数

[in] cap true表示内容应该在当前直线注释的外观中复制为标题，而false表示不这样做。

返回: 无。

◆ getCaptionOffset()

PointF com.foxit.sdk.pdf.annots.Line.getCaptionOffset ( ) throws com.foxit.sdk.PDFException

获取标题偏移值。

标题偏移是标题从其正常位置的偏移。
只有当前直线注释有标题时，此属性才有意义并对直线注释的外观有影响。函数Line.hasCaption 可用于检查当前直线注释是否应该有标题，函数Line.enableCaption 可用于更改状态。

返回: 接收标题水平偏移和垂直偏移的Offset对象。
值为(0, 0)的Offset对象也可能意味着找不到标题偏移值。

◆ getCaptionPositionType()

int com.foxit.sdk.pdf.annots.Line.getCaptionPositionType ( ) throws com.foxit.sdk.PDFException

获取标题的位置类型。

只有当前直线注释有标题时，此属性才有意义并对直线注释的外观有影响。函数Line.hasCaption 可用于检查当前直线注释是否应该有标题，函数Line.enableCaption 可用于更改状态。

返回: 标题的位置类型。请参考从com.foxit.sdk.pdf.annots.Line.e_CapPosInline 开始的值，这将是这些值中的一个。

◆ getEndPoint()

PointF com.foxit.sdk.pdf.annots.Line.getEndPoint ( ) throws com.foxit.sdk.PDFException

获取终点。

直线注释需要起点和终点。它们对直线注释的外观有影响。

返回: 终点。值为(0, 0)的点也可能意味着找不到起点。

◆ getLeaderLineExtensionLength()

float com.foxit.sdk.pdf.annots.Line.getLeaderLineExtensionLength ( ) throws com.foxit.sdk.PDFException

获取引导线延伸的长度。

引导线延伸从直线本身沿与引导线相对180度的方向延伸。
有关更多详细信息，请参考<PDF参考1.7>第8.4.5节"注释类型"中的"直线注释"。

返回: 引导线延伸的长度。

◆ getLeaderLineLength()

float com.foxit.sdk.pdf.annots.Line.getLeaderLineLength ( ) throws com.foxit.sdk.PDFException

获取引导线的长度。

引导线从直线的每个端点垂直于直线本身延伸。正值表示引导线出现在从起点到终点遍历直线时顺时针方向；负值表示相反方向。特别地，即使引导线长度为0，直线注释仍然可以有引导线延伸和引导线偏移。在这种情况下，引导线的方向与正长度值相同，以便仍然可以判断引导线延伸和偏移的方向或位置。
有关更多详细信息，请参考<PDF参考1.7>第8.4.5节"注释类型"中的"直线注释"。

返回: 引导线的长度。

◆ getLeaderLineOffset()

float com.foxit.sdk.pdf.annots.Line.getLeaderLineOffset ( ) throws com.foxit.sdk.PDFException

获取引导线偏移的长度。

引导线偏移是直线注释端点与引导线开始之间的空白间距。
有关更多详细信息，请参考<PDF参考1.7>第8.4.5节"注释类型"中的"直线注释"。

返回: 引导线偏移的长度。

◆ getLineEndStyle()

int com.foxit.sdk.pdf.annots.Line.getLineEndStyle ( ) throws com.foxit.sdk.PDFException

获取终点的线条结束样式。

此属性对直线注释的外观有影响。

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

◆ getLineStartStyle()

int com.foxit.sdk.pdf.annots.Line.getLineStartStyle ( ) throws com.foxit.sdk.PDFException

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

此属性对直线注释的外观有影响。

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

◆ getMeasureConversionFactor()

float com.foxit.sdk.pdf.annots.Line.getMeasureConversionFactor ( int measure_type ) throws com.foxit.sdk.PDFException

获取用于测量的转换因子。

直线注释可能有一个测量字典，它为页面的一个区域指定备用坐标系。有关更多详细信息，请参考《PDF参考1.7》中的第745页。

参数

[in] measure_type 测量类型。请参考从com.foxit.sdk.pdf.annots.Markup.e_MeasureTypeX 开始的值，这应该是这些值中的一个。

返回: 转换因子。

◆ getMeasureRatio()

String com.foxit.sdk.pdf.annots.Line.getMeasureRatio ( ) throws com.foxit.sdk.PDFException

获取用于测量的比例比率字符串。

直线注释可能有一个测量字典，它为页面的一个区域指定备用坐标系。比例比率字符串表达该区域中绘图的比例比率。有关更多详细信息，请参考《PDF参考1.7》中的第745页。

返回: 表达比例比率的UTF-8字节字符串。

◆ getMeasureRatioW()

String com.foxit.sdk.pdf.annots.Line.getMeasureRatioW ( ) throws com.foxit.sdk.PDFException

获取用于测量的比例比率Unicode字符串。

直线注释可能有一个测量字典，它为页面的一个区域指定备用坐标系。比例比率字符串表达该区域中绘图的比例比率。有关更多详细信息，请参考《PDF参考1.7》中的第745页。

返回: 表达比例比率的Unicode字符串。

◆ getMeasureUnit()

String com.foxit.sdk.pdf.annots.Line.getMeasureUnit ( int measure_type ) throws com.foxit.sdk.PDFException

获取用于测量的单位显示标签。

直线注释可能有一个测量字典，它为页面的一个区域指定备用坐标系。有关更多详细信息，请参考《PDF参考1.7》中的第745页。

参数

[in] measure_type 测量类型。请参考从com.foxit.sdk.pdf.annots.Markup.e_MeasureTypeX 开始的值，这应该是这些值中的一个。

返回: 表示显示单位标签的UTF-8文本字符串。

◆ getMeasureUnitW()

String com.foxit.sdk.pdf.annots.Line.getMeasureUnitW ( int measure_type ) throws com.foxit.sdk.PDFException

获取用于测量的单位显示标签（Unicode字符串格式）。

直线注释可能有一个测量字典，它为页面的一个区域指定备用坐标系。有关更多详细信息，请参考《PDF参考1.7》中的第745页。

参数

[in] measure_type 测量类型。请参考从com.foxit.sdk.pdf.annots.Markup.e_MeasureTypeX 开始的值，这应该是这些值中的一个。

返回: 表示显示单位标签的Unicode字符串。

◆ getStartPoint()

PointF com.foxit.sdk.pdf.annots.Line.getStartPoint ( ) throws com.foxit.sdk.PDFException

获取起点。

直线注释需要起点和终点。它们对直线注释的外观有影响。

返回: 起点。值为(0, 0)的点也可能意味着找不到起点。

◆ getStyleFillColor()

long com.foxit.sdk.pdf.annots.Line.getStyleFillColor ( ) throws com.foxit.sdk.PDFException

Get fill color for ending styles.

This property has effect on line annotation's appearance. Fill color is used for some line ending styles:
"Square", "Circle", "Diamond", "ClosedArrow", "RClosedArrow".

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

◆ hasCaption()

boolean com.foxit.sdk.pdf.annots.Line.hasCaption ( ) throws com.foxit.sdk.PDFException

检查当前直线注释的内容是否应该在外观中复制为标题。

返回: true表示内容应该在当前直线注释的外观中复制为标题。 false表示不在当前直线注释的外观中复制内容为标题。

◆ setCaptionOffset()

void com.foxit.sdk.pdf.annots.Line.setCaptionOffset ( PointF offset ) throws com.foxit.sdk.PDFException

设置标题偏移值。

标题偏移是标题从其正常位置的偏移。
只有当前直线注释有标题时，此属性才有意义并对直线注释的外观有影响。函数Line.hasCaption 可用于检查当前直线注释是否应该有标题，函数Line.enableCaption 可用于更改状态。
如果用户希望效果在注释外观中显示，请在此函数后调用函数 Annot.resetAppearanceStream 。

参数

[in] offset 新的偏移值。

返回: 无。

◆ setCaptionPositionType()

void com.foxit.sdk.pdf.annots.Line.setCaptionPositionType ( int cap_position ) throws com.foxit.sdk.PDFException

设置标题的位置类型。

只有当前直线注释有标题时，此属性才有意义并对直线注释的外观有影响。函数Line.hasCaption 可用于检查当前直线注释是否应该有标题，函数Line.enableCaption 可用于更改状态。
如果用户希望效果在注释外观中显示，请在此函数后调用函数 Annot.resetAppearanceStream 。

参数

[in] cap_position 标题的位置类型。请参考从com.foxit.sdk.pdf.annots.Line.e_CapPosInline 开始的值，这应该是这些值中的一个。

返回: 无。

◆ setEndPoint()

void com.foxit.sdk.pdf.annots.Line.setEndPoint ( PointF point ) throws com.foxit.sdk.PDFException

设置终点。

直线注释需要起点和终点。它们对直线注释的外观有影响。
如果用户希望新的终点对注释外观产生效果，请在设置新终点后调用函数Annot.resetAppearanceStream 。

参数

[in] point 指定终点的新点。

返回: 无。

◆ setLeaderLineExtensionLength()

void com.foxit.sdk.pdf.annots.Line.setLeaderLineExtensionLength ( float extension_length ) throws com.foxit.sdk.PDFException

设置引导线延伸的长度。

引导线延伸从直线本身沿与引导线相对180度的方向延伸。
有关更多详细信息，请参考<PDF参考1.7>第8.4.5节"注释类型"中的"直线注释"。

参数

[in] extension_length 引导线延伸的长度。它应该是非负值。 0表示没有引导线延伸。

返回: 无。

◆ setLeaderLineLength()

void com.foxit.sdk.pdf.annots.Line.setLeaderLineLength ( float length ) throws com.foxit.sdk.PDFException

设置引导线的长度。

引导线从直线的每个端点垂直于直线本身延伸。正值表示引导线出现在从起点到终点遍历直线时顺时针方向；负值表示相反方向。特别地，即使引导线长度为0，直线注释仍然可以有引导线延伸和引导线偏移。在这种情况下，引导线的方向与正长度值相同，以便仍然可以判断引导线延伸和偏移的方向或位置。
有关更多详细信息，请参考<PDF参考1.7>第8.4.5节"注释类型"中的"直线注释"。

参数

[in] length 引导线的长度。有关更多详细信息，请参阅详细信息部分。 0表示没有引导线。

返回: 无。

◆ setLeaderLineOffset()

void com.foxit.sdk.pdf.annots.Line.setLeaderLineOffset ( float offset ) throws com.foxit.sdk.PDFException

设置引导线偏移的长度。

引导线偏移是直线注释端点与引导线开始之间的空白间距。
有关更多详细信息，请参考<PDF参考1.7>第8.4.5节"注释类型"中的"直线注释"。

参数

[in] offset 引导线偏移的长度。它应该是非负值。 0表示没有引导线延伸。

返回: None.

◆ setLineEndStyle()

void com.foxit.sdk.pdf.annots.Line.setLineEndStyle ( int ending_style ) throws com.foxit.sdk.PDFException

设置终点的线条结束样式。

此属性对直线注释的外观有影响。如果用户希望新的线条结束样式对注释外观产生效果，请在设置新线条结束样式后调用函数Annot.resetAppearanceStream 。

参数

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

返回: 无。

◆ setLineStartStyle()

void com.foxit.sdk.pdf.annots.Line.setLineStartStyle ( int ending_style ) throws com.foxit.sdk.PDFException

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

此属性对直线注释的外观有影响。如果用户希望新的线条结束样式对注释外观产生效果，请在设置新线条结束样式后调用函数Annot.resetAppearanceStream 。

参数

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

返回: 无。

◆ setMeasureConversionFactor()

void com.foxit.sdk.pdf.annots.Line.setMeasureConversionFactor	(	int	measure_type,
		float	factor
	)		throws com.foxit.sdk.PDFException

设置用于测量的转换因子。

直线注释可能有一个测量字典，它为页面的一个区域指定备用坐标系。有关更多详细信息，请参考《PDF参考1.7》中的第745页。

参数

[in]	measure_type	测量类型。请参考从com.foxit.sdk.pdf.annots.Markup.e_MeasureTypeX 开始的值，这应该是这些值中的一个。
[in]	factor	转换因子。

返回: 无。

◆ setMeasureRatio()

void com.foxit.sdk.pdf.annots.Line.setMeasureRatio ( String ratio ) throws com.foxit.sdk.PDFException

设置用于测量的比例比率字符串。

直线注释可能有一个测量字典，它为页面的一个区域指定备用坐标系。比例比率字符串表达该区域中绘图的比例比率。有关更多详细信息，请参考《PDF参考1.7》中的第745页。

参数

[in] ratio 表达比例比率的UTF-8字节字符串。该字符串应类似于："1/4 in = 1 ft"，表示默认用户空间中的1/4英寸等于实际测量中的1英尺。

返回: 无。

◆ setMeasureUnit()

void com.foxit.sdk.pdf.annots.Line.setMeasureUnit	(	int	measure_type,
		String	unit
	)		throws com.foxit.sdk.PDFException

设置用于测量的单位显示标签。

直线注释可能有一个测量字典，它为页面的一个区域指定备用坐标系。有关更多详细信息，请参考《PDF参考1.7》中的第745页。

参数

[in]	measure_type	测量类型。请参考从com.foxit.sdk.pdf.annots.Markup.e_MeasureTypeX 开始的值，这应该是这些值中的一个。
[in]	unit	指定显示单位标签的UTF-8文本字符串。

返回: 无。

◆ setStartPoint()

void com.foxit.sdk.pdf.annots.Line.setStartPoint ( PointF point ) throws com.foxit.sdk.PDFException

设置起点。

直线注释需要起点和终点。它们对直线注释的外观有影响。
如果用户希望新的起点对注释外观产生效果，请在设置新起点后调用函数Annot.resetAppearanceStream 。

参数

[in] point 指定起点的新点。

返回: 无。

◆ setStyleFillColor()

void com.foxit.sdk.pdf.annots.Line.setStyleFillColor ( long color ) throws com.foxit.sdk.PDFException

设置结束样式的填充颜色。

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

参数

[in] color 结束样式的新填充颜色。格式：0xRRGGBB。

返回: 无。

Public 成员函数

额外继承的成员函数

详细描述

构造及析构函数说明

◆ Line()

成员函数说明

◆ delete()

◆ enableCaption()

◆ getCaptionOffset()

◆ getCaptionPositionType()

◆ getEndPoint()

◆ getLeaderLineExtensionLength()

◆ getLeaderLineLength()

◆ getLeaderLineOffset()

◆ getLineEndStyle()

◆ getLineStartStyle()

◆ getMeasureConversionFactor()

◆ getMeasureRatio()

◆ getMeasureRatioW()

◆ getMeasureUnit()

◆ getMeasureUnitW()

◆ getStartPoint()

◆ getStyleFillColor()

◆ hasCaption()

◆ setCaptionOffset()

◆ setCaptionPositionType()

◆ setEndPoint()

◆ setLeaderLineExtensionLength()

◆ setLeaderLineLength()

◆ setLeaderLineOffset()

◆ setLineEndStyle()

◆ setLineStartStyle()

◆ setMeasureConversionFactor()

◆ setMeasureRatio()

◆ setMeasureUnit()

◆ setStartPoint()

◆ setStyleFillColor()