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

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

All Implemented Interfaces:

OwClientRefreshContext, OwPageableView, OwBaseView, OwUpdateTarget, EventListener

public class OwObjectListViewCombined
extends OwPageableListView

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

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

Modifier and Type	Field and Description
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, 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

Constructor and Description
OwObjectListViewCombined()
OwObjectListViewCombined(int iViewMask_p) construct a object list view

Method Summary

Methods

Modifier and Type	Method and Description
void	detach() remove view and all subviews from context
protected OwXMLUtil	getConfigNode() Simple getter of configuration
String	getIcon() get the icon URL for this view to be displayed
boolean	getIsList() same as getIsListValid() && ( ! getIsListEmpty() )
boolean	getIsListEmpty() Deprecated. since 4.2.0.0 use OwObjectListView.getCount() != 0 instead
boolean	getIsListValid() check if list is configured well and can be displayed
boolean	getIsPaging() Deprecated. since 4.2.0.0 use OwObjectListView.hasPaging()
Collection<String>	getRetrievalPropertyNames() get a collection of property names that are needed to display the Objects in the list i.e.
String	getTitle() overridable title of the view
protected void	init() Initialize the view after the context is set.
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<? extends OwFieldColumnInfo> 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 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 eventlistner_p) register an event listener 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.OwPageableListView

canPageNext, canPagePrev, getColumnInfo, getCurrentPage, getDisplayedPage, getFieldManager, getObjectIterable, getObjectList, getPageAbsolutEventURL, getPageCount, getPageNextEventURL, getPagePrevEventURL, getPageSize, getRefreshContext, getSort, isCollectionComplete, isPagingEnabled, onClientRefreshContextUpdate, onPageAbsolut, onPageNext, onPagePrev

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, isEmptyPluginColumnRendered, isObjectSelectionPersisted, isObjectTypeSupportedByPlugin, isShowMaximized, isStickyFooterInUse, persistAjaxTriggeredSelection, persistAjaxTriggeredSelection, persistObjectSelectionState, renderContextMenu, resetPersistedSelectionState, setCurrentPage, setFilter, setParentObject, setRenderEmptyPluginColumn, setStickyFooterInUse, setViewMask

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

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

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

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

getConfigNode

protected OwXMLUtil getConfigNode()

Simple getter of configuration

Returns:

OwXMLUtil (can return null, if setConfigNode(Node) was not called yet)

Since:

4.2.0.0

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

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

@Deprecated
public boolean getIsListEmpty()

Deprecated. since 4.2.0.0 use OwObjectListView.getCount() != 0 instead

check if list contains any items

Returns:

boolean

getIsPaging

@Deprecated
public boolean getIsPaging()

Deprecated. since 4.2.0.0 use OwObjectListView.hasPaging()

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

setFieldManager

public void setFieldManager(OwFieldManager fieldmanager_p)

Description copied from class: OwObjectListView

set the internal fieldmanager in case you want a specific fieldmanager

Overrides:

setFieldManager in class OwPageableListView

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.

Overrides:

getRetrievalPropertyNames in class OwPageableListView

Returns:

Collection of String

Throws:

Exception

pageAbsolut

protected void pageAbsolut(int iPage_p)

Description copied from class: OwObjectListView

Move to the given zero based absolute page.

Overrides:

pageAbsolut in class OwPageableListView

Parameters:

iPage_p - int zero based page number

setColumnInfo

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

Description copied from class: OwObjectListView

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

Overrides:

setColumnInfo in class OwPageableListView

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

Overrides:

setObjectList in class OwPageableListView

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.

Overrides:

setObjectIterable in class OwPageableListView

Parameters:

iterable - OwIterable returning OwObjects

parentObject_p - OwObject

Throws:

Exception

setRefreshContext

public void setRefreshContext(OwClientRefreshContext eventlistner_p)

Description copied from class: OwObjectListView

register an event listener with this view to receive notifications

Overrides:

setRefreshContext in class OwPageableListView

Parameters:

eventlistner_p - OwClientRefreshContext interface

setSort

public void setSort(OwSort sort_p)

Description copied from class: OwObjectListView

set / override current sort to given sort

Overrides:

setSort in class OwPageableListView

Parameters:

sort_p - new OwSort

getTitle

public String getTitle()

Description copied from class: OwView

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

detach

public void detach()

Description copied from class: OwView

remove view and all subviews from context

Overrides:

detach in class OwPageableListView