org.nuxeo.theme.styling.service

Interface ThemeStylingService

All Known Implementing Classes:

ThemeStylingServiceImpl

public interface ThemeStylingService

Service handling the mapping between a theme page and its resources (styling and flavors)

Registers corresponding contributions to the ThemeService so that styling of the page is handled as if styling was provided by the theme definition. Also handles related flavors as theme collections.

Since:

5.5

See Also:

Flavor

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ThemeStylingService.PRESET_CATEGORY

Field Summary

Fields

Modifier and Type	Field and Description
static String	FLAVOR_MARKER
static String	PAGE_STYLE_CLASS_NAME_PREFIX
static String	PAGE_STYLE_NAME_SUFFIX

Method Summary

Methods

Modifier and Type	Method and Description
String	getDefaultFlavorName(String themePage) 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 themePage) Returns the flavor names for a given theme page
List<Flavor>	getFlavors(String themePage) Returns the flavors for a given theme page
Logo	getLogo(String flavor) Returns the logo configured for given flavor name, and fallbacks on the extends flavor logo if not set.
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

Field Detail

FLAVOR_MARKER

static final String FLAVOR_MARKER

See Also:

Constant Field Values

PAGE_STYLE_CLASS_NAME_PREFIX

static final String PAGE_STYLE_CLASS_NAME_PREFIX

See Also:

Constant Field Values

PAGE_STYLE_NAME_SUFFIX

static final String PAGE_STYLE_NAME_SUFFIX

See Also:

Constant Field Values

Method Detail

getDefaultFlavorName

String getDefaultFlavorName(String themePage)

Returns the default flavor for a given theme page

getFlavorNames

List<String> getFlavorNames(String themePage)

Returns the flavor names for a given theme page

getFlavors

List<Flavor> getFlavors(String themePage)

Returns the flavors for a given theme page

getFlavor

Flavor getFlavor(String flavorName)

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.

Parameters:

flavorName -

getLogo

Logo getLogo(String flavor)

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

Parameters:

flavor -

themeRegistered

void themeRegistered(String themeName)

Hook to notify the service that a theme has been registered

Parameters:

themeName -

themeGlobalResourcesRegistered

void themeGlobalResourcesRegistered(URL themeUrl)

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

Parameters:

themeUrl -