com.foxit.sdk.pdf.AnnotationSummarySettings类 参考

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

Public 成员函数
	AnnotationSummarySettings ()
	构造函数，带参数。
	AnnotationSummarySettings (AnnotationSummarySettings other)
	构造函数，使用另一个注释摘要设置对象。 更多...
synchronized void	delete ()
	直接清除C++相关资源。 更多...
void	enableOutputNoAnnotationPage (boolean enable) throws com.foxit.sdk.PDFException
	设置标志以决定是否输出没有注释的页面信息。 更多...
boolean	isEmpty ()
	检查当前对象是否为空。 更多...
void	setAnnotThumbnail (int type, Bitmap thumbnail) throws com.foxit.sdk.PDFException
	设置结果文档中用于指示注释类型的标记注释缩略图。 更多...
void	setAnnotType (int type, boolean use_all) throws com.foxit.sdk.PDFException
	设置决定哪种类型的注释将被摘要的选项。 更多...
void	setConnectorLineColor (long color) throws com.foxit.sdk.PDFException
	设置连接线颜色。 更多...
void	setConnectorLineOpacity (float opacity) throws com.foxit.sdk.PDFException
	设置连接线不透明度。 更多...
void	setEndPage (int page_index) throws com.foxit.sdk.PDFException
	设置结束页面索引。 更多...
void	setFileTitle (String title) throws com.foxit.sdk.PDFException
	设置当需要在结果文档中输出文档位置时的文件标题字符串。 更多...
void	setFontSize (int type) throws com.foxit.sdk.PDFException
	设置注释摘要结果文档中使用的字体大小类型。 更多...
void	setPageMargin (RectF margin) throws com.foxit.sdk.PDFException
	设置结果文档中使用的页面边距。 更多...
void	setPageRect (RectF rect) throws com.foxit.sdk.PDFException
	设置结果文档中的页面矩形。 更多...
void	setSortType (int type) throws com.foxit.sdk.PDFException
	设置决定按什么对注释进行排序的选项。 更多...
void	setStartPage (int page_index) throws com.foxit.sdk.PDFException
	设置起始页面索引。 更多...
void	setSummaryLayout (int type) throws com.foxit.sdk.PDFException
	设置摘要布局类型。 更多...
Public 成员函数 继承自 com.foxit.sdk.common.Base
synchronized void	delete ()
	直接清除C++相关资源。 更多...

静态 Public 属性
static final int	e_FontSizeLarge = 2
	如果设置，表示在结果文档中使用大字体。
static final int	e_FontSizeMedium = 1
	如果设置，表示在结果文档中使用中等字体。
static final int	e_FontSizeSmall = 0
	如果设置，表示在结果文档中使用小字体。
static final int	e_SummaryLayoutAnnotationOnly = 2
	如果设置，则表示仅布局注释。
static final int	e_SummaryLayoutSeparatePagesWithLine = 0
	如果设置，表示在结果文档中使用分页且带连接线的布局。注释内容会显示在注释原始位置的相对页面上。
static final int	e_SummaryLayoutSeparatePagesWithSequenceNumber = 3
	如果设置，这意味着在单独的页面上用序列号布局文档和注释。
static final int	e_SummaryLayoutSinglePageWithLine = 1
	如果设置，表示在结果文档中使用分页且不带连接线的布局。注释内容会显示在注释原始位置的相对页面上。
static final int	e_SummaryLayoutSinglePageWithSequenceNumber = 4
	如果设置，这意味着在单独的页面上用序列号布局文档和注释。
static final int	e_TypeSortByAnnotationType = 3
	如果设置，表示在结果文档中按注释类型对注释进行排序。
static final int	e_TypeSortByAuthor = 0
	如果设置，表示在结果文档中按作者对注释进行排序。
static final int	e_TypeSortByDate = 1
	如果设置，表示在结果文档中按日期对注释进行排序。
static final int	e_TypeSortByPage = 2
	如果设置，表示在结果文档中按页面对注释进行排序。

详细描述

此类表示注释摘要的设置。这将在类 AnnotationSummary 中使用。

参见

AnnotationSummary

构造及析构函数说明

AnnotationSummarySettings()

com.foxit.sdk.pdf.AnnotationSummarySettings.AnnotationSummarySettings

(

AnnotationSummarySettings

other

)

构造函数，使用另一个注释摘要设置对象。

参数

[in]

other

另一个注释摘要设置对象。

成员函数说明

delete()

synchronized void com.foxit.sdk.pdf.AnnotationSummarySettings.delete

(

)

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

返回

无。

注解

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

enableOutputNoAnnotationPage()

void com.foxit.sdk.pdf.AnnotationSummarySettings.enableOutputNoAnnotationPage

(

boolean

enable

)

throws com.foxit.sdk.PDFException

设置标志以决定是否输出没有注释的页面信息。

对于新构造的对象，如果不调用此函数，将使用默认值 true。

参数

[in]

enable

布尔值，用于决定是否输出没有注释的页面信息： true 表示输出没有注释的页面信息， 而 false 表示不输出没有注释的页面信息。

返回

无。

isEmpty()

boolean com.foxit.sdk.pdf.AnnotationSummarySettings.isEmpty

(

)

检查当前对象是否为空。

当当前对象为空时，表示当前对象无用。

返回

true 表示当前对象为空，而 false 表示不为空。

setAnnotThumbnail()

void com.foxit.sdk.pdf.AnnotationSummarySettings.setAnnotThumbnail	(	int	type,
		Bitmap	thumbnail
	)		throws com.foxit.sdk.PDFException

设置结果文档中用于指示注释类型的标记注释缩略图。

缩略图位图不使用 alpha 通道。因此建议用户设置不带 alpha 通道的位图作为新缩略图。 如果设置了带 alpha 通道的位图，新缩略图将默认使用白色背景。
如果未设置，相应注释类型将不使用缩略图。

参数

[in]	type	注释类型，用于决定要设置其缩略图的类型。请参考从 com.foxit.sdk.pdf.annots.Annot.e_Note 开始的值，这应该是这些值中的一个， 除了 com.foxit.sdk.pdf.annots.Annot.e_Link , com.foxit.sdk.pdf.annots.Annot.e_PSInk , com.foxit.sdk.pdf.annots.Annot.e_Sound , com.foxit.sdk.pdf.annots.Annot.e_Movie , com.foxit.sdk.pdf.annots.Annot.e_Widget , com.foxit.sdk.pdf.annots.Annot.e_Screen , com.foxit.sdk.pdf.annots.Annot.e_PrinterMark , com.foxit.sdk.pdf.annots.Annot.e_TrapNet , com.foxit.sdk.pdf.annots.Annot.e_Watermark , com.foxit.sdk.pdf.annots.Annot.e_3D , com.foxit.sdk.pdf.annots.Annot.e_Popup , com.foxit.sdk.pdf.annots.Annot.e_Redact 。
[in]	thumbnail	用作结果文档中注释类型缩略图的位图。 这应该是有效的位图。如果位图大小不是 12*12， 位图在使用时将被缩放到 12*12。

返回

无。

setAnnotType()

void com.foxit.sdk.pdf.AnnotationSummarySettings.setAnnotType	(	int	type,
		boolean	use_all
	)		throws com.foxit.sdk.PDFException

设置决定哪种类型的注释将被摘要的选项。

对于新构造的对象，如果不调用此函数来设置此选项， 表示摘要所有支持类型的注释。

参数

[in]	type	注释类型，用于决定哪些注释将被摘要。 请参考从 com.foxit.sdk.pdf.annots.Annot.e_Note 开始的值， 这应该是这些值中的一个，除了 com.foxit.sdk.pdf.annots.Annot.e_Link , com.foxit.sdk.pdf.annots.Annot.e_PSInk , com.foxit.sdk.pdf.annots.Annot.e_Sound , com.foxit.sdk.pdf.annots.Annot.e_Movie , com.foxit.sdk.pdf.annots.Annot.e_Widget , com.foxit.sdk.pdf.annots.Annot.e_Screen , com.foxit.sdk.pdf.annots.Annot.e_PrinterMark , com.foxit.sdk.pdf.annots.Annot.e_TrapNet , com.foxit.sdk.pdf.annots.Annot.e_Watermark , com.foxit.sdk.pdf.annots.Annot.e_3D , com.foxit.sdk.pdf.annots.Annot.e_Popup , com.foxit.sdk.pdf.annots.Annot.e_Redact 。
[in]	use_all	布尔值，用于决定是否在结果文档中摘要所有支持的注释： true 表示摘要所有支持类型的注释。 在这种情况下，参数 type 将被忽略。 false 表示仅摘要由参数 type 指定的注释。

返回

无。

setConnectorLineColor()

void com.foxit.sdk.pdf.AnnotationSummarySettings.setConnectorLineColor

(

long

color

)

throws com.foxit.sdk.PDFException

设置连接线颜色。

当摘要布局类型通过函数 AnnotationSummarySettings.setSummaryLayout 设置为 com.foxit.sdk.pdf.AnnotationSummarySettings.e_SummaryLayoutSeparatePagesWithLine 或 com.foxit.sdk.pdf.AnnotationSummarySettings.e_SummaryLayoutSinglePageWithLine 时， 此选项将生效。 如果未设置，将使用默认值 0x000000。

参数

[in]

color

连接线颜色。格式：0xRRGGBB。

返回

无。

setConnectorLineOpacity()

void com.foxit.sdk.pdf.AnnotationSummarySettings.setConnectorLineOpacity

(

float

opacity

)

throws com.foxit.sdk.PDFException

设置连接线不透明度。

当摘要布局类型通过函数 AnnotationSummarySettings.setSummaryLayout 设置为 com.foxit.sdk.pdf.AnnotationSummarySettings.e_SummaryLayoutSeparatePagesWithLine 或 com.foxit.sdk.pdf.AnnotationSummarySettings.e_SummaryLayoutSinglePageWithLine 时， 此选项将生效。 如果未设置，将使用默认值 1.0。

参数

[in]

opacity

连接线不透明度。有效范围：从 0.0 到 1.0。 0.0 表示完全透明，1.0 表示完全不透明。

返回

无。

setEndPage()

void com.foxit.sdk.pdf.AnnotationSummarySettings.setEndPage

(

int

page_index

)

throws com.foxit.sdk.PDFException

设置结束页面索引。

对于新构造的对象，如果不调用此函数，将使用默认值 (count-1) 作为结束页面索引。 count 是由函数 PDFDoc.getPageCount 为要摘要其注释的 PDF 文档返回的。

参数

[in]

page_index

页面索引，指定摘要操作结束的结束页面。 有效范围：从 0 到 (count-1)。count 是由函数 PDFDoc.getPageCount 为要摘要其注释的 PDF 文档返回的。 当调用函数 AnnotationSummary.startSummarize 时将检查此索引。

返回

无。

setFileTitle()

void com.foxit.sdk.pdf.AnnotationSummarySettings.setFileTitle

(

String

title

)

throws com.foxit.sdk.PDFException

设置当需要在结果文档中输出文档位置时的文件标题字符串。

如果未设置，将使用空字符串作为默认值。

参数

[in]

title

结果文档中使用的摘要标题。

返回

无。

setFontSize()

void com.foxit.sdk.pdf.AnnotationSummarySettings.setFontSize

(

int

type

)

throws com.foxit.sdk.PDFException

设置注释摘要结果文档中使用的字体大小类型。

对于新构造的对象，如果不调用此函数来设置此选项， 表示使用 com.foxit.sdk.pdf.AnnotationSummarySettings.e_FontSizeMedium 作为此选项的默认值。

参数

[in]

type

注释摘要结果文档中使用的字体大小类型。请参考从 com.foxit.sdk.pdf.AnnotationSummarySettings.e_FontSizeSmall 开始的值，这应该是这些值中的一个。

返回

无。

setPageMargin()

void com.foxit.sdk.pdf.AnnotationSummarySettings.setPageMargin

(

RectF

margin

)

throws com.foxit.sdk.PDFException

设置结果文档中使用的页面边距。

此值不表示矩形。它只是定义 PDF 页面的左边距、下边距、 右边距和上边距。 如果未设置边距值，Foxit PDF SDK 将使用定义为 (50.0, 50.0, 50.0, 50.0) 的边距作为默认值。

参数

[in]

margin

结果文档中使用的页面边距。

返回

无。

setPageRect()

void com.foxit.sdk.pdf.AnnotationSummarySettings.setPageRect

(

RectF

rect

)

throws com.foxit.sdk.PDFException

设置结果文档中的页面矩形。

如果未设置，将使用默认矩形 (0.0, 0.0, 612.0, 792.0)。

参数

[in]

rect

结果文档中使用的页面矩形。

返回

无。

setSortType()

void com.foxit.sdk.pdf.AnnotationSummarySettings.setSortType

(

int

type

)

throws com.foxit.sdk.PDFException

设置决定按什么对注释进行排序的选项。

对于新构造的对象，如果不调用此函数来设置此选项， 表示使用 com.foxit.sdk.pdf.AnnotationSummarySettings.e_TypeSortByAnnotationType 作为此选项的默认值。

参数

[in]

type

注释摘要的排序类型。请参考从 com.foxit.sdk.pdf.AnnotationSummarySettings.e_TypeSortByAuthor 开始的值，这应该是这些值中的一个。

返回

无。

setStartPage()

void com.foxit.sdk.pdf.AnnotationSummarySettings.setStartPage

(

int

page_index

)

throws com.foxit.sdk.PDFException

设置起始页面索引。

对于新构造的对象，如果不调用此函数，将使用默认值 0 作为起始页面索引。

参数

[in]

page_index

页面索引，指定摘要操作开始的起始页面。 有效范围：从 0 到 (count-1)。count 是由函数 PDFDoc.getPageCount 为要摘要其注释的 PDF 文档返回的。 当调用函数 AnnotationSummary.startSummarize 时将检查此索引。

返回

无。

setSummaryLayout()

void com.foxit.sdk.pdf.AnnotationSummarySettings.setSummaryLayout

(

int

type

)

throws com.foxit.sdk.PDFException

设置摘要布局类型。

对于新构造的对象，如果不调用此函数来设置此选项， 表示使用 com.foxit.sdk.pdf.AnnotationSummarySettings.e_SummaryLayoutSeparatePagesWithLine 作为此选项的默认值。

参数

[in]

type

摘要布局类型。请参考从 com.foxit.sdk.pdf.AnnotationSummarySettings.e_SummaryLayoutSeparatePagesWithLine 开始的值，这应该是这些值中的一个。

返回

无。