Package com.atlassian.confluence.themes
Interface ColourSchemeManager
-
- All Known Implementing Classes:
DefaultColourSchemeManager,SetupColourSchemeManager
public interface ColourSchemeManager
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetColourSchemeSetting(Space space)ColourSchemegetDefaultColourScheme()Retrieve only the default color scheme, useful for the superbatch.ColourSchemegetGlobalColourScheme()Retrieve the global colour scheme - for display, complete with global defaults.ColourSchemegetGlobalColourSchemeCustom()Retrieve the global colour scheme for editing - with system defaults.BaseColourSchemegetGlobalColourSchemeIsolated()Retrieve the isolated global colour scheme for editing - no global defaults.ColourSchemegetSpaceColourScheme(Space space)Retrieve the colour scheme for a space - for display, complete with global defaults.ColourSchemegetSpaceColourScheme(String spaceKey)Retrieve the colour scheme for a space - for display, complete with global defaults.ColourSchemegetSpaceColourSchemeCustom(String spaceKey)Retrieve the custom colour scheme for a space - for editing, complete with global defaults and system defaults.BaseColourSchemegetSpaceColourSchemeIsolated(String spaceKey)Retrieve the isolated colour scheme for a space for editing - no global defaults.ColourSchemegetSpaceThemeColourScheme(String spaceKey)ColourSchemegetThemeColourScheme()voidresetColourScheme(Space space)voidsaveGlobalColourScheme(BaseColourScheme colourScheme)voidsaveSpaceColourScheme(Space space, BaseColourScheme colourScheme)voidsetColourSchemeSetting(Space space, String value)
-
-
-
Method Detail
-
getDefaultColourScheme
ColourScheme getDefaultColourScheme()
Retrieve only the default color scheme, useful for the superbatch.
-
getSpaceColourScheme
ColourScheme getSpaceColourScheme(Space space)
Retrieve the colour scheme for a space - for display, complete with global defaults.For editing, use
getSpaceColourScheme(String)()}.
-
getSpaceColourScheme
ColourScheme getSpaceColourScheme(String spaceKey)
Retrieve the colour scheme for a space - for display, complete with global defaults.For editing, use
getSpaceColourSchemeCustom(String).
-
getGlobalColourScheme
ColourScheme getGlobalColourScheme()
Retrieve the global colour scheme - for display, complete with global defaults.For editing, use
getGlobalColourSchemeCustom().
-
getThemeColourScheme
ColourScheme getThemeColourScheme()
-
getSpaceColourSchemeIsolated
BaseColourScheme getSpaceColourSchemeIsolated(String spaceKey)
Retrieve the isolated colour scheme for a space for editing - no global defaults.For display, use
getSpaceColourScheme(com.atlassian.confluence.spaces.Space).- Returns:
- a
ColourSchemethat does not have any backingColourSchemes.
-
getSpaceColourSchemeCustom
ColourScheme getSpaceColourSchemeCustom(String spaceKey)
Retrieve the custom colour scheme for a space - for editing, complete with global defaults and system defaults.
-
getGlobalColourSchemeIsolated
BaseColourScheme getGlobalColourSchemeIsolated()
Retrieve the isolated global colour scheme for editing - no global defaults.For display, use
getGlobalColourScheme().- Returns:
- a
ColourSchemethat does not have any backingColourSchemes.
-
getGlobalColourSchemeCustom
ColourScheme getGlobalColourSchemeCustom()
Retrieve the global colour scheme for editing - with system defaults.
-
resetColourScheme
void resetColourScheme(Space space)
-
saveSpaceColourScheme
void saveSpaceColourScheme(Space space, BaseColourScheme colourScheme)
-
saveGlobalColourScheme
void saveGlobalColourScheme(BaseColourScheme colourScheme)
-
getSpaceThemeColourScheme
ColourScheme getSpaceThemeColourScheme(String spaceKey)
-
-