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
All Methods Instance Methods Concrete Methods 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)
-
-
-
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 classjava.lang.Object
-
getMenuCallback
public XmlRenderThemeMenuCallback getMenuCallback()
- Specified by:
getMenuCallback
in interfaceXmlRenderTheme
- Returns:
- the interface callback to create a settings menu on the fly.
-
getRelativePathPrefix
public java.lang.String getRelativePathPrefix()
- Specified by:
getRelativePathPrefix
in interfaceXmlRenderTheme
- Returns:
- the prefix for all relative resource paths.
-
getRenderThemeAsStream
public java.io.InputStream getRenderThemeAsStream() throws java.io.IOException
- Specified by:
getRenderThemeAsStream
in interfaceXmlRenderTheme
- 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 interfaceXmlRenderTheme
- Returns:
- a custom provider to retrieve resources internally referenced by "src" attribute (e.g. images, icons).
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
setMenuCallback
public void setMenuCallback(XmlRenderThemeMenuCallback menuCallback)
- Specified by:
setMenuCallback
in interfaceXmlRenderTheme
- Parameters:
menuCallback
- the interface callback to create a settings menu on the fly.
-
setResourceProvider
public void setResourceProvider(XmlThemeResourceProvider resourceProvider)
- Specified by:
setResourceProvider
in interfaceXmlRenderTheme
- Parameters:
resourceProvider
- a custom provider to retrieve resources internally referenced by "src" attribute (e.g. images, icons).
-
-