public class PageRegistry extends ContributionFragmentRegistry<PageDescriptor>
PageDescriptor
elements.ContributionFragmentRegistry.Fragment<T>, ContributionFragmentRegistry.FragmentList<T>
Modifier and Type | Field and Description |
---|---|
protected Map<String,PageDescriptor> |
pageResources |
contribs
Constructor and Description |
---|
PageRegistry() |
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.
|
addContribution, addFragment, getContribution, getFragments, isSupportingMerge, removeContribution, removeFragment, toMap
protected Map<String,PageDescriptor> pageResources
public PageRegistry()
public String getContributionId(PageDescriptor contrib)
ContributionFragmentRegistry
getContributionId
in class ContributionFragmentRegistry<PageDescriptor>
public void contributionUpdated(String id, PageDescriptor contrib, PageDescriptor newOrigContrib)
ContributionFragmentRegistry
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.
contributionUpdated
in class ContributionFragmentRegistry<PageDescriptor>
id
- - the id of the contribution that needs to be updatedcontrib
- the updated contribution object thatnewOrigContrib
- - the new, unchanged (original) contribution fragment that triggered the update.public void removeContribution(PageDescriptor contrib)
ContributionFragmentRegistry
Uses standard equality to check for old objects (useEqualsMethod == false).
removeContribution
in class ContributionFragmentRegistry<PageDescriptor>
ContributionFragmentRegistry.removeContribution(Object, boolean)
public void contributionRemoved(String id, PageDescriptor origContrib)
ContributionFragmentRegistry
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.
contributionRemoved
in class ContributionFragmentRegistry<PageDescriptor>
public PageDescriptor clone(PageDescriptor orig)
ContributionFragmentRegistry
clone
in class ContributionFragmentRegistry<PageDescriptor>
public void merge(PageDescriptor src, PageDescriptor dst)
ContributionFragmentRegistry
merge
in class ContributionFragmentRegistry<PageDescriptor>
src
- the object to copy over the 'dst' objectdst
- this object is modifiedpublic PageDescriptor getPage(String id)
@Deprecated public PageDescriptor getThemePage(String id)
getPage(String)
instead.public List<PageDescriptor> getPages()
public List<String> getPageNames()
@Deprecated public List<PageDescriptor> getThemePages()
getPages()
instead.public PageDescriptor getConfigurationApplyingToAll()
public PageDescriptor getConfigurationApplyingToAllThemes()
getConfigurationApplyingToAll()
instead.Copyright © 2018 Nuxeo. All rights reserved.