Package VASSAL.tools.image.svg

Class SVGImageUtils

java.lang.Object

VASSAL.tools.image.svg.SVGImageUtils

public class SVGImageUtils
extends Object

Utility methods for manipulating SVG images.

Since:

3.1.0

Author:

Joel Uckelman

Method Summary

Modifier and Type	Method	Description
static org.w3c.dom.svg.SVGDocument	getDocument(String file, InputStream in)
static List<String>	getExternalReferences(String path)	Conducts a recursive depth-first search for external references in the given SVG file.
protected static List<String>	getExternalReferences(String path, List<String> known)	Conducts a recursive depth-first search for external references in the SVG file named by path.
static Dimension	getImageSize(InputStream in)	Returns the default dimensions of the SVG image.
static Dimension	getImageSize(String file, InputStream in)	Returns the default dimensions of the SVG image.
static Dimension	getImageSize(org.w3c.dom.svg.SVGDocument doc)
protected static void	relativizeElement(Element e)
static byte[]	relativizeExternalReferences(String path)	Rewrites external references contained in SVG files.

Methods inherited from class java.lang.Object

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

Method Details

getDocument

public static org.w3c.dom.svg.SVGDocument getDocument(String file,
InputStream in)
                                               throws IOException

Throws:

IOException

getImageSize

public static Dimension getImageSize(String file,
InputStream in)
                              throws IOException

Returns the default dimensions of the SVG image. Closes the InputStream.

Returns:

the image dimensions

Throws:

IOException - if the image cannot be read

getImageSize

public static Dimension getImageSize(org.w3c.dom.svg.SVGDocument doc)
                              throws IOException

Throws:

IOException

getImageSize

public static Dimension getImageSize(InputStream in)
                              throws IOException

Returns the default dimensions of the SVG image.

Returns:

the image dimensions

Throws:

IOException - if the image cannot be read

getExternalReferences

public static List<String> getExternalReferences(String path)
                                          throws IOException

Conducts a recursive depth-first search for external references in the given SVG file.

Parameters:

path - the path of the file to check for external references

Throws:

IOException

getExternalReferences

protected static List<String> getExternalReferences(String path,
List<String> known)
                                             throws IOException

Conducts a recursive depth-first search for external references in the SVG file named by path. This is a helper function for getExternalReferences(java.lang.String).

Parameters:

path - the path of the file to check for external references

known - the list of references already found

Throws:

IOException

relativizeExternalReferences

public static byte[] relativizeExternalReferences(String path)
                                           throws IOException

Rewrites external references contained in SVG files.

Parameters:

path - the path of the file to be processed

Throws:

IOException

relativizeElement

protected static void relativizeElement(Element e)