com.itextpdf.kernel.pdf.canvas.parser.data

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 Summary

Fields

Modifier and Type	Field and Description
static int	FILL Value specifying fill operation to perform on the current path.
static int	NO_OP End the path object without filling or stroking it.
static int	STROKE Value specifying stroke operation to perform on the current path.

Fields inherited from class com.itextpdf.kernel.pdf.canvas.parser.data.AbstractRenderInfo

gs

Constructor Summary

Constructors

Constructor and Description
PathRenderInfo(Stack<CanvasTag> canvasTagHierarchy, CanvasGraphicsState gs, Path path, int operation) If the operation is NO_OP then the rule is ignored, otherwise PdfCanvasConstants.FillingRule.NONZERO_WINDING is used by default.
PathRenderInfo(Stack<CanvasTag> canvasTagHierarchy, CanvasGraphicsState gs, Path path, int operation, int rule, boolean isClip, int clipRule)

Method Summary

Modifier and Type	Method and Description
List<CanvasTag>	getCanvasTagHierarchy() Gets hierarchy of the canvas tags that wraps given text.
int	getClippingRule()
Matrix	getCtm()
Color	getFillColor()
int	getLineCapStyle()
PdfArray	getLineDashPattern()
int	getLineJoinStyle()
float	getLineWidth()
int	getMcid() Gets the marked-content identifier associated with this PathRenderInfo instance
float	getMiterLimit()
int	getOperation()
Path	getPath()
int	getRule()
Color	getStrokeColor()
boolean	hasMcid(int mcid) Checks if the text belongs to a marked content sequence with a given mcid.
boolean	hasMcid(int mcid, boolean checkTheTopmostLevelOnly) Checks if the text belongs to a marked content sequence with a given mcid.
boolean	isPathModifiesClippingPath()

Methods inherited from class com.itextpdf.kernel.pdf.canvas.parser.data.AbstractRenderInfo

checkGraphicsState, getGraphicsState, isGraphicsStatePreserved, preserveGraphicsState, releaseGraphicsState

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

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:

Constant Field Values

STROKE

public static final int STROKE

Value specifying stroke operation to perform on the current path.

See Also:

Constant Field Values

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:

Constant Field Values

Constructor Detail

PathRenderInfo

public PathRenderInfo(Stack<CanvasTag> canvasTagHierarchy,
                      CanvasGraphicsState gs,
                      Path path,
                      int operation,
                      int rule,
                      boolean isClip,
                      int clipRule)

Parameters:

gs - The graphics state.

path - The path to be rendered.

operation - One of the possible combinations of STROKE and FILL values or NO_OP

rule - Either PdfCanvasConstants.FillingRule.NONZERO_WINDING or PdfCanvasConstants.FillingRule.EVEN_ODD.

isClip - True indicates that current path modifies the clipping path, false - if not.

clipRule - Either PdfCanvasConstants.FillingRule.NONZERO_WINDING or PdfCanvasConstants.FillingRule.EVEN_ODD.

PathRenderInfo

public PathRenderInfo(Stack<CanvasTag> canvasTagHierarchy,
                      CanvasGraphicsState gs,
                      Path path,
                      int operation)

If the operation is NO_OP then the rule is ignored, otherwise PdfCanvasConstants.FillingRule.NONZERO_WINDING is used by default. With this constructor path is considered as not modifying clipping path.

See PathRenderInfo(Stack, CanvasGraphicsState, Path, int, int, boolean, int)

Method Detail

getPath

public Path getPath()

Returns:

The Path to be rendered.

getOperation

public int getOperation()

Returns:

int value which is either NO_OP or one of possible combinations of STROKE and FILL

getRule

public int getRule()

Returns:

Either PdfCanvasConstants.FillingRule.NONZERO_WINDING or PdfCanvasConstants.FillingRule.EVEN_ODD.

isPathModifiesClippingPath

public boolean isPathModifiesClippingPath()

Returns:

true indicates that current path modifies the clipping path, false - if not.

getClippingRule

public int getClippingRule()

Returns:

Either PdfCanvasConstants.FillingRule.NONZERO_WINDING or PdfCanvasConstants.FillingRule.EVEN_ODD.

getCtm

public Matrix getCtm()

Returns:

Current transformation matrix.

getLineWidth

public float getLineWidth()

getLineCapStyle

public int getLineCapStyle()

getLineJoinStyle

public int getLineJoinStyle()

getMiterLimit

public float getMiterLimit()

getLineDashPattern

public PdfArray getLineDashPattern()

getStrokeColor

public Color getStrokeColor()

getFillColor

public Color getFillColor()

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 the text belongs to a marked content sequence with a given mcid.

Parameters:

mcid - a marked content id

Returns:

true if the text is marked with this id

hasMcid

public boolean hasMcid(int mcid,
                       boolean checkTheTopmostLevelOnly)

Checks if the text 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 the text is marked with this id