com.atlassian.confluence.themes
Interface ColourSchemeManager

All Known Implementing Classes:
DefaultColourSchemeManager

public interface ColourSchemeManager


Method Summary
 String getColourSchemeSetting(Space space)
           
 ColourScheme getGlobalColourScheme()
          Retrieve the global colour scheme - for display, complete with global defaults.
 ColourScheme getGlobalColourSchemeCustom()
          Retrieve the global colour scheme for editing - with system defaults.
 BaseColourScheme getGlobalColourSchemeIsolated()
          Retrieve the isolated global colour scheme for editing - no global defaults.
 ColourScheme getSpaceColourScheme(Space space)
          Retrieve the colour scheme for a space - for display, complete with global defaults.
 ColourScheme getSpaceColourScheme(String spaceKey)
          Retrieve the colour scheme for a space - for display, complete with global defaults.
 ColourScheme getSpaceColourSchemeCustom(String spaceKey)
          Retrieve the custom colour scheme for a space - for editing, complete with global defaults and system defaults.
 BaseColourScheme getSpaceColourSchemeIsolated(String spaceKey)
          Retrieve the isolated colour scheme for a space for editing - no global defaults.
 ColourScheme getSpaceThemeColourScheme(String spaceKey)
           
 ColourScheme getThemeColourScheme()
           
 void resetColourScheme(Space space)
           
 void saveGlobalColourScheme(BaseColourScheme colourScheme)
           
 void saveSpaceColourScheme(Space space, BaseColourScheme colourScheme)
           
 void setColourSchemeSetting(Space space, String value)
           
 

Method Detail

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 ColourScheme that does not have any backing ColourSchemes.

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 ColourScheme that does not have any backing ColourSchemes.

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)

setColourSchemeSetting

void setColourSchemeSetting(Space space,
                            String value)

getColourSchemeSetting

String getColourSchemeSetting(Space space)


Copyright © 2003–2015 Atlassian. All rights reserved.