org.pentaho.platform.api.ui
Interface IThemeManager

All Known Implementing Classes:

DefaultThemeManager

public interface IThemeManager

Class responsible for collecting information about all available system module local themes. All implementations should utilize a caching mechanism to prevent unnecessary overhead. User: nbaker Date: 5/15/11

Method Summary

Theme	getModuleTheme(String moduleName, String themeName) Returns the named local theme for the given named module or null if either is not found
ModuleThemeInfo	getModuleThemeInfo(String moduleName) Returns the MoudleThemeInfo object containing all themes for the given module name or null if not found.
Theme	getSystemTheme(String themeName) Returns the named theme or null if not found.
List<String>	getSystemThemeIds() Return a list of available system themes.
void	refresh() Force the Theme Manager to recalculate system and module themes
void	setThemeResolvers(List<IThemeResolver> resolvers) Set the collection of IThemeResolver objects used to find available themes

Method Detail

setThemeResolvers

void setThemeResolvers(List<IThemeResolver> resolvers)

Set the collection of IThemeResolver objects used to find available themes

Parameters:

resolvers -

getSystemThemeIds

List<String> getSystemThemeIds()

Return a list of available system themes.

Returns:

List of themes

getSystemTheme

Theme getSystemTheme(String themeName)

Returns the named theme or null if not found.

Parameters:

themeName -

Returns:

Theme for the supplied name

getModuleTheme

Theme getModuleTheme(String moduleName,
                     String themeName)

Returns the named local theme for the given named module or null if either is not found

Parameters:

moduleName -

themeName -

Returns:

getModuleThemeInfo

ModuleThemeInfo getModuleThemeInfo(String moduleName)

Returns the MoudleThemeInfo object containing all themes for the given module name or null if not found.

Parameters:

moduleName -

Returns:

refresh

void refresh()

Force the Theme Manager to recalculate system and module themes