WaterMark (Excel Write/Read Framework 0.5.21 API)

java.lang.Object
- org.ttzero.excel.entity.WaterMark

```
public class WaterMark
extends Object
```
水印，Excel并没有水印功能，本工具的水印功能是使用Excel的背景实现，打印的时候该背景会被忽略。
注意：只接受FileSignatures.whitelist白名单的图片格式

作者:

guanquan.wang at 2018-01-26 15:23

构造器概要

构造器
构造器和说明
`WaterMark(InputStream inputStream)` 使用图片流创建水印，可以下载远程图片创建水印
`WaterMark(Path imagePath)` 使用本地图片创建水印
`WaterMark(String word)` 使用一段文本创建水印

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`boolean`	`canWrite()` 测试水印图片是否可输出
`boolean`	`delete()` 删除临时文件，传入InputStream或文本时会保存到临时文件，所以需要清理资源
`Path`	`get()` 获取水印图片路径
`String`	`getContentType()` 水印图片Content-type
`String`	`getSuffix()` 获取水印图片的后缀
`static WaterMark`	`of(InputStream is)` 使用图片流创建水印，可以下载远程图片创建水印
`static WaterMark`	`of(Path path)` 使用本地图片创建水印
`static WaterMark`	`of(String mark)` 使用一段文本创建水印

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

- 构造器详细资料
  - WaterMark
```
public WaterMark(String word)
```
    使用一段文本创建水印
    
    参数:
    
    word - 一段有意义的文本
  - WaterMark
```
public WaterMark(Path imagePath)
```
    使用本地图片创建水印
    
    参数:
    
    imagePath - 图片的本地文件
  - WaterMark
```
public WaterMark(InputStream inputStream)
          throws IOException
```
    使用图片流创建水印，可以下载远程图片创建水印
    
    参数:
    
    inputStream - 图片流
    
    抛出:
    
    IOException - 读取流异常
- 方法详细资料
  - get
```
public Path get()
```
    获取水印图片路径
    
    返回:
    
    水印图片临时路径，
  - of
```
public static WaterMark of(String mark)
```
    使用一段文本创建水印
    
    参数:
    
    mark - 文本
    
    返回:
    
    水印对象
  - of
```
public static WaterMark of(Path path)
```
    使用本地图片创建水印
    
    参数:
    
    path - 图片的本地文件
    
    返回:
    
    水印对象WaterMark
  - of
```
public static WaterMark of(InputStream is)
                    throws IOException
```
    使用图片流创建水印，可以下载远程图片创建水印
    
    参数:
    
    is - 图片流
    
    返回:
    
    水印对象WaterMark
    
    抛出:
    
    IOException - 读取流异常
  - delete
```
public boolean delete()
```
    删除临时文件，传入InputStream或文本时会保存到临时文件，所以需要清理资源
    
    返回:
    
    出异常时返回false
  - getSuffix
```
public String getSuffix()
```
    获取水印图片的后缀
    
    返回:
    
    水印图片后缀
  - getContentType
```
public String getContentType()
```
    水印图片Content-type
    
    返回:
    
    Content-type
  - canWrite
```
public boolean canWrite()
```
    测试水印图片是否可输出
    
    返回:
    
    true: 资源可信任输出到Excel

类 WaterMark

构造器概要

方法概要

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

构造器详细资料

WaterMark

WaterMark

WaterMark

方法详细资料

get

of

of

of

delete

getSuffix

getContentType

canWrite