Foxit PDF SDK

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

## Public 成员函数
synchronized void | delete ()
| 直接清除C++相关资源。 更多...
int | getFillMode () throws com.foxit.sdk.PDFException
| 获取填充模式。 更多...
Path | getPathData () throws com.foxit.sdk.PDFException
| 获取路径数据。 更多...
boolean | getStrokeState () throws com.foxit.sdk.PDFException
| 获取描边状态 更多...
void | setFillMode (int fill_mode) throws com.foxit.sdk.PDFException
| 设置填充模式。 更多...
void | setPathData (Path path_data) throws com.foxit.sdk.PDFException
| 设置路径数据。 更多...
void | setStrokeState (boolean is_stroke) throws com.foxit.sdk.PDFException
| 设置描边状态。 更多...
Public 成员函数 继承自 com.foxit.sdk.pdf.graphics.GraphicsObject
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)
| 克隆新的图形对象。 更多...
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 PathObject | create () throws com.foxit.sdk.PDFException
| 创建新的路径图形对象。 更多...
static PathObject | createFromTextObject (PDFPage page, TextObject text_obj) throws com.foxit.sdk.PDFException
| 从文本对象创建路径图形对象。 更多...

## 额外继承的成员函数
静态 Public 属性 继承自 com.foxit.sdk.pdf.graphics.GraphicsObject
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图形对象，因此PathObject 类派生自 GraphicsObject 类。它提供了获取/设置路径图形对象数据的函数。
要创建新的路径图形对象，请使用PathObject.create 函数，然后 使用设置函数为新的路径图形对象设置信息。 PathObject.createFromTextObject 函数可用于从文本图形对象 创建路径图形对象。

参见
  GraphicsObject

## 成员函数说明

## ◆ create()

static PathObject com.foxit.sdk.pdf.graphics.PathObject.create | ( |  | ) | throws com.foxit.sdk.PDFException
| static

创建新的路径图形对象。

新创建的路径图形对象尚未包含任何数据。然后，可以调用设置函数 为新的路径图形对象设置数据。 如果新创建的路径图形对象不会插入到任何页面或其他对象中， 请记住在不使用时调用GraphicsObject.release 函数来释放它。

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

## ◆ createFromTextObject()

static PathObject com.foxit.sdk.pdf.graphics.PathObject.createFromTextObject | ( | PDFPage | page,
|  | TextObject | text_obj
| ) |  | throws com.foxit.sdk.PDFException
| static

从文本对象创建路径图形对象。

如果新创建的路径图形对象不会插入到任何页面或其他对象中， 请记住在不使用时调用GraphicsObject.release 函数来释放它。

参数

  [in] | page | 有效的PDF页面对象。
  [in] | text_obj | 文本图形对象。它不应为null。 请确保文本图形对象在参数page指定的PDF页面中。

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

## ◆ delete()

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

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

返回
  无。

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

重载 com.foxit.sdk.pdf.graphics.GraphicsObject .

## ◆ getFillMode()

int com.foxit.sdk.pdf.graphics.PathObject.getFillMode | ( |  | ) | throws com.foxit.sdk.PDFException

获取填充模式。

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

## ◆ getPathData()

Path com.foxit.sdk.pdf.graphics.PathObject.getPathData | ( |  | ) | throws com.foxit.sdk.PDFException

获取路径数据。

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

## ◆ getStrokeState()

boolean com.foxit.sdk.pdf.graphics.PathObject.getStrokeState | ( |  | ) | throws com.foxit.sdk.PDFException

获取描边状态

返回
  true 表示当前路径图形对象被描边，false 表示 当前路径图形对象未被描边。

## ◆ setFillMode()

void com.foxit.sdk.pdf.graphics.PathObject.setFillMode | ( | int | fill_mode | ) | throws com.foxit.sdk.PDFException

设置填充模式。

参数

  [in] | fill_mode | 填充模式。请参考从com.foxit.sdk.common.Constants.e_FillModeNone 开始的值， 这应该是这些值中的一个。

返回
  无。

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

## ◆ setPathData()

void com.foxit.sdk.pdf.graphics.PathObject.setPathData | ( | Path | path_data | ) | throws com.foxit.sdk.PDFException

设置路径数据。

参数

  [in] | path_data | 表示要设置的路径数据的有效路径对象。

返回
  无。

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

## ◆ setStrokeState()

void com.foxit.sdk.pdf.graphics.PathObject.setStrokeState | ( | boolean | is_stroke | ) | throws com.foxit.sdk.PDFException

设置描边状态。

参数

  [in] | is_stroke | true 表示当前路径图形对象要被描边。 false 表示当前路径图形对象不要被描边。

返回
  无。

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