Package org.mapsforge.map.rendertheme

Class ZipRenderTheme

java.lang.Object

org.mapsforge.map.rendertheme.ZipRenderTheme

All Implemented Interfaces:

XmlRenderTheme

public class ZipRenderTheme
extends java.lang.Object
implements XmlRenderTheme

A ZipRenderTheme allows for customizing the rendering style of the map via an XML from an archive.

Field Summary

Fields

Modifier and Type	Field	Description
protected java.lang.String	xmlTheme

Constructor Summary

Constructors

Constructor	Description
ZipRenderTheme(java.lang.String xmlTheme, XmlThemeResourceProvider resourceProvider)
ZipRenderTheme(java.lang.String xmlTheme, XmlThemeResourceProvider resourceProvider, XmlRenderThemeMenuCallback menuCallback)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object obj)
XmlRenderThemeMenuCallback	getMenuCallback()
java.lang.String	getRelativePathPrefix()
java.io.InputStream	getRenderThemeAsStream()
XmlThemeResourceProvider	getResourceProvider()
int	hashCode()
void	setMenuCallback(XmlRenderThemeMenuCallback menuCallback)
void	setResourceProvider(XmlThemeResourceProvider resourceProvider)

Methods inherited from class java.lang.Object

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

Field Detail

xmlTheme

protected final java.lang.String xmlTheme

Constructor Detail

ZipRenderTheme

public ZipRenderTheme(java.lang.String xmlTheme,
                      XmlThemeResourceProvider resourceProvider)

Parameters:

xmlTheme - the XML theme path in the archive.

resourceProvider - the custom provider to retrieve resources internally referenced by "src" attribute (e.g. images, icons).

ZipRenderTheme

public ZipRenderTheme(java.lang.String xmlTheme,
                      XmlThemeResourceProvider resourceProvider,
                      XmlRenderThemeMenuCallback menuCallback)

Parameters:

xmlTheme - the XML theme path in the archive.

resourceProvider - the custom provider to retrieve resources internally referenced by "src" attribute (e.g. images, icons).

menuCallback - the interface callback to create a settings menu on the fly.

Method Detail

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

getMenuCallback

public XmlRenderThemeMenuCallback getMenuCallback()

Specified by:

getMenuCallback in interface XmlRenderTheme

Returns:

the interface callback to create a settings menu on the fly.

getRelativePathPrefix

public java.lang.String getRelativePathPrefix()

Specified by:

getRelativePathPrefix in interface XmlRenderTheme

Returns:

the prefix for all relative resource paths.

getRenderThemeAsStream

public java.io.InputStream getRenderThemeAsStream()
                                           throws java.io.IOException

Specified by:

getRenderThemeAsStream in interface XmlRenderTheme

Returns:

an InputStream to read the render theme data from.

Throws:

java.io.IOException - if the render theme file cannot be found.

getResourceProvider

public XmlThemeResourceProvider getResourceProvider()

Specified by:

getResourceProvider in interface XmlRenderTheme

Returns:

a custom provider to retrieve resources internally referenced by "src" attribute (e.g. images, icons).

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

setMenuCallback

public void setMenuCallback(XmlRenderThemeMenuCallback menuCallback)

Specified by:

setMenuCallback in interface XmlRenderTheme

Parameters:

menuCallback - the interface callback to create a settings menu on the fly.

setResourceProvider

public void setResourceProvider(XmlThemeResourceProvider resourceProvider)

Specified by:

setResourceProvider in interface XmlRenderTheme

Parameters:

resourceProvider - a custom provider to retrieve resources internally referenced by "src" attribute (e.g. images, icons).