com.atlassian.confluence.themes
Class BasicTheme

java.lang.Object
  com.atlassian.confluence.themes.BasicTheme

All Implemented Interfaces:

Theme

public class BasicTheme
extends Object
implements Theme

A theme that is loaded from a Confluence plugin.

Constructor Summary

BasicTheme()

Method Summary

ColourScheme	getColourScheme()
ThemedDecorator	getDecorator(String path)
String	getPluginKey() Return the key of the plugin which includes this theme.
Collection<? extends ThemeStylesheet>	getStylesheets() Return the stylesheets for the theme.
void	init(ThemeModuleDescriptor moduleDescriptor)
boolean	isIncludeClassicStyles() Controls the behaviour of stylesheets in this theme.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicTheme

public BasicTheme()

Method Detail

getColourScheme

public ColourScheme getColourScheme()

Specified by:

getColourScheme in interface Theme

getDecorator

public ThemedDecorator getDecorator(String path)

Specified by:

getDecorator in interface Theme

getStylesheets

public Collection<? extends ThemeStylesheet> getStylesheets()

Description copied from interface: Theme

Return the stylesheets for the theme.

Specified by:

getStylesheets in interface Theme

Returns:

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

getPluginKey

public String getPluginKey()

Description copied from interface: Theme

Return the key of the plugin which includes this theme. May return null if the theme doesn't come from a plugin.

Specified by:

getPluginKey in interface Theme

isIncludeClassicStyles

public boolean isIncludeClassicStyles()

Controls the behaviour of stylesheets in this theme. Returns the value specified by the 'includeClassicStyles' parameter on the theme plugin module.

It is recommended that new themes should set this parameter to 'false' and supply a stylesheet which is independent of changes to Confluence. However, themes can set this parameter to 'true' to get the old behaviour, which includes Confluence's 2.5 stylesheet above the theme's customisations.

For old themes that don't specify this parameter, this method returns true.

Specified by:

isIncludeClassicStyles in interface Theme

Returns:

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

See Also:

Theme.isIncludeClassicStyles()

init

public void init(ThemeModuleDescriptor moduleDescriptor)

Specified by:

init in interface Theme