Foxit PDF SDK

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

## Public 成员函数
Bitmap | cloneBitmap (GraphicsObjects graphics_objects) throws com.foxit.sdk.PDFException
Bitmap | cloneBitmap (PDFPage page, GraphicsObjects graphics_objects) throws com.foxit.sdk.PDFException
| 从当前图像图形对象克隆位图。 更多...
synchronized void | delete ()
| 直接清除C++相关资源。 更多...
int | getColorSpace () throws com.foxit.sdk.PDFException
| 获取颜色空间。 更多...
PDFObject | getMask ()
| 获取表示当前图像图形对象蒙版的PDF对象。 更多...
PDFStream | getStream () throws com.foxit.sdk.PDFException
| 获取图像流。 更多...
boolean | isImageMask ()
| 检查当前图像对象是否被视为蒙版。 更多...
void | setBitmap (Bitmap bitmap, Bitmap mask) throws com.foxit.sdk.PDFException
| 将位图设置到当前图像图形对象。 更多...
void | setImage (Image image, int frame_index) 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 ImageObject | create (PDFDoc document) throws com.foxit.sdk.PDFException
| 创建新的图像图形对象。 更多...
static ImageObject | createFromType3TextObject (PDFPage page, TextObject text_obj)
| 从type3文本对象创建图像图形对象。 更多...

## 额外继承的成员函数
静态 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图形对象，因此类ImageObject 派生自 类GraphicsObject 。它提供获取/设置图像图形对象数据的函数。
要创建新的图像图形对象，请使用函数ImageObject.create ，然后 使用设置函数为新的图像图形对象设置信息。

参见
  GraphicsObject

## 成员函数说明

## ◆ cloneBitmap() [1/2]

Bitmap com.foxit.sdk.pdf.graphics.ImageObject.cloneBitmap | ( | GraphicsObjects | graphics_objects | ) | throws com.foxit.sdk.PDFException

弃用:
  此函数已弃用。请使用带两个参数的函数ImageObject.cloneBitmap 。

目前，只有当位图格式是以下格式之一时，才能从图像图形对象克隆位图：
com.foxit.sdk.common.Bitmap.e_DIB8bppMask 、com.foxit.sdk.common.Bitmap.e_DIB8bpp 、 com.foxit.sdk.common.Bitmap.e_DIBRgb 、com.foxit.sdk.common.Bitmap.e_DIBRgb32 、 com.foxit.sdk.common.Bitmap.e_DIBArgb 、com.foxit.sdk.common.Bitmap.e_DIBCmyk 。
如果返回位图对象的函数common.Bitmap.isEmpty 的返回值为true， 表示位图的DIB格式不受支持。

参数

  [in] | graphics_objects | 有效的com.foxit.sdk.pdf.GraphicsObjects 对象。请确保当前图像图形对象 正好属于此com.foxit.sdk.pdf.GraphicsObjects 对象(可能是PDF页面)。

返回
  新克隆的位图对象。如果返回位图对象的函数common.Bitmap.isEmpty 的返回值为true， 表示位图的DIB格式不受支持。

## ◆ cloneBitmap() [2/2]

Bitmap com.foxit.sdk.pdf.graphics.ImageObject.cloneBitmap | ( | PDFPage | page,
|  | GraphicsObjects | graphics_objects
| ) |  | throws com.foxit.sdk.PDFException

从当前图像图形对象克隆位图。

目前，只有当位图格式是以下格式之一时，才能从图像图形对象克隆位图：
com.foxit.sdk.common.Bitmap.e_DIB8bppMask 、com.foxit.sdk.common.Bitmap.e_DIB8bpp 、 com.foxit.sdk.common.Bitmap.e_DIBRgb 、com.foxit.sdk.common.Bitmap.e_DIBRgb32 、 com.foxit.sdk.common.Bitmap.e_DIBArgb 、com.foxit.sdk.common.Bitmap.e_DIBCmyk 。
如果返回位图对象的函数common.Bitmap.isEmpty 的返回值为true， 表示位图的DIB格式不受支持。

参数

  [in] | page | 有效的PDF页面对象。请确保当前图像图形对象正好属于此页面。
  [in] | graphics_objects | 有效的com.foxit.sdk.pdf.GraphicsObjects 对象。请确保当前图像图形对象 正好属于此com.foxit.sdk.pdf.GraphicsObjects 对象(可能是PDF页面)。

返回
  新克隆的位图对象。如果返回位图对象的函数common.Bitmap.isEmpty 的返回值为true， 表示位图的DIB格式不受支持。

## ◆ create()

static ImageObject com.foxit.sdk.pdf.graphics.ImageObject.create | ( | PDFDoc | document | ) | throws com.foxit.sdk.PDFException
| static

创建新的图像图形对象。

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

参数

  [in] | document | 有效的PDF文档对象。然后新的图像图形对象应该插入到 此PDF文档的一个页面中。

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

## ◆ createFromType3TextObject()

static ImageObject com.foxit.sdk.pdf.graphics.ImageObject.createFromType3TextObject | ( | PDFPage | page,
|  | TextObject | text_obj
| ) |  |
| static

从type3文本对象创建图像图形对象。

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

参数

  [in] | page | 有效的PDF页面对象。
  [in] | text_obj | 有效的文本对象。此文本对象应该是type3文本对象。

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

## ◆ delete()

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

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

返回
  无。

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

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

## ◆ getColorSpace()

int com.foxit.sdk.pdf.graphics.ImageObject.getColorSpace | ( |  | ) | throws com.foxit.sdk.PDFException

获取颜色空间。

返回
  颜色空间。请参考从com.foxit.sdk.common.Constants.e_ColorSpaceDeviceGray 开始的值， 这将是这些值中的一个。

## ◆ getMask()

PDFObject com.foxit.sdk.pdf.graphics.ImageObject.getMask | ( |  | ) |

获取表示当前图像图形对象蒙版的PDF对象。

蒙版可以是PDF字典或PDF数组：

- PDF字典表示要应用到此图像的图像蒙版。
- PDF数组表示要作为颜色键蒙版应用到图像的颜色范围。

更多详细信息请参阅<PDF Reference 1.7>中的第4.8.4节"图像字典"。

返回
  表示蒙版的PDF对象。 如果ImageObject.isImageMask 返回true，此函数将返回null。

## ◆ getStream()

PDFStream com.foxit.sdk.pdf.graphics.ImageObject.getStream | ( |  | ) | throws com.foxit.sdk.PDFException

获取图像流。

返回
  表示图像流的com.foxit.sdk.pdf.objects.PDFStream 。 如果有任何错误，此函数将返回null。

## ◆ isImageMask()

boolean com.foxit.sdk.pdf.graphics.ImageObject.isImageMask | ( |  | ) |

检查当前图像对象是否被视为蒙版。

返回
  true 表示当前对象被视为蒙版，false 表示不是。

## ◆ setBitmap()

void com.foxit.sdk.pdf.graphics.ImageObject.setBitmap | ( | Bitmap | bitmap,
|  | Bitmap | mask
| ) |  | throws com.foxit.sdk.PDFException

将位图设置到当前图像图形对象。

参数

  [in] | bitmap | 要设置到当前图像的有效位图对象。
  [in] | mask | 蒙版位图。默认值：通过默认构造函数创建的位图对象，未设置任何值， 表示不使用蒙版。 如果此参数有效，其格式应为com.foxit.sdk.common.Bitmap.e_DIB8bppMask 。 仅当参数bitmap没有alpha通道时，此参数才有用。

返回
  无

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

## ◆ setImage()

void com.foxit.sdk.pdf.graphics.ImageObject.setImage | ( | Image | image,
|  | int | frame_index
| ) |  | throws com.foxit.sdk.PDFException

将图像的一帧设置到当前图像图形对象。

输入图像可能包含多帧，只能将图像的一帧设置到当前图像图形对象。

参数

  [in] | image | 有效的图像对象。此图像应至少包含一帧，图像类型 不应为com.foxit.sdk.common.Image.e_Unknown 。
  [in] | frame_index | 帧索引，用于决定参数image的哪一帧要被设置。 有效范围：从0到(count-1)。count由函数 common.Image.getFrameCount 返回。

返回
  无

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