com.foxit.sdk.pdf.graphics.FormXObject Class Reference
Inheritance diagram for com.foxit.sdk.pdf.graphics.FormXObject:
com.foxit.sdk.pdf.graphics.GraphicsObject

Public Member Functions

GraphicsObjects getGraphicsObjects () throws com.foxit.sdk.PDFException
 Get graphics objects that associated with current form XObject.
More...
 
PDFStream getStream () throws com.foxit.sdk.PDFException
 Get stream.
More...
 
boolean importPageContent (PDFPage source_page, boolean is_annots_included) throws com.foxit.sdk.PDFException
 Import page content from a specified PDF page to current form XObject.
More...
 
- Public Member Functions inherited from com.foxit.sdk.pdf.graphics.GraphicsObject
boolean addClipPath (Path path, int fill_mode) throws com.foxit.sdk.PDFException
 Add a path for clipping.
More...
 
boolean addClipTextObject (TextObject textobject) throws com.foxit.sdk.PDFException
 Add text object for clipping.
More...
 
boolean clearClips ()
 Clear all clips.
More...
 
GraphicsObject clone ()
 Clone a new graphics object.
More...
 
int getBlendMode () throws com.foxit.sdk.PDFException
 Get the blend mode for transparent imaging model.
More...
 
Path getClipPath (int index) throws com.foxit.sdk.PDFException
 Get a path clip by index.
More...
 
int getClipPathCount ()
 Get the count of path clip.
More...
 
int getClipPathFillMode (int index) throws com.foxit.sdk.PDFException
 Get the fill mode of a path clip by index.
More...
 
RectF getClipRect ()
 Get clip rectangle.
More...
 
TextObject getClipTextObject (int index) throws com.foxit.sdk.PDFException
 Get the text object of a text clip by index.
More...
 
int getClipTextObjectCount ()
 Get the count of text clip.
More...
 
long getFillColor ()
 Get the fill color.
More...
 
FormXObject getFormXObject ()
 Get the form XObject object if current graphics object represents a form XObject object.
More...
 
GraphState getGraphState ()
 Get graph state.
More...
 
ImageObject getImageObject ()
 Get the image object if current graphics object represents an image object.
More...
 
LayerNodeArray getLayers (LayerTree layer_tree) throws com.foxit.sdk.PDFException
 Get all the layers which are associated with current graphics object.
More...
 
MarkedContent getMarkedContent ()
 Get marked content object.
More...
 
Matrix2D getMatrix () throws com.foxit.sdk.PDFException
 Get matrix.
More...
 
PathObject getPathObject ()
 Get the path object if current graphics object represents a path object.
More...
 
RectF getRect ()
 Get the rectangle of current graphics object.
More...
 
ShadingObject getShadingObject ()
 Get the shading object if current graphics object represents a shading object.
More...
 
long getStrokeColor ()
 Get the stroke color.
More...
 
TextObject getTextObject ()
 Get the text object if current graphics object represents a text object.
More...
 
int getType ()
 Get the type of current graphics object.
More...
 
boolean hasTransparency ()
 Check whether current graphics object has transparency or not.
More...
 
void release ()
 Release a cloned or newly created PDF graphics object which has not been inserted into any PDF page or other object.
More...
 
boolean removeClipPath (int index) throws com.foxit.sdk.PDFException
 Remove a path clip by index.
More...
 
boolean removeClipTextObject (int index) throws com.foxit.sdk.PDFException
 Remove a text clip by index for clipping.
More...
 
void setBlendMode (int blend_mode) throws com.foxit.sdk.PDFException
 Set the blend mode for transparent imaging model.
More...
 
void setClipRect (RectF clip_rect)
 Set clip rectangle.
More...
 
void setFillColor (long color) throws com.foxit.sdk.PDFException
 Set the fill color.
More...
 
void setGraphState (GraphState graph_state) throws com.foxit.sdk.PDFException
 Set graph state.
More...
 
void setMatrix (Matrix2D matrix) throws com.foxit.sdk.PDFException
 Set matrix.
More...
 
void setStrokeColor (long color) throws com.foxit.sdk.PDFException
 Set the stroke color.
More...
 
boolean transform (Matrix2D matrix, boolean need_transform_clippath)
 Transform current graphics object.
More...
 

Static Public Member Functions

static FormXObject create (PDFDoc document) throws com.foxit.sdk.PDFException
 Create a new form XObject graphics object.
More...
 

Additional Inherited Members

- Static Public Attributes inherited from com.foxit.sdk.pdf.graphics.GraphicsObject
static final int e_BlendColor = 23
 Creates a color with the hue and saturation of the source color, and the luminosity of the backdrop color.
More...
 
static final int e_BlendColorBurn = 7
 Darkens backdrop color to reflect the source color.
More...
 
static final int e_BlendColorDodge = 6
 Brightens backdrop color to reflect source colors.
More...
 
static final int e_BlendDarken = 4
 Select darker one of backdrop and source colors.
More...
 
static final int e_BlendDifference = 10
 Subtracts the darker of the two constituent colors from lighter colors.
More...
 
static final int e_BlendExclusion = 11
 Creates a color with the hue of the source color, and the saturation and luminosity of the backdrop color.
More...
 
static final int e_BlendHardlight = 8
 Multiply or screens colors, depending on source color value.
More...
 
static final int e_BlendHue = 21
 Creates a color with the hue of the source color, and the saturation and luminosity of the backdrop color.
More...
 
static final int e_BlendLighten = 5
 Select lighter one of backdrop and source colors.
More...
 
static final int e_BlendLuminosity = 24
 Creates a color with the luminosity of the source color, and the hue and saturation of the backdrop color.
More...
 
static final int e_BlendMultiply = 1
 Multiply backdrop by source color values.
More...
 
static final int e_BlendNormal = 0
 Selecting source color and ignoring backdrop color.
More...
 
static final int e_BlendOverlay = 3
 Multiply or screens colors, depending on backdrop color value.
More...
 
static final int e_BlendSaturation = 22
 Creates a color with the saturation of the source color, and the hue and luminosity of the backdrop color.
More...
 
static final int e_BlendScreen = 2
 Multiply complements of backdrop by source color values, and then complement the result.
More...
 
static final int e_BlendSoftlight = 9
 Darkens or lightens colors, depending on source color value.
More...
 
static final int e_TypeAll = 0
 Represents all graphics object types, only used as filter.

 
static final int e_TypeFormXObject = 5
 Form XObject graphics object.

 
static final int e_TypeImage = 3
 Image graphics object.

 
static final int e_TypePath = 2
 Path graphics object.

 
static final int e_TypeShading = 4
 Shading graphics object.

 
static final int e_TypeText = 1
 Text graphics object.

 

Detailed Description

A form XObject is not only a graphics object, but also a container. A form XObject consists of a set of graphics objects or sub form XObjects. Form XObject is a kind of PDF graphics object, so class FormXObject is derived from class GraphicsObject. It offers functions to get/set form XObject's data.
To create a new form XObject graphics object, please use function PathObject::create and then import page content to the new form XObject, or insert new graphics object to form XObject through GraphicsObjects object returned by function FormXObject::getGraphicsObjects.

See also
GraphicsObject

Member Function Documentation

◆ create()

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

Create a new form XObject graphics object.

The newly created form XObject graphics object does not have any data yet. Then, setting functions can be called to set data to the new form XObject graphics object.

Parameters
documentA valid PDF document object. The new form XObject graphics object should be inserted to one page of this PDF document then.
Returns
A new form XObject.
If the newly created form XObject will not inserted to any page or other objects, please remember to call function GraphicsObject::release to release it when no use.

◆ getGraphicsObjects()

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

Get graphics objects that associated with current form XObject.

Returns
A GraphicsObjects object.

◆ getStream()

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

Get stream.

Returns
A PDFStream that represents the stream data of current form XObject. If there is any error, this function will return null.

◆ importPageContent()

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

Import page content from a specified PDF page to current form XObject.

If this function succeeds, the boundary box of current form XObject will be the same as page's size.

Parameters
source_pageA valid PDF page object that represents the source PDF page whose content will be imported to current form XObject.
is_annots_includedtrue means annotations should be included with the content of parameter source_page. false means annotations should be ignored from the content of parameter source_page.
Returns
true means success, while false means failure.
Note
When this function succeeds, function GraphicsObjects::generateContent should be called. Please refer to function GraphicsObjects::generateContent for more details.

Foxit Software Corporation Logo
@2018 Foxit Software Incorporated. All rights reserved.