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

Class WidgetDefinitionRegistry

java.lang.Object

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

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

public class WidgetDefinitionRegistry
extends ContributionFragmentRegistry<WidgetDefinition>

Registry holding widget definitions (global widgets) 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
WidgetDefinitionRegistry(String category)

Method Summary

Methods

Modifier and Type	Method and Description
WidgetDefinition	clone(WidgetDefinition orig) CLone the given contribution object
void	contributionRemoved(String id, WidgetDefinition origContrib) All the fragments in the contribution was removed.
void	contributionUpdated(String id, WidgetDefinition contrib, WidgetDefinition newOrigContrib) Adds or updates a contribution.
String	getCategory()
String	getContributionId(WidgetDefinition contrib) Returns the contribution ID given the contribution object
WidgetDefinition	getWidgetDefinition(String id)
boolean	isSupportingMerge() Returns true if merge is supported.
void	merge(WidgetDefinition src, WidgetDefinition 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

WidgetDefinitionRegistry

public WidgetDefinitionRegistry(String category)

Method Detail

getCategory

public String getCategory()

getContributionId

public String getContributionId(WidgetDefinition contrib)

Description copied from class: ContributionFragmentRegistry

Returns the contribution ID given the contribution object

Specified by:

getContributionId in class ContributionFragmentRegistry<WidgetDefinition>

Returns:

contributionUpdated

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

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,
                       WidgetDefinition 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<WidgetDefinition>

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<WidgetDefinition>

clone

public WidgetDefinition clone(WidgetDefinition orig)

Description copied from class: ContributionFragmentRegistry

CLone the given contribution object

Specified by:

clone in class ContributionFragmentRegistry<WidgetDefinition>

Returns:

merge

public void merge(WidgetDefinition src,
         WidgetDefinition dst)

Description copied from class: ContributionFragmentRegistry

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

Specified by:

merge in class ContributionFragmentRegistry<WidgetDefinition>

Parameters:

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

dst - this object is modified

getWidgetDefinition

public WidgetDefinition getWidgetDefinition(String id)