Class Index | File Index

Classes


Class Alfresco.component.WorkflowForm

Extends Alfresco.component.Base
WorkflowForm component.

The workflow details page form is actually a form display of the workflow's start task and data form the workflow itself.
To be able to display all this information the following approach is taken:

1. The page loads with a url containing the workflowId as an argument.
2. Since we actually want to display the start task the data-loader component has been bound in to the bottom of the page,
instructed to load detailed workflow data based on the workflowId url argument,
so we can get the startTaskInstanceId needed to request the form.
3. A dynamically/ajax loaded form is brought in using the startTaskInstanceId which gives us a start task form with the
"More Info", "Roles" and "Items" sections.
4. However we shall also display info from the workflow itsel, so once the form is loaded and inserted in to the Dom,
the additional sections "Summary", "General", "Current Tasks" & "Workflow History" are inserted inside the form.
Defined in: workflow-form.js
Constructor Summary
Constructor Attributes Constructor Name and Description
 
WorkflowForm constructor.
Field Summary
Field Attributes Field Name and Description
 
Sorted list of current tasks
 
Sorted list of workflow history
 
Flag set after component is instantiated.
 
Object container for initialization options
 
The workflow to display
Fields borrowed from class Alfresco.component.Base:
modules, services, widgets
Method Summary
Method Attributes Method Name and Description
 
Fired by YUI when parent element is available for scripting
 
Event handler called when the "onWorkflowDetailedData" event is received
 
Called when a workflow form has been loaded.
 
renderCellComment(elCell, oRecord, oColumn, oData)
Render task comment
 
renderCellCurrentTasksActions(elCell, oRecord, oColumn, oData)
Render actions available for current tasks
 
renderCellDateCompleted(elCell, oRecord, oColumn, oData)
Render task completed date
 
renderCellDueDate(elCell, oRecord, oColumn, oData)
Render task due date
 
renderCellOutcome(elCell, oRecord, oColumn, oData)
Render task outcome
 
renderCellOwner(elCell, oRecord, oColumn, oData)
Render task owner as link
 
renderCellStatus(elCell, oRecord, oColumn, oData)
Render task status
 
renderCellType(elCell, oRecord, oColumn, oData)
Render task type as link
 
Called when view workflow diagram button is clicked.
Methods borrowed from class Alfresco.component.Base:
attachLinkClickListeners, bind, createYUIButtons, destroy, fire, invokeAction, msg, onComponentLoaded, onComponentsLoaded, onReadyWrapper, refresh, setMessages, setOptions
Constructor Detail
Alfresco.component.WorkflowForm(htmlId)
WorkflowForm constructor.
Parameters:
{String} htmlId
The HTML id of the parent element
Returns:
{Alfresco.component.WorkflowForm} The new WorkflowForm instance
Field Detail
currentTasks
Sorted list of current tasks

historyTasks
Sorted list of workflow history

isReady
Flag set after component is instantiated.

{object} options
Object container for initialization options

workflow
The workflow to display
Method Detail
onReady()
Fired by YUI when parent element is available for scripting

onWorkflowDetailedData(layer, args)
Event handler called when the "onWorkflowDetailedData" event is received
Parameters:
layer
args

onWorkflowFormLoaded(response)
Called when a workflow form has been loaded.
Will insert the form in the Dom.
Parameters:
{Object} response

renderCellComment(elCell, oRecord, oColumn, oData)
Render task comment
Parameters:
{object} elCell
{object} oRecord
{object} oColumn
oData
{object|string}

renderCellCurrentTasksActions(elCell, oRecord, oColumn, oData)
Render actions available for current tasks
Parameters:
{object} elCell
{object} oRecord
{object} oColumn
oData
{object|string}

renderCellDateCompleted(elCell, oRecord, oColumn, oData)
Render task completed date
Parameters:
{object} elCell
{object} oRecord
{object} oColumn
oData
{object|string}

renderCellDueDate(elCell, oRecord, oColumn, oData)
Render task due date
Parameters:
{object} elCell
{object} oRecord
{object} oColumn
oData
{object|string}

renderCellOutcome(elCell, oRecord, oColumn, oData)
Render task outcome
Parameters:
{object} elCell
{object} oRecord
{object} oColumn
oData
{object|string}

renderCellOwner(elCell, oRecord, oColumn, oData)
Render task owner as link
Parameters:
{object} elCell
{object} oRecord
{object} oColumn
oData
{object|string}

renderCellStatus(elCell, oRecord, oColumn, oData)
Render task status
Parameters:
{object} elCell
{object} oRecord
{object} oColumn
oData
{object|string}

renderCellType(elCell, oRecord, oColumn, oData)
Render task type as link
Parameters:
{object} elCell
{object} oRecord
{object} oColumn
oData
{object|string}

viewWorkflowDiagram()
Called when view workflow diagram button is clicked.
WIll display the workflow's diagram.

Documentation generated by JsDoc Toolkit 2.4.0 on Thu Feb 16 2012 12:24:24 GMT-0000 (GMT)