Foxit PDF SDK

Public 成员函数 | 静态 Public 属性 | 所有成员列表
com.foxit.sdk.pdf.graphics.GraphicsObject类 参考
类 com.foxit.sdk.pdf.graphics.GraphicsObject 继承关系图:

## Public 成员函数
boolean | addClipPath (Path path, int fill_mode) throws com.foxit.sdk.PDFException
| 添加用于裁剪的路径。 更多...
boolean | addClipTextObject (TextObject textobject) throws com.foxit.sdk.PDFException
| 添加用于裁剪的文本对象。 更多...
boolean | clearClips ()
| 清除所有裁剪。 更多...
GraphicsObject | clone ()
| 克隆新的图形对象。 更多...
GraphicsObject | clone (GraphicsObjects src_graphicsobjects, GraphicsObjects dest_graphicsobjects)
| 克隆新的图形对象。 更多...
synchronized void | delete ()
| 直接清除C++相关资源。 更多...
boolean | equal (GraphicsObject other)
| 检查输入对象是否与当前对象相等。 更多...
int | getBlendMode () throws com.foxit.sdk.PDFException
| 获取透明成像模型的混合模式。 更多...
Path | getClipPath (int index) throws com.foxit.sdk.PDFException
| 根据索引获取路径裁剪。 更多...
int | getClipPathCount ()
| 获取路径裁剪的数量。 更多...
int | getClipPathFillMode (int index) throws com.foxit.sdk.PDFException
| 根据索引获取路径裁剪的填充模式。 更多...
RectF | getClipRect ()
| 获取裁剪矩形。 更多...
TextObject | getClipTextObject (int index) throws com.foxit.sdk.PDFException
| 根据索引获取文本裁剪的文本对象。 更多...
int | getClipTextObjectCount ()
| 获取文本裁剪的数量。 更多...
ColorState | getColorState ()
| 获取颜色状态。 更多...
long | getFillColor ()
| 获取填充颜色。 更多...
float | getFillOpacity () throws com.foxit.sdk.PDFException
| 获取除描边外的绘制操作的不透明度值。 更多...
FormXObject | getFormXObject ()
| 如果当前图形对象表示表单XObject对象，则获取表单XObject图形对象。 更多...
GraphState | getGraphState ()
| 获取图形状态。 更多...
ImageObject | getImageObject ()
| 如果当前图形对象表示图像对象，则获取图像图形对象。 更多...
LayerNodeArray | getLayers (LayerTree layer_tree) throws com.foxit.sdk.PDFException
| 获取与当前图形对象关联的所有图层。 更多...
MarkedContent | getMarkedContent ()
| 获取标记内容对象。 更多...
Matrix2D | getMatrix () throws com.foxit.sdk.PDFException
| 获取矩阵。 更多...
PathObject | getPathObject ()
| 如果当前图形对象表示路径对象，则获取路径图形对象。 更多...
RectF | getRect ()
| 获取当前图形对象的矩形。 更多...
ShadingObject | getShadingObject ()
| 如果当前图形对象表示阴影对象，则获取阴影图形对象。 更多...
long | getStrokeColor ()
| 获取描边颜色。 更多...
float | getStrokeOpacity () throws com.foxit.sdk.PDFException
| 获取路径和字形轮廓的描边绘制操作的不透明度值。 更多...
TextObject | getTextObject ()
| 如果当前图形对象表示文本对象，则获取文本图形对象。 更多...
int | getType ()
| 获取当前图形对象的类型。 更多...
boolean | hasTransparency ()
| 检查当前图形对象是否具有透明度。 更多...
void | release ()
| 释放尚未插入到任何PDF页面中的克隆或新创建的PDF图形对象或其他对象。 更多...
boolean | removeClipPath (int index) throws com.foxit.sdk.PDFException
| 根据索引删除路径裁剪。 更多...
boolean | removeClipTextObject (int index) throws com.foxit.sdk.PDFException
| 根据索引删除用于裁剪的文本裁剪。 更多...
void | rotate (int angle)
| 从当前状态以指定的角度顺时针旋转当前图形对象。 更多...
void | setBlendMode (int blend_mode) throws com.foxit.sdk.PDFException
| 设置透明成像模型的混合模式。 更多...
void | setClipRect (RectF clip_rect)
| 设置裁剪矩形。 更多...
void | setColorState (ColorState color_state) throws com.foxit.sdk.PDFException
| 设置颜色状态。 更多...
void | setFillColor (long color) throws com.foxit.sdk.PDFException
| 设置填充颜色。 更多...
void | setFillOpacity (float opacity) throws com.foxit.sdk.PDFException
| 设置除描边外的绘制操作的不透明度值。 更多...
void | setGraphState (GraphState graph_state) throws com.foxit.sdk.PDFException
| 设置图形状态。 更多...
void | setMatrix (Matrix2D matrix) throws com.foxit.sdk.PDFException
| 设置矩阵。 更多...
void | setStrokeColor (long color) throws com.foxit.sdk.PDFException
| 设置描边颜色。 更多...
void | setStrokeOpacity (float opacity) throws com.foxit.sdk.PDFException
| 设置路径和字形轮廓的描边绘制操作的不透明度值。 更多...
boolean | transform (Matrix2D matrix, boolean need_transform_clippath)
| 变换当前图形对象。 更多...

## 静态 Public 属性
static final int | e_BlendColor = 23
| 使用源颜色的色调和饱和度以及背景颜色的明度创建颜色。 更多...
static final int | e_BlendColorBurn = 7
| 加深背景颜色以反映源颜色。 更多...
static final int | e_BlendColorDodge = 6
| 增亮背景颜色以反映源颜色。 更多...
static final int | e_BlendDarken = 4
| 选择背景和源颜色中较暗的一个。 更多...
static final int | e_BlendDifference = 10
| 从较亮的颜色中减去两种组成颜色中较暗的一种。 更多...
static final int | e_BlendExclusion = 11
| 使用源颜色的色调和背景颜色的饱和度和明度创建颜色。 更多...
static final int | e_BlendHardlight = 8
| 根据源颜色值进行相乘或滤色。 更多...
static final int | e_BlendHue = 21
| 使用源颜色的色调和背景颜色的饱和度和明度创建颜色。 更多...
static final int | e_BlendLighten = 5
| 选择背景和源颜色中较亮的一个。 更多...
static final int | e_BlendLuminosity = 24
| 使用源颜色的明度和背景颜色的色调和饱和度创建颜色。 更多...
static final int | e_BlendMultiply = 1
| 将背景与源颜色值相乘。 更多...
static final int | e_BlendNormal = 0
| 选择源颜色并忽略背景颜色。 更多...
static final int | e_BlendOverlay = 3
| 根据背景颜色值进行相乘或滤色。 更多...
static final int | e_BlendSaturation = 22
| 使用源颜色的饱和度和背景颜色的色调和明度创建颜色。 更多...
static final int | e_BlendScreen = 2
| 将背景的补码与源颜色值相乘，然后对结果取补。 更多...
static final int | e_BlendSoftlight = 9
| 根据源颜色值使颜色变暗或变亮。 更多...
static final int | e_TypeAll = 0
| 表示所有图形对象类型，仅用作过滤器。
static final int | e_TypeEmptyMarkedContent = 7
| 空标记内容对象。
static final int | e_TypeFormXObject = 5
| 表单XObject图形对象。
static final int | e_TypeImage = 3
| 图像图形对象。
static final int | e_TypeInlines = 6
| 内联图形对象。
static final int | e_TypePath = 2
| 路径图形对象。
static final int | e_TypeShading = 4
| 阴影图形对象。
static final int | e_TypeText = 1
| 文本图形对象。

## 详细描述

PDF页面的内容通常由一系列图形对象组成。每个图形对象包含其状态信息、数据和渲染指令。
类GraphicsObject 是所有类型PDF图形对象的基类。 它提供获取/设置图形对象通用属性的基本函数。对于具体的图形对象类型，请参阅派生类。
要获取或插入/删除图形对象，请参阅类com.foxit.sdk.pdf.GraphicsObjects 。
如果对PDF图形对象进行了任何更改，请记住为com.foxit.sdk.pdf.GraphicsObjects 对象 (当前图形对象所属的对象)调用函数GraphicsObjects.generateContent 。 更多详细信息请参阅函数GraphicsObjects.generateContent 的注释。

参见
  com.foxit.sdk.pdf.GraphicsObjects

## 成员函数说明

## ◆ addClipPath()

boolean com.foxit.sdk.pdf.graphics.GraphicsObject.addClipPath | ( | Path | path,
|  | int | fill_mode
| ) |  | throws com.foxit.sdk.PDFException

添加用于裁剪的路径。

参数

  [in] | path | 要添加到当前图形对象的路径数据。
  [in] | fill_mode | 输入路径的填充模式。请参考从 com.foxit.sdk.common.Constants.e_FillModeNone 开始的值，这应该是这些值中的一个。

返回
  true 表示成功，false 表示失败。

注解
  当此函数成功时，应调用函数GraphicsObjects.generateContent 。 更多详细信息请参阅函数GraphicsObjects.generateContent 。

## ◆ addClipTextObject()

boolean com.foxit.sdk.pdf.graphics.GraphicsObject.addClipTextObject | ( | TextObject | textobject | ) | throws com.foxit.sdk.PDFException

添加用于裁剪的文本对象。

参数

  [in] | textobject | 要添加用于裁剪的文本对象。

返回
  true 表示成功，false 表示失败。

注解
  当此函数成功时，应调用函数GraphicsObjects.generateContent 。 更多详细信息请参阅函数GraphicsObjects.generateContent 。

## ◆ clearClips()

boolean com.foxit.sdk.pdf.graphics.GraphicsObject.clearClips | ( |  | ) |

清除所有裁剪。

返回
  true 表示成功，false 表示失败。

注解
  当此函数成功时，应调用函数GraphicsObjects.generateContent 。 更多详细信息请参阅函数GraphicsObjects.generateContent 。

## ◆ clone() [1/2]

GraphicsObject com.foxit.sdk.pdf.graphics.GraphicsObject.clone | ( |  | ) |

克隆新的图形对象。

新克隆的图形对象默认与当前图形对象关联到同一页面。 新克隆的图形对象只能在包含当前图形对象的PDF文件内使用。 如果克隆的图形对象未插入到任何PDF页面或其他对象中， 请记住在不再使用时调用函数GraphicsObject.release 来释放它。

返回
  克隆的图形对象。如果有任何错误，此函数将返回null。

## ◆ clone() [2/2]

GraphicsObject com.foxit.sdk.pdf.graphics.GraphicsObject.clone | ( | GraphicsObjects | src_graphicsobjects,
|  | GraphicsObjects | dest_graphicsobjects
| ) |  |

克隆新的图形对象。

新克隆的图形对象与dest_graphicsobjects所属的页面相关联。 新克隆的图形对象可以在包含当前图形对象的PDF文件内外使用。 如果克隆的图形对象未插入到任何PDF页面或其他对象中， 请记住在不再使用时调用函数GraphicsObject.release 来释放它。

参数

  [in] | src_graphicsobjects | 包含当前图形对象的GraphicsObjects 对象。
  [in] | dest_graphicsobjects | 将包含克隆图形对象的GraphicsObjects 对象。 这可以属于当前文档中的另一页面或另一文档中的页面。

返回
  克隆的图形对象。如果有任何错误，此函数将返回null。

## ◆ delete()

synchronized void com.foxit.sdk.pdf.graphics.GraphicsObject.delete | ( |  | ) |

直接清除C++相关资源。

返回
  无。

注解
  一旦这个接口被调用，这个对象将不能再被使用。

## ◆ equal()

boolean com.foxit.sdk.pdf.graphics.GraphicsObject.equal | ( | GraphicsObject | other | ) |

检查输入对象是否与当前对象相等。

参数

  [in] | other | 另一个图形对象。此函数将检查当前对象是否与该对象相等。

返回
  true 表示相等，false 表示不相等。

## ◆ getBlendMode()

int com.foxit.sdk.pdf.graphics.GraphicsObject.getBlendMode | ( |  | ) | throws com.foxit.sdk.PDFException

获取透明成像模型的混合模式。

返回
  透明成像模型的混合模式。请参考从 com.foxit.sdk.pdf.graphics.GraphicsObject.e_BlendNormal 开始的值，这将是这些值中的一个。

## ◆ getClipPath()

Path com.foxit.sdk.pdf.graphics.GraphicsObject.getClipPath | ( | int | index | ) | throws com.foxit.sdk.PDFException

根据索引获取路径裁剪。

参数

  [in] | index | 路径裁剪索引。有效范围：从0到(count-1)。 count 由函数GraphicsObject.getClipPath 返回。

返回
  路径数据。如果返回路径对象的函数common.Path.isEmpty 的返回值为true， 表示有任何错误。

## ◆ getClipPathCount()

int com.foxit.sdk.pdf.graphics.GraphicsObject.getClipPathCount | ( |  | ) |

获取路径裁剪的数量。

返回
  路径裁剪的数量。

## ◆ getClipPathFillMode()

int com.foxit.sdk.pdf.graphics.GraphicsObject.getClipPathFillMode | ( | int | index | ) | throws com.foxit.sdk.PDFException

根据索引获取路径裁剪的填充模式。

参数

  [in] | index | 路径裁剪索引。有效范围：从0到(count-1)。 count 由函数GraphicsObject.getClipPath 返回。

返回
  填充模式。请参考从com.foxit.sdk.common.Constants.e_FillModeNone 开始的值， 这将是这些值中的一个。

## ◆ getClipRect()

RectF com.foxit.sdk.pdf.graphics.GraphicsObject.getClipRect | ( |  | ) |

获取裁剪矩形。

返回
  裁剪矩形。如果没有裁剪矩形，将返回一个所有值都为0的RectF对象。

## ◆ getClipTextObject()

TextObject com.foxit.sdk.pdf.graphics.GraphicsObject.getClipTextObject | ( | int | index | ) | throws com.foxit.sdk.PDFException

根据索引获取文本裁剪的文本对象。

参数

  [in] | index | 文本裁剪索引。有效范围：从0到(count-1)。 count 由函数GraphicsObject.getClipTextObjectCount 返回。

返回
  文本图形对象。如果有任何错误，此函数将返回null。

## ◆ getClipTextObjectCount()

int com.foxit.sdk.pdf.graphics.GraphicsObject.getClipTextObjectCount | ( |  | ) |

获取文本裁剪的数量。

返回
  文本裁剪的数量。

## ◆ getColorState()

ColorState com.foxit.sdk.pdf.graphics.GraphicsObject.getColorState | ( |  | ) |

获取颜色状态。

文本图形对象、路径图形对象和表单XObject图形对象可以具有颜色状态。

返回
  颜色状态。

## ◆ getFillColor()

long com.foxit.sdk.pdf.graphics.GraphicsObject.getFillColor | ( |  | ) |

获取填充颜色。

文本图形对象、路径图形对象和表单XObject图形对象可以具有此属性。 函数GraphicsObject.getColorState 可用于获取其他颜色空间(如CMYK颜色空间)中的填充颜色。

返回
  颜色值，格式为0xAARRGGBB。

## ◆ getFillOpacity()

float com.foxit.sdk.pdf.graphics.GraphicsObject.getFillOpacity | ( |  | ) | throws com.foxit.sdk.PDFException

获取除描边外的绘制操作的不透明度值。

返回
  不透明度值。有效范围：0.0到1.0。0.0表示完全透明，1.0表示完全不透明。 如果找不到不透明度值，将返回1作为默认值。

## ◆ getFormXObject()

FormXObject com.foxit.sdk.pdf.graphics.GraphicsObject.getFormXObject | ( |  | ) |

如果当前图形对象表示表单XObject对象，则获取表单XObject图形对象。

返回
  表单XObject图形对象。如果当前图形对象不表示表单XObject对象， 此函数将返回null。

## ◆ getGraphState()

GraphState com.foxit.sdk.pdf.graphics.GraphicsObject.getGraphState | ( |  | ) |

获取图形状态。

表单XObject图形对象、路径图形对象和文本图形对象可以具有此属性。

返回
  图形状态。

## ◆ getImageObject()

ImageObject com.foxit.sdk.pdf.graphics.GraphicsObject.getImageObject | ( |  | ) |

如果当前图形对象表示图像对象，则获取图像图形对象。

返回
  图像图形对象。如果当前图形对象不表示图像对象， 此函数将返回null。

## ◆ getLayers()

LayerNodeArray com.foxit.sdk.pdf.graphics.GraphicsObject.getLayers | ( | LayerTree | layer_tree | ) | throws com.foxit.sdk.PDFException

获取与当前图形对象关联的所有图层。

参数

  [in] | layer_tree | 有效的图层树。此图层树中的所有图层节点将按顺序枚举， 以查找与当前图形对象关联的图层。

返回
  包含所有匹配图层节点的图层节点数组。

## ◆ getMarkedContent()

MarkedContent com.foxit.sdk.pdf.graphics.GraphicsObject.getMarkedContent | ( |  | ) |

获取标记内容对象。

返回
  标记内容对象。如果有任何错误，此函数将返回null。

## ◆ getMatrix()

Matrix2D com.foxit.sdk.pdf.graphics.GraphicsObject.getMatrix | ( |  | ) | throws com.foxit.sdk.PDFException

获取矩阵。

返回
  矩阵值。 如果有任何错误，此函数将返回一个所有值都为0的矩阵。

## ◆ getPathObject()

PathObject com.foxit.sdk.pdf.graphics.GraphicsObject.getPathObject | ( |  | ) |

如果当前图形对象表示路径对象，则获取路径图形对象。

返回
  路径图形对象。如果当前图形对象不表示路径对象， 此函数将返回null。

## ◆ getRect()

RectF com.foxit.sdk.pdf.graphics.GraphicsObject.getRect | ( |  | ) |

获取当前图形对象的矩形。

返回
  当前图形对象的矩形。 如果有任何错误，此函数将返回一个所有值都为0的RectF对象。

## ◆ getShadingObject()

ShadingObject com.foxit.sdk.pdf.graphics.GraphicsObject.getShadingObject | ( |  | ) |

如果当前图形对象表示阴影对象，则获取阴影图形对象。

返回
  阴影图形对象。如果当前图形对象不表示阴影对象， 此函数将返回null。

## ◆ getStrokeColor()

long com.foxit.sdk.pdf.graphics.GraphicsObject.getStrokeColor | ( |  | ) |

获取描边颜色。

文本图形对象、路径图形对象和表单XObject图形对象可以具有此属性。
函数GraphicsObject.getColorState 可用于获取其他颜色空间(如CMYK颜色空间)中的描边颜色。

返回
  颜色值，格式为0xAARRGGBB。

## ◆ getStrokeOpacity()

float com.foxit.sdk.pdf.graphics.GraphicsObject.getStrokeOpacity | ( |  | ) | throws com.foxit.sdk.PDFException

获取路径和字形轮廓的描边绘制操作的不透明度值。

返回
  不透明度值。有效范围：0.0到1.0。0.0表示完全透明，1.0表示完全不透明。 如果找不到不透明度值，将返回1作为默认值。

## ◆ getTextObject()

TextObject com.foxit.sdk.pdf.graphics.GraphicsObject.getTextObject | ( |  | ) |

如果当前图形对象表示文本对象，则获取文本图形对象。

返回
  文本图形对象。如果当前图形对象不表示文本对象， 此函数将返回null。

## ◆ getType()

int com.foxit.sdk.pdf.graphics.GraphicsObject.getType | ( |  | ) |

获取当前图形对象的类型。

返回
  图形对象类型。请参考从com.foxit.sdk.pdf.graphics.GraphicsObject.e_TypeText 开始的值， 这将是这些值中的一个，除了com.foxit.sdk.pdf.graphics.GraphicsObject.e_TypeAll 。

## ◆ hasTransparency()

boolean com.foxit.sdk.pdf.graphics.GraphicsObject.hasTransparency | ( |  | ) |

检查当前图形对象是否具有透明度。

返回
  true 表示当前图形对象具有透明度，false 表示没有。

## ◆ release()

void com.foxit.sdk.pdf.graphics.GraphicsObject.release | ( |  | ) |

释放尚未插入到任何PDF页面中的克隆或新创建的PDF图形对象或其他对象。

返回
  无。

## ◆ removeClipPath()

boolean com.foxit.sdk.pdf.graphics.GraphicsObject.removeClipPath | ( | int | index | ) | throws com.foxit.sdk.PDFException

根据索引删除路径裁剪。

参数

  [in] | index | 路径裁剪索引。有效范围：从0到(count-1)。 count 由函数GraphicsObject.getClipPath 返回。

返回
  true 表示成功，false 表示失败。

注解
  当此函数成功时，应调用函数GraphicsObjects.generateContent 。 更多详细信息请参阅函数GraphicsObjects.generateContent 。

## ◆ removeClipTextObject()

boolean com.foxit.sdk.pdf.graphics.GraphicsObject.removeClipTextObject | ( | int | index | ) | throws com.foxit.sdk.PDFException

根据索引删除用于裁剪的文本裁剪。

参数

  [in] | index | 文本裁剪索引。有效范围：从0到(count-1)。 count 由函数GraphicsObject.getClipTextObjectCount 返回。

返回
  true 表示成功，false 表示失败。

注解
  当此函数成功时，应调用函数GraphicsObjects.generateContent 。 更多详细信息请参阅函数GraphicsObjects.generateContent 。

## ◆ rotate()

void com.foxit.sdk.pdf.graphics.GraphicsObject.rotate | ( | int | angle | ) |

从当前状态以指定的角度顺时针旋转当前图形对象。

参数

  [in] | angle | 角度值，用于从当前状态顺时针旋转当前图形对象。 值范围：从0到360。特别地，如果输入值为0或360(表示不旋转当前图形对象)， 当前函数将不执行任何操作。

返回
  无。

注解
  当此函数成功时，应调用函数GraphicsObjects.generateContent 。 更多详细信息请参阅函数GraphicsObjects.generateContent 。

## ◆ setBlendMode()

void com.foxit.sdk.pdf.graphics.GraphicsObject.setBlendMode | ( | int | blend_mode | ) | throws com.foxit.sdk.PDFException

设置透明成像模型的混合模式。

参数

  [in] | blend_mode | 新的混合模式。请参考从com.foxit.sdk.pdf.graphics.GraphicsObject.e_BlendNormal 开始的值， 这应该是这些值中的一个。

返回
  无。

注解
  当此函数成功时，应调用函数GraphicsObjects.generateContent 。 更多详细信息请参阅函数GraphicsObjects.generateContent 。

## ◆ setClipRect()

void com.foxit.sdk.pdf.graphics.GraphicsObject.setClipRect | ( | RectF | clip_rect | ) |

设置裁剪矩形。

新的裁剪矩形将默认使用填充模式com.foxit.sdk.common.Constants.e_FillModeWinding 设置。

参数

  [in] | clip_rect | 新的裁剪矩形。

返回
  无。

注解
  当此函数成功时，应调用函数GraphicsObjects.generateContent 。 更多详细信息请参阅函数GraphicsObjects.generateContent 。

## ◆ setColorState()

void com.foxit.sdk.pdf.graphics.GraphicsObject.setColorState | ( | ColorState | color_state | ) | throws com.foxit.sdk.PDFException

设置颜色状态。

文本图形对象、路径图形对象和表单XObject图形对象可以具有此属性。 如果尝试为其余不支持的类型设置颜色状态，将抛出异常com.foxit.sdk.common.Constants.e_ErrUnsupported 。

参数

  [in] | color_state | 要设置到当前图形对象的颜色状态对象。

返回
  无。

注解
  当此函数成功时，应调用函数GraphicsObjects.generateContent 。 更多详细信息请参阅函数GraphicsObjects.generateContent 。

## ◆ setFillColor()

void com.foxit.sdk.pdf.graphics.GraphicsObject.setFillColor | ( | long | color | ) | throws com.foxit.sdk.PDFException

设置填充颜色。

文本图形对象、路径图形对象和表单XObject图形对象可以具有颜色状态。 如果尝试为其余不支持的类型设置填充颜色，将抛出com.foxit.sdk.common.Constants.e_ErrUnsupported 。
对于路径图形对象，请确保填充模式不是com.foxit.sdk.common.Constants.e_FillModeNone ； 否则填充颜色将不会对路径图形对象产生任何影响。请参阅函数 PathObject.getFillMode 和PathObject.setFillMode 来 检查和更改路径图形对象的填充模式。

此函数仅设置RGB颜色值。 如果需要设置其他颜色空间（如CMYK颜色空间）的填充颜色， 可以使用函数GraphicsObject.setColorState 。

参数

  [in] | color | 新的颜色值，格式为0xAARRGGBB。

返回
  无。

注解
  当此函数成功时，应调用函数GraphicsObjects.generateContent 。 更多详细信息请参阅函数GraphicsObjects.generateContent 。

## ◆ setFillOpacity()

void com.foxit.sdk.pdf.graphics.GraphicsObject.setFillOpacity | ( | float | opacity | ) | throws com.foxit.sdk.PDFException

设置除描边外的绘制操作的不透明度值。

参数

  [in] | opacity | 新的不透明度值。有效范围：0.0到1.0。 0.0表示完全透明，1.0表示完全不透明。

返回
  无。

注解
  当此函数成功时，应调用函数GraphicsObjects.generateContent 。 更多详细信息请参阅函数GraphicsObjects.generateContent 。

## ◆ setGraphState()

void com.foxit.sdk.pdf.graphics.GraphicsObject.setGraphState | ( | GraphState | graph_state | ) | throws com.foxit.sdk.PDFException

设置图形状态。

表单XObject图形对象、路径图形对象和文本图形对象(其文本模式为 com.foxit.sdk.pdf.graphics.TextState.e_ModeStroke 、com.foxit.sdk.pdf.graphics.TextState.e_ModeStrokeClip 、 com.foxit.sdk.pdf.graphics.TextState.e_ModeFillStroke 或com.foxit.sdk.pdf.graphics.TextState.e_ModeFillStrokeClip ) 可以具有此属性。如果尝试为其余不支持的类型设置图形状态，将抛出异常 com.foxit.sdk.common.Constants.e_ErrUnsupported 。

参数

  [in] | graph_state | 新的图形状态。

返回
  无。

注解
  当此函数成功时，应调用函数GraphicsObjects.generateContent 。 更多详细信息请参阅函数GraphicsObjects.generateContent 。

## ◆ setMatrix()

void com.foxit.sdk.pdf.graphics.GraphicsObject.setMatrix | ( | Matrix2D | matrix | ) | throws com.foxit.sdk.PDFException

设置矩阵。

参数

  [in] | matrix | 新的矩阵值。

返回
  无。

注解
  当此函数成功时，应调用函数GraphicsObjects.generateContent 。 更多详细信息请参阅函数GraphicsObjects.generateContent 。

## ◆ setStrokeColor()

void com.foxit.sdk.pdf.graphics.GraphicsObject.setStrokeColor | ( | long | color | ) | throws com.foxit.sdk.PDFException

设置描边颜色。

文本图形对象、路径图形对象和表单XObject图形对象可以具有此属性。 如果当前图形对象是文本图形对象且文本模式为com.foxit.sdk.pdf.graphics.TextState.e_ModeFill ， 描边颜色将不会对文本图形对象产生影响。
如果尝试为其余不支持的类型设置描边颜色，将抛出异常com.foxit.sdk.common.Constants.e_ErrUnsupported 。
函数GraphicsObject.setColorState 可用于在其他颜色空间(如CMYK颜色空间)中设置描边颜色。

参数

  [in] | color | 新的颜色值，格式为0xAARRGGBB。

返回
  无。

注解
  当此函数成功时，应调用函数GraphicsObjects.generateContent 。 更多详细信息请参阅函数GraphicsObjects.generateContent 。

## ◆ setStrokeOpacity()

void com.foxit.sdk.pdf.graphics.GraphicsObject.setStrokeOpacity | ( | float | opacity | ) | throws com.foxit.sdk.PDFException

设置路径和字形轮廓的描边绘制操作的不透明度值。

参数

  [in] | opacity | 新的不透明度值。有效范围：0.0到1.0。 0.0表示完全透明，1.0表示完全不透明。

返回
  无。

注解
  当此函数成功时，应调用函数GraphicsObjects.generateContent 。 更多详细信息请参阅函数GraphicsObjects.generateContent 。

## ◆ transform()

boolean com.foxit.sdk.pdf.graphics.GraphicsObject.transform | ( | Matrix2D | matrix,
|  | boolean | need_transform_clippath
| ) |  |

变换当前图形对象。

参数

  [in] | matrix | 变换矩阵。
  [in] | need_transform_clippath | true 表示与当前图形对象一起变换裁剪路径。 false 表示仅变换当前图形对象。

返回
  true 表示成功，false 表示失败。

注解
  当此函数成功时，应调用函数GraphicsObjects.generateContent 。 更多详细信息请参阅函数GraphicsObjects.generateContent 。

## 类成员变量说明

## ◆ e_BlendColor

final int com.foxit.sdk.pdf.graphics.GraphicsObject.e_BlendColor = 23
| static

使用源颜色的色调和饱和度以及背景颜色的明度创建颜色。

公式如下：

    B(Cb, Cs) = SetLum(Cs, Lum(Cb)).

## ◆ e_BlendColorBurn

final int com.foxit.sdk.pdf.graphics.GraphicsObject.e_BlendColorBurn = 7
| static

加深背景颜色以反映源颜色。

用白色绘制不产生变化。
公式如下：

             B(Cb, Cs) =
             -1 - min(1, (1 - Cb) / Cs)  if Cs > 0
             -0              if Cs = 0

## ◆ e_BlendColorDodge

final int com.foxit.sdk.pdf.graphics.GraphicsObject.e_BlendColorDodge = 6
| static

增亮背景颜色以反映源颜色。

用黑色绘制不产生变化。
公式如下：

             B(Cb, Cs) =
             -min(1, Cb / (1 - Cs))    if Cs < 1
             -1              if Cs = 1

## ◆ e_BlendDarken

final int com.foxit.sdk.pdf.graphics.GraphicsObject.e_BlendDarken = 4
| static

选择背景和源颜色中较暗的一个。

公式如下：

    B(Cb, Cs) = min(Cb, Cs).

## ◆ e_BlendDifference

final int com.foxit.sdk.pdf.graphics.GraphicsObject.e_BlendDifference = 10
| static

从较亮的颜色中减去两种组成颜色中较暗的一种。

公式如下：

    B(Cb, Cs) = |Cb - Cs|.

## ◆ e_BlendExclusion

final int com.foxit.sdk.pdf.graphics.GraphicsObject.e_BlendExclusion = 11
| static

使用源颜色的色调和背景颜色的饱和度和明度创建颜色。

公式如下：

    B(Cb, Cs) = SetLum(SetSat(Cs, Sat(Cb)), Lum(Cb)).

## ◆ e_BlendHardlight

final int com.foxit.sdk.pdf.graphics.GraphicsObject.e_BlendHardlight = 8
| static

根据源颜色值进行相乘或滤色。

公式如下：

            B(Cb, Cs) =
            -Multiply(Cb, 2 * Cs)    if Cs <= 0.5
            -Screen(Cb, 2 * Cs - 1)  if Cs > 0.5

## ◆ e_BlendHue

final int com.foxit.sdk.pdf.graphics.GraphicsObject.e_BlendHue = 21
| static

使用源颜色的色调和背景颜色的饱和度和明度创建颜色。

公式如下：

    B(Cb, Cs) = SetLum(SetSat(Cs, Sat(Cb)), Lum(Cb)).

## ◆ e_BlendLighten

final int com.foxit.sdk.pdf.graphics.GraphicsObject.e_BlendLighten = 5
| static

选择背景和源颜色中较亮的一个。

公式如下：

    B(Cb, Cs) = max(Cb, Cs).

## ◆ e_BlendLuminosity

final int com.foxit.sdk.pdf.graphics.GraphicsObject.e_BlendLuminosity = 24
| static

使用源颜色的明度和背景颜色的色调和饱和度创建颜色。

公式如下：

    B(Cb, Cs) = SetLum(Cb, Lum(Cs)).

## ◆ e_BlendMultiply

final int com.foxit.sdk.pdf.graphics.GraphicsObject.e_BlendMultiply = 1
| static

将背景与源颜色值相乘。

公式如下：

    B(Cb, Cs) = Cb * Cs.

## ◆ e_BlendNormal

final int com.foxit.sdk.pdf.graphics.GraphicsObject.e_BlendNormal = 0
| static

选择源颜色并忽略背景颜色。

公式如下：

    B(Cb, Cs) = Cs.

## ◆ e_BlendOverlay

final int com.foxit.sdk.pdf.graphics.GraphicsObject.e_BlendOverlay = 3
| static

根据背景颜色值进行相乘或滤色。

公式如下：

    B(Cb, Cs) = HardLight(Cs, Cb).

## ◆ e_BlendSaturation

final int com.foxit.sdk.pdf.graphics.GraphicsObject.e_BlendSaturation = 22
| static

使用源颜色的饱和度和背景颜色的色调和明度创建颜色。

公式如下：

    B(Cb, Cs) = SetLum(SetSat(Cb, Sat(Cs)), Lum(Cb)).

## ◆ e_BlendScreen

final int com.foxit.sdk.pdf.graphics.GraphicsObject.e_BlendScreen = 2
| static

将背景的补码与源颜色值相乘，然后对结果取补。

公式如下：

    B(Cb, Cs) = 1 - [(1 - Cb) * (1 - Cs)] = Cb + Cs - Cb * Cs.

## ◆ e_BlendSoftlight

final int com.foxit.sdk.pdf.graphics.GraphicsObject.e_BlendSoftlight = 9
| static

根据源颜色值使颜色变暗或变亮。

公式如下：

            B(Cb, Cs) =
            -Cb - (1 - 2 * Cs) * Cb * (1 - Cb)    if Cs <= 0.5
            -Cb + (2 * Cs - 1) * (D(Cb) - Cb)    if Cs > 0.5
            where D(x) =
            -((16 * x - 12) * x + 4) * x      if x <= 0.25
            -sqrt(x)                if x > 0.25