public interface

Theme

com.atlassian.confluence.themes.Theme
Known Indirect Subclasses

Summary

Public Methods
abstract ColourScheme getColourScheme()
abstract ThemedDecorator getDecorator(String path)
abstract Collection<? extends ThemeResource> getJavascript()
Return the JavaScript resources for the theme.
abstract String getModuleKey()
Returns the module key of the theme plugin module, or null if this theme doesn't come from a plugin.
abstract String getPluginKey()
Return the key of the plugin which includes this theme.
abstract Collection<? extends ThemeResource> getStylesheets()
Return the stylesheets for the theme.
abstract void init(ThemeModuleDescriptor moduleDescriptor)
Initialise the theme details from the given theme module descriptor.
abstract boolean isIncludeClassicStyles()
This method is deprecated. Since 3.5. Themes should include their own stylesheets and not rely on Confluence's legacy styles.

Public Methods

public abstract ColourScheme getColourScheme ()

public abstract ThemedDecorator getDecorator (String path)

public abstract Collection<? extends ThemeResource> getJavascript ()

Return the JavaScript resources for the theme.

Returns
  • a Collection of ThemeResources representing custom JavaScript for this theme, or an empty list if none exist.

public abstract String getModuleKey ()

Returns the module key of the theme plugin module, or null if this theme doesn't come from a plugin.

public abstract String getPluginKey ()

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

public abstract Collection<? extends ThemeResource> getStylesheets ()

Return the stylesheets for the theme.

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

public abstract void init (ThemeModuleDescriptor moduleDescriptor)

Initialise the theme details from the given theme module descriptor.

public abstract boolean isIncludeClassicStyles ()

This method is deprecated.
Since 3.5. Themes should include their own stylesheets and not rely on Confluence's legacy styles.

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 com.atlassian.confluence.core.actions.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.