org.nuxeo.ecm.platform.forms.layout.core.registries

Class LayoutDefinitionRegistry

java.lang.Object

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

org.nuxeo.ecm.platform.forms.layout.core.registries.LayoutDefinitionRegistry

public class LayoutDefinitionRegistry
extends ContributionFragmentRegistry<LayoutDefinition>

Registry holding layout definitions for a given category

Since:

5.5

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
LayoutDefinitionRegistry(String category)

Method Summary

Methods

Modifier and Type	Method and Description
LayoutDefinition	clone(LayoutDefinition orig) CLone the given contribution object
void	contributionRemoved(String id, LayoutDefinition origContrib) All the fragments in the contribution was removed.
void	contributionUpdated(String id, LayoutDefinition contrib, LayoutDefinition newOrigContrib) Adds or updates a contribution.
String	getCategory()
String	getContributionId(LayoutDefinition contrib) Returns the contribution ID given the contribution object
LayoutDefinition	getLayoutDefinition(String id)
List<String>	getLayoutNames()
boolean	isSupportingMerge() Returns true if merge is supported.
void	merge(LayoutDefinition src, LayoutDefinition dst) Merge 'src' into 'dst'.

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

addContribution, getFragments, removeContribution

Methods inherited from class java.lang.Object

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

Constructor Detail

LayoutDefinitionRegistry

public LayoutDefinitionRegistry(String category)

Method Detail

getCategory

public String getCategory()

getLayoutNames

public List<String> getLayoutNames()

getContributionId

public String getContributionId(LayoutDefinition contrib)

Description copied from class: ContributionFragmentRegistry

Returns the contribution ID given the contribution object

Specified by:

getContributionId in class ContributionFragmentRegistry<LayoutDefinition>

Returns:

contributionUpdated

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

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.

contributionRemoved

public void contributionRemoved(String id,
                       LayoutDefinition 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<LayoutDefinition>

isSupportingMerge

public boolean isSupportingMerge()

Description copied from class: ContributionFragmentRegistry

Returns true if merge is supported.

Hook method to be overridden if merge logics behind Object.clone() and ContributionFragmentRegistry.merge(Object, Object) cannot be implemented.

Overrides:

isSupportingMerge in class ContributionFragmentRegistry<LayoutDefinition>

clone

public LayoutDefinition clone(LayoutDefinition orig)

Description copied from class: ContributionFragmentRegistry

CLone the given contribution object

Specified by:

clone in class ContributionFragmentRegistry<LayoutDefinition>

Returns:

merge

public void merge(LayoutDefinition src,
         LayoutDefinition dst)

Description copied from class: ContributionFragmentRegistry

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

Specified by:

merge in class ContributionFragmentRegistry<LayoutDefinition>

Parameters:

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

dst - this object is modified

getLayoutDefinition

public LayoutDefinition getLayoutDefinition(String id)