com.wewebu.ow.server.plug.owbpm
Class OwBPMWorkItemListView

java.lang.Object
  com.wewebu.ow.server.ui.OwEventTarget
      com.wewebu.ow.server.ui.OwView
          com.wewebu.ow.server.ui.OwLayout
              com.wewebu.ow.server.plug.owbpm.OwBPMWorkItemListView

All Implemented Interfaces:

com.wewebu.ow.server.dmsdialogs.views.OwObjectListView.OwObjectListViewEventListner, com.wewebu.ow.server.ui.OwBaseView, com.wewebu.ow.server.ui.OwUpdateTarget, EventListener

public class OwBPMWorkItemListView
extends com.wewebu.ow.server.ui.OwLayout
implements com.wewebu.ow.server.dmsdialogs.views.OwObjectListView.OwObjectListViewEventListner

Workdesk BPM Plugin.
View for the workitems in a queue.

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.ui.OwLayout

com.wewebu.ow.server.ui.OwLayout.OwDispatchRegion

Field Summary

protected OwBPMVirtualQueue	m_currentQueue currently selected queue
protected com.wewebu.ow.server.app.OwMenuView	m_FilterCriteriaBtnView the buttons for the filter criteria form
protected int	m_iResubmitFilterToggleBtnIndex index of the resubmit filter menu toggle button
protected com.wewebu.ow.server.dmsdialogs.views.OwObjectListViewControl	m_listcontrol control for list view selection
protected com.wewebu.ow.server.app.OwMenuView	m_OptionMenuView the buttons for the filter menu
protected com.wewebu.ow.server.app.OwSearchCriteriaView	m_SearchCriteriaView view to display and edit the criteria
static int	MIN_MAX_CONTROL_VIEW name of the min max control region
static int	OBJECT_LIST_CONTROL_REGION name of the max object list control region
static int	OPTION_MENU_REGION name of the option menu region
static int	SEARCH_CRITERIA_BUTTON_REGION name of the button / menu region
static int	SEARCH_CRITERIA_REGION region of the work item list
static int	WORKITEM_LIST_REGION region of the work item list

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

m_Regions

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

OwBPMWorkItemListView()

Method Summary

OwBPMVirtualQueue	getCurrentQueue()
com.wewebu.ow.server.ecm.bpm.OwWorkitemContainer	getCurrentWorkitemcontainer() get the currently opened work item container
com.wewebu.ow.server.dmsdialogs.views.OwObjectListView	getListView() get the list view
protected void	init() init the target after the context is set.
boolean	isRegion(int iRegion_p) determine if region exists
protected void	onActivate(int iIndex_p, Object oReason_p) activate the target from a navigation module.
void	onDoReset(javax.servlet.http.HttpServletRequest request_p, Object oReason_p) event called when user clicked DoReset
void	onDoSearch(javax.servlet.http.HttpServletRequest request_p, Object oReason_p) event called when user clicked DoSearch
void	onObjectListViewFilterChange(com.wewebu.ow.server.field.OwSearchNode filterNode_p, com.wewebu.ow.server.ecm.OwObject parent_p)
String	onObjectListViewGetRowClassName(int iIndex_p, com.wewebu.ow.server.ecm.OwObject obj_p) get the style class name for the row
boolean	onObjectListViewItemClick(com.wewebu.ow.server.ecm.OwObject obj_p)
void	onObjectListViewSelect(com.wewebu.ow.server.ecm.OwObject object_p, com.wewebu.ow.server.ecm.OwObject parent_p)
void	onObjectListViewSort(com.wewebu.ow.server.field.OwSort newSort_p, String strSortProperty_p)
protected void	onRender(Writer w_p) called when the view should create its HTML content to be displayed
void	onToggleResubmitFilter(javax.servlet.http.HttpServletRequest request_p, Object oReason_p) event called when user clicked resubmit view button
void	setRefreshContext(com.wewebu.ow.server.app.OwClientRefreshContext eventlister_p) register an eventlistener with this view to receive notifications
void	update() refresh the list
void	updateGroupBoxSelectFilter()

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

addRegion, addView, addView, addViewReference, getIterator, getViewRegion, isRegionMaximized, isRegionMinimized, isRegionNormal, renderNamedRegion, renderRegion

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

activate, detach, getBreadcrumbPart, getDocument, getExternalFormEventTarget, getFormName, getFormTarget, getIcon, getMaximizeView, getParent, getRenderedNamedRegion, getRenderedRegion, getTitle, getViewList, isFormTargetExternal, isNamedRegion, isShowMaximized, isShowMinimized, isShowNormal, onUpdate, render, renderHTMLFormular, 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

Field Detail

WORKITEM_LIST_REGION

public static final int WORKITEM_LIST_REGION

region of the work item list

See Also:

Constant Field Values

SEARCH_CRITERIA_REGION

public static final int SEARCH_CRITERIA_REGION

region of the work item list

See Also:

Constant Field Values

MIN_MAX_CONTROL_VIEW

public static final int MIN_MAX_CONTROL_VIEW

name of the min max control region

See Also:

Constant Field Values

SEARCH_CRITERIA_BUTTON_REGION

public static final int SEARCH_CRITERIA_BUTTON_REGION

name of the button / menu region

See Also:

Constant Field Values

OPTION_MENU_REGION

public static final int OPTION_MENU_REGION

name of the option menu region

See Also:

Constant Field Values

OBJECT_LIST_CONTROL_REGION

public static final int OBJECT_LIST_CONTROL_REGION

name of the max object list control region

See Also:

Constant Field Values

m_SearchCriteriaView

protected com.wewebu.ow.server.app.OwSearchCriteriaView m_SearchCriteriaView

view to display and edit the criteria

m_FilterCriteriaBtnView

protected com.wewebu.ow.server.app.OwMenuView m_FilterCriteriaBtnView

the buttons for the filter criteria form

m_OptionMenuView

protected com.wewebu.ow.server.app.OwMenuView m_OptionMenuView

the buttons for the filter menu

m_currentQueue

protected OwBPMVirtualQueue m_currentQueue

currently selected queue

m_listcontrol

protected com.wewebu.ow.server.dmsdialogs.views.OwObjectListViewControl m_listcontrol

control for list view selection

m_iResubmitFilterToggleBtnIndex

protected int m_iResubmitFilterToggleBtnIndex

index of the resubmit filter menu toggle button

Constructor Detail

OwBPMWorkItemListView

public OwBPMWorkItemListView()

Method Detail

init

protected void init()
             throws Exception

init the target after the context is set.

Overrides:

init in class com.wewebu.ow.server.ui.OwView

Throws:

Exception

isRegion

public boolean isRegion(int iRegion_p)

determine if region exists

Specified by:

isRegion in interface com.wewebu.ow.server.ui.OwBaseView

Overrides:

isRegion in class com.wewebu.ow.server.ui.OwLayout

Parameters:

iRegion_p - ID of the region to render

Returns:

true if region contains anything and should be rendered

getCurrentQueue

public OwBPMVirtualQueue getCurrentQueue()

getListView

public com.wewebu.ow.server.dmsdialogs.views.OwObjectListView getListView()

get the list view

Returns:

OwObjectListView

onDoReset

public void onDoReset(javax.servlet.http.HttpServletRequest request_p,
                      Object oReason_p)
               throws Exception

event called when user clicked DoReset

Parameters:

request_p - a HttpServletRequest

oReason_p - Reason object submitted in the menu item creation

Throws:

Exception

onDoSearch

public void onDoSearch(javax.servlet.http.HttpServletRequest request_p,
                       Object oReason_p)
                throws Exception

event called when user clicked DoSearch

Parameters:

request_p - a HttpServletRequest

oReason_p - Reason object submitted in the menu item creation

Throws:

Exception

onToggleResubmitFilter

public void onToggleResubmitFilter(javax.servlet.http.HttpServletRequest request_p,
                                   Object oReason_p)
                            throws Exception

event called when user clicked resubmit view button

Parameters:

request_p - a HttpServletRequest

oReason_p - Reason object submitted in the menu item creation

Throws:

Exception

onActivate

protected void onActivate(int iIndex_p,
                          Object oReason_p)
                   throws Exception

activate the target from a navigation module. Called when menu item was pressed for this target.

Overrides:

onActivate in class com.wewebu.ow.server.ui.OwView

Parameters:

iIndex_p - tab iIndex of Navigation

oReason_p - User Object which was submitted when target was attached to the navigation module

Throws:

Exception

update

public void update()
            throws Exception

refresh the list

Throws:

Exception

setRefreshContext

public void setRefreshContext(com.wewebu.ow.server.app.OwClientRefreshContext eventlister_p)

register an eventlistener with this view to receive notifications

Parameters:

eventlister_p - OwClientRefreshContext interface

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 com.wewebu.ow.server.ui.OwView

Parameters:

w_p - Writer object to write HTML to

Throws:

Exception

onObjectListViewSort

public void onObjectListViewSort(com.wewebu.ow.server.field.OwSort newSort_p,
                                 String strSortProperty_p)
                          throws Exception

Specified by:

onObjectListViewSort in interface com.wewebu.ow.server.dmsdialogs.views.OwObjectListView.OwObjectListViewEventListner

Throws:

Exception

onObjectListViewSelect

public void onObjectListViewSelect(com.wewebu.ow.server.ecm.OwObject object_p,
                                   com.wewebu.ow.server.ecm.OwObject parent_p)
                            throws Exception

Specified by:

onObjectListViewSelect in interface com.wewebu.ow.server.dmsdialogs.views.OwObjectListView.OwObjectListViewEventListner

Throws:

Exception

onObjectListViewFilterChange

public void onObjectListViewFilterChange(com.wewebu.ow.server.field.OwSearchNode filterNode_p,
                                         com.wewebu.ow.server.ecm.OwObject parent_p)
                                  throws Exception

Specified by:

onObjectListViewFilterChange in interface com.wewebu.ow.server.dmsdialogs.views.OwObjectListView.OwObjectListViewEventListner

Throws:

Exception

onObjectListViewItemClick

public boolean onObjectListViewItemClick(com.wewebu.ow.server.ecm.OwObject obj_p)
                                  throws Exception

Specified by:

onObjectListViewItemClick in interface com.wewebu.ow.server.dmsdialogs.views.OwObjectListView.OwObjectListViewEventListner

Throws:

Exception

getCurrentWorkitemcontainer

public com.wewebu.ow.server.ecm.bpm.OwWorkitemContainer getCurrentWorkitemcontainer()
                                                                             throws com.wewebu.ow.server.exceptions.OwObjectNotFoundException

get the currently opened work item container

Returns:

OwWorkitemContainer

Throws:

com.wewebu.ow.server.exceptions.OwObjectNotFoundException

updateGroupBoxSelectFilter

public void updateGroupBoxSelectFilter()
                                throws Exception

Throws:

Exception

onObjectListViewGetRowClassName

public String onObjectListViewGetRowClassName(int iIndex_p,
                                              com.wewebu.ow.server.ecm.OwObject obj_p)

get the style class name for the row

Specified by:

onObjectListViewGetRowClassName in interface com.wewebu.ow.server.dmsdialogs.views.OwObjectListView.OwObjectListViewEventListner

Parameters:

iIndex_p - int row index

obj_p - current OwObject

Returns:

String with style class name, or null to use default