Annotation (OFDRW Layout 2.3.8 API)

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

Direct Known Subclasses:

Watermark
```
public class Annotation
extends Object
```
注释对象
请设置绘制对象

Since:

2020-05-14 19:09:37

Author:

权观宇

Constructor Summary

Constructors
Constructor and Description
`Annotation(double x, double y, double width, double height, org.ofdrw.core.annotation.pageannot.AnnotType type, Drawer drawer)` 创建注释对象
`Annotation(org.ofdrw.core.basicType.ST_Box boundary, org.ofdrw.core.annotation.pageannot.AnnotType type, Drawer drawer)` 创建注解对象

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Annotation`	`addParameter(String name, String parameter)` 增加注释参数
`org.ofdrw.core.annotation.pageannot.Annot`	`build()` 获取注释底层对象
`org.ofdrw.core.basicType.ST_Box`	`getBoundary()`
`String`	`getCreator()` 获取注释创建者
`Drawer`	`getDrawer()` 获取当前注释的绘制器
`LocalDate`	`getLastModDate()` 获取最近一次修改的时间
`Boolean`	`getNoRotate()` 获取对象的 Remark 信息是否不随页面旋转而旋转
`Boolean`	`getNoZoom()` 获取对象的 Remark 信息是否不随页面缩放而同步缩放
`Map<String,String>`	`getParameters()` 获取一组注释参数
`Boolean`	`getPrint()` 设置对象的Remark 信息是否随页面一起打印
`Boolean`	`getReadOnly()` 获取对象的 Remark 信息是否不能被用户更改
`String`	`getRemark()` 获取注释说明内容
`String`	`getSubtype()` 获取注释子类型
`org.ofdrw.core.annotation.pageannot.AnnotType`	`getType()` 获取注释类型
`Boolean`	`getVisible()` 获取表示该注释对象是否显示
`void`	`setBoundary(org.ofdrw.core.basicType.ST_Box boundary)`
`Annotation`	`setCreator(String creator)` 设置注释创建者
`Annotation`	`setDrawer(Drawer drawer)` 设置注释绘制器
`Annotation`	`setLastModDate(LocalDate lastModDate)` 设置最近一次修改的时间
`Annotation`	`setNoRotate(boolean noRotate)` 设置对象的 Remark 信息是否不随页面旋转而旋转
`Annotation`	`setNoZoom(boolean noZoom)` 设置对象的 Remark 信息是否不随页面缩放而同步缩放
`Annotation`	`setPrint(boolean print)` 设置对象的Remark 信息是否随页面一起打印
`Annotation`	`setReadOnly(boolean readOnly)` 设置对象的 Remark 信息是否不能被用户更改
`Annotation`	`setRemark(String remark)` 设置注释说明内容
`Annotation`	`setSubtype(String subtype)` 设置注释子类型
`Annotation`	`setType(org.ofdrw.core.annotation.pageannot.AnnotType type)` 设置注释类型
`Annotation`	`setVisible(boolean visible)` 设置表示该注释对象是否显示

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

- Constructor Detail
  - Annotation
```
public Annotation(double x,
                  double y,
                  double width,
                  double height,
                  org.ofdrw.core.annotation.pageannot.AnnotType type,
                  Drawer drawer)
```
    创建注释对象
    
    Parameters:
    
    x - 所处页面 y坐标
    
    y - 所处页面 y坐标
    
    width - 画布宽度
    
    height - 画布高度
    
    type - 注释类型
    
    drawer - 注释绘制器
  - Annotation
```
public Annotation(org.ofdrw.core.basicType.ST_Box boundary,
                  org.ofdrw.core.annotation.pageannot.AnnotType type,
                  Drawer drawer)
```
    创建注解对象
    
    Parameters:
    
    boundary - 注释对象绘制空间
    
    type - 注释类型
    
    drawer - 注释绘制器
- Method Detail
  - build
```
public org.ofdrw.core.annotation.pageannot.Annot build()
```
    获取注释底层对象
    
    Returns:
    
    注释对象
  - getBoundary
```
public org.ofdrw.core.basicType.ST_Box getBoundary()
```
  - setBoundary
```
public void setBoundary(org.ofdrw.core.basicType.ST_Box boundary)
```
  - getDrawer
```
public Drawer getDrawer()
```
    获取当前注释的绘制器
    
    Returns:
    
    绘制器
  - setDrawer
```
public Annotation setDrawer(Drawer drawer)
```
    设置注释绘制器
    
    Parameters:
    
    drawer - 注释绘制器
    
    Returns:
    
    this
  - setType
```
public Annotation setType(org.ofdrw.core.annotation.pageannot.AnnotType type)
```
    设置注释类型
    具体取值见AnnotType
    
    Parameters:
    
    type - 注释类型
    
    Returns:
    
    this
  - getType
```
public org.ofdrw.core.annotation.pageannot.AnnotType getType()
```
    获取注释类型
    具体取值见AnnotType
    
    Returns:
    
    注释类型
  - setCreator
```
public Annotation setCreator(String creator)
```
    设置注释创建者
    
    Parameters:
    
    creator - 注释创建者
    
    Returns:
    
    this
  - getCreator
```
public String getCreator()
```
    获取注释创建者
    
    Returns:
    
    注释创建者
  - setLastModDate
```
public Annotation setLastModDate(LocalDate lastModDate)
```
    设置最近一次修改的时间
    
    Parameters:
    
    lastModDate - 最近一次修改的时间
    
    Returns:
    
    this
  - getLastModDate
```
public LocalDate getLastModDate()
```
    获取最近一次修改的时间
    
    Returns:
    
    最近一次修改的时间
  - setSubtype
```
public Annotation setSubtype(String subtype)
```
    设置注释子类型
    
    Parameters:
    
    subtype - 注释子类型
    
    Returns:
    
    this
  - getSubtype
```
public String getSubtype()
```
    获取注释子类型
    
    Returns:
    
    注释子类型
  - setVisible
```
public Annotation setVisible(boolean visible)
```
    设置表示该注释对象是否显示
    默认值为 true
    
    Parameters:
    
    visible - 表示该注释对象是否显示，默认值为 true
    
    Returns:
    
    this
  - getVisible
```
public Boolean getVisible()
```
    获取表示该注释对象是否显示
    默认值为 true
    
    Returns:
    
    表示该注释对象是否显示，默认值为 true
  - setPrint
```
public Annotation setPrint(boolean print)
```
    设置对象的Remark 信息是否随页面一起打印
    默认值为 true
    
    Parameters:
    
    print - 对象的Remark 信息是否随页面一起打印
    
    Returns:
    
    this
  - getPrint
```
public Boolean getPrint()
```
    设置对象的Remark 信息是否随页面一起打印
    默认值为 true
    
    Returns:
    
    对象的Remark 信息是否随页面一起打印
  - setNoZoom
```
public Annotation setNoZoom(boolean noZoom)
```
    设置对象的 Remark 信息是否不随页面缩放而同步缩放
    默认值为 false
    
    Parameters:
    
    noZoom - 对象的 Remark 信息是否不随页面缩放而同步缩放
    
    Returns:
    
    this
  - getNoZoom
```
public Boolean getNoZoom()
```
    获取对象的 Remark 信息是否不随页面缩放而同步缩放
    默认值为 false
    
    Returns:
    
    对象的 Remark 信息是否不随页面缩放而同步缩放
  - setNoRotate
```
public Annotation setNoRotate(boolean noRotate)
```
    设置对象的 Remark 信息是否不随页面旋转而旋转
    默认值为 false
    
    Parameters:
    
    noRotate - 对象的 Remark 信息是否不随页面旋转而旋转
    
    Returns:
    
    this
  - getNoRotate
```
public Boolean getNoRotate()
```
    获取对象的 Remark 信息是否不随页面旋转而旋转
    默认值为 false
    
    Returns:
    
    对象的 Remark 信息是否不随页面旋转而旋转
  - setReadOnly
```
public Annotation setReadOnly(boolean readOnly)
```
    设置对象的 Remark 信息是否不能被用户更改
    默认值为 true
    
    Parameters:
    
    readOnly - 对象的 Remark 信息是否不能被用户更改
    
    Returns:
    
    this
  - getReadOnly
```
public Boolean getReadOnly()
```
    获取对象的 Remark 信息是否不能被用户更改
    默认值为 true
    
    Returns:
    
    对象的 Remark 信息是否不能被用户更改
  - setRemark
```
public Annotation setRemark(String remark)
```
    设置注释说明内容
    
    Parameters:
    
    remark - 注释说明内容
    
    Returns:
    
    this
  - getRemark
```
public String getRemark()
```
    获取注释说明内容
    
    Returns:
    
    注释说明内容，如果注释说明内容不存在返还null
  - addParameter
```
public Annotation addParameter(String name,
                               String parameter)
```
    增加注释参数
    
    Parameters:
    
    name - 键名
    
    parameter - 值
    
    Returns:
    
    this
  - getParameters
```
public Map<String,String> getParameters()
```
    获取一组注释参数
    
    Returns:
    
    注解参数映射表, 如果注释参数不存在那么返还空的集合

Class Annotation

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Annotation

Annotation

Method Detail

build

getBoundary

setBoundary

getDrawer

setDrawer

setType

getType

setCreator

getCreator

setLastModDate

getLastModDate

setSubtype

getSubtype

setVisible

getVisible

setPrint

getPrint

setNoZoom

getNoZoom

setNoRotate

getNoRotate

setReadOnly

getReadOnly

setRemark

getRemark

addParameter

getParameters