com.caverock.androidsvg

Class SVGExternalFileResolver

java.lang.Object

com.caverock.androidsvg.SVGExternalFileResolver

Direct Known Subclasses:

SimpleAssetResolver

public class SVGExternalFileResolver
extends Object

Resolver class used by the renderer when resolving font, image, and external CSS references.

When AndroidSVG encounters a reference to an external object, such as an image, it will call the associated method on this class in an attempt to load it.

The default behaviour of each method is to tell AndroidSVG that the reference could not be found. Extend this class and override the methods if you want to customise how AndroidSVG treats font, image, and external CSS references.

Example usage

 public class MyResolver {
    // Override the default method implementations with your own.
    // See the code for SimpleAssetResolver class, for examples of how to do that.
 }

 // Register your resolver with AndroidSVG
 SVG.registerExternalFileResolver(new MyResolver());

 // Your resolver will now be used when an SVG is parsed or rendered,
 SVG mySVG = SVG.getFromX();
 
 

Constructor Summary

Constructors

Constructor and Description
SVGExternalFileResolver()

Method Summary

Modifier and Type	Method and Description
boolean	isFormatSupported(String mimeType) Called by renderer to determine whether a particular format is supported.
String	resolveCSSStyleSheet(String url) Called by the parser to resolve CSS stylesheet file references in <?xml-stylesheet?> processing instructions.
Typeface	resolveFont(String fontFamily, int fontWeight, String fontStyle) Called by renderer to resolve font references in <text> elements.
Bitmap	resolveImage(String filename) Called by renderer to resolve image file references in <image> elements.

Methods inherited from class java.lang.Object

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

Constructor Detail

SVGExternalFileResolver

public SVGExternalFileResolver()

Method Detail

resolveFont

public Typeface resolveFont(String fontFamily,
                            int fontWeight,
                            String fontStyle)

Called by renderer to resolve font references in <text> elements.

An implementation of this method should return a Typeface instance, or null if you want the renderer to ignore this font request.

Note that AndroidSVG does not attempt to cache Typeface references. If you want them cached, for speed or memory reasons, you should do so yourself.

Parameters:

fontFamily - Font family as specified in a font-family style attribute.

fontWeight - Font weight as specified in a font-weight style attribute.

fontStyle - Font style as specified in a font-style style attribute.

Returns:

an Android Typeface instance, or null

resolveImage

public Bitmap resolveImage(String filename)

Called by renderer to resolve image file references in <image> elements.

An implementation of this method should return a Bitmap instance, or null if you want the renderer to ignore this image.

Note that AndroidSVG does not attempt to cache Bitmap references. If you want them cached, for speed or memory reasons, you should do so yourself.

Parameters:

filename - the filename as provided in the xlink:href attribute of a <image> element.

Returns:

an Android Bitmap object, or null if the image could not be found.

resolveCSSStyleSheet

public String resolveCSSStyleSheet(String url)

Called by the parser to resolve CSS stylesheet file references in <?xml-stylesheet?> processing instructions.

An implementation of this method should return a String whose contents correspond to the URL passed in.

Note that AndroidSVG does not attempt to cache stylesheet references. If you want them cached, for speed or memory reasons, you should do so yourself.

Parameters:

url - the URL of the CSS file as it appears in the SVG file.

Returns:

a AndroidSVG CSSStyleSheet object, or null if the stylesheet could not be found.

Since:

1.3

isFormatSupported

public boolean isFormatSupported(String mimeType)

Called by renderer to determine whether a particular format is supported. In particular, this method is used in <switch> elements when processing requiredFormats conditionals.

Parameters:

mimeType - A MIME type (such as "image/jpeg").

Returns:

true if your resolveImage() implementation supports this file format.