|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Theme
Method Summary | |
---|---|
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()
Deprecated. since 5.0 - with the common header themes shouldn't specify their own top navigation anymore. This method is no longer called from anywhere within Confluence. |
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 assumes the Space IA side bar is displayed. |
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. |
Method Detail |
---|
ColourScheme getColourScheme()
String getBodyClass()
ThemedDecorator getDecorator(String path)
Collection<? extends ThemeResource> getStylesheets()
ThemeResource
s representing custom stylesheets for this theme,
or an empty list if none exist.Collection<? extends ThemeResource> getJavascript()
ThemeResource
s representing custom JavaScript for this theme,
or an empty list if none exist.void init(ThemeModuleDescriptor moduleDescriptor)
String getPluginKey()
String getModuleKey()
@Deprecated boolean isIncludeClassicStyles()
com.atlassian.confluence.core.actions.StylesheetAction
continues to include
this "classic" stylesheet above theme stylesheets when this method returns true.
For new themes, it is recommended that stylesheets be independent of Confluence's styles. In this case, this
method returns false, and the StylesheetAction will only render the theme's stylesheet.
boolean isDisableSitemesh()
String getXworkVelocityPath(String packageName, String actionName, String result, String template)
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 process
String getTopNavLocation()
boolean hasSpaceSideBar()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |