Package com.itextpdf.svg.processors.impl

Class SvgConverterProperties

java.lang.Object

com.itextpdf.svg.processors.impl.SvgConverterProperties

All Implemented Interfaces:

ISvgConverterProperties

public class SvgConverterProperties
extends java.lang.Object
implements ISvgConverterProperties

Default and fallback implementation of ISvgConverterProperties for DefaultSvgProcessor.

Field Summary

Fields

Modifier and Type	Field	Description
private AccessibilityProperties	accessibilityProperties
private java.lang.String	baseUri	The base URI.
private java.lang.String	charset
private CssStyleSheet	cssStyleSheet
private Rectangle	customViewport
private FontProvider	fontProvider	The font provider.
private MediaDeviceDescription	mediaDeviceDescription	The media device description.
private ISvgNodeRendererFactory	rendererFactory
private IResourceRetriever	resourceRetriever	The resource retriever.

Constructor Summary

Constructors

Constructor	Description
SvgConverterProperties()	Creates a new SvgConverterProperties instance.

Method Summary

Modifier and Type	Method	Description
AccessibilityProperties	getAccessibilityProperties()	Gets the accessibility properties.
java.lang.String	getBaseUri()	Gets the base URI.
java.lang.String	getCharset()	Get the name of the Charset to be used when decoding an InputStream.
CssStyleSheet	getCssStyleSheet()	Gets the CSS style sheet.
Rectangle	getCustomViewport()	Gets the custom viewport of SVG.
FontProvider	getFontProvider()	Gets the font provider.
MediaDeviceDescription	getMediaDeviceDescription()	Gets the media device description.
ISvgNodeRendererFactory	getRendererFactory()	Retrieve the factory responsible for creating ISvgNodeRenderer
IResourceRetriever	getResourceRetriever()	Gets the resource retriever.
SvgConverterProperties	setBaseUri(java.lang.String baseUri)	Sets the base URI.
SvgConverterProperties	setCharset(java.lang.String charset)	Sets the character set.
SvgConverterProperties	setCssStyleSheet(CssStyleSheet cssStyleSheet)	Sets the CSS style sheet.
void	setCustomViewport(Rectangle customViewport)	Sets the custom viewport of SVG.
SvgConverterProperties	setFontProvider(FontProvider fontProvider)	Sets font provider.
SvgConverterProperties	setMediaDeviceDescription(MediaDeviceDescription mediaDeviceDescription)	Sets the media device description.
SvgConverterProperties	setRendererFactory(ISvgNodeRendererFactory rendererFactory)	Sets renderer factory.
SvgConverterProperties	setResourceRetriever(IResourceRetriever resourceRetriever)	Sets the resource retriever.

Methods inherited from class java.lang.Object

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

Field Detail

mediaDeviceDescription

private MediaDeviceDescription mediaDeviceDescription

The media device description.

fontProvider

private FontProvider fontProvider

The font provider.

baseUri

private java.lang.String baseUri

The base URI.

resourceRetriever

private IResourceRetriever resourceRetriever

The resource retriever.

rendererFactory

private ISvgNodeRendererFactory rendererFactory

charset

private java.lang.String charset

cssStyleSheet

private CssStyleSheet cssStyleSheet

customViewport

private Rectangle customViewport

accessibilityProperties

private final AccessibilityProperties accessibilityProperties

Constructor Detail

SvgConverterProperties

public SvgConverterProperties()

Creates a new SvgConverterProperties instance. Instantiates its members, IResourceRetriever and ISvgNodeRendererFactory, to its default implementations.

Method Detail

getCustomViewport

public 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

getAccessibilityProperties

public AccessibilityProperties getAccessibilityProperties()

Gets the accessibility properties.

Returns:

the accessibility properties.

setCustomViewport

public void setCustomViewport(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

setRendererFactory

public SvgConverterProperties setRendererFactory(ISvgNodeRendererFactory rendererFactory)

Sets renderer factory.

Parameters:

rendererFactory - ISvgNodeRendererFactory to set

Returns:

this SvgConverterProperties instance

setFontProvider

public SvgConverterProperties setFontProvider(FontProvider fontProvider)

Sets font provider.

Parameters:

fontProvider - FontProvider to set

Returns:

this SvgConverterProperties instance

getRendererFactory

public ISvgNodeRendererFactory getRendererFactory()

Description copied from interface: ISvgConverterProperties

Retrieve the factory responsible for creating ISvgNodeRenderer

Specified by:

getRendererFactory in interface ISvgConverterProperties

Returns:

A ISvgNodeRendererFactory implementation

getCharset

public java.lang.String getCharset()

Description copied from interface: ISvgConverterProperties

Get the name of the Charset to be used when decoding an InputStream. This method is allowed to return null, in which case UTF-8 will be used (by JSoup).

Please be aware that this method is NOT used when handling a String variable in the SvgConverter.

Specified by:

getCharset in interface ISvgConverterProperties

Returns:

the String name of the Charset used for decoding

setCharset

public SvgConverterProperties setCharset(java.lang.String charset)

Sets the character set.

Parameters:

charset - the character set to set

Returns:

this SvgConverterProperties instance

getBaseUri

public java.lang.String getBaseUri()

Gets the base URI.

Specified by:

getBaseUri in interface ISvgConverterProperties

Returns:

the base URI

getFontProvider

public FontProvider getFontProvider()

Gets the font provider.

Specified by:

getFontProvider in interface ISvgConverterProperties

Returns:

the font provider

getMediaDeviceDescription

public MediaDeviceDescription getMediaDeviceDescription()

Gets the media device description.

Specified by:

getMediaDeviceDescription in interface ISvgConverterProperties

Returns:

the media device description

setMediaDeviceDescription

public SvgConverterProperties setMediaDeviceDescription(MediaDeviceDescription mediaDeviceDescription)

Sets the media device description.

Parameters:

mediaDeviceDescription - the media device description

Returns:

the ConverterProperties instance

setBaseUri

public SvgConverterProperties setBaseUri(java.lang.String baseUri)

Sets the base URI.

Parameters:

baseUri - the base URI

Returns:

the ConverterProperties instance

getResourceRetriever

public IResourceRetriever getResourceRetriever()

Description copied from interface: ISvgConverterProperties

Gets the resource retriever. The resourceRetriever is used to retrieve data from resources by URL.

Specified by:

getResourceRetriever in interface ISvgConverterProperties

Returns:

the resource retriever

setResourceRetriever

public SvgConverterProperties setResourceRetriever(IResourceRetriever resourceRetriever)

Sets the resource retriever. The resourceRetriever is used to retrieve data from resources by URL.

Parameters:

resourceRetriever - the resource retriever

Returns:

the SvgConverterProperties instance

getCssStyleSheet

public CssStyleSheet getCssStyleSheet()

Description copied from interface: ISvgConverterProperties

Gets the CSS style sheet. Style sheet is used to apply CSS statements to elements.

Specified by:

getCssStyleSheet in interface ISvgConverterProperties

Returns:

the CSS style sheet

setCssStyleSheet

public SvgConverterProperties setCssStyleSheet(CssStyleSheet cssStyleSheet)

Sets the CSS style sheet. Style sheet is used to apply CSS statements to elements.

Parameters:

cssStyleSheet - the CSS style sheet

Returns:

the SvgConverterProperties instance