com.atlassian.confluence.themes
Class BasicTheme

java.lang.Object
  extended by 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)
           
 Collection<? extends ThemeResource> getJavascript()
          Return the JavaScript resources for the theme.
 String getModuleKey()
          Returns the module key of the theme plugin module, or null if this theme doesn't come from a plugin.
 String getPluginKey()
          Return the key of the plugin which includes this theme.
 Collection<? extends ThemeResource> getStylesheets()
          Return the stylesheets for the theme.
 void init(ThemeModuleDescriptor moduleDescriptor)
          Initialise the theme details from the given theme module descriptor.
 boolean isIncludeClassicStyles()
          Deprecated. Since 3.5. Themes should include their own stylesheets and not rely on Confluence's legacy styles.
 
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 ThemeResource> getStylesheets()
Description copied from interface: Theme
Return the stylesheets for the theme.

Specified by:
getStylesheets in interface Theme
Returns:
a Collection of ThemeResources representing custom stylesheets for this theme, or an empty list if none exist.

getJavascript

public Collection<? extends ThemeResource> getJavascript()
Description copied from interface: Theme
Return the JavaScript resources for the theme.

Specified by:
getJavascript in interface Theme
Returns:
a Collection of ThemeResources representing custom JavaScript 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

@Deprecated
public boolean isIncludeClassicStyles()
Deprecated. Since 3.5. Themes should include their own stylesheets and not rely on Confluence's legacy styles.

Classic (pre 2.5) styles are no longer supported by Confluecne, hence this will always returns false.

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.

init

public void init(ThemeModuleDescriptor moduleDescriptor)
Description copied from interface: Theme
Initialise the theme details from the given theme module descriptor.

Specified by:
init in interface Theme

getModuleKey

public String getModuleKey()
Description copied from interface: Theme
Returns the module key of the theme plugin module, or null if this theme doesn't come from a plugin.

Specified by:
getModuleKey in interface Theme


Copyright © 2003-2012 Atlassian. All Rights Reserved.