XEasyPdfImage (x-easypdf-pdfbox 2.12.2 API)

java.lang.Object
- org.dromara.pdf.pdfbox.component.image.XEasyPdfImage

所有已实现的接口:

Serializable, XEasyPdfComponent

直接已知子类:

XEasyPdfSVGImage
```
public class XEasyPdfImage
extends Object
implements XEasyPdfComponent
```
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

另请参阅:

序列化表格

嵌套类概要
- 从接口继承的嵌套类/接口 org.dromara.pdf.pdfbox.component.XEasyPdfComponent
  XEasyPdfComponent.ContentMode

构造器概要

构造器
构造器和说明
`XEasyPdfImage(BufferedImage image, XEasyPdfImageType imageType)` 有参构造
`XEasyPdfImage(BufferedImage image, XEasyPdfImageType imageType, int width, int height)` 有参构造
`XEasyPdfImage(File imageFile)` 有参构造
`XEasyPdfImage(File imageFile, int width, int height)` 有参构造
`XEasyPdfImage(InputStream imageStream, XEasyPdfImageType imageType)` 有参构造
`XEasyPdfImage(InputStream imageStream, XEasyPdfImageType imageType, int width, int height)` 有参构造

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`XEasyPdfImage`	`disableSelfAdaption()` 关闭图片大小自适应
`void`	`draw(XEasyPdfDocument document, XEasyPdfPage page)` 绘制
`XEasyPdfImage`	`enableCenterStyle()` 开启居中样式（水平居中，垂直居中）
`XEasyPdfImage`	`enableChildComponent()` 开启子组件
`XEasyPdfImage`	`enableResetContext()` 开启上下文重置
`XEasyPdfImage`	`enableSelfStyle()` 开启自身样式
`XEasyPdfComponent.ContentMode`	`getContentMode()` 获取内容模式
`Integer`	`getHeight(XEasyPdfDocument document, XEasyPdfPage page)` 获取图片高度
`XEasyPdfPositionStyle`	`getHorizontalStyle()` 获取水平样式
`float`	`getMarginBottom()` 获取下边距
`float`	`getMarginLeft()` 获取左边距
`float`	`getMarginRight()` 获取右边距
`float`	`getMarginTop()` 获取上边距
`XEasyPdfPositionStyle`	`getVerticalStyle()` 获取垂直样式
`Integer`	`getWidth(XEasyPdfDocument document, XEasyPdfPage page)` 获取图片宽度
`boolean`	`isCustomRectangle()` 是否自定义尺寸
`boolean`	`isNeedInitialize()` 是否需要初始化
`boolean`	`isUseSelfStyle()` 是否使用自身样式
`XEasyPdfImage`	`setContentMode(XEasyPdfComponent.ContentMode mode)` 设置内容模式
`XEasyPdfImage`	`setHeight(float height)` 设置高度
`XEasyPdfImage`	`setHorizontalStyle(XEasyPdfPositionStyle style)` 设置水平样式（居左、居中、居右）
`XEasyPdfImage`	`setImage(BufferedImage image, XEasyPdfImageType imageType)` 设置图片
`XEasyPdfImage`	`setImage(File imageFile)` 设置图片
`XEasyPdfImage`	`setImage(InputStream imageStream, XEasyPdfImageType imageType)` 设置图片
`XEasyPdfImage`	`setMargin(float margin)` 设置边距（上下左右）
`XEasyPdfImage`	`setMarginBottom(float margin)` 设置下边距
`XEasyPdfImage`	`setMarginLeft(float margin)` 设置左边距
`XEasyPdfImage`	`setMarginRight(float margin)` 设置右边距
`XEasyPdfImage`	`setMarginTop(float margin)` 设置上边距
`XEasyPdfImage`	`setMaxHeight(float maxHeight)` 设置最大高度
`XEasyPdfImage`	`setMaxWidth(float maxWidth)` 设置最大宽度
`XEasyPdfImage`	`setNeedInitialize(boolean needInitialize)` 设置是否需要初始化
`XEasyPdfImage`	`setPosition(float beginX, float beginY)` 设置定位
`XEasyPdfImage`	`setRadians(double radians)` 设置旋转弧度
`XEasyPdfImage`	`setVerticalStyle(XEasyPdfPositionStyle style)` 设置垂直样式（居上、居中、居下）
`XEasyPdfImage`	`setWidth(float width)` 设置宽度

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

- 构造器详细资料
  - XEasyPdfImage
```
public XEasyPdfImage(File imageFile)
```
    有参构造
    
    参数:
    
    imageFile - 待添加图片
  - XEasyPdfImage
```
public XEasyPdfImage(InputStream imageStream,
                     XEasyPdfImageType imageType)
```
    有参构造
    
    参数:
    
    imageStream - 待添加图片数据流
    
    imageType - 待添加图片类型（扩展名）
  - XEasyPdfImage
```
public XEasyPdfImage(BufferedImage image,
                     XEasyPdfImageType imageType)
```
    有参构造
    
    参数:
    
    image - 待添加图片
    
    imageType - 待添加图片类型（扩展名）
  - XEasyPdfImage
```
public XEasyPdfImage(File imageFile,
                     int width,
                     int height)
```
    有参构造
    
    参数:
    
    imageFile - 待添加图片
    
    width - 图片宽度
    
    height - 图片高度
  - XEasyPdfImage
```
public XEasyPdfImage(InputStream imageStream,
                     XEasyPdfImageType imageType,
                     int width,
                     int height)
```
    有参构造
    
    参数:
    
    imageStream - 待添加图片数据流
    
    imageType - 待添加图片类型（扩展名）
    
    width - 图片宽度
    
    height - 图片高度
  - XEasyPdfImage
```
public XEasyPdfImage(BufferedImage image,
                     XEasyPdfImageType imageType,
                     int width,
                     int height)
```
    有参构造
    
    参数:
    
    image - 待添加图片
    
    imageType - 待添加图片类型（扩展名）
    
    width - 图片宽度
    
    height - 图片高度
- 方法详细资料
  - setImage
```
public XEasyPdfImage setImage(File imageFile)
```
    设置图片
    
    参数:
    
    imageFile - 待添加图片
    
    返回:
    
    返回图片组件
  - setImage
```
public XEasyPdfImage setImage(BufferedImage image,
                              XEasyPdfImageType imageType)
```
    设置图片
    
    参数:
    
    image - 待添加图片
    
    imageType - 待添加图片类型
    
    返回:
    
    返回图片组件
  - setImage
```
public XEasyPdfImage setImage(InputStream imageStream,
                              XEasyPdfImageType imageType)
```
    设置图片
    
    参数:
    
    imageStream - 待添加图片数据流
    
    imageType - 待添加图片类型
    
    返回:
    
    返回图片组件
  - disableSelfAdaption
```
public XEasyPdfImage disableSelfAdaption()
```
    关闭图片大小自适应
    
    返回:
    
    返回图片组件
  - enableSelfStyle
```
public XEasyPdfImage enableSelfStyle()
```
    开启自身样式
    
    返回:
    
    返回图片组件
  - enableCenterStyle
```
public XEasyPdfImage enableCenterStyle()
```
    开启居中样式（水平居中，垂直居中）
    
    返回:
    
    返回图片组件
  - enableChildComponent
```
public XEasyPdfImage enableChildComponent()
```
    开启子组件
    
    返回:
    
    返回图片组件
  - enableResetContext
```
public XEasyPdfImage enableResetContext()
```
    开启上下文重置
    
    指定者:
    
    enableResetContext 在接口中 XEasyPdfComponent
    
    返回:
    
    返回图片组件
  - setNeedInitialize
```
public XEasyPdfImage setNeedInitialize(boolean needInitialize)
```
    设置是否需要初始化
    
    参数:
    
    needInitialize - 是否需要初始化
    
    返回:
    
    返回图片组件
  - setRadians
```
public XEasyPdfImage setRadians(double radians)
```
    设置旋转弧度
    
    参数:
    
    radians - 图片弧度
    
    返回:
    
    返回图片组件
  - setMaxWidth
```
public XEasyPdfImage setMaxWidth(float maxWidth)
```
    设置最大宽度
    
    参数:
    
    maxWidth - 最大宽度
    
    返回:
    
    返回图片组件
  - setMaxHeight
```
public XEasyPdfImage setMaxHeight(float maxHeight)
```
    设置最大高度
    
    参数:
    
    maxHeight - 最大高度
    
    返回:
    
    返回图片组件
  - setMargin
```
public XEasyPdfImage setMargin(float margin)
```
    设置边距（上下左右）
    
    参数:
    
    margin - 边距
    
    返回:
    
    返回图片组件
  - setMarginLeft
```
public XEasyPdfImage setMarginLeft(float margin)
```
    设置左边距
    
    参数:
    
    margin - 边距
    
    返回:
    
    返回图片组件
  - setMarginRight
```
public XEasyPdfImage setMarginRight(float margin)
```
    设置右边距
    
    参数:
    
    margin - 边距
    
    返回:
    
    返回图片组件
  - setMarginTop
```
public XEasyPdfImage setMarginTop(float margin)
```
    设置上边距
    
    参数:
    
    margin - 边距
    
    返回:
    
    返回图片组件
  - setMarginBottom
```
public XEasyPdfImage setMarginBottom(float margin)
```
    设置下边距
    
    参数:
    
    margin - 边距
    
    返回:
    
    返回图片组件
  - setHorizontalStyle
```
public XEasyPdfImage setHorizontalStyle(XEasyPdfPositionStyle style)
```
    设置水平样式（居左、居中、居右）
    
    参数:
    
    style - 样式
    
    返回:
    
    返回图片组件
  - setVerticalStyle
```
public XEasyPdfImage setVerticalStyle(XEasyPdfPositionStyle style)
```
    设置垂直样式（居上、居中、居下）
    
    参数:
    
    style - 样式
    
    返回:
    
    返回图片组件
  - setPosition
```
public XEasyPdfImage setPosition(float beginX,
                                 float beginY)
```
    设置定位
    
    指定者:
    
    setPosition 在接口中 XEasyPdfComponent
    
    参数:
    
    beginX - 当前页面X轴坐标
    
    beginY - 当前页面Y轴坐标
    
    返回:
    
    返回图片组件
  - setWidth
```
public XEasyPdfImage setWidth(float width)
```
    设置宽度
    
    指定者:
    
    setWidth 在接口中 XEasyPdfComponent
    
    参数:
    
    width - 宽度
    
    返回:
    
    返回图片组件
  - setHeight
```
public XEasyPdfImage setHeight(float height)
```
    设置高度
    
    指定者:
    
    setHeight 在接口中 XEasyPdfComponent
    
    参数:
    
    height - 高度
    
    返回:
    
    返回图片组件
  - setContentMode
```
public XEasyPdfImage setContentMode(XEasyPdfComponent.ContentMode mode)
```
    设置内容模式
    
    指定者:
    
    setContentMode 在接口中 XEasyPdfComponent
    
    参数:
    
    mode - 内容模式
    
    返回:
    
    返回图片组件
  - draw
```
public void draw(XEasyPdfDocument document,
                 XEasyPdfPage page)
```
    绘制
    
    指定者:
    
    draw 在接口中 XEasyPdfComponent
    
    参数:
    
    document - pdf文档
    
    page - pdf页面
  - getContentMode
```
public XEasyPdfComponent.ContentMode getContentMode()
```
    获取内容模式
    
    返回:
    
    返回内容模式
  - getWidth
```
public Integer getWidth(XEasyPdfDocument document,
                        XEasyPdfPage page)
```
    获取图片宽度
    
    参数:
    
    document - pdf文档
    
    page - pdf页面
    
    返回:
    
    返回图片宽度
  - getHeight
```
public Integer getHeight(XEasyPdfDocument document,
                         XEasyPdfPage page)
```
    获取图片高度
    
    参数:
    
    document - pdf文档
    
    page - pdf页面
    
    返回:
    
    返回图片高度
  - getMarginTop
```
public float getMarginTop()
```
    获取上边距
    
    返回:
    
    返回上边距
  - getMarginBottom
```
public float getMarginBottom()
```
    获取下边距
    
    返回:
    
    返回下边距
  - getMarginLeft
```
public float getMarginLeft()
```
    获取左边距
    
    返回:
    
    返回左边距
  - getMarginRight
```
public float getMarginRight()
```
    获取右边距
    
    返回:
    
    返回右边距
  - getHorizontalStyle
```
public XEasyPdfPositionStyle getHorizontalStyle()
```
    获取水平样式
    
    返回:
    
    返回图片样式
  - getVerticalStyle
```
public XEasyPdfPositionStyle getVerticalStyle()
```
    获取垂直样式
    
    返回:
    
    返回图片样式
  - isUseSelfStyle
```
public boolean isUseSelfStyle()
```
    是否使用自身样式
    
    返回:
    
    返回布尔值，是为true，否为false
  - isCustomRectangle
```
public boolean isCustomRectangle()
```
    是否自定义尺寸
    
    返回:
    
    返回布尔值，是为true，否为false
  - isNeedInitialize
```
public boolean isNeedInitialize()
```
    是否需要初始化
    
    返回:
    
    返回布尔值，是为true，否为false

类 XEasyPdfImage

嵌套类概要

从接口继承的嵌套类/接口 org.dromara.pdf.pdfbox.component.XEasyPdfComponent

构造器概要

方法概要

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

构造器详细资料

XEasyPdfImage

XEasyPdfImage

XEasyPdfImage

XEasyPdfImage

XEasyPdfImage

XEasyPdfImage

方法详细资料

setImage

setImage

setImage

disableSelfAdaption

enableSelfStyle

enableCenterStyle

enableChildComponent

enableResetContext

setNeedInitialize

setRadians

setMaxWidth

setMaxHeight

setMargin

setMarginLeft

setMarginRight

setMarginTop

setMarginBottom

setHorizontalStyle

setVerticalStyle

setPosition

setWidth

setHeight

setContentMode

draw

getContentMode

getWidth

getHeight

getMarginTop

getMarginBottom

getMarginLeft

getMarginRight

getHorizontalStyle

getVerticalStyle

isUseSelfStyle

isCustomRectangle

isNeedInitialize