Class PathRenderInfo

java.lang.Object
com.itextpdf.kernel.pdf.canvas.parser.data.AbstractRenderInfo
com.itextpdf.kernel.pdf.canvas.parser.data.PathRenderInfo
All Implemented Interfaces:
IEventData
public class PathRenderInfo extends AbstractRenderInfo
Contains information relating to painting current path.

  • Field Details

    • NO_OP

      public static final int NO_OP
      End the path object without filling or stroking it. This operator shall be a path-painting no-op, used primarily for the side effect of changing the current clipping path
      See Also:

    • STROKE

      public static final int STROKE
      Value specifying stroke operation to perform on the current path.
      See Also:

    • FILL

      public static final int FILL
      Value specifying fill operation to perform on the current path. When the fill operation is performed it should use either nonzero winding or even-odd rule.
      See Also:

    • path

      private Path path

    • operation

      private int operation

    • rule

      private int rule

    • isClip

      private boolean isClip

    • clippingRule

      private int clippingRule

    • canvasTagHierarchy

      private List<CanvasTag> canvasTagHierarchy
      Hierarchy of nested canvas tags for the text from the most inner (nearest to text) tag to the most outer.

  • Constructor Details

  • Method Details

    • getPath

      public Path getPath()
      Gets the Path to be rendered
      Returns:
      the Path to be rendered

    • getOperation

      public int getOperation()
      Gets the int value which is either NO_OP or one of possible combinations of STROKE and FILL.
      Returns:
      the operation value

    • getRule

      public int getRule()
      Gets either PdfCanvasConstants.FillingRule.NONZERO_WINDING or PdfCanvasConstants.FillingRule.EVEN_ODD.
      Returns:
      the rule value

    • isPathModifiesClippingPath

      public boolean isPathModifiesClippingPath()
      Gets the clipping path flag.
      Returns:
      true indicates that current path modifies the clipping path

    • getClippingRule

      public int getClippingRule()
      Gets either PdfCanvasConstants.FillingRule.NONZERO_WINDING or PdfCanvasConstants.FillingRule.EVEN_ODD.
      Returns:
      the clipping rule value

    • getCtm

      public Matrix getCtm()
      Gets the current transformation matrix.
      Returns:
      the current transformation matrix

    • getLineWidth

      public float getLineWidth()
      Gets the path's line width.
      Returns:
      the path's line width

    • getLineCapStyle

      public int getLineCapStyle()
      Gets the line cap style. See PdfCanvasConstants.LineCapStyle.
      Returns:
      the line cap style value

    • getLineJoinStyle

      public int getLineJoinStyle()
      Gets the line join style. See PdfCanvasConstants.LineJoinStyle.
      Returns:
      the line join style value

    • getMiterLimit

      public float getMiterLimit()
      Gets the miter limit.
      Returns:
      the miter limit

    • getLineDashPattern

      public PdfArray getLineDashPattern()
      Gets the path's dash pattern.
      Returns:
      the path's dash pattern as a PdfArray

    • getStrokeColor

      public Color getStrokeColor()
      Gets the path's stroke color.
      Returns:
      the path's stroke color

    • getFillColor

      public Color getFillColor()
      Gets the path's fill color.
      Returns:
      the path's fill color

    • getCanvasTagHierarchy

      public List<CanvasTag> getCanvasTagHierarchy()
      Gets hierarchy of the canvas tags that wraps given text.
      Returns:
      list of the wrapping canvas tags. The first tag is the innermost (nearest to the text)

    • getMcid

      public int getMcid()
      Gets the marked-content identifier associated with this PathRenderInfo instance
      Returns:
      associated marked-content identifier or -1 in case content is unmarked

    • hasMcid

      public boolean hasMcid(int mcid)
      Checks if this PathRenderInfo instance belongs to a marked content sequence with a given mcid.
      Parameters:
      mcid - a marked content id
      Returns:
      true if this PathRenderInfo instance is marked with this id, false otherwise

    • hasMcid

      public boolean hasMcid(int mcid, boolean checkTheTopmostLevelOnly)
      Checks if this PathRenderInfo instance belongs to a marked content sequence with a given mcid.
      Parameters:
      mcid - a marked content id
      checkTheTopmostLevelOnly - indicates whether to check the topmost level of marked content stack only
      Returns:
      true if this PathRenderInfo instance is marked with this id, false otherwise