XEasyPdfText (x-easypdf-pdfbox 2.12.2 API)

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

所有已实现的接口:

Serializable, XEasyPdfComponent
```
public class XEasyPdfText
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

构造器概要

构造器
构造器和说明
`XEasyPdfText(float fontSize, List<String> textList)` 有参构造
`XEasyPdfText(float fontSize, String text)` 有参构造
`XEasyPdfText(List<String> textList)` 有参构造
`XEasyPdfText(String text)` 有参构造

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`XEasyPdfText`	`disableSelfStyle()` 关闭自身样式
`void`	`draw(XEasyPdfDocument document, XEasyPdfPage page)` 绘制
`XEasyPdfText`	`enableCenterStyle()` 开启居中样式（水平居中，垂直居中）
`XEasyPdfText`	`enableChildComponent()` 开启子组件
`XEasyPdfText`	`enableDeleteLine()` 开启删除线
`XEasyPdfText`	`enableHighlight()` 开启高亮
`XEasyPdfText`	`enableResetContext()` 开启上下文重置
`XEasyPdfText`	`enableRotateLine()` 开启整行旋转
`XEasyPdfText`	`enableSelfStyle()` 开启自身样式
`XEasyPdfText`	`enableTextAppend()` 开启文本追加
`XEasyPdfText`	`enableUnderline()` 开启下划线
`float`	`getAlpha()` 获取透明度
`float`	`getCharacterSpacing()` 获取文本间隔
`XEasyPdfComponent.ContentMode`	`getContentMode()` 获取内容模式
`Color`	`getFontColor()` 获取字体颜色
`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)` 绘制之前
`XEasyPdfText`	`replaceAllPlaceholder(String placeholder, String value)` 替换占位符
`XEasyPdfText`	`setAlpha(float alpha)` 设置文本透明度
`XEasyPdfText`	`setAutoIndent(int indent)` 设置自动缩进
`XEasyPdfText`	`setCharacterSpacing(float characterSpacing)` 设置文本间隔
`XEasyPdfText`	`setCheckPage(boolean isCheckPage)` 设置是否分页检查
`XEasyPdfText`	`setComment(String comment)` 设置评论
`XEasyPdfText`	`setContentMode(XEasyPdfComponent.ContentMode mode)` 设置内容模式
`XEasyPdfText`	`setDefaultFontStyle(XEasyPdfDefaultFontStyle style)` 设置默认字体样式
`XEasyPdfText`	`setDeleteLineColor(Color deleteLineColor)` 设置删除线颜色
`XEasyPdfText`	`setDeleteLineWidth(float deleteLineWidth)` 设置删除线线宽
`XEasyPdfText`	`setFontColor(Color fontColor)` 设置字体颜色
`XEasyPdfText`	`setFontPath(String fontPath)` 设置字体路径
`XEasyPdfText`	`setFontSize(float fontSize)` 设置字体大小
`XEasyPdfText`	`setHeight(float height)` 设置高度
`XEasyPdfText`	`setHighlightColor(Color highlightColor)` 设置高亮颜色
`XEasyPdfText`	`setHorizontalStyle(XEasyPdfPositionStyle style)` 设置水平样式（居左、居中、居右）
`XEasyPdfText`	`setLeading(float leading)` 设置行间距
`XEasyPdfText`	`setLink(String linkUrl)` 设置超链接地址
`XEasyPdfText`	`setMargin(float margin)` 设置边距（上下左右）
`XEasyPdfText`	`setMarginBottom(float margin)` 设置下边距
`XEasyPdfText`	`setMarginLeft(float margin)` 设置左边距
`XEasyPdfText`	`setMarginRight(float margin)` 设置右边距
`XEasyPdfText`	`setMarginTop(float margin)` 设置上边距
`XEasyPdfText`	`setMaxHeight(Float maxHeight)` 设置最大高度
`XEasyPdfText`	`setNeedInitialize(boolean needInitialize)` 设置是否需要初始化
`XEasyPdfText`	`setNewLine(boolean isNewLine)` 设置是否换行（影响下一个组件是否换行）
`XEasyPdfText`	`setPagingCondition(XEasyPdfPagingCondition pagingCondition)` 设置分页条件
`XEasyPdfText`	`setPosition(float beginX, float beginY)` 设置定位
`XEasyPdfText`	`setRadians(double radians)` 设置文本弧度(逆时针旋转)
`XEasyPdfText`	`setRenderingMode(XEasypdfTextRenderingMode renderingMode)` 设置渲染模式
`XEasyPdfText`	`setReplaceCharacters(Map<String,String> replaceMap)` 设置替换字符
`XEasyPdfText`	`setReplaceCharacters(String oldValue, String replacement)` 设置替换字符
`XEasyPdfText`	`setSplitTextList(List<String> splitTextList)` 设置拆分后的待添加文本列表
`XEasyPdfText`	`setUnderlineColor(Color underlineColor)` 设置下划线颜色
`XEasyPdfText`	`setUnderlineWidth(float underlineWidth)` 设置下划线线宽
`XEasyPdfText`	`setVerticalStyle(XEasyPdfPositionStyle style)` 设置垂直样式（居上、居中、居下）
`XEasyPdfText`	`setWidth(float width)` 设置宽度

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

- 构造器详细资料
  - XEasyPdfText
```
public XEasyPdfText(String text)
```
    有参构造
    
    参数:
    
    text - 待输入文本
  - XEasyPdfText
```
public XEasyPdfText(List<String> textList)
```
    有参构造
    
    参数:
    
    textList - 待输入文本列表
  - XEasyPdfText
```
public XEasyPdfText(float fontSize,
                    String text)
```
    有参构造
    
    参数:
    
    fontSize - 字体大小
    
    text - 待输入文本
  - XEasyPdfText
```
public XEasyPdfText(float fontSize,
                    List<String> textList)
```
    有参构造
    
    参数:
    
    fontSize - 字体大小
    
    textList - 待输入文本列表
- 方法详细资料
  - enableTextAppend
```
public XEasyPdfText enableTextAppend()
```
    开启文本追加
    
    返回:
    
    返回文本组件
  - enableCenterStyle
```
public XEasyPdfText enableCenterStyle()
```
    开启居中样式（水平居中，垂直居中）
    
    返回:
    
    返回文本组件
  - enableChildComponent
```
public XEasyPdfText enableChildComponent()
```
    开启子组件
    
    返回:
    
    返回文本组件
  - enableUnderline
```
public XEasyPdfText enableUnderline()
```
    开启下划线
    
    返回:
    
    返回文本组件
  - enableDeleteLine
```
public XEasyPdfText enableDeleteLine()
```
    开启删除线
    
    返回:
    
    返回文本组件
  - enableHighlight
```
public XEasyPdfText enableHighlight()
```
    开启高亮
    
    返回:
    
    返回文本组件
  - enableRotateLine
```
public XEasyPdfText enableRotateLine()
```
    开启整行旋转
    
    返回:
    
    返回文本组件
  - enableResetContext
```
public XEasyPdfText enableResetContext()
```
    开启上下文重置
    
    指定者:
    
    enableResetContext 在接口中 XEasyPdfComponent
    
    返回:
    
    返回文本组件
  - enableSelfStyle
```
public XEasyPdfText enableSelfStyle()
```
    开启自身样式
    
    返回:
    
    返回文本组件
  - disableSelfStyle
```
public XEasyPdfText disableSelfStyle()
```
    关闭自身样式
    
    返回:
    
    返回文本组件
  - setAutoIndent
```
public XEasyPdfText setAutoIndent(int indent)
```
    设置自动缩进
    
    参数:
    
    indent - 缩进值
    
    返回:
    
    返回文本组件
  - setMargin
```
public XEasyPdfText setMargin(float margin)
```
    设置边距（上下左右）
    
    参数:
    
    margin - 边距
    
    返回:
    
    返回文本组件
  - setMarginLeft
```
public XEasyPdfText setMarginLeft(float margin)
```
    设置左边距
    
    参数:
    
    margin - 边距
    
    返回:
    
    返回文本组件
  - setMarginRight
```
public XEasyPdfText setMarginRight(float margin)
```
    设置右边距
    
    参数:
    
    margin - 边距
    
    返回:
    
    返回文本组件
  - setMarginTop
```
public XEasyPdfText setMarginTop(float margin)
```
    设置上边距
    
    参数:
    
    margin - 边距
    
    返回:
    
    返回文本组件
  - setMarginBottom
```
public XEasyPdfText setMarginBottom(float margin)
```
    设置下边距
    
    参数:
    
    margin - 边距
    
    返回:
    
    返回文本组件
  - setLeading
```
public XEasyPdfText setLeading(float leading)
```
    设置行间距
    
    参数:
    
    leading - 行间距
    
    返回:
    
    返回文本组件
  - setCharacterSpacing
```
public XEasyPdfText setCharacterSpacing(float characterSpacing)
```
    设置文本间隔
    
    参数:
    
    characterSpacing - 文本间隔
    
    返回:
    
    返回文本组件
  - setFontPath
```
public XEasyPdfText setFontPath(String fontPath)
```
    设置字体路径
    
    参数:
    
    fontPath - 字体路径
    
    返回:
    
    返回文本组件
  - setDefaultFontStyle
```
public XEasyPdfText setDefaultFontStyle(XEasyPdfDefaultFontStyle style)
```
    设置默认字体样式
    
    参数:
    
    style - 默认字体样式
    
    返回:
    
    返回文本组件
  - setFontSize
```
public XEasyPdfText setFontSize(float fontSize)
```
    设置字体大小
    
    参数:
    
    fontSize - 字体大小
    
    返回:
    
    返回文本组件
  - setFontColor
```
public XEasyPdfText setFontColor(Color fontColor)
```
    设置字体颜色
    
    参数:
    
    fontColor - 字体颜色
    
    返回:
    
    返回文本组件
  - setHighlightColor
```
public XEasyPdfText setHighlightColor(Color highlightColor)
```
    设置高亮颜色
    
    参数:
    
    highlightColor - 高亮颜色
    
    返回:
    
    返回文本组件
  - setUnderlineColor
```
public XEasyPdfText setUnderlineColor(Color underlineColor)
```
    设置下划线颜色
    
    参数:
    
    underlineColor - 下划线颜色
    
    返回:
    
    返回文本组件
  - setUnderlineWidth
```
public XEasyPdfText setUnderlineWidth(float underlineWidth)
```
    设置下划线线宽
    
    参数:
    
    underlineWidth - 下划线线宽
    
    返回:
    
    返回文本组件
  - setDeleteLineColor
```
public XEasyPdfText setDeleteLineColor(Color deleteLineColor)
```
    设置删除线颜色
    
    参数:
    
    deleteLineColor - 删除线颜色
    
    返回:
    
    返回文本组件
  - setDeleteLineWidth
```
public XEasyPdfText setDeleteLineWidth(float deleteLineWidth)
```
    设置删除线线宽
    
    参数:
    
    deleteLineWidth - 删除线线宽
    
    返回:
    
    返回文本组件
  - setLink
```
public XEasyPdfText setLink(String linkUrl)
```
    设置超链接地址
    
    参数:
    
    linkUrl - 超链接地址
    
    返回:
    
    返回文本组件
  - setComment
```
public XEasyPdfText setComment(String comment)
```
    设置评论
    
    参数:
    
    comment - 评论
    
    返回:
    
    返回文本组件
  - setAlpha
```
public XEasyPdfText setAlpha(float alpha)
```
    设置文本透明度
    
    参数:
    
    alpha - 文本透明度
    
    返回:
    
    返回页面水印组件
  - setRadians
```
public XEasyPdfText setRadians(double radians)
```
    设置文本弧度(逆时针旋转)
    
    参数:
    
    radians - 文本弧度
    
    返回:
    
    返回文本扩展组件
  - setHorizontalStyle
```
public XEasyPdfText setHorizontalStyle(XEasyPdfPositionStyle style)
```
    设置水平样式（居左、居中、居右）
    
    参数:
    
    style - 样式
    
    返回:
    
    返回文本组件
  - setVerticalStyle
```
public XEasyPdfText setVerticalStyle(XEasyPdfPositionStyle style)
```
    设置垂直样式（居上、居中、居下）
    
    参数:
    
    style - 样式
    
    返回:
    
    返回文本组件
  - setSplitTextList
```
public XEasyPdfText setSplitTextList(List<String> splitTextList)
```
    设置拆分后的待添加文本列表
    
    参数:
    
    splitTextList - 拆分后的待添加文本列表
    
    返回:
    
    返回文本组件
  - setReplaceCharacters
```
public XEasyPdfText setReplaceCharacters(String oldValue,
                                         String replacement)
```
    设置替换字符
    
    参数:
    
    oldValue - 待替换字符串
    
    replacement - 替换字符串
    
    返回:
    
    返回返回文本组件
  - setReplaceCharacters
```
public XEasyPdfText setReplaceCharacters(Map<String,String> replaceMap)
```
    设置替换字符
    
    参数:
    
    replaceMap - 待替换字典
    
    返回:
    
    返回返回文本组件
  - setNewLine
```
public XEasyPdfText setNewLine(boolean isNewLine)
```
    设置是否换行（影响下一个组件是否换行）
    
    参数:
    
    isNewLine - 是否换行
    
    返回:
    
    返回文本组件
  - setCheckPage
```
public XEasyPdfText setCheckPage(boolean isCheckPage)
```
    设置是否分页检查
    
    参数:
    
    isCheckPage - 是否分页检查
    
    返回:
    
    返回文本组件
  - setPosition
```
public XEasyPdfText setPosition(float beginX,
                                float beginY)
```
    设置定位
    
    指定者:
    
    setPosition 在接口中 XEasyPdfComponent
    
    参数:
    
    beginX - 当前页面X轴坐标
    
    beginY - 当前页面Y轴坐标
    
    返回:
    
    返回文本组件
  - setWidth
```
public XEasyPdfText setWidth(float width)
```
    设置宽度
    
    指定者:
    
    setWidth 在接口中 XEasyPdfComponent
    
    参数:
    
    width - 宽度
    
    返回:
    
    返回文本组件
  - setHeight
```
public XEasyPdfText setHeight(float height)
```
    设置高度
    
    指定者:
    
    setHeight 在接口中 XEasyPdfComponent
    
    参数:
    
    height - 高度
    
    返回:
    
    返回文本组件
  - setMaxHeight
```
public XEasyPdfText setMaxHeight(Float maxHeight)
```
    设置最大高度
    
    参数:
    
    maxHeight - 最大高度
    
    返回:
    
    返回文本组件
  - setContentMode
```
public XEasyPdfText setContentMode(XEasyPdfComponent.ContentMode mode)
```
    设置内容模式
    
    指定者:
    
    setContentMode 在接口中 XEasyPdfComponent
    
    参数:
    
    mode - 内容模式
    
    返回:
    
    返回文本组件
  - setRenderingMode
```
public XEasyPdfText setRenderingMode(XEasypdfTextRenderingMode renderingMode)
```
    设置渲染模式
    
    参数:
    
    renderingMode - 渲染模式
    
    返回:
    
    返回文本组件
  - setPagingCondition
```
public XEasyPdfText setPagingCondition(XEasyPdfPagingCondition pagingCondition)
```
    设置分页条件
    
    参数:
    
    pagingCondition - 分页条件
    
    返回:
    
    返回文本组件
  - setNeedInitialize
```
public XEasyPdfText setNeedInitialize(boolean needInitialize)
```
    设置是否需要初始化
    
    参数:
    
    needInitialize - 是否需要初始化
    
    返回:
    
    返回文本组件
  - replaceAllPlaceholder
```
public XEasyPdfText replaceAllPlaceholder(String placeholder,
                                          String value)
```
    替换占位符
    
    参数:
    
    placeholder - 占位符
    
    value - 新字符串
    
    返回:
    
    返回文本组件
  - 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()
```
    获取文本间隔
    
    返回:
    
    返回文本间隔
  - getAlpha
```
public float getAlpha()
```
    获取透明度
    
    返回:
    
    返回透明度
  - getFontColor
```
public Color getFontColor()
```
    获取字体颜色
    
    返回:
    
    返回字体颜色
  - getHorizontalStyle
```
public XEasyPdfPositionStyle getHorizontalStyle()
```
    获取水平样式
    
    返回:
    
    返回水平样式
  - getVerticalStyle
```
public XEasyPdfPositionStyle getVerticalStyle()
```
    获取垂直样式
    
    返回:
    
    返回垂直样式
  - isNeedInitialize
```
public boolean isNeedInitialize()
```
    是否需要初始化
    
    返回:
    
    返回布尔值，是为true，否为false
  - onBeforeDraw
```
public void onBeforeDraw(XEasyPdfComponentEvent event)
```
    绘制之前
    
    参数:
    
    event - 组件事件
  - onAfterDraw
```
public void onAfterDraw(XEasyPdfComponentEvent event)
```
    绘制之后
    
    参数:
    
    event - 组件事件
  - draw
```
public void draw(XEasyPdfDocument document,
                 XEasyPdfPage page)
```
    绘制
    
    指定者:
    
    draw 在接口中 XEasyPdfComponent
    
    参数:
    
    document - pdf文档
    
    page - pdf页面

类 XEasyPdfText

嵌套类概要

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

构造器概要

方法概要

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

构造器详细资料

XEasyPdfText

XEasyPdfText

XEasyPdfText

XEasyPdfText

方法详细资料

enableTextAppend

enableCenterStyle

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

setRadians

setHorizontalStyle

setVerticalStyle

setSplitTextList

setReplaceCharacters

setReplaceCharacters

setNewLine

setCheckPage

setPosition

setWidth

setHeight

setMaxHeight

setContentMode

setRenderingMode

setPagingCondition

setNeedInitialize

replaceAllPlaceholder

getHeight

getWidth

getContentMode

getMarginTop

getMarginBottom

getMarginLeft

getMarginRight

getSplitTextList

getFontSize

getFontPath

getLeading

getCharacterSpacing

getAlpha

getFontColor

getHorizontalStyle

getVerticalStyle

isNeedInitialize

onBeforeDraw

onAfterDraw

draw