org.ofdrw.core.pageDescription.drawParam

类 CT_DrawParam

java.lang.Object

org.ofdrw.core.DefaultElementProxy

org.ofdrw.core.OFDElement

org.ofdrw.core.pageDescription.drawParam.CT_DrawParam

所有已实现的接口:

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

public class CT_DrawParam
extends OFDElement

绘制参数

绘制参数是一组用于控制绘制渲染效果的修饰参数的集合。 绘制参数可以被不同的图元对象所共享。

绘制参数可以继承已有的绘制参数，被继承的绘制参数称为 该参数的“基础绘制参数”。

图元对象通过绘制参数的标识符引用绘制参数。图元对象在引用 绘制参数的同时，还可以定义自己的绘制属性，图元自有的绘制属性 将覆盖引用的绘制参数中的同名属性。

绘制参数可通过引用基础绘制参数的方式形成嵌套，对单个绘制参数而言， 它继承了其基础绘制参数中的所有属性，并且可以重定义其基础绘制参数中的属性。

绘制参数的作用顺序采用就近原则，即当多个绘制参数作用于同一个对象并且这些绘制参数 中具有相同的要素时，采用与被作用对象关系最为密切的绘制参数的要素对其进行渲染。 例如，当图元已经定义绘制参数时，则按定义属性进行渲染；当图元未定义绘制参数时， 应首先按照图元定义的绘制参数进行渲染；图元未定义绘制参数时应采用所在图层的默认绘制参数 渲染；当图元和所在图层都没有定义绘制参数时，按照各绘制属性的默认值进行渲染。

8.2 绘制参数结构 图 22

从以下版本开始:

2019-10-11 06:47:29

作者:

权观宇

字段概要

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

方法概要

限定符和类型	方法和说明
CT_DrawParam	clone()
LineCapType	getCap() 【可选 属性】 设置 线端点样式 可选样式参照LineCapType，线条端点样式取值与效果之间关系见表 24 默认值为 Butt
Double	getDashOffset() 【可选 属性】 获取 线条虚线开始位置 默认值为 0 当 DashPattern 不出现时，该参数无效
ST_Array	getDashPattern() 【可选 属性】 获取 线条虚线的重复样式 数组中共含两个值，第一个值代表虚线的线段的长度， 第二个值代表虚线间隔的长度。
FillColor	getFillColor() 【可选】 获取 填充颜色 用以填充路径形成的区域以及文字轮廓内的区域， 默认值为透明色。
ST_ID	getID()
LineJoinType	getJoin() 【可选 属性】 获取 线条连接样式 可选样式参照LineJoinType，线条连接样式的取值和显示效果之间的关系见表
Double	getLineWidth() 【可选 属性】 获取 线宽 非负浮点数，指定了绘制路径绘制时线的宽度。
Double	getMiterLimit() 【可选 属性】 获取 Join的截断值 Join为 Miter 时小角度结合点长度的截断值，默认值为 3.528。
ST_RefID	getRelative() 【可选 属性】 获取 基础绘制参数，引用资源文件中的绘制参数的标识符
CT_Color	getStrokeColor() 【可选】 获取 勾边颜色 用以填充路径形成的区域以及文字轮廓内的区域， 默认值为黑色。
CT_DrawParam	setCap(LineCapType cap) 【可选 属性】 设置 线端点样式 可选样式参照LineCapType，线条端点样式取值与效果之间关系见表 24
CT_DrawParam	setDashOffset(Double dashOffset) 【可选 属性】 设置 线条虚线开始位置 默认值为 0 当 DashPattern 不出现时，该参数无效
CT_DrawParam	setDashPattern(ST_Array dashPattern) 【可选 属性】 设置 线条虚线的重复样式 数组中共含两个值，第一个值代表虚线的线段的长度， 第二个值代表虚线间隔的长度。
CT_DrawParam	setFillColor(CT_Color fillColor) 【可选】 设置 填充颜色 用以填充路径形成的区域以及文字轮廓内的区域， 默认值为透明色。
CT_DrawParam	setID(ST_ID id)
CT_DrawParam	setJoin(LineJoinType join) 【可选 属性】 设置 线条连接样式 可选样式参照LineJoinType，线条连接样式的取值和显示效果之间的关系见表
CT_DrawParam	setLineWidth(Double lineWidth) 【可选 属性】 设置 线宽 非负浮点数，指定了绘制路径绘制时线的宽度。
CT_DrawParam	setMiterLimit(Double miterLimit) 【可选 属性】 设置 Join的截断值 Join为 Miter 时小角度结合点长度的截断值，默认值为 3.528。
CT_DrawParam	setRelative(ST_RefID relative) 【可选 属性】 设置 基础绘制参数，引用资源文件中的绘制参数的标识符
CT_DrawParam	setStrokeColor(CT_Color strokeColor) 【可选】 设置 勾边颜色 用以填充路径形成的区域以及文字轮廓内的区域， 默认值为黑色。

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

public CT_DrawParam(org.dom4j.Element proxy)

CT_DrawParam

public CT_DrawParam()

方法详细资料

getID

public ST_ID getID()

setID

public CT_DrawParam setID(ST_ID id)

setRelative

public CT_DrawParam setRelative(ST_RefID relative)

【可选 属性】 设置 基础绘制参数，引用资源文件中的绘制参数的标识符

参数:

relative - 引用资源文件中的绘制参数的标识符

返回:

this

getRelative

public ST_RefID getRelative()

【可选 属性】 获取 基础绘制参数，引用资源文件中的绘制参数的标识符

返回:

引用资源文件中的绘制参数的标识符

setLineWidth

public CT_DrawParam setLineWidth(Double lineWidth)

【可选 属性】 设置 线宽

非负浮点数，指定了绘制路径绘制时线的宽度。由于 某些设备不能输出一个像素宽度的线，因此强制规定 当线宽大于 0 时，无论多小都至少要绘制两个像素的宽度； 当线宽为 0 时，绘制一个像素的宽度。由于线宽为 0 定义与 设备相关，所以不推荐使用线宽为 0。

默认值为 0.353 mm

参数:

lineWidth - 线宽

返回:

this

抛出:

NumberFormatException - 线宽必须是非负浮点数

getLineWidth

public Double getLineWidth()

【可选 属性】 获取 线宽

非负浮点数，指定了绘制路径绘制时线的宽度。由于 某些设备不能输出一个像素宽度的线，因此强制规定 当线宽大于 0 时，无论多小都至少要绘制两个像素的宽度； 当线宽为 0 时，绘制一个像素的宽度。由于线宽为 0 定义与 设备相关，所以不推荐使用线宽为 0。

默认值为 0.353 mm

返回:

线宽

setJoin

public CT_DrawParam setJoin(LineJoinType join)

【可选 属性】 设置 线条连接样式

可选样式参照LineJoinType，线条连接样式的取值和显示效果之间的关系见表

参数:

join - 线条连接样式

返回:

this

getJoin

public LineJoinType getJoin()

【可选 属性】 获取 线条连接样式

可选样式参照LineJoinType，线条连接样式的取值和显示效果之间的关系见表

返回:

线条连接样式

setCap

public CT_DrawParam setCap(LineCapType cap)

【可选 属性】 设置 线端点样式

可选样式参照LineCapType，线条端点样式取值与效果之间关系见表 24

参数:

cap - 线端点样式

返回:

this

getCap

public LineCapType getCap()

【可选 属性】 设置 线端点样式

可选样式参照LineCapType，线条端点样式取值与效果之间关系见表 24

默认值为 Butt

返回:

线端点样式

setDashOffset

public CT_DrawParam setDashOffset(Double dashOffset)

【可选 属性】 设置 线条虚线开始位置

默认值为 0

当 DashPattern 不出现时，该参数无效

参数:

dashOffset - 线条虚线开始位置

返回:

this

getDashOffset

public Double getDashOffset()

【可选 属性】 获取 线条虚线开始位置

默认值为 0

当 DashPattern 不出现时，该参数无效

返回:

线条虚线开始位置

setDashPattern

public CT_DrawParam setDashPattern(ST_Array dashPattern)

【可选 属性】 设置 线条虚线的重复样式

数组中共含两个值，第一个值代表虚线的线段的长度， 第二个值代表虚线间隔的长度。

默认值为空。

线条样式的控制效果见表 23

参数:

dashPattern - 线条虚线的重复样式的数组中共含两个值，第一个值代表虚线的线段的长度，第二个值代表虚线间隔的长度。

返回:

this

getDashPattern

public ST_Array getDashPattern()

【可选 属性】 获取 线条虚线的重复样式

数组中共含两个值，第一个值代表虚线的线段的长度， 第二个值代表虚线间隔的长度。

默认值为空。

线条样式的控制效果见表 23

返回:

线条虚线的重复样式的数组中共含两个值，第一个值代表虚线的线段的长度，第二个值代表虚线间隔的长度。

setMiterLimit

public CT_DrawParam setMiterLimit(Double miterLimit)

【可选 属性】 设置 Join的截断值

Join为 Miter 时小角度结合点长度的截断值，默认值为 3.528。 当 Join 不等于 Miter 时该参数无效。

参数:

miterLimit - Join的截断值长度

返回:

this

getMiterLimit

public Double getMiterLimit()

【可选 属性】 获取 Join的截断值

Join为 Miter 时小角度结合点长度的截断值，默认值为 3.528。 当 Join 不等于 Miter 时该参数无效。

返回:

Join的截断值长度

setFillColor

public CT_DrawParam setFillColor(CT_Color fillColor)

【可选】 设置 填充颜色

用以填充路径形成的区域以及文字轮廓内的区域， 默认值为透明色。关于颜色的描述见 8.3

参数:

fillColor - 填充颜色

返回:

this

getFillColor

public FillColor getFillColor()

【可选】 获取 填充颜色

用以填充路径形成的区域以及文字轮廓内的区域， 默认值为透明色。关于颜色的描述见 8.3

返回:

填充颜色

setStrokeColor

public CT_DrawParam setStrokeColor(CT_Color strokeColor)

【可选】 设置 勾边颜色

用以填充路径形成的区域以及文字轮廓内的区域， 默认值为黑色。关于颜色的描述见 8.3

参数:

strokeColor - 勾边颜色

返回:

this

getStrokeColor

public CT_Color getStrokeColor()

【可选】 获取 勾边颜色

用以填充路径形成的区域以及文字轮廓内的区域， 默认值为黑色。关于颜色的描述见 8.3

返回:

勾边颜色

clone

public CT_DrawParam clone()

指定者:

clone 在接口中 org.dom4j.Node

覆盖:

clone 在类中 DefaultElementProxy