Package com.atlassian.confluence.plugin.descriptor

Class ThemeModuleDescriptor

java.lang.Object

com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Theme>

com.atlassian.confluence.plugin.descriptor.ThemeModuleDescriptor

All Implemented Interfaces:

com.atlassian.plugin.ModuleDescriptor<Theme>, com.atlassian.plugin.Resourced, com.atlassian.plugin.ScopeAware, com.atlassian.plugin.StateAware

public class ThemeModuleDescriptor
extends com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Theme>

Field Summary

Fields inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

key, moduleClass, moduleClassName, moduleFactory, name, plugin, resources

Constructor Summary

Constructors

Constructor	Description
ThemeModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory, com.atlassian.plugin.PluginAccessor pluginAccessor, com.atlassian.plugin.webresource.WebResourceIntegration webResourceIntegration)

Method Summary

Modifier and Type	Method	Description
void	disabled()
void	enabled()
String	getBodyClass()
ColourScheme	getColourScheme()
Iterable<ThemeResource>	getJavascript()	Retrieve the stylesheets for the theme.
List<ThemedDecorator>	getLayouts()
Theme	getModule()
Collection<ThemeResource>	getStylesheets()	Retrieve the stylesheets for the theme.
String	getTopNavLocation()
List<VelocityResultOverride>	getVelocityResultOverrides()
boolean	hasSpaceSideBar()
void	init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)
boolean	isDisableSitemesh()

Methods inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor

assertModuleClassImplements, checkPermissions, destroy, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getModuleClassName, getName, getParams, getPlugin, getPluginKey, getRequiredPermissions, getResourceDescriptor, getResourceDescriptors, getResourceLocation, getScopeKey, hashCode, isBroken, isEnabled, isEnabledByDefault, isSystemModule, loadClass, provideValidationRules, satisfiesMinJavaVersion, setBroken, setPlugin, toString, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlassian.plugin.ModuleDescriptor

getDisplayName, init

Constructor Detail

ThemeModuleDescriptor

public ThemeModuleDescriptor(com.atlassian.plugin.module.ModuleFactory moduleFactory,
                             com.atlassian.plugin.PluginAccessor pluginAccessor,
                             com.atlassian.plugin.webresource.WebResourceIntegration webResourceIntegration)

Method Detail

init

public void init(com.atlassian.plugin.Plugin plugin,
                 org.dom4j.Element element)
          throws com.atlassian.plugin.PluginParseException

Specified by:

init in interface com.atlassian.plugin.ModuleDescriptor<Theme>

Overrides:

init in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Theme>

Throws:

com.atlassian.plugin.PluginParseException

getModule

public Theme getModule()

Specified by:

getModule in interface com.atlassian.plugin.ModuleDescriptor<Theme>

Specified by:

getModule in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Theme>

enabled

public void enabled()

Specified by:

enabled in interface com.atlassian.plugin.StateAware

Overrides:

enabled in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Theme>

disabled

public void disabled()

Specified by:

disabled in interface com.atlassian.plugin.StateAware

Overrides:

disabled in class com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Theme>

getColourScheme

public ColourScheme getColourScheme()

getLayouts

public List<ThemedDecorator> getLayouts()

getStylesheets

public Collection<ThemeResource> getStylesheets()

Retrieve the stylesheets for the theme. Resources are considered to be stylesheets if they have a type of 'stylesheet' or a name ending in '.css'. As of Confluence 2.8, stylesheet resources for a theme only include resources declared within the theme module.

Returns:

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

getJavascript

public Iterable<ThemeResource> getJavascript()

Retrieve the stylesheets for the theme. Resources are considered to be stylesheets if they have a type of 'stylesheet' or a name ending in '.css'. As of Confluence 2.8, stylesheet resources for a theme only include resources declared within the theme module.

Returns:

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

isDisableSitemesh

public boolean isDisableSitemesh()

getVelocityResultOverrides

public List<VelocityResultOverride> getVelocityResultOverrides()

getBodyClass

public String getBodyClass()

getTopNavLocation

public String getTopNavLocation()

hasSpaceSideBar

public boolean hasSpaceSideBar()