Class Monk.component.FlowManager

Extends Monk.component.Component.
A manager for workflow. Handles transitions between steps in the flow. Contains the initial workbench screen.
Defined in: flow-manager.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	Monk.component.FlowManager(args)

Field Summary
Field Attributes	Field Name and Description
	checked
	clearInvalid Overridden and disabled.
	currentStep The ID of the step currently being viewed.
	defaultAutoCreate
	fieldClass
	focusClass
	markInvalid Overridden and disabled.
	panel This is the container for all the steps in the flow, the toolbar for the steps, and the universal continue button.
	steps A list containing all the steps in the workflow.

Fields borrowed from class Monk.component.Component:: afterRenderEveryTime, afterRenderFirstTime, afterRenderFirstTimeCalled, beforeExit, id, label

Method Summary
Method Attributes	Method Name and Description
	addStep(nextStep, addTBarButton) Adds a step to the flow
	chooseCollection()
	clearProjects()
	clearToolsets(clearDefaultToolsets) Clears the toolset list
	contextSensitive(titleText, helptext, target)
	deleteProject(projectId)
	doSave()
	dynamic(titleText, helptext, target)
	editToolset()
	gethelp()
	getId()
	getPositionEl()
	getResizeEl()
	getStep(key) Gets a particular step in the flow.
	getToolset(toolsetId)
	getValue() Returns the value of the checked radio.
	goToStep(key, noFade) For moving between steps in the workflow.
	handle(monkEvent, data)
	handleStoreDataChange(store)
	hide()
	hideAdvancedSearchLink()
	initComponent()
	initEvents()
	initialize()
	initializeAdvancedSearchDialog()
	initValue()
	isToolsetDefault(toolsetId)
	loadProject(projectId)
	loadProjectComponents()
	loadProjectFinish()
	loadResult(data)
	loadToolset(config, results) Load a toolset.
	onClick()
	onDestroy()
	onRender(ct, position)
	onResize(this, checked)
	onTrigger1Click()
	onTrigger2Click()
	removeLoadingImage()
	removeStep(stepId) Removes a step from the flow
	renderProjects()
	renderToolset(toolset)
	renderToolsetPreview()
	reset()
	resetCenterPanel()
	selectProject(projectId)
	selectToolset(toolsetId, selected) Select a toolset.
	sendSearchNotification(form)
	sendSimpleSearchNofication(featureValue)
	setButtonLabel(stepId, label) Sets the button label for a particular step.
	setChecked(v)
	setProjectLabel(label)
	settext(strFlag)
	setValue(v) Checks the radio box with the matching value
	show()
	showAdvancedSearchLink()
	simple(titleText, flag, target)
	toggleCenterContainer(type) Toggle the center container between worksets and toolset editor.
	toolbarButtonToggle(buttonId) Set a specific button to appear pressed.
	trimSteps(stepId) Removes the specified step, and all steps after it
	withinToolsetCheck(key) Check if the user's currently running a toolset, and confirm that they want to exit it.

Methods borrowed from class Monk.component.Component:: addResultsToProject, addTermsToChunk, alert, associativeArray2Arrays, beforeLoad, bind, cancelAnalysis, clearTermsForChunks, clearWorklist, confirm, contains, createNewProject, createResultToolset, createToolsetConfig, doFeatureComparison, doLoad, doSimilarityQuery, doSimpleQuery, getActivePage, getChunkSimilar, getChunkType, getCurrentChunk, getDecisionTree, getDecisionTreeImage, getDecisionTreeSummary, getDocumentList, getFeature, getFeatureList, getInstanceId, getItinerary, getLastPage, getLastWorksetLoadedTimestamp, getPageData, getPageSize, getProjectData, getProjectId, getQueryParam, getResults, getResultStore, getResultSummary, getTermsForChunk, getToolsetId, getWorklist, getWorkset, getWorksetId, getWorksetLabel, getWorksetName, growl, handleResponse, init, initializeProgressDialog, isVisible, isWorksetUnsaved, isWorksetValid, load, loadOrSet, loadWorkset, moveFirst, moveLast, moveNext, movePrevious, notify, onInitView, onLoad, onLoadError, onPageSizeChanged, onPagingKeydown, processChunk, processResults, processStatus, progress, prompt, readPage, refresh, remove, renderResults, renderWorksets, request, resetChunkSimilar, resetQueryParam, resetResults, resetWorkset, runAnalysis, selectResult, selectWorkset, setActivePage, setChunkSimilar, setCurrentChunk, setDecisionTree, setDecisionTreeImage, setDecisionTreeSummary, setFeature, setFeatureList, setInstanceId, setItinerary, setPageSize, setProjectData, setProjectId, setResultSummary, setSearchQueryParam, setSimilarQueryParam, setTimer, setToolsetId, setupTextBox, setUserRatings, setWorklist, setWorkset, setWorksetId, setWorksetName, setWorksetQueryParam, showJobsWindow, unbind, update, updateInfo, updateProgress, updateProjectDataWorkset, updateRecord, useJs, wait

Class Detail

Monk.component.FlowManager(args)

Author: Andrew.

Parameters:
args

Field Detail

checked

Defined in: radiogroup.js.

clearInvalid

Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide
Defined in: radiogroup.js.

{String} currentStep

The ID of the step currently being viewed.

defaultAutoCreate

Defined in: radiogroup.js.

fieldClass

Defined in: radiogroup.js.

focusClass

Defined in: radiogroup.js.

markInvalid

Overridden and disabled. The editor element does not support standard valid/invalid marking. @hide
Defined in: radiogroup.js.

{Ext.Panel} panel

This is the container for all the steps in the flow, the toolbar for the steps, and the universal continue button. An Ext.ux.AnimatedCardLayout is used to switch between steps.

{Ext.util.MixedCollection} steps

A list containing all the steps in the workflow.

Method Detail

addStep(nextStep, addTBarButton)

Adds a step to the flow

Parameters:
{Object} nextStep
{String} nextStep.id: The ID of the step
{String} nextStep.label: The label for the step
{Ext.Panel} nextStep.panel: The panel to render
{Boolean} addTBarButton Optional: Whether to add a toolbar button (defaults to true)

chooseCollection()

Defined in: SearchComponent.js.

clearProjects()

Defined in: ProjectSelector.js.

clearToolsets(clearDefaultToolsets)

Clears the toolset list
Defined in: ProjectToolsets.js.

Parameters:
{Boolean} clearDefaultToolsets: If true will clear default toolsets as well

contextSensitive(titleText, helptext, target)

Defined in: help.js.

Parameters:
titleText
helptext
target

deleteProject(projectId)

Defined in: ProjectSelector.js.

Parameters:
projectId

doSave()

Defined in: inline_text_field.js.

dynamic(titleText, helptext, target)

Defined in: help.js.

Parameters:
titleText
helptext
target

editToolset()

Defined in: ProjectToolsets.js.

gethelp()

Defined in: HelpComponent.js.

getId()

Defined in: radiogroup.js.

getPositionEl()

Defined in: radiogroup.js.

getResizeEl()

Defined in: radiogroup.js.

{Object} getStep(key)

Gets a particular step in the flow. Returns the step, or null if none is found.

Parameters:
{String} key: The ID of the step to get.

Returns:: {Object} The step (or null)

getToolset(toolsetId)

Defined in: ProjectToolsets.js.

Parameters:
toolsetId

{Mixed} getValue()

Returns the value of the checked radio.
Defined in: radiogroup.js.

Returns:: {Mixed} value

goToStep(key, noFade)

For moving between steps in the workflow.

Parameters:
{String|Integer} key: The key or index of the step.
{Boolean} noFade Optional: True to cancel default fade in animation (defaults to false).

handle(monkEvent, data)

Defined in: SearchComponent.js.

Parameters:
monkEvent
data

handleStoreDataChange(store)

Defined in: SearchComponent.js.

Parameters:
store

hide()

Defined in: SearchComponent.js.

hideAdvancedSearchLink()

Defined in: SearchComponent.js.

initComponent()

Defined in: SearchComponent.js.

initEvents()

Defined in: radiogroup.js.

initialize()

Defined in: SearchComponent.js.

initializeAdvancedSearchDialog()

Defined in: SearchComponent.js.

initValue()

Defined in: radiogroup.js.

isToolsetDefault(toolsetId)

Defined in: ProjectToolsets.js.

Parameters:
toolsetId

loadProject(projectId)

Defined in: ProjectSelector.js.

Parameters:
projectId

loadProjectComponents()

Defined in: Project.js.

loadProjectFinish()

Defined in: Project.js.

loadResult(data)

Defined in: Project.js.

Parameters:
data

loadToolset(config, results)

Load a toolset.
Defined in: ProjectToolsets.js.

Parameters:
{Object} config Optional: Optional custom config to load
{Boolean} results Optional: True if we're loading results with the toolset (defaults to false)

onClick()

Defined in: radiogroup.js.

onDestroy()

Defined in: radiogroup.js.

onRender(ct, position)

Defined in: radiogroup.js.

Parameters:
ct
position

onResize(this, checked)

Defined in: radiogroup.js.

Parameters:
{Ext.vx.RadioGroup} this: This radio
{Boolean} checked: The new checked value

onTrigger1Click()

Defined in: SearchComponent.js.

onTrigger2Click()

Defined in: SearchComponent.js.

removeLoadingImage()

Defined in: ProjectSelector.js.

removeStep(stepId)

Removes a step from the flow

Parameters:
{String} stepId: The ID of the step

renderProjects()

Defined in: ProjectSelector.js.

renderToolset(toolset)

Defined in: ProjectToolsets.js.

Parameters:
toolset

renderToolsetPreview()

Defined in: Project.js.

reset()

Defined in: ProjectToolsets.js.

resetCenterPanel()

Defined in: Project.js.

selectProject(projectId)

Defined in: ProjectSelector.js.

Parameters:
projectId

selectToolset(toolsetId, selected)

Select a toolset.
Defined in: ProjectToolsets.js.

Parameters:
{String} toolsetId: The toolset to select
{Boolean} selected Optional: If set, will force to select/deselect. Otherwise, toolset is toggled.

sendSearchNotification(form)

Defined in: SearchComponent.js.

Parameters:
form

sendSimpleSearchNofication(featureValue)

Defined in: SearchComponent.js.

Parameters:
featureValue

setButtonLabel(stepId, label)

Sets the button label for a particular step.

Parameters:
{String} stepId: The ID of the step
{String} label: The label to use for the step

setChecked(v)

Defined in: radiogroup.js.

Parameters:
v

setProjectLabel(label)

Defined in: Project.js.

Parameters:
label

settext(strFlag)

Defined in: help.js.

Parameters:
strFlag

setValue(v)

Checks the radio box with the matching value
Defined in: radiogroup.js.

Parameters:
{Mixed} v

show()

Defined in: SearchComponent.js.

showAdvancedSearchLink()

Defined in: SearchComponent.js.

simple(titleText, flag, target)

Defined in: help.js.

Parameters:
titleText
flag
target

toggleCenterContainer(type)

Toggle the center container between worksets and toolset editor.
Defined in: Project.js.

Parameters:
{String} type: Either 'worksets' or 'toolsetEditor'

toolbarButtonToggle(buttonId)

Set a specific button to appear pressed.

Parameters:
{String} buttonId: The button ID to use (corresponds to step ID).

trimSteps(stepId)

Removes the specified step, and all steps after it

Parameters:
{String} stepId: The ID of the step

withinToolsetCheck(key)

Check if the user's currently running a toolset, and confirm that they want to exit it.

Parameters:
{String|Integer} key: The key or index of the step to move to

Classes

Class Monk.component.FlowManager