CT_Color (ofdrw-core 1.13.4 API)

java.lang.Object
- org.ofdrw.core.DefaultElementProxy
- - org.ofdrw.core.OFDElement
  - - org.ofdrw.core.pageDescription.color.color.CT_Color

所有已实现的接口:

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

直接已知子类:

BorderColor, FillColor, StrokeColor
```
public class CT_Color
extends OFDElement
```
基本颜色
本标准中定义的颜色是一个广义的概念，包括基本颜色、底纹和渐变
基本颜色支持两种指定方式：一种是通过设定颜色个通道值指定颜色空间的某个颜色，另一种是通过索引值取得颜色空间中的一个预定义颜色。
由于不同颜色空间下，颜色通道的含义、数目各不相同，因此对颜色空间的类型、颜色值的描述格式等作出了详细的说明，见表 27。BitsPerComponent（简称 BPC）由效时，颜色通道值的取值下限是 0，上限由 BitsPerComponent 决定，取值区间 [0, 2^BPC - 1] 内的整数，采用 10 进制或 16 进制的形式表示，采用 16 进制表示时，应以“#”加以标识。当颜色通道的值超出了相应区间，则按照默认颜色来处理。
8.3.2 基本颜色图 25 表 26

从以下版本开始:

2019-10-11 09:01:56

作者:

权观宇

字段概要
- 从类继承的字段 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_Color()

CT_Color(ColorClusterType color)

CT_Color(org.dom4j.Element proxy)

protected CT_Color(String name)

构造器
限定符	构造器和说明
	`CT_Color()`
	`CT_Color(ColorClusterType color)`
	`CT_Color(org.dom4j.Element proxy)`
`protected`	`CT_Color(String name)`

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`Integer`	`getAlpha()` 【可选属性】获取颜色透明度范围在 0~255 之间取值。
`ColorClusterType`	`getColor()` 【可选】获取颜色
`<T extends ColorClusterType> T`	`getColorByType()` 【可选】获取指定类型的颜色
`ST_RefID`	`getColorSpace()` 【可选属性】获取引用资源文件中颜色空间的标识默认值为文档设定的颜色空间
`Integer`	`getIndex()` 【可选属性】获取调色板中颜色的编号，非负整数将从当前颜色空间的调色板中取出相应索引的预定义颜色用来描绘。
`ST_Array`	`getValue()` 【可选属性】获取颜色值指定了当前颜色空间下各通道的取值。
`static CT_Color`	`rgb(int[] rgb)`
`static CT_Color`	`rgb(int r, int g, int b)` RGB颜色值其中颜色空间（CT_ColorSpace）的通道使用位数（BitsPerComponent）为 8 采用10进制表示方式
`CT_Color`	`setAlpha(Integer alpha)` 【可选属性】设置颜色透明度范围在 0~255 之间取值。
`CT_Color`	`setColor(ColorClusterType color)` 【可选】设置颜色
`CT_Color`	`setColorSpace(ST_RefID colorSpace)` 【可选属性】设置引用资源文件中颜色空间的标识默认值为文档设定的颜色空间
`CT_Color`	`setIndex(Integer index)` 【可选属性】设置调色板中颜色的编号，非负整数将从当前颜色空间的调色板中取出相应索引的预定义颜色用来描绘。
`CT_Color`	`setValue(ST_Array value)` 【可选属性】设置颜色值指定了当前颜色空间下各通道的取值。

从类继承的方法 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_Color
```
public CT_Color(org.dom4j.Element proxy)
```
  - CT_Color
```
public CT_Color()
```
  - CT_Color
```
public CT_Color(ColorClusterType color)
```
    参数:
    
    color - 颜色族中的颜色
  - CT_Color
```
protected CT_Color(String name)
```
- 方法详细资料
  - rgb
```
public static CT_Color rgb(int r,
                           int g,
                           int b)
```
    RGB颜色值
    其中颜色空间（CT_ColorSpace）的通道使用位数（BitsPerComponent）为 8
    采用10进制表示方式
    
    参数:
    
    r - 红色 0~255
    
    g - 绿色 0~255
    
    b - 蓝色 0~255
    
    返回:
    
    RGB 颜色
  - rgb
```
public static CT_Color rgb(int[] rgb)
```
  - setValue
```
public CT_Color setValue(ST_Array value)
```
    【可选属性】设置颜色值
    指定了当前颜色空间下各通道的取值。Value 的取值应符合"通道 1 通道 2 通道 3 ..."格式。此属性不出现时，应采用 Index 属性从颜色空间的调色板中的取值。二者都不出现时，改颜色各通道的值全部为 0
    颜色表示：
    Gray - 通过一个通道来表明灰度值；例如 "#FF 255"
    RGB - 包含3个通道，一次是红、绿、蓝；例如 "#11 #22 #33"、"17 34 51"
    CMYK - 包含4个通道，依次是青、黄、品红、黑；例如 "#11 #22 #33 # 44"、"17 34 51 68"
    
    参数:
    
    value - 颜色值
    
    返回:
    
    this
  - getValue
```
public ST_Array getValue()
```
    【可选属性】获取颜色值
    指定了当前颜色空间下各通道的取值。Value 的取值应符合"通道 1 通道 2 通道 3 ..."格式。此属性不出现时，应采用 Index 属性从颜色空间的调色板中的取值。二者都不出现时，改颜色各通道的值全部为 0
    颜色表示：
    Gray - 通过一个通道来表明灰度值；例如 "#FF 255"
    RGB - 包含3个通道，一次是红、绿、蓝；例如 "#11 #22 #33"、"17 34 51"
    CMYK - 包含4个通道，依次是青、黄、品红、黑；例如 "#11 #22 #33 # 44"、"17 34 51 68"
    
    返回:
    
    颜色值
  - setIndex
```
public CT_Color setIndex(Integer index)
```
    【可选属性】设置调色板中颜色的编号，非负整数
    将从当前颜色空间的调色板中取出相应索引的预定义颜色用来描绘。索引从 0 开始
    
    参数:
    
    index - 调色板中颜色的编号
    
    返回:
    
    this
  - getIndex
```
public Integer getIndex()
```
    【可选属性】获取调色板中颜色的编号，非负整数
    将从当前颜色空间的调色板中取出相应索引的预定义颜色用来描绘。索引从 0 开始
    
    返回:
    
    调色板中颜色的编号，null表示不存在
  - setColorSpace
```
public CT_Color setColorSpace(ST_RefID colorSpace)
```
    【可选属性】设置引用资源文件中颜色空间的标识
    默认值为文档设定的颜色空间
    
    参数:
    
    colorSpace - 颜色空间的标识
    
    返回:
    
    this
  - getColorSpace
```
public ST_RefID getColorSpace()
```
    【可选属性】获取引用资源文件中颜色空间的标识
    默认值为文档设定的颜色空间
    
    返回:
    
    颜色空间的标识，为null是请从文档中获取设定的颜色空间，参照表 6 DefaultCS
  - setAlpha
```
public CT_Color setAlpha(Integer alpha)
```
    【可选属性】设置颜色透明度
    范围在 0~255 之间取值。
    默认为 255，完全不透明。
    
    参数:
    
    alpha - 颜色透明度
    
    返回:
    
    this
  - getAlpha
```
public Integer getAlpha()
```
    【可选属性】获取颜色透明度
    范围在 0~255 之间取值。
    默认为 255，完全不透明。
    
    返回:
    
    颜色透明度 0~255
  - setColor
```
public CT_Color setColor(ColorClusterType color)
```
    【可选】设置颜色
    
    参数:
    
    color - 颜色族
    
    返回:
    
    this
  - getColor
```
public ColorClusterType getColor()
```
    【可选】获取颜色
    
    返回:
    
    颜色族, null表示不存在
  - getColorByType
```
public <T extends ColorClusterType> T getColorByType()
```
    【可选】获取指定类型的颜色
    
    类型参数:
    
    T - 颜色类型
    
    返回:
    
    指定类型色对象， null表示不存指定类型颜色

类 CT_Color

字段概要

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

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

构造器概要

方法概要

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

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

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

构造器详细资料

CT_Color

CT_Color

CT_Color

CT_Color

方法详细资料

rgb

rgb

setValue

getValue

setIndex

getIndex

setColorSpace

getColorSpace

setAlpha

getAlpha

setColor

getColor

getColorByType