com.atlassian.confluence.plugin.descriptor
Class ThemeModuleDescriptor

java.lang.Object
  extended by com.atlassian.plugin.descriptors.AbstractModuleDescriptor<Theme>
      extended by com.atlassian.confluence.plugin.descriptor.ThemeModuleDescriptor
All Implemented Interfaces:
com.atlassian.plugin.ModuleDescriptor<Theme>, com.atlassian.plugin.Resourced, 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
moduleClass, moduleClassName, moduleFactory, plugin, resources, singleton
 
Constructor Summary
ThemeModuleDescriptor()
           
 
Method Summary
 void disabled()
           
 void enabled()
           
 ColourScheme getColourScheme()
           
 Iterable<ThemeResource> getJavascript()
          Retrieve the stylesheets for the theme.
 List getLayouts()
           
 Theme getModule()
           
 Collection<ThemeResource> getStylesheets()
          Retrieve the stylesheets for the theme.
 void init(com.atlassian.plugin.Plugin plugin, org.dom4j.Element element)
           
 void setPluginAccessor(com.atlassian.plugin.PluginAccessor pluginAccessor)
           
 
Methods inherited from class com.atlassian.plugin.descriptors.AbstractModuleDescriptor
assertModuleClassImplements, destroy, equals, getCompleteKey, getDescription, getDescriptionKey, getI18nNameKey, getKey, getMinJavaVersion, getModuleClass, getName, getParams, getPlugin, getPluginKey, getResourceDescriptor, getResourceDescriptors, getResourceDescriptors, getResourceLocation, hashCode, isEnabledByDefault, isSingleton, isSingletonByDefault, isSystemModule, loadClass, loadClass, provideValidationRules, satisfiesMinJavaVersion, setPlugin, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ThemeModuleDescriptor

public ThemeModuleDescriptor()
Method Detail

setPluginAccessor

public void setPluginAccessor(com.atlassian.plugin.PluginAccessor pluginAccessor)

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 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.


Copyright © 2003-2011 Atlassian. All Rights Reserved.