XEasyPdfDefaultFooter (x-easypdf-pdfbox 2.12.2 API)

java.lang.Object
- org.dromara.pdf.pdfbox.footer.XEasyPdfDefaultFooter

所有已实现的接口:

Serializable, XEasyPdfFooter
```
public class XEasyPdfDefaultFooter
extends Object
implements XEasyPdfFooter
```
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

另请参阅:

序列化表格

构造器概要

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

方法概要

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

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - XEasyPdfDefaultFooter
```
public XEasyPdfDefaultFooter(XEasyPdfComponent component)
```
    有参构造
    
    参数:
    
    component - 自定义组件
  - XEasyPdfDefaultFooter
```
public XEasyPdfDefaultFooter(XEasyPdfImage image)
```
    有参构造
    
    参数:
    
    image - pdf图片
  - XEasyPdfDefaultFooter
```
public XEasyPdfDefaultFooter(XEasyPdfText text)
```
    有参构造
    
    参数:
    
    text - pdf文本
  - XEasyPdfDefaultFooter
```
public XEasyPdfDefaultFooter(XEasyPdfImage image,
                             XEasyPdfText text)
```
    有参构造
    
    参数:
    
    image - pdf图片
    
    text - pdf文本
- 方法详细资料
  - enableResetContext
```
public XEasyPdfDefaultFooter enableResetContext()
```
    开启上下文重置
    
    指定者:
    
    enableResetContext 在接口中 XEasyPdfFooter
    
    返回:
    
    返回页脚组件
  - setMargin
```
public XEasyPdfDefaultFooter setMargin(float margin)
```
    设置边距（左右下）
    
    指定者:
    
    setMargin 在接口中 XEasyPdfFooter
    
    参数:
    
    margin - 边距
    
    返回:
    
    返回页脚组件
  - setMarginLeft
```
public XEasyPdfDefaultFooter setMarginLeft(float margin)
```
    设置左边距
    
    指定者:
    
    setMarginLeft 在接口中 XEasyPdfFooter
    
    参数:
    
    margin - 边距
    
    返回:
    
    返回页脚组件
  - setMarginRight
```
public XEasyPdfDefaultFooter setMarginRight(float margin)
```
    设置右边距
    
    指定者:
    
    setMarginRight 在接口中 XEasyPdfFooter
    
    参数:
    
    margin - 边距
    
    返回:
    
    返回页脚组件
  - setMarginBottom
```
public XEasyPdfDefaultFooter setMarginBottom(float margin)
```
    设置下边距
    
    指定者:
    
    setMarginBottom 在接口中 XEasyPdfFooter
    
    参数:
    
    margin - 边距
    
    返回:
    
    返回页脚组件
  - setHeight
```
public XEasyPdfFooter setHeight(float height)
```
    设置高度
    
    指定者:
    
    setHeight 在接口中 XEasyPdfFooter
    
    参数:
    
    height - 高度
    
    返回:
    
    返回页脚组件
  - addComponent
```
public XEasyPdfDefaultFooter addComponent(XEasyPdfComponent component)
```
    添加自定义组件
    
    指定者:
    
    addComponent 在接口中 XEasyPdfFooter
    
    参数:
    
    component - pdf组件
    
    返回:
    
    返回页脚组件
  - getHeight
```
public float getHeight(XEasyPdfDocument document,
                       XEasyPdfPage page)
```
    获取页脚高度
    
    指定者:
    
    getHeight 在接口中 XEasyPdfFooter
    
    参数:
    
    document - pdf文档
    
    page - pdf页面
    
    返回:
    
    返回页脚高度
  - getTotalPagePlaceholder
```
public String getTotalPagePlaceholder()
```
    获取总页码占位符
    
    指定者:
    
    getTotalPagePlaceholder 在接口中 XEasyPdfFooter
    
    返回:
    
    返回总页码占位符
  - getCurrentPagePlaceholder
```
public String getCurrentPagePlaceholder()
```
    获取当前页码占位符
    
    指定者:
    
    getCurrentPagePlaceholder 在接口中 XEasyPdfFooter
    
    返回:
    
    返回当前页码占位符
  - getTextFontPath
```
public String getTextFontPath()
```
    获取文本字体路径
    
    指定者:
    
    getTextFontPath 在接口中 XEasyPdfFooter
    
    返回:
    
    返回文本字体路径
  - check
```
public boolean check(XEasyPdfComponent component)
```
    检查组件
    
    指定者:
    
    check 在接口中 XEasyPdfFooter
    
    参数:
    
    component - 组件
    
    返回:
    
    返回布尔值，true为是，false为否
  - draw
```
public void draw(XEasyPdfDocument document,
                 XEasyPdfPage page)
```
    绘制
    
    指定者:
    
    draw 在接口中 XEasyPdfFooter
    
    参数:
    
    document - pdf文档
    
    page - pdf页面

类 XEasyPdfDefaultFooter

构造器概要

方法概要

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

构造器详细资料

XEasyPdfDefaultFooter

XEasyPdfDefaultFooter

XEasyPdfDefaultFooter

XEasyPdfDefaultFooter

方法详细资料

enableResetContext

setMargin

setMarginLeft

setMarginRight

setMarginBottom

setHeight

addComponent

getHeight

getTotalPagePlaceholder

getCurrentPagePlaceholder

getTextFontPath

check

draw