Package org.mapsforge.map.rendertheme

Class ExternalRenderTheme

java.lang.Object

org.mapsforge.map.rendertheme.ExternalRenderTheme

All Implemented Interfaces:

XmlRenderTheme

public class ExternalRenderTheme
extends java.lang.Object
implements XmlRenderTheme

An ExternalRenderTheme allows for customizing the rendering style of the map via an XML file.

Constructor Summary

Constructors

Constructor	Description
ExternalRenderTheme(java.io.File renderThemeFile)
ExternalRenderTheme(java.io.File renderThemeFile, XmlRenderThemeMenuCallback menuCallback)
ExternalRenderTheme(java.lang.String renderThemePath)
ExternalRenderTheme(java.lang.String renderThemePath, 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

Constructor Detail

ExternalRenderTheme

public ExternalRenderTheme(java.io.File renderThemeFile)
                    throws java.io.FileNotFoundException

Parameters:

renderThemeFile - the XML render theme file.

Throws:

java.io.FileNotFoundException - if the file does not exist or cannot be read.

ExternalRenderTheme

public ExternalRenderTheme(java.io.File renderThemeFile,
                           XmlRenderThemeMenuCallback menuCallback)
                    throws java.io.FileNotFoundException

Parameters:

renderThemeFile - the XML render theme file.

Throws:

java.io.FileNotFoundException - if the file does not exist or cannot be read.

ExternalRenderTheme

public ExternalRenderTheme(java.lang.String renderThemePath)
                    throws java.io.FileNotFoundException

Parameters:

renderThemePath - the path of the XML render theme file.

Throws:

java.io.FileNotFoundException - if the file does not exist or cannot be read.

ExternalRenderTheme

public ExternalRenderTheme(java.lang.String renderThemePath,
                           XmlRenderThemeMenuCallback menuCallback)
                    throws java.io.FileNotFoundException

Parameters:

renderThemePath - the path of the XML render theme file.

Throws:

java.io.FileNotFoundException - if the file does not exist or cannot be read.

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).