com.wewebu.ow.server.dmsdialogs.views
Class OwObjectListViewCombined

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.OwObjectListViewCombined

All Implemented Interfaces:

OwPageableView, OwBaseView, OwUpdateTarget

public class OwObjectListViewCombined
extends OwObjectListView

List View: OwObject List View Combined.

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

Nested Class Summary

protected class

OwObjectListViewCombined.OwObjectListViewRowCombined

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

protected Collection	m_ColumnInfoList a list of column info, which describe the columns of the object list
protected ArrayList	m_SubViews
protected static String	QUERY_KEY_PAGE_COMBINED query string key for the page index.

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, 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

OwObjectListViewCombined()
construct a object list view

OwObjectListViewCombined(int iViewMask_p)
construct a object list view

Method Summary

boolean	canPageNext() check if there is a next page
boolean	canPagePrev() check if there is a previous page
Collection	getColumnInfo() get the list of column info to be used by this list view
int	getCount() get number of items in the list
int	getCurrentPage() get current zero based page number in multiples of getPageSize()
OwFieldManager	getFieldManager() get the internal fieldmanager
String	getIcon() get the icon URL for this view to be displayed
boolean	getIsList() same as getIsListValid() && ( ! getIsListEmpty() )
boolean	getIsListEmpty() check if list contains any items
boolean	getIsListValid() check if list is configured well and can be displayed
boolean	getIsPaging() check if page buttons should be rendered
OwObjectCollection	getObjectList() get the current object list
int	getPageCount() retrieve number of available pages
OwObject	getParentObject() get the parent object
protected OwClientRefreshContext	getRefreshContext() get an eventlistener with this view to receive notifications
Collection	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
String	getTitle() overridable title of the view
protected void	init() Initialize the view after the context is set.
protected boolean	isPagingEnabled() check if paging is enabled
boolean	isShowMaximized() checks if the view is shown maximized
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	onRender(Writer w_p) called when the view should create its HTML content to be displayed
protected void	pageAbsolut(int iPage_p) Move to the given zero based absolute page.
protected void	renderCombinedPageButtons(Writer w_p) render the paging buttons for the combined view
void	setColumnInfo(Collection columnInfo_p) set the list of column info to be used by this list view
void	setConfigNode(Node node_p) optional use the default constructor and set a config node to configure the view with XML This may override the settings in the ViewMaks, see setViewMask
void	setDocumentFunctionPluginList(List pluginList_p) Set a java.util.List of OwDocumentFunction to be used by this list.
void	setEventListner(OwObjectListView.OwObjectListViewEventListner eventlister_p) Register an eventlistener with this view to receive notifications.
void	setFieldManager(OwFieldManager fielmanager_p) set the internal fieldmanager in case you want a specific fieldmanager
void	setObjectList(OwObjectCollection objectList_p, OwObject parentObject_p) set the list of objects to be displayed by this list view
void	setRefreshContext(OwClientRefreshContext eventlistner_p) register an eventlistener with this view to receive notifications
void	setSort(OwSort sort_p) 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, getDocumentFunction, getDocumentFunctionPluginList, getEventListner, getFilter, getFilterOperators, getFilterSearch, getListViewID, getPageAbsolutEventURL, getPageNextEventURL, getPagePrevEventURL, getPluginEntries, hasPaging, hasViewMask, isEmptyPluginColumnRendered, isObjectSelectionPersisted, isObjectTypeSupportedByPlugin, isStickyFooterInUse, persistAjaxTriggeredSelection, persistObjectSelectionState, renderContextMenu, resetPersistedSelectionState, setCurrentPage, setFilter, setParentObject, setRenderEmptyPluginColumn, setStickyFooterInUse, setViewMask

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

activate, addView, detach, getBreadcrumbPart, getDocument, getExternalFormEventTarget, getFormName, getFormTarget, getIterator, getMaximizeView, getParent, getRenderedNamedRegion, getRenderedRegion, getViewList, isFormTargetExternal, isNamedRegion, isRegion, isShowMinimized, isShowNormal, onActivate, 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, isNamedRegion, isRegion, render, renderNamedRegion, renderRegion

Field Detail

m_SubViews

protected ArrayList m_SubViews

m_ColumnInfoList

protected Collection m_ColumnInfoList

a list of column info, which describe the columns of the object list

QUERY_KEY_PAGE_COMBINED

protected static final String QUERY_KEY_PAGE_COMBINED

query string key for the page index.

See Also:

Constant Field Values

Constructor Detail

OwObjectListViewCombined

public OwObjectListViewCombined(int iViewMask_p)

construct a object list view

Parameters:

iViewMask_p - int combination of VIEW_MASK_... defined flags

OwObjectListViewCombined

public OwObjectListViewCombined()

construct a object list view

Method Detail

setConfigNode

public void setConfigNode(Node node_p)
                   throws Exception

optional use the default constructor and set a config node to configure the view with XML This may override the settings in the ViewMaks, see setViewMask

Overrides:

setConfigNode in class OwObjectListView

Parameters:

node_p - XML node with configuration information

Throws:

Exception

init

protected void init()
             throws Exception

Initialize the view after the context is set.

Overrides:

init in class OwObjectListView

Throws:

Exception

setDocumentFunctionPluginList

public void setDocumentFunctionPluginList(List pluginList_p)

Set a java.util.List of OwDocumentFunction to be used by this list. This list overrides the default set of document functions that are retrieved from the context during init.

Overrides:

setDocumentFunctionPluginList in class OwObjectListView

Parameters:

pluginList_p - the java.util.List of OwDocumentFunction to be used by this list. Must not be null.

onRender

protected void onRender(Writer w_p)
                 throws Exception

called when the view should create its HTML content to be displayed

Overrides:

onRender in class OwView

Parameters:

w_p - Writer object to write HTML to

Throws:

Exception

isShowMaximized

public boolean isShowMaximized()

checks if the view is shown maximized

Overrides:

isShowMaximized in class OwView

Returns:

true, if view is maximized, false otherwise

isPagingEnabled

protected boolean isPagingEnabled()

check if paging is enabled

Overrides:

isPagingEnabled in class OwObjectListView

Returns:

true = enabled, display page buttons, false = disabled

getIsList

public boolean getIsList()

same as getIsListValid() && ( ! getIsListEmpty() )

Returns:

boolean true = valid list with at least one item to display

getIsListValid

public boolean getIsListValid()

check if list is configured well and can be displayed

Returns:

boolean true = list is valid, false = no valid list, don't render anything yet

getIsListEmpty

public boolean getIsListEmpty()

check if list contains any items

Returns:

boolean true = list contains at least one item

getIsPaging

public boolean getIsPaging()

check if page buttons should be rendered

Returns:

true = render page buttons, false = no page buttons to render

renderCombinedPageButtons

protected void renderCombinedPageButtons(Writer w_p)
                                  throws Exception

render the paging buttons for the combined view

Parameters:

w_p - Writer object to write HTML to

Throws:

Exception

onPageNext

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

display next page of objects

Specified by:

onPageNext in interface OwPageableView

Overrides:

onPageNext in class OwObjectListView

Throws:

Exception

See Also:

OwPageableView.onPageNext(javax.servlet.http.HttpServletRequest)

onPagePrev

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

display previous page of objects

Specified by:

onPagePrev in interface OwPageableView

Overrides:

onPagePrev in class OwObjectListView

Throws:

Exception

See Also:

OwPageableView.onPagePrev(javax.servlet.http.HttpServletRequest)

getPageCount

public int getPageCount()
                 throws Exception

Description copied from class: OwObjectListView

retrieve number of available pages

Specified by:

getPageCount in interface OwPageableView

Overrides:

getPageCount in class OwObjectListView

Returns:

int number of pages for paging in multiples of getPageSize()

Throws:

Exception

getCurrentPage

public int getCurrentPage()

Description copied from class: OwObjectListView

get current zero based page number in multiples of getPageSize()

Specified by:

getCurrentPage in interface OwPageableView

Overrides:

getCurrentPage in class OwObjectListView

Returns:

current zero based page number in multiples of getPageSize()

canPagePrev

public boolean canPagePrev()

check if there is a previous page

Specified by:

canPagePrev in interface OwPageableView

Overrides:

canPagePrev in class OwObjectListView

Returns:

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

canPageNext

public boolean canPageNext()
                    throws Exception

check if there is a next page

Specified by:

canPageNext in interface OwPageableView

Overrides:

canPageNext in class OwObjectListView

Returns:

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

Throws:

Exception

getColumnInfo

public Collection 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

getCount

public int getCount()

Description copied from class: OwObjectListView

get number of items in the list

Specified by:

getCount in interface OwPageableView

Specified by:

getCount in class OwObjectListView

Returns:

int

getFieldManager

public OwFieldManager getFieldManager()

Description copied from class: OwObjectListView

get the internal fieldmanager

Specified by:

getFieldManager in class OwObjectListView

setFieldManager

public void setFieldManager(OwFieldManager fielmanager_p)

set the internal fieldmanager in case you want a specific fieldmanager

Specified by:

setFieldManager in class OwObjectListView

getObjectList

public OwObjectCollection getObjectList()

Description copied from class: OwObjectListView

get the current object list

Specified by:

getObjectList in class OwObjectListView

getParentObject

public OwObject getParentObject()

Description copied from class: OwObjectListView

get the parent object

Overrides:

getParentObject in class OwObjectListView

Returns:

OwObject

getRetrievalPropertyNames

public Collection 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 roundtrips.

Specified by:

getRetrievalPropertyNames in class OwObjectListView

Returns:

Collection of String

Throws:

Exception

getSort

public OwSort getSort()

Description copied from class: OwObjectListView

get the current selected sort instance

Specified by:

getSort in class OwObjectListView

Returns:

OwSort object

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

pageAbsolut

protected void pageAbsolut(int iPage_p)
                    throws Exception

Description copied from class: OwObjectListView

Move to the given zero based absolute page.

Overrides:

pageAbsolut in class OwObjectListView

Parameters:

iPage_p - int zero based page number

Throws:

Exception

setColumnInfo

public void setColumnInfo(Collection columnInfo_p)

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_p - List of OwFieldColumnInfo's

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

setRefreshContext

public void setRefreshContext(OwClientRefreshContext eventlistner_p)

Description copied from class: OwObjectListView

register an eventlistener with this view to receive notifications

Specified by:

setRefreshContext in class OwObjectListView

Parameters:

eventlistner_p - OwClientRefreshContext interface

setSort

public void setSort(OwSort sort_p)

Description copied from class: OwObjectListView

set / override current sort to given sort

Specified by:

setSort in class OwObjectListView

Parameters:

sort_p - new OwSort

getTitle

public String getTitle()

overridable title of the view

Specified by:

getTitle in interface OwBaseView

Overrides:

getTitle in class OwView

Returns:

String localized display name for the view

getIcon

public String getIcon()
               throws Exception

get the icon URL for this view to be displayed

Overrides:

getIcon in class OwView

Returns:

String icon url, or null if not defined

Throws:

Exception

setEventListner

public void setEventListner(OwObjectListView.OwObjectListViewEventListner eventlister_p)

Register an eventlistener with this view to receive notifications. Also propagates the event listener to subviews.

Overrides:

setEventListner in class OwObjectListView

Parameters:

eventlister_p - OwObjectListCollectionEventListner interface

onPageAbsolut

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

Description copied from interface: OwPageableView

display absolute page of objects

Specified by:

onPageAbsolut in interface OwPageableView

Overrides:

onPageAbsolut in class OwObjectListView

Throws:

Exception

Since:

2.5.2.0

See Also:

OwObjectListView.onPageAbsolut(javax.servlet.http.HttpServletRequest)