Class SvgImageRenderer

java.lang.Object

com.itextpdf.layout.renderer.AbstractRenderer

com.itextpdf.layout.renderer.ImageRenderer

com.itextpdf.svg.renderers.SvgImageRenderer

All Implemented Interfaces:

IPropertyContainer, ILeafElementRenderer, IRenderer

public class SvgImageRenderer
extends ImageRenderer

Represents a renderer for the SvgImage layout element.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	SvgImageRenderer.Area
private static class	SvgImageRenderer.NullableArea

Field Summary

Fields inherited from class ImageRenderer

deltaX, fixedXPosition, fixedYPosition, imageHeight, imageWidth, pivotY

Fields inherited from class AbstractRenderer

childRenderers, EPS, flushed, INF, isLastRendererForModelElement, modelElement, occupiedArea, OVERLAP_EPSILON, parent, positionedRenderers, properties

Constructor Summary

Constructors

Constructor	Description
SvgImageRenderer(SvgImage image)	Creates an SvgImageRenderer from its corresponding layout object.

Method Summary

Modifier and Type	Method	Description
private void	calculateRelativeSizedSvgSize(SvgImage svgImage, Rectangle layoutBox)
void	draw(DrawContext drawContext)	Flushes the renderer subtree contents, i.e.
private SvgImageRenderer.Area	initMissingMetricsAndApplyAspectRatio(Float aspectRatio, SvgImageRenderer.NullableArea retrievedArea, SvgImageRenderer.Area area, UnitValue xObjectWidth, UnitValue xObjectHeight)
LayoutResult	layout(LayoutContext layoutContext)	This method simulates positioning of the renderer, including all of its children, and returns the LayoutResult, representing the layout result, including occupied area, status, i.e.
private static boolean	tryToApplyAspectRatio(SvgImageRenderer.NullableArea retrievedArea, SvgImageRenderer.Area inputArea, SvgImageRenderer.Area resultArea, Float aspectRatio)

Methods inherited from class ImageRenderer

applyPaddings, autoScale, getAscent, getBorderAreaBBox, getDescent, getImageHeight, getImageWidth, getMinMaxWidth, getNextRenderer, move

Methods inherited from class AbstractRenderer

addAllProperties, addChild, alignChildHorizontally, allowLastYLineRecursiveExtraction, applyAbsolutePosition, applyAction, applyBorderBox, applyBorderBox, applyDestination, applyDestinationsAndAnnotation, applyLinkAnnotation, applyMargins, applyMargins, applyPaddings, applyRelativePositioningTranslation, beginElementOpacityApplying, beginTransformationIfApplied, calculateAbsolutePdfBBox, calculateBBox, calculateShiftToPositionBBoxOfPointsAt, clipBackgroundArea, clipBackgroundArea, clipBorderArea, createXObject, deleteOwnProperty, deleteProperty, drawBackground, drawBorder, drawChildren, endElementOpacityApplying, endTransformationIfApplied, getBackgroundArea, getBorderRadii, getBorders, getChildRenderers, getDefaultProperty, getFirstYLineRecursively, getInnerAreaBBox, getLastYLineRecursively, getMargins, getMinMaxWidth, getModelElement, getOccupiedArea, getOccupiedAreaBBox, getOwnProperties, getOwnProperty, getPaddings, getParent, getProperty, getProperty, getPropertyAsBoolean, getPropertyAsColor, getPropertyAsFloat, getPropertyAsFloat, getPropertyAsFont, getPropertyAsInteger, getPropertyAsTransparentColor, getPropertyAsUnitValue, hasAbsoluteUnitValue, hasOwnOrModelProperty, hasOwnProperty, hasProperty, hasRelativeUnitValue, initElementAreas, isAbsolutePosition, isBorderBoxSizing, isFirstOnRootArea, isFixedLayout, isFlushed, isKeepTogether, isNotFittingHeight, isNotFittingLayoutArea, isNotFittingWidth, isOverflowFit, isOverflowProperty, isOverflowProperty, isOverflowProperty, isPositioned, isRelativePosition, isStaticLayout, rectangleToPointsList, retrieveHeight, retrieveMaxHeight, retrieveMaxWidth, retrieveMinHeight, retrieveMinWidth, retrieveResolvedDeclaredHeight, retrieveUnitValue, retrieveUnitValue, retrieveWidth, setBorders, setMinMaxWidthBasedOnFixedWidth, setParent, setProperty, toString, transformPoints, updateHeight, updateHeightsOnSplit, updateMaxHeight, updateMinHeight, updateWidth

Methods inherited from class Object

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

Methods inherited from interface IPropertyContainer

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

Methods inherited from interface IRenderer

addChild, getChildRenderers, getModelElement, getOccupiedArea, getParent, getProperty, isFlushed, setParent

Constructor Details

SvgImageRenderer

public SvgImageRenderer(SvgImage image)

Creates an SvgImageRenderer from its corresponding layout object.

Parameters:

image - the SvgImage which this object should manage

Method Details

layout

public LayoutResult layout(LayoutContext layoutContext)

Description copied from interface: IRenderer

This method simulates positioning of the renderer, including all of its children, and returns the LayoutResult, representing the layout result, including occupied area, status, i.e. if there was enough place to fit the renderer subtree, etc. LayoutResult can be extended to return custom layout results for custom elements, e.g. TextRenderer uses TextLayoutResult as its result. This method can be called standalone to learn how much area the renderer subtree needs, or can be called before IRenderer.draw(DrawContext), to prepare the renderer to be flushed to the output stream.

Specified by:

layout in interface IRenderer

Overrides:

layout in class ImageRenderer

Parameters:

layoutContext - the description of layout area and any other additional information

Returns:

result of the layout process

draw

public void draw(DrawContext drawContext)

Flushes the renderer subtree contents, i.e. draws itself on canvas, adds necessary objects to the PdfDocument etc.

Specified by:

draw in interface IRenderer

Overrides:

draw in class ImageRenderer

Parameters:

drawContext - contains the PdfDocument to which the renderer subtree if flushed, the PdfCanvas on which the renderer subtree is drawn and other additional parameters needed to perform drawing

calculateRelativeSizedSvgSize

private void calculateRelativeSizedSvgSize(SvgImage svgImage,
 Rectangle layoutBox)

initMissingMetricsAndApplyAspectRatio

private SvgImageRenderer.Area initMissingMetricsAndApplyAspectRatio(Float aspectRatio,
 SvgImageRenderer.NullableArea retrievedArea,
 SvgImageRenderer.Area area,
 UnitValue xObjectWidth,
 UnitValue xObjectHeight)

tryToApplyAspectRatio

private static boolean tryToApplyAspectRatio(SvgImageRenderer.NullableArea retrievedArea,
 SvgImageRenderer.Area inputArea,
 SvgImageRenderer.Area resultArea,
 Float aspectRatio)