Foxit PDF SDK
|
Public Member Functions | |
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... | |
boolean | equal (GraphicsObject other) |
Check if input object is equal to current 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... | |
ColorState | getColorState () |
Get color state. More... | |
long | getFillColor () |
Get the fill color. More... | |
float | getFillOpacity () throws com.foxit.sdk.PDFException |
Get the opacity value for painting operations other than stroking. More... | |
FormXObject | getFormXObject () |
Get the form XObject graphics object if current graphics object represents a form XObject object. More... | |
GraphState | getGraphState () |
Get graph state. More... | |
ImageObject | getImageObject () |
Get the image graphics 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 graphics 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 graphics object if current graphics object represents a shading object. More... | |
long | getStrokeColor () |
Get the stroke color. More... | |
float | getStrokeOpacity () throws com.foxit.sdk.PDFException |
Get opacity value for stroke painting operations for paths and glyph outlines. More... | |
TextObject | getTextObject () |
Get the text graphics 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 | rotate (int angle) |
Rotate current graphics object from current state with specified angle degree in clockwise. 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 | setColorState (ColorState color_state) throws com.foxit.sdk.PDFException |
Set color state. More... | |
void | setFillColor (long color) throws com.foxit.sdk.PDFException |
Set the fill color. More... | |
void | setFillOpacity (float opacity) throws com.foxit.sdk.PDFException |
Set the opacity value for painting operations other than stroking. 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... | |
void | setStrokeOpacity (float opacity) throws com.foxit.sdk.PDFException |
Set opacity value for stroke painting operations for paths and glyph outlines. More... | |
boolean | transform (Matrix2D matrix, boolean need_transform_clippath) |
Transform current graphics object. More... | |
Static Public Attributes | |
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. | |
Content of a PDF page usually consists of a sequence of graphics objects. Each graphics object contains its state information, data and instructions for rendering.
Class GraphicsObject is the base class for all types of PDF graphics objects. It offers the base functions to get/set graphics object's common properties. For concrete graphics object types, please refer to derived classes.
To get or insert/remove a graphics object, please refer to class com.foxit.sdk.pdf.GraphicsObjects .
If any change is done to a PDF graphics object, please remember to call function GraphicsObjects.generateContent for com.foxit.sdk.pdf.GraphicsObjects object (to which current graphics object belongs). Please refer to comment of function GraphicsObjects.generateContent for more details.
boolean com.foxit.sdk.pdf.graphics.GraphicsObject.addClipPath | ( | Path | path, |
int | fill_mode | ||
) | throws com.foxit.sdk.PDFException |
Add a path for clipping.
[in] | path | Path data to be added to current graphics object. |
[in] | fill_mode | Fill mode for the input path. Please refer to values starting from com.foxit.sdk.common.Constants.e_FillModeNone and this should be one of these values. |
boolean com.foxit.sdk.pdf.graphics.GraphicsObject.addClipTextObject | ( | TextObject | textobject | ) | throws com.foxit.sdk.PDFException |
Add text object for clipping.
[in] | textobject | Text object to be added for clipping. |
boolean com.foxit.sdk.pdf.graphics.GraphicsObject.clearClips | ( | ) |
Clear all clips.
GraphicsObject com.foxit.sdk.pdf.graphics.GraphicsObject.clone | ( | ) |
Clone a new graphics object.
Newly cloned graphics object is related to the same page with current graphics object by default. Newly cloned graphics object can only be used inside the PDF file which contains current graphics object.
boolean com.foxit.sdk.pdf.graphics.GraphicsObject.equal | ( | GraphicsObject | other | ) |
Check if input object is equal to current object.
[in] | other | Another graphics object. This function will check if current object is equal to this one. |
int com.foxit.sdk.pdf.graphics.GraphicsObject.getBlendMode | ( | ) | throws com.foxit.sdk.PDFException |
Get the blend mode for transparent imaging model.
Path com.foxit.sdk.pdf.graphics.GraphicsObject.getClipPath | ( | int | index | ) | throws com.foxit.sdk.PDFException |
Get a path clip by index.
[in] | index | Path clip index. Valid range: from 0 to (count-1). count is returned by function GraphicsObject.getClipPath . |
int com.foxit.sdk.pdf.graphics.GraphicsObject.getClipPathCount | ( | ) |
Get the count of path clip.
int com.foxit.sdk.pdf.graphics.GraphicsObject.getClipPathFillMode | ( | int | index | ) | throws com.foxit.sdk.PDFException |
Get the fill mode of a path clip by index.
[in] | index | Path clip index. Valid range: from 0 to (count-1). count is returned by function GraphicsObject.getClipPath . |
RectF com.foxit.sdk.pdf.graphics.GraphicsObject.getClipRect | ( | ) |
Get clip rectangle.
TextObject com.foxit.sdk.pdf.graphics.GraphicsObject.getClipTextObject | ( | int | index | ) | throws com.foxit.sdk.PDFException |
Get the text object of a text clip by index.
[in] | index | Text clip index. Valid range: from 0 to (count-1). count is returned by function GraphicsObject.getClipTextObjectCount . |
int com.foxit.sdk.pdf.graphics.GraphicsObject.getClipTextObjectCount | ( | ) |
Get the count of text clip.
ColorState com.foxit.sdk.pdf.graphics.GraphicsObject.getColorState | ( | ) |
Get color state.
Text graphics object, path graphics object, and form XObject graphics object can have color state.
long com.foxit.sdk.pdf.graphics.GraphicsObject.getFillColor | ( | ) |
Get the fill color.
Text graphics object, path graphics object, and form XObject graphics object can have this property. Function GraphicsObject.getColorState can be used to get fille color in other color space, like CMYK color space.
float com.foxit.sdk.pdf.graphics.GraphicsObject.getFillOpacity | ( | ) | throws com.foxit.sdk.PDFException |
Get the opacity value for painting operations other than stroking.
FormXObject com.foxit.sdk.pdf.graphics.GraphicsObject.getFormXObject | ( | ) |
Get the form XObject graphics object if current graphics object represents a form XObject object.
GraphState com.foxit.sdk.pdf.graphics.GraphicsObject.getGraphState | ( | ) |
Get graph state.
Form XObjet graphics object, path graphics object and text graphics object can have this property.
ImageObject com.foxit.sdk.pdf.graphics.GraphicsObject.getImageObject | ( | ) |
Get the image graphics object if current graphics object represents an image object.
LayerNodeArray com.foxit.sdk.pdf.graphics.GraphicsObject.getLayers | ( | LayerTree | layer_tree | ) | throws com.foxit.sdk.PDFException |
Get all the layers which are associated with current graphics object.
[in] | layer_tree | A valid layer tree. All the layer nodes in this layer tree will be enumerated\ in order to find which are associated with current graphics object. |
MarkedContent com.foxit.sdk.pdf.graphics.GraphicsObject.getMarkedContent | ( | ) |
Get marked content object.
Matrix2D com.foxit.sdk.pdf.graphics.GraphicsObject.getMatrix | ( | ) | throws com.foxit.sdk.PDFException |
Get matrix.
PathObject com.foxit.sdk.pdf.graphics.GraphicsObject.getPathObject | ( | ) |
Get the path graphics object if current graphics object represents a path object.
RectF com.foxit.sdk.pdf.graphics.GraphicsObject.getRect | ( | ) |
Get the rectangle of current graphics object.
ShadingObject com.foxit.sdk.pdf.graphics.GraphicsObject.getShadingObject | ( | ) |
Get the shading graphics object if current graphics object represents a shading object.
long com.foxit.sdk.pdf.graphics.GraphicsObject.getStrokeColor | ( | ) |
Get the stroke color.
Text graphics object, path graphics object, and form XObject graphics object can have this property.
Function GraphicsObject.getColorState can be used to get stroke color in other color space, like CMYK color space.
float com.foxit.sdk.pdf.graphics.GraphicsObject.getStrokeOpacity | ( | ) | throws com.foxit.sdk.PDFException |
Get opacity value for stroke painting operations for paths and glyph outlines.
TextObject com.foxit.sdk.pdf.graphics.GraphicsObject.getTextObject | ( | ) |
Get the text graphics object if current graphics object represents a text object.
int com.foxit.sdk.pdf.graphics.GraphicsObject.getType | ( | ) |
Get the type of current graphics object.
boolean com.foxit.sdk.pdf.graphics.GraphicsObject.hasTransparency | ( | ) |
Check whether current graphics object has transparency or not.
void com.foxit.sdk.pdf.graphics.GraphicsObject.release | ( | ) |
Release a cloned or newly created PDF graphics object which has not been inserted into any PDF page or other object.
boolean com.foxit.sdk.pdf.graphics.GraphicsObject.removeClipPath | ( | int | index | ) | throws com.foxit.sdk.PDFException |
Remove a path clip by index.
[in] | index | Path clip index. Valid range: from 0 to (count-1). count is returned by function GraphicsObject.getClipPath . |
boolean com.foxit.sdk.pdf.graphics.GraphicsObject.removeClipTextObject | ( | int | index | ) | throws com.foxit.sdk.PDFException |
Remove a text clip by index for clipping.
[in] | index | Text clip index. Valid range: from 0 to (count-1). count is returned by function GraphicsObject.getClipTextObjectCount . |
void com.foxit.sdk.pdf.graphics.GraphicsObject.rotate | ( | int | angle | ) |
Rotate current graphics object from current state with specified angle degree in clockwise.
[in] | angle | Angle degree value, which is used to rotate current graphics object from current state in clockwise. Value range: from 0 to 360. Specially, if the input value is 0 or 360 (which means not to rotate current graphics object), current function will do nothing. |
void com.foxit.sdk.pdf.graphics.GraphicsObject.setBlendMode | ( | int | blend_mode | ) | throws com.foxit.sdk.PDFException |
Set the blend mode for transparent imaging model.
[in] | blend_mode | New blend mode. Please refer to values starting from com.foxit.sdk.pdf.graphics.GraphicsObject.e_BlendNormal and this should be one of these values. |
void com.foxit.sdk.pdf.graphics.GraphicsObject.setClipRect | ( | RectF | clip_rect | ) |
Set clip rectangle.
New clip rectangle will be set with fill mode com.foxit.sdk.common.Constants.e_FillModeWinding by default.
[in] | clip_rect | New clip rectangle. |
void com.foxit.sdk.pdf.graphics.GraphicsObject.setColorState | ( | ColorState | color_state | ) | throws com.foxit.sdk.PDFException |
Set color state.
Text graphics object, path graphics object, and form XObject graphics object can have this property. If try to set color state for rest unsupported types, exception com.foxit.sdk.common.Constants.e_ErrUnsupported will be thrown.
[in] | color_state | A color state object to be set to current graphics object. |
void com.foxit.sdk.pdf.graphics.GraphicsObject.setFillColor | ( | long | color | ) | throws com.foxit.sdk.PDFException |
Set the fill color.
Text graphics object, path graphics object, and form XObject graphics object can have color state. If try to set fill color for rest unsupported types, com.foxit.sdk.common.Constants.e_ErrUnsupported will be thrown.
For path graphics object, please ensure the fill mode is not com.foxit.sdk.common.Constants.e_FillModeNone ; otherwise the fill color will not have any effect on the path graphics object. Please refer to functions PathObject.getFillMode and PathObject.setFillMode to check and change the fill mode of a path graphics object.
Function GraphicsObject.setColorState can be used to set fill color in other color space, like CMYK color space.
[in] | color | New color value, in format 0xAARRGGBB. |
void com.foxit.sdk.pdf.graphics.GraphicsObject.setFillOpacity | ( | float | opacity | ) | throws com.foxit.sdk.PDFException |
Set the opacity value for painting operations other than stroking.
[in] | opacity | The new opacity value. Valid range: 0.0 to 1.0. 0.0 means full transparency and 1.0 means full opaque. |
void com.foxit.sdk.pdf.graphics.GraphicsObject.setGraphState | ( | GraphState | graph_state | ) | throws com.foxit.sdk.PDFException |
Set graph state.
Form XObjet graphics object, path graphics object and text graphics object can have this property. If try to set graph state to rest unsupported types, exception com.foxit.sdk.common.Constants.e_ErrUnsupported will be thrown.
[in] | graph_state | New graph state. |
void com.foxit.sdk.pdf.graphics.GraphicsObject.setMatrix | ( | Matrix2D | matrix | ) | throws com.foxit.sdk.PDFException |
Set matrix.
[in] | matrix | New matrix value. |
void com.foxit.sdk.pdf.graphics.GraphicsObject.setStrokeColor | ( | long | color | ) | throws com.foxit.sdk.PDFException |
Set the stroke color.
Text graphics object, path graphics object, and form XObject graphics object can have this property. If current graphics object is a text graphics object and the text mode is com.foxit.sdk.pdf.graphics.TextState.e_ModeFill , the stroke color will not have effect on the text graphics object.
If try to set stroke color for rest unsupported types, exception com.foxit.sdk.common.Constants.e_ErrUnsupported will be thrown.
Function GraphicsObject.setColorState can be used to set stroke color in other color space, like CMYK color space.
[in] | color | New color value, in format 0xAARRGGBB. |
void com.foxit.sdk.pdf.graphics.GraphicsObject.setStrokeOpacity | ( | float | opacity | ) | throws com.foxit.sdk.PDFException |
Set opacity value for stroke painting operations for paths and glyph outlines.
[in] | opacity | The new opacity value. Valid range: 0.0 to 1.0. 0.0 means full transparency and 1.0 means full opaque. |
boolean com.foxit.sdk.pdf.graphics.GraphicsObject.transform | ( | Matrix2D | matrix, |
boolean | need_transform_clippath | ||
) |
Transform current graphics object.
[in] | matrix | Transform matrix. |
[in] | need_transform_clippath | true means to transform clip path with current graphics object. false means to transform current graphics object only. |
|
static |
Creates a color with the hue and saturation of the source color, and the luminosity of the backdrop color.
Here is the formula :
B(Cb, Cs) = SetLum(Cs, Lum(Cb)).
|
static |
Darkens backdrop color to reflect the source color.
Painting with white produces no changes.
Here is the formula :
B(Cb, Cs) = -1 - min(1, (1 - Cb) / Cs) if Cs > 0 -0 if Cs = 0
|
static |
Brightens backdrop color to reflect source colors.
Painting with black produces no changes.
Here is the formula :
B(Cb, Cs) = -min(1, Cb / (1 - Cs)) if Cs < 1 -1 if Cs = 1
|
static |
Select darker one of backdrop and source colors.
Here is the formula :
B(Cb, Cs) = min(Cb, Cs).
|
static |
Subtracts the darker of the two constituent colors from lighter colors.
Here is the formula :
B(Cb, Cs) = |Cb - Cs|.
|
static |
Creates a color with the hue of the source color, and the saturation and luminosity of the backdrop color.
Here is the formula :
B(Cb, Cs) = SetLum(SetSat(Cs, Sat(Cb)), Lum(Cb)).
|
static |
Multiply or screens colors, depending on source color value.
Here is the formula :
B(Cb, Cs) = -Multiply(Cb, 2 * Cs) if Cs <= 0.5 -Screen(Cb, 2 * Cs - 1) if Cs > 0.5
|
static |
Creates a color with the hue of the source color, and the saturation and luminosity of the backdrop color.
Here is the formula :
B(Cb, Cs) = SetLum(SetSat(Cs, Sat(Cb)), Lum(Cb)).
|
static |
Select lighter one of backdrop and source colors.
Here is the formula :
B(Cb, Cs) = max(Cb, Cs).
|
static |
Creates a color with the luminosity of the source color, and the hue and saturation of the backdrop color.
Here is the formula :
B(Cb, Cs) = SetLum(Cb, Lum(Cs)).
|
static |
Multiply backdrop by source color values.
Here is the formula :
B(Cb, Cs) = Cb * Cs.
|
static |
Selecting source color and ignoring backdrop color.
Here is the formula :
B(Cb, Cs) = Cs.
|
static |
Multiply or screens colors, depending on backdrop color value.
Here is the formula :
B(Cb, Cs) = HardLight(Cs, Cb).
|
static |
Creates a color with the saturation of the source color, and the hue and luminosity of the backdrop color.
Here is the formula :
B(Cb, Cs) = SetLum(SetSat(Cb, Sat(Cs)), Lum(Cb)).
|
static |
Multiply complements of backdrop by source color values, and then complement the result.
Here is the formula :
B(Cb, Cs) = 1 - [(1 - Cb) * (1 - Cs)] = Cb + Cs - Cb * Cs.
|
static |
Darkens or lightens colors, depending on source color value.
Here is the formula :
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