Package org.oscim.theme

Class ExternalRenderTheme

java.lang.Object

org.oscim.theme.ExternalRenderTheme

All Implemented Interfaces:

Serializable, ThemeFile

public class ExternalRenderTheme
extends Object
implements ThemeFile

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

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ExternalRenderTheme(String fileName)
ExternalRenderTheme(String fileName, XmlRenderThemeMenuCallback menuCallback)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
XmlRenderThemeMenuCallback	getMenuCallback()
String	getRelativePathPrefix()
InputStream	getRenderThemeAsStream()
XmlThemeResourceProvider	getResourceProvider()
boolean	isMapsforgeTheme()	Tells ThemeLoader if theme file is in Mapsforge format
void	setMapsforgeTheme(boolean mapsforgeTheme)
void	setMenuCallback(XmlRenderThemeMenuCallback menuCallback)
void	setResourceProvider(XmlThemeResourceProvider resourceProvider)

Methods inherited from class java.lang.Object

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

Constructor Details

ExternalRenderTheme

public ExternalRenderTheme(String fileName)
                    throws IRenderTheme.ThemeException

Parameters:

fileName - the path to the XML render theme file.

Throws:

IRenderTheme.ThemeException - if the file does not exist or cannot be read.

ExternalRenderTheme

public ExternalRenderTheme(String fileName,
 XmlRenderThemeMenuCallback menuCallback)
                    throws IRenderTheme.ThemeException

Parameters:

fileName - the path to the XML render theme file.

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

Throws:

IRenderTheme.ThemeException - if the file does not exist or cannot be read.

Method Details

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getMenuCallback

public XmlRenderThemeMenuCallback getMenuCallback()

Specified by:

getMenuCallback in interface ThemeFile

Returns:

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

getRelativePathPrefix

public String getRelativePathPrefix()

Specified by:

getRelativePathPrefix in interface ThemeFile

Returns:

the prefix for all relative resource paths.

getRenderThemeAsStream

public InputStream getRenderThemeAsStream()
                                   throws IRenderTheme.ThemeException

Specified by:

getRenderThemeAsStream in interface ThemeFile

Returns:

an InputStream to read the render theme data from.

Throws:

IRenderTheme.ThemeException - if an error occurs while reading the render theme XML.

getResourceProvider

public XmlThemeResourceProvider getResourceProvider()

Specified by:

getResourceProvider in interface ThemeFile

Returns:

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

isMapsforgeTheme

public boolean isMapsforgeTheme()

Description copied from interface: ThemeFile

Tells ThemeLoader if theme file is in Mapsforge format

Specified by:

isMapsforgeTheme in interface ThemeFile

Returns:

true if theme file is in Mapsforge format

setMapsforgeTheme

public void setMapsforgeTheme(boolean mapsforgeTheme)

Specified by:

setMapsforgeTheme in interface ThemeFile

Parameters:

mapsforgeTheme - true if theme file is in Mapsforge format

setMenuCallback

public void setMenuCallback(XmlRenderThemeMenuCallback menuCallback)

Specified by:

setMenuCallback in interface ThemeFile

Parameters:

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

setResourceProvider

public void setResourceProvider(XmlThemeResourceProvider resourceProvider)

Specified by:

setResourceProvider in interface ThemeFile

Parameters:

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