@Name(value="contentViewActions") @Scope(value=CONVERSATION) public class ContentViewActions extends Object implements Serializable
Constructor and Description |
---|
ContentViewActions() |
Modifier and Type | Method and Description |
---|---|
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 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
|
void |
refresh(String contentViewName) |
void |
refreshAndRewind(String contentViewName) |
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 |
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.
|
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
|
public ContentView getCurrentContentView()
public void setCurrentContentView(ContentView cv)
public Long getCurrentGlobalPageSize()
public void setCurrentGlobalPageSize(Long pageSize)
getCurrentContentView()
public Long getGlobalPageSize()
public void setGlobalPageSize(Long pageSize)
public ContentView getContentView(String name) throws ClientException
ClientException
public ContentView getContentView(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(String name) throws ClientException
ClientException
public ContentView getContentViewWithProvider(String name, DocumentModel searchDocumentModel) throws ClientException
ClientException
public ContentView getContentViewWithProvider(String name, DocumentModel searchDocumentModel, List<SortInfo> sortInfos, Long pageSize, Long currentPage) throws ClientException
ClientException
public ContentView getContentViewWithProvider(String name, DocumentModel searchDocumentModel, List<SortInfo> sortInfos, Long pageSize, Long currentPage, Object... params) throws ClientException
ClientException
public void refreshOnSeamEvent(String seamEventName)
public void resetPageProviderOnSeamEvent(String seamEventName)
public void refresh(String contentViewName)
public void refreshAndRewind(String contentViewName)
public void resetPageProvider(String contentViewName)
public void reset(String contentViewName)
public void resetAllContent()
public void resetAll()
Copyright © 2011 Nuxeo SA. All Rights Reserved.