public abstract class AbstractUsersPageProvider<T> extends AbstractPageProvider<T>
Modifier and Type | Field and Description |
---|---|
protected static String |
ALL_MODE |
protected List<DocumentModel> |
pageUsers |
protected static String |
SEARCH_ONLY_MODE |
protected static String |
SEARCH_OVERFLOW_ERROR_MESSAGE |
protected static String |
TABBED_MODE |
protected Map<String,DocumentModelList> |
userCatalog
Map with first letter as key and users list as value.
|
protected static String |
USERS_LISTING_MODE_PROPERTY |
currentEntryIndex, currentHigherNonEmptyPageIndex, currentSelectPage, definition, error, errorMessage, maxPageSize, name, offset, PAGEPROVIDER_TRACK_PROPERTY_NAME, pageProviderChangedListener, pageSize, pageSizeOptions, parameters, properties, resultsCount, searchDocumentModel, selectedEntries, SKIPPED_SCHEMAS_FOR_SEARCHFIELD, sortable, sortInfos, tracking
DEFAULT_MAX_PAGE_SIZE, DEFAULT_MAX_PAGE_SIZE_RUNTIME_PROP, PAGE_LIMIT_UNKNOWN, UNKNOWN_SIZE, UNKNOWN_SIZE_AFTER_QUERY
Constructor and Description |
---|
AbstractUsersPageProvider() |
Modifier and Type | Method and Description |
---|---|
protected List<DocumentModel> |
computeCurrentPage() |
Collection<String> |
getCatalogLetters() |
protected String |
getFirstParameter() |
protected String |
getUserListingMode() |
boolean |
isSortable()
This page provider does not support sort for now => override what may be contributed in the definition
|
protected void |
pageChanged()
Page change hook, to override for custom behavior
|
void |
refresh()
Refresh hook, to override for custom behavior
|
protected List<DocumentModel> |
searchAllUsers(UserManager userManager) |
protected List<DocumentModel> |
searchUsers(UserManager userManager) |
protected List<DocumentModel> |
searchUsersFromCatalog(UserManager userManager) |
protected void |
updateUserCatalog(UserManager userManager) |
addSortInfo, fireSearchEvent, firstPage, getAggregateDefinitions, getAggregates, getBooleanProperty, getCurrentEntry, getCurrentHigherNonEmptyPageIndex, getCurrentPage, getCurrentPageIndex, getCurrentPageOffset, getCurrentPageSize, getCurrentPageStatus, getCurrentSelectPage, getDefaultMaxPageSize, getDefinition, getError, getErrorMessage, getMaxNumberOfEmptyPages, getMaxPageSize, getMinMaxPageSize, getName, getNumberOfPages, getPageLimit, getPageSize, getPageSizeOptions, getParameters, getParametersChanged, getProperties, getResultsCount, getSearchDocumentModel, getSortInfo, getSortInfoIndex, getSortInfos, hasAggregateSupport, hasChangedParameters, hasError, incorporateAggregates, isLastPageAvailable, isNextEntryAvailable, isNextPageAvailable, isPreviousEntryAvailable, isPreviousPageAvailable, isTrackingEnabled, last, lastPage, next, nextEntry, nextPage, notifyPageChanged, notifyRefresh, previous, previousEntry, previousPage, rewind, searchDocumentModelChanged, setCurrentEntry, setCurrentEntryIndex, setCurrentHigherNonEmptyPageIndex, setCurrentPage, setCurrentPageIndex, setCurrentPageOffset, setDefinition, setMaxPageSize, setName, setPageProviderChangedListener, setPageSize, setPageSizeOptions, setParameters, setProperties, setResultsCount, setSearchDocumentModel, setSelectedEntries, setSortable, setSortInfo, setSortInfo, setSortInfos, sortInfoChanged
protected static final String USERS_LISTING_MODE_PROPERTY
protected static final String ALL_MODE
protected static final String SEARCH_ONLY_MODE
protected static final String TABBED_MODE
protected static final String SEARCH_OVERFLOW_ERROR_MESSAGE
protected Map<String,DocumentModelList> userCatalog
protected List<DocumentModel> pageUsers
public AbstractUsersPageProvider()
protected List<DocumentModel> computeCurrentPage()
protected String getUserListingMode()
protected String getFirstParameter()
protected List<DocumentModel> searchAllUsers(UserManager userManager)
protected List<DocumentModel> searchUsers(UserManager userManager)
protected List<DocumentModel> searchUsersFromCatalog(UserManager userManager)
protected void updateUserCatalog(UserManager userManager)
public Collection<String> getCatalogLetters()
public boolean isSortable()
isSortable
in interface PageProvider<T>
isSortable
in class AbstractPageProvider<T>
protected void pageChanged()
AbstractPageProvider
When overriding it, call super.pageChanged()
as last statement to make sure that the
PageProviderChangedListener
is called with the up-to-date @{code PageProvider} state.
pageChanged
in class AbstractPageProvider<T>
public void refresh()
AbstractPageProvider
When overriding it, call super.refresh()
as last statement to make sure that the
PageProviderChangedListener
is called with the up-to-date @{code PageProvider} state.
refresh
in interface PageProvider<T>
refresh
in class AbstractPageProvider<T>
Copyright © 2015 Nuxeo SA. All rights reserved.