Class SvgImage

java.lang.Object

com.itextpdf.commons.actions.sequence.AbstractIdentifiableElement

com.itextpdf.layout.ElementPropertyContainer<Image>

com.itextpdf.layout.element.AbstractElement<Image>

com.itextpdf.layout.element.Image

com.itextpdf.svg.element.SvgImage

All Implemented Interfaces:

IAbstractElement, IElement, ILeafElement, IPropertyContainer, IAccessibleElement

public class SvgImage
extends Image

A layout element that represents SVG image for inclusion in the document model.

Field Summary

Fields inherited from class Image

tagProperties, xObject

Fields inherited from class AbstractElement

childElements, nextRenderer, styles

Fields inherited from class ElementPropertyContainer

properties

Constructor Summary

Constructors

Constructor	Description
SvgImage(SvgImageXObject xObject)	Creates an SvgImage from the SvgImageXObject which represents Form XObject and contains processor result with the SVG information and resource resolver for the SVG image.

Method Summary

Modifier and Type	Method	Description
void	generate(PdfDocument document)	Deprecated. was replaced by getSvgImageXObject().generate(PdfDocument)
SvgImageXObject	getSvgImageXObject()	Gets the SvgImageXObject contained in this image object.
protected IRenderer	makeNewRenderer()	Creates a new renderer instance.

Methods inherited from class Image

getAccessibilityProperties, getImageHeight, getImageScaledHeight, getImageScaledWidth, getImageWidth, getMarginBottom, getMarginLeft, getMarginRight, getMarginTop, getObjectFit, getPaddingBottom, getPaddingLeft, getPaddingRight, getPaddingTop, getWidth, getXObject, scale, scaleAbsolute, scaleToFit, setAutoScale, setAutoScaleHeight, setAutoScaleWidth, setFixedPosition, setFixedPosition, setHeight, setHeight, setMarginBottom, setMarginLeft, setMarginRight, setMargins, setMarginTop, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setNeutralRole, setObjectFit, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddings, setPaddingTop, setRotationAngle, setWidth, setWidth

Methods inherited from class AbstractElement

addStyle, createRendererSubTree, getChildren, getProperty, getRenderer, hasProperty, isEmpty, setAction, setNextRenderer, setPageNumber

Methods inherited from class ElementPropertyContainer

deleteOwnProperty, getDefaultProperty, getOwnProperty, getSplitCharacters, getStrokeColor, getStrokeWidth, getTextRenderingMode, getTransparentStrokeColor, hasOwnProperty, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBackgroundColor, setBackgroundImage, setBackgroundImage, setBaseDirection, setBorder, setBorderBottom, setBorderBottomLeftRadius, setBorderBottomRightRadius, setBorderLeft, setBorderRadius, setBorderRight, setBorderTop, setBorderTopLeftRadius, setBorderTopRightRadius, setCharacterSpacing, setDashPattern, setDestination, setFixedPosition, setFixedPosition, setFixedPosition, setFixedPosition, setFont, setFontColor, setFontColor, setFontColor, setFontFamily, setFontFamily, setFontKerning, setFontScript, setFontSize, setHorizontalAlignment, setHyphenation, setLineThrough, setOpacity, setProperty, setRelativePosition, setSplitCharacters, setStrokeColor, setStrokeColor, setStrokeColor, setStrokeWidth, setTextAlignment, setTextRenderingMode, setUnderline, setUnderline, setUnderline, setUnderline, setUnderline, setWordSpacing, simulateBold, simulateItalic

Methods inherited from class Object

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

Methods inherited from interface IElement

createRendererSubTree, getRenderer, setNextRenderer

Methods inherited from interface IPropertyContainer

deleteOwnProperty, getDefaultProperty, getOwnProperty, getProperty, hasOwnProperty, hasProperty, setProperty

Constructor Details

SvgImage

public SvgImage(SvgImageXObject xObject)

Creates an SvgImage from the SvgImageXObject which represents Form XObject and contains processor result with the SVG information and resource resolver for the SVG image.

Parameters:

xObject - an internal SvgImageXObject.

Method Details

getSvgImageXObject

public SvgImageXObject getSvgImageXObject()

Gets the SvgImageXObject contained in this image object.

Returns:

a SvgImageXObject

generate

@Deprecated
public void generate(PdfDocument document)

Deprecated.

was replaced by getSvgImageXObject().generate(PdfDocument)

Draws SVG image to a canvas-like object maintained in the SvgDrawContext.

Parameters:

document - pdf that shall contain the SVG image.

makeNewRenderer

protected IRenderer makeNewRenderer()

Creates a new renderer instance.

Overrides:

makeNewRenderer in class Image

Returns:

new IRenderer