org.nuxeo.ecm.platform.contentview.jsf
Interface ContentView

All Superinterfaces:

Serializable

All Known Implementing Classes:

ContentViewImpl

public interface ContentView
extends Serializable

A content view is a notion to handle lists of objects rendering, as well as query filters to build the list.

It has a name that will be the resulting page provider name too. It handles a page provider and accepts configuration needed to handle rendering, like the search layout (for filtering options), the result layout (for results rendering), actions (for buttons available when selecting result objects), the selection list name...

It also handles refresh or reset of its provider, depending on its cache key and refresh events configuration.

Since:

5.4

Author:

Anahide Tchertchian

Field Summary

static String

SEARCH_DOCUMENT_EL_VARIABLE

Method Summary

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 getPageProvider(), getPageProvider(DocumentModel, List, Long, Long, Object...) or getPageProviderWithParams(Object...) were never called before.
Long	getCurrentPageSize() Returns the current page size, as set using setCurrentPageSize(Long), or the page size set on current page provider if not null.
ContentViewLayout	getCurrentResultLayout() Returns the current result layout, as set using 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 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) Gets page provider according to given parameters
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<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() Deprecated. use getCurrentResultLayoutColumns() instead
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.
void	refreshAndRewindPageProvider() Refreshes the current page provider if not null, see PageProvider.refresh(), and resets the current page to the first one.
void	refreshPageProvider() Refreshes the current page provider if not null, see PageProvider.refresh().
void	resetPageProvider() Resets the page provider.
void	resetSearchDocumentModel() Resets the search document model, setting it to null so that it's recomputed when calling getSearchDocumentModel()
void	setCurrentPageSize(Long pageSize) Sets the current page size.
void	setCurrentResultLayout(ContentViewLayout layout) Sets the current result layout.
void	setCurrentResultLayoutColumns(List<String> resultColumns) Sets the list of result layout columns.
void	setSearchDocumentModel(DocumentModel doc) Sets the search document model to be passed on the page provider, and set it also on the current page provider if not null.

Field Detail

SEARCH_DOCUMENT_EL_VARIABLE

static final String SEARCH_DOCUMENT_EL_VARIABLE

See Also:

Constant Field Values

Method Detail

getName

String getName()

Returns the name of this content view

getTitle

String getTitle()

Returns a title for this content view

getTranslateTitle

boolean getTranslateTitle()

Returns a boolean stating if title has to be translated

See Also:

getTitle()

getShowTitle

boolean getShowTitle()

Returns true is the title should be displayed before the result layout selector.

Since:

5.4.2

getSelectionListName

String getSelectionListName()

Returns the selection list name

getPagination

String getPagination()

Returns the pagination type to be used in pagination rendering

getActionsCategories

List<String> getActionsCategories()

Returns the list of action categories to display buttons available on selection of items.

getFlags

List<String> getFlags()

Returns the list of flags set on this content view, useful to group them, see ContentViewService.getContentViewNames(String)

getSearchLayout

ContentViewLayout getSearchLayout()

Returns the search layout, used to filter results.

getResultLayouts

List<ContentViewLayout> getResultLayouts()

Returns the result layouts, used to display results.

getCurrentResultLayout

ContentViewLayout getCurrentResultLayout()

Returns the current result layout, as set using setCurrentResultLayout(ContentViewLayout), or the first of defined result layouts when not set.

setCurrentResultLayout

void setCurrentResultLayout(ContentViewLayout layout)

Sets the current result layout.

getCurrentPageSize

Long getCurrentPageSize()

Returns the current page size, as set using setCurrentPageSize(Long), or the page size set on current page provider if not null.

setCurrentPageSize

void setCurrentPageSize(Long pageSize)

Sets the current page size.

getResultLayoutColumns

@Deprecated
List<String> getResultLayoutColumns()

Deprecated. use getCurrentResultLayoutColumns() instead

getCurrentResultLayoutColumns

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 setCurrentResultLayoutColumns(List).

Since:

5.4.2

setCurrentResultLayoutColumns

void setCurrentResultLayoutColumns(List<String> resultColumns)

Sets the list of result layout columns.

Since:

5.4.2

getCacheKey

String getCacheKey()

Returns the cache key for this content view provider, resolving from the current FacesContext instance if it's an EL expression.

getCacheSize

Integer getCacheSize()

Returns the cache size for this content view.

getIconPath

String getIconPath()

Returns the icon relative path for this content view.

getQueryParameters

Object[] getQueryParameters()

Returns the query parameters for this content view provider provider, resolving from the current FacesContext instance if they are EL expressions.

getRefreshEventNames

List<String> getRefreshEventNames()

Returns the list of event names that should trigger a refresh of this content view page provider.

getResetEventNames

List<String> getResetEventNames()

Returns the list of event names that should trigger a reset of this content view page provider.

getPageProvider

PageProvider<?> getPageProvider(DocumentModel searchDocument,
                                List<SortInfo> sortInfos,
                                Long pageSize,
                                Long currentPage,
                                Object... params)
                                throws ClientException

Gets page provider according to given parameters

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 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 getQueryParameters()

Throws:

ClientException

getPageProviderWithParams

PageProvider<?> getPageProviderWithParams(Object... params)
                                          throws ClientException

Gets page provider according to given parameters

Throws:

ClientException

See Also:

using null as every argument except params

getPageProvider

PageProvider<?> getPageProvider()
                                throws ClientException

Gets page provider according to given parameters

Throws:

ClientException

See Also:

, using null as every argument

getCurrentPageProvider

PageProvider<?> getCurrentPageProvider()

Returns the current page provider, or null if methods getPageProvider(), getPageProvider(DocumentModel, List, Long, Long, Object...) or getPageProviderWithParams(Object...) were never called before.

resetPageProvider

void resetPageProvider()

Resets the page provider.

A new page provider will be computed next time getPageProviderWithParams(Object...) is called. Sort information and query parameters will have to be re-generated.

refreshPageProvider

void refreshPageProvider()

Refreshes the current page provider if not null, see PageProvider.refresh().

Sort information and query parameters and current page are kept.

refreshAndRewindPageProvider

void refreshAndRewindPageProvider()

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.

getUseGlobalPageSize

boolean getUseGlobalPageSize()

Returns true is this content view can use the global page size set on the application.

getShowPageSizeSelector

boolean getShowPageSizeSelector()

Returns true is the page size selector should be displayed.

Since:

5.4.2

getShowRefreshCommand

boolean getShowRefreshCommand()

Returns true is the refresh command should be displayed.

Since:

5.4.2

getShowFilterForm

boolean getShowFilterForm()

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.

Since:

5.4.2

getSearchDocumentModel

DocumentModel getSearchDocumentModel()

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.

setSearchDocumentModel

void setSearchDocumentModel(DocumentModel doc)

Sets the search document model to be passed on the page provider, and set it also on the current page provider if not null.

resetSearchDocumentModel

void resetSearchDocumentModel()

Resets the search document model, setting it to null so that it's recomputed when calling getSearchDocumentModel()

getSearchDocumentModelType

String getSearchDocumentModelType()

Returns the search document model type as defined in the XML configuration.

getEmptySentence

String getEmptySentence()

Returns a sentence to display when this content view is empty

Since:

5.4.2

getTranslateEmptySentence

boolean getTranslateEmptySentence()

Returns a boolean stating if sentence to display is empty has to be translated

Since:

5.4.2

See Also:

getEmptySentence()