iText7 7.1.15  Overview   Package   Class  Text Changes  Statistics  Help 
Generated by
JDiff
PREV PACKAGE    NEXT PACKAGE          FRAMES    NO FRAMES  

com.itextpdf.svg.converter Documentation Differences

This file contains all the changes in documentation in the package com.itextpdf.svg.converter as colored differences. Deletions are shown like this , and additions are shown like this.
If no deletions or additions are shown in an entry, the HTML tags will be what has changed. The new HTML tags are shown in the differences. If no documentation existed, and then some was added in a later version, this change is noted in the appropriate class pages of differences, but the change is not shown on this page. Only changes in existing text are shown here. Similarly, documentation which was inherited from another class or interface is not shown here.
Note that an HTML error in the new documentation may cause the display of other documentation changes to be presented incorrectly. For instance, failure to close a tag will cause all subsequent paragraphs to be displayed differently.
Class SvgConverter, Image convertToImage(InputStream, PdfDocument)

Converts a String containing valid SVG content to an XObject that can then be used on the passed PdfDocument. This method does NOT manipulate the PdfDocument in any way.

This method (or its overloads) is the best method to use if you want to reuse the same SVG image multiple times on the same PdfDocument.

If you want to reuse this object on other PdfDocument instances, please either use any of the .process overloads in this same class and convert its result to an XObject with .convertToXObject(ISvgNodeRenderer, PdfDocument) , or look into using com.itextpdf.kernel.pdf.PdfObject.copyTo(PdfDocument). @param stream the Stream object containing valid SVG content @param document the PdfDocument instance to draw on @return a Image containing the PDF instructions instructions corresponding to the passed SVG content @throws IOException when the Stream cannot be read correctly

Class SvgConverter, Image convertToImage(InputStream, PdfDocument, ISvgConverterProperties)

Converts a String containing valid SVG content to an image that can then be used on the passed PdfDocument. This method does NOT manipulate the PdfDocument in any way.

This method (or its overloads) is the best method to use if you want to reuse the same SVG image multiple times on the same PdfDocument.

If you want to reuse this object on other PdfDocument instances, please either use any of the .process overloads in this same class and convert its result to an XObject with .convertToXObject(ISvgNodeRenderer, PdfDocument) , or look into using com.itextpdf.kernel.pdf.PdfObject.copyTo(PdfDocument). @param stream the Stream object containing valid SVG content @param document the PdfDocument instance to draw on @param props ISvgConverterProperties an instance for extra properties to customize the behavior @return a Image containing the PDF instructions instructions corresponding to the passed SVG content @throws IOException when the Stream cannot be read correctly

Class SvgConverter, PdfFormXObject convertToXObject(ISvgNodeRenderer, PdfDocument)

This method draws a NodeRenderer tree to a canvas that is tied to the passed document.

This method (or its overloads) is the best method to use if you want to reuse the same SVG image multiple times on the same PdfDocument.

If you want to reuse this object on other PdfDocument instances, please either use any of the .process overloads in this same class and convert its result to an XObject with this method, or look into using com.itextpdf.kernel.pdf.PdfObject.copyTo(PdfDocument). @param topSvgRenderer the ISvgNodeRenderer instance that contains the renderer tree @param document the document that the returned XObject can be drawn on (on any given page coordinates) @return an XObjectcontaining the PDF instructions corresponding to the passed node renderer tree.

Class SvgConverter, PdfFormXObject convertToXObject(InputStream, PdfDocument)

Converts a String containing valid SVG content to an XObject that can then be used on the passed PdfDocument. This method does NOT manipulate the PdfDocument in any way.

This method (or its overloads) is the best method to use if you want to reuse the same SVG image multiple times on the same PdfDocument.

If you want to reuse this object on other PdfDocument instances, please either use any of the .process overloads in this same class and convert its result to an XObject with .convertToXObject(ISvgNodeRenderer, PdfDocument) , or look into using com.itextpdf.kernel.pdf.PdfObject.copyTo(PdfDocument). @param stream the Stream object containing valid SVG content @param document the PdfDocument instance to draw on @return a XObject containing the PDF instructions corresponding to the passed SVG content @throws IOException when the Stream cannot be read correctly

Class SvgConverter, PdfFormXObject convertToXObject(InputStream, PdfDocument, ISvgConverterProperties)

Converts a String containing valid SVG content to an XObject that can then be used on the passed PdfDocument. This method does NOT manipulate the PdfDocument in any way.

This method (or its overloads) is the best method to use if you want to reuse the same SVG image multiple times on the same PdfDocument.

If you want to reuse this object on other PdfDocument instances, please either use any of the .process overloads in this same class and convert its result to an XObject with .convertToXObject(ISvgNodeRenderer, PdfDocument) , or look into using com.itextpdf.kernel.pdf.PdfObject.copyTo(PdfDocument). @param stream the Stream object containing valid SVG content @param document the PdfDocument instance to draw on @param props ISvgConverterProperties an instance for extra properties to customize the behavior @return a XObject containing the PDF instructions corresponding to the passed SVG content @throws IOException when the Stream stream cannot be read correctly

Class SvgConverter, PdfFormXObject convertToXObject(String, PdfDocument)

Converts a String containing valid SVG content to an XObject that can then be used on the passed PdfDocument. This method does NOT manipulate the PdfDocument in any way.

This method (or its overloads) is the best method to use if you want to reuse the same SVG image multiple times on the same PdfDocument.

If you want to reuse this object on other PdfDocument instances, please either use any of the .process overloads in this same class and convert its result to an XObject with .convertToXObject(ISvgNodeRenderer, PdfDocument) , or look into using com.itextpdf.kernel.pdf.PdfObject.copyTo(PdfDocument). @param content the String value containing valid SVG content @param document the PdfDocument instance to draw on @return a XObject containing the PDF instructions corresponding to the passed SVG content

Class SvgConverter, PdfFormXObject convertToXObject(String, PdfDocument, ISvgConverterProperties)

Converts a String containing valid SVG content to an XObject that can then be used on the passed PdfDocument. This method does NOT manipulate the PdfDocument in any way.

This method (or its overloads) is the best method to use if you want to reuse the same SVG image multiple times on the same PdfDocument.

If you want to reuse this object on other PdfDocument instances, please either use any of the .process overloads in this same class and convert its result to an XObject with .convertToXObject(ISvgNodeRenderer, PdfDocument) , or look into using com.itextpdf.kernel.pdf.PdfObject.copyTo(PdfDocument). @param content the String value containing valid SVG content @param document the PdfDocument instance to draw on @param props ISvgConverterProperties an instance for extra properties to customize the behavior @return a XObject containing the PDF instructions corresponding to the passed SVG content

Class SvgConverter, void createPdf(File, File, ISvgConverterProperties)

Converts SVG stored in a File to a PDF File, using specific ISvgConverterProperties. @param svgFile the File containing the source SVG @param pdfFile the File containing the resulting PDF @param props a ISvgConverterProperties instance an instance for extra properties to customize the behavior @throws IOException Signals that an I/O exception has occurred.
Class SvgConverter, void createPdf(File, File, ISvgConverterProperties, WriterProperties)

Converts SVG stored in a File to a PDF File, using specific ISvgConverterProperties and WriterProperties. @param svgFile the File containing the source SVG @param pdfFile the File containing the resulting PDF @param props a ISvgConverterProperties instance an instance for extra properties to customize the behavior @param writerProps a WriterProperties for the pdf document @throws IOException Signals that an I/O exception has occurred.
Class SvgConverter, void createPdf(InputStream, OutputStream, ISvgConverterProperties)

Create a single page pdf containing the SVG on its page using the default processing and drawing logic @param svgStream Stream containing the SVG @param pdfDest PDF destination outputStream @param props Svg ISvgConverterProperties an instance for extra properties to change default behaviour customize the behavior @throws IOException when the one of the streams cannot be read correctly
Class SvgConverter, void createPdf(InputStream, OutputStream, ISvgConverterProperties, WriterProperties)

Create a single page pdf containing the SVG on its page using the default processing and drawing logic @param svgStream Stream containing the SVG @param pdfDest PDF destination outputStream @param props ISvgConverterProperties to change default behaviour @param an pdfDest instance for extra properties to PDF destination outputStream customize the behavior @param writerProps WriterProperties for the pdf document @throws IOException when the one of the streams cannot be read correctly public static void createPdf(InputStream svgStream,ISvgConverterProperties props, OutputStream pdfDest) throws IOException { createPdf(svgStream,props,pdfDest,null); } /** Create a single page pdf containing the SVG on its page using the default processing and drawing logic @throws IOException when the one of the streams cannot be read correctly
Class SvgConverter, void createPdf(InputStream, OutputStream, WriterProperties)

Create a single page pdf containing the SVG on its page using the default processing and drawing logic @param svgStream Stream containing the SVG @param pdfDest PDF destination outputStream @param writerprops writerproperties writerProps writer properties for the pdf document @throws IOException when the one of the streams cannot be read correctly
Class SvgConverter, void drawOnDocument(InputStream, PdfDocument, int)

Draws a Stream containing valid SVG to a document, on a given page number ate the origni of the page. @param stream the Stream object containing valid SVG content @param document the PdfDocument instance to draw on @param pageNo the page to draw on @throws IOException when the Stream cannot be read correctly
Class SvgConverter, void drawOnDocument(InputStream, PdfDocument, int, ISvgConverterProperties)

Draws a Stream containing valid SVG to a document, on a given page number on the provided x and y coordinate. @param stream the Stream object containing valid SVG content @param document the PdfDocument instance to draw on @param pageNo the page to draw on @param props a container for extra properties that customize the behavior @throws IOException when the Stream cannot be read correctly
Class SvgConverter, void drawOnDocument(InputStream, PdfDocument, int, float, float)

Draws a Stream containing valid SVG to a document, on a given page number on the provided x and y coordinate. @param stream the Stream object containing valid SVG content @param document the PdfDocument instance to draw on @param pageNo the page to draw on @param x x-coordinate of the location to draw at @param y y-coordinate of the location to draw at @throws IOException when the Stream cannot be read correctly
Class SvgConverter, void drawOnDocument(InputStream, PdfDocument, int, float, float, ISvgConverterProperties)

Draws a Stream containing valid SVG to a document, on a given page number on the provided x and y coordinate. @param stream the Stream object containing valid SVG content @param document the PdfDocument instance to draw on @param pageNo the page to draw on @param x x-coordinate of the location to draw at @param y y-coordinate of the location to draw at @param props a container for extra properties that customize the behavior @throws IOException when the Stream cannot be read correctly
Class SvgConverter, void drawOnDocument(String, PdfDocument, int, ISvgConverterProperties)

Draws a String containing valid SVG to a document, on a given page number on the provided x and y coordinate. @param content the Stream object String value containing valid SVG content @param document the PdfDocument instance to draw on @param pageNo the page to draw on @param props a container for extra properties that customize the behavior
Class SvgConverter, void drawOnDocument(String, PdfDocument, int, float, float, ISvgConverterProperties)

Draws a String containing valid SVG to a document, on a given page number on the provided x and y coordinate. @param content the Stream object String value containing valid SVG content @param document the PdfDocument instance to draw on @param pageNo the page to draw on @param x x-coordinate of the location to draw at @param y y-coordinate of the location to draw at @param props a container for extra properties that customize the behavior
Class SvgConverter, INode parse(InputStream)

Parse a Stream containing valid SVG into an XML DOM node, using the default JSoup XML parser. This method will assume that the encoding of the Stream is {@code UTF-8}. @param stream the Stream object containing valid SVG content @return an XML DOM tree corresponding to the passed String input @throws IOException when the Stream cannot be read correctly
Class SvgConverter, INode parse(InputStream, ISvgConverterProperties)

Parse a Stream containing valid SVG into an XML DOM node, using the default JSoup XML parser. This method will assume that the encoding of the Stream is {@code UTF-8}, unless specified otherwise by the method ISvgConverterProperties.getCharset() of the {@code props} parameter. @param stream the Stream object containing valid SVG content @param props ISvgConverterProperties an instance for extra properties to customize the behavior @return an XML DOM tree corresponding to the passed String input @throws IOException when the Stream cannot be read correctly
Class SvgConverter, ISvgProcessorResult parseAndProcess(InputStream)

Parse and process an Inputstream containing an SVG, using the default Svg processor (DefaultSvgProcessor) The parsing of the stream is done using UTF-8 as the default charset. The properties used by the processor are the SvgConverterProperties @param svgStream Input stream Stream containing the SVG to parse and process @return ISvgProcessorResult containing the root renderer and metadata of the svg @throws IOException when the Stream cannot be read correctly
Class SvgConverter, ISvgProcessorResult parseAndProcess(InputStream, ISvgConverterProperties)

Parse and process an Inputstream containing an SVG, using the default Svg processor (DefaultSvgProcessor) @param svgStream Stream containing the SVG to parse and process @param props ISvgConverterProperties used an instance for extra properties to by customize the processor behavior @return ISvgProcessorResult containing the root renderer and metadata of the svg @throws IOException when the Stream cannot be read correctly
Class SvgConverter, ISvgProcessorResult process(INode, ISvgConverterProperties)

Use the default implementation of ISvgProcessor to convert an XML DOM tree to a node renderer tree. The passed properties can modify the default behaviour @param root the XML DOM tree @param props ISvgConverterProperties an instance for extra properties to customize the behavior @return a node renderer tree corresponding to the passed XML DOM tree