Package org.nuxeo.theme.styling.service
Interface ThemeStylingService
- All Known Implementing Classes:
ThemeStylingServiceImpl
public interface ThemeStylingService
Service handling the mapping between a page and its resources and flavors.
Registers some contributions to the WebResourceManager
for compatibility.
- Since:
- 5.5
- See Also:
-
Nested Class Summary
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptiongetDefaultFlavorName
(String themePage) Returns the default flavor for a given theme pageReturns the flavor for given name, or null if not found.getFlavorNames
(String themePage) Returns the flavor names for a given theme pagegetFlavors
(String themePage) Returns the flavors for a given theme pageReturns the logo configured for given flavor name, and fallbacks on the extends flavor logo if not set.Returns the page for given name.getPages()
Rerurns all pages declared on the service, except the global one named "*".getPresetVariables
(String flavorName) Returns the map of variable replacements for given flavor.Returns the negotiated String value for given target variable.
-
Field Details
-
FLAVOR_MARKER
- See Also:
-
PAGE_STYLE_CLASS_NAME_PREFIX
- See Also:
-
PAGE_STYLE_NAME_SUFFIX
- See Also:
-
-
Method Details
-
getDefaultFlavorName
Returns the default flavor for a given theme page -
getFlavorNames
Returns the flavor names for a given theme page -
getFlavors
Returns the flavors for a given theme page -
getFlavor
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.
-
getPresetVariables
Returns the map of variable replacements for given flavor.Returns an empty map if flavor is not resolved.
- Since:
- 7.3
-
getLogo
Returns the logo configured for given flavor name, and fallbacks on the extends flavor logo if not set. -
getPage
Returns the page for given name.Resources and bundles declared for all pages will also be attached to returned page.
- Since:
- 7.4
-
getPages
List<PageDescriptor> getPages()Rerurns all pages declared on the service, except the global one named "*".Resources and bundles declared for all pages will also be attached to returned pages.
- Since:
- 7.10
-
negotiate
Returns the negotiated String value for given target variable.Context can be dependent on the target variable, depending on how this method is called/used and corresponding negotiator implementations.
- Since:
- 7.4
-