Signer.Position.KeywordPosition.KeywordPositionBuilder (signit-java-sdk 2.7.7 API)

java.lang.Object
- cn.signit.sdk.pojo.Signer.Position.KeywordPosition.KeywordPositionBuilder

封闭类:

Signer.Position.KeywordPosition
```
public static class Signer.Position.KeywordPosition.KeywordPositionBuilder
extends Object
```
利用关键字定位签名矩形框所在位置的数据对象建造器

从以下版本开始:

1.0.0

构造器概要

构造器
构造器和说明

KeywordPositionBuilder()

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

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`Signer.Position.KeywordPosition`	`build()`
`Signer.Position.KeywordPosition.KeywordPositionBuilder`	`withDeleteTextAfterLocate(Boolean deleteTextAfterLocate)`
`Signer.Position.KeywordPosition.KeywordPositionBuilder`	`withDirection(Direction direction)`
`Signer.Position.KeywordPosition.KeywordPositionBuilder`	`withHeight(Float height)`
`Signer.Position.KeywordPosition.KeywordPositionBuilder`	`withIndex(Integer index)`
`Signer.Position.KeywordPosition.KeywordPositionBuilder`	`withKeyword(String keyword)`
`Signer.Position.KeywordPosition.KeywordPositionBuilder`	`withOffset(Float offset)`
`Signer.Position.KeywordPosition.KeywordPositionBuilder`	`withPages(String pages)`
`Signer.Position.KeywordPosition.KeywordPositionBuilder`	`withRelativeHeightRatio(Float relativeHeightRatio)`
`Signer.Position.KeywordPosition.KeywordPositionBuilder`	`withRelativeOffsetRatio(Float relativeOffsetRatio)`
`Signer.Position.KeywordPosition.KeywordPositionBuilder`	`withRelativeWidthRatio(Float relativeWidthRatio)`
`Signer.Position.KeywordPosition.KeywordPositionBuilder`	`withReplaceTextAfterLocate(String replaceTextAfterLocate)`
`Signer.Position.KeywordPosition.KeywordPositionBuilder`	`withReverseIndex(Boolean reverseIndex)`
`Signer.Position.KeywordPosition.KeywordPositionBuilder`	`withScale(Float scale)`
`Signer.Position.KeywordPosition.KeywordPositionBuilder`	`withWidth(Float width)`
`Signer.Position.KeywordPosition.KeywordPositionBuilder`	`withXOffset(Float xOffset)`
`Signer.Position.KeywordPosition.KeywordPositionBuilder`	`withYOffset(Float yOffset)`

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

- 构造器详细资料
  - KeywordPositionBuilder
```
public KeywordPositionBuilder()
```
- 方法详细资料
  - withWidth
```
public Signer.Position.KeywordPosition.KeywordPositionBuilder withWidth(Float width)
```
    参数:
    
    width - 签名矩形框的宽度（默认为关键字宽度,单位：pt）；在易企签系统中，以左上角为坐标原点，横向为x轴，以纵向为y轴；宽度也即是签名矩形框在x方向上大小
    
    返回:
    
    利用关键字定位签名矩形框所在位置的数据对象建造器Signer.Position.KeywordPosition.KeywordPositionBuilder
    
    从以下版本开始:
    
    1.0.0
  - withRelativeWidthRatio
```
public Signer.Position.KeywordPosition.KeywordPositionBuilder withRelativeWidthRatio(Float relativeWidthRatio)
```
    参数:
    
    relativeWidthRatio - 签名矩形框宽度相对于关键字宽度的比率，默认为1.0；例：关键字宽度为50pt，relativeWidthRatio=2，那么签名矩形框宽度即为100pt；宽度更多介绍详见withWidth(Float)
    
    返回:
    
    利用关键字定位签名矩形框所在位置的数据对象建造器Signer.Position.KeywordPosition.KeywordPositionBuilder
    
    从以下版本开始:
    
    1.0.0
  - withHeight
```
public Signer.Position.KeywordPosition.KeywordPositionBuilder withHeight(Float height)
```
    参数:
    
    height - 签名矩形框的高度（默认为关键字高度,单位：pt）;在易企签系统中，以左上角为坐标原点，横向为x轴，以纵向为y轴；高度也即是签名矩形框在y方向上大小
    
    返回:
    
    利用关键字定位签名矩形框所在位置的数据对象建造器Signer.Position.KeywordPosition.KeywordPositionBuilder
    
    从以下版本开始:
    
    1.0.0
  - withRelativeHeightRatio
```
public Signer.Position.KeywordPosition.KeywordPositionBuilder withRelativeHeightRatio(Float relativeHeightRatio)
```
    参数:
    
    relativeHeightRatio - 签名矩形框高度相对于关键字高度的比率，默认为1.0；例：关键字高度为50pt，relativeHeightRatio=2，那么签名矩形框高度即为100pt；高度更多介绍详见withHeight(Float)
    
    返回:
    
    利用关键字定位签名矩形框所在位置的数据对象建造器Signer.Position.KeywordPosition.KeywordPositionBuilder
    
    从以下版本开始:
    
    1.0.0
  - withDirection
```
public Signer.Position.KeywordPosition.KeywordPositionBuilder withDirection(Direction direction)
```
    参数:
    
    direction - 偏移方向，即签名矩形框相对于关键字的方向（TOP,BOTTOM,LEFT,RIGHT,CENTER），默认为RIGHT；例：direction=TOP，则签名矩形框在关键字的上方
    
    返回:
    
    利用关键字定位签名矩形框所在位置的数据对象建造器Signer.Position.KeywordPosition.KeywordPositionBuilder
    
    从以下版本开始:
    
    1.0.0
  - withOffset
```
public Signer.Position.KeywordPosition.KeywordPositionBuilder withOffset(Float offset)
```
    参数:
    
    offset - 偏移量（以签名矩形框中心为0点）配合direction使用，默认为0，单位为pt；例：经过关键字初步定位，以及设置签名矩形框的宽高后，签名矩形框位置为：（100,100）(左上角顶点)->(200,200)（右下角顶点） ,direction=RIGHT,offset=20,那么进行偏移后，签名矩形框的坐标是 (120,100)(左上角顶点)->(220,200)（右下角顶点）
    
    返回:
    
    利用关键字定位签名矩形框所在位置的数据对象建造器Signer.Position.KeywordPosition.KeywordPositionBuilder
    
    从以下版本开始:
    
    1.0.0
  - withRelativeOffsetRatio
```
public Signer.Position.KeywordPosition.KeywordPositionBuilder withRelativeOffsetRatio(Float relativeOffsetRatio)
```
    参数:
    
    relativeOffsetRatio - 在偏移方向上，相对于该方向签名矩形框大小的比率，默认为0。例：假设签名矩形框的宽度是50pt，高度为30pt，relativeOffsetRatio=2.0，direction=RIGHT，那么意味着最终偏移量为offset=100pt；同理，如果签名矩形框宽度为50，高度为30，relativeOffsetRatio=1.3，direction=TOP，那么最终offset=39；计算后的offset使用方法详见withOffset(java.lang.Float)
    
    返回:
    
    利用关键字定位签名矩形框所在位置的数据对象建造器Signer.Position.KeywordPosition.KeywordPositionBuilder
    
    从以下版本开始:
    
    1.0.0
  - withKeyword
```
public Signer.Position.KeywordPosition.KeywordPositionBuilder withKeyword(String keyword)
```
    参数:
    
    keyword - 用于定位的关键字，例如：甲方（签名）。需要注意：用于定位的关键字在文档通过wps或者adobe reader等pdf阅读器打开后，需要能够通过鼠标圈选。例如：如果签署文档是通过图片转换后的pdf，就无法在签署文档中获取关键字位置。
    
    返回:
    
    利用关键字定位签名矩形框所在位置的数据对象建造器Signer.Position.KeywordPosition.KeywordPositionBuilder
    
    从以下版本开始:
    
    1.0.0
  - withScale
```
public Signer.Position.KeywordPosition.KeywordPositionBuilder withScale(Float scale)
```
    参数:
    
    scale - 根据关键字定位后的签名矩形框缩放比例，默认为1.0。例如根据关键字定位后，签名矩形框位置为(100,100)->(200,200),scale为2.0,那么签名矩形框位置将是(50,50)->(250,250)
    
    返回:
    
    利用关键字定位签名矩形框所在位置的数据对象建造器Signer.Position.KeywordPosition.KeywordPositionBuilder
    
    从以下版本开始:
    
    1.0.0
  - withPages
```
public Signer.Position.KeywordPosition.KeywordPositionBuilder withPages(String pages)
```
    参数:
    
    pages - 关键字需要搜索的页数，默认为"all"。在文档中搜索关键字时，只在指定页中搜索。支持"all","first","last","odd","even","1","1-5","1,2,3,5","(0,5]","[1,5]","(0,5)"这些页数的表示方式
    
    返回:
    
    利用关键字定位签名矩形框所在位置的数据对象建造器Signer.Position.KeywordPosition.KeywordPositionBuilder
    
    从以下版本开始:
    
    1.0.0
  - withXOffset
```
public Signer.Position.KeywordPosition.KeywordPositionBuilder withXOffset(Float xOffset)
```
    参数:
    
    xOffset - 签名矩形框在x轴额外偏移量，单位为pt,默认为0
    
    返回:
    
    利用关键字定位签名矩形框所在位置的数据对象建造器Signer.Position.KeywordPosition.KeywordPositionBuilder
    
    从以下版本开始:
    
    2.0.0
  - withYOffset
```
public Signer.Position.KeywordPosition.KeywordPositionBuilder withYOffset(Float yOffset)
```
    参数:
    
    yOffset - 签名矩形框在y轴额外偏移量，单位为pt，默认为0
    
    返回:
    
    利用关键字定位签名矩形框所在位置的数据对象建造器Signer.Position.KeywordPosition.KeywordPositionBuilder
    
    从以下版本开始:
    
    2.0.0
  - withIndex
```
public Signer.Position.KeywordPosition.KeywordPositionBuilder withIndex(Integer index)
```
    参数:
    
    index - 如果关键字所在页数存在多个相同关键字，则需要指定关键字的索引（关键字从索引从0开始）,即指定使用第几个关键字。默认为0
    
    返回:
    
    利用关键字定位签名矩形框所在位置的数据对象建造器Signer.Position.KeywordPosition.KeywordPositionBuilder
    
    从以下版本开始:
    
    2.0.0
  - withReverseIndex
```
public Signer.Position.KeywordPosition.KeywordPositionBuilder withReverseIndex(Boolean reverseIndex)
```
    参数:
    
    reverseIndex - 是否逆向搜索关键字index，默认false
    
    返回:
    
    利用关键字定位签名矩形框所在位置的数据对象建造器Signer.Position.KeywordPosition.KeywordPositionBuilder
    
    从以下版本开始:
    
    2.0.0
  - withReplaceTextAfterLocate
```
public Signer.Position.KeywordPosition.KeywordPositionBuilder withReplaceTextAfterLocate(String replaceTextAfterLocate)
```
    参数:
    
    replaceTextAfterLocate - 关键字定位完成后，将关键字内容替换为replaceTextAfterLocate；删除关键字优先于替换关键字
    
    返回:
    
    利用关键字定位签名矩形框所在位置的数据对象建造器Signer.Position.KeywordPosition.KeywordPositionBuilder
    
    从以下版本开始:
    
    2.3.0
  - withDeleteTextAfterLocate
```
public Signer.Position.KeywordPosition.KeywordPositionBuilder withDeleteTextAfterLocate(Boolean deleteTextAfterLocate)
```
    参数:
    
    deleteTextAfterLocate - 关键字定位完成后，将关键字删除；删除关键字优先于替换关键字
    
    返回:
    
    利用关键字定位签名矩形框所在位置的数据对象建造器Signer.Position.KeywordPosition.KeywordPositionBuilder
    
    从以下版本开始:
    
    2.3.0
  - build
```
public Signer.Position.KeywordPosition build()
```
    返回:
    
    利用关键字定位签名矩形框所在位置的数据对象 Signer.Position.KeywordPosition
    
    从以下版本开始:
    
    1.0.0

类 Signer.Position.KeywordPosition.KeywordPositionBuilder

构造器概要

方法概要

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

构造器详细资料

KeywordPositionBuilder

方法详细资料

withWidth

withRelativeWidthRatio

withHeight

withRelativeHeightRatio

withDirection

withOffset

withRelativeOffsetRatio

withKeyword

withScale

withPages

withXOffset

withYOffset

withIndex

withReverseIndex

withReplaceTextAfterLocate

withDeleteTextAfterLocate

build