Class PDGraphicsState
java.lang.Object
org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState
- All Implemented Interfaces:
Cloneable
The current state of the graphics parameters when executing a content stream.
- Author:
- Ben Litchfield
-
Constructor Summary
ConstructorsConstructorDescriptionPDGraphicsState
(PDRectangle page) Constructor with a given page size to initialize the clipping path. -
Method Summary
Modifier and TypeMethodDescriptionclone()
double
Get the value of the stroke alpha constant property.Returns the current blend modeThis will get the current clipping path.This will get the current clipping path, as one or more individual paths.Get the value of the CTM.double
get the value of the flatness property.int
Get the value of the line cap.This will get the current line dash pattern.int
Get the value of the line join.float
Get the value of the line width.float
Get the value of the miter limit.double
Get the value of the non-stroke alpha constant property.double
Deprecated.Returns the non-stroking color.Returns the non-stroking color space.double
get the value of the overprint mode property.This will get the rendering intent.double
get the value of the smoothness property.returns the current softmaskReturns the stroking color.Returns the stroking color space.This will get the graphics text state.This will get the transfer function.void
intersectClippingPath
(Area area) Modify the current clipping path by intersecting it with the given path.void
Modify the current clipping path by intersecting it with the given path.boolean
get the value of the stroke alpha source property.boolean
get the value of the non stroking overprint property.boolean
get the value of the overprint property.boolean
Get the value of the stroke adjustment parameter.void
setAlphaConstant
(double value) set the value of the stroke alpha constant property.void
setAlphaSource
(boolean value) set the value of the alpha source property.void
setBlendMode
(BlendMode blendMode) Sets the blend mode in the current graphics statevoid
Set the value of the CTM.void
setFlatness
(double value) set the value of the flatness property.void
setLineCap
(int value) set the value of the line cap.void
This will set the current line dash pattern.void
setLineJoin
(int value) Get the value of the line join.void
setLineWidth
(float value) set the value of the line width.void
setMiterLimit
(float value) set the value of the miter limit.void
setNonStrokeAlphaConstant
(double value) set the value of the non-stroke alpha constant property.void
setNonStrokeAlphaConstants
(double value) Deprecated.void
setNonStrokingColor
(PDColor color) Sets the non-stroking color.void
setNonStrokingColorSpace
(PDColorSpace colorSpace) Sets the non-stroking color space.void
setNonStrokingOverprint
(boolean value) set the value of the non stroking overprint property.void
setOverprint
(boolean value) set the value of the overprint property.void
setOverprintMode
(double value) set the value of the overprint mode property.void
This will set the rendering intent.void
setSmoothness
(double value) set the value of the smoothness property.void
setSoftMask
(PDSoftMask softMask) Sets the current soft maskvoid
setStrokeAdjustment
(boolean value) set the value of the stroke adjustment.void
setStrokingColor
(PDColor color) Sets the stroking color.void
setStrokingColorSpace
(PDColorSpace colorSpace) Sets the stroking color space.void
setTextState
(PDTextState value) This will set the graphics text state.void
setTransfer
(COSBase transfer) This will set the transfer function.
-
Constructor Details
-
PDGraphicsState
Constructor with a given page size to initialize the clipping path.- Parameters:
page
- the size of the page
-
-
Method Details
-
getCurrentTransformationMatrix
Get the value of the CTM.- Returns:
- The current transformation matrix.
-
setCurrentTransformationMatrix
Set the value of the CTM.- Parameters:
value
- The current transformation matrix.
-
getLineWidth
public float getLineWidth()Get the value of the line width.- Returns:
- The current line width.
-
setLineWidth
public void setLineWidth(float value) set the value of the line width.- Parameters:
value
- The current line width.
-
getLineCap
public int getLineCap()Get the value of the line cap.- Returns:
- The current line cap.
-
setLineCap
public void setLineCap(int value) set the value of the line cap.- Parameters:
value
- The current line cap.
-
getLineJoin
public int getLineJoin()Get the value of the line join.- Returns:
- The current line join value.
-
setLineJoin
public void setLineJoin(int value) Get the value of the line join.- Parameters:
value
- The current line join
-
getMiterLimit
public float getMiterLimit()Get the value of the miter limit.- Returns:
- The current miter limit.
-
setMiterLimit
public void setMiterLimit(float value) set the value of the miter limit.- Parameters:
value
- The current miter limit.
-
isStrokeAdjustment
public boolean isStrokeAdjustment()Get the value of the stroke adjustment parameter.- Returns:
- The current stroke adjustment.
-
setStrokeAdjustment
public void setStrokeAdjustment(boolean value) set the value of the stroke adjustment.- Parameters:
value
- The value of the stroke adjustment parameter.
-
getAlphaConstant
public double getAlphaConstant()Get the value of the stroke alpha constant property.- Returns:
- The value of the stroke alpha constant parameter.
-
setAlphaConstant
public void setAlphaConstant(double value) set the value of the stroke alpha constant property.- Parameters:
value
- The value of the stroke alpha constant parameter.
-
getNonStrokeAlphaConstants
Deprecated.Get the value of the non-stroke alpha constant property.- Returns:
- The value of the non-stroke alpha constant parameter.
-
setNonStrokeAlphaConstants
Deprecated.set the value of the non-stroke alpha constant property.- Parameters:
value
- The value of the non-stroke alpha constant parameter.
-
getNonStrokeAlphaConstant
public double getNonStrokeAlphaConstant()Get the value of the non-stroke alpha constant property.- Returns:
- The value of the non-stroke alpha constant parameter.
-
setNonStrokeAlphaConstant
public void setNonStrokeAlphaConstant(double value) set the value of the non-stroke alpha constant property.- Parameters:
value
- The value of the non-stroke alpha constant parameter.
-
isAlphaSource
public boolean isAlphaSource()get the value of the stroke alpha source property.- Returns:
- The value of the stroke alpha source parameter.
-
setAlphaSource
public void setAlphaSource(boolean value) set the value of the alpha source property.- Parameters:
value
- The value of the alpha source parameter.
-
getSoftMask
returns the current softmask- Returns:
- softMask
-
setSoftMask
Sets the current soft mask- Parameters:
softMask
-
-
getBlendMode
Returns the current blend mode- Returns:
- the current blend mode
-
setBlendMode
Sets the blend mode in the current graphics state- Parameters:
blendMode
-
-
isOverprint
public boolean isOverprint()get the value of the overprint property.- Returns:
- The value of the overprint parameter.
-
setOverprint
public void setOverprint(boolean value) set the value of the overprint property.- Parameters:
value
- The value of the overprint parameter.
-
isNonStrokingOverprint
public boolean isNonStrokingOverprint()get the value of the non stroking overprint property.- Returns:
- The value of the non stroking overprint parameter.
-
setNonStrokingOverprint
public void setNonStrokingOverprint(boolean value) set the value of the non stroking overprint property.- Parameters:
value
- The value of the non stroking overprint parameter.
-
getOverprintMode
public double getOverprintMode()get the value of the overprint mode property.- Returns:
- The value of the overprint mode parameter.
-
setOverprintMode
public void setOverprintMode(double value) set the value of the overprint mode property.- Parameters:
value
- The value of the overprint mode parameter.
-
getFlatness
public double getFlatness()get the value of the flatness property.- Returns:
- The value of the flatness parameter.
-
setFlatness
public void setFlatness(double value) set the value of the flatness property.- Parameters:
value
- The value of the flatness parameter.
-
getSmoothness
public double getSmoothness()get the value of the smoothness property.- Returns:
- The value of the smoothness parameter.
-
setSmoothness
public void setSmoothness(double value) set the value of the smoothness property.- Parameters:
value
- The value of the smoothness parameter.
-
getTextState
This will get the graphics text state.- Returns:
- The graphics text state.
-
setTextState
This will set the graphics text state.- Parameters:
value
- The graphics text state.
-
getLineDashPattern
This will get the current line dash pattern.- Returns:
- The line dash pattern.
-
setLineDashPattern
This will set the current line dash pattern.- Parameters:
value
- The new line dash pattern.
-
getRenderingIntent
This will get the rendering intent.- Returns:
- The rendering intent
- See Also:
-
setRenderingIntent
This will set the rendering intent.- Parameters:
value
- The new rendering intent.
-
clone
-
getStrokingColor
Returns the stroking color.- Returns:
- stroking color
-
setStrokingColor
Sets the stroking color.- Parameters:
color
- The new stroking color
-
getNonStrokingColor
Returns the non-stroking color.- Returns:
- The non-stroking color
-
setNonStrokingColor
Sets the non-stroking color.- Parameters:
color
- The new non-stroking color
-
getStrokingColorSpace
Returns the stroking color space.- Returns:
- The stroking color space.
-
setStrokingColorSpace
Sets the stroking color space.- Parameters:
colorSpace
- The new stroking color space.
-
getNonStrokingColorSpace
Returns the non-stroking color space.- Returns:
- The non-stroking color space.
-
setNonStrokingColorSpace
Sets the non-stroking color space.- Parameters:
colorSpace
- The new non-stroking color space.
-
intersectClippingPath
Modify the current clipping path by intersecting it with the given path.- Parameters:
path
- path to intersect with the clipping path
-
intersectClippingPath
Modify the current clipping path by intersecting it with the given path.- Parameters:
area
- area to intersect with the clipping path
-
getCurrentClippingPath
This will get the current clipping path. Do not modify this Area object!- Returns:
- The current clipping path.
-
getCurrentClippingPaths
This will get the current clipping path, as one or more individual paths. Do not modify the list or the paths!- Returns:
- The current clipping paths.
-
getStrokingJavaComposite
-
getNonStrokingJavaComposite
-
getTransfer
This will get the transfer function.- Returns:
- The transfer function. According to the PDF specification, this is either a single function (which applies to all process colorants) or an array of four functions (which apply to the process colorants individually). The name Identity may be used to represent the identity function, and the name Default denotes the transfer function that was in effect at the start of the page.
-
setTransfer
This will set the transfer function.- Parameters:
transfer
- The transfer function. According to the PDF specification, this is either a single function (which applies to all process colorants) or an array of four functions (which apply to the process colorants individually). The name Identity may be used to represent the identity function, and the name Default denotes the transfer function that was in effect at the start of the page.
-
getNonStrokeAlphaConstant()