XEasyPdfPage (x-easypdf-pdfbox 2.12.1 API)

java.lang.Object
- org.dromara.pdf.pdfbox.doc.XEasyPdfPage

所有已实现的接口:

Serializable
```
public class XEasyPdfPage
extends Object
implements 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

另请参阅:

序列化表格

嵌套类概要

嵌套类
限定符和类型类和说明

static class XEasyPdfPage.Rotation
旋转角度

嵌套类
限定符和类型	类和说明
`static class`	`XEasyPdfPage.Rotation` 旋转角度

构造器概要

构造器
构造器和说明

XEasyPdfPage(XEasyPdfPageRectangle pageSize)
有参构造

构造器
构造器和说明
`XEasyPdfPage(XEasyPdfPageRectangle pageSize)` 有参构造

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`XEasyPdfPage`	`addComponent(List<XEasyPdfComponent> components)` 添加pdf组件
`XEasyPdfPage`	`addComponent(XEasyPdfComponent... components)` 添加pdf组件
`XEasyPdfPage`	`addNewPage(XEasyPdfDocument document, org.apache.pdfbox.pdmodel.common.PDRectangle pageSize)` 添加新页面
`XEasyPdfPage`	`disableBackgroundColor()` 关闭背景色
`XEasyPdfPage`	`disableBackgroundImage()` 关闭背景图片
`XEasyPdfPage`	`disableFooter()` 关闭页脚
`XEasyPdfPage`	`disableHeader()` 关闭页眉
`XEasyPdfPage`	`disablePosition()` 关闭页面自动重置定位
`XEasyPdfPage`	`disableRotateInherentPage()` 关闭旋转固有页面
`XEasyPdfPage`	`disableWatermark()` 关闭水印
`XEasyPdfPage`	`enablePosition()` 开启页面自动重置定位
`XEasyPdfPage`	`enableResetContext()` 开启重置上下文
`Color`	`getBackgroundColor()` 获取页面背景色
`XEasyPdfImage`	`getBackgroundImage()` 获取页面背景图片
`XEasyPdfComponent.ContentMode`	`getContentMode()` 获取内容模式
`int`	`getCurrentIndex(XEasyPdfDocument document)` 获取当前页面索引
`org.apache.pdfbox.pdmodel.font.PDFont`	`getFont()` 获取页面字体
`String`	`getFontPath()` 获取页面字体路径
`XEasyPdfFooter`	`getFooter()` 获取页脚
`XEasyPdfHeader`	`getHeader()` 获取页眉
`float`	`getHeight()` 获取当前页面高度
`org.apache.pdfbox.pdmodel.PDPage`	`getLastPage()` 获取pdfBox最新页面
`List<org.apache.pdfbox.pdmodel.PDPage>`	`getNewPageList()` 获取新增的pdfBox页面列表
`float`	`getOriginalHeight()` 获取原有页面高度
`XEasyPdfPageRectangle`	`getOriginalRectangle()` 获取原有页面尺寸
`float`	`getOriginalRectangleBottomY()` 获取原有页面尺寸Y轴下坐标
`float`	`getOriginalRectangleLeftX()` 获取原有页面尺寸X轴左坐标
`float`	`getOriginalRectangleRightX()` 获取原有页面尺寸X轴右坐标
`float`	`getOriginalRectangleTopY()` 获取原有页面尺寸Y轴上坐标
`float`	`getOriginalWidth()` 获取原有页面宽度
`List<org.apache.pdfbox.pdmodel.PDPage>`	`getPageList()` 获取包含的pdfBox页面列表
`Float`	`getPageX()` 获取页面X轴坐标
`Float`	`getPageY()` 获取页面Y轴坐标
`XEasyPdfPageRectangle`	`getRectangle()` 获取当前页面尺寸
`float`	`getRectangleBottomY()` 获取当前页面尺寸Y轴下坐标
`float`	`getRectangleLeftX()` 获取当前页面尺寸X轴左坐标
`float`	`getRectangleRightX()` 获取当前页面尺寸X轴右坐标
`float`	`getRectangleTopY()` 获取当前页面尺寸Y轴上坐标
`float`	`getUnit()` 获取每毫米像素点
`XEasyPdfWatermark`	`getWatermark()` 获取水印
`float`	`getWidth()` 获取当前页面宽度
`boolean`	`isAllowBackgroundColor()` 是否允许添加背景色
`boolean`	`isAllowBackgroundImage()` 是否允许添加背景图片
`boolean`	`isAllowFooter()` 是否允许添加页脚
`boolean`	`isAllowHeader()` 是否允许添加页眉
`boolean`	`isAllowResetPosition()` 是否允许重置定位
`boolean`	`isAllowRotateInherentPage()` 是否允许旋转固有页面
`boolean`	`isAllowWatermark()` 是否允许添加水印
`boolean`	`isResetContext()` 是否重置上下文
`XEasyPdfPage`	`modifyPageSize(XEasyPdfPageRectangle pageSize)` 修改页面尺寸
`XEasyPdfPage`	`setBackgroundColor(Color backgroundColor)` 设置页面背景色
`XEasyPdfPage`	`setBackgroundImage(XEasyPdfImage backgroundImage)` 设置页面背景图片
`XEasyPdfPage`	`setContentMode(XEasyPdfComponent.ContentMode contentMode)` 设置内容模式
`XEasyPdfPage`	`setDefaultFontStyle(XEasyPdfDefaultFontStyle style)` 设置默认字体样式
`XEasyPdfPage`	`setFontPath(String fontPath)` 设置字体路径
`XEasyPdfPage`	`setFooter(XEasyPdfFooter footer)` 设置页脚
`XEasyPdfPage`	`setHeader(XEasyPdfHeader header)` 设置页眉
`XEasyPdfPage`	`setPageX(Float pageX)` 设置页面X轴坐标
`XEasyPdfPage`	`setPageY(Float pageY)` 设置页面X轴坐标
`XEasyPdfPage`	`setRotation(XEasyPdfPage.Rotation rotation)` 设置旋转角度
`XEasyPdfPage`	`setWatermark(XEasyPdfWatermark watermark)` 设置水印

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

- 构造器详细资料
  - XEasyPdfPage
```
public XEasyPdfPage(XEasyPdfPageRectangle pageSize)
```
    有参构造
    
    参数:
    
    pageSize - pdf页面尺寸
- 方法详细资料
  - setRotation
```
public XEasyPdfPage setRotation(XEasyPdfPage.Rotation rotation)
```
    设置旋转角度
    
    参数:
    
    rotation - 旋转角度
    
    返回:
    
    返回pdf页面
  - setFontPath
```
public XEasyPdfPage setFontPath(String fontPath)
```
    设置字体路径
    
    参数:
    
    fontPath - 字体路径
    
    返回:
    
    返回pdf页面
  - getFontPath
```
public String getFontPath()
```
    获取页面字体路径
    
    返回:
    
    返回页面字体路径
  - getFont
```
public org.apache.pdfbox.pdmodel.font.PDFont getFont()
```
    获取页面字体
    
    返回:
    
    返回pdfBox字体
  - setDefaultFontStyle
```
public XEasyPdfPage setDefaultFontStyle(XEasyPdfDefaultFontStyle style)
```
    设置默认字体样式
    
    参数:
    
    style - 默认字体样式
    
    返回:
    
    返回pdf页面
  - setPageX
```
public XEasyPdfPage setPageX(Float pageX)
```
    设置页面X轴坐标
    
    参数:
    
    pageX - X轴坐标
    
    返回:
    
    返回pdf页面
  - getPageX
```
public Float getPageX()
```
    获取页面X轴坐标
    
    返回:
    
    返回页面X轴坐标
  - setPageY
```
public XEasyPdfPage setPageY(Float pageY)
```
    设置页面X轴坐标
    
    参数:
    
    pageY - Y轴坐标
    
    返回:
    
    返回pdf页面
  - getPageY
```
public Float getPageY()
```
    获取页面Y轴坐标
    
    返回:
    
    返回页面Y轴坐标
  - setContentMode
```
public XEasyPdfPage setContentMode(XEasyPdfComponent.ContentMode contentMode)
```
    设置内容模式
    
    参数:
    
    contentMode - 内容模式
    
    返回:
    
    返回返回pdf页面
  - getContentMode
```
public XEasyPdfComponent.ContentMode getContentMode()
```
    获取内容模式
    
    返回:
    
    返回内容模式
  - setBackgroundImage
```
public XEasyPdfPage setBackgroundImage(XEasyPdfImage backgroundImage)
```
    设置页面背景图片
    
    参数:
    
    backgroundImage - 背景图片
    
    返回:
    
    返回pdf页面
  - getBackgroundImage
```
public XEasyPdfImage getBackgroundImage()
```
    获取页面背景图片
    
    返回:
    
    返回pdf页面
  - setBackgroundColor
```
public XEasyPdfPage setBackgroundColor(Color backgroundColor)
```
    设置页面背景色
    
    参数:
    
    backgroundColor - 背景色
    
    返回:
    
    返回pdf页面
  - getBackgroundColor
```
public Color getBackgroundColor()
```
    获取页面背景色
    
    返回:
    
    返回页面背景色
  - setWatermark
```
public XEasyPdfPage setWatermark(XEasyPdfWatermark watermark)
```
    设置水印
    
    参数:
    
    watermark - pdf水印
    
    返回:
    
    返回pdf页面
  - getWatermark
```
public XEasyPdfWatermark getWatermark()
```
    获取水印
    
    返回:
    
    返回pdf水印
  - setHeader
```
public XEasyPdfPage setHeader(XEasyPdfHeader header)
```
    设置页眉
    
    参数:
    
    header - pdf页眉
    
    返回:
    
    返回pdf页面
  - getHeader
```
public XEasyPdfHeader getHeader()
```
    获取页眉
    
    返回:
    
    返回pdf页眉
  - setFooter
```
public XEasyPdfPage setFooter(XEasyPdfFooter footer)
```
    设置页脚
    
    参数:
    
    footer - pdf页脚
    
    返回:
    
    返回pdf页面
  - getFooter
```
public XEasyPdfFooter getFooter()
```
    获取页脚
    
    返回:
    
    返回pdf页脚
  - getUnit
```
public float getUnit()
```
    获取每毫米像素点
    
    返回:
    
    返回每毫米像素点
  - getWidth
```
public float getWidth()
```
    获取当前页面宽度
    
    返回:
    
    返回当前页面宽度
  - getHeight
```
public float getHeight()
```
    获取当前页面高度
    
    返回:
    
    返回当前页面高度
  - getRectangle
```
public XEasyPdfPageRectangle getRectangle()
```
    获取当前页面尺寸
    
    返回:
    
    返回当前页面尺寸
  - getRectangleLeftX
```
public float getRectangleLeftX()
```
    获取当前页面尺寸X轴左坐标
    
    返回:
    
    返回当前页面尺寸X轴左坐标
  - getRectangleRightX
```
public float getRectangleRightX()
```
    获取当前页面尺寸X轴右坐标
    
    返回:
    
    返回当前页面尺寸X轴右坐标
  - getRectangleBottomY
```
public float getRectangleBottomY()
```
    获取当前页面尺寸Y轴下坐标
    
    返回:
    
    返回当前页面尺寸Y轴下坐标
  - getRectangleTopY
```
public float getRectangleTopY()
```
    获取当前页面尺寸Y轴上坐标
    
    返回:
    
    返回当前页面尺寸Y轴上坐标
  - getOriginalWidth
```
public float getOriginalWidth()
```
    获取原有页面宽度
    
    返回:
    
    返回原有页面宽度
  - getOriginalHeight
```
public float getOriginalHeight()
```
    获取原有页面高度
    
    返回:
    
    返回原有页面高度
  - getOriginalRectangle
```
public XEasyPdfPageRectangle getOriginalRectangle()
```
    获取原有页面尺寸
    
    返回:
    
    返回原有页面尺寸
  - getOriginalRectangleLeftX
```
public float getOriginalRectangleLeftX()
```
    获取原有页面尺寸X轴左坐标
    
    返回:
    
    返回当前页面尺寸X轴左坐标
  - getOriginalRectangleRightX
```
public float getOriginalRectangleRightX()
```
    获取原有页面尺寸X轴右坐标
    
    返回:
    
    返回当前页面尺寸X轴右坐标
  - getOriginalRectangleBottomY
```
public float getOriginalRectangleBottomY()
```
    获取原有页面尺寸Y轴下坐标
    
    返回:
    
    返回当前页面尺寸Y轴下坐标
  - getOriginalRectangleTopY
```
public float getOriginalRectangleTopY()
```
    获取原有页面尺寸Y轴上坐标
    
    返回:
    
    返回当前页面尺寸Y轴上坐标
  - getLastPage
```
public org.apache.pdfbox.pdmodel.PDPage getLastPage()
```
    获取pdfBox最新页面
    
    返回:
    
    返回pdfBox最新页面
  - getCurrentIndex
```
public int getCurrentIndex(XEasyPdfDocument document)
```
    获取当前页面索引
    
    返回:
    
    返回当前页面索引
  - getPageList
```
public List<org.apache.pdfbox.pdmodel.PDPage> getPageList()
```
    获取包含的pdfBox页面列表
    
    返回:
    
    返回包含的pdfBox页面列表
  - getNewPageList
```
public List<org.apache.pdfbox.pdmodel.PDPage> getNewPageList()
```
    获取新增的pdfBox页面列表
    
    返回:
    
    返回新增的pdfBox页面列表
  - disableBackgroundColor
```
public XEasyPdfPage disableBackgroundColor()
```
    关闭背景色
    
    返回:
    
    返回pdf页面
  - disableBackgroundImage
```
public XEasyPdfPage disableBackgroundImage()
```
    关闭背景图片
    
    返回:
    
    返回pdf页面
  - disableWatermark
```
public XEasyPdfPage disableWatermark()
```
    关闭水印
    
    返回:
    
    返回pdf页面
  - disableHeader
```
public XEasyPdfPage disableHeader()
```
    关闭页眉
    
    返回:
    
    返回pdf页面
  - disableFooter
```
public XEasyPdfPage disableFooter()
```
    关闭页脚
    
    返回:
    
    返回pdf页面
  - disableRotateInherentPage
```
public XEasyPdfPage disableRotateInherentPage()
```
    关闭旋转固有页面
    
    返回:
    
    返回pdf页面
  - enablePosition
```
public XEasyPdfPage enablePosition()
```
    开启页面自动重置定位
    
    返回:
    
    返回pdf页面
  - disablePosition
```
public XEasyPdfPage disablePosition()
```
    关闭页面自动重置定位
    
    返回:
    
    返回pdf页面
  - enableResetContext
```
public XEasyPdfPage enableResetContext()
```
    开启重置上下文
    
    返回:
    
    返回pdf页面
  - isAllowResetPosition
```
public boolean isAllowResetPosition()
```
    是否允许重置定位
    
    返回:
    
    返回布尔值，true为是，false为否
  - isAllowHeader
```
public boolean isAllowHeader()
```
    是否允许添加页眉
    
    返回:
    
    返回布尔值，true为是，false为否
  - isAllowFooter
```
public boolean isAllowFooter()
```
    是否允许添加页脚
    
    返回:
    
    返回布尔值，true为是，false为否
  - isAllowWatermark
```
public boolean isAllowWatermark()
```
    是否允许添加水印
    
    返回:
    
    返回布尔值，true为是，false为否
  - isAllowBackgroundImage
```
public boolean isAllowBackgroundImage()
```
    是否允许添加背景图片
    
    返回:
    
    返回布尔值，true为是，false为否
  - isAllowBackgroundColor
```
public boolean isAllowBackgroundColor()
```
    是否允许添加背景色
    
    返回:
    
    返回布尔值，true为是，false为否
  - isAllowRotateInherentPage
```
public boolean isAllowRotateInherentPage()
```
    是否允许旋转固有页面
    
    返回:
    
    返回布尔值，true为是，false为否
  - isResetContext
```
public boolean isResetContext()
```
    是否重置上下文
    
    返回:
    
    返回布尔值，true为是，false为否
  - addNewPage
```
public XEasyPdfPage addNewPage(XEasyPdfDocument document,
                               org.apache.pdfbox.pdmodel.common.PDRectangle pageSize)
```
    添加新页面
    
    参数:
    
    pageSize - 页面尺寸
    
    document - pdf文档
    
    返回:
    
    返回pdf页面
  - addComponent
```
public XEasyPdfPage addComponent(XEasyPdfComponent... components)
```
    添加pdf组件
    
    参数:
    
    components - pdf组件
    
    返回:
    
    返回pdf页面
  - addComponent
```
public XEasyPdfPage addComponent(List<XEasyPdfComponent> components)
```
    添加pdf组件
    
    参数:
    
    components - pdf组件列表
    
    返回:
    
    返回pdf页面
  - modifyPageSize
```
public XEasyPdfPage modifyPageSize(XEasyPdfPageRectangle pageSize)
```
    修改页面尺寸
    
    参数:
    
    pageSize - pdf页面尺寸
    
    返回:
    
    返回pdf页面

类 XEasyPdfPage

嵌套类概要

构造器概要

方法概要

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

构造器详细资料

XEasyPdfPage

方法详细资料

setRotation

setFontPath

getFontPath

getFont

setDefaultFontStyle

setPageX

getPageX

setPageY

getPageY

setContentMode

getContentMode

setBackgroundImage

getBackgroundImage

setBackgroundColor

getBackgroundColor

setWatermark

getWatermark

setHeader

getHeader

setFooter

getFooter

getUnit

getWidth

getHeight

getRectangle

getRectangleLeftX

getRectangleRightX

getRectangleBottomY

getRectangleTopY

getOriginalWidth

getOriginalHeight

getOriginalRectangle

getOriginalRectangleLeftX

getOriginalRectangleRightX

getOriginalRectangleBottomY

getOriginalRectangleTopY

getLastPage

getCurrentIndex

getPageList

getNewPageList

disableBackgroundColor

disableBackgroundImage

disableWatermark

disableHeader

disableFooter

disableRotateInherentPage

enablePosition

disablePosition

enableResetContext

isAllowResetPosition

isAllowHeader

isAllowFooter

isAllowWatermark

isAllowBackgroundImage

isAllowBackgroundColor

isAllowRotateInherentPage

isResetContext

addNewPage

addComponent

addComponent

modifyPageSize