org.dromara.pdf.pdfbox.core.component

类 Textarea

java.lang.Object

org.dromara.pdf.pdfbox.core.base.AbstractBase

org.dromara.pdf.pdfbox.core.base.AbstractBaseMargin

org.dromara.pdf.pdfbox.core.base.AbstractBaseBorder

org.dromara.pdf.pdfbox.core.base.AbstractBaseFont

org.dromara.pdf.pdfbox.core.component.AbstractComponent

org.dromara.pdf.pdfbox.core.component.Textarea

所有已实现的接口:

Closeable, AutoCloseable, Component

public class Textarea
extends AbstractComponent

文本域组件

从以下版本开始:

1.8

Copyright (c) 2020 xsx All Rights Reserved. x-easypdf-pdfbox 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

字段概要

字段

限定符和类型	字段和说明
protected CatalogInfo	catalog 目录
protected Color	deleteLineColor 删除线颜色
protected Float	deleteLineWidth 删除线宽度
protected Color	highlightColor 高亮颜色
protected InnerDest	innerDest 内部目标
protected Boolean	isDeleteLine 是否删除线
protected Boolean	isHighlight 是否高亮
protected Boolean	isUnderline 是否下划线
protected OuterDest	outerDest 外部目标
protected Integer	tabSize 制表符大小
protected String	text 文本内容
protected List<String>	textList 文本列表
protected Color	underlineColor 下划线颜色
protected Float	underlineWidth 下划线宽度

构造器概要

构造器

构造器和说明
Textarea(Page page) 有参构造

方法概要

限定符和类型	方法和说明
protected void	addBorder(org.apache.pdfbox.pdmodel.common.PDRectangle rectangle, org.apache.pdfbox.pdmodel.PDPageContentStream stream) 添加边框
protected void	addDeleteLine(org.apache.pdfbox.pdmodel.common.PDRectangle rectangle, org.apache.pdfbox.pdmodel.PDPageContentStream stream) 添加删除线
protected void	addHighlight(org.apache.pdfbox.pdmodel.common.PDRectangle rectangle, org.apache.pdfbox.pdmodel.PDPageContentStream contentStream) 添加高亮（不支持旋转）
protected void	addInnerDest(org.apache.pdfbox.pdmodel.common.PDRectangle rectangle) 添加内部目标
protected void	addLink(org.apache.pdfbox.pdmodel.interactive.action.PDAction action, String name, org.apache.pdfbox.pdmodel.common.PDRectangle rectangle, HighlightMode mode) 添加链接
protected void	addOuterDest(org.apache.pdfbox.pdmodel.common.PDRectangle rectangle) 添加外部目标
protected void	addText(String text, org.apache.pdfbox.pdmodel.common.PDRectangle rectangle, org.apache.pdfbox.pdmodel.PDPageContentStream contentStream) 添加文本
protected void	addUnderline(org.apache.pdfbox.pdmodel.common.PDRectangle rectangle, org.apache.pdfbox.pdmodel.PDPageContentStream stream) 添加下划线
protected org.apache.pdfbox.pdmodel.common.PDRectangle	getLineRectangle(float textWidth, Position position) 获取行尺寸
String	getPlaceholder() 获取页码占位符
ComponentType	getType() 获取类型
protected void	init() 初始化
protected void	initCatalog(Position position) 初始化目录
protected org.apache.pdfbox.pdmodel.PDPageContentStream	initContentStream() 初始化内容流
protected void	initFontColorAndAlpha(org.apache.pdfbox.pdmodel.PDPageContentStream stream) 初始化字体颜色及透明度
protected void	initPosition(org.apache.pdfbox.pdmodel.PDPageContentStream stream, float beginX, float beginY) 初始化位置
protected void	initText() 初始化文本
protected void	initTextList(List<String> tempTextList) 初始化文本列表
protected void	initTextList(List<String> tempTextList, float firstLineWidth, float newLineWidth) 初始化文本列表
protected List<String>	processText(String text) 处理文本
void	render() 渲染
protected void	resetPagePosition(Position position, float textWidth) 重置页面位置坐标
void	setDeleteLineWidth(float width) 设置删除线宽度
void	setFontName(String fontName) 设置字体名称
void	setTabSize(int size) 设置制表符大小（空格数）
void	setUnderlineWidth(float width) 设置下划线宽度
void	virtualRender() 虚拟渲染
protected void	virtualWrite(String text, Position position) 虚拟写入
protected org.apache.pdfbox.pdmodel.PDPageContentStream	write(String text, float textWidth, org.apache.pdfbox.pdmodel.PDPageContentStream contentStream, Position position) 写入

从类继承的方法 org.dromara.pdf.pdfbox.core.component.AbstractComponent

checkPaging, checkWrap, close, executeBreak, getBase, getBottom, getPage, initBase, isPaging, isPagingComponent, isWrap, paging, processBreak, reset, resetWrapWidth, resetXY, setBeginX, setBeginX, setBeginY, setBeginY, wrap

从类继承的方法 org.dromara.pdf.pdfbox.core.base.AbstractBaseFont

init, initFont, setCharacterSpacing, setFontSize, setLeading

从类继承的方法 org.dromara.pdf.pdfbox.core.base.AbstractBaseBorder

init, initBorder, setBorderColor, setBorderLineLength, setBorderLineSpacing, setBorderWidth, setIsBorder

从类继承的方法 org.dromara.pdf.pdfbox.core.base.AbstractBaseMargin

init, initMargin, initMargin, initMarginWithParam, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop

从类继承的方法 org.dromara.pdf.pdfbox.core.base.AbstractBase

init, setHorizontalAlignment, setVerticalAlignment

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 org.dromara.pdf.pdfbox.core.component.Component

getContext, getPagingCondition, getPagingEvents

字段详细资料

catalog

protected CatalogInfo catalog

目录

tabSize

protected Integer tabSize

制表符大小

text

protected String text

文本内容

textList

protected List<String> textList

文本列表

highlightColor

protected Color highlightColor

高亮颜色

isHighlight

protected Boolean isHighlight

是否高亮

underlineWidth

protected Float underlineWidth

下划线宽度

underlineColor

protected Color underlineColor

下划线颜色

isUnderline

protected Boolean isUnderline

是否下划线

deleteLineWidth

protected Float deleteLineWidth

删除线宽度

deleteLineColor

protected Color deleteLineColor

删除线颜色

isDeleteLine

protected Boolean isDeleteLine

是否删除线

innerDest

protected InnerDest innerDest

内部目标

outerDest

protected OuterDest outerDest

外部目标

构造器详细资料

Textarea

public Textarea(Page page)

有参构造

参数:

page - 页面

方法详细资料

setFontName

public void setFontName(String fontName)

设置字体名称

参数:

fontName - 字体名称

setTabSize

public void setTabSize(int size)

设置制表符大小（空格数）

参数:

size - 大小

setUnderlineWidth

public void setUnderlineWidth(float width)

设置下划线宽度

参数:

width - 宽度

setDeleteLineWidth

public void setDeleteLineWidth(float width)

设置删除线宽度

参数:

width - 宽度

getType

public ComponentType getType()

获取类型

返回:

返回类型

getPlaceholder

public String getPlaceholder()

获取页码占位符

返回:

返回页码占位符

virtualRender

public void virtualRender()

虚拟渲染

render

public void render()

渲染

init

protected void init()

初始化

覆盖:

init 在类中 AbstractComponent

initText

protected void initText()

初始化文本

processText

protected List<String> processText(String text)

处理文本

参数:

text - 文本

返回:

返回文本列表

initTextList

protected void initTextList(List<String> tempTextList)

初始化文本列表

参数:

tempTextList - 临时文本列表

initTextList

protected void initTextList(List<String> tempTextList,
                            float firstLineWidth,
                            float newLineWidth)

初始化文本列表

参数:

tempTextList - 临时文本列表

firstLineWidth - 首行宽度

newLineWidth - 新行宽度

initCatalog

protected void initCatalog(Position position)

初始化目录

参数:

position - 坐标

virtualWrite

protected void virtualWrite(String text,
                            Position position)

虚拟写入

参数:

text - 文本

position - 坐标

write

protected org.apache.pdfbox.pdmodel.PDPageContentStream write(String text,
                                                              float textWidth,
                                                              org.apache.pdfbox.pdmodel.PDPageContentStream contentStream,
                                                              Position position)

写入

参数:

text - 文本

textWidth - 文本宽度

contentStream - 内容流

position - 坐标

addHighlight

protected void addHighlight(org.apache.pdfbox.pdmodel.common.PDRectangle rectangle,
                            org.apache.pdfbox.pdmodel.PDPageContentStream contentStream)

添加高亮（不支持旋转）

参数:

rectangle - 尺寸

contentStream - 内容流

addText

protected void addText(String text,
                       org.apache.pdfbox.pdmodel.common.PDRectangle rectangle,
                       org.apache.pdfbox.pdmodel.PDPageContentStream contentStream)

添加文本

参数:

text - 文本

rectangle - 尺寸

contentStream - 内容流

addDeleteLine

protected void addDeleteLine(org.apache.pdfbox.pdmodel.common.PDRectangle rectangle,
                             org.apache.pdfbox.pdmodel.PDPageContentStream stream)

添加删除线

参数:

rectangle - 尺寸

stream - 内容流

addUnderline

protected void addUnderline(org.apache.pdfbox.pdmodel.common.PDRectangle rectangle,
                            org.apache.pdfbox.pdmodel.PDPageContentStream stream)

添加下划线

参数:

rectangle - 尺寸

stream - 内容流

addInnerDest

protected void addInnerDest(org.apache.pdfbox.pdmodel.common.PDRectangle rectangle)

添加内部目标

参数:

rectangle - 尺寸

addOuterDest

protected void addOuterDest(org.apache.pdfbox.pdmodel.common.PDRectangle rectangle)

添加外部目标

参数:

rectangle - 尺寸

addLink

protected void addLink(org.apache.pdfbox.pdmodel.interactive.action.PDAction action,
                       String name,
                       org.apache.pdfbox.pdmodel.common.PDRectangle rectangle,
                       HighlightMode mode)

添加链接

参数:

action - 动作

name - 名称

rectangle - 尺寸

addBorder

protected void addBorder(org.apache.pdfbox.pdmodel.common.PDRectangle rectangle,
                         org.apache.pdfbox.pdmodel.PDPageContentStream stream)

添加边框

参数:

rectangle - 尺寸

stream - 内容流

initContentStream

protected org.apache.pdfbox.pdmodel.PDPageContentStream initContentStream()

初始化内容流

返回:

返回内容流

initFontColorAndAlpha

protected void initFontColorAndAlpha(org.apache.pdfbox.pdmodel.PDPageContentStream stream)

初始化字体颜色及透明度

参数:

stream - pdfbox内容流

initPosition

protected void initPosition(org.apache.pdfbox.pdmodel.PDPageContentStream stream,
                            float beginX,
                            float beginY)

初始化位置

参数:

stream - pdfbox内容流

beginX - 起始X轴坐标

beginY - 起始Y轴坐标

getLineRectangle

protected org.apache.pdfbox.pdmodel.common.PDRectangle getLineRectangle(float textWidth,
                                                                        Position position)

获取行尺寸

参数:

textWidth - 文本宽度

position - 坐标

返回:

返回尺寸

resetPagePosition

protected void resetPagePosition(Position position,
                                 float textWidth)

重置页面位置坐标

参数:

position - 坐标

textWidth - 文本宽度