XEasyPdfTextScript (x-easypdf-pdfbox 2.12.1 API)

java.lang.Object
- org.dromara.pdf.pdfbox.component.text.XEasyPdfTextScript

所有已实现的接口:

Serializable, XEasyPdfComponent
```
public class XEasyPdfTextScript
extends Object
```
pdf文本角标组件

从以下版本开始:

1.8
Copyright (c) 2020-2023 xsx All Rights Reserved. x-easypdf is licensed under Mulan PSL v2. You can use this software according to the terms and conditions of the Mulan PSL v2. You may obtain a copy of Mulan PSL v2 at: http://license.coscl.org.cn/MulanPSL2 THIS SOFTWARE IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT, MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE. See the Mulan PSL v2 for more details.

作者:

xsx

另请参阅:

序列化表格

嵌套类概要
- 从接口继承的嵌套类/接口 org.dromara.pdf.pdfbox.component.XEasyPdfComponent
  XEasyPdfComponent.ContentMode

构造器概要

构造器
构造器和说明

XEasyPdfTextScript(String text)
有参构造

构造器
构造器和说明
`XEasyPdfTextScript(String text)` 有参构造

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`XEasyPdfTextScript`	`disableSelfStyle()` 关闭自身样式
`void`	`draw(XEasyPdfDocument document, XEasyPdfPage page)` 绘制
`XEasyPdfTextScript`	`enableChildComponent()` 开启子组件
`XEasyPdfTextScript`	`enableDeleteLine()` 开启删除线
`XEasyPdfTextScript`	`enableHighlight()` 开启高亮
`XEasyPdfTextScript`	`enableResetContext()` 开启上下文重置
`XEasyPdfTextScript`	`enableRotateLine()` 开启整行旋转
`XEasyPdfTextScript`	`enableSelfStyle()` 开启自身样式
`XEasyPdfTextScript`	`enableUnderline()` 开启下划线
`float`	`getCharacterSpacing()` 获取文本间隔
`XEasyPdfComponent.ContentMode`	`getContentMode()` 获取内容模式
`String`	`getFontPath()` 获取字体路径
`float`	`getFontSize()` 获取字体大小
`float`	`getHeight(XEasyPdfDocument document, XEasyPdfPage page)` 获取高度
`XEasyPdfPositionStyle`	`getHorizontalStyle()` 获取水平样式
`float`	`getLeading()` 获取行间距
`float`	`getMarginBottom()` 获取下边距
`float`	`getMarginLeft()` 获取左边距
`float`	`getMarginRight()` 获取右边距
`float`	`getMarginTop()` 获取上边距
`List<String>`	`getSplitTextList()` 获取待添加文本列表
`XEasyPdfPositionStyle`	`getVerticalStyle()` 获取垂直样式
`float`	`getWidth(XEasyPdfDocument document, XEasyPdfPage page)` 获取宽度
`boolean`	`isNeedInitialize()` 是否需要初始化
`void`	`onAfterDraw(XEasyPdfComponentEvent event)` 绘制之后
`void`	`onBeforeDraw(XEasyPdfComponentEvent event)` 绘制之前
`XEasyPdfTextScript`	`setAlpha(float alpha)` 设置文本透明度
`XEasyPdfTextScript`	`setAutoIndent(int indent)` 设置自动缩进
`XEasyPdfTextScript`	`setCharacterSpacing(float characterSpacing)` 设置文本间隔
`XEasyPdfTextScript`	`setCheckPage(boolean isCheckPage)` 设置是否分页检查
`XEasyPdfTextScript`	`setComment(String comment)` 设置评论
`XEasyPdfTextScript`	`setContentMode(XEasyPdfComponent.ContentMode mode)` 设置内容模式
`XEasyPdfTextScript`	`setDefaultFontStyle(XEasyPdfDefaultFontStyle style)` 设置默认字体样式
`XEasyPdfTextScript`	`setDeleteLineColor(Color deleteLineColor)` 设置删除线颜色
`XEasyPdfTextScript`	`setDeleteLineWidth(float deleteLineWidth)` 设置删除线线宽
`XEasyPdfTextScript`	`setFontColor(Color fontColor)` 设置字体颜色
`XEasyPdfTextScript`	`setFontPath(String fontPath)` 设置字体路径
`XEasyPdfTextScript`	`setFontScaleRatio(float fontScaleRatio)` 设置字体缩放比例
`XEasyPdfTextScript`	`setFontSize(float fontSize)` 设置字体大小
`XEasyPdfTextScript`	`setHeight(float height)` 设置高度
`XEasyPdfTextScript`	`setHighlightColor(Color highlightColor)` 设置高亮颜色
`XEasyPdfTextScript`	`setLeading(float leading)` 设置行间距
`XEasyPdfTextScript`	`setLink(String linkUrl)` 设置超链接地址
`XEasyPdfTextScript`	`setMargin(float margin)` 设置边距（上下左右）
`XEasyPdfTextScript`	`setMarginBottom(float margin)` 设置下边距
`XEasyPdfTextScript`	`setMarginLeft(float margin)` 设置左边距
`XEasyPdfTextScript`	`setMarginRight(float margin)` 设置右边距
`XEasyPdfTextScript`	`setMarginTop(float margin)` 设置上边距
`XEasyPdfTextScript`	`setMaxHeight(Float maxHeight)` 设置最大高度
`XEasyPdfTextScript`	`setNeedInitialize(boolean needInitialize)` 设置是否需要初始化
`XEasyPdfTextScript`	`setNewLine(boolean isNewLine)` 设置是否换行（影响下一个组件是否换行）
`XEasyPdfTextScript`	`setPagingCondition(XEasyPdfPagingCondition pagingCondition)` 设置分页条件
`XEasyPdfTextScript`	`setPosition(float beginX, float beginY)` 设置定位
`XEasyPdfTextScript`	`setRenderingMode(XEasypdfTextRenderingMode renderingMode)` 设置渲染模式
`XEasyPdfTextScript`	`setReplaceCharacters(Map<String,String> replaceMap)` 设置替换字符
`XEasyPdfTextScript`	`setReplaceCharacters(String oldValue, String replacement)` 设置替换字符
`XEasyPdfTextScript`	`setScriptType(XEasyPdfTextScriptType scriptType)` 设置角标类型
`XEasyPdfTextScript`	`setUnderlineColor(Color underlineColor)` 设置下划线颜色
`XEasyPdfTextScript`	`setUnderlineWidth(float underlineWidth)` 设置下划线线宽
`XEasyPdfTextScript`	`setWidth(float width)` 设置宽度

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

- 构造器详细资料
  - XEasyPdfTextScript
```
public XEasyPdfTextScript(String text)
```
    有参构造
    
    参数:
    
    text - 待写入文本
- 方法详细资料
  - enableChildComponent
```
public XEasyPdfTextScript enableChildComponent()
```
    开启子组件
    
    返回:
    
    返回角标组件
  - enableUnderline
```
public XEasyPdfTextScript enableUnderline()
```
    开启下划线
    
    返回:
    
    返回角标组件
  - enableDeleteLine
```
public XEasyPdfTextScript enableDeleteLine()
```
    开启删除线
    
    返回:
    
    返回角标组件
  - enableHighlight
```
public XEasyPdfTextScript enableHighlight()
```
    开启高亮
    
    返回:
    
    返回角标组件
  - enableRotateLine
```
public XEasyPdfTextScript enableRotateLine()
```
    开启整行旋转
    
    返回:
    
    返回角标组件
  - enableResetContext
```
public XEasyPdfTextScript enableResetContext()
```
    开启上下文重置
    
    指定者:
    
    enableResetContext 在接口中 XEasyPdfComponent
    
    返回:
    
    返回角标组件
  - enableSelfStyle
```
public XEasyPdfTextScript enableSelfStyle()
```
    开启自身样式
    
    返回:
    
    返回角标组件
  - disableSelfStyle
```
public XEasyPdfTextScript disableSelfStyle()
```
    关闭自身样式
    
    返回:
    
    返回角标组件
  - setAutoIndent
```
public XEasyPdfTextScript setAutoIndent(int indent)
```
    设置自动缩进
    
    参数:
    
    indent - 缩进值
    
    返回:
    
    返回角标组件
  - setMargin
```
public XEasyPdfTextScript setMargin(float margin)
```
    设置边距（上下左右）
    
    参数:
    
    margin - 边距
    
    返回:
    
    返回角标组件
  - setMarginLeft
```
public XEasyPdfTextScript setMarginLeft(float margin)
```
    设置左边距
    
    参数:
    
    margin - 边距
    
    返回:
    
    返回角标组件
  - setMarginRight
```
public XEasyPdfTextScript setMarginRight(float margin)
```
    设置右边距
    
    参数:
    
    margin - 边距
    
    返回:
    
    返回角标组件
  - setMarginTop
```
public XEasyPdfTextScript setMarginTop(float margin)
```
    设置上边距
    
    参数:
    
    margin - 边距
    
    返回:
    
    返回角标组件
  - setMarginBottom
```
public XEasyPdfTextScript setMarginBottom(float margin)
```
    设置下边距
    
    参数:
    
    margin - 边距
    
    返回:
    
    返回角标组件
  - setLeading
```
public XEasyPdfTextScript setLeading(float leading)
```
    设置行间距
    
    参数:
    
    leading - 行间距
    
    返回:
    
    返回角标组件
  - setCharacterSpacing
```
public XEasyPdfTextScript setCharacterSpacing(float characterSpacing)
```
    设置文本间隔
    
    参数:
    
    characterSpacing - 文本间隔
    
    返回:
    
    返回角标组件
  - setFontPath
```
public XEasyPdfTextScript setFontPath(String fontPath)
```
    设置字体路径
    
    参数:
    
    fontPath - 字体路径
    
    返回:
    
    返回角标组件
  - setDefaultFontStyle
```
public XEasyPdfTextScript setDefaultFontStyle(XEasyPdfDefaultFontStyle style)
```
    设置默认字体样式
    
    参数:
    
    style - 默认字体样式
    
    返回:
    
    返回角标组件
  - setFontSize
```
public XEasyPdfTextScript setFontSize(float fontSize)
```
    设置字体大小
    
    参数:
    
    fontSize - 字体大小
    
    返回:
    
    返回角标组件
  - setFontColor
```
public XEasyPdfTextScript setFontColor(Color fontColor)
```
    设置字体颜色
    
    参数:
    
    fontColor - 字体颜色
    
    返回:
    
    返回角标组件
  - setHighlightColor
```
public XEasyPdfTextScript setHighlightColor(Color highlightColor)
```
    设置高亮颜色
    
    参数:
    
    highlightColor - 高亮颜色
    
    返回:
    
    返回角标组件
  - setUnderlineColor
```
public XEasyPdfTextScript setUnderlineColor(Color underlineColor)
```
    设置下划线颜色
    
    参数:
    
    underlineColor - 下划线颜色
    
    返回:
    
    返回角标组件
  - setUnderlineWidth
```
public XEasyPdfTextScript setUnderlineWidth(float underlineWidth)
```
    设置下划线线宽
    
    参数:
    
    underlineWidth - 下划线线宽
    
    返回:
    
    返回角标组件
  - setDeleteLineColor
```
public XEasyPdfTextScript setDeleteLineColor(Color deleteLineColor)
```
    设置删除线颜色
    
    参数:
    
    deleteLineColor - 删除线颜色
    
    返回:
    
    返回角标组件
  - setDeleteLineWidth
```
public XEasyPdfTextScript setDeleteLineWidth(float deleteLineWidth)
```
    设置删除线线宽
    
    参数:
    
    deleteLineWidth - 删除线线宽
    
    返回:
    
    返回角标组件
  - setLink
```
public XEasyPdfTextScript setLink(String linkUrl)
```
    设置超链接地址
    
    参数:
    
    linkUrl - 超链接地址
    
    返回:
    
    返回角标组件
  - setComment
```
public XEasyPdfTextScript setComment(String comment)
```
    设置评论
    
    参数:
    
    comment - 评论
    
    返回:
    
    返回角标组件
  - setAlpha
```
public XEasyPdfTextScript setAlpha(float alpha)
```
    设置文本透明度
    
    参数:
    
    alpha - 文本透明度
    
    返回:
    
    返回页面水印组件
  - setReplaceCharacters
```
public XEasyPdfTextScript setReplaceCharacters(String oldValue,
                                               String replacement)
```
    设置替换字符
    
    参数:
    
    oldValue - 待替换字符串
    
    replacement - 替换字符串
    
    返回:
    
    返回返回角标组件
  - setReplaceCharacters
```
public XEasyPdfTextScript setReplaceCharacters(Map<String,String> replaceMap)
```
    设置替换字符
    
    参数:
    
    replaceMap - 待替换字典
    
    返回:
    
    返回返回角标组件
  - setNewLine
```
public XEasyPdfTextScript setNewLine(boolean isNewLine)
```
    设置是否换行（影响下一个组件是否换行）
    
    参数:
    
    isNewLine - 是否换行
    
    返回:
    
    返回角标组件
  - setCheckPage
```
public XEasyPdfTextScript setCheckPage(boolean isCheckPage)
```
    设置是否分页检查
    
    参数:
    
    isCheckPage - 是否分页检查
    
    返回:
    
    返回角标组件
  - setPosition
```
public XEasyPdfTextScript setPosition(float beginX,
                                      float beginY)
```
    设置定位
    
    指定者:
    
    setPosition 在接口中 XEasyPdfComponent
    
    参数:
    
    beginX - 当前页面X轴坐标
    
    beginY - 当前页面Y轴坐标
    
    返回:
    
    返回角标组件
  - setWidth
```
public XEasyPdfTextScript setWidth(float width)
```
    设置宽度
    
    指定者:
    
    setWidth 在接口中 XEasyPdfComponent
    
    参数:
    
    width - 宽度
    
    返回:
    
    返回角标组件
  - setHeight
```
public XEasyPdfTextScript setHeight(float height)
```
    设置高度
    
    指定者:
    
    setHeight 在接口中 XEasyPdfComponent
    
    参数:
    
    height - 高度
    
    返回:
    
    返回角标组件
  - setMaxHeight
```
public XEasyPdfTextScript setMaxHeight(Float maxHeight)
```
    设置最大高度
    
    参数:
    
    maxHeight - 最大高度
    
    返回:
    
    返回角标组件
  - setContentMode
```
public XEasyPdfTextScript setContentMode(XEasyPdfComponent.ContentMode mode)
```
    设置内容模式
    
    指定者:
    
    setContentMode 在接口中 XEasyPdfComponent
    
    参数:
    
    mode - 内容模式
    
    返回:
    
    返回角标组件
  - setRenderingMode
```
public XEasyPdfTextScript setRenderingMode(XEasypdfTextRenderingMode renderingMode)
```
    设置渲染模式
    
    参数:
    
    renderingMode - 渲染模式
    
    返回:
    
    返回角标组件
  - setPagingCondition
```
public XEasyPdfTextScript setPagingCondition(XEasyPdfPagingCondition pagingCondition)
```
    设置分页条件
    
    参数:
    
    pagingCondition - 分页条件
    
    返回:
    
    返回角标组件
  - setNeedInitialize
```
public XEasyPdfTextScript setNeedInitialize(boolean needInitialize)
```
    设置是否需要初始化
    
    参数:
    
    needInitialize - 是否需要初始化
    
    返回:
    
    返回角标组件
  - setFontScaleRatio
```
public XEasyPdfTextScript setFontScaleRatio(float fontScaleRatio)
```
    设置字体缩放比例
    
    参数:
    
    fontScaleRatio - 字体缩放比例（0.1~0.7之间）
    
    返回:
    
    返回角标组件
  - setScriptType
```
public XEasyPdfTextScript setScriptType(XEasyPdfTextScriptType scriptType)
```
    设置角标类型
    
    参数:
    
    scriptType - 角标类型
    
    返回:
    
    返回角标组件
  - getHeight
```
public float getHeight(XEasyPdfDocument document,
                       XEasyPdfPage page)
```
    获取高度
    
    参数:
    
    document - pdf文档
    
    page - pdf页面
    
    返回:
    
    返回文本高度
  - getWidth
```
public float getWidth(XEasyPdfDocument document,
                      XEasyPdfPage page)
```
    获取宽度
    
    参数:
    
    document - pdf文档
    
    page - pdf页面
    
    返回:
    
    返回文本宽度
  - getContentMode
```
public XEasyPdfComponent.ContentMode getContentMode()
```
    获取内容模式
    
    返回:
    
    返回内容模式
  - getMarginTop
```
public float getMarginTop()
```
    获取上边距
    
    返回:
    
    返回上边距
  - getMarginBottom
```
public float getMarginBottom()
```
    获取下边距
    
    返回:
    
    返回下边距
  - getMarginLeft
```
public float getMarginLeft()
```
    获取左边距
    
    返回:
    
    返回左边距
  - getMarginRight
```
public float getMarginRight()
```
    获取右边距
    
    返回:
    
    返回右边距
  - getSplitTextList
```
public List<String> getSplitTextList()
```
    获取待添加文本列表
    
    返回:
    
    返回待添加文本列表
  - getFontSize
```
public float getFontSize()
```
    获取字体大小
    
    返回:
    
    返回字体大小
  - getFontPath
```
public String getFontPath()
```
    获取字体路径
    
    返回:
    
    返回字体路径
  - getLeading
```
public float getLeading()
```
    获取行间距
    
    返回:
    
    返回行间距
  - getCharacterSpacing
```
public float getCharacterSpacing()
```
    获取文本间隔
    
    返回:
    
    返回文本间隔
  - getHorizontalStyle
```
public XEasyPdfPositionStyle getHorizontalStyle()
```
    获取水平样式
    
    返回:
    
    返回水平样式
  - getVerticalStyle
```
public XEasyPdfPositionStyle getVerticalStyle()
```
    获取垂直样式
    
    返回:
    
    返回垂直样式
  - isNeedInitialize
```
public boolean isNeedInitialize()
```
    是否需要初始化
    
    返回:
    
    返回布尔值，是为true，否为false
  - draw
```
public void draw(XEasyPdfDocument document,
                 XEasyPdfPage page)
```
    绘制
    
    指定者:
    
    draw 在接口中 XEasyPdfComponent
    
    参数:
    
    document - pdf文档
    
    page - pdf页面
  - onBeforeDraw
```
public void onBeforeDraw(XEasyPdfComponentEvent event)
```
    绘制之前
    
    参数:
    
    event - 组件事件
  - onAfterDraw
```
public void onAfterDraw(XEasyPdfComponentEvent event)
```
    绘制之后
    
    参数:
    
    event - 组件事件

类 XEasyPdfTextScript

嵌套类概要

从接口继承的嵌套类/接口 org.dromara.pdf.pdfbox.component.XEasyPdfComponent

构造器概要

方法概要

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

构造器详细资料

XEasyPdfTextScript

方法详细资料

enableChildComponent

enableUnderline

enableDeleteLine

enableHighlight

enableRotateLine

enableResetContext

enableSelfStyle

disableSelfStyle

setAutoIndent

setMargin

setMarginLeft

setMarginRight

setMarginTop

setMarginBottom

setLeading

setCharacterSpacing

setFontPath

setDefaultFontStyle

setFontSize

setFontColor

setHighlightColor

setUnderlineColor

setUnderlineWidth

setDeleteLineColor

setDeleteLineWidth

setLink

setComment

setAlpha

setReplaceCharacters

setReplaceCharacters

setNewLine

setCheckPage

setPosition

setWidth

setHeight

setMaxHeight

setContentMode

setRenderingMode

setPagingCondition

setNeedInitialize

setFontScaleRatio

setScriptType

getHeight

getWidth

getContentMode

getMarginTop

getMarginBottom

getMarginLeft

getMarginRight

getSplitTextList

getFontSize

getFontPath

getLeading

getCharacterSpacing

getHorizontalStyle

getVerticalStyle

isNeedInitialize

draw

onBeforeDraw

onAfterDraw