Class PDGraphicsState
- java.lang.Object
-
- org.apache.pdfbox.pdmodel.graphics.PDGraphicsState
-
- All Implemented Interfaces:
java.lang.Cloneable
public class PDGraphicsState extends java.lang.Object implements java.lang.Cloneable
This class will hold the current state of the graphics parameters when executing a content stream.- Version:
- $Revision: 1.5 $
- Author:
- Ben Litchfield
-
-
Constructor Summary
Constructors Constructor Description PDGraphicsState()
Default constructor.PDGraphicsState(PDRectangle page)
Constructor with a given pagesize to initialize the clipping path.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
double
getAlphaConstants()
Get the value of the stroke alpha constants property.java.awt.Shape
getCurrentClippingPath()
This will get the current clipping path.Matrix
getCurrentTransformationMatrix()
Get the value of the CTM.double
getFlatness()
get the value of the flatness property.int
getLineCap()
Get the value of the line cap.PDLineDashPattern
getLineDashPattern()
This will get the current line dash pattern.int
getLineJoin()
Get the value of the line join.double
getLineWidth()
Get the value of the line width.double
getMiterLimit()
Get the value of the miter limit.double
getNonStrokeAlphaConstants()
Get the value of the non-stroke alpha constants property.java.awt.Composite
getNonStrokeJavaComposite()
PDColorState
getNonStrokingColor()
Returns the non-stroking color state.double
getOverprintMode()
get the value of the overprint mode property.java.lang.String
getRenderingIntent()
This will get the rendering intent.double
getSmoothness()
get the value of the smoothness property.java.awt.Composite
getStrokeJavaComposite()
PDColorState
getStrokingColor()
Returns the stroking color state.PDTextState
getTextState()
This will get the graphics text state.boolean
isAlphaSource()
get the value of the stroke alpha source property.boolean
isOverprint()
get the value of the overprint property.boolean
isStrokeAdjustment()
Get the value of the stroke adjustment parameter.void
setAlphaConstants(double value)
set the value of the stroke alpha constants property.void
setAlphaSource(boolean value)
set the value of the alpha source property.void
setCurrentClippingPath(java.awt.Shape pCurrentClippingPath)
This will set the current clipping path.void
setCurrentTransformationMatrix(Matrix value)
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
setLineDashPattern(PDLineDashPattern value)
This will set the current line dash pattern.void
setLineJoin(int value)
Get the value of the line join.void
setLineWidth(double value)
set the value of the line width.void
setMiterLimit(double value)
set the value of the miter limit.void
setNonStrokeAlphaConstants(double value)
set the value of the non-stroke alpha constants 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
setRenderingIntent(java.lang.String value)
This will set the rendering intent.void
setSmoothness(double value)
set the value of the smoothness property.void
setStrokeAdjustment(boolean value)
set the value of the stroke adjustment.void
setTextState(PDTextState value)
This will set the graphics text state.
-
-
-
Constructor Detail
-
PDGraphicsState
public PDGraphicsState()
Default constructor.
-
PDGraphicsState
public PDGraphicsState(PDRectangle page)
Constructor with a given pagesize to initialize the clipping path.- Parameters:
page
- the size of the page
-
-
Method Detail
-
getCurrentTransformationMatrix
public Matrix getCurrentTransformationMatrix()
Get the value of the CTM.- Returns:
- The current transformation matrix.
-
setCurrentTransformationMatrix
public void setCurrentTransformationMatrix(Matrix value)
Set the value of the CTM.- Parameters:
value
- The current transformation matrix.
-
getLineWidth
public double getLineWidth()
Get the value of the line width.- Returns:
- The current line width.
-
setLineWidth
public void setLineWidth(double 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 double getMiterLimit()
Get the value of the miter limit.- Returns:
- The current miter limit.
-
setMiterLimit
public void setMiterLimit(double 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.
-
getAlphaConstants
public double getAlphaConstants()
Get the value of the stroke alpha constants property.- Returns:
- The value of the stroke alpha constants parameter.
-
setAlphaConstants
public void setAlphaConstants(double value)
set the value of the stroke alpha constants property.- Parameters:
value
- The value of the stroke alpha constants parameter.
-
getNonStrokeAlphaConstants
public double getNonStrokeAlphaConstants()
Get the value of the non-stroke alpha constants property.- Returns:
- The value of the non-stroke alpha constants parameter.
-
setNonStrokeAlphaConstants
public void setNonStrokeAlphaConstants(double value)
set the value of the non-stroke alpha constants property.- Parameters:
value
- The value of the non-stroke alpha constants 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.
-
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.
-
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
public PDTextState getTextState()
This will get the graphics text state.- Returns:
- The graphics text state.
-
setTextState
public void setTextState(PDTextState value)
This will set the graphics text state.- Parameters:
value
- The graphics text state.
-
getLineDashPattern
public PDLineDashPattern getLineDashPattern()
This will get the current line dash pattern.- Returns:
- The line dash pattern.
-
setLineDashPattern
public void setLineDashPattern(PDLineDashPattern value)
This will set the current line dash pattern.- Parameters:
value
- The new line dash pattern.
-
getRenderingIntent
public java.lang.String getRenderingIntent()
This will get the rendering intent.- Returns:
- The rendering intent
- See Also:
PDExtendedGraphicsState
-
setRenderingIntent
public void setRenderingIntent(java.lang.String value)
This will set the rendering intent.- Parameters:
value
- The new rendering intent.
-
clone
public java.lang.Object clone()
- Overrides:
clone
in classjava.lang.Object
-
getStrokingColor
public PDColorState getStrokingColor()
Returns the stroking color state.- Returns:
- stroking color state
-
getNonStrokingColor
public PDColorState getNonStrokingColor()
Returns the non-stroking color state.- Returns:
- non-stroking color state
-
setCurrentClippingPath
public void setCurrentClippingPath(java.awt.Shape pCurrentClippingPath)
This will set the current clipping path.- Parameters:
pCurrentClippingPath
- The current clipping path.
-
getCurrentClippingPath
public java.awt.Shape getCurrentClippingPath()
This will get the current clipping path.- Returns:
- The current clipping path.
-
getStrokeJavaComposite
public java.awt.Composite getStrokeJavaComposite()
-
getNonStrokeJavaComposite
public java.awt.Composite getNonStrokeJavaComposite()
-
-