to.etc.domui.themes
Interface ITheme

All Known Implementing Classes:
FragmentedThemeStore, SimpleTheme

public interface ITheme

A theme.

Author:
Frits Jalvingh Created on Jan 12, 2011

Method Summary
 ResourceDependencies getDependencies()
          The dependencies for this theme instance.
 java.lang.String getIconURL(java.lang.String icon)
          Find the specified icon in the theme, and return the proper RURL for it.
 java.lang.String getStylesheet()
          Returns the stylesheet RURL to include in every page.
 java.lang.String getThemePath(java.lang.String path)
          Get a resource from the theme's inheritance path.
 java.util.Map<java.lang.String,java.lang.Object> getThemeProperties()
          Return the read-only properties for a theme.
 

Method Detail

getDependencies

@Nonnull
ResourceDependencies getDependencies()
The dependencies for this theme instance. This will be used by the engine to check if this instance needs to be reloaded because it's source files have changed in development mode.

Returns:

getStylesheet

java.lang.String getStylesheet()
Returns the stylesheet RURL to include in every page. This must return an application-relative URL, i.e. it must not include the webapp's context and must not start with a /.

Returns:

getThemePath

java.lang.String getThemePath(java.lang.String path)
                              throws java.lang.Exception
Get a resource from the theme's inheritance path.

Parameters:
path -
Returns:
Throws:
java.lang.Exception

getThemeProperties

@Nonnull
java.util.Map<java.lang.String,java.lang.Object> getThemeProperties()
Return the read-only properties for a theme.

Returns:

getIconURL

@Nullable
java.lang.String getIconURL(@Nonnull
                                     java.lang.String icon)
                            throws java.lang.Exception
Find the specified icon in the theme, and return the proper RURL for it.

Parameters:
icon -
Returns:
Throws:
java.lang.Exception