com.atlassian.confluence.themes
Interface Theme

All Known Implementing Classes:
BasicTheme, DefaultTheme

public interface Theme


Method Summary
 ColourScheme getColourScheme()
           
 ThemedDecorator getDecorator(java.lang.String path)
           
 java.lang.String getPluginKey()
          Return the key of the plugin which includes this theme.
 java.util.Collection<? extends ThemeStylesheet> getStylesheets()
          Return the stylesheets for the theme.
 void init(ThemeModuleDescriptor moduleDescriptor)
           
 boolean isIncludeClassicStyles()
          Controls whether Confluence's 2.5 default styles will be included when rendering a theme stylesheet.
 

Method Detail

getColourScheme

ColourScheme getColourScheme()

getDecorator

ThemedDecorator getDecorator(java.lang.String path)

getStylesheets

java.util.Collection<? extends ThemeStylesheet> getStylesheets()
Return the stylesheets for the theme.

Returns:
a Collection of ThemeStylesheets representing custom stylesheets for this theme, or an empty list if none exist.

init

void init(ThemeModuleDescriptor moduleDescriptor)

getPluginKey

java.lang.String getPluginKey()
Return the key of the plugin which includes this theme. May return null if the theme doesn't come from a plugin.


isIncludeClassicStyles

boolean isIncludeClassicStyles()
Controls whether Confluence's 2.5 default styles will be included when rendering a theme stylesheet.

Old themes (prior to 2.6) provided stylesheets to be used in conjuction with the default stylesheet in Confluence 2.5. To facilitate this, the StylesheetAction continues to include this "classic" stylesheet above theme stylesheets when this method returns true.

For new themes, it is recommended that stylesheets be independent of Confluence's styles. In this case, this method returns false, and the StylesheetAction will only render the theme's stylesheet.

Returns:
true if the theme should include Confluence's classic styles when rendering, or false if the theme should not include any Confluence styles.


Copyright © 2003-2008 Atlassian Pty Ltd. All Rights Reserved.