WatermarkDrawer (OFDRW Layout 2.3.8 API)

java.lang.Object
- org.ofdrw.layout.edit.WatermarkDrawer

All Implemented Interfaces:

Drawer
```
public class WatermarkDrawer
extends Object
implements Drawer
```
水印绘制器

Since:

2024-04-18 13:18

Author:

bhzhange

Constructor Summary

Constructors
Constructor and Description

WatermarkDrawer()
初始化一个水印绘制器

Constructors
Constructor and Description
`WatermarkDrawer()` 初始化一个水印绘制器

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`draw(DrawContext ctx)` 绘制水印
`Double`	`getAngle()` 获取旋转角度
`Annotation`	`getAnnotation()` 水印注释信息
`Boolean`	`getBold()` 是否加粗
`String`	`getColor()` 获取文字颜色
`String`	`getFontName()` 获取字体名称
`double`	`getFontSize()` 获取字号
`String`	`getFontWeight()` 获取字体宽度
`Double`	`getGlobalAlpha()` 获取透明度
`Double`	`getIntervalX()` 获取横向间隔
`Double`	`getIntervalY()` 获取水印纵向间距，单位mm
`Boolean`	`getItalic()` 是否斜体
`Double`	`getLetterSpacing()` 获取文字之间的间距
`String`	`getValue()` 水印文字内容
`boolean`	`isDEBUG()` 是否调试
`void`	`setAngle(Double angle)` 设置旋转角度，基于坐标系(0,1)方向，向第4象限偏移的角度。与数学意义上的弧度角度存在
`void`	`setAnnotation(Annotation annotation)` 设置水印注释信息
`void`	`setBold(Boolean bold)` 设置是否加粗
`void`	`setColor(String color)` 设置文字颜色
`void`	`setDEBUG(boolean DEBUG)` 设置调试状态
`WatermarkDrawer`	`setFont(String fontName, Path fontPath)` 设置单元格绘制器使用的外部字体
`void`	`setFontName(String fontName)` 设置字体名称
`void`	`setFontSize(double fontSize)` 设置字号
`void`	`setFontWeight(String fontWeight)` 设置字体宽度
`void`	`setGlobalAlpha(Double globalAlpha)` 设置透明度
`void`	`setIntervalX(Double intervalX)` 设置水印横向间距
`void`	`setIntervalY(Double intervalY)` 设置水印纵向间距
`void`	`setItalic(Boolean italic)` 设置是否斜体
`void`	`setLetterSpacing(Double letterSpacing)` 设置文字之间的间距
`void`	`setValue(String value)` 设置水印文字内容

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - WatermarkDrawer
```
public WatermarkDrawer()
```
    初始化一个水印绘制器
- Method Detail
  - draw
```
public void draw(DrawContext ctx)
          throws IOException
```
    绘制水印
    
    Specified by:
    
    draw in interface Drawer
    
    Parameters:
    
    ctx - 绘制上下文
    
    Throws:
    
    IOException - ignore
  - getValue
```
public String getValue()
```
    水印文字内容
    
    Returns:
    
    水印文字内容
  - setValue
```
public void setValue(String value)
```
    设置水印文字内容
    
    Parameters:
    
    value - 水印文字内容
  - getColor
```
public String getColor()
```
    获取文字颜色
    
    Returns:
    
    颜色值
  - setColor
```
public void setColor(String color)
```
    设置文字颜色
    
    Parameters:
    
    color - 符合CSS3样式的颜色值被支持，可选值颜色英文单词,例如red,blue、16进制颜色值，#000000、rgb(0,0,0)、rgba(0,0,0,1)
  - getFontName
```
public String getFontName()
```
    获取字体名称
    
    Returns:
    
    字体名称
  - setFontName
```
public void setFontName(String fontName)
```
    设置字体名称
    
    Parameters:
    
    fontName - 字体名称
  - getFontSize
```
public double getFontSize()
```
    获取字号
    
    Returns:
    
    字号，单位 mm
  - setFontSize
```
public void setFontSize(double fontSize)
```
    设置字号
    
    Parameters:
    
    fontSize - 字号，单位 mm
  - getBold
```
public Boolean getBold()
```
    是否加粗
    
    Returns:
    
    是否加粗
  - setBold
```
public void setBold(Boolean bold)
```
    设置是否加粗
    
    Parameters:
    
    bold - 是否加粗
  - getFontWeight
```
public String getFontWeight()
```
    获取字体宽度
    
    Returns:
    
    字体宽度，如：normal、bold、bolder、lighter、100、200、300、400、500、600、700、800、900
  - setFontWeight
```
public void setFontWeight(String fontWeight)
```
    设置字体宽度
    
    Parameters:
    
    fontWeight - 字体宽度，如：normal、bold、bolder、lighter、100、200、300、400、500、600、700、800、900
  - getItalic
```
public Boolean getItalic()
```
    是否斜体
    
    Returns:
    
    是否斜体
  - setItalic
```
public void setItalic(Boolean italic)
```
    设置是否斜体
    
    Parameters:
    
    italic - 是否斜体
  - getLetterSpacing
```
public Double getLetterSpacing()
```
    获取文字之间的间距
    
    Returns:
    
    文字之间的间距，单位mm
  - setLetterSpacing
```
public void setLetterSpacing(Double letterSpacing)
```
    设置文字之间的间距
    
    Parameters:
    
    letterSpacing - 文字之间的间距，单位mm
  - getGlobalAlpha
```
public Double getGlobalAlpha()
```
    获取透明度
    
    Returns:
    
    透明度，0.0~1.0
  - setGlobalAlpha
```
public void setGlobalAlpha(Double globalAlpha)
```
    设置透明度
    
    Parameters:
    
    globalAlpha - 透明度，0.0~1.0
  - getAngle
```
public Double getAngle()
```
    获取旋转角度
    
    Returns:
    
    旋转角度，0-360, 默认330（-30）
  - setAngle
```
public void setAngle(Double angle)
```
    设置旋转角度，基于坐标系(0,1)方向，向第4象限偏移的角度。与数学意义上的弧度角度存在
    
    Parameters:
    
    angle - 旋转角度，0-360, 默认330（-30）
  - getIntervalX
```
public Double getIntervalX()
```
    获取横向间隔
    
    Returns:
    
    横向间隔，单位mm
  - setIntervalX
```
public void setIntervalX(Double intervalX)
```
    设置水印横向间距
    
    Parameters:
    
    intervalX - 横向间距，单位mm
  - getIntervalY
```
public Double getIntervalY()
```
    获取水印纵向间距，单位mm
    
    Returns:
    
    水印纵向间距，单位mm
  - setIntervalY
```
public void setIntervalY(Double intervalY)
```
    设置水印纵向间距
    
    Parameters:
    
    intervalY - 纵向间距，单位mm
  - isDEBUG
```
public boolean isDEBUG()
```
    是否调试
    
    Returns:
    
    是否调试 true - 调试模式绘制边框 false - 非调试模式
  - setDEBUG
```
public void setDEBUG(boolean DEBUG)
```
    设置调试状态
    
    Parameters:
    
    DEBUG - 是否调试 true - 调试模式绘制边框 false - 非调试模式
  - getAnnotation
```
public Annotation getAnnotation()
```
    水印注释信息
    
    Returns:
    
    水印注释对象，Annotation 的实现实例
  - setAnnotation
```
public void setAnnotation(Annotation annotation)
```
    设置水印注释信息
    
    Parameters:
    
    annotation - 水印注释对象，Annotation 的实现实例
  - setFont
```
public WatermarkDrawer setFont(String fontName,
                               Path fontPath)
```
    设置单元格绘制器使用的外部字体
    注意OFDRW不会提供任何字体裁剪功能，您的字体文件将直接加入OFD文件中，这可能造成文件体积剧增。
    
    Parameters:
    
    fontName - 字体名称，如“思源宋体”
    
    fontPath - 字体文件所在路径
    
    Returns:
    
    this

Class WatermarkDrawer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WatermarkDrawer

Method Detail

draw

getValue

setValue

getColor

setColor

getFontName

setFontName

getFontSize

setFontSize

getBold

setBold

getFontWeight

setFontWeight

getItalic

setItalic

getLetterSpacing

setLetterSpacing

getGlobalAlpha

setGlobalAlpha

getAngle

setAngle

getIntervalX

setIntervalX

getIntervalY

setIntervalY

isDEBUG

setDEBUG

getAnnotation

setAnnotation

setFont