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

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

Public 成员函数
	DocViewerPrefs (PDFDoc document, PDFDictionary pdf_dict) throws com.foxit.sdk.PDFException
	带参数的构造函数。 更多...
	DocViewerPrefs (DocViewerPrefs other)
	拷贝构造函数。 更多...
synchronized void	delete ()
	直接清除C++相关资源。 更多...
PDFDictionary	getDict () throws com.foxit.sdk.PDFException
	从当前对象获取PDF字典。 更多...
int	getNonFullScreenPageMode () throws com.foxit.sdk.PDFException
	获取指定文档在退出全屏模式时如何显示文档的显示模式， 当文档的显示模式为全屏时。 更多...
int	getPrintArea () throws com.foxit.sdk.PDFException
	获取表示打印文档时要渲染的页面区域的页面边界。 更多...
int	getPrintClip () throws com.foxit.sdk.PDFException
	获取打印文档时页面内容要被裁剪的页面边界。 更多...
int	getPrintCopies () throws com.foxit.sdk.PDFException
	获取为PDF文档打开打印对话框时要打印的副本数量。 更多...
Range	getPrintRange () throws com.foxit.sdk.PDFException
	获取用于在为PDF文档打开打印对话框时初始化打印对话框的页面范围信息。 更多...
int	getPrintScale () throws com.foxit.sdk.PDFException
	获取为PDF文档显示打印对话框时要选择的页面缩放选项。 更多...
boolean	getReadingDirection () throws com.foxit.sdk.PDFException
	获取文本的主要阅读方向。 更多...
boolean	getUIDisplayStatus (int pref) throws com.foxit.sdk.PDFException
	获取指定查看器首选项类型的UI显示状态。 更多...
int	getViewArea () throws com.foxit.sdk.PDFException
	获取表示在屏幕上查看文档时要显示的页面区域的页面边界。 更多...
int	getViewClip () throws com.foxit.sdk.PDFException
	获取在屏幕上查看文档时页面内容要被裁剪的页面边界。 更多...
boolean	isEmpty ()
	检查当前对象是否为空。 更多...
void	setNonFullScreenPageMode (int display_mode) throws com.foxit.sdk.PDFException
	设置指定文档在退出全屏模式时如何显示文档的显示模式， 当文档的显示模式为全屏时。 更多...
void	setPrintArea (int box_type) throws com.foxit.sdk.PDFException
	设置表示打印文档时要渲染的页面区域的页面边界。 更多...
void	setPrintClip (int box_type) throws com.foxit.sdk.PDFException
	设置打印文档时页面内容要被裁剪的页面边界。 更多...
void	setPrintCopies (int print_copies) throws com.foxit.sdk.PDFException
	设置为PDF文档打开打印对话框时要打印的副本数量。 更多...
void	setPrintRange (Range page_range) throws com.foxit.sdk.PDFException
	设置用于在为PDF文档打开打印对话框时初始化打印对话框的页面范围。 更多...
void	setPrintScale (int print_scale) throws com.foxit.sdk.PDFException
	设置为PDF文档显示打印对话框时要选择的页面缩放选项。 更多...
void	setReadingDirection (boolean is_left_to_right) throws com.foxit.sdk.PDFException
	设置文本的主要阅读方向。 更多...
void	setUIDisplayStatus (int pref, boolean value) throws com.foxit.sdk.PDFException
	设置指定查看器首选项类型的UI显示状态。 更多...
void	setViewArea (int box_type) throws com.foxit.sdk.PDFException
	设置表示在屏幕上查看文档时要显示的页面区域的页面边界。 更多...
void	setViewClip (int box_type) throws com.foxit.sdk.PDFException
	设置在屏幕上查看文档时页面内容要被裁剪的页面边界。 更多...
Public 成员函数 继承自 com.foxit.sdk.common.Base
synchronized void	delete ()
	直接清除C++相关资源。 更多...

静态 Public 属性
static final int	e_CenterWindow = 4
	指定是否将文档窗口位置居中显示在屏幕中央的标志。
static final int	e_DisplayDocTitle = 5
	指定窗口标题栏是否应显示从文档信息字典的"Title"条目中获取的 文档标题的标志。如果为false，标题栏应显示包含文档的PDF文件名。
static final int	e_FitWindow = 3
	指定是否调整文档窗口大小以适应第一个显示页面尺寸的标志。
static final int	e_HideMenubar = 1
	指定文档处于活动状态时是否隐藏查看器应用程序菜单栏的标志。
static final int	e_HideToolbar = 0
	指定文档处于活动状态时是否隐藏查看器应用程序工具栏的标志。
static final int	e_HideWindowUI = 2
	指定是否隐藏文档窗口中的用户界面元素（如滚动条和导航控件）的标志， 只显示文档内容。
static final int	e_PrintScaleAppDefault = 1
	这表示应用程序应该使用当前的打印缩放。
static final int	e_PrintScaleNone = 0
	这表示打印对话框应该反映无页面缩放。

详细描述

查看器首选项定义了文档在屏幕上或打印时的呈现方式。 此类应由有效的PDF文档对象构造。此类提供了获取/设置PDF文档查看器首选项 不同部分的功能，如UI可见性、非全屏模式的显示模式、阅读方向、 指定用途的框项目类型、用于打印的一些首选项选项等。

参见

PDFDoc

构造及析构函数说明

DocViewerPrefs() [1/2]

com.foxit.sdk.pdf.DocViewerPrefs.DocViewerPrefs	(	PDFDoc	document,
		PDFDictionary	pdf_dict
	)		throws com.foxit.sdk.PDFException

带参数的构造函数。

当输入参数pdf_dict为null时，Foxit PDF SDK将尝试 访问指定PDF文档中的查看器首选项信息： 如果PDF文档中存在查看器首选项信息，此函数只是构造一个 与这些信息关联的文档查看器首选项对象； 如果指定的PDF文档中没有此类信息，构造的文档查看器首选项对象 可用于向PDF文档设置这些信息。

参数

[in]	document	有效的PDF文档对象。
[in]	pdf_dict	表示PDF文档查看器首选项信息的PDF字典。 如果此参数不是null，此PDF字典应已存在于 指定的PDF文档中。如果此参数为null，则表示 访问指定PDF文档中的查看器首选项信息。 请参考"详细信息"部分了解更多详情。默认值：null。

DocViewerPrefs() [2/2]

com.foxit.sdk.pdf.DocViewerPrefs.DocViewerPrefs

(

DocViewerPrefs

other

)

拷贝构造函数。

参数

[in]

other

另一个文档查看器首选项对象。

成员函数说明

delete()

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

(

)

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

返回

无。

注解

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

getDict()

PDFDictionary com.foxit.sdk.pdf.DocViewerPrefs.getDict

(

)

throws com.foxit.sdk.PDFException

从当前对象获取PDF字典。

返回

PDF字典。如果有任何错误，此函数将返回null。

getNonFullScreenPageMode()

int com.foxit.sdk.pdf.DocViewerPrefs.getNonFullScreenPageMode

(

)

throws com.foxit.sdk.PDFException

获取指定文档在退出全屏模式时如何显示文档的显示模式， 当文档的显示模式为全屏时。

此显示模式仅在文档的显示模式为全屏时有用。 可以使用函数 PDFDoc.getDisplayMode 检查文档的显示模式。

返回

非全屏模式的值。将是以下值之一：

• com.foxit.sdk.pdf.PDFDoc.e_DisplayUseNone

• com.foxit.sdk.pdf.PDFDoc.e_DisplayUseOutlines

• com.foxit.sdk.pdf.PDFDoc.e_DisplayUseThumbs

• com.foxit.sdk.pdf.PDFDoc.e_DisplayUseOC

getPrintArea()

int com.foxit.sdk.pdf.DocViewerPrefs.getPrintArea

(

)

throws com.foxit.sdk.PDFException

获取表示打印文档时要渲染的页面区域的页面边界。

返回

页面框类型。请参考从 com.foxit.sdk.pdf.PDFPage.e_MediaBox 开始的值， 将是这些值中的一个。

getPrintClip()

int com.foxit.sdk.pdf.DocViewerPrefs.getPrintClip

(

)

throws com.foxit.sdk.PDFException

获取打印文档时页面内容要被裁剪的页面边界。

返回

页面框类型。请参考从 com.foxit.sdk.pdf.PDFPage.e_MediaBox 开始的值， 将是这些值中的一个。

getPrintCopies()

int com.foxit.sdk.pdf.DocViewerPrefs.getPrintCopies

(

)

throws com.foxit.sdk.PDFException

获取为PDF文档打开打印对话框时要打印的副本数量。

返回

副本数量。

getPrintRange()

Range com.foxit.sdk.pdf.DocViewerPrefs.getPrintRange

(

)

throws com.foxit.sdk.PDFException

获取用于在为PDF文档打开打印对话框时初始化打印对话框的页面范围信息。

页面范围中指定的所有索引都是从0到(页面数 - 1)。 如果页面范围信息无效，此函数将抛出异常 com.foxit.sdk.common.Constants.e_ErrFormat 。

返回

页面范围。

getPrintScale()

int com.foxit.sdk.pdf.DocViewerPrefs.getPrintScale

(

)

throws com.foxit.sdk.PDFException

获取为PDF文档显示打印对话框时要选择的页面缩放选项。

返回

页面缩放选项字符串值。请参考从 com.foxit.sdk.pdf.DocViewerPrefs.e_PrintScaleNone 开始的值，将是这些值中的一个。

getReadingDirection()

boolean com.foxit.sdk.pdf.DocViewerPrefs.getReadingDirection

(

)

throws com.foxit.sdk.PDFException

获取文本的主要阅读方向。

阅读方向信息对文档内容或页码编号没有直接影响， 但可用于确定页面并排显示或多页打印（即在单页上打印多个PDF页面）时 页面的相对位置。

返回

true表示从左到右的阅读顺序，false表示从右到左的阅读顺序。

getUIDisplayStatus()

boolean com.foxit.sdk.pdf.DocViewerPrefs.getUIDisplayStatus

(

int

pref

)

throws com.foxit.sdk.PDFException

获取指定查看器首选项类型的UI显示状态。

参数

[in]

pref

查看器首选项类型。请参考从 com.foxit.sdk.pdf.DocViewerPrefs.e_HideToolbar 开始的值，应该是这些值中的一个。

返回

指定查看器首选项类型的值。

getViewArea()

int com.foxit.sdk.pdf.DocViewerPrefs.getViewArea

(

)

throws com.foxit.sdk.PDFException

获取表示在屏幕上查看文档时要显示的页面区域的页面边界。

返回

页面框类型。请参考从 com.foxit.sdk.pdf.PDFPage.e_MediaBox 开始的值， 将是这些值中的一个。

getViewClip()

int com.foxit.sdk.pdf.DocViewerPrefs.getViewClip

(

)

throws com.foxit.sdk.PDFException

获取在屏幕上查看文档时页面内容要被裁剪的页面边界。

返回

页面框类型。请参考从 com.foxit.sdk.pdf.PDFPage.e_MediaBox 开始的值， 将是这些值中的一个。

isEmpty()

boolean com.foxit.sdk.pdf.DocViewerPrefs.isEmpty

(

)

检查当前对象是否为空。

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

返回

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

setNonFullScreenPageMode()

void com.foxit.sdk.pdf.DocViewerPrefs.setNonFullScreenPageMode

(

int

display_mode

)

throws com.foxit.sdk.PDFException

设置指定文档在退出全屏模式时如何显示文档的显示模式， 当文档的显示模式为全屏时。

此显示模式仅在文档的显示模式为全屏时有用。 可以使用函数 PDFDoc.getDisplayMode 检查文档的显示模式。

参数

[in]

display_mode

退出全屏模式时的新显示模式。应该是以下值之一： com.foxit.sdk.pdf.PDFDoc.e_DisplayUseNone com.foxit.sdk.pdf.PDFDoc.e_DisplayUseOutlines com.foxit.sdk.pdf.PDFDoc.e_DisplayUseThumbs com.foxit.sdk.pdf.PDFDoc.e_DisplayUseOC

返回

无。

setPrintArea()

void com.foxit.sdk.pdf.DocViewerPrefs.setPrintArea

(

int

box_type

)

throws com.foxit.sdk.PDFException

设置表示打印文档时要渲染的页面区域的页面边界。

参数

[in]

box_type

页面框类型。请参考从 com.foxit.sdk.pdf.PDFPage.e_MediaBox 开始的值， 应该是这些值中的一个。

返回

无。

setPrintClip()

void com.foxit.sdk.pdf.DocViewerPrefs.setPrintClip

(

int

box_type

)

throws com.foxit.sdk.PDFException

设置打印文档时页面内容要被裁剪的页面边界。

参数

[in]

box_type

页面框类型。请参考从 com.foxit.sdk.pdf.PDFPage.e_MediaBox 开始的值， 应该是这些值中的一个。

返回

无。

setPrintCopies()

void com.foxit.sdk.pdf.DocViewerPrefs.setPrintCopies

(

int

print_copies

)

throws com.foxit.sdk.PDFException

设置为PDF文档打开打印对话框时要打印的副本数量。

参数

[in]

print_copies

副本数量的新整数值。有效范围：从1到5。 如果输入值超出有效范围，Foxit PDF SDK将默认使用1。

返回

无。

setPrintRange()

void com.foxit.sdk.pdf.DocViewerPrefs.setPrintRange

(

Range

page_range

)

throws com.foxit.sdk.PDFException

设置用于在为PDF文档打开打印对话框时初始化打印对话框的页面范围。

参数

[in]

page_range

表示新页面范围信息的范围对象。它应该包含至少 一个有效的范围段。此范围指定的所有索引应该 从0到(页面数 - 1)。页面数由函数 PDFDoc.getPageCount 返回。

返回

无。

setPrintScale()

void com.foxit.sdk.pdf.DocViewerPrefs.setPrintScale

(

int

print_scale

)

throws com.foxit.sdk.PDFException

设置为PDF文档显示打印对话框时要选择的页面缩放选项。

参数

[in]

print_scale

新的页面缩放选项字符串。请参考从 com.foxit.sdk.pdf.DocViewerPrefs.e_PrintScaleNone 开始的值，应该是这些值中的一个。

返回

无。

setReadingDirection()

void com.foxit.sdk.pdf.DocViewerPrefs.setReadingDirection

(

boolean

is_left_to_right

)

throws com.foxit.sdk.PDFException

设置文本的主要阅读方向。

阅读方向信息对文档内容或页码编号没有直接影响， 但可用于确定页面并排显示或多页打印（即在单页上打印多个PDF页面）时 页面的相对位置。

参数

[in]

is_left_to_right

新的阅读方向：true表示从左到右的阅读顺序， false表示从右到左的阅读顺序。

返回

无。

setUIDisplayStatus()

void com.foxit.sdk.pdf.DocViewerPrefs.setUIDisplayStatus	(	int	pref,
		boolean	value
	)		throws com.foxit.sdk.PDFException

设置指定查看器首选项类型的UI显示状态。

如果查看器首选项类型之前不存在且从未设置过， 该值默认为false。

参数

[in]	pref	查看器首选项类型。请参考从 com.foxit.sdk.pdf.DocViewerPrefs.e_HideToolbar 开始的值，应该是这些值中的一个。
[in]	value	指定查看器首选项类型的新值。

返回

无。

setViewArea()

void com.foxit.sdk.pdf.DocViewerPrefs.setViewArea

(

int

box_type

)

throws com.foxit.sdk.PDFException

设置表示在屏幕上查看文档时要显示的页面区域的页面边界。

参数

[in]

box_type

页面框类型。请参考从 com.foxit.sdk.pdf.PDFPage.e_MediaBox 开始的值， 应该是这些值中的一个。

返回

无。

setViewClip()

void com.foxit.sdk.pdf.DocViewerPrefs.setViewClip

(

int

box_type

)

throws com.foxit.sdk.PDFException

设置在屏幕上查看文档时页面内容要被裁剪的页面边界。

参数

[in]

box_type

页面框类型。请参考从 com.foxit.sdk.pdf.PDFPage.e_MediaBox 开始的值， 应该是这些值中的一个。

返回

无。