Apache PDFBox 3.0.4 · org.apache.pdfbox.pdmodel.graphics.state.PDGraphicsState

Modifier and Type	Field and Description
private double	alphaConstant
private boolean	alphaSource
private BlendMode	blendMode
private Area	clippingPathCache
private List<Path2D>	clippingPaths
private Matrix	currentTransformationMatrix
private double	flatness
private boolean	isClippingPathDirty
private int	lineCap
private PDLineDashPattern	lineDashPattern
private int	lineJoin
private float	lineWidth
private float	miterLimit
private double	nonStrokingAlphaConstant
private PDColor	nonStrokingColor
private PDColorSpace	nonStrokingColorSpace
private boolean	nonStrokingOverprint
private boolean	overprint
private int	overprintMode
private RenderingIntent	renderingIntent
private double	smoothness
private PDSoftMask	softMask
private boolean	strokeAdjustment
private PDColor	strokingColor
private PDColorSpace	strokingColorSpace
private Matrix	textLineMatrix
private Matrix	textMatrix
private PDTextState	textState
private COSBase	transfer

Access	Constructor and Description
public	PDGraphicsState(PDRectangle the size of the page page) Constructor with a given page size to initialize the clipping path.

Method Summary

Modifier and Type	Method and Description
public PDGraphicsState	clone() Overrides java.lang.Object.clone. Creates and returns a copy of this object.
public double	Returns: The value of the stroke alpha constant parameter. getAlphaConstant() Get the value of the stroke alpha constant property.
public BlendMode	Returns: the current blend mode getBlendMode() Returns the current blend mode
public Area	Returns: The current clipping path. getCurrentClippingPath() This will get the current clipping path.
public List<Path2D>	Returns: The current clipping paths. getCurrentClippingPaths() This will get the current clipping path, as one or more individual paths.
public Matrix	Returns: The current transformation matrix. getCurrentTransformationMatrix() Get the value of the CTM.
public double	Returns: The value of the flatness parameter. getFlatness() get the value of the flatness property.
public int	Returns: The current line cap. getLineCap() Get the value of the line cap.
public PDLineDashPattern	Returns: The line dash pattern. getLineDashPattern() This will get the current line dash pattern.
public int	Returns: The current line join value. getLineJoin() Get the value of the line join.
public float	Returns: The current line width. getLineWidth() Get the value of the line width.
public float	Returns: The current miter limit. getMiterLimit() Get the value of the miter limit.
public double	Returns: The value of the non-stroke alpha constant parameter. getNonStrokeAlphaConstant() Get the value of the non-stroke alpha constant property.
public PDColor	Returns: The non-stroking color getNonStrokingColor() Returns the non-stroking color.
public PDColorSpace	Returns: The non-stroking color space. getNonStrokingColorSpace() Returns the non-stroking color space.
public Composite	getNonStrokingJavaComposite()
public int	Returns: The value of the overprint mode parameter. getOverprintMode() get the value of the overprint mode property.
public RenderingIntent	Returns: The rendering intent getRenderingIntent() This will get the rendering intent.
public double	Returns: The value of the smoothness parameter. getSmoothness() get the value of the smoothness property.
public PDSoftMask	Returns: softMask getSoftMask() returns the current softmask
public PDColor	Returns: stroking color getStrokingColor() Returns the stroking color.
public PDColorSpace	Returns: The stroking color space. getStrokingColorSpace() Returns the stroking color space.
public Composite	getStrokingJavaComposite()
public Matrix	Returns: Returns the textLineMatrix. getTextLineMatrix()
public Matrix	Returns: Returns the textMatrix. getTextMatrix()
public PDTextState	Returns: The graphics text state. getTextState() This will get the graphics text state.
public COSBase	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. getTransfer() This will get the transfer function.
public void	intersectClippingPath(GeneralPath path to intersect with the clipping path path) Modify the current clipping path by intersecting it with the given path.
private void	intersectClippingPath(Path2D path, boolean clonePath)
public void	intersectClippingPath(Area area to intersect with the clipping path area) Modify the current clipping path by intersecting it with the given path.
public boolean	Returns: The value of the stroke alpha source parameter. isAlphaSource() get the value of the stroke alpha source property.
public boolean	Returns: The value of the non stroking overprint parameter. isNonStrokingOverprint() get the value of the non stroking overprint property.
public boolean	Returns: The value of the overprint parameter. isOverprint() get the value of the overprint property.
public boolean	Returns: The current stroke adjustment. isStrokeAdjustment() Get the value of the stroke adjustment parameter.
public void	setAlphaConstant(double The value of the stroke alpha constant parameter. value) set the value of the stroke alpha constant property.
public void	setAlphaSource(boolean The value of the alpha source parameter. value) set the value of the alpha source property.
public void	setBlendMode(BlendMode blend mode blendMode) Sets the blend mode in the current graphics state
public void	setCurrentTransformationMatrix(Matrix The current transformation matrix. value) Set the value of the CTM.
public void	setFlatness(double The value of the flatness parameter. value) set the value of the flatness property.
public void	setLineCap(int The current line cap. value) set the value of the line cap.
public void	setLineDashPattern(PDLineDashPattern The new line dash pattern. value) This will set the current line dash pattern.
public void	setLineJoin(int The current line join value) Get the value of the line join.
public void	setLineWidth(float The current line width. value) set the value of the line width.
public void	setMiterLimit(float The current miter limit. value) set the value of the miter limit.
public void	setNonStrokeAlphaConstant(double The value of the non-stroke alpha constant parameter. value) set the value of the non-stroke alpha constant property.
public void	setNonStrokingColor(PDColor The new non-stroking color color) Sets the non-stroking color.
public void	setNonStrokingColorSpace(PDColorSpace The new non-stroking color space. colorSpace) Sets the non-stroking color space.
public void	setNonStrokingOverprint(boolean The value of the non stroking overprint parameter. value) set the value of the non stroking overprint property.
public void	setOverprint(boolean The value of the overprint parameter. value) set the value of the overprint property.
public void	setOverprintMode(int The value of the overprint mode parameter. value) set the value of the overprint mode property.
public void	setRenderingIntent(RenderingIntent The new rendering intent. value) This will set the rendering intent.
public void	setSmoothness(double The value of the smoothness parameter. value) set the value of the smoothness property.
public void	setSoftMask(PDSoftMask soft mask softMask) Sets the current soft mask
public void	setStrokeAdjustment(boolean The value of the stroke adjustment parameter. value) set the value of the stroke adjustment.
public void	setStrokingColor(PDColor The new stroking color color) Sets the stroking color.
public void	setStrokingColorSpace(PDColorSpace The new stroking color space. colorSpace) Sets the stroking color space.
public void	setTextLineMatrix(Matrix The textLineMatrix to set. value)
public void	setTextMatrix(Matrix The textMatrix to set. value)
public void	setTextState(PDTextState The graphics text state. value) This will set the graphics text state.
public void	setTransfer(COSBase 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. transfer) This will set the transfer function.

Inherited from java.lang.Object:: equals finalize getClass hashCode notify notifyAll toString wait wait wait

alphaConstant	back to summary
private double alphaConstant

alphaSource	back to summary
private boolean alphaSource

blendMode	back to summary
private BlendMode blendMode

clippingPathCache	back to summary
private Area clippingPathCache

clippingPaths	back to summary
private List<Path2D> clippingPaths

currentTransformationMatrix	back to summary
private Matrix currentTransformationMatrix

flatness	back to summary
private double flatness

isClippingPathDirty	back to summary
private boolean isClippingPathDirty

lineCap	back to summary
private int lineCap

lineDashPattern	back to summary
private PDLineDashPattern lineDashPattern

lineJoin	back to summary
private int lineJoin

lineWidth	back to summary
private float lineWidth

miterLimit	back to summary
private float miterLimit

nonStrokingAlphaConstant	back to summary
private double nonStrokingAlphaConstant

nonStrokingColor	back to summary
private PDColor nonStrokingColor

nonStrokingColorSpace	back to summary
private PDColorSpace nonStrokingColorSpace

nonStrokingOverprint	back to summary
private boolean nonStrokingOverprint

overprint	back to summary
private boolean overprint

overprintMode	back to summary
private int overprintMode

renderingIntent	back to summary
private RenderingIntent renderingIntent

smoothness	back to summary
private double smoothness

softMask	back to summary
private PDSoftMask softMask

strokeAdjustment	back to summary
private boolean strokeAdjustment

strokingColor	back to summary
private PDColor strokingColor

strokingColorSpace	back to summary
private PDColorSpace strokingColorSpace

textLineMatrix	back to summary
private Matrix textLineMatrix

textMatrix	back to summary
private Matrix textMatrix

textState	back to summary
private PDTextState textState

transfer	back to summary
private COSBase transfer

PDGraphicsState	back to summary
public PDGraphicsState(PDRectangle page) Constructor with a given page size to initialize the clipping path. Parameters page:PDRectangle the size of the page

Method Detail

clone back to summary

clone	back to summary
public PDGraphicsState clone() Overrides java.lang.Object.clone. Doc from java.lang.Object.clone. Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object `x`, the expression: x.clone() != x will be true, and that the expression: x.clone().getClass() == x.getClass() will be `true`, but these are not absolute requirements. While it is typically the case that: x.clone().equals(x) will be `true`, this is not an absolute requirement. By convention, the returned object should be obtained by calling `super.clone`. If a class and all of its superclasses (except `Object`) obey this convention, it will be the case that `x.clone().getClass() == x.getClass()`. By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by `super.clone` before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by `super.clone` need to be modified. Returns:PDGraphicsState a clone of this instance. Annotations @Override

public PDGraphicsState clone()

Overrides java.lang.Object.clone.

Doc from java.lang.Object.clone.

Creates and returns a copy of this object. The precise meaning of "copy" may depend on the class of the object. The general intent is that, for any object x, the expression:

x.clone() != x

will be true, and that the expression:

x.clone().getClass() == x.getClass()

will be true, but these are not absolute requirements. While it is typically the case that:

x.clone().equals(x)

will be true, this is not an absolute requirement.

By convention, the returned object should be obtained by calling super.clone. If a class and all of its superclasses (except Object) obey this convention, it will be the case that x.clone().getClass() == x.getClass().

By convention, the object returned by this method should be independent of this object (which is being cloned). To achieve this independence, it may be necessary to modify one or more fields of the object returned by super.clone before returning it. Typically, this means copying any mutable objects that comprise the internal "deep structure" of the object being cloned and replacing the references to these objects with references to the copies. If a class contains only primitive fields or references to immutable objects, then it is usually the case that no fields in the object returned by super.clone need to be modified.

Returns:PDGraphicsState

a clone of this instance.

Annotations

@Override

getAlphaConstant	back to summary
public double getAlphaConstant() Get the value of the stroke alpha constant property. Returns:double The value of the stroke alpha constant parameter.

getAlphaConstant

public Class PDGraphicsState

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail