Class Monk.component.ToolFlowManager

Extends Monk.component.Component.
A manager for moving between steps in a toolset.
Defined in: tool-flow-manager.js.

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

Field Summary
Field Attributes	Field Name and Description
	currentStep The index or ID of the step currently being viewed.
	panel The container for the toolset steps, and the toolbar for the steps.
	toolset The toolset to use.

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

Method Summary
Method Attributes	Method Name and Description
	afterRenderEveryTime()
	afterRenderFirstTime()
	beforeExit()
	buildToolbar() Add buttons to the toolbar based on the steps in the toolset.
	closeWindows() Closes all open windows (and destroys their components).
	createToolsetConfig(toolsetId) Create a config for Monk.component.Toolset based on a toolset object
	createToolstep(siblingToolstep, config, invisible) Creates a new toolstep.
	deleteToolstep(toolstep)
	doLayout() Layout the tools for the current step.
	getFlowDirection(oldStep, newStep) Determine if we're moving backward or forward in the toolset.
	getStep(key, validate) Get a specific step in the workflow
	getToolsetElements()
	getToolsetTools() Gets all the tools in the toolset, as an array.
	handle(monkEvent, data)
	handleToolTransfer(target, toolEl) Handle transfer of tools between toolsteps and tool parent, etc.
	initializeDragDrop()
	initializeSaveDialog() Creates and display the dialog used to save a toolset.
	initializeToolFlow() Initializes everything needed to start the tool flow and moves to the first step in the toolset.
	launchTools(tools) Launch tools.
	loadToolset(savedToolset) Load a toolset.
	removeStaleTools(newStep, oldStep) Remove the tools that don't persist between steps.
	reset() Resets everything back to the factory state.
	resetToolbar() Reset the toolbar to its initial condition.
	saveToolset(config) Save/create a toolset
	saveWindowLayouts() Get the layout of the currently opened tools and (temporarily) save them to the toolset.
	setNavButtons(key) Set the universal continue button to go to the next step.
	setToolset(toolset) Set the toolset that this component will manage.
	setToolsetLabel(label)
	toolsetSelected(selectedToolsetEl) Called when a toolset gets dropped on the 'toolset-drag-here' box.
	updateToolstepNumbers() Set the number for each step, based on their index
	validateTools(tools) Checks the list of tools to see if they're valid.

Methods borrowed from class Monk.component.Component:: addResultsToProject, addTermsToChunk, alert, associativeArray2Arrays, beforeLoad, bind, cancelAnalysis, clearTermsForChunks, clearWorklist, confirm, contains, createNewProject, createResultToolset, 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, initComponent, initializeProgressDialog, isVisible, isWorksetUnsaved, isWorksetValid, load, loadOrSet, loadWorkset, moveFirst, moveLast, moveNext, movePrevious, notify, onInitView, onLoad, onLoadError, onPageSizeChanged, onPagingKeydown, onRender, 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, show, showJobsWindow, unbind, update, updateInfo, updateProgress, updateProjectDataWorkset, updateRecord, useJs, wait

Class Detail

Monk.component.ToolFlowManager(args)

Author: Andrew.

Parameters:
args

Field Detail

{String|Integer} currentStep

The index or ID of the step currently being viewed.

{Ext.Panel} panel

The container for the toolset steps, and the toolbar for the steps. An Ext.ux.AnimatedCardLayout is used to switch between steps.

{Monk.component.Toolset} toolset

The toolset to use.

Method Detail

afterRenderEveryTime()

afterRenderFirstTime()

beforeExit()

buildToolbar()

Add buttons to the toolbar based on the steps in the toolset. Also adds a Save Toolset button.

closeWindows()

Closes all open windows (and destroys their components).

createToolsetConfig(toolsetId)

Create a config for Monk.component.Toolset based on a toolset object
Defined in: ToolsetEditor.js.

Parameters:
{String} toolsetId Optional: If included, create a config for a saved toolset, otherwise, create a config for a new toolset

createToolstep(siblingToolstep, config, invisible)

Creates a new toolstep.
Defined in: ToolsetEditor.js.

Parameters:
{Ext.Element} siblingToolstep: The sibling of this toolstep
{Object} config: A config object containing label and help url
{String} config.label: The label for this toolstep
{String} config.helpUrl: The help url for this toolstep
{Boolean} invisible: Whether the toolstep should be invisible initially

deleteToolstep(toolstep)

Defined in: ToolsetEditor.js.

Parameters:
toolstep

doLayout()

Layout the tools for the current step. If a specific layout exists, use that. Otherwise use the default (column) layout.

{String} getFlowDirection(oldStep, newStep)

Determine if we're moving backward or forward in the toolset.

Parameters:
{String} oldStep: The ID of the old step.
{String} newStep: The ID of the new step.

Returns:: {String} Returns either 'forward' or 'backward'.

getStep(key, validate)

Get a specific step in the workflow

Parameters:
{String|Integer} key: The ID of the step.
{Boolean} validate Optional: True to validate the current tools (defaults to true).

getToolsetElements()

Defined in: ToolsetSelector.js.

{Array} getToolsetTools()

Gets all the tools in the toolset, as an array.

Returns:: {Array} An array of tools.

handle(monkEvent, data)

Defined in: ToolsetEditor.js.

Parameters:
monkEvent
data

handleToolTransfer(target, toolEl)

Handle transfer of tools between toolsteps and tool parent, etc.
Defined in: ToolsetEditor.js.

Parameters:
{Object} target: The receiving target Element
{Ext.Element} toolEl: The tool to transfer

initializeDragDrop()

Defined in: ToolsetSelector.js.

initializeSaveDialog()

Creates and display the dialog used to save a toolset.

initializeToolFlow()

Initializes everything needed to start the tool flow and moves to the first step in the toolset.

launchTools(tools)

Launch tools.

Parameters:
{Array} tools: An array of tools to launch.

loadToolset(savedToolset)

Load a toolset.
Defined in: ToolsetEditor.js.

Parameters:
{Boolean} savedToolset: Is the toolset one of the previously saved ones? Or is it a new (unsaved) toolset.

removeStaleTools(newStep, oldStep)

Remove the tools that don't persist between steps.

Parameters:
{String|Integer} newStep: The new step.
{String|Integer} oldStep: The old step.

reset()

Resets everything back to the factory state.
Defined in: ToolsetEditor.js.

resetToolbar()

Reset the toolbar to its initial condition.

saveToolset(config)

Save/create a toolset
Defined in: ToolsetEditor.js.

Parameters:
{Object} config: An object containing toolset properties
{String} config.label: The toolset label
{String} config.worksetId: A number representing the workset ID
{String} config.toolsetId: A number representing the toolset ID
{Boolean} config.shareable: Where to share this toolset with other users
{String} config.description: A description of the toolset If this is present, the toolset will be updated. Otherwise, a new toolset will be created.

saveWindowLayouts()

Get the layout of the currently opened tools and (temporarily) save them to the toolset.

setNavButtons(key)

Set the universal continue button to go to the next step.

Parameters:
{String|Integer} key: The ID/index of the step.

setToolset(toolset)

Set the toolset that this component will manage.

Parameters:
{Monk.component.Toolset} toolset: The toolset to use.

setToolsetLabel(label)

Defined in: ToolsetEditor.js.

Parameters:
label

toolsetSelected(selectedToolsetEl)

Called when a toolset gets dropped on the 'toolset-drag-here' box.
Defined in: ToolsetSelector.js.

Parameters:
{Object} selectedToolsetEl

updateToolstepNumbers()

Set the number for each step, based on their index
Defined in: ToolsetEditor.js.

{Array} validateTools(tools)

Checks the list of tools to see if they're valid. Returns false if any one tool isn't valid.

Parameters:
{Array} tools: An array of tool IDs.

Returns:: {Array} An array of error messages, or an array with one item which equals true.

Classes

Class Monk.component.ToolFlowManager