Class ecm.widget.process.StepRoutingLayout

Extends ecm.widget.process.ProcessorLayout, ecm.widget.process._ProcessorMixin.
Provides a widget that is used to display the Content Manager Step Processor
Defined in: <ecm\widget\process\StepRoutingLayout.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	ecm.widget.process.StepRoutingLayout()

Method Summary

Method Attributes	Method Name and Description
	addActionTab(actionUrl, actionName) Add the custom action as a Tab to the tab container in the step processor.
	createWorkItem(repository) Creates a ecm.model.WorkItem object from the passed in parameter information.
	destroy()
	isValid(focus, onEditStatus, onSaveStatus) Checks the work item properties pane properties list for having valid values.
	onCancel() Cancels the operation and unlocks the work item.
	onCompleteRendering() An event function that is called when the processor layout has completed rendering.
	onCustomAction(actionName) Add a new tab to tab container to display the url in an iframe or replacing the existing one
	onOk(dispatch, callback) Saves the modified processor information and if requested, will dispatch the work item.
	onResume(callback) Called when Resume button is clicked and would try to resume the current work item.
	onSave() Calls `onOk` event handler to save the processor information.
	onSuspend(callback) Called when Suspend button is clicked and would try to suspend the current work item.
	postCreate()
	retrieveECPluginURL(callback, actionUrl, actionName) Retrieve the eClient plugin URL setting (if it has been configured)
	updateView() Updates the widgets with the current work item property information for rendering.

Constructor Detail

ecm.widget.process.StepRoutingLayout()

Since:: 2.0.2

Method Detail

addActionTab(actionUrl, actionName)

Add the custom action as a Tab to the tab container in the step processor.

Parameters:
actionUrl: A string holding the custom action Url configured on the workflow step
actionName: A string holding the custom action label to be displayed

createWorkItem(repository)

Creates a ecm.model.WorkItem object from the passed in parameter information.

Parameters:
repository: A ecm.model.Repository object.

destroy()

{Boolean} isValid(focus, onEditStatus, onSaveStatus)

Checks the work item properties pane properties list for having valid values.

Parameters:
focus: A boolean value indicating if the error field (if any) should be set as focus.
onEditStatus: A boolean value indicating if we are editing the properties.
onSaveStatus: A boolean value indicating if we are saving the properties.

Returns:: {Boolean} A value of true if the property values are valid, false otherwise.

onCancel()

Cancels the operation and unlocks the work item.

onCompleteRendering()

An event function that is called when the processor layout has completed rendering.

onCustomAction(actionName)

Add a new tab to tab container to display the url in an iframe or replacing the existing one

Parameters:
actionName: A string holding the custom action label to be displayed

onOk(dispatch, callback)

Saves the modified processor information and if requested, will dispatch the work item.

Parameters:
dispatch: A boolean value indicating whether to dispatch the item after saving it's values.
callback: A callback function that is called after the item information has been saved.

onResume(callback)

Called when Resume button is clicked and would try to resume the current work item. param callback A callback function that is called after the item is resumed.

Parameters:
callback

onSave()

Calls onOk event handler to save the processor information.

onSuspend(callback)

Called when Suspend button is clicked and would try to suspend the current work item. param callback A callback function that is called after the item is suspended.

Parameters:
callback

postCreate()

retrieveECPluginURL(callback, actionUrl, actionName)

Retrieve the eClient plugin URL setting (if it has been configured)

Parameters:
callback: A callback function that is called after the item information has been saved.
actionUrl: A string holding the custom action Url configured on the workflow step
actionName: A string holding the custom action label to be displayed

updateView()

Updates the widgets with the current work item property information for rendering.