CT_GraphicUnit (ofdrw-core 1.13.4 API)

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

所有已实现的接口:

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

直接已知子类:

CT_Composite, CT_Image, CT_Path, CT_Text
```
public abstract class CT_GraphicUnit<T extends CT_GraphicUnit>
extends OFDElement
```
图元对象
图元对象是版式文档中页面上呈现内容的最基本单元，所有页面显示内容。包括文字、图形、图像等，都属于图元对象，或是图元对象的组合。
8.5 图元对象图 45 表 34

从以下版本开始:

2019-10-14 07:32:38

作者:

权观宇

字段概要
- 从类继承的字段 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_GraphicUnit(org.dom4j.Element proxy)

CT_GraphicUnit(String name)

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

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`Actions`	`getActions()` 【可选】设置图元对象的动作序列当存在多个 Action 对象时，所有动作依次执行
`Integer`	`getAlpha()` 【可选属性】获取图元对象透明度取值区间为 [0,255] 默认为 0
`ST_Box`	`getBoundary()` 【必选属性】获取外接矩形采用当前空间坐标系（页面坐标或其他容器坐标），当图元绘制超出此矩形区域时进行裁剪。
`LineCapType`	`getCap()` 【可选属性】获取线端点样式见 8.2 绘制参数如果图元对象有 DrawParam 属性时，则用此值覆盖 DrawParam 中对应的值
`Clips`	`getClips()` 【可选】设置图元对象的裁剪区域序列采用对象空间坐标系当存在多个 Clip 对象时，最终裁剪区域为所有 Clip 区域的交集。
`ST_Array`	`getCTM()` 【可选属性】获取对空间内的图元变换矩阵
`Double`	`getDashOffset()` 【可选属性】获取线条虚线开始位置默认值为 0 当 DashPattern 不出现时，该参数无效见 8.2 绘制参数如果图元对象有 DrawParam 属性时，则用此值覆盖 DrawParam 中对应的值
`ST_Array`	`getDashPattern()` 【可选属性】获取线条虚线的重复样式数组中共含两个值，第一个值代表虚线的线段的长度，第二个值代表虚线间隔的长度。
`ST_RefID`	`getDrawParam()` 【可选属性】获取引用资源文件中的绘制参数标识
`String`	`getGraphicName()` 【可选属性】获取
`LineJoinType`	`getJoin()` 【可选属性】获取线条连接样式见 8.2 绘制参数如果图元对象有 DrawParam 属性时，则用此值覆盖 DrawParam 中对应的值
`Double`	`getLineWidth()` 【可选属性】获取绘制路径时使用的线宽如果图元对象有 DrawParam 属性时，则用此值覆盖 DrawParam 中对应的值
`Double`	`getMiterLimit()` 【可选属性】获取 Join的截断值 Join为 Miter 时小角度结合点长度的截断值，默认值为 3.528。
`Boolean`	`getVisible()` 【可选属性】获取图元是否可见
`T`	`setActions(Actions actions)` 【可选】设置图元对象的动作序列当存在多个 Action 对象时，所有动作依次执行
`T`	`setAlpha(Integer alpha)` 【可选属性】设置图元对象透明度取值区间为 [0,255] 默认为 0
`T`	`setBoundary(double topLeftX, double topLeftY, double width, double height)` 【必选属性】设置外接矩形采用当前空间坐标系（页面坐标或其他容器坐标），当图元绘制超出此矩形区域时进行裁剪。
`T`	`setBoundary(ST_Box boundary)` 【必选属性】设置外接矩形采用当前空间坐标系（页面坐标或其他容器坐标），当图元绘制超出此矩形区域时进行裁剪。
`T`	`setCap(LineCapType cap)` 【可选属性】设置线端点样式见 8.2 绘制参数如果图元对象有 DrawParam 属性时，则用此值覆盖 DrawParam 中对应的值
`CT_GraphicUnit`	`setClips(Clips clips)` 【可选】设置图元对象的裁剪区域序列采用对象空间坐标系当存在多个 Clip 对象时，最终裁剪区域为所有 Clip 区域的交集。
`T`	`setCTM(ST_Array ctm)` 【可选属性】设置对空间内的图元变换矩阵
`T`	`setDashOffset(Double dashOffset)` 【可选属性】设置线条虚线开始位置默认值为 0 当 DashPattern 不出现时，该参数无效见 8.2 绘制参数如果图元对象有 DrawParam 属性时，则用此值覆盖 DrawParam 中对应的值
`T`	`setDashPattern(ST_Array dashPattern)` 【可选属性】设置线条虚线的重复样式数组中共含两个值，第一个值代表虚线的线段的长度，第二个值代表虚线间隔的长度。
`T`	`setDrawParam(ST_RefID id)` 【可选属性】设置引用资源文件中的绘制参数标识
`T`	`setGraphicName(String name)` 【可选属性】设置图元对象的名字
`T`	`setJoin(LineJoinType join)` 【可选属性】设置线条连接样式见 8.2 绘制参数如果图元对象有 DrawParam 属性时，则用此值覆盖 DrawParam 中对应的值
`T`	`setLineWidth(Double lineWidth)` 【可选属性】设置绘制路径时使用的线宽如果图元对象有 DrawParam 属性时，则用此值覆盖 DrawParam 中对应的值
`T`	`setMiterLimit(Double miterLimit)` 【可选属性】设置 Join的截断值 Join为 Miter 时小角度结合点长度的截断值，默认值为 3.528。
`T`	`setVisible(Boolean visible)` 【可选属性】设置图元是否可见

从类继承的方法 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

- 构造器详细资料
  - CT_GraphicUnit
```
public CT_GraphicUnit(org.dom4j.Element proxy)
```
  - CT_GraphicUnit
```
public CT_GraphicUnit(String name)
```
- 方法详细资料
  - setBoundary
```
public T setBoundary(ST_Box boundary)
```
    【必选属性】设置外接矩形
    采用当前空间坐标系（页面坐标或其他容器坐标），当图元绘制超出此矩形区域时进行裁剪。
    
    参数:
    
    boundary - 外接矩形
    
    返回:
    
    this
  - setBoundary
```
public T setBoundary(double topLeftX,
                     double topLeftY,
                     double width,
                     double height)
```
    【必选属性】设置外接矩形
    采用当前空间坐标系（页面坐标或其他容器坐标），当图元绘制超出此矩形区域时进行裁剪。
    
    参数:
    
    topLeftX - 外接矩形X坐标
    
    topLeftY - 外接矩形Y坐标
    
    width - 外接矩形宽度
    
    height - 外接矩形高度
    
    返回:
    
    this
  - getBoundary
```
public ST_Box getBoundary()
```
    【必选属性】获取外接矩形
    采用当前空间坐标系（页面坐标或其他容器坐标），当图元绘制超出此矩形区域时进行裁剪。
    
    返回:
    
    外接矩形
  - setGraphicName
```
public T setGraphicName(String name)
```
    【可选属性】设置图元对象的名字
    
    参数:
    
    name - 图元对象的名字
    
    返回:
    
    this
  - getGraphicName
```
public String getGraphicName()
```
    【可选属性】获取
    
    返回:
    
    图元对象的名字，可能为null
  - setVisible
```
public T setVisible(Boolean visible)
```
    【可选属性】设置图元是否可见
    
    参数:
    
    visible - true - 可见；false - 不见
    
    返回:
    
    this
  - getVisible
```
public Boolean getVisible()
```
    【可选属性】获取图元是否可见
    
    返回:
    
    true - 可见；false - 不见
  - setCTM
```
public T setCTM(ST_Array ctm)
```
    【可选属性】设置对空间内的图元变换矩阵
    
    参数:
    
    ctm - 变换矩阵
    
    返回:
    
    this
  - getCTM
```
public ST_Array getCTM()
```
    【可选属性】获取对空间内的图元变换矩阵
    
    返回:
    
    变换矩阵
  - setDrawParam
```
public T setDrawParam(ST_RefID id)
```
    【可选属性】设置引用资源文件中的绘制参数标识
    
    参数:
    
    id - 绘制参数标识
    
    返回:
    
    this
  - getDrawParam
```
public ST_RefID getDrawParam()
```
    【可选属性】获取引用资源文件中的绘制参数标识
    
    返回:
    
    绘制参数标识
  - setLineWidth
```
public T setLineWidth(Double lineWidth)
```
    【可选属性】设置绘制路径时使用的线宽
    如果图元对象有 DrawParam 属性时，则用此值覆盖 DrawParam 中对应的值
    
    参数:
    
    lineWidth - 绘制路径时使用的线宽
    
    返回:
    
    this
  - getLineWidth
```
public Double getLineWidth()
```
    【可选属性】获取绘制路径时使用的线宽
    如果图元对象有 DrawParam 属性时，则用此值覆盖 DrawParam 中对应的值
    
    返回:
    
    绘制路径时使用的线宽，可能为null
  - setCap
```
public T setCap(LineCapType cap)
```
    【可选属性】设置线端点样式
    见 8.2 绘制参数
    如果图元对象有 DrawParam 属性时，则用此值覆盖 DrawParam 中对应的值
    
    参数:
    
    cap - 线端点样式
    
    返回:
    
    this
  - getCap
```
public LineCapType getCap()
```
    【可选属性】获取线端点样式
    见 8.2 绘制参数
    如果图元对象有 DrawParam 属性时，则用此值覆盖 DrawParam 中对应的值
    
    返回:
    
    线端点样式
  - setJoin
```
public T setJoin(LineJoinType join)
```
    【可选属性】设置线条连接样式
    见 8.2 绘制参数
    如果图元对象有 DrawParam 属性时，则用此值覆盖 DrawParam 中对应的值
    
    参数:
    
    join - 线条连接样式
    
    返回:
    
    this
  - getJoin
```
public LineJoinType getJoin()
```
    【可选属性】获取线条连接样式
    见 8.2 绘制参数
    如果图元对象有 DrawParam 属性时，则用此值覆盖 DrawParam 中对应的值
    
    返回:
    
    线条连接样式
  - setMiterLimit
```
public T setMiterLimit(Double miterLimit)
```
    【可选属性】设置 Join的截断值
    Join为 Miter 时小角度结合点长度的截断值，默认值为 3.528。当 Join 不等于 Miter 时该参数无效。
    见 8.2 绘制参数
    如果图元对象有 DrawParam 属性时，则用此值覆盖 DrawParam 中对应的值
    
    参数:
    
    miterLimit - Join的截断值长度
    
    返回:
    
    this
  - getMiterLimit
```
public Double getMiterLimit()
```
    【可选属性】获取 Join的截断值
    Join为 Miter 时小角度结合点长度的截断值，默认值为 3.528。当 Join 不等于 Miter 时该参数无效。
    见 8.2 绘制参数
    如果图元对象有 DrawParam 属性时，则用此值覆盖 DrawParam 中对应的值
    
    返回:
    
    Join的截断值长度
  - setDashOffset
```
public T setDashOffset(Double dashOffset)
```
    【可选属性】设置线条虚线开始位置
    默认值为 0
    当 DashPattern 不出现时，该参数无效
    见 8.2 绘制参数
    如果图元对象有 DrawParam 属性时，则用此值覆盖 DrawParam 中对应的值
    
    参数:
    
    dashOffset - 线条虚线开始位置
    
    返回:
    
    this
  - getDashOffset
```
public Double getDashOffset()
```
    【可选属性】获取线条虚线开始位置
    默认值为 0
    当 DashPattern 不出现时，该参数无效
    见 8.2 绘制参数
    如果图元对象有 DrawParam 属性时，则用此值覆盖 DrawParam 中对应的值
    
    返回:
    
    线条虚线开始位置
  - setDashPattern
```
public T setDashPattern(ST_Array dashPattern)
```
    【可选属性】设置线条虚线的重复样式
    数组中共含两个值，第一个值代表虚线的线段的长度，第二个值代表虚线间隔的长度。
    默认值为空。
    线条样式的控制效果见表 23
    见 8.2 绘制参数
    如果图元对象有 DrawParam 属性时，则用此值覆盖 DrawParam 中对应的值
    
    参数:
    
    dashPattern - 线条虚线的重复样式的数组中共含两个值，第一个值代表虚线的线段的长度，第二个值代表虚线间隔的长度。
    
    返回:
    
    this
  - getDashPattern
```
public ST_Array getDashPattern()
```
    【可选属性】获取线条虚线的重复样式
    数组中共含两个值，第一个值代表虚线的线段的长度，第二个值代表虚线间隔的长度。
    默认值为空。
    线条样式的控制效果见表 23
    见 8.2 绘制参数
    如果图元对象有 DrawParam 属性时，则用此值覆盖 DrawParam 中对应的值
    
    返回:
    
    线条虚线的重复样式的数组中共含两个值，第一个值代表虚线的线段的长度，第二个值代表虚线间隔的长度。
  - setAlpha
```
public T setAlpha(Integer alpha)
```
    【可选属性】设置图元对象透明度
    取值区间为 [0,255]
    默认为 0
    
    参数:
    
    alpha - 图元对象透明度，取值区间为 [0,255]
    
    返回:
    
    this
  - getAlpha
```
public Integer getAlpha()
```
    【可选属性】获取图元对象透明度
    取值区间为 [0,255]
    默认为 0
    
    返回:
    
    图元对象透明度，取值区间为 [0,255]
  - setActions
```
public T setActions(Actions actions)
```
    【可选】设置图元对象的动作序列
    当存在多个 Action 对象时，所有动作依次执行
    
    参数:
    
    actions - 图元对象的动作序列
    
    返回:
    
    this
  - getActions
```
public Actions getActions()
```
    【可选】设置图元对象的动作序列
    当存在多个 Action 对象时，所有动作依次执行
    
    返回:
    
    图元对象的动作序列
  - setClips
```
public CT_GraphicUnit setClips(Clips clips)
```
    【可选】设置图元对象的裁剪区域序列
    采用对象空间坐标系
    当存在多个 Clip 对象时，最终裁剪区域为所有 Clip 区域的交集。
    
    参数:
    
    clips - 图元对象的裁剪区域序列
    
    返回:
    
    this
  - getClips
```
public Clips getClips()
```
    【可选】设置图元对象的裁剪区域序列
    采用对象空间坐标系
    当存在多个 Clip 对象时，最终裁剪区域为所有 Clip 区域的交集。
    
    返回:
    
    图元对象的裁剪区域序列

类 CT_GraphicUnit<T extends CT_GraphicUnit>

字段概要

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

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

构造器概要

方法概要

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

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

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

构造器详细资料

CT_GraphicUnit

CT_GraphicUnit

方法详细资料

setBoundary

setBoundary

getBoundary

setGraphicName

getGraphicName

setVisible

getVisible

setCTM

getCTM

setDrawParam

getDrawParam

setLineWidth

getLineWidth

setCap

getCap

setJoin

getJoin

setMiterLimit

getMiterLimit

setDashOffset

getDashOffset

setDashPattern

getDashPattern

setAlpha

getAlpha

setActions

getActions

setClips

getClips