to.etc.domui.themes

Class ThemeManager

java.lang.Object

to.etc.domui.themes.ThemeManager

public final class ThemeManager
extends Object

This is used by DomApplication to manage themes. It exists to reduce the code in DomApplication; it cannot be overridden.

Author:

Frits Jalvingh Created on Apr 27, 2011

Constructor Summary

Constructors

Constructor and Description
ThemeManager(DomApplication application)

Method Summary

Modifier and Type	Method and Description
String	getCurrentTheme() Gets the current theme string.
ITheme	getTheme(String themeName, IResourceDependencyList rdl) Get the theme store representing the specified theme name.
String	getThemedResourceRURL(IThemeVariant themeStyle, String path) This checks to see if the RURL passed is a theme-relative URL.
IThemeFactory	getThemeFactory() Get the current theme factory.
IScriptScope	getThemeMap(String themeName, IResourceDependencyList rdlin) Return the current theme map (a readonly map), cached from the last time.
String	getThemeReplacedString(IResourceDependencyList rdl, String rurl)
String	getThemeReplacedString(IResourceDependencyList rdl, String rurl, BrowserVersion bv) EXPENSIVE CALL - ONLY USE TO CREATE CACHED RESOURCES This loads a theme resource as an utf-8 encoded template, then does expansion using the current theme's variable map.
void	setCurrentTheme(String currentTheme) Sets the current theme string.
void	setThemeFactory(IThemeFactory themer) Set the factory for handling the theme.

Methods inherited from class java.lang.Object

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

Constructor Detail

ThemeManager

public ThemeManager(DomApplication application)

Method Detail

setCurrentTheme

public void setCurrentTheme(@Nonnull
                            String currentTheme)

Sets the current theme string. This string is used as a "parameter" for the theme factory which will use it to decide on the "real" theme to use.

Parameters:

currentTheme - The theme name, valid for the current theme engine. Cannot be null nor the empty string.

getCurrentTheme

@Nonnull
public String getCurrentTheme()

Gets the current theme string. This will become part of all themed resource URLs and is interpreted by the theme factory to resolve resources.

Returns:

getThemeFactory

@Nonnull
public IThemeFactory getThemeFactory()

Get the current theme factory.

Returns:

setThemeFactory

public void setThemeFactory(@Nonnull
                            IThemeFactory themer)

Set the factory for handling the theme.

Parameters:

themer -

getTheme

@Nonnull
public ITheme getTheme(String themeName,
                                @Nullable
                                IResourceDependencyList rdl)

Get the theme store representing the specified theme name. This is the name as obtained from the resource name which is the part between $THEME/ and the actual filename. This code is fast once the theme is loaded after the 1st call.

Parameters:

rdl -

Returns:

Throws:

Exception

getThemeReplacedString

public String getThemeReplacedString(@Nonnull
                                     IResourceDependencyList rdl,
                                     String rurl)
                              throws Exception

Throws:

Exception

getThemeReplacedString

public String getThemeReplacedString(@Nonnull
                                     IResourceDependencyList rdl,
                                     @Nonnull
                                     String rurl,
                                     @Nullable
                                     BrowserVersion bv)
                              throws Exception

EXPENSIVE CALL - ONLY USE TO CREATE CACHED RESOURCES This loads a theme resource as an utf-8 encoded template, then does expansion using the current theme's variable map. This map is either a "style.properties" file inside the theme's folder, or can be configured dynamically using a IThemeMapFactory. The result is returned as a string.

Parameters:

rdl -

Returns:

Throws:

Exception

getThemeMap

public IScriptScope getThemeMap(String themeName,
                                IResourceDependencyList rdlin)
                         throws Exception

Return the current theme map (a readonly map), cached from the last time. It will refresh automatically when the resource dependencies for the theme are updated.

Parameters:

rdl -

Returns:

Throws:

Exception

getThemedResourceRURL

@Nonnull
public String getThemedResourceRURL(@Nonnull
                                             IThemeVariant themeStyle,
                                             @Nonnull
                                             String path)

This checks to see if the RURL passed is a theme-relative URL. These URLs start with THEME/. If not the RURL is returned as-is; otherwise the URL is translated to a path containing the current theme string:

        $THEME/[currentThemeString]/[name]
 

where [name] is the rest of the path string after THEME/ has been removed from it.

Parameters:

themeStyle - The substyle/variant of the theme that the page wants to use.

path -

Returns: