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

Public 成员函数
	TableOfContentsConfig (String title, Int32Array bookmark_level_array, boolean is_show_serial_number, boolean include_toc_pages)
	带参数的构造函数。 更多...
	TableOfContentsConfig ()
	构造函数。
synchronized void	delete ()
	直接清除C++相关资源。 更多...
Int32Array	getBookmark_level_array ()
	Get 书签级别数组，用于指定用于生成"目录"的书签。 对于输入数组中的每个元素，有效范围：从1到(depth)。 depth 由函数 PDFDoc.getBookmarkLevelDepth 返回。 如果输入数组是空数组，则意味着所有书签都用于生成"目录"。 更多...
boolean	getInclude_toc_pages ()
	Get true 表示在目录的页码计算中包含目录页面， false 表示在目录的页码计算中排除目录页面。 更多...
boolean	getIs_show_serial_number ()
	Get true 表示在目录中显示序列号，false 表示不显示序列号。 更多...
String	getTitle ()
	Get 目录的标题。如果这是空字符串，将使用默认值"Table of Contents"。 更多...
void	set (String title, Int32Array bookmark_level_array, boolean is_show_serial_number, boolean include_toc_pages)
	设置值。 更多...
void	setBookmark_level_array (Int32Array value)
	Set 书签级别数组，用于指定用于生成"目录"的书签。 对于输入数组中的每个元素，有效范围：从1到(depth)。 depth 由函数 PDFDoc.getBookmarkLevelDepth 返回。 如果输入数组是空数组，则意味着所有书签都用于生成"目录"。 更多...
void	setInclude_toc_pages (boolean value)
	Set true 表示在目录的页码计算中包含目录页面， false 表示在目录的页码计算中排除目录页面。 更多...
void	setIs_show_serial_number (boolean value)
	Set true 表示在目录中显示序列号，false 表示不显示序列号。 更多...
void	setTitle (String value)
	Set 目录的标题。如果这是空字符串，将使用默认值"Table of Contents"。 更多...

详细描述

此类表示目录配置。

构造及析构函数说明

TableOfContentsConfig()

com.foxit.sdk.pdf.TableOfContentsConfig.TableOfContentsConfig	(	String	title,
		Int32Array	bookmark_level_array,
		boolean	is_show_serial_number,
		boolean	include_toc_pages
	)

带参数的构造函数。

参数

[in]	title	目录的标题。
[in]	bookmark_level_array	书签级别数组，用于指定用于生成"目录"的书签。
[in]	is_show_serial_number	true 表示在目录中显示序列号，false 表示不显示序列号。
[in]	include_toc_pages	true 表示在目录的页码计算中包含目录页面， false 表示在目录的页码计算中排除目录页面。

成员函数说明

delete()

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

(

)

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

返回

无。

注解

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

getBookmark_level_array()

com.foxit.sdk.pdf.TableOfContentsConfig.getBookmark_level_array

(

)

Get 书签级别数组，用于指定用于生成"目录"的书签。 对于输入数组中的每个元素，有效范围：从1到(depth)。 depth 由函数 PDFDoc.getBookmarkLevelDepth 返回。 如果输入数组是空数组，则意味着所有书签都用于生成"目录"。

返回

书签级别数组，用于指定用于生成"目录"的书签。 对于输入数组中的每个元素，有效范围：从1到(depth)。 depth 由函数 PDFDoc.getBookmarkLevelDepth 返回。 如果输入数组是空数组，则意味着所有书签都用于生成"目录"。

getInclude_toc_pages()

com.foxit.sdk.pdf.TableOfContentsConfig.getInclude_toc_pages

(

)

Get true 表示在目录的页码计算中包含目录页面， false 表示在目录的页码计算中排除目录页面。

返回

true 表示在目录的页码计算中包含目录页面， false 表示在目录的页码计算中排除目录页面。

getIs_show_serial_number()

com.foxit.sdk.pdf.TableOfContentsConfig.getIs_show_serial_number

(

)

Get true 表示在目录中显示序列号，false 表示不显示序列号。

返回

true 表示在目录中显示序列号，false 表示不显示序列号。

getTitle()

com.foxit.sdk.pdf.TableOfContentsConfig.getTitle

(

)

Get 目录的标题。如果这是空字符串，将使用默认值"Table of Contents"。

返回

目录的标题。如果这是空字符串，将使用默认值"Table of Contents"。

set()

void com.foxit.sdk.pdf.TableOfContentsConfig.set	(	String	title,
		Int32Array	bookmark_level_array,
		boolean	is_show_serial_number,
		boolean	include_toc_pages
	)

设置值。

参数

[in]	title	目录的标题。
[in]	bookmark_level_array	书签级别数组，用于指定用于生成"目录"的书签。
[in]	is_show_serial_number	true 表示在目录中显示序列号，false 表示不显示序列号。
[in]	include_toc_pages	true 表示在目录的页码计算中包含目录页面， false 表示在目录的页码计算中排除目录页面。

@ return 无。

setBookmark_level_array()

com.foxit.sdk.pdf.TableOfContentsConfig.setBookmark_level_array

(

Int32Array

value

)

Set 书签级别数组，用于指定用于生成"目录"的书签。 对于输入数组中的每个元素，有效范围：从1到(depth)。 depth 由函数 PDFDoc.getBookmarkLevelDepth 返回。 如果输入数组是空数组，则意味着所有书签都用于生成"目录"。

参数

[in]

value

书签级别数组，用于指定用于生成"目录"的书签。 对于输入数组中的每个元素，有效范围：从1到(depth)。 depth 由函数 PDFDoc.getBookmarkLevelDepth 返回。 如果输入数组是空数组，则意味着所有书签都用于生成"目录"。

返回

None.

setInclude_toc_pages()

com.foxit.sdk.pdf.TableOfContentsConfig.setInclude_toc_pages

(

boolean

value

)

Set true 表示在目录的页码计算中包含目录页面， false 表示在目录的页码计算中排除目录页面。

参数

[in]

value

true 表示在目录的页码计算中包含目录页面， false 表示在目录的页码计算中排除目录页面。

返回

None.

setIs_show_serial_number()

com.foxit.sdk.pdf.TableOfContentsConfig.setIs_show_serial_number

(

boolean

value

)

Set true 表示在目录中显示序列号，false 表示不显示序列号。

参数

[in]

value

true 表示在目录中显示序列号，false 表示不显示序列号。

返回

None.

setTitle()

com.foxit.sdk.pdf.TableOfContentsConfig.setTitle

(

String

value

)

Set 目录的标题。如果这是空字符串，将使用默认值"Table of Contents"。

参数

[in]

value

目录的标题。如果这是空字符串，将使用默认值"Table of Contents"。

返回

None.