Public 成员函数
	HeaderFooter ()
	Constructor.

	HeaderFooter (Font font, float text_size, long text_color, PageNumberRange page_range, RectF page_margin, boolean has_text_shrinked, boolean has_fixedsize_for_print, int start_page_number, HeaderFooterContent content, boolean is_to_embed_font, boolean is_underline)
	Constructor, with parameters. 更多...

	HeaderFooter (HeaderFooter other)
	用另一个页眉页脚对象的构造函数。更多...

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

HeaderFooterContent	getContent ()
	Get 页眉页脚内容。更多...

Font	getFont ()
	Get 期望用于页眉页脚内容的有效字体对象。更多...

boolean	getHas_fixedsize_for_print ()
	Get 决定是否为打印使用固定大小的布尔值。更多...

boolean	getHas_text_shrinked ()
	Get 决定是否缩小文本的布尔值。更多...

boolean	getIs_replace_font ()
	Get （保留）决定是否替换字体的布尔值。目前 Foxit PDF SDK 始终将此值设为 true。更多...

boolean	getIs_to_embed_font ()
	Get 决定是否嵌入字体的布尔值。更多...

boolean	getIs_underline ()
	Get 决定是否给文本加下划线的布尔值。更多...

RectF	getPage_margin ()
	Get 指定页眉页脚内容位置的页边距。如果用户未设置边距值，Foxit PDF SDK 将使用定义为 (72. 更多...

PageNumberRange	getPage_range ()
	Get 指定当前页眉页脚使用页面的页码范围对象。更多...

int	getStart_page_number ()
	Get 用于参数 page_range 中指定的第一页的虚拟页码。这可以是任何数字，甚至与指定页面的实际页码不同。更多...

long	getText_color ()
	Get 用于页眉页脚内容的文本颜色。更多...

float	getText_size ()
	Get 页眉页脚内容的文本大小。更多...

void	set (Font font, float text_size, long text_color, PageNumberRange page_range, RectF page_margin, boolean has_text_shrinked, boolean has_fixedsize_for_print, int start_page_number, HeaderFooterContent content, boolean is_to_embed_font, boolean is_underline)
	设置值。更多...

void	setContent (HeaderFooterContent value)
	Set 页眉页脚内容。更多...

void	setFont (Font value)
	Set 期望用于页眉页脚内容的有效字体对象。更多...

void	setHas_fixedsize_for_print (boolean value)
	Set 决定是否为打印使用固定大小的布尔值。更多...

void	setHas_text_shrinked (boolean value)
	Set 决定是否缩小文本的布尔值。更多...

void	setIs_replace_font (boolean value)
	Set （保留）决定是否替换字体的布尔值。目前 Foxit PDF SDK 始终将此值设为 true。更多...

void	setIs_to_embed_font (boolean value)
	Set 决定是否嵌入字体的布尔值。更多...

void	setIs_underline (boolean value)
	Set 决定是否给文本加下划线的布尔值。更多...

void	setPage_margin (RectF value)
	Set 指定页眉页脚内容位置的页边距。如果用户未设置边距值，Foxit PDF SDK 将使用定义为 (72. 更多...

void	setPage_range (PageNumberRange value)
	Set 指定当前页眉页脚使用页面的页码范围对象。更多...

void	setStart_page_number (int value)
	Set 用于参数 page_range 中指定的第一页的虚拟页码。这可以是任何数字，甚至与指定页面的实际页码不同。更多...

void	setText_color (long value)
	Set 用于页眉页脚内容的文本颜色。更多...

void	setText_size (float value)
	Set 页眉页脚内容的文本大小。更多...

详细描述

This class represents properties and data for a header-footer.

构造及析构函数说明

◆ HeaderFooter() [1/2]

com.foxit.sdk.pdf.HeaderFooter.HeaderFooter	(	Font	font,
		float	text_size,
		long	text_color,
		PageNumberRange	page_range,
		RectF	page_margin,
		boolean	has_text_shrinked,
		boolean	has_fixedsize_for_print,
		int	start_page_number,
		HeaderFooterContent	content,
		boolean	is_to_embed_font,
		boolean	is_underline
	)

Constructor, with parameters.

参数

[in]	font	A valid font object used for header-footer content. Please refer to comment of font of current object.
[in]	text_size	Text size of header-footer content.
[in]	text_color	Text color used for header-footer content.
[in]	page_range	A page number range object which specifies pages where current header-footer is used. Please refer to comment of page_range of current object.
[in]	page_margin	Page margin which specifies the location for header-footer content. Please refer to comment of page_margin of current object.
[in]	has_text_shrinked	A boolean value that decides whether to shrink text or not.
[in]	has_fixedsize_for_print	A boolean value that decides whether to use fixed size for print or not.
[in]	start_page_number	A virtual page number used for the first page specified in parameter page_range. This can be any number, even different from the actual page number of the specified page. If this value is less than 1, Foxit PDF SDK will use 1 for this value when current header-footer object is used in a PDF document.
[in]	content	Header-footer content.
[in]	is_to_embed_font	A boolean value that decides whether to embed font or not.
[in]	is_underline	A boolean value that decides whether to underline text or not.

◆ HeaderFooter() [2/2]

com.foxit.sdk.pdf.HeaderFooter.HeaderFooter ( HeaderFooter other )

用另一个页眉页脚对象的构造函数。

参数

[in] other 另一个页眉页脚对象。

成员函数说明

◆ delete()

synchronized void com.foxit.sdk.pdf.HeaderFooter.delete ( )

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

返回: 无。

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

◆ getContent()

com.foxit.sdk.pdf.HeaderFooter.getContent ( )

Get 页眉页脚内容。

返回: 页眉页脚内容。

◆ getFont()

com.foxit.sdk.pdf.HeaderFooter.getFont ( )

Get 期望用于页眉页脚内容的有效字体对象。

注解: 有时，Foxit PDF SDK 无法将提取的字体与此字体对象匹配。在这种情况下，Foxit PDF SDK 将为页眉页脚内容匹配一个类似的字体（与此字体对象不完全相同）。

返回: 期望用于页眉页脚内容的有效字体对象。

◆ getHas_fixedsize_for_print()

com.foxit.sdk.pdf.HeaderFooter.getHas_fixedsize_for_print ( )

Get 决定是否为打印使用固定大小的布尔值。

返回: 决定是否为打印使用固定大小的布尔值。

◆ getHas_text_shrinked()

com.foxit.sdk.pdf.HeaderFooter.getHas_text_shrinked ( )

Get 决定是否缩小文本的布尔值。

返回: 决定是否缩小文本的布尔值。

◆ getIs_replace_font()

com.foxit.sdk.pdf.HeaderFooter.getIs_replace_font ( )

Get （保留）决定是否替换字体的布尔值。目前 Foxit PDF SDK 始终将此值设为 true。

返回: （保留）决定是否替换字体的布尔值。目前 Foxit PDF SDK 始终将此值设为 true。

◆ getIs_to_embed_font()

com.foxit.sdk.pdf.HeaderFooter.getIs_to_embed_font ( )

Get 决定是否嵌入字体的布尔值。

返回: 决定是否嵌入字体的布尔值。

◆ getIs_underline()

com.foxit.sdk.pdf.HeaderFooter.getIs_underline ( )

Get 决定是否给文本加下划线的布尔值。

返回: 决定是否给文本加下划线的布尔值。

◆ getPage_margin()

com.foxit.sdk.pdf.HeaderFooter.getPage_margin ( )

Get 指定页眉页脚内容位置的页边距。如果用户未设置边距值，Foxit PDF SDK 将使用定义为 (72.

注解

此值不表示矩形。它只是定义 PDF 页面的左边距、下边距、右边距和上边距。这些边距可用于将页眉页脚内容定位在不同的位置：

左边距用于指定左页眉或页脚内容开始的位置。
右边距用于指定右页眉或页脚内容结束的位置。
下边距用于指定任何页脚内容放置的顶部位置。如果下边距不大于 0，页脚内容将不可见。
上边距用于指定任何页眉内容放置的底部位置。如果上边距不大于 0，页眉内容将不可见。

返回: 指定页眉页脚内容位置的页边距。如果用户未设置边距值，Foxit PDF SDK 将使用定义为 (72.0, 36.0, 72.0, 36.0) 的边距作为默认值。

◆ getPage_range()

com.foxit.sdk.pdf.HeaderFooter.getPage_range ( )

Get 指定当前页眉页脚使用页面的页码范围对象。

此范围中表示的所有值应从 1 开始且不超过使用当前页眉页脚对象的 PDF 文档的页数。

返回: 指定当前页眉页脚使用页面的页码范围对象。

◆ getStart_page_number()

com.foxit.sdk.pdf.HeaderFooter.getStart_page_number ( )

Get 用于参数 page_range 中指定的第一页的虚拟页码。这可以是任何数字，甚至与指定页面的实际页码不同。

注解: 如果此值小于 1，当当前页眉页脚对象在 PDF 文档中使用时，Foxit PDF SDK 将对此值使用 1。

返回: 用于参数 page_range 中指定的第一页的虚拟页码。这可以是任何数字，甚至与指定页面的实际页码不同。

◆ getText_color()

com.foxit.sdk.pdf.HeaderFooter.getText_color ( )

Get 用于页眉页脚内容的文本颜色。

返回: 用于页眉页脚内容的文本颜色。

◆ getText_size()

com.foxit.sdk.pdf.HeaderFooter.getText_size ( )

Get 页眉页脚内容的文本大小。

返回: 页眉页脚内容的文本大小。

◆ set()

void com.foxit.sdk.pdf.HeaderFooter.set	(	Font	font,
		float	text_size,
		long	text_color,
		PageNumberRange	page_range,
		RectF	page_margin,
		boolean	has_text_shrinked,
		boolean	has_fixedsize_for_print,
		int	start_page_number,
		HeaderFooterContent	content,
		boolean	is_to_embed_font,
		boolean	is_underline
	)

设置值。

参数

[in]	font	期望用于页眉页脚内容的有效字体对象。请参阅当前对象的 font 注释。
[in]	text_size	页眉页脚内容的文本大小。
[in]	text_color	用于页眉页脚内容的文本颜色。
[in]	page_range	指定当前页眉页脚使用页面的页码范围对象。请参阅当前对象的 page_range 注释。
[in]	page_margin	指定页眉页脚内容位置的页边距。请参阅当前对象的 page_margin 注释。
[in]	has_text_shrinked	决定是否缩小文本的布尔值。
[in]	has_fixedsize_for_print	决定是否为打印使用固定大小的布尔值。
[in]	start_page_number	用于参数 page_range 中指定的第一页的虚拟页码。这可以是任何数字，甚至与指定页面的实际页码不同。如果此值小于 1，当当前页眉页脚对象在 PDF 文档中使用时，Foxit PDF SDK 将对此值使用 1。
[in]	content	页眉页脚内容。
[in]	is_to_embed_font	决定是否嵌入字体的布尔值。
[in]	is_underline	决定是否给文本加下划线的布尔值。

返回: 无。

◆ setContent()

com.foxit.sdk.pdf.HeaderFooter.setContent ( HeaderFooterContent value )

Set 页眉页脚内容。

参数

[in] value 页眉页脚内容。

返回: None.

◆ setFont()

com.foxit.sdk.pdf.HeaderFooter.setFont ( Font value )

Set 期望用于页眉页脚内容的有效字体对象。

注解: 有时，Foxit PDF SDK 无法将提取的字体与此字体对象匹配。在这种情况下，Foxit PDF SDK 将为页眉页脚内容匹配一个类似的字体（与此字体对象不完全相同）。

参数

[in] value 期望用于页眉页脚内容的有效字体对象。

返回: None.

◆ setHas_fixedsize_for_print()

com.foxit.sdk.pdf.HeaderFooter.setHas_fixedsize_for_print ( boolean value )

Set 决定是否为打印使用固定大小的布尔值。

参数

[in] value 决定是否为打印使用固定大小的布尔值。

返回: None.

◆ setHas_text_shrinked()

com.foxit.sdk.pdf.HeaderFooter.setHas_text_shrinked ( boolean value )

Set 决定是否缩小文本的布尔值。

参数

[in] value 决定是否缩小文本的布尔值。

返回: None.

◆ setIs_replace_font()

com.foxit.sdk.pdf.HeaderFooter.setIs_replace_font ( boolean value )

Set （保留）决定是否替换字体的布尔值。目前 Foxit PDF SDK 始终将此值设为 true。

参数

[in] value （保留）决定是否替换字体的布尔值。目前 Foxit PDF SDK 始终将此值设为 true。

返回: None.

◆ setIs_to_embed_font()

com.foxit.sdk.pdf.HeaderFooter.setIs_to_embed_font ( boolean value )

Set 决定是否嵌入字体的布尔值。

参数

[in] value 决定是否嵌入字体的布尔值。

返回: None.

◆ setIs_underline()

com.foxit.sdk.pdf.HeaderFooter.setIs_underline ( boolean value )

Set 决定是否给文本加下划线的布尔值。

参数

[in] value 决定是否给文本加下划线的布尔值。

返回: None.

◆ setPage_margin()

com.foxit.sdk.pdf.HeaderFooter.setPage_margin ( RectF value )

Set 指定页眉页脚内容位置的页边距。如果用户未设置边距值，Foxit PDF SDK 将使用定义为 (72.

注解

此值不表示矩形。它只是定义 PDF 页面的左边距、下边距、右边距和上边距。这些边距可用于将页眉页脚内容定位在不同的位置：

左边距用于指定左页眉或页脚内容开始的位置。
右边距用于指定右页眉或页脚内容结束的位置。
下边距用于指定任何页脚内容放置的顶部位置。如果下边距不大于 0，页脚内容将不可见。
上边距用于指定任何页眉内容放置的底部位置。如果上边距不大于 0，页眉内容将不可见。

参数

[in] value 指定页眉页脚内容位置的页边距。如果用户未设置边距值，Foxit PDF SDK 将使用定义为 (72.0, 36.0, 72.0, 36.0) 的边距作为默认值。

返回: None.

◆ setPage_range()

com.foxit.sdk.pdf.HeaderFooter.setPage_range ( PageNumberRange value )

Set 指定当前页眉页脚使用页面的页码范围对象。

此范围中表示的所有值应从 1 开始且不超过使用当前页眉页脚对象的 PDF 文档的页数。

参数

[in] value 指定当前页眉页脚使用页面的页码范围对象。

返回: None.

◆ setStart_page_number()

com.foxit.sdk.pdf.HeaderFooter.setStart_page_number ( int value )

Set 用于参数 page_range 中指定的第一页的虚拟页码。这可以是任何数字，甚至与指定页面的实际页码不同。

注解: 如果此值小于 1，当当前页眉页脚对象在 PDF 文档中使用时，Foxit PDF SDK 将对此值使用 1。

参数

[in] value 用于参数 page_range 中指定的第一页的虚拟页码。这可以是任何数字，甚至与指定页面的实际页码不同。

返回: None.

◆ setText_color()

com.foxit.sdk.pdf.HeaderFooter.setText_color ( long value )

Set 用于页眉页脚内容的文本颜色。

参数

[in] value 用于页眉页脚内容的文本颜色。

返回: None.

◆ setText_size()

com.foxit.sdk.pdf.HeaderFooter.setText_size ( float value )

Set 页眉页脚内容的文本大小。

参数

[in] value 页眉页脚内容的文本大小。

返回: None.

Public 成员函数

详细描述

构造及析构函数说明

◆ HeaderFooter() [1/2]

◆ HeaderFooter() [2/2]

成员函数说明

◆ delete()

◆ getContent()

◆ getFont()

◆ getHas_fixedsize_for_print()

◆ getHas_text_shrinked()

◆ getIs_replace_font()

◆ getIs_to_embed_font()

◆ getIs_underline()

◆ getPage_margin()

◆ getPage_range()

◆ getStart_page_number()

◆ getText_color()

◆ getText_size()

◆ set()

◆ setContent()

◆ setFont()

◆ setHas_fixedsize_for_print()

◆ setHas_text_shrinked()

◆ setIs_replace_font()

◆ setIs_to_embed_font()

◆ setIs_underline()

◆ setPage_margin()

◆ setPage_range()

◆ setStart_page_number()

◆ setText_color()

◆ setText_size()