AbstractWatermarkHandler (org.easywatermark:easy-watermark 0.0.3 API)

java.lang.Object
- org.easywatermark.core.AbstractWatermarkHandler<F,G>

类型参数:

F - Font

G - Graphics

所有已实现的接口:

Closeable, AutoCloseable, EasyWatermarkHandler, FontProvider, GraphicsProvider, WatermarkHandler

直接已知子类:

DocxWatermarkHandler, ImageWatermarkHandler, PdfWatermarkHandler
```
public abstract class AbstractWatermarkHandler<F,G>
extends Object
implements EasyWatermarkHandler, FontProvider, GraphicsProvider
```
AbstractWatermarkHandler is an abstract class for handling watermark-related operations.

作者:

zhangshukun

字段概要

字段
限定符和类型	字段和说明
`protected EasyWatermarkCustomDraw`	`easyWatermarkCustomDraw`
`protected F`	`font`
`protected FontConfig`	`fontConfig`
`protected G`	`graphics`
`protected WatermarkConfig`	`watermarkConfig`
`protected byte[]`	`watermarkImage`
`protected String`	`watermarkText`
`protected List<String>`	`watermarkTextList`

构造器概要

构造器
构造器和说明

AbstractWatermarkHandler(byte[] data, FontConfig fontConfig, WatermarkConfig watermarkConfig)

构造器
构造器和说明
`AbstractWatermarkHandler(byte[] data, FontConfig fontConfig, WatermarkConfig watermarkConfig)`

方法概要

所有方法实例方法抽象方法具体方法
限定符和类型	方法和说明
`protected Point`	`calcCenterWatermarkPoint(float watermarkWidth, float watermarkHeight, int page)` calculate watermark point
`protected Point`	`calcCenterWatermarkPoint(String watermarkText, int page)` Calculate center watermark point.
`protected float`	`calcDistanceBetweenWatermarks(float blank, float k, int count)` m: The width/height of the watermark from both sides n: The width/height between watermarks m = n - k. k ≈ page width * 1% 2m + (col - 1)n = blankWidth ⬇ 2(n - k) + (col - 1)n = blankWidth ⬇ n = (blankWidth + 2k) / (col + 1)
`protected void`	`drawOverspreadWatermark(int pageNumber)` normal draw overspread watermark
`byte[]`	`execute(EasyWatermarkTypeEnum watermarkType)` add watermark, return handler file bytes.
`protected abstract byte[]`	`export(EasyWatermarkTypeEnum watermarkType)` export handle data to byte array
`protected abstract float`	`getFileHeight(int page)` get current height
`protected abstract float`	`getFileWidth(int page)` get current width
`WatermarkBox`	`getStringBox(String... text)` Get the watermark box of the text.
`protected WatermarkBox`	`getWatermarkBox(WatermarkTypeEnum watermarkType, int page)` Get watermark box.
`protected abstract float`	`getWatermarkImageHeight()` Get watermark image height.
`protected abstract float`	`getWatermarkImageWidth()` Get watermark image width.
`protected WatermarkTypeEnum`	`getWatermarkType()`
`protected abstract void`	`initEnvironment()` init environment.
`protected abstract void`	`initFont()` init font
`protected abstract void`	`initGraphics()` init graphics
`void`	`setCustomDraw(EasyWatermarkCustomDraw easyWatermarkCustomDraw)`
`String`	`toString()`
`void`	`watermark(byte[] watermarkImage)`
`void`	`watermark(List<String> watermarkTextList)`
`void`	`watermark(String watermarkText)`

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

从接口继承的方法 org.easywatermark.core.EasyWatermarkHandler
customDraw, drawCenterWatermark, drawDiagonalWatermark, drawOverspreadWatermark

从接口继承的方法 org.easywatermark.core.WatermarkHandler
loadFile

从接口继承的方法 java.io.Closeable
close

从接口继承的方法 org.easywatermark.core.provider.FontProvider
getStringHeight, getStringWidth

从接口继承的方法 org.easywatermark.core.provider.GraphicsProvider
drawImage, drawMultiLineString, drawString, rotate

字段详细资料

watermarkText
```
protected String watermarkText
```

watermarkTextList

protected List<String> watermarkTextList

watermarkImage
```
protected byte[] watermarkImage
```

font
```
protected F font
```

graphics
```
protected G graphics
```

fontConfig
```
protected FontConfig fontConfig
```

watermarkConfig

protected WatermarkConfig watermarkConfig

easyWatermarkCustomDraw

protected EasyWatermarkCustomDraw easyWatermarkCustomDraw

构造器详细资料

AbstractWatermarkHandler

public AbstractWatermarkHandler(byte[] data,
                                FontConfig fontConfig,
                                WatermarkConfig watermarkConfig)

方法详细资料
- initGraphics
```
protected abstract void initGraphics()
```
  init graphics
- initFont
```
protected abstract void initFont()
```
  init font
- initEnvironment
```
protected abstract void initEnvironment()
```
  init environment.
- getFileWidth
```
protected abstract float getFileWidth(int page)
```
  get current width
  
  参数:
  
  page - page
  
  返回:
  
  width
- getFileHeight
```
protected abstract float getFileHeight(int page)
```
  get current height
  
  参数:
  
  page - page
  
  返回:
  
  height
- getWatermarkImageWidth
```
protected abstract float getWatermarkImageWidth()
```
  Get watermark image width.
  
  返回:
  
  watermark image width
- getWatermarkImageHeight
```
protected abstract float getWatermarkImageHeight()
```
  Get watermark image height.
  
  返回:
  
  watermark image height
- drawOverspreadWatermark
```
protected void drawOverspreadWatermark(int pageNumber)
```
  normal draw overspread watermark
  
  参数:
  
  pageNumber - page number
- export
```
protected abstract byte[] export(EasyWatermarkTypeEnum watermarkType)
```
  export handle data to byte array
  
  参数:
  
  watermarkType - watermark type
  
  返回:
  
  byte array
- setCustomDraw
```
public void setCustomDraw(EasyWatermarkCustomDraw easyWatermarkCustomDraw)
```
- watermark
```
public void watermark(String watermarkText)
```
- watermark
```
public void watermark(byte[] watermarkImage)
```
- watermark
```
public void watermark(List<String> watermarkTextList)
```
- execute
```
public byte[] execute(EasyWatermarkTypeEnum watermarkType)
```
  从接口复制的说明: WatermarkHandler
  
  add watermark, return handler file bytes.
  
  指定者:
  
  execute 在接口中 WatermarkHandler
  
  返回:
  
  Byte array after adding watermark
- getStringBox
```
public WatermarkBox getStringBox(String... text)
```
  从接口复制的说明: FontProvider
  
  Get the watermark box of the text.
  
  指定者:
  
  getStringBox 在接口中 FontProvider
  
  参数:
  
  text - text
  
  返回:
  
  watermark box
- getWatermarkType
```
protected WatermarkTypeEnum getWatermarkType()
```
- calcCenterWatermarkPoint
```
protected Point calcCenterWatermarkPoint(float watermarkWidth,
                                         float watermarkHeight,
                                         int page)
```
  calculate watermark point
  
  参数:
  
  watermarkWidth - watermark width
  
  watermarkHeight - watermark height
  
  page - page
  
  返回:
  
  point
- calcCenterWatermarkPoint
```
protected Point calcCenterWatermarkPoint(String watermarkText,
                                         int page)
```
  Calculate center watermark point.
  
  参数:
  
  watermarkText - watermark text
  
  page - page
  
  返回:
  
  center watermark point
- calcDistanceBetweenWatermarks
```
protected float calcDistanceBetweenWatermarks(float blank,
                                              float k,
                                              int count)
```
  m: The width/height of the watermark from both sides n: The width/height between watermarks m = n - k. k ≈ page width * 1% 2m + (col - 1)n = blankWidth ⬇ 2(n - k) + (col - 1)n = blankWidth ⬇ n = (blankWidth + 2k) / (col + 1)
  
  参数:
  
  blank - blank weight/width
  
  k - The difference in m n.
  
  count - columns/rows count.
  
  返回:
  
  distance between watermarks.
- getWatermarkBox
```
protected WatermarkBox getWatermarkBox(WatermarkTypeEnum watermarkType,
                                       int page)
```
  Get watermark box.
  
  参数:
  
  watermarkType - watermark type
  
  page - page
  
  返回:
  
  watermark box
- toString
```
public String toString()
```
  覆盖:
  
  toString 在类中 Object

类 AbstractWatermarkHandler<F,G>

字段概要

构造器概要

方法概要

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

从接口继承的方法 org.easywatermark.core.EasyWatermarkHandler

从接口继承的方法 org.easywatermark.core.WatermarkHandler

从接口继承的方法 java.io.Closeable

从接口继承的方法 org.easywatermark.core.provider.FontProvider

从接口继承的方法 org.easywatermark.core.provider.GraphicsProvider

字段详细资料

watermarkText

watermarkTextList

watermarkImage

font

graphics

fontConfig

watermarkConfig

easyWatermarkCustomDraw

构造器详细资料

AbstractWatermarkHandler

方法详细资料

initGraphics

initFont

initEnvironment

getFileWidth

getFileHeight

getWatermarkImageWidth

getWatermarkImageHeight

drawOverspreadWatermark

export

setCustomDraw

watermark

watermark

watermark

execute

getStringBox

getWatermarkType

calcCenterWatermarkPoint

calcCenterWatermarkPoint

calcDistanceBetweenWatermarks

getWatermarkBox

toString