ContentViewImpl (Nuxeo ECM Projects 8.10-SNAPSHOT API)

java.lang.Object
- org.nuxeo.ecm.platform.contentview.jsf.ContentViewImpl

All Implemented Interfaces:

Serializable, ContentView, PageProviderChangedListener
```
public class ContentViewImpl
extends Object
implements ContentView, PageProviderChangedListener
```
Default implementation for the content view object.
Provides simple getters for attributes defined in the XMap descriptor, except cache key which is computed from currrent FacesContext instance if cache key is an EL expression.
The page provider is initialized calling ContentViewService.getPageProvider(java.lang.String, java.util.List<org.nuxeo.ecm.core.api.SortInfo>, java.lang.Long, java.lang.Long, org.nuxeo.ecm.core.api.DocumentModel, java.lang.Object...).

Since:

5.4

Author:

Anahide Tchertchian

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<String>`	`actionCategories`
`protected String`	`cacheKey`
`protected Integer`	`cacheSize`
`protected Long`	`currentPageSize`
`protected ContentViewLayout`	`currentResultLayout`
`protected List<String>`	`currentResultLayoutColumns`
`protected boolean`	`currentResultLayoutSet`
`protected String`	`emptySentence`
`protected boolean`	`executed`
`protected List<String>`	`flags`
`protected String`	`iconPath`
`protected String`	`name`
`protected PageProvider<?>`	`pageProvider`
`protected String`	`pageSizeBinding`
`protected String`	`pagination`
`protected String[]`	`queryParameters`
`protected List<QuickFilter>`	`quickFilters`
`protected List<String>`	`refreshEventNames`
`protected List<String>`	`resetEventNames`
`protected String`	`resultColumnsBinding`
`protected String`	`resultLayoutBinding`
`protected List<ContentViewLayout>`	`resultLayouts`
`protected DocumentModel`	`searchDocumentModel`
`protected String`	`searchDocumentModelBinding`
`protected String`	`searchDocumentModelType`
`protected ContentViewLayout`	`searchLayout`
`protected String`	`selectionList`
`protected boolean`	`showFilterForm`
`protected boolean`	`showPageSizeSelector`
`protected boolean`	`showRefreshCommand`
`protected boolean`	`showTitle`
`protected String`	`sortInfosBinding`
`protected String`	`title`
`protected boolean`	`translateEmptySentence`
`protected boolean`	`translateTitle`
`protected boolean`	`useGlobalPageSize`
`protected boolean`	`waitForExecution`
`protected String`	`waitForExecutionSentence`

Fields inherited from interface org.nuxeo.ecm.platform.contentview.jsf.ContentView
CONTENT_VIEW_PAGE_CHANGED_EVENT, CONTENT_VIEW_PAGE_SIZE_CHANGED_EVENT, CONTENT_VIEW_REFRESH_EVENT, SEARCH_DOCUMENT_EL_VARIABLE

Constructor Summary

Constructors
Constructor and Description
ContentViewImpl(String name, String title, boolean translateTitle, String iconPath, String selectionList, String pagination, List<String> actionCategories, ContentViewLayout searchLayout, List<ContentViewLayout> resultLayouts, List<String> flags, String cacheKey, Integer cacheSize, List<String> refreshEventNames, List<String> resetEventNames, boolean useGlobalPageSize, String[] queryParameters, String searchDocumentModelBinding, String searchDocumentModelType, String resultColumnsBinding, String resultLayoutBinding, String sortInfosBinding, String pageSizeBinding, boolean showTitle, boolean showPageSizeSelector, boolean showRefreshCommand, boolean showFilterForm, String emptySentence, boolean translateEmptySentence)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected Object`	`addSearchDocumentToELContext(javax.faces.context.FacesContext facesContext)`
`List<String>`	`getActionsCategories()` Returns the list of action categories to display buttons available on selection of items.
`String`	`getCacheKey()` Returns the cache key for this content view provider, resolving from the current `FacesContext` instance if it's an EL expression.
`Integer`	`getCacheSize()` Returns the cache size for this content view.
`PageProvider<?>`	`getCurrentPageProvider()` Returns the current page provider, or null if methods `ContentView.getPageProvider()`, `ContentView.getPageProvider(DocumentModel, List, Long, Long, Object...)` or `ContentView.getPageProviderWithParams(Object...)` were never called before.
`Long`	`getCurrentPageSize()` Returns the current page size, as set using `ContentView.setCurrentPageSize(Long)`, or the page size set on current page provider if not null.
`ContentViewLayout`	`getCurrentResultLayout()` Returns the current result layout, as set using `ContentView.setCurrentResultLayout(ContentViewLayout)`, or the first of defined result layouts when not set.
`List<String>`	`getCurrentResultLayoutColumns()` Returns the list of selected result layout columns, resolving the bound EL expression set in the content view definition if columns where not explicitely set with `ContentView.setCurrentResultLayoutColumns(List)`.
`String`	`getEmptySentence()` Returns a sentence to display when this content view is empty
`List<String>`	`getFlags()` Returns the list of flags set on this content view, useful to group them, see `ContentViewService.getContentViewNames(String)`
`String`	`getIconPath()` Returns the icon relative path for this content view.
`String`	`getName()` Returns the name of this content view
`PageProvider<?>`	`getPageProvider()` Gets page provider according to given parameters
`PageProvider<?>`	`getPageProvider(DocumentModel searchDocument, List<SortInfo> sortInfos, Long pageSize, Long currentPage, Object... params)` Returns cached page provider if it exists or build a new one if parameters have changed.
`PageProvider<?>`	`getPageProviderWithParams(Object... params)` Gets page provider according to given parameters
`String`	`getPagination()` Returns the pagination type to be used in pagination rendering
`Object[]`	`getQueryParameters()` Returns the query parameters for this content view provider provider, resolving from the current `FacesContext` instance if they are EL expressions.
`List<QuickFilter>`	`getQuickFilters()`
`List<String>`	`getRefreshEventNames()` Returns the list of event names that should trigger a refresh of this content view page provider.
`List<String>`	`getResetEventNames()` Returns the list of event names that should trigger a reset of this content view page provider.
`List<String>`	`getResultLayoutColumns()`
`List<ContentViewLayout>`	`getResultLayouts()` Returns the result layouts, used to display results.
`DocumentModel`	`getSearchDocumentModel()` Returns the search document model as set on the content view.
`String`	`getSearchDocumentModelType()` Returns the search document model type as defined in the XML configuration.
`ContentViewLayout`	`getSearchLayout()` Returns the search layout, used to filter results.
`String`	`getSelectionListName()` Returns the selection list name
`boolean`	`getShowFilterForm()` Returns true is the filter form should be displayed.
`boolean`	`getShowPageSizeSelector()` Returns true is the page size selector should be displayed.
`boolean`	`getShowRefreshCommand()` Returns true is the refresh command should be displayed.
`boolean`	`getShowTitle()` Returns true is the title should be displayed before the result layout selector.
`String`	`getTitle()` Returns a title for this content view
`boolean`	`getTranslateEmptySentence()` Returns a boolean stating if sentence to display is empty has to be translated
`boolean`	`getTranslateTitle()` Returns a boolean stating if title has to be translated
`boolean`	`getUseGlobalPageSize()` Returns true is this content view can use the global page size set on the application.
`String`	`getWaitForExecutionSentence()` Returns the sentence to display when content view is waiting for a first execution.
`boolean`	`hasResultLayoutBinding()`
`boolean`	`hasResultLayoutColumnsBinding()`
`boolean`	`isExecuted()` Returns true if content view has been executed.
`boolean`	`isWaitForExecution()` Returns true if content view will not display results until an explicit search is executed.
`void`	`pageChanged(PageProvider<?> pageProvider)` Called when the current page of the `pageProvider` has changed.
`protected void`	`raiseEvent(String eventName)`
`protected void`	`raiseEvent(String eventName, Object... params)`
`void`	`refreshAndRewindPageProvider()` Refreshes the current page provider if not null, see `PageProvider.refresh()`, and resets the current page to the first one.
`void`	`refreshed(PageProvider<?> pageProvider)` Called when the `pageProvider` has refreshed.
`void`	`refreshPageProvider()` Refreshes the current page provider if not null, see `PageProvider.refresh()`.
`protected void`	`removeSearchDocumentFromELContext(javax.faces.context.FacesContext facesContext, Object previousValue)`
`void`	`resetPageProvider()` Resets the page provider.
`void`	`resetPageProviderAggregates()` Reset the page provider aggregates.
`void`	`resetSearchDocumentModel()` Resets the search document model, setting it to null so that it's recomputed when calling `ContentView.getSearchDocumentModel()`
`protected Long`	`resolvePageSize()`
`protected List<SortInfo>`	`resolveSortInfos()`
`protected Object`	`resolveWithSearchDocument(com.google.common.base.Function<javax.faces.context.FacesContext,Object> func)`
`void`	`setCurrentPageSize(Long pageSize)` Sets the current page size.
`void`	`setCurrentResultLayout(ContentViewLayout layout)` Sets the current result layout.
`void`	`setCurrentResultLayout(ContentViewLayout layout, boolean resetLayoutColumn)`
`void`	`setCurrentResultLayout(String resultLayoutName)` Sets the current result layout given its name.
`void`	`setCurrentResultLayoutColumns(List<String> resultColumns)` Sets the list of result layout columns.
`void`	`setExecuted(boolean executed)` Sets the content view execution status.
`void`	`setQuickFilters(List<QuickFilter> quickFilters)`
`void`	`setSearchDocumentModel(DocumentModel searchDocumentModel)` Sets the search document model to be passed on the page provider, and set it also on the current page provider if not null.
`void`	`setWaitForExecution(boolean waitForExecution)`
`void`	`setWaitForExecutionSentence(String waitForExecutionSentence)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - name
```
protected String name
```
  - pageProvider
```
protected PageProvider<?> pageProvider
```
  - title
```
protected String title
```
  - translateTitle
```
protected boolean translateTitle
```
  - emptySentence
```
protected String emptySentence
```
  - translateEmptySentence
```
protected boolean translateEmptySentence
```
  - iconPath
```
protected String iconPath
```
  - showTitle
```
protected boolean showTitle
```
  - selectionList
```
protected String selectionList
```
  - pagination
```
protected String pagination
```
  - actionCategories
```
protected List<String> actionCategories
```
  - searchLayout
```
protected ContentViewLayout searchLayout
```
  - resultLayouts
```
protected List<ContentViewLayout> resultLayouts
```
  - flags
```
protected List<String> flags
```
  - currentResultLayoutSet
```
protected boolean currentResultLayoutSet
```
  - currentResultLayout
```
protected ContentViewLayout currentResultLayout
```
  - currentResultLayoutColumns
```
protected List<String> currentResultLayoutColumns
```
  - cacheKey
```
protected String cacheKey
```
  - cacheSize
```
protected Integer cacheSize
```
  - refreshEventNames
```
protected List<String> refreshEventNames
```
  - resetEventNames
```
protected List<String> resetEventNames
```
  - useGlobalPageSize
```
protected boolean useGlobalPageSize
```
  - showPageSizeSelector
```
protected boolean showPageSizeSelector
```
  - showRefreshCommand
```
protected boolean showRefreshCommand
```
  - showFilterForm
```
protected boolean showFilterForm
```
  - currentPageSize
```
protected Long currentPageSize
```
  - queryParameters
```
protected String[] queryParameters
```
  - searchDocumentModel
```
protected DocumentModel searchDocumentModel
```
  - searchDocumentModelBinding
```
protected String searchDocumentModelBinding
```
  - searchDocumentModelType
```
protected String searchDocumentModelType
```
  - resultColumnsBinding
```
protected String resultColumnsBinding
```
  - resultLayoutBinding
```
protected String resultLayoutBinding
```
  - pageSizeBinding
```
protected String pageSizeBinding
```
  - sortInfosBinding
```
protected String sortInfosBinding
```
  - waitForExecution
```
protected boolean waitForExecution
```
  - waitForExecutionSentence
```
protected String waitForExecutionSentence
```
  - executed
```
protected boolean executed
```
  - quickFilters
```
protected List<QuickFilter> quickFilters
```
    Since:
    
    8.4
- Constructor Detail
  - ContentViewImpl
```
public ContentViewImpl(String name,
                       String title,
                       boolean translateTitle,
                       String iconPath,
                       String selectionList,
                       String pagination,
                       List<String> actionCategories,
                       ContentViewLayout searchLayout,
                       List<ContentViewLayout> resultLayouts,
                       List<String> flags,
                       String cacheKey,
                       Integer cacheSize,
                       List<String> refreshEventNames,
                       List<String> resetEventNames,
                       boolean useGlobalPageSize,
                       String[] queryParameters,
                       String searchDocumentModelBinding,
                       String searchDocumentModelType,
                       String resultColumnsBinding,
                       String resultLayoutBinding,
                       String sortInfosBinding,
                       String pageSizeBinding,
                       boolean showTitle,
                       boolean showPageSizeSelector,
                       boolean showRefreshCommand,
                       boolean showFilterForm,
                       String emptySentence,
                       boolean translateEmptySentence)
```
- Method Detail
  - getName
```
public String getName()
```
    Description copied from interface: ContentView
    
    Returns the name of this content view
    
    Specified by:
    
    getName in interface ContentView
  - getTitle
```
public String getTitle()
```
    Description copied from interface: ContentView
    
    Returns a title for this content view
    
    Specified by:
    
    getTitle in interface ContentView
  - getTranslateTitle
```
public boolean getTranslateTitle()
```
    Description copied from interface: ContentView
    
    Returns a boolean stating if title has to be translated
    
    Specified by:
    
    getTranslateTitle in interface ContentView
    
    See Also:
    
    ContentView.getTitle()
  - getIconPath
```
public String getIconPath()
```
    Description copied from interface: ContentView
    
    Returns the icon relative path for this content view.
    
    Specified by:
    
    getIconPath in interface ContentView
  - getSelectionListName
```
public String getSelectionListName()
```
    Description copied from interface: ContentView
    
    Returns the selection list name
    
    Specified by:
    
    getSelectionListName in interface ContentView
  - getPagination
```
public String getPagination()
```
    Description copied from interface: ContentView
    
    Returns the pagination type to be used in pagination rendering
    
    Specified by:
    
    getPagination in interface ContentView
  - getActionsCategories
```
public List<String> getActionsCategories()
```
    Description copied from interface: ContentView
    
    Returns the list of action categories to display buttons available on selection of items.
    
    Specified by:
    
    getActionsCategories in interface ContentView
  - getSearchLayout
```
public ContentViewLayout getSearchLayout()
```
    Description copied from interface: ContentView
    
    Returns the search layout, used to filter results.
    
    Specified by:
    
    getSearchLayout in interface ContentView
  - getResultLayouts
```
public List<ContentViewLayout> getResultLayouts()
```
    Description copied from interface: ContentView
    
    Returns the result layouts, used to display results.
    
    Specified by:
    
    getResultLayouts in interface ContentView
  - getCurrentResultLayout
```
public ContentViewLayout getCurrentResultLayout()
```
    Description copied from interface: ContentView
    
    Returns the current result layout, as set using ContentView.setCurrentResultLayout(ContentViewLayout), or the first of defined result layouts when not set.
    
    Specified by:
    
    getCurrentResultLayout in interface ContentView
  - setCurrentResultLayout
```
public void setCurrentResultLayout(ContentViewLayout layout)
```
    Description copied from interface: ContentView
    
    Sets the current result layout.
    
    Specified by:
    
    setCurrentResultLayout in interface ContentView
  - setCurrentResultLayout
```
public void setCurrentResultLayout(ContentViewLayout layout,
                                   boolean resetLayoutColumn)
```
  - resolveWithSearchDocument
```
protected Object resolveWithSearchDocument(com.google.common.base.Function<javax.faces.context.FacesContext,Object> func)
```
  - setCurrentResultLayout
```
public void setCurrentResultLayout(String resultLayoutName)
```
    Description copied from interface: ContentView
    
    Sets the current result layout given its name.
    
    Specified by:
    
    setCurrentResultLayout in interface ContentView
  - hasResultLayoutBinding
```
public boolean hasResultLayoutBinding()
```
    Specified by:
    
    hasResultLayoutBinding in interface ContentView
  - getPageProvider
```
public PageProvider<?> getPageProvider(DocumentModel searchDocument,
                                       List<SortInfo> sortInfos,
                                       Long pageSize,
                                       Long currentPage,
                                       Object... params)
```
    Returns cached page provider if it exists or build a new one if parameters have changed.
    The search document, current page and page size are set on the page provider anyway. Sort infos are not set again if page provider was not built again (e.g if parameters did not change) to avoid erasing sort infos already held by it.
    
    Specified by:
    
    getPageProvider in interface ContentView
    
    Parameters:
    
    searchDocument - document that will be set on the page provider. If this document is null, we try to retrieve the content view document model calling ContentView.getSearchDocumentModel(). If it is not null, it is set on the page provider.
    
    sortInfos - if not null, will override default sort info put in the page provider XML description
    
    pageSize - if not null, will override default page size put in the page provider XML description
    
    currentPage - if not null, will set the current page to given one
    
    params - if not null, will set the parameters on provider. If null, will take parameters as resolved on the content view from the XML configuration, see ContentView.getQueryParameters()
  - getPageProviderWithParams
```
public PageProvider<?> getPageProviderWithParams(Object... params)
```
    Description copied from interface: ContentView
    
    Gets page provider according to given parameters
    
    Specified by:
    
    getPageProviderWithParams in interface ContentView
    
    See Also:
    
    using null as every argument except params
  - getPageProvider
```
public PageProvider<?> getPageProvider()
```
    Description copied from interface: ContentView
    
    Gets page provider according to given parameters
    
    Specified by:
    
    getPageProvider in interface ContentView
    
    See Also:
    
    , using null as every argument
  - getCurrentPageProvider
```
public PageProvider<?> getCurrentPageProvider()
```
    Description copied from interface: ContentView
    
    Returns the current page provider, or null if methods ContentView.getPageProvider(), ContentView.getPageProvider(DocumentModel, List, Long, Long, Object...) or ContentView.getPageProviderWithParams(Object...) were never called before.
    
    Specified by:
    
    getCurrentPageProvider in interface ContentView
  - resetPageProvider
```
public void resetPageProvider()
```
    Description copied from interface: ContentView
    
    Resets the page provider.
    A new page provider will be computed next time ContentView.getPageProviderWithParams(Object...) is called. Sort information and query parameters will have to be re-generated.
    
    Specified by:
    
    resetPageProvider in interface ContentView
  - refreshPageProvider
```
public void refreshPageProvider()
```
    Description copied from interface: ContentView
    
    Refreshes the current page provider if not null, see PageProvider.refresh().
    Sort information and query parameters and current page are kept.
    
    Specified by:
    
    refreshPageProvider in interface ContentView
  - refreshAndRewindPageProvider
```
public void refreshAndRewindPageProvider()
```
    Description copied from interface: ContentView
    
    Refreshes the current page provider if not null, see PageProvider.refresh(), and resets the current page to the first one.
    Sort information and query parameters are kept.
    
    Specified by:
    
    refreshAndRewindPageProvider in interface ContentView
  - getCacheKey
```
public String getCacheKey()
```
    Description copied from interface: ContentView
    
    Returns the cache key for this content view provider, resolving from the current FacesContext instance if it's an EL expression.
    
    Specified by:
    
    getCacheKey in interface ContentView
  - getCacheSize
```
public Integer getCacheSize()
```
    Description copied from interface: ContentView
    
    Returns the cache size for this content view.
    
    Specified by:
    
    getCacheSize in interface ContentView
  - getQueryParameters
```
public Object[] getQueryParameters()
```
    Description copied from interface: ContentView
    
    Returns the query parameters for this content view provider provider, resolving from the current FacesContext instance if they are EL expressions.
    
    Specified by:
    
    getQueryParameters in interface ContentView
  - getRefreshEventNames
```
public List<String> getRefreshEventNames()
```
    Description copied from interface: ContentView
    
    Returns the list of event names that should trigger a refresh of this content view page provider.
    
    Specified by:
    
    getRefreshEventNames in interface ContentView
  - getResetEventNames
```
public List<String> getResetEventNames()
```
    Description copied from interface: ContentView
    
    Returns the list of event names that should trigger a reset of this content view page provider.
    
    Specified by:
    
    getResetEventNames in interface ContentView
  - getUseGlobalPageSize
```
public boolean getUseGlobalPageSize()
```
    Description copied from interface: ContentView
    
    Returns true is this content view can use the global page size set on the application.
    
    Specified by:
    
    getUseGlobalPageSize in interface ContentView
  - getCurrentPageSize
```
public Long getCurrentPageSize()
```
    Description copied from interface: ContentView
    
    Returns the current page size, as set using ContentView.setCurrentPageSize(Long), or the page size set on current page provider if not null.
    
    Specified by:
    
    getCurrentPageSize in interface ContentView
  - setCurrentPageSize
```
public void setCurrentPageSize(Long pageSize)
```
    Description copied from interface: ContentView
    
    Sets the current page size.
    
    Specified by:
    
    setCurrentPageSize in interface ContentView
  - getSearchDocumentModel
```
public DocumentModel getSearchDocumentModel()
```
    Description copied from interface: ContentView
    
    Returns the search document model as set on the content view.
    If this document is null and a EL binding has been set on the content view description, the document model will be resolved from this binding, and set as the search document model.
    Else, if the content view is using a provider that needs a search document model, a new one is created and attached to it thanks to the document type held in the definition.
    
    Specified by:
    
    getSearchDocumentModel in interface ContentView
  - setSearchDocumentModel
```
public void setSearchDocumentModel(DocumentModel searchDocumentModel)
```
    Description copied from interface: ContentView
    
    Sets the search document model to be passed on the page provider, and set it also on the current page provider if not null.
    
    Specified by:
    
    setSearchDocumentModel in interface ContentView
  - resetSearchDocumentModel
```
public void resetSearchDocumentModel()
```
    Description copied from interface: ContentView
    
    Resets the search document model, setting it to null so that it's recomputed when calling ContentView.getSearchDocumentModel()
    
    Specified by:
    
    resetSearchDocumentModel in interface ContentView
  - getSearchDocumentModelType
```
public String getSearchDocumentModelType()
```
    Description copied from interface: ContentView
    
    Returns the search document model type as defined in the XML configuration.
    
    Specified by:
    
    getSearchDocumentModelType in interface ContentView
  - getFlags
```
public List<String> getFlags()
```
    Description copied from interface: ContentView
    
    Returns the list of flags set on this content view, useful to group them, see ContentViewService.getContentViewNames(String)
    
    Specified by:
    
    getFlags in interface ContentView
  - getResultLayoutColumns
```
public List<String> getResultLayoutColumns()
```
    Specified by:
    
    getResultLayoutColumns in interface ContentView
  - getCurrentResultLayoutColumns
```
public List<String> getCurrentResultLayoutColumns()
```
    Description copied from interface: ContentView
    
    Returns the list of selected result layout columns, resolving the bound EL expression set in the content view definition if columns where not explicitely set with ContentView.setCurrentResultLayoutColumns(List).
    
    Specified by:
    
    getCurrentResultLayoutColumns in interface ContentView
  - setCurrentResultLayoutColumns
```
public void setCurrentResultLayoutColumns(List<String> resultColumns)
```
    Description copied from interface: ContentView
    
    Sets the list of result layout columns.
    
    Specified by:
    
    setCurrentResultLayoutColumns in interface ContentView
  - hasResultLayoutColumnsBinding
```
public boolean hasResultLayoutColumnsBinding()
```
    Specified by:
    
    hasResultLayoutColumnsBinding in interface ContentView
  - resolveSortInfos
```
protected List<SortInfo> resolveSortInfos()
```
  - resolvePageSize
```
protected Long resolvePageSize()
```
  - addSearchDocumentToELContext
```
protected Object addSearchDocumentToELContext(javax.faces.context.FacesContext facesContext)
```
  - removeSearchDocumentFromELContext
```
protected void removeSearchDocumentFromELContext(javax.faces.context.FacesContext facesContext,
                                                 Object previousValue)
```
  - getShowPageSizeSelector
```
public boolean getShowPageSizeSelector()
```
    Description copied from interface: ContentView
    
    Returns true is the page size selector should be displayed.
    
    Specified by:
    
    getShowPageSizeSelector in interface ContentView
  - getShowRefreshCommand
```
public boolean getShowRefreshCommand()
```
    Description copied from interface: ContentView
    
    Returns true is the refresh command should be displayed.
    
    Specified by:
    
    getShowRefreshCommand in interface ContentView
  - getShowFilterForm
```
public boolean getShowFilterForm()
```
    Description copied from interface: ContentView
    
    Returns true is the filter form should be displayed.
    Filter form is displayed on top of content view results, using the search document model and search layout if they have been set on the content view.
    
    Specified by:
    
    getShowFilterForm in interface ContentView
  - getShowTitle
```
public boolean getShowTitle()
```
    Description copied from interface: ContentView
    
    Returns true is the title should be displayed before the result layout selector.
    
    Specified by:
    
    getShowTitle in interface ContentView
  - getEmptySentence
```
public String getEmptySentence()
```
    Description copied from interface: ContentView
    
    Returns a sentence to display when this content view is empty
    
    Specified by:
    
    getEmptySentence in interface ContentView
  - getTranslateEmptySentence
```
public boolean getTranslateEmptySentence()
```
    Description copied from interface: ContentView
    
    Returns a boolean stating if sentence to display is empty has to be translated
    
    Specified by:
    
    getTranslateEmptySentence in interface ContentView
    
    See Also:
    
    ContentView.getEmptySentence()
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - raiseEvent
```
protected void raiseEvent(String eventName,
                          Object... params)
```
  - raiseEvent
```
protected void raiseEvent(String eventName)
```
  - pageChanged
```
public void pageChanged(PageProvider<?> pageProvider)
```
    Description copied from interface: PageProviderChangedListener
    
    Called when the current page of the pageProvider has changed.
    
    Specified by:
    
    pageChanged in interface PageProviderChangedListener
  - refreshed
```
public void refreshed(PageProvider<?> pageProvider)
```
    Description copied from interface: PageProviderChangedListener
    
    Called when the pageProvider has refreshed.
    
    Specified by:
    
    refreshed in interface PageProviderChangedListener
  - resetPageProviderAggregates
```
public void resetPageProviderAggregates()
```
    Description copied from interface: ContentView
    
    Reset the page provider aggregates.
    
    Specified by:
    
    resetPageProviderAggregates in interface ContentView
  - getWaitForExecutionSentence
```
public String getWaitForExecutionSentence()
```
    Description copied from interface: ContentView
    
    Returns the sentence to display when content view is waiting for a first execution.
    
    Specified by:
    
    getWaitForExecutionSentence in interface ContentView
  - setWaitForExecutionSentence
```
public void setWaitForExecutionSentence(String waitForExecutionSentence)
```
    Since:
    
    7.4
  - isWaitForExecution
```
public boolean isWaitForExecution()
```
    Description copied from interface: ContentView
    
    Returns true if content view will not display results until an explicit search is executed.
    
    Specified by:
    
    isWaitForExecution in interface ContentView
    
    See Also:
    
    ContentView.isExecuted()
  - setWaitForExecution
```
public void setWaitForExecution(boolean waitForExecution)
```
    Since:
    
    7.4
  - isExecuted
```
public boolean isExecuted()
```
    Description copied from interface: ContentView
    
    Returns true if content view has been executed.
    Execution is detected when either ContentView.refreshPageProvider() or ContentView.refreshAndRewindPageProvider() methods are called, or when ContentView.setExecuted(boolean) is called explicitely.
    
    Specified by:
    
    isExecuted in interface ContentView
  - setExecuted
```
public void setExecuted(boolean executed)
```
    Description copied from interface: ContentView
    
    Sets the content view execution status.
    
    Specified by:
    
    setExecuted in interface ContentView
  - setQuickFilters
```
public void setQuickFilters(List<QuickFilter> quickFilters)
```
    Specified by:
    
    setQuickFilters in interface ContentView
    
    Since:
    
    8.4
  - getQuickFilters
```
public List<QuickFilter> getQuickFilters()
```
    Specified by:
    
    getQuickFilters in interface ContentView
    
    Since:
    
    8.4

Class ContentViewImpl

Field Summary

Fields inherited from interface org.nuxeo.ecm.platform.contentview.jsf.ContentView

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

name

pageProvider

title

translateTitle

emptySentence

translateEmptySentence

iconPath

showTitle

selectionList

pagination

actionCategories

searchLayout

resultLayouts

flags

currentResultLayoutSet

currentResultLayout

currentResultLayoutColumns

cacheKey

cacheSize

refreshEventNames

resetEventNames

useGlobalPageSize

showPageSizeSelector

showRefreshCommand

showFilterForm

currentPageSize

queryParameters

searchDocumentModel

searchDocumentModelBinding

searchDocumentModelType

resultColumnsBinding

resultLayoutBinding

pageSizeBinding

sortInfosBinding

waitForExecution

waitForExecutionSentence

executed

quickFilters

Constructor Detail

ContentViewImpl

Method Detail

getName

getTitle

getTranslateTitle

getIconPath

getSelectionListName

getPagination

getActionsCategories

getSearchLayout

getResultLayouts

getCurrentResultLayout

setCurrentResultLayout

setCurrentResultLayout

resolveWithSearchDocument

setCurrentResultLayout

hasResultLayoutBinding

getPageProvider

getPageProviderWithParams

getPageProvider

getCurrentPageProvider

resetPageProvider

refreshPageProvider

refreshAndRewindPageProvider

getCacheKey

getCacheSize

getQueryParameters

getRefreshEventNames

getResetEventNames

getUseGlobalPageSize

getCurrentPageSize

setCurrentPageSize

getSearchDocumentModel

setSearchDocumentModel