Constructor and Description |
---|
BasicTheme() |
Modifier and Type | Method and Description |
---|---|
String |
getBodyClass()
Returns the class for the body element specified by the theme.
|
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.
|
String |
getTopNavLocation()
Returns the location of the Velocity file which renders the top navigation.
|
String |
getXworkVelocityPath(String packageName,
String actionName,
String result,
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.
|
public ColourScheme getColourScheme()
getColourScheme
in interface Theme
public ThemedDecorator getDecorator(String path)
getDecorator
in interface Theme
public Collection<? extends ThemeResource> getStylesheets()
Theme
getStylesheets
in interface Theme
ThemeResource
s representing custom stylesheets for this theme,
or an empty list if none exist.public Collection<? extends ThemeResource> getJavascript()
Theme
getJavascript
in interface Theme
ThemeResource
s representing custom JavaScript for this theme,
or an empty list if none exist.public String getPluginKey()
Theme
getPluginKey
in interface Theme
@Deprecated public boolean isIncludeClassicStyles()
isIncludeClassicStyles
in interface Theme
public void init(ThemeModuleDescriptor moduleDescriptor)
Theme
public String getXworkVelocityPath(String packageName, String actionName, String result, String template)
Theme
getXworkVelocityPath
in interface Theme
packageName
- the package name of the action being runactionName
- the name of the action being runresult
- the result string of the action being runtemplate
- the Velocity template path the action wants to processpublic boolean isDisableSitemesh()
Theme
isDisableSitemesh
in interface Theme
public String getModuleKey()
Theme
getModuleKey
in interface Theme
public String getBodyClass()
Theme
getBodyClass
in interface Theme
public String getTopNavLocation()
Theme
getTopNavLocation
in interface Theme
public boolean hasSpaceSideBar()
Theme
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.
hasSpaceSideBar
in interface Theme
Copyright © 2003–2017 Atlassian. All rights reserved.