XEasyPdfTemplateImage (x-easypdf-fop 2.12.2 API)

java.lang.Object
- org.dromara.pdf.fop.doc.component.image.XEasyPdfTemplateImage

所有已实现的接口:

XEasyPdfTemplateComponent
```
public class XEasyPdfTemplateImage
extends Object
implements XEasyPdfTemplateComponent
```
pdf模板-图像组件
fo:external-graphic

从以下版本开始:

1.8
Copyright (c) 2020-2023 xsx All Rights Reserved. x-easypdf is licensed under the 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

构造器概要

构造器
构造器和说明

XEasyPdfTemplateImage()

构造器
构造器和说明
`XEasyPdfTemplateImage()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`Element`	`createElement(Document document)` 创建元素
`XEasyPdfTemplateImage`	`enableBorder()` 开启边框（调试时使用）
`XEasyPdfTemplateImage`	`enableKeepTogether()` 开启分页时保持
`XEasyPdfTemplateImage`	`enableKeepWithNext()` 开启分页时与下一个元素保持
`XEasyPdfTemplateImage`	`enableKeepWithPrevious()` 开启分页时与上一个元素保持
`XEasyPdfTemplateImage`	`setBreakAfter(String breakAfter)` 设置分页符-后 auto：自动 column：分列 page：分页 even-page：在元素之后强制分页一次或两个，以便下一页将成为偶数页 odd-page：在元素之后强制分页一次或两个，以便下一页将成为奇数页
`XEasyPdfTemplateImage`	`setBreakBefore(String breakBefore)` 设置分页符-前 auto：自动 column：分列 page：分页 even-page：在元素之前强制分页一次或两个，以便下一页将成为偶数页 odd-page：在元素之前强制分页一次或两个，以便下一页将成为奇数页
`XEasyPdfTemplateImage`	`setHeight(String height)` 设置高度
`XEasyPdfTemplateImage`	`setHorizontalStyle(String style)` 设置水平样式 left：居左 center：居中 right：居右
`XEasyPdfTemplateImage`	`setId(String id)` 设置id
`XEasyPdfTemplateImage`	`setMargin(String margin)` 设置上下左右边距
`XEasyPdfTemplateImage`	`setMarginBottom(String marginBottom)` 设置下边距
`XEasyPdfTemplateImage`	`setMarginLeft(String marginLeft)` 设置左边距
`XEasyPdfTemplateImage`	`setMarginRight(String paddingRight)` 设置右边距
`XEasyPdfTemplateImage`	`setMarginTop(String marginTop)` 设置上边距
`XEasyPdfTemplateImage`	`setPadding(String padding)` 设置上下左右填充
`XEasyPdfTemplateImage`	`setPaddingBottom(String paddingBottom)` 设置下填充
`XEasyPdfTemplateImage`	`setPaddingLeft(String paddingLeft)` 设置左填充
`XEasyPdfTemplateImage`	`setPaddingRight(String paddingRight)` 设置右填充
`XEasyPdfTemplateImage`	`setPaddingTop(String paddingTop)` 设置上填充
`XEasyPdfTemplateImage`	`setPath(String path)` 设置图像路径注：当为windows系统绝对路径时，须添加前缀“/”，例如：”/E:\test\test.png“
`XEasyPdfTemplateImage`	`setWidth(String width)` 设置宽度

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

从接口继承的方法 org.dromara.pdf.fop.doc.component.XEasyPdfTemplateComponent
appendChild, createBlockElement, createBlockElement, createEmptyElement, transform

- 构造器详细资料
  - XEasyPdfTemplateImage
```
public XEasyPdfTemplateImage()
```
- 方法详细资料
  - setMargin
```
public XEasyPdfTemplateImage setMargin(String margin)
```
    设置上下左右边距
    
    参数:
    
    margin - 边距
    
    返回:
    
    返回图像组件
  - setMarginTop
```
public XEasyPdfTemplateImage setMarginTop(String marginTop)
```
    设置上边距
    
    参数:
    
    marginTop - 上边距
    
    返回:
    
    返回图像组件
  - setMarginBottom
```
public XEasyPdfTemplateImage setMarginBottom(String marginBottom)
```
    设置下边距
    
    参数:
    
    marginBottom - 下边距
    
    返回:
    
    返回图像组件
  - setMarginLeft
```
public XEasyPdfTemplateImage setMarginLeft(String marginLeft)
```
    设置左边距
    
    参数:
    
    marginLeft - 左边距
    
    返回:
    
    返回图像组件
  - setMarginRight
```
public XEasyPdfTemplateImage setMarginRight(String paddingRight)
```
    设置右边距
    
    参数:
    
    paddingRight - 右边距
    
    返回:
    
    返回图像组件
  - setPadding
```
public XEasyPdfTemplateImage setPadding(String padding)
```
    设置上下左右填充
    
    参数:
    
    padding - 填充
    
    返回:
    
    返回图像组件
  - setPaddingTop
```
public XEasyPdfTemplateImage setPaddingTop(String paddingTop)
```
    设置上填充
    
    参数:
    
    paddingTop - 上填充
    
    返回:
    
    返回图像组件
  - setPaddingBottom
```
public XEasyPdfTemplateImage setPaddingBottom(String paddingBottom)
```
    设置下填充
    
    参数:
    
    paddingBottom - 下填充
    
    返回:
    
    返回图像组件
  - setPaddingLeft
```
public XEasyPdfTemplateImage setPaddingLeft(String paddingLeft)
```
    设置左填充
    
    参数:
    
    paddingLeft - 左填充
    
    返回:
    
    返回图像组件
  - setPaddingRight
```
public XEasyPdfTemplateImage setPaddingRight(String paddingRight)
```
    设置右填充
    
    参数:
    
    paddingRight - 右填充
    
    返回:
    
    返回图像组件
  - setId
```
public XEasyPdfTemplateImage setId(String id)
```
    设置id
    
    参数:
    
    id - id
    
    返回:
    
    返回图像组件
  - setWidth
```
public XEasyPdfTemplateImage setWidth(String width)
```
    设置宽度
    
    参数:
    
    width - 宽度
    
    返回:
    
    返回图像组件
  - setHeight
```
public XEasyPdfTemplateImage setHeight(String height)
```
    设置高度
    
    参数:
    
    height - 高度
    
    返回:
    
    返回图像组件
  - setPath
```
public XEasyPdfTemplateImage setPath(String path)
```
    设置图像路径
    注：当为windows系统绝对路径时，须添加前缀“/”，例如：”/E:\test\test.png“
    
    参数:
    
    path - 图像路径
    
    返回:
    
    返回图像组件
  - setHorizontalStyle
```
public XEasyPdfTemplateImage setHorizontalStyle(String style)
```
    设置水平样式
    left：居左
    
    center：居中
    
    right：居右
    
    参数:
    
    style - 水平样式
    
    返回:
    
    返回图像组件
  - setBreakBefore
```
public XEasyPdfTemplateImage setBreakBefore(String breakBefore)
```
    设置分页符-前
    auto：自动
    
    column：分列
    
    page：分页
    
    even-page：在元素之前强制分页一次或两个，以便下一页将成为偶数页
    
    odd-page：在元素之前强制分页一次或两个，以便下一页将成为奇数页
    
    参数:
    
    breakBefore - 分页符
    
    返回:
    
    返回图像组件
  - setBreakAfter
```
public XEasyPdfTemplateImage setBreakAfter(String breakAfter)
```
    设置分页符-后
    auto：自动
    
    column：分列
    
    page：分页
    
    even-page：在元素之后强制分页一次或两个，以便下一页将成为偶数页
    
    odd-page：在元素之后强制分页一次或两个，以便下一页将成为奇数页
    
    参数:
    
    breakAfter - 分页符
    
    返回:
    
    返回图像组件
  - enableKeepTogether
```
public XEasyPdfTemplateImage enableKeepTogether()
```
    开启分页时保持
    
    返回:
    
    返回图像组件
  - enableKeepWithPrevious
```
public XEasyPdfTemplateImage enableKeepWithPrevious()
```
    开启分页时与上一个元素保持
    
    返回:
    
    返回图像组件
  - enableKeepWithNext
```
public XEasyPdfTemplateImage enableKeepWithNext()
```
    开启分页时与下一个元素保持
    
    返回:
    
    返回图像组件
  - enableBorder
```
public XEasyPdfTemplateImage enableBorder()
```
    开启边框（调试时使用）
    
    返回:
    
    返回图像组件
  - createElement
```
public Element createElement(Document document)
```
    创建元素
    
    指定者:
    
    createElement 在接口中 XEasyPdfTemplateComponent
    
    参数:
    
    document - fo文档
    
    返回:
    
    返回元素

类 XEasyPdfTemplateImage

构造器概要

方法概要

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

从接口继承的方法 org.dromara.pdf.fop.doc.component.XEasyPdfTemplateComponent

构造器详细资料

XEasyPdfTemplateImage

方法详细资料

setMargin

setMarginTop

setMarginBottom

setMarginLeft

setMarginRight

setPadding

setPaddingTop

setPaddingBottom

setPaddingLeft

setPaddingRight

setId

setWidth

setHeight

setPath

setHorizontalStyle

setBreakBefore

setBreakAfter

enableKeepTogether

enableKeepWithPrevious

enableKeepWithNext

enableBorder

createElement