Package org.oscim.theme

Interface ThemeFile

All Superinterfaces:
Serializable
All Known Implementing Classes:
ExternalRenderTheme, StreamRenderTheme, ZipRenderTheme
public interface ThemeFile extends Serializable
Interface for a render theme which is defined in XML.

  • Method Details

    • getMenuCallback

      XmlRenderThemeMenuCallback getMenuCallback()
      Returns:
      the interface callback to create a settings menu on the fly.

    • getRelativePathPrefix

      String getRelativePathPrefix()
      Returns:
      the prefix for all relative resource paths.

    • getRenderThemeAsStream

      InputStream getRenderThemeAsStream() throws IRenderTheme.ThemeException
      Returns:
      an InputStream to read the render theme data from.
      Throws:
      IRenderTheme.ThemeException - if an error occurs while reading the render theme XML.

    • getResourceProvider

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

    • isMapsforgeTheme

      boolean isMapsforgeTheme()
      Tells ThemeLoader if theme file is in Mapsforge format
      Returns:
      true if theme file is in Mapsforge format

    • setMapsforgeTheme

      void setMapsforgeTheme(boolean mapsforgeTheme)
      Parameters:
      mapsforgeTheme - true if theme file is in Mapsforge format

    • setMenuCallback

      void setMenuCallback(XmlRenderThemeMenuCallback menuCallback)
      Parameters:
      menuCallback - the interface callback to create a settings menu on the fly.

    • setResourceProvider

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