org.nuxeo.ecm.platform.contentview.seam

Class ContentViewActions

java.lang.Object

org.nuxeo.ecm.platform.contentview.seam.ContentViewActions

All Implemented Interfaces:

Serializable

@Name(value="contentViewActions")
 @Scope(value=CONVERSATION)
public class ContentViewActions
extends Object
implements Serializable

Handles cache and refresh for named content views.

Since:

5.4, 5.4.2: moved to content-view-jsf module

Author:

Anahide Tchertchian

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected ContentViewCache	cache
protected ContentViewRestActions	contentViewRestActions
protected ContentViewService	contentViewService
protected ContentView	currentContentView
protected Long	globalPageSize
protected WebActions	webActions

Constructor Summary

Constructors

Constructor and Description
ContentViewActions()

Method Summary

Modifier and Type	Method and Description
protected ActionContext	createContentViewActionContext(DocumentModel currentDocument, ContentView contentView, Object showPageSizeSelector, Object showRefreshCommand, Object showCSVExport, Object showPDFExport, Object showSyndicationLinks, Object showSlideshow, Object showEditColumns, Object showEditRows, Object showSpreadsheet)
List<Action>	getActionsList(String category, DocumentModel currentDocument, ContentView contentView, Object showPageSizeSelector, Object showRefreshCommand, Object showCSVExport, Object showPDFExport, Object showSyndicationLinks, Object showSlideshow, Object showEditColumns, Object showEditRows, Object showSpreadsheet) Returns actions filtered depending on given custom context.
ContentView	getContentView(String name)
ContentView	getContentView(String name, DocumentModel searchDocumentModel) Returns content view with given name, or null if no content view with this name is found.
ContentView	getContentViewWithProvider(String name)
ContentView	getContentViewWithProvider(String name, DocumentModel searchDocumentModel)
ContentView	getContentViewWithProvider(String name, DocumentModel searchDocumentModel, List<SortInfo> sortInfos, Long pageSize, Long currentPage)
ContentView	getContentViewWithProvider(String name, DocumentModel searchDocumentModel, List<SortInfo> sortInfos, Long defaultPageSize, Long pageSize, Long currentPage)
protected ContentView	getContentViewWithProvider(String name, DocumentModel searchDocumentModel, List<SortInfo> sortInfos, Long defaultPageSize, Long pageSize, Long currentPage, Object... params) Helper method to retrieve a content view, taking care of initialization of page provider according to parameters and current global page size.
ContentView	getContentViewWithProvider(String name, DocumentModel searchDocumentModel, List<SortInfo> sortInfos, Long pageSize, Long currentPage, Object... params)
ContentView	getCurrentContentView() Returns the current global content view.
Long	getCurrentGlobalPageSize() Returns the global page size, or returns the page size on current content view if set.
Long	getGlobalPageSize() Returns the global page size
List<javax.faces.model.SelectItem>	getPageSizeOptions(ContentView cv) Returns the list of available options for page size selections, for given content view.
void	refresh(String contentViewName)
void	refreshAll()
void	refreshAndRewind(String contentViewName)
void	refreshAndRewindAll()
void	refreshOnSeamEvent(String seamEventName) Refreshes all content views that have declared the given seam event name as a refresh event in their XML configuration.
void	reset(String contentViewName)
void	resetAggregates(String contentViewName)
void	resetAll()
void	resetAllContent()
void	resetPageProvider(String contentViewName)
void	resetPageProviderOnSeamEvent(String seamEventName) Resets all content views page providers that have declared the given seam event name as a reset event in their XML configuration.
ContentView	restoreContentView(ContentViewState state) Restore a Content View from the given ContentView state.
ContentView	restoreContentView(String contentViewName, Long currentPage, Long pageSize, List<SortInfo> sortInfos, String jsonContentViewState) Restore a content view from the given parameters.
void	setCurrentContentView(ContentView cv) Sets the current global content view.
void	setCurrentGlobalPageSize(Long pageSize) Sets the global page size, useful to set the value having the appropriate selection set, see getCurrentContentView()
void	setGlobalPageSize(Long pageSize) Sets the global page size

Methods inherited from class java.lang.Object

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

Field Detail

contentViewRestActions

@In(create=true)
protected ContentViewRestActions contentViewRestActions

contentViewService

@In(create=true)
protected ContentViewService contentViewService

cache

protected final ContentViewCache cache

globalPageSize

protected Long globalPageSize

webActions

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

currentContentView

protected ContentView currentContentView

Constructor Detail

ContentViewActions

public ContentViewActions()

Method Detail

getCurrentContentView

public ContentView getCurrentContentView()

Returns the current global content view.

Current content view is usually the last one displayed on the page, but this may change depending on calls to setCurrentContentView(ContentView).

setCurrentContentView

public void setCurrentContentView(ContentView cv)

Sets the current global content view.

See Also:

getCurrentGlobalPageSize()

getCurrentGlobalPageSize

public Long getCurrentGlobalPageSize()

Returns the global page size, or returns the page size on current content view if set.

setCurrentGlobalPageSize

public void setCurrentGlobalPageSize(Long pageSize)

Sets the global page size, useful to set the value having the appropriate selection set, see getCurrentContentView()

getGlobalPageSize

public Long getGlobalPageSize()

Returns the global page size

getPageSizeOptions

public List<javax.faces.model.SelectItem> getPageSizeOptions(ContentView cv)

Returns the list of available options for page size selections, for given content view.

This method relies on a hard-coded set of available values, and adapts it to the current content view page size and max page size information to present more or less items from this list.

Since:

5.8

setGlobalPageSize

public void setGlobalPageSize(Long pageSize)

Sets the global page size

getContentView

public ContentView getContentView(String name)

getContentView

public ContentView getContentView(String name,
                                  DocumentModel searchDocumentModel)

Returns content view with given name, or null if no content view with this name is found.

If parameter searchDocumentModel is not null, it will be set on the content view. If it is null and the content is using a provider that needs it, a new document model is created and attached to it. This document model is resolved from the binding put in the content view XML definition, or from the document type in this definition if no binding is set.

If not null, this content view is set as the current content view so that subsequent calls to other methods can take information from it, like getCurrentGlobalPageSize()

The content view is put in a cache map so that it's not rebuilt at each call. It is rebuilt when its cache key changes (if defined).

getContentViewWithProvider

public ContentView getContentViewWithProvider(String name)

getContentViewWithProvider

public ContentView getContentViewWithProvider(String name,
                                              DocumentModel searchDocumentModel)

getContentViewWithProvider

public ContentView getContentViewWithProvider(String name,
                                              DocumentModel searchDocumentModel,
                                              List<SortInfo> sortInfos,
                                              Long pageSize,
                                              Long currentPage)

getContentViewWithProvider

public ContentView getContentViewWithProvider(String name,
                                              DocumentModel searchDocumentModel,
                                              List<SortInfo> sortInfos,
                                              Long defaultPageSize,
                                              Long pageSize,
                                              Long currentPage)

getContentViewWithProvider

public ContentView getContentViewWithProvider(String name,
                                              DocumentModel searchDocumentModel,
                                              List<SortInfo> sortInfos,
                                              Long pageSize,
                                              Long currentPage,
                                              Object... params)

Since:

5.6

getContentViewWithProvider

protected ContentView getContentViewWithProvider(String name,
                                                 DocumentModel searchDocumentModel,
                                                 List<SortInfo> sortInfos,
                                                 Long defaultPageSize,
                                                 Long pageSize,
                                                 Long currentPage,
                                                 Object... params)

Helper method to retrieve a content view, taking care of initialization of page provider according to parameters and current global page size.

This method is not public to avoid EL method resolution issues.

restoreContentView

public ContentView restoreContentView(String contentViewName,
                                      Long currentPage,
                                      Long pageSize,
                                      List<SortInfo> sortInfos,
                                      String jsonContentViewState)
                               throws UnsupportedEncodingException

Restore a content view from the given parameters.

The content view is put in a cache map so that it's not rebuilt at each call. It is rebuilt when its cache key changes (if defined).

Throws:

UnsupportedEncodingException

Since:

5.7

restoreContentView

public ContentView restoreContentView(ContentViewState state)
                               throws UnsupportedEncodingException

Restore a Content View from the given ContentView state.

The content view is put in a cache map so that it's not rebuilt at each call. It is rebuilt when its cache key changes (if defined).

Throws:

UnsupportedEncodingException

Since:

6.0

refreshOnSeamEvent

@BypassInterceptors
public void refreshOnSeamEvent(String seamEventName)

Refreshes all content views that have declared the given seam event name as a refresh event in their XML configuration.

resetPageProviderOnSeamEvent

@BypassInterceptors
public void resetPageProviderOnSeamEvent(String seamEventName)

Resets all content views page providers that have declared the given seam event name as a reset event in their XML configuration.

refresh

@BypassInterceptors
public void refresh(String contentViewName)

refreshAndRewind

@BypassInterceptors
public void refreshAndRewind(String contentViewName)

resetAggregates

@BypassInterceptors
public void resetAggregates(String contentViewName)

Since:

6.0

resetPageProvider

@BypassInterceptors
public void resetPageProvider(String contentViewName)

reset

@BypassInterceptors
public void reset(String contentViewName)

resetAllContent

@BypassInterceptors
public void resetAllContent()

resetAll

@BypassInterceptors
public void resetAll()

refreshAll

@BypassInterceptors
public void refreshAll()

Since:

5.7

refreshAndRewindAll

@BypassInterceptors
public void refreshAndRewindAll()

Since:

5.7

getActionsList

public List<Action> getActionsList(String category,
                                   DocumentModel currentDocument,
                                   ContentView contentView,
                                   Object showPageSizeSelector,
                                   Object showRefreshCommand,
                                   Object showCSVExport,
                                   Object showPDFExport,
                                   Object showSyndicationLinks,
                                   Object showSlideshow,
                                   Object showEditColumns,
                                   Object showEditRows,
                                   Object showSpreadsheet)

Returns actions filtered depending on given custom context.

Boolean values are declared as objects to avoid conversion to "false" when variable is not defined, and keep "null" value.

Since:

6.0

createContentViewActionContext

protected ActionContext createContentViewActionContext(DocumentModel currentDocument,
                                                       ContentView contentView,
                                                       Object showPageSizeSelector,
                                                       Object showRefreshCommand,
                                                       Object showCSVExport,
                                                       Object showPDFExport,
                                                       Object showSyndicationLinks,
                                                       Object showSlideshow,
                                                       Object showEditColumns,
                                                       Object showEditRows,
                                                       Object showSpreadsheet)