org.nuxeo.theme.styling.service

Class ThemeStylingServiceImpl

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.theme.styling.service.ThemeStylingServiceImpl

All Implemented Interfaces:

Adaptable, Component, Extensible, TimestampedService, ThemeStylingService

public class ThemeStylingServiceImpl
extends DefaultComponent
implements ThemeStylingService

Default implementation for the ThemeStylingService

Since:

5.5

Nested Class Summary

Nested classes/interfaces inherited from interface org.nuxeo.theme.styling.service.ThemeStylingService

ThemeStylingService.PRESET_CATEGORY

Field Summary

Fields

Modifier and Type	Field and Description
protected FlavorRegistry	flavorReg
protected PageRegistry	pageReg
protected ResourceRegistry	resourceReg
protected StyleRegistry	styleReg

Fields inherited from class org.nuxeo.runtime.model.DefaultComponent

lastModified

Fields inherited from interface org.nuxeo.theme.styling.service.ThemeStylingService

FLAVOR_MARKER, PAGE_STYLE_CLASS_NAME_PREFIX, PAGE_STYLE_NAME_SUFFIX

Constructor Summary

Constructors

Constructor and Description
ThemeStylingServiceImpl()

Method Summary

Modifier and Type	Method and Description
void	activate(ComponentContext context)
protected Logo	computeLogo(Flavor flavor, List<String> flavors)
protected PalettePreview	computePalettePreview(Flavor flavor, List<String> flavors)
protected List<FlavorPresets>	computePresets(Flavor flavor, List<String> flavors)
String	getDefaultFlavorName(String themePageName) Returns the default flavor for a given theme page
Flavor	getFlavor(String flavorName) Returns the flavor for given name, or null if not found.
List<String>	getFlavorNames(String themePageName) Returns the flavor names for a given theme page
List<Flavor>	getFlavors(String themePageName) Returns the flavors for a given theme page
Logo	getLogo(String flavorName) Returns the logo configured for given flavor name, and fallbacks on the extends flavor logo if not set.
protected String	getPaletteName(String name, String category)
protected URL	getUrlFromPath(String path, RuntimeContext extensionContext)
protected void	postRegisterAllThemePageResources() Reload theme page resources conf according to new style
protected void	postRegisterThemePageResources(String themePageName, ThemePage page, ThemePage pageApplyingToAll)
protected void	postRegisterThemePageResources(ThemePage page) Register link between page and style after theme has been registered
void	registerContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
protected void	registerFlavor(Flavor flavor, RuntimeContext extensionContext)
protected void	registerFlavorToThemeService(Flavor flavor, RuntimeContext extensionContext)
protected void	registerPage(ThemePage themePage)
protected void	registerResource(ResourceType resource, RuntimeContext extensionContext)
protected void	registerStyle(SimpleStyle style, RuntimeContext extensionContext)
void	themeGlobalResourcesRegistered(URL themeUrl) Hook to notify the service that global resources for a theme need to be registered
void	themeRegistered(String themeName) Hook to notify the service that a theme has been registered
void	unregisterContribution(Object contribution, String extensionPoint, ComponentInstance contributor)
protected void	unregisterFlavorToThemeService(Flavor flavor)
protected void	unregisterResourceToThemeService(ResourceType resource)
protected void	unRegisterThemePageResources(String themePageName, ThemePage page)
protected void	unRegisterThemePageResources(ThemePage page)

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

applicationStarted, deactivate, getAdapter, getApplicationStartedOrder, getLastModified, registerExtension, setLastModified, setModifiedNow, unregisterExtension

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

pageReg

protected PageRegistry pageReg

flavorReg

protected FlavorRegistry flavorReg

styleReg

protected StyleRegistry styleReg

resourceReg

protected ResourceRegistry resourceReg

Constructor Detail

ThemeStylingServiceImpl

public ThemeStylingServiceImpl()

Method Detail

activate

public void activate(ComponentContext context)
              throws Exception

Specified by:

activate in interface Component

Overrides:

activate in class DefaultComponent

Throws:

Exception

registerContribution

public void registerContribution(Object contribution,
                                 String extensionPoint,
                                 ComponentInstance contributor)
                          throws Exception

Overrides:

registerContribution in class DefaultComponent

Throws:

Exception

unregisterContribution

public void unregisterContribution(Object contribution,
                                   String extensionPoint,
                                   ComponentInstance contributor)
                            throws Exception

Overrides:

unregisterContribution in class DefaultComponent

Throws:

Exception

registerPage

protected void registerPage(ThemePage themePage)
                     throws Exception

Throws:

Exception

registerFlavor

protected void registerFlavor(Flavor flavor,
                              RuntimeContext extensionContext)
                       throws Exception

Throws:

Exception

computePresets

protected List<FlavorPresets> computePresets(Flavor flavor,
                                             List<String> flavors)

registerFlavorToThemeService

protected void registerFlavorToThemeService(Flavor flavor,
                                            RuntimeContext extensionContext)

unregisterFlavorToThemeService

protected void unregisterFlavorToThemeService(Flavor flavor)

registerResource

protected void registerResource(ResourceType resource,
                                RuntimeContext extensionContext)
                         throws Exception

Throws:

Exception

unregisterResourceToThemeService

protected void unregisterResourceToThemeService(ResourceType resource)

registerStyle

protected void registerStyle(SimpleStyle style,
                             RuntimeContext extensionContext)
                      throws Exception

Throws:

Exception

getPaletteName

protected String getPaletteName(String name,
                                String category)

getUrlFromPath

protected URL getUrlFromPath(String path,
                             RuntimeContext extensionContext)

postRegisterAllThemePageResources

protected void postRegisterAllThemePageResources()

Reload theme page resources conf according to new style

postRegisterThemePageResources

protected void postRegisterThemePageResources(ThemePage page)
                                       throws ThemeException

Register link between page and style after theme has been registered

Throws:

ThemeException

postRegisterThemePageResources

protected void postRegisterThemePageResources(String themePageName,
                                              ThemePage page,
                                              ThemePage pageApplyingToAll)
                                       throws ThemeException

Throws:

ThemeException

unRegisterThemePageResources

protected void unRegisterThemePageResources(ThemePage page)
                                     throws ThemeException

Throws:

ThemeException

unRegisterThemePageResources

protected void unRegisterThemePageResources(String themePageName,
                                            ThemePage page)
                                     throws ThemeException

Throws:

ThemeException

getDefaultFlavorName

public String getDefaultFlavorName(String themePageName)

Description copied from interface: ThemeStylingService

Returns the default flavor for a given theme page

Specified by:

getDefaultFlavorName in interface ThemeStylingService

getFlavor

public Flavor getFlavor(String flavorName)

Description copied from interface: ThemeStylingService

Returns the flavor for given name, or null if not found.

If not defined on the local flavor, flavor attributes will be resolved from the extended flavor if any (except presets that just need to be resolved at registration to the ThemeService.

Specified by:

getFlavor in interface ThemeStylingService

getLogo

public Logo getLogo(String flavorName)

Description copied from interface: ThemeStylingService

Returns the logo configured for given flavor name, and fallbacks on the extends flavor logo if not set.

Specified by:

getLogo in interface ThemeStylingService

computeLogo

protected Logo computeLogo(Flavor flavor,
                           List<String> flavors)

computePalettePreview

protected PalettePreview computePalettePreview(Flavor flavor,
                                               List<String> flavors)

getFlavorNames

public List<String> getFlavorNames(String themePageName)

Description copied from interface: ThemeStylingService

Returns the flavor names for a given theme page

Specified by:

getFlavorNames in interface ThemeStylingService

getFlavors

public List<Flavor> getFlavors(String themePageName)

Description copied from interface: ThemeStylingService

Returns the flavors for a given theme page

Specified by:

getFlavors in interface ThemeStylingService

themeRegistered

public void themeRegistered(String themeName)

Description copied from interface: ThemeStylingService

Hook to notify the service that a theme has been registered

Specified by:

themeRegistered in interface ThemeStylingService

themeGlobalResourcesRegistered

public void themeGlobalResourcesRegistered(URL themeUrl)

Description copied from interface: ThemeStylingService

Hook to notify the service that global resources for a theme need to be registered

Specified by:

themeGlobalResourcesRegistered in interface ThemeStylingService