com.wewebu.ow.server.dmsdialogs.views

Class OwPageableListView

java.lang.Object

com.wewebu.ow.server.ui.OwEventTarget

com.wewebu.ow.server.ui.OwView

com.wewebu.ow.server.dmsdialogs.views.OwObjectListView

com.wewebu.ow.server.dmsdialogs.views.OwPageableListView

All Implemented Interfaces:

OwClientRefreshContext, OwPageableView, OwBaseView, OwUpdateTarget, EventListener

Direct Known Subclasses:

OwObjectListViewCombined, OwObjectListViewPluginCache, OwObjectListViewThumbnails

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

Since:

4.2.0.0

Nested Class Summary

Nested classes/interfaces inherited from class com.wewebu.ow.server.dmsdialogs.views.OwObjectListView

OwObjectListView.OwFilter, OwObjectListView.OwFilterEntry, OwObjectListView.OwHtmlAlignmentMap, OwObjectListView.OwIcon, OwObjectListView.OwObjectListViewEventListner, OwObjectListView.OwPluginEntry

Field Summary

Fields inherited from class com.wewebu.ow.server.dmsdialogs.views.OwObjectListView

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

Fields inherited from class com.wewebu.ow.server.ui.OwView

CURRENT_MODULE_KEY, FORMULAR_PLACEHOLDER_END_DELIMITER, FORMULAR_PLACEHOLDER_START_DELIMITER, m_externalFormEventTarget

Fields inherited from interface com.wewebu.ow.server.ui.OwBaseView

EMPTY_STRING

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OwPageableListView()
	OwPageableListView(int viewMask)

Method Summary

Methods

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

Methods inherited from class com.wewebu.ow.server.dmsdialogs.views.OwObjectListView

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

Methods inherited from class com.wewebu.ow.server.ui.OwView

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

Methods inherited from class com.wewebu.ow.server.ui.OwEventTarget

attach, disableRequestListener, enableRequestListener, getAjaxEventURL, getContext, getEventURL, getFormEventFunction, getFormEventURL, getID, onExternalRequest, onFormEvent, onRequest, updateExternalFormTarget

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.wewebu.ow.server.dmsdialogs.views.OwPageableView

getContext

Methods inherited from interface com.wewebu.ow.server.ui.OwBaseView

getBreadcrumbPart, getTitle, isNamedRegion, isRegion, render, renderNamedRegion, renderRegion

Constructor Detail

OwPageableListView

protected OwPageableListView()

OwPageableListView

public OwPageableListView(int viewMask)

Method Detail

detach

public void detach()

Description copied from class: OwView

remove view and all subviews from context

Overrides:

detach in class OwView

setObjectList

public void setObjectList(OwObjectCollection objectList_p,
                 OwObject parentObject_p)
                   throws Exception

Description copied from class: OwObjectListView

set the list of objects to be displayed by this list view

Specified by:

setObjectList in class OwObjectListView

Parameters:

objectList_p - OwObjectCollection

parentObject_p - OwObject parent which created the object list, can be null if no parent is specified

Throws:

Exception

setObjectIterable

public void setObjectIterable(OwIterable<OwObject> iterable,
                     OwObject parentObject_p)
                       throws Exception

Description copied from class: OwObjectListView

set a pageable interface for retrieval of items to display.

Specified by:

setObjectIterable in class OwObjectListView

Parameters:

iterable - OwIterable returning OwObjects

parentObject_p - OwObject

Throws:

Exception

getObjectList

public OwObjectCollection getObjectList()

Description copied from class: OwObjectListView

get the current object list

Specified by:

getObjectList in class OwObjectListView

getObjectIterable

public OwIterable<OwObject> getObjectIterable()

Specified by:

getObjectIterable in class OwObjectListView

getFieldManager

public OwFieldManager getFieldManager()

Description copied from class: OwObjectListView

get the internal fieldmanager

Specified by:

getFieldManager in class OwObjectListView

setFieldManager

public void setFieldManager(OwFieldManager fieldmanager_p)

Description copied from class: OwObjectListView

set the internal fieldmanager in case you want a specific fieldmanager

Specified by:

setFieldManager in class OwObjectListView

setRefreshContext

public void setRefreshContext(OwClientRefreshContext refreshContext)

Description copied from class: OwObjectListView

register an event listener with this view to receive notifications

Specified by:

setRefreshContext in class OwObjectListView

Parameters:

refreshContext - OwClientRefreshContext interface

getRefreshContext

protected OwClientRefreshContext getRefreshContext()

Description copied from class: OwObjectListView

get an eventlistener with this view to receive notifications

Specified by:

getRefreshContext in class OwObjectListView

Returns:

OwClientRefreshContext

setColumnInfo

public void setColumnInfo(Collection<? extends OwFieldColumnInfo> columnInfo)

Description copied from class: OwObjectListView

set the list of column info to be used by this list view

Specified by:

setColumnInfo in class OwObjectListView

Parameters:

columnInfo - List of OwFieldColumnInfo's

getColumnInfo

public Collection<? extends OwFieldColumnInfo> getColumnInfo()

Description copied from class: OwObjectListView

get the list of column info to be used by this list view

Specified by:

getColumnInfo in class OwObjectListView

Returns:

Collection of OwFieldColumnInfo's

setSort

public void setSort(OwSort sort)

Description copied from class: OwObjectListView

set / override current sort to given sort

Specified by:

setSort in class OwObjectListView

Parameters:

sort - new OwSort

getSort

public OwSort getSort()

Description copied from class: OwObjectListView

get the current selected sort instance

Specified by:

getSort in class OwObjectListView

Returns:

OwSort object

getRetrievalPropertyNames

public Collection<String> getRetrievalPropertyNames()
                                             throws Exception

Description copied from class: OwObjectListView

get a collection of property names that are needed to display the Objects in the list i.e. these properties should be requested in advance to save server round-trips.

Specified by:

getRetrievalPropertyNames in class OwObjectListView

Returns:

Collection of String

Throws:

Exception

onPageAbsolut

public void onPageAbsolut(javax.servlet.http.HttpServletRequest request_p)
                   throws Exception

Description copied from interface: OwPageableView

display absolute page of objects

Throws:

Exception

onPageNext

public void onPageNext(javax.servlet.http.HttpServletRequest request_p)
                throws Exception

Description copied from interface: OwPageableView

display next page of objects

Throws:

Exception

onPagePrev

public void onPagePrev(javax.servlet.http.HttpServletRequest request_p)
                throws Exception

Description copied from interface: OwPageableView

display previous page of objects

Throws:

Exception

getPageCount

public int getPageCount()

Description copied from interface: OwPageableView

Retrieve number of available pages:

• pageCount > 0: available pages
• pageCount = 0: no pages/elements available
• pageCount < 0: unknown amount of pages

Returns:

integer number of pages (or -1 if unknown)

getCurrentPage

public int getCurrentPage()

Description copied from interface: OwPageableView

Get the current page, will not exceed the OwPageableView.getPageCount().

A zero based page representation, which will go up to OwPageableView.getPageCount() - 1

Returns:

integer representing current page number

canPagePrev

public boolean canPagePrev()

Description copied from interface: OwPageableView

Check if there is a previous page

Returns:

boolean true = there is a previous page, pagePrev is possible

canPageNext

public boolean canPageNext()

Description copied from interface: OwPageableView

Check if there is a next page

Returns:

boolean true = there is a next page, pageNext is possible

isPagingEnabled

protected boolean isPagingEnabled()

Description copied from class: OwObjectListView

Extended check for page selector functionality.

Overrides:

isPagingEnabled in class OwObjectListView

Returns:

true = enable/display page buttons, by default false = disabled

See Also:

OwObjectListView.hasPaging()

getPagePrevEventURL

public String getPagePrevEventURL()

Description copied from interface: OwPageableView

Get the previous page URL.

Specified by:

getPagePrevEventURL in interface OwPageableView

Overrides:

getPagePrevEventURL in class OwObjectListView

Returns:

the page previous URL

See Also:

OwPageableView.getPagePrevEventURL()

getPageNextEventURL

public String getPageNextEventURL()

Description copied from interface: OwPageableView

Get the next page URL.

Specified by:

getPageNextEventURL in interface OwPageableView

Overrides:

getPageNextEventURL in class OwObjectListView

Returns:

the next page URL

See Also:

OwPageableView.getPageNextEventURL()

getPageAbsolutEventURL

public String getPageAbsolutEventURL(String aditionalParameters_p)

Description copied from interface: OwPageableView

Get URL for a given page number

Specified by:

getPageAbsolutEventURL in interface OwPageableView

Overrides:

getPageAbsolutEventURL in class OwObjectListView

Parameters:

aditionalParameters_p - - query parameters in a http link

Returns:

the URL

See Also:

OwPageableView.getPageAbsolutEventURL(java.lang.String)

pageAbsolut

protected void pageAbsolut(int currentPage)

Description copied from class: OwObjectListView

Move to the given zero based absolute page.

Overrides:

pageAbsolut in class OwObjectListView

Parameters:

currentPage - int zero based page number

getDisplayedPage

public OwIterable<OwObject> getDisplayedPage()

Get the items for current displayed page.

Returns:

OwIterable current page

isCollectionComplete

public boolean isCollectionComplete()

Helper to identify if list is completely retrieved or there are more results.

Returns:

boolean

getPageSize

public int getPageSize()

Return the configured PageSize for lists.

Returns:

integer UI page list size

onClientRefreshContextUpdate

public void onClientRefreshContextUpdate(int iReason_p,
                                Object param_p)
                                  throws Exception

Description copied from interface: OwClientRefreshContext

call client and cause it to refresh its display data

Parameters:

iReason_p - int reason as defined in OwUpdateCodes

param_p - Object optional parameter representing the refresh, depends on the value of iReason_p, can be null

Throws:

Exception