com.atlassian.confluence.themes

Class BasicTheme

java.lang.Object

com.atlassian.confluence.themes.BasicTheme

All Implemented Interfaces:

Theme

public class BasicTheme
extends java.lang.Object
implements Theme

A theme that is loaded from a Confluence plugin.

Constructor Summary

Constructors

Constructor and Description
BasicTheme()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getBodyClass() Returns the class for the body element specified by the theme.
ColourScheme	getColourScheme()
ThemedDecorator	getDecorator(java.lang.String path)
java.util.Collection<? extends ThemeResource>	getJavascript() Return the JavaScript resources for the theme.
java.lang.String	getModuleKey() Returns the module key of the theme plugin module, or null if this theme doesn't come from a plugin.
java.lang.String	getPluginKey() Return the key of the plugin which includes this theme.
java.util.Collection<? extends ThemeResource>	getStylesheets() Return the stylesheets for the theme.
java.lang.String	getTopNavLocation() Returns the location of the Velocity file which renders the top navigation.
java.lang.String	getXworkVelocityPath(java.lang.String packageName, java.lang.String actionName, java.lang.String result, java.lang.String template) If this theme defines any specific overrides for Velocity XWork results, process them through here.
boolean	hasSpaceSideBar() Tells whether this theme requires rendering of the Space IA sidebar.
void	init(ThemeModuleDescriptor moduleDescriptor) Initialise the theme details from the given theme module descriptor.
boolean	isDisableSitemesh() If this flag returns true, all requests for sitemesh templates w.r.t this theme will return NoDecorator, leading to a total bypassing of the sitemesh-based theme system.
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(java.lang.String path)

Specified by:

getDecorator in interface Theme

getStylesheets

public java.util.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 java.util.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 java.lang.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

getXworkVelocityPath

public java.lang.String getXworkVelocityPath(java.lang.String packageName,
                                    java.lang.String actionName,
                                    java.lang.String result,
                                    java.lang.String template)

Description copied from interface: Theme

If this theme defines any specific overrides for Velocity XWork results, process them through here.

Specified by:

getXworkVelocityPath in interface Theme

Parameters:

packageName - the package name of the action being run

actionName - the name of the action being run

result - the result string of the action being run

template - the Velocity template path the action wants to process

Returns:

the Velocity template path the action should process, with any overrides applied

isDisableSitemesh

public boolean isDisableSitemesh()

Description copied from interface: Theme

If this flag returns true, all requests for sitemesh templates w.r.t this theme will return NoDecorator, leading to a total bypassing of the sitemesh-based theme system.

Specified by:

isDisableSitemesh in interface Theme

Returns:

true if this theme wants to turn off sitemesh

getModuleKey

public java.lang.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

getBodyClass

public java.lang.String getBodyClass()

Description copied from interface: Theme

Returns the class for the body element specified by the theme.

Specified by:

getBodyClass in interface Theme

getTopNavLocation

public java.lang.String getTopNavLocation()

Description copied from interface: Theme

Returns the location of the Velocity file which renders the top navigation.

Specified by:

getTopNavLocation in interface Theme

hasSpaceSideBar

public boolean hasSpaceSideBar()

Description copied from interface: Theme

Tells whether this theme requires rendering of the Space IA sidebar. The Space IA side bar is the one on the left, which contains a tree view of pages, a chronological view of the blogs, and so on.

Recommended value: false for themes that don't require rendering of the Space IA sidebar, true otherwise. This value is true for the default theme starting from Confluence 5.0.

Specified by:

hasSpaceSideBar in interface Theme

Returns:

whether this theme needs rendering of the Space IA side bar.