public abstract class OwPageableListView extends OwObjectListView
Abstraction of paging handling for ListViews. Provide new helper and consolidate methods defined by OwPageableView interface.
Alfresco Workdesk
Copyright (c) Alfresco Software, Inc.
All rights reserved.
For licensing information read the license.txt file or
go to: http://wiki.alfresco.com
OwObjectListView.OwFilter, OwObjectListView.OwFilterEntry, OwObjectListView.OwHtmlAlignmentMap, OwObjectListView.OwIcon, OwObjectListView.OwObjectListViewEventListner, OwObjectListView.OwPluginEntry
m_HtmlAlignments, m_isStickyFooterInUse, m_pageSelectorComponent, m_pagingNode, MULTISELECT_COMOBO_MENU_NAME, OBJECT_INDEX_KEY, PLUG_INDEX_KEY, QUERY_KEY_PAGE, SELECT_DESELECT_NONCONSECUTIVE_OBJECTS_ACTION_ID, SORT_PROPERTY_KEY, VIEW_MASK_INLINE_EDITING, VIEW_MASK_INSTANCE_PLUGINS, VIEW_MASK_MULTI_SELECTION, VIEW_MASK_NO_PAGE_BUTTONS, VIEW_MASK_SINGLE_SELECTION, VIEW_MASK_USE_DOCUMENT_PLUGINS, VIEW_MASK_USE_SELECT_BUTTON
CURRENT_MODULE_KEY, FORMULAR_PLACEHOLDER_END_DELIMITER, FORMULAR_PLACEHOLDER_START_DELIMITER, m_externalFormEventTarget
EMPTY_STRING
Modifier | Constructor and Description |
---|---|
protected |
OwPageableListView() |
|
OwPageableListView(int viewMask) |
Modifier and Type | Method and Description |
---|---|
boolean |
canPageNext()
Check if there is a next page
|
boolean |
canPagePrev()
Check if there is a previous page
|
void |
detach()
remove view and all subviews from context
|
Collection<? extends OwFieldColumnInfo> |
getColumnInfo()
get the list of column info to be used by this list view
|
int |
getCurrentPage()
Get the current page, will not exceed the
OwPageableView.getPageCount() . |
OwIterable<OwObject> |
getDisplayedPage()
Get the items for current displayed page.
|
OwFieldManager |
getFieldManager()
get the internal fieldmanager
|
OwIterable<OwObject> |
getObjectIterable() |
OwObjectCollection |
getObjectList()
get the current object list
|
String |
getPageAbsolutEventURL(String aditionalParameters_p)
Get URL for a given page number
|
int |
getPageCount()
Retrieve number of available pages:
pageCount > 0: available pages
pageCount = 0: no pages/elements available
pageCount < 0: unknown amount of pages
|
String |
getPageNextEventURL()
Get the next page URL.
|
String |
getPagePrevEventURL()
Get the previous page URL.
|
int |
getPageSize()
Return the configured PageSize for lists.
|
protected OwClientRefreshContext |
getRefreshContext()
get an eventlistener with this view to receive notifications
|
Collection<String> |
getRetrievalPropertyNames()
get a collection of property names that are needed to display the Objects in the list
i.e.
|
OwSort |
getSort()
get the current selected sort instance
|
boolean |
isCollectionComplete()
Helper to identify if list is completely retrieved or there are more results.
|
protected boolean |
isPagingEnabled()
Extended check for page selector functionality.
|
void |
onClientRefreshContextUpdate(int iReason_p,
Object param_p)
call client and cause it to refresh its display data
|
void |
onPageAbsolut(javax.servlet.http.HttpServletRequest request_p)
display absolute page of objects
|
void |
onPageNext(javax.servlet.http.HttpServletRequest request_p)
display next page of objects
|
void |
onPagePrev(javax.servlet.http.HttpServletRequest request_p)
display previous page of objects
|
protected void |
pageAbsolut(int currentPage)
Move to the given zero based absolute page.
|
void |
setColumnInfo(Collection<? extends OwFieldColumnInfo> columnInfo)
set the list of column info to be used by this list view
|
void |
setFieldManager(OwFieldManager fieldmanager_p)
set the internal fieldmanager
in case you want a specific fieldmanager
|
void |
setObjectIterable(OwIterable<OwObject> iterable,
OwObject parentObject_p)
set a pageable interface for retrieval of items to display.
|
void |
setObjectList(OwObjectCollection objectList_p,
OwObject parentObject_p)
set the list of objects to be displayed by this list view
|
void |
setRefreshContext(OwClientRefreshContext refreshContext)
register an event listener with this view to receive notifications
|
void |
setSort(OwSort sort)
set / override current sort to given sort
|
addAjaxPersistenceService, addViewMask, clearViewMask, copy, createFilter, createFilter, createFilter, createPageSelector, getContextMenuFunction, getCount, getDocumentFunction, getDocumentFunctionPluginList, getEventListner, getFilter, getFilterOperators, getFilterSearch, getListViewID, getObjectByIndex, getParentObject, getPluginEntries, hasPaging, hasViewMask, init, isEmptyPluginColumnRendered, isObjectSelectionPersisted, isObjectTypeSupportedByPlugin, isShowMaximized, isStickyFooterInUse, persistAjaxTriggeredSelection, persistAjaxTriggeredSelection, persistObjectSelectionState, renderContextMenu, resetPersistedSelectionState, setConfigNode, setCurrentPage, setDocumentFunctionPluginList, setEventListner, setFilter, setParentObject, setRenderEmptyPluginColumn, setStickyFooterInUse, setViewMask
activate, addView, getBreadcrumbPart, getDocument, getExternalFormEventTarget, getFormName, getFormTarget, getIcon, getIterator, getMaximizeView, getParent, getRenderedNamedRegion, getRenderedRegion, getTitle, getViewList, isFormTargetExternal, isNamedRegion, isRegion, isShowMinimized, isShowNormal, onActivate, onRender, onUpdate, render, renderHTMLFormular, renderNamedRegion, renderRegion, serverSideDesignInclude, serverSideInclude, setDocument, setExternalFormTarget, setMaximizeView, setParent, showMaximized, showMinimized, showNormal, usesFormWithAttributes
attach, disableRequestListener, enableRequestListener, getAjaxEventURL, getContext, getEventURL, getFormEventFunction, getFormEventURL, getID, onExternalRequest, onFormEvent, onRequest, updateExternalFormTarget
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getContext
getBreadcrumbPart, getTitle, isNamedRegion, isRegion, render, renderNamedRegion, renderRegion
protected OwPageableListView()
public OwPageableListView(int viewMask)
public void detach()
OwView
public void setObjectList(OwObjectCollection objectList_p, OwObject parentObject_p) throws Exception
OwObjectListView
setObjectList
in class OwObjectListView
objectList_p
- OwObjectCollectionparentObject_p
- OwObject parent which created the object list, can be null if no parent is specifiedException
public void setObjectIterable(OwIterable<OwObject> iterable, OwObject parentObject_p) throws Exception
OwObjectListView
setObjectIterable
in class OwObjectListView
iterable
- OwIterable returning OwObjectsparentObject_p
- OwObjectException
public OwObjectCollection getObjectList()
OwObjectListView
getObjectList
in class OwObjectListView
public OwIterable<OwObject> getObjectIterable()
getObjectIterable
in class OwObjectListView
public OwFieldManager getFieldManager()
OwObjectListView
getFieldManager
in class OwObjectListView
public void setFieldManager(OwFieldManager fieldmanager_p)
OwObjectListView
setFieldManager
in class OwObjectListView
public void setRefreshContext(OwClientRefreshContext refreshContext)
OwObjectListView
setRefreshContext
in class OwObjectListView
refreshContext
- OwClientRefreshContext interfaceprotected OwClientRefreshContext getRefreshContext()
OwObjectListView
getRefreshContext
in class OwObjectListView
public void setColumnInfo(Collection<? extends OwFieldColumnInfo> columnInfo)
OwObjectListView
setColumnInfo
in class OwObjectListView
columnInfo
- List of OwFieldColumnInfo'spublic Collection<? extends OwFieldColumnInfo> getColumnInfo()
OwObjectListView
getColumnInfo
in class OwObjectListView
public void setSort(OwSort sort)
OwObjectListView
setSort
in class OwObjectListView
sort
- new OwSortpublic OwSort getSort()
OwObjectListView
getSort
in class OwObjectListView
public Collection<String> getRetrievalPropertyNames() throws Exception
OwObjectListView
getRetrievalPropertyNames
in class OwObjectListView
Exception
public void onPageAbsolut(javax.servlet.http.HttpServletRequest request_p) throws Exception
OwPageableView
Exception
public void onPageNext(javax.servlet.http.HttpServletRequest request_p) throws Exception
OwPageableView
Exception
public void onPagePrev(javax.servlet.http.HttpServletRequest request_p) throws Exception
OwPageableView
Exception
public int getPageCount()
OwPageableView
public int getCurrentPage()
OwPageableView
OwPageableView.getPageCount()
.
A zero based page representation, which will go up to OwPageableView.getPageCount()
- 1
public boolean canPagePrev()
OwPageableView
public boolean canPageNext()
OwPageableView
protected boolean isPagingEnabled()
OwObjectListView
isPagingEnabled
in class OwObjectListView
OwObjectListView.hasPaging()
public String getPagePrevEventURL()
OwPageableView
getPagePrevEventURL
in interface OwPageableView
getPagePrevEventURL
in class OwObjectListView
OwPageableView.getPagePrevEventURL()
public String getPageNextEventURL()
OwPageableView
getPageNextEventURL
in interface OwPageableView
getPageNextEventURL
in class OwObjectListView
OwPageableView.getPageNextEventURL()
public String getPageAbsolutEventURL(String aditionalParameters_p)
OwPageableView
getPageAbsolutEventURL
in interface OwPageableView
getPageAbsolutEventURL
in class OwObjectListView
aditionalParameters_p
- - query parameters in a http linkOwPageableView.getPageAbsolutEventURL(java.lang.String)
protected void pageAbsolut(int currentPage)
OwObjectListView
pageAbsolut
in class OwObjectListView
currentPage
- int zero based page numberpublic OwIterable<OwObject> getDisplayedPage()
public boolean isCollectionComplete()
public int getPageSize()
public void onClientRefreshContextUpdate(int iReason_p, Object param_p) throws Exception
OwClientRefreshContext
iReason_p
- int reason as defined in OwUpdateCodesparam_p
- Object optional parameter representing the refresh, depends on the value of iReason_p, can be nullException
Copyright © 2014 Alfresco Business Solutions. All Rights Reserved.