Foxit PDF SDK
com.foxit.sdk.pdf.graphics.FormXObject类 参考
类 com.foxit.sdk.pdf.graphics.FormXObject 继承关系图:
com.foxit.sdk.pdf.graphics.GraphicsObject

Public 成员函数

synchronized void delete ()
 直接清除C++相关资源。 更多...
 
GraphicsObjects getGraphicsObjects () throws com.foxit.sdk.PDFException
 获取与当前表单XObject关联的图形对象。
更多...
 
PDFStream getStream () throws com.foxit.sdk.PDFException
 获取流。
更多...
 
boolean importPageContent (PDFPage source_page, boolean is_annots_included) throws com.foxit.sdk.PDFException
 从指定的PDF页面将页面内容导入到当前表单XObject。
更多...
 
- 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 FormXObject create (PDFDoc document) throws com.foxit.sdk.PDFException
 创建新的表单XObject图形对象。
更多...
 

额外继承的成员函数

- 静态 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
 文本图形对象。

 

详细描述

表单XObject不仅是图形对象,也是容器。表单XObject由一组图形对象或子表单XObject组成。 表单XObject是一种PDF图形对象,因此com.foxit.sdk.pdf.graphics.FormXObject 类派生自GraphicsObject 类。 它提供了获取/设置表单XObject数据的函数。
要创建新的表单XObject图形对象,请使用PathObject.create 函数,然后 将页面内容导入到新的表单XObject中,或通过FormXObject.getGraphicsObjects 函数 返回的com.foxit.sdk.pdf.GraphicsObjects 对象将新的图形对象插入到表单XObject中。

参见
GraphicsObject

成员函数说明

◆ create()

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

创建新的表单XObject图形对象。

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

参数
[in]document有效的PDF文档对象。新的表单XObject图形对象随后应插入到 此PDF文档的某个页面中。
返回
新的表单XObject。如果有任何错误,此函数将返回null

◆ delete()

synchronized void com.foxit.sdk.pdf.graphics.FormXObject.delete ( )

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

返回
无。
注解
一旦这个接口被调用,这个对象将不能再被使用。

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

◆ getGraphicsObjects()

GraphicsObjects com.foxit.sdk.pdf.graphics.FormXObject.getGraphicsObjects ( ) throws com.foxit.sdk.PDFException

获取与当前表单XObject关联的图形对象。

返回
com.foxit.sdk.pdf.GraphicsObjects 对象。

◆ getStream()

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

获取流。

返回
表示当前表单XObject流数据的com.foxit.sdk.pdf.objects.PDFStream 。 如果有任何错误,此函数将返回null

◆ importPageContent()

boolean com.foxit.sdk.pdf.graphics.FormXObject.importPageContent ( PDFPage  source_page,
boolean  is_annots_included 
) throws com.foxit.sdk.PDFException

从指定的PDF页面将页面内容导入到当前表单XObject。

如果此函数成功,当前表单XObject的边界框将与页面大小相同。

参数
[in]source_page有效的PDF页面对象,表示其内容将被 导入到当前表单XObject的源PDF页面。
[in]is_annots_includedtrue 表示注释应与参数source_page的内容一起包含。 false 表示注释应从参数source_page的内容中忽略。
返回
true 表示成功,false 表示失败。
注解
当此函数成功时,应调用GraphicsObjects.generateContent 函数。 更多详细信息请参阅GraphicsObjects.generateContent 函数。