iText 8.0.5 API
iText.Kernel.Pdf.Canvas.Parser.ParserGraphicsState Class Reference

Internal class which is essentially a iText.Kernel.Pdf.Canvas.CanvasGraphicsState which supports tracking of clipping path state and changes. More...

Inheritance diagram for iText.Kernel.Pdf.Canvas.Parser.ParserGraphicsState:
iText.Kernel.Pdf.Canvas.CanvasGraphicsState

Public Member Functions

override void  UpdateCtm (Matrix newCtm)
  Updates current transformation matrix. More...
 
virtual void  Clip (Path path, int fillingRule)
  Intersects the current clipping path with the given path. More...
 
virtual Path  GetClippingPath ()
  Getter for the current clipping path. More...
 
virtual void  SetClippingPath (Path clippingPath)
  Sets the current clipping path to the specified path. More...
 
- Public Member Functions inherited from iText.Kernel.Pdf.Canvas.CanvasGraphicsState
  CanvasGraphicsState (iText.Kernel.Pdf.Canvas.CanvasGraphicsState source)
  Copy constructor. More...
 
virtual void  UpdateFromExtGState (PdfDictionary extGState)
  Updates this object with the values from a dictionary. More...
 
virtual Matrix  GetCtm ()
 
Returns
current transformation matrix.

 
virtual void  UpdateCtm (float a, float b, float c, float d, float e, float f)
  Updates current transformation matrix. More...
 
virtual Color  GetFillColor ()
  Gets the current fill color. More...
 
virtual void  SetFillColor (Color fillColor)
  Sets the current fill color. More...
 
virtual Color  GetStrokeColor ()
  Gets the current stroke color. More...
 
virtual void  SetStrokeColor (Color strokeColor)
  Sets the current stroke color. More...
 
virtual float  GetLineWidth ()
  Gets the current line width. More...
 
virtual void  SetLineWidth (float lineWidth)
  Sets the current line width. More...
 
virtual int  GetLineCapStyle ()
  Gets the current line cap style, see ISO-320001, 8.4.3.3 Line Cap Style. More...
 
virtual void  SetLineCapStyle (int lineCapStyle)
  Sets the current line cap style, see ISO-320001, 8.4.3.3 Line Cap Style. More...
 
virtual int  GetLineJoinStyle ()
  Gets the current line join style, see ISO-320001, 8.4.3.4 Line Join Style. More...
 
virtual void  SetLineJoinStyle (int lineJoinStyle)
  Sets the current line join style, see ISO-320001, 8.4.3.4 Line Join Style. More...
 
virtual float  GetMiterLimit ()
  Gets the current miter limit, see ISO-320001, 8.4.3.5 Miter Limit. More...
 
virtual void  SetMiterLimit (float miterLimit)
  Sets the current miter limit, see ISO-320001, 8.4.3.5 Miter Limit. More...
 
virtual PdfArray  GetDashPattern ()
  Gets line dash pattern value, D key, see ISO-320001, 8.4.3.6 Line Dash Pattern, iText.Kernel.Pdf.Extgstate.PdfExtGState.SetDashPattern(iText.Kernel.Pdf.PdfArray). More...
 
virtual void  SetDashPattern (PdfArray dashPattern)
  Sets line dash pattern value, D key, see ISO-320001, 8.4.3.6 Line Dash Pattern, iText.Kernel.Pdf.Extgstate.PdfExtGState.SetDashPattern(iText.Kernel.Pdf.PdfArray). More...
 
virtual PdfName  GetRenderingIntent ()
  Gets the rendering intent, see iText.Kernel.Pdf.Extgstate.PdfExtGState.GetRenderingIntent(). More...
 
virtual void  SetRenderingIntent (PdfName renderingIntent)
  Sets the rendering intent, see iText.Kernel.Pdf.Extgstate.PdfExtGState.GetRenderingIntent(). More...
 
virtual float  GetFontSize ()
  Gets the font size. More...
 
virtual void  SetFontSize (float fontSize)
  Sets the font size. More...
 
virtual PdfFont  GetFont ()
  Gets the current iText.Kernel.Font.PdfFont. More...
 
virtual void  SetFont (PdfFont font)
  Sets the current iText.Kernel.Font.PdfFont. More...
 
virtual int  GetTextRenderingMode ()
  Gets the current Text Rendering Mode, see ISO-320001, 9.3.6 Text Rendering Mode, PdfCanvas.SetTextRenderingMode(int). More...
 
virtual void  SetTextRenderingMode (int textRenderingMode)
  Sets the current Text Rendering Mode, see ISO-320001, 9.3.6 Text Rendering Mode, PdfCanvas.SetTextRenderingMode(int). More...
 
virtual float  GetTextRise ()
  Get the current Text Rise, see ISO-320001, 9.3.7 Text Rise, PdfCanvas.SetTextRise(float). More...
 
virtual void  SetTextRise (float textRise)
  Set the current Text Rise, see ISO-320001, 9.3.7 Text Rise PdfCanvas.SetTextRise(float). More...
 
virtual float  GetFlatnessTolerance ()
  Gets the current Flatness Tolerance, see ISO-320001, 10.6.2 Flatness Tolerance, PdfCanvas.SetFlatnessTolerance(float). More...
 
virtual void  SetFlatnessTolerance (float flatnessTolerance)
  Sets the current Flatness Tolerance, see ISO-320001, 10.6.2 Flatness Tolerance, PdfCanvas.SetFlatnessTolerance(float). More...
 
virtual void  SetWordSpacing (float wordSpacing)
  Sets the Word Spacing, see ISO-320001, 9.3.3 Word Spacing, PdfCanvas.SetWordSpacing(float). More...
 
virtual float  GetWordSpacing ()
  Gets the current Word Spacing, see ISO-320001, 9.3.3 Word Spacing, PdfCanvas.SetWordSpacing(float) More...
 
virtual void  SetCharSpacing (float characterSpacing)
  Sets the Character Spacing, see ISO-320001, 9.3.2 Character Spacing, PdfCanvas.SetCharacterSpacing(float) More...
 
virtual float  GetCharSpacing ()
  Gets the current Character Spacing, see ISO-320001, 9.3.2 Character Spacing, PdfCanvas.SetCharacterSpacing(float). More...
 
virtual float  GetLeading ()
  Gets the current Leading, see ISO-320001, 9.3.5 Leading, PdfCanvas.SetLeading(float). More...
 
virtual void  SetLeading (float leading)
  Sets the Leading, see ISO-320001, 9.3.5 Leading, PdfCanvas.SetLeading(float). More...
 
virtual float  GetHorizontalScaling ()
  Gets the current Horizontal Scaling percentage, see ISO-320001, 9.3.4 Horizontal Scaling. More...
 
virtual void  SetHorizontalScaling (float scale)
  Sets the Horizontal Scaling percentage for text, see ISO-320001, 9.3.4 Horizontal Scaling, PdfCanvas.SetHorizontalScaling(float). More...
 
virtual bool  GetStrokeOverprint ()
  Get the Stroke Overprint flag, see ISO 32000-1, 8.6.7 Overprint Control and 11.7.4.5 Summary of Overprinting Behaviour, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetStrokeOverprintFlag(). More...
 
virtual bool  GetFillOverprint ()
  Get the Fill Overprint flag, see ISO 32000-1, 8.6.7 Overprint Control and 11.7.4.5 Summary of Overprinting Behaviour, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetFillOverprintFlag(). More...
 
virtual int  GetOverprintMode ()
  Get the Overprint Mode, see ISO 32000-1, 8.6.7 Overprint Control and 11.7.4.5 Summary of Overprinting Behaviour, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetOverprintMode(). More...
 
virtual PdfObject  GetBlackGenerationFunction ()
  Gets the current Black-generation function, see ISO32000-1, 11.7.5.3 Rendering Intent and Colour Conversions and Table 58 – Entries in a Graphics State Parameter Dictionary, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetBlackGenerationFunction(). More...
 
virtual PdfObject  GetBlackGenerationFunction2 ()
  Gets the current overruling Black-generation function, see ISO32000-1, 11.7.5.3 Rendering Intent and Colour Conversions and Table 58 – Entries in a Graphics State Parameter Dictionary, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetBlackGenerationFunction2(). More...
 
virtual PdfObject  GetUnderColorRemovalFunction ()
  Gets the current Undercolor-removal function, see ISO32000-1, 11.7.5.3 Rendering Intent and Colour Conversions and Table 58 – Entries in a Graphics State Parameter Dictionary iText.Kernel.Pdf.Extgstate.PdfExtGState.GetUndercolorRemovalFunction(). More...
 
virtual PdfObject  GetUnderColorRemovalFunction2 ()
  Gets the current overruling Undercolor-removal function, see ISO32000-1, 11.7.5.3 Rendering Intent and Colour Conversions and Table 58 – Entries in a Graphics State Parameter Dictionary, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetUndercolorRemovalFunction2(). More...
 
virtual PdfObject  GetTransferFunction ()
  Gets the current Transfer function, see ISO32000-1, 11.7.5.3 Rendering Intent and Colour Conversions and Table 58 – Entries in a Graphics State Parameter Dictionary, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetTransferFunction(). More...
 
virtual PdfObject  GetTransferFunction2 ()
  Gets the current overruling transer function, see ISO32000-1, 11.7.5.3 Rendering Intent and Colour Conversions and Table 58 – Entries in a Graphics State Parameter Dictionary, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetTransferFunction2(). More...
 
virtual PdfObject  GetHalftone ()
  Gets the current halftone , see ISO32000-1, 10.5 Halftones and Table 58 – Entries in a Graphics State Parameter Dictionary, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetHalftone(). More...
 
virtual ? float  GetSmoothnessTolerance ()
  Gets the current Smoothness Tolerance, see ISO32000-1, 10.6.3 Smoothness Tolerance and Table 58 – Entries in a Graphics State Parameter Dictionary, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetSmothnessTolerance(). More...
 
virtual bool  GetAutomaticStrokeAdjustment ()
  Gets the current Apply Automatic Stroke Adjustment flag, see ISO 32000-1, 10.6.5 Automatic Stroke Adjustment, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetAutomaticStrokeAdjustmentFlag(). More...
 
virtual PdfObject  GetBlendMode ()
  Gets the current Blend Mode, see ISO 32000-1, 11.3.5 Blend Mode and 11.6.3 Specifying Blending Colour Space and Blend Mode, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetBlendMode(). More...
 
virtual PdfObject  GetSoftMask ()
  Gets the current Soft Mask, see ISO 32000-1, 11.3.7.2 Source Shape and Opacity, 11.6.4.3 Mask Shape and Opacity and 11.6.5.2 Soft-Mask Dictionaries, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetSoftMask(). More...
 
virtual float  GetStrokeOpacity ()
  Gets the current Stroke Opacity value, see ISO 32000-1, 11.3.7.2 Source Shape and Opacity and 11.6.4.4 Constant Shape and Opacity, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetStrokeOpacity(). More...
 
virtual float  GetFillOpacity ()
  Gets the current Fill Opacity value, see ISO 32000-1, 11.3.7.2 Source Shape and Opacity and 11.6.4.4 Constant Shape and Opacity, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetFillOpacity(). More...
 
virtual bool  GetAlphaIsShape ()
  Gets the current Alpha is shape flag, see ISO 32000-1, 11.3.7.2 Source Shape and Opacity and 11.6.4.3 Mask Shape and Opacity, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetAlphaSourceFlag() More...
 
virtual bool  GetTextKnockout ()
  Gets the current Text Knockout flag, see ISO 32000-1, 9.3.8 Text Knockout, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetTextKnockoutFlag(). More...
 
virtual PdfObject  GetHTP ()
  Gets the current Halftone Phase, see Portable Document Format Reference Manual Version 1.2, 7.12 Extended graphics states and PostScript Language Reference Manual, Second Edition, 7.3.3, Halftone Phase. More...
 
virtual void  UpdateFromExtGState (PdfExtGState extGState)
  Updates current graphic state with values from extended graphic state dictionary. More...
 

Additional Inherited Members

- Package Functions inherited from iText.Kernel.Pdf.Canvas.CanvasGraphicsState
  CanvasGraphicsState ()
  Internal empty and default constructor. More...
 

Detailed Description

Internal class which is essentially a iText.Kernel.Pdf.Canvas.CanvasGraphicsState which supports tracking of clipping path state and changes.

Member Function Documentation

◆ Clip()

virtual void iText.Kernel.Pdf.Canvas.Parser.ParserGraphicsState.Clip ( Path  path,
int  fillingRule 
)
inlinevirtual

Intersects the current clipping path with the given path.

Intersects the current clipping path with the given path. Note: Coordinates of the given path should be in the transformed user space.

Parameters
path The path to be intersected with the current clipping path.
fillingRule The filling rule which should be applied to the given path. It should be either iText.Kernel.Pdf.Canvas.PdfCanvasConstants.FillingRule.EVEN_ODD or iText.Kernel.Pdf.Canvas.PdfCanvasConstants.FillingRule.NONZERO_WINDING

◆ GetClippingPath()

virtual Path iText.Kernel.Pdf.Canvas.Parser.ParserGraphicsState.GetClippingPath ( )
inlinevirtual

Getter for the current clipping path.

Getter for the current clipping path. Note: The returned clipping path is in the transformed user space, so if you want to get it in default user space, apply transformation matrix ( iText.Kernel.Pdf.Canvas.CanvasGraphicsState.GetCtm() ).

Returns
The current clipping path.

◆ SetClippingPath()

virtual void iText.Kernel.Pdf.Canvas.Parser.ParserGraphicsState.SetClippingPath ( Path  clippingPath )
inlinevirtual

Sets the current clipping path to the specified path.

Sets the current clipping path to the specified path. Note:This method doesn't modify existing clipping path, it simply replaces it with the new one instead.

Parameters
clippingPath New clipping path.

◆ UpdateCtm()

override void iText.Kernel.Pdf.Canvas.Parser.ParserGraphicsState.UpdateCtm ( Matrix  newCtm )
inlinevirtual

Updates current transformation matrix.

Parameters
newCtm new current transformation matrix.

Reimplemented from iText.Kernel.Pdf.Canvas.CanvasGraphicsState.