|
Nuxeo Enterprise Platform 5.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.nuxeo.ecm.webapp.contentbrowser.ContentViewActions
@Name(value="contentViewActions") @Scope(value=CONVERSATION) public class ContentViewActions
Handles cache and refresh for named content views.
Constructor Summary | |
---|---|
ContentViewActions()
|
Method Summary | |
---|---|
ContentView |
getContentView(java.lang.String name)
|
ContentView |
getContentView(java.lang.String name,
DocumentModel searchDocumentModel)
Returns content view with given name, or null if no content view with this name is found. |
ContentView |
getContentViewWithProvider(java.lang.String name)
|
ContentView |
getContentViewWithProvider(java.lang.String name,
DocumentModel searchDocumentModel)
|
ContentView |
getContentViewWithProvider(java.lang.String name,
DocumentModel searchDocumentModel,
java.util.List<SortInfo> sortInfos,
java.lang.Long pageSize,
java.lang.Long currentPage)
|
ContentView |
getContentViewWithProvider(java.lang.String name,
DocumentModel searchDocumentModel,
java.util.List<SortInfo> sortInfos,
java.lang.Long pageSize,
java.lang.Long currentPage,
java.lang.Object... params)
|
ContentView |
getCurrentContentView()
Returns the current global content view |
java.lang.Long |
getCurrentGlobalPageSize()
Returns the global page size, or returns the page size on current content view if set. |
java.lang.Long |
getGlobalPageSize()
Returns the global page size |
void |
refresh(java.lang.String contentViewName)
|
void |
refreshAndRewind(java.lang.String contentViewName)
|
void |
refreshOnDocumentChildrenChanged()
Refreshes content views that have declared event EventNames.DOCUMENT_CHILDREN_CHANGED or
EventNames.DOCUMENT_CHANGED as a refresh event. |
void |
refreshOnSeamEvent(java.lang.String seamEventName)
Refreshes all content views that have declared the given seam event name as a refresh event in their XML configuration. |
void |
reset(java.lang.String contentViewName)
|
void |
resetAll()
|
void |
resetAllContent()
|
void |
resetPageProvider(java.lang.String contentViewName)
|
void |
resetPageProviderOnDocumentChildrenChanged()
Resets page providers for content views that have declared event EventNames.DOCUMENT_CHILDREN_CHANGED or
EventNames.DOCUMENT_CHANGED as a reset event. |
void |
resetPageProviderOnSeamEvent(java.lang.String seamEventName)
Resets all content views page providers that have declared the given seam event name as a reset event in their XML configuration. |
void |
setCurrentContentView(ContentView cv)
Sets the current global content view |
void |
setCurrentGlobalPageSize(java.lang.Long pageSize)
Sets the global page size, useful to set the value having the appropriate selection set, see getCurrentContentView() |
void |
setGlobalPageSize(java.lang.Long pageSize)
Sets the global page size |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ContentViewActions()
Method Detail |
---|
public ContentView getCurrentContentView()
public void setCurrentContentView(ContentView cv)
public java.lang.Long getCurrentGlobalPageSize()
public void setCurrentGlobalPageSize(java.lang.Long pageSize)
getCurrentContentView()
public java.lang.Long getGlobalPageSize()
public void setGlobalPageSize(java.lang.Long pageSize)
public ContentView getContentView(java.lang.String name) throws ClientException
ClientException
public ContentView getContentView(java.lang.String name, DocumentModel searchDocumentModel) throws ClientException
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).
ClientException
public ContentView getContentViewWithProvider(java.lang.String name) throws ClientException
ClientException
public ContentView getContentViewWithProvider(java.lang.String name, DocumentModel searchDocumentModel) throws ClientException
ClientException
public ContentView getContentViewWithProvider(java.lang.String name, DocumentModel searchDocumentModel, java.util.List<SortInfo> sortInfos, java.lang.Long pageSize, java.lang.Long currentPage) throws ClientException
ClientException
public ContentView getContentViewWithProvider(java.lang.String name, DocumentModel searchDocumentModel, java.util.List<SortInfo> sortInfos, java.lang.Long pageSize, java.lang.Long currentPage, java.lang.Object... params) throws ClientException
ClientException
public void refreshOnSeamEvent(java.lang.String seamEventName)
public void resetPageProviderOnSeamEvent(java.lang.String seamEventName)
@Observer(value={"documentChildrenChanged","documentChanged"}) public void refreshOnDocumentChildrenChanged()
EventNames.DOCUMENT_CHILDREN_CHANGED
or
EventNames.DOCUMENT_CHANGED
as a refresh event.
@Observer(value={"documentChildrenChanged","documentChanged"}) public void resetPageProviderOnDocumentChildrenChanged()
EventNames.DOCUMENT_CHILDREN_CHANGED
or
EventNames.DOCUMENT_CHANGED
as a reset event.
public void refresh(java.lang.String contentViewName)
public void refreshAndRewind(java.lang.String contentViewName)
public void resetPageProvider(java.lang.String contentViewName)
public void reset(java.lang.String contentViewName)
public void resetAllContent()
public void resetAll()
|
Nuxeo Enterprise Platform 5.4 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |