org.dromara.pdf.pdfbox.header

类 XEasyPdfDefaultHeader

java.lang.Object

org.dromara.pdf.pdfbox.header.XEasyPdfDefaultHeader

所有已实现的接口:

Serializable, XEasyPdfHeader

public class XEasyPdfDefaultHeader
extends Object
implements XEasyPdfHeader

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

另请参阅:

序列化表格

构造器概要

构造器

构造器和说明
XEasyPdfDefaultHeader() 无参构造
XEasyPdfDefaultHeader(XEasyPdfComponent component) 有参构造
XEasyPdfDefaultHeader(XEasyPdfImage image) 有参构造
XEasyPdfDefaultHeader(XEasyPdfImage image, XEasyPdfText text) 有参构造
XEasyPdfDefaultHeader(XEasyPdfText text) 有参构造

方法概要

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

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

XEasyPdfDefaultHeader

public XEasyPdfDefaultHeader()

无参构造

XEasyPdfDefaultHeader

public XEasyPdfDefaultHeader(XEasyPdfComponent component)

有参构造

参数:

component - 自定义组件

XEasyPdfDefaultHeader

public XEasyPdfDefaultHeader(XEasyPdfImage image)

有参构造

参数:

image - pdf图片

XEasyPdfDefaultHeader

public XEasyPdfDefaultHeader(XEasyPdfText text)

有参构造

参数:

text - pdf文本

XEasyPdfDefaultHeader

public XEasyPdfDefaultHeader(XEasyPdfImage image,
                             XEasyPdfText text)

有参构造

参数:

image - pdf图片

text - pdf文本

方法详细资料

enableResetContext

public XEasyPdfDefaultHeader enableResetContext()

开启上下文重置

指定者:

enableResetContext 在接口中 XEasyPdfHeader

返回:

返回页眉组件

addSplitLine

public XEasyPdfDefaultHeader addSplitLine(XEasyPdfLine... splitLine)

添加分割线

指定者:

addSplitLine 在接口中 XEasyPdfHeader

参数:

splitLine - pdf分割线

返回:

返回页眉组件

addComponent

public XEasyPdfDefaultHeader addComponent(XEasyPdfComponent component)

添加自定义组件

指定者:

addComponent 在接口中 XEasyPdfHeader

参数:

component - pdf组件

返回:

返回页眉组件

setMargin

public XEasyPdfDefaultHeader setMargin(float margin)

设置边距（上左右）

指定者:

setMargin 在接口中 XEasyPdfHeader

参数:

margin - 边距

返回:

返回页眉组件

setMarginLeft

public XEasyPdfDefaultHeader setMarginLeft(float margin)

设置左边距

指定者:

setMarginLeft 在接口中 XEasyPdfHeader

参数:

margin - 边距

返回:

返回页眉组件

setMarginRight

public XEasyPdfDefaultHeader setMarginRight(float margin)

设置右边距

指定者:

setMarginRight 在接口中 XEasyPdfHeader

参数:

margin - 边距

返回:

返回页眉组件

setMarginTop

public XEasyPdfDefaultHeader setMarginTop(float margin)

设置上边距

指定者:

setMarginTop 在接口中 XEasyPdfHeader

参数:

margin - 边距

返回:

返回页眉组件

getHeight

public float getHeight(XEasyPdfDocument document,
                       XEasyPdfPage page)

获取页眉高度

指定者:

getHeight 在接口中 XEasyPdfHeader

参数:

document - pdf文档

page - pdf页面

返回:

返回页眉高度

getTotalPagePlaceholder

public String getTotalPagePlaceholder()

获取总页码占位符

指定者:

getTotalPagePlaceholder 在接口中 XEasyPdfHeader

返回:

返回总页码占位符

getCurrentPagePlaceholder

public String getCurrentPagePlaceholder()

获取当前页码占位符

指定者:

getCurrentPagePlaceholder 在接口中 XEasyPdfHeader

返回:

返回当前页码占位符

getTextFontPath

public String getTextFontPath()

获取文本字体路径

指定者:

getTextFontPath 在接口中 XEasyPdfHeader

返回:

返回文本字体路径

check

public boolean check(XEasyPdfComponent component)

检查组件

指定者:

check 在接口中 XEasyPdfHeader

参数:

component - 组件

返回:

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

draw

public void draw(XEasyPdfDocument document,
                 XEasyPdfPage page)

绘制

指定者:

draw 在接口中 XEasyPdfHeader

参数:

document - pdf文档

page - pdf页面