Watermark (x-easypdf-fop 3.1.0 API)

java.lang.Object
- org.dromara.pdf.fop.core.doc.watermark.Watermark

所有已实现的接口:

WatermarkComponent
```
public class Watermark
extends Object
implements WatermarkComponent
```
pdf模板-水印（文字）组件

从以下版本开始:

1.8
Copyright (c) 2020 xsx All Rights Reserved. x-easypdf-fop 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

构造器概要

构造器
构造器和说明

Watermark()

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

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`createWatermark(Document document, Element element)` 创建水印
`Watermark`	`enableOverwrite()` 开启覆盖
`void`	`saveImage()` 保存水印图像
`Watermark`	`setFontAlpha(String alpha)` 设置字体透明度 0-255之间，值越小越透明
`Watermark`	`setFontColor(String color)` 设置字体颜色 color：颜色（名称或16进制颜色） transparent：透明
`Watermark`	`setFontFamily(String fontFamily)` 设置字体名称
`Watermark`	`setFontSize(String fontSize)` 设置字体大小
`Watermark`	`setFontStyle(String fontStyle)` 设置字体样式 normal：正常 oblique：斜体 italic：斜体 backslant：斜体
`Watermark`	`setHeight(String height)` 设置图像高度
`Watermark`	`setHorizontalPosition(String position)` 设置背景图片水平定位
`Watermark`	`setId(String id)` 设置水印id
`Watermark`	`setPosition(String position)` 设置背景图片定位第一个参数为X轴第二个参数为Y轴
`Watermark`	`setRadians(String radians)` 设置旋转弧度
`Watermark`	`setRepeat(String repeat)` 设置背景图片重复 repeat：水平垂直重复 repeat-x：水平重复 repeat-y：垂直重复 no-repeat：不重复
`Watermark`	`setShowHeight(String height)` 设置图像显示高度
`Watermark`	`setShowWidth(String width)` 设置图像显示宽度
`Watermark`	`setTempDir(String tempDir)` 设置临时目录
`Watermark`	`setText(List<String> texts)` 设置文本列表
`Watermark`	`setText(String... texts)` 设置文本列表
`Watermark`	`setVerticalPosition(String position)` 设置背景图片垂直定位
`Watermark`	`setWidth(String width)` 设置图像宽度

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

- 构造器详细资料
  - Watermark
```
public Watermark()
```
- 方法详细资料
  - setTempDir
```
public Watermark setTempDir(String tempDir)
```
    设置临时目录
    
    参数:
    
    tempDir - 临时目录
    
    返回:
    
    返回水印（文字）组件
  - setId
```
public Watermark setId(String id)
```
    设置水印id
    
    参数:
    
    id - 水印id须唯一
    
    返回:
    
    返回水印（文字）组件
  - setWidth
```
public Watermark setWidth(String width)
```
    设置图像宽度
    
    参数:
    
    width - 图像宽度
    
    返回:
    
    返回水印（文字）组件
  - setHeight
```
public Watermark setHeight(String height)
```
    设置图像高度
    
    参数:
    
    height - 图像高度
    
    返回:
    
    返回水印（文字）组件
  - setShowWidth
```
public Watermark setShowWidth(String width)
```
    设置图像显示宽度
    
    参数:
    
    width - 图像显示宽度
    
    返回:
    
    返回水印（文字）组件
  - setShowHeight
```
public Watermark setShowHeight(String height)
```
    设置图像显示高度
    
    参数:
    
    height - 图像显示高度
    
    返回:
    
    返回水印（文字）组件
  - setFontFamily
```
public Watermark setFontFamily(String fontFamily)
```
    设置字体名称
    
    参数:
    
    fontFamily - 字体名称
    
    返回:
    
    返回水印（文字）组件
  - setFontStyle
```
public Watermark setFontStyle(String fontStyle)
```
    设置字体样式
    normal：正常
    
    oblique：斜体
    
    italic：斜体
    
    backslant：斜体
    
    参数:
    
    fontStyle - 字体样式
    
    返回:
    
    返回水印（文字）组件
  - setFontSize
```
public Watermark setFontSize(String fontSize)
```
    设置字体大小
    
    参数:
    
    fontSize - 字体大小
    
    返回:
    
    返回水印（文字）组件
  - setFontColor
```
public Watermark setFontColor(String color)
```
    设置字体颜色
    color：颜色（名称或16进制颜色）
    
    transparent：透明
    
    参数:
    
    color - 字体颜色
    
    返回:
    
    返回水印（文字）组件
  - setFontAlpha
```
public Watermark setFontAlpha(String alpha)
```
    设置字体透明度
    0-255之间，值越小越透明
    
    参数:
    
    alpha - 字体透明度
    
    返回:
    
    返回水印（文字）组件
  - setPosition
```
public Watermark setPosition(String position)
```
    设置背景图片定位
    第一个参数为X轴
    
    第二个参数为Y轴
    
    参数:
    
    position - 定位
    
    返回:
    
    返回水印（文字）组件
  - setHorizontalPosition
```
public Watermark setHorizontalPosition(String position)
```
    设置背景图片水平定位
    
    参数:
    
    position - 定位
    
    返回:
    
    返回水印（文字）组件
  - setVerticalPosition
```
public Watermark setVerticalPosition(String position)
```
    设置背景图片垂直定位
    
    参数:
    
    position - 定位
    
    返回:
    
    返回水印（文字）组件
  - setRepeat
```
public Watermark setRepeat(String repeat)
```
    设置背景图片重复
    repeat：水平垂直重复
    
    repeat-x：水平重复
    
    repeat-y：垂直重复
    
    no-repeat：不重复
    
    参数:
    
    repeat - 重复
    
    返回:
    
    返回水印（文字）组件
  - setRadians
```
public Watermark setRadians(String radians)
```
    设置旋转弧度
    
    参数:
    
    radians - 旋转弧度
    
    返回:
    
    返回水印（文字）组件
  - enableOverwrite
```
public Watermark enableOverwrite()
```
    开启覆盖
    
    返回:
    
    返回水印（文字）组件
  - setText
```
public Watermark setText(String... texts)
```
    设置文本列表
    
    参数:
    
    texts - 文本列表
    
    返回:
    
    返回水印（文字）组件
  - setText
```
public Watermark setText(List<String> texts)
```
    设置文本列表
    
    参数:
    
    texts - 文本列表
    
    返回:
    
    返回水印（文字）组件
  - saveImage
```
public void saveImage()
```
    保存水印图像
  - createWatermark
```
public void createWatermark(Document document,
                            Element element)
```
    创建水印
    
    指定者:
    
    createWatermark 在接口中 WatermarkComponent
    
    参数:
    
    document - fo文档
    
    element - fo元素

类 Watermark

构造器概要

方法概要

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

构造器详细资料

Watermark

方法详细资料

setTempDir

setId

setWidth

setHeight

setShowWidth

setShowHeight

setFontFamily

setFontStyle

setFontSize

setFontColor

setFontAlpha

setPosition

setHorizontalPosition

setVerticalPosition

setRepeat

setRadians

enableOverwrite

setText

setText

saveImage

createWatermark