org.dromara.pdf.pdfbox.footer

接口 XEasyPdfFooter

所有超级接口:

Serializable

所有已知实现类:

XEasyPdfDefaultFooter

public interface XEasyPdfFooter
extends Serializable

pdf页脚组件接口

从以下版本开始:

1.8

Copyright (c) 2020-2023 xsx All Rights Reserved. x-easypdf is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details.

作者:

xsx

方法概要

限定符和类型	方法和说明
XEasyPdfFooter	addComponent(XEasyPdfComponent component) 添加自定义组件
boolean	check(XEasyPdfComponent component) 检查组件
void	draw(XEasyPdfDocument document, XEasyPdfPage page) 绘制
XEasyPdfFooter	enableResetContext() 开启上下文重置
String	getCurrentPagePlaceholder() 获取当前页码占位符
float	getHeight(XEasyPdfDocument document, XEasyPdfPage page) 获取页脚高度
String	getTextFontPath() 获取文本字体路径
String	getTotalPagePlaceholder() 获取总页码占位符
XEasyPdfFooter	setHeight(float height) 设置高度
XEasyPdfFooter	setMargin(float margin) 设置边距（左右下）
XEasyPdfFooter	setMarginBottom(float margin) 设置下边距
XEasyPdfFooter	setMarginLeft(float margin) 设置左边距
XEasyPdfFooter	setMarginRight(float margin) 设置右边距

方法详细资料

enableResetContext

XEasyPdfFooter enableResetContext()

开启上下文重置

返回:

返回页脚组件

setMargin

XEasyPdfFooter setMargin(float margin)

设置边距（左右下）

参数:

margin - 边距

返回:

返回页脚组件

setMarginLeft

XEasyPdfFooter setMarginLeft(float margin)

设置左边距

参数:

margin - 边距

返回:

返回页脚组件

setMarginRight

XEasyPdfFooter setMarginRight(float margin)

设置右边距

参数:

margin - 边距

返回:

返回页脚组件

setMarginBottom

XEasyPdfFooter setMarginBottom(float margin)

设置下边距

参数:

margin - 边距

返回:

返回页脚组件

setHeight

XEasyPdfFooter setHeight(float height)

设置高度

参数:

height - 高度

返回:

返回页脚组件

addComponent

XEasyPdfFooter addComponent(XEasyPdfComponent component)

添加自定义组件

参数:

component - pdf组件

返回:

返回页脚组件

getHeight

float getHeight(XEasyPdfDocument document,
                XEasyPdfPage page)

获取页脚高度

参数:

document - pdf文档

page - pdf页面

返回:

返回页脚高度

getTotalPagePlaceholder

String getTotalPagePlaceholder()

获取总页码占位符

返回:

返回总页码占位符

getCurrentPagePlaceholder

String getCurrentPagePlaceholder()

获取当前页码占位符

返回:

返回当前页码占位符

getTextFontPath

String getTextFontPath()

获取文本字体路径

返回:

返回文本字体路径

check

boolean check(XEasyPdfComponent component)

检查组件

参数:

component - 组件

返回:

返回布尔值，true为是，false为否

draw

void draw(XEasyPdfDocument document,
          XEasyPdfPage page)

绘制

参数:

document - pdf文档

page - pdf页面