org.nuxeo.ecm.webapp.contentbrowser

Class DocumentContentViewActions

java.lang.Object

org.nuxeo.ecm.webapp.contentbrowser.DocumentContentViewActions

All Implemented Interfaces:

Serializable

@Name(value="documentContentViewActions")
 @Scope(value=CONVERSATION)
public class DocumentContentViewActions
extends Object
implements Serializable

Handles available content views defined on a document type per category, as well as helper methods to retrieve selection actions for a given content view.

Since:

5.4

Author:

Anahide Tchertchian

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ActionContextProvider	actionContextProvider
protected ContentViewService	contentViewService
protected Map<String,List<ContentViewHeader>>	currentAvailableContentViews
protected Map<String,List<ContentViewHeader>>	currentExportContentViews
protected NavigationContext	navigationContext
protected Map<String,Map<String,List<ContentViewHeader>>>	typeToContentView Map caching content views defined on a given document type
protected Map<String,Map<String,List<ContentViewHeader>>>	typeToExportContentView Map caching content views shown in export defined on a given document type
protected WebActions	webActions

Constructor Summary

Constructors

Constructor and Description
DocumentContentViewActions()

Method Summary

Modifier and Type	Method and Description
void	documentChanged()
Map<String,List<ContentViewHeader>>	getAvailableContentViewsForCurrentDocument()
List<ContentViewHeader>	getAvailableContentViewsForCurrentDocument(String category)
Map<String,List<ContentViewHeader>>	getAvailableContentViewsForDocument(DocumentModel doc)
List<ContentViewHeader>	getAvailableContentViewsForDocument(DocumentModel doc, String category)
protected Map<String,List<ContentViewHeader>>	getContentViewHeaders(TypeInfo typeInfo, boolean export)
Map<String,List<ContentViewHeader>>	getExportContentViewsForCurrentDocument()
List<ContentViewHeader>	getExportContentViewsForCurrentDocument(String category)
Map<String,List<ContentViewHeader>>	getExportContentViewsForDocument(DocumentModel doc)
List<ContentViewHeader>	getLocalConfiguredContentViews(DocumentModel doc)
List<Action>	getSelectionActions(String category, ContentView contentView, List<Object> selectedEntries) Helper to retrieve selection actions for a given content view, passing additional variables to the ActionContext used for resolution.
boolean	hasContentViewSupport(DocumentModel doc, String category) Returns true if content views are defined on given document for given category.
void	onHotReloadFlush() Resets typeToContentView cache on EventNames.FLUSH_EVENT, triggered by hot reload when dev mode is set.
protected void	retrieveContentViewHeaders(DocumentModel doc)
protected void	retrieveExportContentViewHeaders(DocumentModel doc)

Methods inherited from class java.lang.Object

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

Field Detail

navigationContext

@In(create=true,
    required=false)
protected transient NavigationContext navigationContext

webActions

@In(create=true,
    required=false)
protected transient WebActions webActions

actionContextProvider

@In(create=true,
    required=false)
protected transient ActionContextProvider actionContextProvider

contentViewService

@In(create=true)
protected ContentViewService contentViewService

typeToContentView

protected Map<String,Map<String,List<ContentViewHeader>>> typeToContentView

Map caching content views defined on a given document type

currentAvailableContentViews

protected Map<String,List<ContentViewHeader>> currentAvailableContentViews

typeToExportContentView

protected Map<String,Map<String,List<ContentViewHeader>>> typeToExportContentView

Map caching content views shown in export defined on a given document type

currentExportContentViews

protected Map<String,List<ContentViewHeader>> currentExportContentViews

Constructor Detail

DocumentContentViewActions

public DocumentContentViewActions()

Method Detail

getContentViewHeaders

protected Map<String,List<ContentViewHeader>> getContentViewHeaders(TypeInfo typeInfo,
                                                                    boolean export)

retrieveContentViewHeaders

protected void retrieveContentViewHeaders(DocumentModel doc)

retrieveExportContentViewHeaders

protected void retrieveExportContentViewHeaders(DocumentModel doc)

hasContentViewSupport

public boolean hasContentViewSupport(DocumentModel doc,
                                     String category)

Returns true if content views are defined on given document for given category.

Also fetches content view headers defined on a document type

getAvailableContentViewsForDocument

public Map<String,List<ContentViewHeader>> getAvailableContentViewsForDocument(DocumentModel doc)

getAvailableContentViewsForDocument

public List<ContentViewHeader> getAvailableContentViewsForDocument(DocumentModel doc,
                                                                   String category)

getAvailableContentViewsForCurrentDocument

public Map<String,List<ContentViewHeader>> getAvailableContentViewsForCurrentDocument()

getAvailableContentViewsForCurrentDocument

public List<ContentViewHeader> getAvailableContentViewsForCurrentDocument(String category)

getLocalConfiguredContentViews

public List<ContentViewHeader> getLocalConfiguredContentViews(DocumentModel doc)

getExportContentViewsForDocument

public Map<String,List<ContentViewHeader>> getExportContentViewsForDocument(DocumentModel doc)

getExportContentViewsForCurrentDocument

public Map<String,List<ContentViewHeader>> getExportContentViewsForCurrentDocument()

getExportContentViewsForCurrentDocument

public List<ContentViewHeader> getExportContentViewsForCurrentDocument(String category)

documentChanged

@Observer(value="userAllDocumentTypesSelectionChanged",
          create=false)
 @BypassInterceptors
public void documentChanged()

onHotReloadFlush

@Observer(value="flush")
 @BypassInterceptors
public void onHotReloadFlush()

Resets typeToContentView cache on EventNames.FLUSH_EVENT, triggered by hot reload when dev mode is set.

Since:

5.7.1

getSelectionActions

public List<Action> getSelectionActions(String category,
                                        ContentView contentView,
                                        List<Object> selectedEntries)

Helper to retrieve selection actions for a given content view, passing additional variables to the ActionContext used for resolution.

Parameters:

category -

contentView -

selectedEntries -

Since:

2.17