org.nuxeo.theme.styling.service.registries

Class PageRegistry

java.lang.Object

org.nuxeo.runtime.model.ContributionFragmentRegistry<PageDescriptor>

org.nuxeo.theme.styling.service.registries.PageRegistry

public class PageRegistry
extends ContributionFragmentRegistry<PageDescriptor>

Registry for theme page resources, handling merge of registered PageDescriptor elements.

Since:

5.5

Nested Class Summary

Nested classes/interfaces inherited from class org.nuxeo.runtime.model.ContributionFragmentRegistry

ContributionFragmentRegistry.Fragment<T>, ContributionFragmentRegistry.FragmentList<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,PageDescriptor>	pageResources

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

contribs

Constructor Summary

Constructors

Constructor and Description
PageRegistry()

Method Summary

Modifier and Type	Method and Description
PageDescriptor	clone(PageDescriptor orig) CLone the given contribution object
void	contributionRemoved(String id, PageDescriptor origContrib) All the fragments in the contribution was removed.
void	contributionUpdated(String id, PageDescriptor contrib, PageDescriptor newOrigContrib) Adds or updates a contribution.
PageDescriptor	getConfigurationApplyingToAll()
PageDescriptor	getConfigurationApplyingToAllThemes() Deprecated. since 7.4: use getConfigurationApplyingToAll() instead.
String	getContributionId(PageDescriptor contrib) Returns the contribution ID given the contribution object
PageDescriptor	getPage(String id)
List<String>	getPageNames() Returns all the page names.
List<PageDescriptor>	getPages()
PageDescriptor	getThemePage(String id) Deprecated. since 7.4: use getPage(String) instead.
List<PageDescriptor>	getThemePages() Deprecated. since 7.4: use getPages() instead.
void	merge(PageDescriptor src, PageDescriptor dst) Merge 'src' into 'dst'.
void	removeContribution(PageDescriptor contrib) Remove a contribution.

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

addContribution, addFragment, getContribution, getFragments, isSupportingMerge, removeContribution, removeFragment, toMap

Methods inherited from class java.lang.Object

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

Field Detail

pageResources

protected Map<String,PageDescriptor> pageResources

Constructor Detail

PageRegistry

public PageRegistry()

Method Detail

getContributionId

public String getContributionId(PageDescriptor contrib)

Description copied from class: ContributionFragmentRegistry

Returns the contribution ID given the contribution object

Specified by:

getContributionId in class ContributionFragmentRegistry<PageDescriptor>

Returns:

contributionUpdated

public void contributionUpdated(String id,
                                PageDescriptor contrib,
                                PageDescriptor newOrigContrib)

Description copied from class: ContributionFragmentRegistry

Adds or updates a contribution.

If the contribution doesn't yet exists then it will be added, otherwise the value will be updated. If the given value is null the existing contribution must be removed.

The second parameter is the contribution that should be updated when merging, as well as stored and used. This usually represents a clone of the original contribution or a merge of multiple contribution fragments. Modifications on this object at application level will be lost on next ContributionFragmentRegistry.contributionUpdated(String, Object, Object) call on the same object id: modifications should be done in the ContributionFragmentRegistry.merge(Object, Object) method.

The last parameter is the new contribution object, unchanged (original) which was neither cloned nor merged. This object should never be modified at application level, because it will be used each time a subsequent merge is done. Also, it never should be stored.

Specified by:

contributionUpdated in class ContributionFragmentRegistry<PageDescriptor>

Parameters:

id - - the id of the contribution that needs to be updated

contrib - the updated contribution object that

newOrigContrib - - the new, unchanged (original) contribution fragment that triggered the update.

removeContribution

public void removeContribution(PageDescriptor contrib)

Description copied from class: ContributionFragmentRegistry

Remove a contribution. This will uninstall the contribution and notify the implementation about the new value it should store (after re-merging contribution fragments).

Uses standard equality to check for old objects (useEqualsMethod == false).

Overrides:

removeContribution in class ContributionFragmentRegistry<PageDescriptor>

See Also:

ContributionFragmentRegistry.removeContribution(Object, boolean)

contributionRemoved

public void contributionRemoved(String id,
                                PageDescriptor origContrib)

Description copied from class: ContributionFragmentRegistry

All the fragments in the contribution was removed. Contribution must be unregistered.

The first parameter is the contribution ID that should be remove and the second parameter the original contribution fragment that as unregistered causing the contribution to be removed.

Specified by:

contributionRemoved in class ContributionFragmentRegistry<PageDescriptor>

clone

public PageDescriptor clone(PageDescriptor orig)

Description copied from class: ContributionFragmentRegistry

CLone the given contribution object

Specified by:

clone in class ContributionFragmentRegistry<PageDescriptor>

Returns:

merge

public void merge(PageDescriptor src,
                  PageDescriptor dst)

Description copied from class: ContributionFragmentRegistry

Merge 'src' into 'dst'. When merging only the 'dst' object is modified.

Specified by:

merge in class ContributionFragmentRegistry<PageDescriptor>

Parameters:

src - the object to copy over the 'dst' object

dst - this object is modified

getPage

public PageDescriptor getPage(String id)

getThemePage

@Deprecated
public PageDescriptor getThemePage(String id)

Deprecated. since 7.4: use getPage(String) instead.

getPages

public List<PageDescriptor> getPages()

getPageNames

public List<String> getPageNames()

Returns all the page names.

Since:

7.10

getThemePages

@Deprecated
public List<PageDescriptor> getThemePages()

Deprecated. since 7.4: use getPages() instead.

getConfigurationApplyingToAll

public PageDescriptor getConfigurationApplyingToAll()

getConfigurationApplyingToAllThemes

public PageDescriptor getConfigurationApplyingToAllThemes()

Deprecated. since 7.4: use getConfigurationApplyingToAll() instead.