CT_Text (ofdrw-core 1.13.4 API)

java.lang.Object
- org.ofdrw.core.DefaultElementProxy
- - org.ofdrw.core.OFDElement
  - - org.ofdrw.core.pageDescription.CT_GraphicUnit<CT_Text>
    - - org.ofdrw.core.text.text.CT_Text

所有已实现的接口:

Cloneable, org.dom4j.Branch, org.dom4j.Element, org.dom4j.Node, ClipAble

直接已知子类:

TextObject
```
public class CT_Text
extends CT_GraphicUnit<CT_Text>
implements ClipAble
```
文字对象
11.2 文字对象图 59 表 45

从以下版本开始:

2019-10-18 09:27:41

作者:

权观宇

字段概要
- 从类继承的字段 org.ofdrw.core.DefaultElementProxy
  proxy
- 从接口继承的字段 org.dom4j.Node
  ANY_NODE, ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_REFERENCE_NODE, MAX_NODE_TYPE, NAMESPACE_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE, UNKNOWN_NODE

构造器概要

构造器
构造器和说明

CT_Text()

CT_Text(org.dom4j.Element proxy)

CT_Text(String name)

构造器
构造器和说明
`CT_Text()`
`CT_Text(org.dom4j.Element proxy)`
`CT_Text(String name)`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`CT_Text`	`addCGTransform(CT_CGTransform cgTransform)` 【可选】增加指定字符编码到字符索引之间的变换关系描述见 11.4 字符变换
`CT_Text`	`addTextCode(TextCode textCode)` 【必选】增加文字内容也就是一段字符编码串如果字符编码不在XML编码方式的字符范围之内，应采用“\”加四位十六进制数的格式转义；文字内容中出现的空格也需要转义若 TextCode 作为占位符使用时一律采用 ¤ （¤）占位
`List<CT_CGTransform>`	`getCGTransforms()` 【可选】获取指定字符编码到字符索引之间的变换关系序列描述见 11.4 字符变换
`Direction`	`getCharDirection()` 【可选属性】获取字符方向指定了文字放置的方向，描述见 11.3 文字定位默认值为 0
`Boolean`	`getFill()` 【可选属性】获取是否填充默认值为 true
`FillColor`	`getFillColor()` 【可选】获取填充颜色默认为黑色
`ST_RefID`	`getFont()` 【必选属性】获取引用资源文件路径
`Double`	`getHScale()` 【可选属性】获取字形在水平方向的缩放比默认值为 1.0 例如：当 HScale 值为 0.5 时表示实际显示的字宽为原来字宽的一半。
`Boolean`	`getItalic()` 【可选属性】获取是否是斜体样式默认值为 false
`Direction`	`getReadDirection()` 【可选属性】获取阅读方向指定了文字排列的方向，描述见 11.3 文字定位默认值为 0
`Double`	`getSize()` 【必选属性】获取字号，单位为毫米
`Boolean`	`getStroke()` 【可选属性】获取是否勾边默认值为 false
`StrokeColor`	`getStrokeColor()` 【可选】获取勾边颜色默认为透明色
`List<TextCode>`	`getTextCodes()` 【必选】获取文字内容序列也就是一段字符编码串如果字符编码不在XML编码方式的字符范围之内，应采用“\”加四位十六进制数的格式转义；文字内容中出现的空格也需要转义若 TextCode 作为占位符使用时一律采用 ¤ （¤）占位
`Weight`	`getWeight()` 【可选属性】设置文字对象的粗细值默认值为 400
`CT_Text`	`setCharDirection(Direction charDirection)` 【可选属性】指定字符方向指定了文字放置的方向，描述见 11.3 文字定位默认值为 0
`CT_Text`	`setFill(Boolean fill)` 【可选属性】设置是否填充默认值为 true
`CT_Text`	`setFillColor(CT_Color fillColor)` 【可选】设置填充颜色默认为黑色
`CT_Text`	`setFont(long refId)` 【必选属性】设置引用资源文件中定义的字形标识
`CT_Text`	`setFont(ST_RefID font)` 【必选属性】设置引用资源文件中定义的字形标识
`CT_Text`	`setHScale(Double hScale)` 【可选属性】设置字形在水平方向的缩放比默认值为 1.0 例如：当 HScale 值为 0.5 时表示实际显示的字宽为原来字宽的一半。
`CT_Text`	`setItalic(Boolean italic)` 【可选属性】设置是否是斜体样式默认值为 false
`CT_Text`	`setReadDirection(Direction readDirection)` 【可选属性】指定阅读方向指定了文字排列的方向，描述见 11.3 文字定位默认值为 0
`CT_Text`	`setSize(Double size)` 【必选属性】设置字号，单位为毫米
`CT_Text`	`setStroke(Boolean stroke)` 【可选属性】设置是否勾边默认值为 false
`CT_Text`	`setStrokeColor(CT_Color strokeColor)` 【可选】设置勾边颜色默认为透明色
`CT_Text`	`setWeight(Weight weight)` 【可选属性】设置文字对象的粗细值默认值为 400
`static CT_Text`	`textObject(ST_ID id)` 获取文字对象
`TextObject`	`toObj(ST_ID id)` 构造文字对象

从类继承的方法 org.ofdrw.core.pageDescription.CT_GraphicUnit
getActions, getAlpha, getBoundary, getCap, getClips, getCTM, getDashOffset, getDashPattern, getDrawParam, getGraphicName, getJoin, getLineWidth, getMiterLimit, getVisible, setActions, setAlpha, setBoundary, setBoundary, setCap, setClips, setCTM, setDashOffset, setDashPattern, setDrawParam, setGraphicName, setJoin, setLineWidth, setMiterLimit, setVisible

从类继承的方法 org.ofdrw.core.OFDElement
addOFDEntity, getElements, getInstance, getObjID, getOFDElement, getOFDElement, getOFDElements, getOFDElementText, getQualifiedName, removeAll, removeAttr, removeOFDElemByNames, set, setObjID, setObjID, setOFDEntity, setOFDName

从类继承的方法 org.ofdrw.core.DefaultElementProxy
accept, add, add, add, add, add, add, add, add, add, addAttribute, addAttribute, addCDATA, addComment, addElement, addElement, addElement, addEntity, additionalNamespaces, addNamespace, addProcessingInstruction, addProcessingInstruction, addText, appendAttributes, appendContent, asXML, asXPathResult, attribute, attribute, attribute, attributeCount, attributeIterator, attributes, attributeValue, attributeValue, attributeValue, attributeValue, clearContent, clone, content, createCopy, createCopy, createCopy, createXPath, declaredNamespaces, detach, element, element, elementByID, elementIterator, elementIterator, elementIterator, elements, elements, elements, elementText, elementText, elementTextTrim, elementTextTrim, equals, getData, getDocument, getName, getNamespace, getNamespaceForPrefix, getNamespaceForURI, getNamespacePrefix, getNamespacesForURI, getNamespaceURI, getNodeType, getNodeTypeName, getParent, getPath, getPath, getProxy, getQName, getQName, getStringValue, getText, getTextTrim, getUniquePath, getUniquePath, getXPathResult, hasContent, hasMixedContent, indexOf, isReadOnly, isRootElement, isTextOnly, matches, node, nodeCount, nodeIterator, normalize, numberValueOf, processingInstruction, processingInstructions, processingInstructions, remove, remove, remove, remove, remove, remove, remove, remove, remove, removeProcessingInstruction, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, setAttributes, setAttributeValue, setAttributeValue, setContent, setData, setDocument, setName, setParent, setProcessingInstructions, setProxy, setQName, setText, supportsParent, valueOf, write

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

从接口继承的方法 org.ofdrw.core.pageDescription.clips.ClipAble
getInstance

从接口继承的方法 org.dom4j.Element
add, add, add, add, add, addAttribute, addAttribute, addCDATA, addComment, addEntity, additionalNamespaces, addNamespace, addProcessingInstruction, addProcessingInstruction, addText, appendAttributes, attribute, attribute, attribute, attributeCount, attributeIterator, attributes, attributeValue, attributeValue, attributeValue, attributeValue, createCopy, createCopy, createCopy, declaredNamespaces, element, element, elementIterator, elementIterator, elementIterator, elements, elements, elements, elementText, elementText, elementTextTrim, elementTextTrim, getData, getNamespace, getNamespaceForPrefix, getNamespaceForURI, getNamespacePrefix, getNamespacesForURI, getNamespaceURI, getQName, getQName, getQualifiedName, getStringValue, getText, getTextTrim, getXPathResult, hasMixedContent, isRootElement, isTextOnly, remove, remove, remove, remove, remove, setAttributes, setAttributeValue, setAttributeValue, setData, setQName

从接口继承的方法 org.dom4j.Branch
add, add, add, add, addElement, addElement, addElement, appendContent, clearContent, content, elementByID, indexOf, node, nodeCount, nodeIterator, normalize, processingInstruction, processingInstructions, processingInstructions, remove, remove, remove, remove, removeProcessingInstruction, setContent, setProcessingInstructions

从接口继承的方法 org.dom4j.Node
accept, asXML, asXPathResult, clone, createXPath, detach, getDocument, getName, getNodeType, getNodeTypeName, getParent, getPath, getPath, getUniquePath, getUniquePath, hasContent, isReadOnly, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, setDocument, setName, setParent, setText, supportsParent, valueOf, write

- 构造器详细资料
  - CT_Text
```
public CT_Text(org.dom4j.Element proxy)
```
  - CT_Text
```
public CT_Text(String name)
```
  - CT_Text
```
public CT_Text()
```
- 方法详细资料
  - textObject
```
public static CT_Text textObject(ST_ID id)
```
    获取文字对象
    
    参数:
    
    id - 文字对象ID
    
    返回:
    
    文字对象 TextObject
  - toObj
```
public TextObject toObj(ST_ID id)
```
    构造文字对象
    
    参数:
    
    id - 对象ID
    
    返回:
    
    对象
  - setFont
```
public CT_Text setFont(ST_RefID font)
```
    【必选属性】设置引用资源文件中定义的字形标识
    
    参数:
    
    font - 引用字形资源文件路径
    
    返回:
    
    this
  - setFont
```
public CT_Text setFont(long refId)
```
    【必选属性】设置引用资源文件中定义的字形标识
    
    参数:
    
    refId - ID
    
    返回:
    
    this
  - getFont
```
public ST_RefID getFont()
```
    【必选属性】获取引用资源文件路径
    
    返回:
    
    引用字形资源文件路径
  - setSize
```
public CT_Text setSize(Double size)
```
    【必选属性】设置字号，单位为毫米
    
    参数:
    
    size - 字号，单位为毫米
    
    返回:
    
    this
  - getSize
```
public Double getSize()
```
    【必选属性】获取字号，单位为毫米
    
    返回:
    
    字号，单位为毫米
  - setStroke
```
public CT_Text setStroke(Boolean stroke)
```
    【可选属性】设置是否勾边
    默认值为 false
    
    参数:
    
    stroke - true - 勾边；false - 不勾边
    
    返回:
    
    this
  - getStroke
```
public Boolean getStroke()
```
    【可选属性】获取是否勾边
    默认值为 false
    
    返回:
    
    true - 勾边；false - 不勾边
  - setFill
```
public CT_Text setFill(Boolean fill)
```
    【可选属性】设置是否填充
    默认值为 true
    
    参数:
    
    fill - true - 填充；false - 不填充
    
    返回:
    
    this
  - getFill
```
public Boolean getFill()
```
    【可选属性】获取是否填充
    默认值为 true
    
    返回:
    
    true - 填充；false - 不填充
  - setHScale
```
public CT_Text setHScale(Double hScale)
```
    【可选属性】设置字形在水平方向的缩放比
    默认值为 1.0
    例如：当 HScale 值为 0.5 时表示实际显示的字宽为原来字宽的一半。
    
    参数:
    
    hScale - 字形在水平方向的缩放比
    
    返回:
    
    this
  - getHScale
```
public Double getHScale()
```
    【可选属性】获取字形在水平方向的缩放比
    默认值为 1.0
    例如：当 HScale 值为 0.5 时表示实际显示的字宽为原来字宽的一半。
    
    返回:
    
    字形在水平方向的缩放比
  - setReadDirection
```
public CT_Text setReadDirection(Direction readDirection)
```
    【可选属性】指定阅读方向
    指定了文字排列的方向，描述见 11.3 文字定位
    默认值为 0
    
    参数:
    
    readDirection - 阅读方向，可选值为Direction
    
    返回:
    
    this
  - getReadDirection
```
public Direction getReadDirection()
```
    【可选属性】获取阅读方向
    指定了文字排列的方向，描述见 11.3 文字定位
    默认值为 0
    
    返回:
    
    阅读方向，可选值为Direction
  - setCharDirection
```
public CT_Text setCharDirection(Direction charDirection)
```
    【可选属性】指定字符方向
    指定了文字放置的方向，描述见 11.3 文字定位
    默认值为 0
    
    参数:
    
    charDirection - 字符方向，可选值为Direction
    
    返回:
    
    this
  - getCharDirection
```
public Direction getCharDirection()
```
    【可选属性】获取字符方向
    指定了文字放置的方向，描述见 11.3 文字定位
    默认值为 0
    
    返回:
    
    字符方向，可选值为Direction
  - setWeight
```
public CT_Text setWeight(Weight weight)
```
    【可选属性】设置文字对象的粗细值
    默认值为 400
    
    参数:
    
    weight - 文字对象的粗细值，可选值Weight
    
    返回:
    
    this
  - getWeight
```
public Weight getWeight()
```
    【可选属性】设置文字对象的粗细值
    默认值为 400
    
    返回:
    
    文字对象的粗细值，可选值Weight
  - setItalic
```
public CT_Text setItalic(Boolean italic)
```
    【可选属性】设置是否是斜体样式
    默认值为 false
    
    参数:
    
    italic - true - 斜体样式； false - 正常
    
    返回:
    
    this
  - getItalic
```
public Boolean getItalic()
```
    【可选属性】获取是否是斜体样式
    默认值为 false
    
    返回:
    
    true - 斜体样式； false - 正常
  - setFillColor
```
public CT_Text setFillColor(CT_Color fillColor)
```
    【可选】设置填充颜色
    默认为黑色
    
    参数:
    
    fillColor - 填充颜色
    
    返回:
    
    this
  - getFillColor
```
public FillColor getFillColor()
```
    【可选】获取填充颜色
    默认为黑色
    
    返回:
    
    填充颜色，null表示黑色
  - setStrokeColor
```
public CT_Text setStrokeColor(CT_Color strokeColor)
```
    【可选】设置勾边颜色
    默认为透明色
    
    参数:
    
    strokeColor - 勾边颜色
    
    返回:
    
    this
  - getStrokeColor
```
public StrokeColor getStrokeColor()
```
    【可选】获取勾边颜色
    默认为透明色
    
    返回:
    
    勾边颜色，null为透明色
  - addCGTransform
```
public CT_Text addCGTransform(CT_CGTransform cgTransform)
```
    【可选】增加指定字符编码到字符索引之间的变换关系
    描述见 11.4 字符变换
    
    参数:
    
    cgTransform - 字符编码到字符索引之间的变换关系
    
    返回:
    
    this
  - getCGTransforms
```
public List<CT_CGTransform> getCGTransforms()
```
    【可选】获取指定字符编码到字符索引之间的变换关系序列
    描述见 11.4 字符变换
    
    返回:
    
    字符编码到字符索引之间的变换关系序列
  - addTextCode
```
public CT_Text addTextCode(TextCode textCode)
```
    【必选】增加文字内容
    也就是一段字符编码串
    如果字符编码不在XML编码方式的字符范围之内，应采用“\”加四位十六进制数的格式转义；文字内容中出现的空格也需要转义若 TextCode 作为占位符使用时一律采用 ¤ （¤）占位
    
    参数:
    
    textCode - 文字内容
    
    返回:
    
    this
  - getTextCodes
```
public List<TextCode> getTextCodes()
```
    【必选】获取文字内容序列
    也就是一段字符编码串
    如果字符编码不在XML编码方式的字符范围之内，应采用“\”加四位十六进制数的格式转义；文字内容中出现的空格也需要转义若 TextCode 作为占位符使用时一律采用 ¤ （¤）占位
    
    返回:
    
    文字内容序列

类 CT_Text

字段概要

从类继承的字段 org.ofdrw.core.DefaultElementProxy

从接口继承的字段 org.dom4j.Node

构造器概要

方法概要

从类继承的方法 org.ofdrw.core.pageDescription.CT_GraphicUnit

从类继承的方法 org.ofdrw.core.OFDElement

从类继承的方法 org.ofdrw.core.DefaultElementProxy

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

从接口继承的方法 org.ofdrw.core.pageDescription.clips.ClipAble

从接口继承的方法 org.dom4j.Element

从接口继承的方法 org.dom4j.Branch

从接口继承的方法 org.dom4j.Node

构造器详细资料

CT_Text

CT_Text

CT_Text

方法详细资料

textObject

toObj

setFont

setFont

getFont

setSize

getSize

setStroke

getStroke

setFill

getFill

setHScale

getHScale

setReadDirection

getReadDirection

setCharDirection

getCharDirection

setWeight

getWeight

setItalic

getItalic

setFillColor

getFillColor

setStrokeColor

getStrokeColor

addCGTransform

getCGTransforms

addTextCode

getTextCodes