org.dromara.pdf.pdfbox.header

接口 XEasyPdfHeader

所有超级接口:

Serializable

所有已知实现类:

XEasyPdfDefaultHeader

public interface XEasyPdfHeader
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

方法概要

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

方法详细资料

enableResetContext

XEasyPdfHeader enableResetContext()

开启上下文重置

返回:

返回页眉组件

addSplitLine

XEasyPdfHeader addSplitLine(XEasyPdfLine... splitLine)

添加分割线

参数:

splitLine - pdf分割线

返回:

返回页眉组件

addComponent

XEasyPdfHeader addComponent(XEasyPdfComponent component)

添加自定义组件

参数:

component - pdf组件

返回:

返回页眉组件

setMargin

XEasyPdfHeader setMargin(float margin)

设置边距（上左右）

参数:

margin - 边距

返回:

返回页眉组件

setMarginLeft

XEasyPdfHeader setMarginLeft(float margin)

设置左边距

参数:

margin - 边距

返回:

返回页眉组件

setMarginRight

XEasyPdfHeader setMarginRight(float margin)

设置右边距

参数:

margin - 边距

返回:

返回页眉组件

setMarginTop

XEasyPdfHeader setMarginTop(float margin)

设置上边距

参数:

margin - 边距

返回:

返回页眉组件

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页面