org.oscim.theme

Class ExternalRenderTheme

java.lang.Object

org.oscim.theme.ExternalRenderTheme

All Implemented Interfaces:

java.io.Serializable, ThemeFile

public class ExternalRenderTheme
extends java.lang.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 and Description
ExternalRenderTheme(java.lang.String fileName)
ExternalRenderTheme(java.lang.String fileName, XmlRenderThemeMenuCallback menuCallback)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalRenderTheme

public ExternalRenderTheme(java.lang.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(java.lang.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 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 ThemeFile

Returns:

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

getRelativePathPrefix

public java.lang.String getRelativePathPrefix()

Specified by:

getRelativePathPrefix in interface ThemeFile

Returns:

the prefix for all relative resource paths.

getRenderThemeAsStream

public java.io.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.

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.