org.nuxeo.ecm.webapp.tree.nav

Class NavTreeRegistry

java.lang.Object

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

org.nuxeo.runtime.model.SimpleContributionRegistry<NavTreeDescriptor>

org.nuxeo.ecm.webapp.tree.nav.NavTreeRegistry

public class NavTreeRegistry
extends SimpleContributionRegistry<NavTreeDescriptor>

Registry for nav trees.

Moved from module nuxeo-platform-virtual-navigation-web, originally added in 5.6.

Since:

6.0

Nested Class Summary

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

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

Constructor Summary

Constructors

Constructor and Description
NavTreeRegistry()

Method Summary

Methods

Modifier and Type	Method and Description
void	contributionUpdated(String id, NavTreeDescriptor contrib, NavTreeDescriptor newOrigContrib) Adds or updates a contribution.
String	getContributionId(NavTreeDescriptor contrib) Returns the contribution ID given the contribution object
List<NavTreeDescriptor>	getTreeDescriptors(DirectoryTreeService directoryTreeService)

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

clone, contributionRemoved, isSupportingMerge, merge

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

addContribution, getFragments, removeContribution, removeContribution

Methods inherited from class java.lang.Object

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

Constructor Detail

NavTreeRegistry

public NavTreeRegistry()

Method Detail

getContributionId

public String getContributionId(NavTreeDescriptor contrib)

Description copied from class: ContributionFragmentRegistry

Returns the contribution ID given the contribution object

Specified by:

getContributionId in class ContributionFragmentRegistry<NavTreeDescriptor>

Returns:

contributionUpdated

public void contributionUpdated(String id,
                       NavTreeDescriptor contrib,
                       NavTreeDescriptor 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.

Overrides:

contributionUpdated in class SimpleContributionRegistry<NavTreeDescriptor>

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.

getTreeDescriptors

public List<NavTreeDescriptor> getTreeDescriptors(DirectoryTreeService directoryTreeService)