Class Monk.feature.Workflow

Extends Monk.feature.MonkBase.
A version of MonkBase which uses Ext 2.0 to create a workflow layout.
Defined in: workflowFeature.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	Monk.feature.Workflow(args)

Field Summary
Field Attributes	Field Name and Description
	componentGroups The list of component groups (pulled from Monk.feature.MonkBase#plugins).
	components The list of components (pulled from Monk.feature.MonkBase#plugins).
	flowManager Manages movement between the steps of the workflow.
	headerPanel Contains the header.
	helpComponent Used to display help for each step of the workflow.
	initialDestination Where should we go after loading everything.
	initialParameterNames The recognized request parameter names.
	initialParameters Holds parameters passed in through the URL.
	initialProgressWin Stores the progress window for loading metadata, etc.
	searchComponent Used to perform searches in components and in the workbench.
	toolFlowManager Manages movement between the steps of the toolset.
	toolsets The list of toolsets.
	toolWindowRegistry Used for tracking component/window relation.
	windowManager Keeps track of component windows and provides layout functions.

Fields borrowed from class Monk.feature.MonkBase:: files, plugins

Method Summary
Method Attributes	Method Name and Description
	destroyComponent(componentWindow) Destroy a component.
	focusComponent(componentWindow) Give the component focus if desktop window has been clicked
	getURLParameters() Parse any parameters included in the URL and set them in Monk.feature.Workflow#initialParameters.
	goToDestination() Go to the destination stored in Monk.feature.Workflow#initialDestination using Monk.component.FlowManager (and Monk.component.ToolFlowManager).
	handle(monkEvent, data) Events handled by this component: Workbench.event.ComponentLoaded Workbench.event.ComponentRemoved Monk.event.workbench.LocalWindowFocus Monk.event.CollectionsMetadataHierarchyLoaded Monk.event.workbench.InitialParametersProcessed
	initialize() Initialize everything and load the collections meta data.
	initializeComponent(componentId) Initialize a component.
	initializeHeader() Initialize the header.
	initializeLayout() Initialize the layout.
	initializeParameters() Analyze request parameters and perform various loading operations based on their contents.
	initializeTools() Initialize the tools.
	initializeToolsets() Initialize toolsets.
	switchComponent(oldComponentId, newComponentId) Replace one component with another.

Class Detail

Monk.feature.Workflow(args)

Author: Andrew.

Parameters:
args

Field Detail

{Ext.util.MixedCollection} componentGroups

The list of component groups (pulled from Monk.feature.MonkBase#plugins).

{Ext.util.MixedCollection} components

The list of components (pulled from Monk.feature.MonkBase#plugins). See Monk.feature.Workflow#initializeTools.

{Monk.component.FlowManager} flowManager

Manages movement between the steps of the workflow.

{Ext.Panel} headerPanel

Contains the header. See Monk.feature.Workflow#initializeHeader.

{Monk.component.HelpComponent} helpComponent

Used to display help for each step of the workflow.

{Array} initialDestination

Where should we go after loading everything.

{Array} initialParameterNames

The recognized request parameter names.

projectId
worksetId
toolsetId
instanceId

{Ext.util.MixedCollection} initialParameters

Holds parameters passed in through the URL. See Monk.feature.Workflow.initialParameterNames for allowed parameter names. Possible combinations:

projectId and instanceId (for loading a result)
projectId and worksetId and/or toolsetId

{Ext.Window} initialProgressWin

Stores the progress window for loading metadata, etc.

{Monk.framework.component.SearchComponent} searchComponent

Used to perform searches in components and in the workbench.

{Monk.component.ToolFlowManager} toolFlowManager

Manages movement between the steps of the toolset.

{Ext.util.MixedCollection} toolsets

The list of toolsets. See Monk.feature.Workflow#initializeToolsets.

{Ext.util.MixedCollection} toolWindowRegistry

Used for tracking component/window relation. Format: key = windowId, item = Workbench.component.Component.

{Ext.ux.WindowManager} windowManager

Keeps track of component windows and provides layout functions.

Method Detail

destroyComponent(componentWindow)

Destroy a component. Called when a component window gets closed.

Parameters:
{Ext.Window} componentWindow: The component window.

focusComponent(componentWindow)

Give the component focus if desktop window has been clicked

Parameters:
{Ext.Window} componentWindow: The component window.

getURLParameters()

Parse any parameters included in the URL and set them in Monk.feature.Workflow#initialParameters.

goToDestination()

Go to the destination stored in Monk.feature.Workflow#initialDestination using Monk.component.FlowManager (and Monk.component.ToolFlowManager).

handle(monkEvent, data)

Events handled by this component:

Workbench.event.ComponentLoaded
Workbench.event.ComponentRemoved
Monk.event.workbench.LocalWindowFocus
Monk.event.CollectionsMetadataHierarchyLoaded
Monk.event.workbench.InitialParametersProcessed

Parameters:
monkEvent
data

initialize()

Initialize everything and load the collections meta data.

{Ext.Window} initializeComponent(componentId)

Initialize a component.

Parameters:
{String} componentId: The ID of the component to initialize.

Returns:: {Ext.Window} An Ext.Window containing the component IFRAME.

initializeHeader()

Initialize the header.

initializeLayout()

Initialize the layout.

initializeParameters()

Analyze request parameters and perform various loading operations based on their contents.

initializeTools()

Initialize the tools.

initializeToolsets()

Initialize toolsets.

switchComponent(oldComponentId, newComponentId)

Replace one component with another.

Parameters:
{String} oldComponentId: The old component's ID.
{String} newComponentId: The new component's ID.

Classes

Class Monk.feature.Workflow