Class ecm.widget.process.StepProcessorLayout

Extends ecm.widget.process.ProcessorLayout, ecm.widget.process._ProcessorMixin.
Provides the basic layout for step processors.
Defined in: <ecm\widget\process\StepProcessorLayout.js>.

Constructor Summary

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

Method Summary

Method Attributes	Method Name and Description
	addProcessButtons() Creates the Move to In-basket, Return, and Reassign buttons (if appropriate) and inserts them into the button bar at bottom of page.
	canRenderHistoryPane() Checks work item to determine if the history pane should be rendered.
	createAttachmentsPane() Dynamically construct the Attachments tab container pane and add it to the view tab container.
	createHistoryPane() Dynamically construct the History tab container pane and add it to the view tab container.
	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.
	onMovetoInbox() Calls `onOk` event handler to save the processor information before moving the item to the user's in-basket.
	onOk(dispatch, callback) Saves the modified processor information and if requested, will dispatch the work item.
	onProcessButtonsCreated() An event function that is called when the processor layout has completed adding the processor buttons at the bottom of the page.
	onReassign() Calls `onOk` event handler to save the processor information before reassigning the item to the new user.
	onReturn() Calls `onOk` event handler to save the processor information before returning the item.
	onSave() Calls `onOk` event handler to save the processor information.
	postCreate()
	resizeIt() Function to resize the widget.
	updateView() Updates the widgets with the current work item property information for rendering.

Constructor Detail

ecm.widget.process.StepProcessorLayout()

Method Detail

addProcessButtons()

Creates the Move to In-basket, Return, and Reassign buttons (if appropriate) and inserts them into the button bar at bottom of page.

{Boolean} canRenderHistoryPane()

Checks work item to determine if the history pane should be rendered.

Since:: 2.0.3

Returns:: {Boolean} A value of true if the history pane can be rendered, false otherwise.

createAttachmentsPane()

Dynamically construct the Attachments tab container pane and add it to the view tab container.

Since:: 2.0.3

createHistoryPane()

Dynamically construct the History tab container pane and add it to the view tab container.

Since:: 2.0.3

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.

onMovetoInbox()

Calls onOk event handler to save the processor information before moving the item to the user's in-basket.

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.

onProcessButtonsCreated()

An event function that is called when the processor layout has completed adding the processor buttons at the bottom of the page.

onReassign()

Calls onOk event handler to save the processor information before reassigning the item to the new user.

onReturn()

Calls onOk event handler to save the processor information before returning the item.

onSave()

Calls onOk event handler to save the processor information.

postCreate()

resizeIt()

Function to resize the widget.

updateView()

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