com.wewebu.ow.server.plug.owbpm.plug

Class OwBPMDisplayWorkflowDialog

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

com.wewebu.ow.server.app.OwStandardDialog

com.wewebu.ow.server.app.OwStandardSequenceDialog

com.wewebu.ow.server.plug.owbpm.plug.OwBPMDisplayWorkflowDialog

All Implemented Interfaces:

com.wewebu.ow.server.app.OwSequenceView, com.wewebu.ow.server.ui.OwBaseView, com.wewebu.ow.server.ui.OwUpdateTarget

public class OwBPMDisplayWorkflowDialog
extends com.wewebu.ow.server.app.OwStandardSequenceDialog

Dialog which display a graphical representation of workflow.

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

com.wewebu.ow.server.ui.OwDialog.OwDialogListener

Nested classes/interfaces inherited from class com.wewebu.ow.server.ui.OwLayout

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

Field Summary

Fields

Modifier and Type	Field and Description
protected int	m_iIndex current item index
protected int	m_iMaxElementSize max number of items to display in the views
protected List<com.wewebu.ow.server.ecm.OwObject>	m_items list of items to work on
protected com.wewebu.ow.server.app.OwMimeManager	m_MimeManager instance of the MIME manager used to open the objects
protected com.wewebu.ow.server.ecm.OwObject	m_ParentObject the parent of the object that listed the getItem()

Fields inherited from class com.wewebu.ow.server.app.OwStandardDialog

CLOSE_BTN_REGION, FOOTER_REGION, HELP_BTN_REGION, INFO_ICON_REGION, LEFT_REGION, m_strHelpPath, m_strInfoIconURL, m_strTitle, MAIN_REGION, MENU_REGION, RIGHT_REGION, STANDARD_DIALOG_REGION_MAX, TITLE_REGION

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

m_iDEBUG_DocumentViewSize, m_iDEBUG_InitDocument, m_iDEBUG_TargetCount, m_Listener

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

Constructors

Constructor and Description
OwBPMDisplayWorkflowDialog(OwBPMDisplayWorkflowDialogBuilder builder)

Method Summary

Methods

Modifier and Type	Method and Description
protected OwBPMDisplayWorkflowDialogBuilder	createDialogBuilder() Create a builder instance for OwEditPropertiesDialog creation.
protected com.wewebu.ow.server.app.OwMimeManager	createMimeManager()
protected void	createNewDialog() init the dialog with the current item
void	detach()
int	getCount() get the number of sequence items in the dialog
com.wewebu.ow.server.ecm.OwObject	getItem() the work item to work on
com.wewebu.ow.server.app.OwJspFormConfigurator	getJspConfigurator()
com.wewebu.ow.server.app.OwMimeManager	getMimeManager() get the MIME manager
Set<com.wewebu.ow.server.ecm.OwObject>	getObjects()
boolean	hasNext() called when the Dialog needs to know if there is a next item
boolean	hasPrev() called when the Dialog needs to know if there is a prev item
protected void	init()
boolean	isRegion(int iRegion_p) determine if region contains a view
void	next(boolean fRemoveCurrent_p) move to next item and roll over, i.e.
boolean	onCancel(javax.servlet.http.HttpServletRequest request_p) Called when the user wants to cancel the workflow selection process
void	prev(boolean fRemoveCurrent_p) move to prev item and roll over, i.e.
void	renderMainRegion(Writer w_p) render the views of the region
void	renderRegion(Writer w_p, int iRegion_p) render the views of the region
void	renderSequenceNumber(Writer w_p) render the no.
void	setJspConfigurator(com.wewebu.ow.server.app.OwJspFormConfigurator jspFormConfigurator_p)
List<String>	tooltipLinesFor(com.wewebu.ow.server.ecm.OwObject object) Creates a list of lines to be displayed in the tool-tip associated with the diagram for the given workflow.

Methods inherited from class com.wewebu.ow.server.app.OwStandardSequenceDialog

getNextHREF, getPrevHREF, onNext, onPrev, renderNavigationButtons

Methods inherited from class com.wewebu.ow.server.app.OwStandardDialog

getInfoIcon, getTitle, hasHelpButton, onClose, onHelp, onRender, renderCloseButton, renderHelpButton, setHelp, setInfoIcon, setTitle

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

closeDialog, setListener

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

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

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

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

m_items

protected List<com.wewebu.ow.server.ecm.OwObject> m_items

list of items to work on

m_iIndex

protected int m_iIndex

current item index

m_MimeManager

protected com.wewebu.ow.server.app.OwMimeManager m_MimeManager

instance of the MIME manager used to open the objects

m_ParentObject

protected com.wewebu.ow.server.ecm.OwObject m_ParentObject

the parent of the object that listed the getItem()

m_iMaxElementSize

protected int m_iMaxElementSize

max number of items to display in the views

Constructor Detail

OwBPMDisplayWorkflowDialog

public OwBPMDisplayWorkflowDialog(OwBPMDisplayWorkflowDialogBuilder builder)

Method Detail

init

protected void init()
             throws Exception

Overrides:

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

Throws:

Exception

renderMainRegion

public void renderMainRegion(Writer w_p)
                      throws Exception

render the views of the region

Parameters:

w_p - Writer object to write HTML to

Throws:

Exception

renderRegion

public void renderRegion(Writer w_p,
                int iRegion_p)
                  throws Exception

render the views of the region

Specified by:

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

Overrides:

renderRegion in class com.wewebu.ow.server.app.OwStandardSequenceDialog

Parameters:

w_p - Writer object to write HTML to

iRegion_p - ID of the region to render

Throws:

Exception

detach

public void detach()

Overrides:

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

onCancel

public boolean onCancel(javax.servlet.http.HttpServletRequest request_p)
                 throws Exception

Called when the user wants to cancel the workflow selection process

Returns:

always true

Throws:

Exception

getObjects

public Set<com.wewebu.ow.server.ecm.OwObject> getObjects()

Returns:

the objects

tooltipLinesFor

public List<String> tooltipLinesFor(com.wewebu.ow.server.ecm.OwObject object)

Creates a list of lines to be displayed in the tool-tip associated with the diagram for the given workflow.

Parameters:

object - The workflow object to build the tool-tip for.

Returns:

A list of tool-tips to be displayed.

Since:

4.2.0.0

getItem

public com.wewebu.ow.server.ecm.OwObject getItem()

the work item to work on

hasNext

public boolean hasNext()
                throws Exception

called when the Dialog needs to know if there is a next item

Specified by:

hasNext in interface com.wewebu.ow.server.app.OwSequenceView

Overrides:

hasNext in class com.wewebu.ow.server.app.OwStandardSequenceDialog

Throws:

Exception

hasPrev

public boolean hasPrev()
                throws Exception

called when the Dialog needs to know if there is a prev item

Specified by:

hasPrev in interface com.wewebu.ow.server.app.OwSequenceView

Overrides:

hasPrev in class com.wewebu.ow.server.app.OwStandardSequenceDialog

Throws:

Exception

getCount

public int getCount()

get the number of sequence items in the dialog

prev

public void prev(boolean fRemoveCurrent_p)
          throws Exception

move to prev item and roll over, i.e. start at the end one if first one is reached

Parameters:

fRemoveCurrent_p - true = remove the current sequence item and then move to the prev item, if this is the last item, closes the dialog

Throws:

Exception

next

public void next(boolean fRemoveCurrent_p)
          throws Exception

move to next item and roll over, i.e. start at the first one if end is reached

Parameters:

fRemoveCurrent_p - true = remove the current sequence item and then move to the next item, if this is the last item, closes the dialog

Throws:

Exception

createDialogBuilder

protected OwBPMDisplayWorkflowDialogBuilder createDialogBuilder()

Create a builder instance for OwEditPropertiesDialog creation.

Returns:

instance of OwEditPropertiesDialogBuilder

Since:

4.2.0.0

createNewDialog

protected void createNewDialog()
                        throws Exception

init the dialog with the current item

Throws:

Exception

getJspConfigurator

public com.wewebu.ow.server.app.OwJspFormConfigurator getJspConfigurator()

setJspConfigurator

public void setJspConfigurator(com.wewebu.ow.server.app.OwJspFormConfigurator jspFormConfigurator_p)

getMimeManager

public com.wewebu.ow.server.app.OwMimeManager getMimeManager()

get the MIME manager

Returns:

OwMimeManager

createMimeManager

protected com.wewebu.ow.server.app.OwMimeManager createMimeManager()

isRegion

public boolean isRegion(int iRegion_p)

determine if region contains a view

Specified by:

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

Overrides:

isRegion in class com.wewebu.ow.server.app.OwStandardDialog

Parameters:

iRegion_p - ID of the region to render

Returns:

true if region contains anything and should be rendered

renderSequenceNumber

public void renderSequenceNumber(Writer w_p)
                          throws Exception

render the no. of elements (x from y)

Parameters:

w_p - Writer object to write HTML to

Throws:

Exception