com.itextpdf.svg.renderers

Class SvgDrawContext

java.lang.Object

com.itextpdf.svg.renderers.SvgDrawContext

public class SvgDrawContext
extends Object

The SvgDrawContext keeps a stack of PdfCanvas instances, which represent all levels of XObjects that are added to the root canvas.

Constructor Summary

Constructors

Constructor and Description
SvgDrawContext(ResourceResolver resourceResolver, FontProvider fontProvider) Create an instance of the context that is used to store information when converting SVG.

Method Summary

Modifier and Type	Method and Description
void	addNamedObject(String name, ISvgNodeRenderer namedObject) Adds a named object to the draw context.
void	addNamedObjects(Map<String,ISvgNodeRenderer> namedObjects) * Adds a number of named object to the draw context.
void	addTextMove(float additionalMoveX, float additionalMoveY) Increment the stored text move.
void	addUsedId(String elementId) Adds an ID that has been referenced by a use element.
void	addViewPort(com.itextpdf.kernel.geom.Rectangle viewPort) Adds a viewbox to the context.
com.itextpdf.kernel.geom.AffineTransform	getClippingElementTransform() Gets clipping element transformation matrix.
com.itextpdf.kernel.geom.AffineTransform	getConcatenatedTransform() Concatenates all transformations applied from the top level of the svg to the current one.
SvgCssContext	getCssContext() Gets the SVG CSS context.
com.itextpdf.kernel.pdf.canvas.PdfCanvas	getCurrentCanvas() Retrieves the current top of the stack, without modifying the stack.
com.itextpdf.kernel.geom.AffineTransform	getCurrentCanvasTransform() Get the current canvas transformation.
com.itextpdf.kernel.geom.Rectangle	getCurrentViewPort() Get the current viewbox.
com.itextpdf.kernel.geom.Rectangle	getCustomViewport() Gets the custom viewport of SVG.
FontProvider	getFontProvider() Gets the FontProvider to be used during the drawing operations.
com.itextpdf.kernel.geom.AffineTransform	getLastTextTransform() Deprecated. in favour of getRootTransform()
ISvgNodeRenderer	getNamedObject(String name) Get a named object based on its name.
float[]	getPreviousElementTextMove() Deprecated. was replaced by getSvgTextProperties()
float[]	getRelativePosition() Retrieves relative position for the current text SVG element relative to the last origin identified by absolute position.
ResourceResolver	getResourceResolver() Gets the ResourceResolver to be used during the drawing operations.
com.itextpdf.kernel.geom.AffineTransform	getRootTransform() Get the current root transformation that was last applied.
com.itextpdf.kernel.geom.Rectangle	getRootViewPort() Get the viewbox which is the root viewport for the current document.
SvgTextProperties	getSvgTextProperties() Retrieves SvgTextProperties for text SVG elements.
FontSet	getTempFonts() Gets list of temporary fonts from @font-face.
float[]	getTextMove() Get the stored current text move.
boolean	isIdUsedByUseTagBefore(String elementId) Returns true when this id has been used before
void	moveRelativePosition(float dx, float dy) Adds move to the current relative position for the text SVG element.
com.itextpdf.kernel.pdf.canvas.PdfCanvas	popCanvas() Retrieves the current top of the stack, thereby taking the current item off the stack.
void	popPatternId() Pops the last template id from the stack.
void	pushCanvas(com.itextpdf.kernel.pdf.canvas.PdfCanvas canvas) Adds a PdfCanvas to the stack (by definition its top), for use in drawing operations.
boolean	pushPatternId(String patternId) Add pattern id to stack.
void	removeCurrentViewPort() Remove the currently set view box.
void	removeUsedId(String elementId) Removes an ID that has been referenced by a use element.
void	resetClippingElementTransform() Resets clipping element transformation matrix.
void	resetRelativePosition() Resets current relative position for the text SVG element.
void	resetTextMove() Reset the stored text move to [0f,0f]
void	setCssContext(SvgCssContext cssContext) Sets the SVG CSS context.
void	setCustomViewport(com.itextpdf.kernel.geom.Rectangle customViewport) Sets the custom viewport of SVG.
void	setLastTextTransform(com.itextpdf.kernel.geom.AffineTransform newTransform) Deprecated. in favour of setRootTransform(AffineTransform)
void	setPreviousElementTextMove(float[] previousElementTextMove) Deprecated. was replaced by setSvgTextProperties(SvgTextProperties)
void	setRootTransform(com.itextpdf.kernel.geom.AffineTransform newTransform) Set the current root transformation.
void	setSvgTextProperties(SvgTextProperties textProperties) Sets SvgTextProperties for textSVG elements.
void	setTempFonts(FontSet tempFonts) Sets the FontSet.
int	size() Get the current size of the stack, signifying the nesting level of the XObjects.

Methods inherited from class java.lang.Object

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

Constructor Detail

SvgDrawContext

public SvgDrawContext(ResourceResolver resourceResolver,
                      FontProvider fontProvider)

Create an instance of the context that is used to store information when converting SVG.

Parameters:

resourceResolver - instance of ResourceResolver

fontProvider - instance of FontProvider

Method Detail

getCustomViewport

public com.itextpdf.kernel.geom.Rectangle getCustomViewport()

Gets the custom viewport of SVG.

The custom viewport is used to resolve percent values of the top level svg.

Returns:

the custom viewport

setCustomViewport

public void setCustomViewport(com.itextpdf.kernel.geom.Rectangle customViewport)

Sets the custom viewport of SVG.

The custom viewport is used to resolve percent values of the top level svg.

Parameters:

customViewport - the custom viewport

getCurrentCanvas

public com.itextpdf.kernel.pdf.canvas.PdfCanvas getCurrentCanvas()

Retrieves the current top of the stack, without modifying the stack.

Returns:

the current canvas that can be used for drawing operations.

popCanvas

public com.itextpdf.kernel.pdf.canvas.PdfCanvas popCanvas()

Retrieves the current top of the stack, thereby taking the current item off the stack.

Returns:

the current canvas that can be used for drawing operations.

pushCanvas

public void pushCanvas(com.itextpdf.kernel.pdf.canvas.PdfCanvas canvas)

Adds a PdfCanvas to the stack (by definition its top), for use in drawing operations.

Parameters:

canvas - the new top of the stack

size

public int size()

Get the current size of the stack, signifying the nesting level of the XObjects.

Returns:

the current size of the stack.

addViewPort

public void addViewPort(com.itextpdf.kernel.geom.Rectangle viewPort)

Adds a viewbox to the context.

Parameters:

viewPort - rectangle representing the current viewbox

getCurrentViewPort

public com.itextpdf.kernel.geom.Rectangle getCurrentViewPort()

Get the current viewbox.

Returns:

the viewbox as it is currently set

getRootViewPort

public com.itextpdf.kernel.geom.Rectangle getRootViewPort()

Get the viewbox which is the root viewport for the current document.

Returns:

root viewbox.

removeCurrentViewPort

public void removeCurrentViewPort()

Remove the currently set view box.

addNamedObject

public void addNamedObject(String name,
                           ISvgNodeRenderer namedObject)

Adds a named object to the draw context. These objects can then be referenced from a different tag.

Parameters:

name - name of the object

namedObject - object to be referenced

getNamedObject

public ISvgNodeRenderer getNamedObject(String name)

Get a named object based on its name. If the name isn't listed, this method will return null.

Parameters:

name - name of the object you want to reference

Returns:

the referenced object

getResourceResolver

public ResourceResolver getResourceResolver()

Gets the ResourceResolver to be used during the drawing operations.

Returns:

resource resolver instance

addNamedObjects

public void addNamedObjects(Map<String,ISvgNodeRenderer> namedObjects)

* Adds a number of named object to the draw context. These objects can then be referenced from a different tag.

Parameters:

namedObjects - Map containing the named objects keyed to their ID strings

getFontProvider

public FontProvider getFontProvider()

Gets the FontProvider to be used during the drawing operations.

Returns:

font provider instance

getTempFonts

public FontSet getTempFonts()

Gets list of temporary fonts from @font-face.

Returns:

font set instance

setTempFonts

public void setTempFonts(FontSet tempFonts)

Sets the FontSet.

Parameters:

tempFonts - font set to be used during drawing operations

isIdUsedByUseTagBefore

public boolean isIdUsedByUseTagBefore(String elementId)

Returns true when this id has been used before

Parameters:

elementId - element id to check

Returns:

true if id has been encountered before through a use element

addUsedId

public void addUsedId(String elementId)

Adds an ID that has been referenced by a use element.

Parameters:

elementId - referenced element ID

removeUsedId

public void removeUsedId(String elementId)

Removes an ID that has been referenced by a use element.

Parameters:

elementId - referenced element ID

getLastTextTransform

@Deprecated
public com.itextpdf.kernel.geom.AffineTransform getLastTextTransform()

Deprecated. in favour of getRootTransform()

Get the text transformation that was last applied.

Returns:

AffineTransform representing the last text transformation

setLastTextTransform

@Deprecated
public void setLastTextTransform(com.itextpdf.kernel.geom.AffineTransform newTransform)

Deprecated. in favour of setRootTransform(AffineTransform)

Set the last text transformation.

Parameters:

newTransform - last text transformation

getRootTransform

public com.itextpdf.kernel.geom.AffineTransform getRootTransform()

Get the current root transformation that was last applied.

Returns:

AffineTransform representing the root transformation.

setRootTransform

public void setRootTransform(com.itextpdf.kernel.geom.AffineTransform newTransform)

Set the current root transformation.

Parameters:

newTransform - root transformation.

getTextMove

public float[] getTextMove()

Get the stored current text move.

Returns:

[horizontal text move, vertical text move]

resetTextMove

public void resetTextMove()

Reset the stored text move to [0f,0f]

addTextMove

public void addTextMove(float additionalMoveX,
                        float additionalMoveY)

Increment the stored text move.

Parameters:

additionalMoveX - horizontal value to add

additionalMoveY - vertical value to add

getCurrentCanvasTransform

public com.itextpdf.kernel.geom.AffineTransform getCurrentCanvasTransform()

Get the current canvas transformation.

Returns:

the AffineTransform representing the current canvas transformation

getCssContext

public SvgCssContext getCssContext()

Gets the SVG CSS context.

Returns:

the SVG CSS context

setCssContext

public void setCssContext(SvgCssContext cssContext)

Sets the SVG CSS context.

Parameters:

cssContext - the SVG CSS context

pushPatternId

public boolean pushPatternId(String patternId)

Add pattern id to stack. Check if the id is already in the stack. If it is, then return false and not add, if it is not - add and return true.

Parameters:

patternId - pattern id

Returns:

true if pattern id was not on the stack and was pushed; false if it is on the stack

popPatternId

public void popPatternId()

Pops the last template id from the stack.

setPreviousElementTextMove

@Deprecated
public void setPreviousElementTextMove(float[] previousElementTextMove)

Deprecated. was replaced by setSvgTextProperties(SvgTextProperties)

Sets a previous element text move.

Parameters:

previousElementTextMove - previous element text move

getPreviousElementTextMove

@Deprecated
public float[] getPreviousElementTextMove()

Deprecated. was replaced by getSvgTextProperties()

Gets a previous element text move.

Returns:

the previous element text move

getSvgTextProperties

public SvgTextProperties getSvgTextProperties()

Retrieves SvgTextProperties for text SVG elements.

Returns:

SvgTextProperties text properties

setSvgTextProperties

public void setSvgTextProperties(SvgTextProperties textProperties)

Sets SvgTextProperties for textSVG elements.

Parameters:

textProperties - SvgTextProperties to set

getRelativePosition

public float[] getRelativePosition()

Retrieves relative position for the current text SVG element relative to the last origin identified by absolute position.

Returns:

relative position for the current text SVG element

moveRelativePosition

public void moveRelativePosition(float dx,
                                 float dy)

Adds move to the current relative position for the text SVG element.

Parameters:

dx - x-axis movement

dy - y-axis movement

resetRelativePosition

public void resetRelativePosition()

Resets current relative position for the text SVG element.

getClippingElementTransform

public com.itextpdf.kernel.geom.AffineTransform getClippingElementTransform()

Gets clipping element transformation matrix.

It is used to preserve clipping element transformation matrix and before drawing clipped element revert canvas transformation matrix into original state. After clipped element will be drawn, clipping element transformation matrix will be used once again to return clipping element matrix for next siblings.

Returns:

the current clipping element transformation matrix

resetClippingElementTransform

public void resetClippingElementTransform()

Resets clipping element transformation matrix.

See getClippingElementTransform() for more info about clipping element transformation matrix.

getConcatenatedTransform

public com.itextpdf.kernel.geom.AffineTransform getConcatenatedTransform()

Concatenates all transformations applied from the top level of the svg to the current one.

Returns:

AffineTransform instance