Class ecm.widget.process.WorkItemViewerPane

Extends dijit._Widget.
Provides a widget that is used to view the content and edit the properties of a document associated with a work item.
Defined in: <ecm\widget\process\WorkItemViewerPane.js>.

Constructor Summary

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

Method Summary

Method Attributes	Method Name and Description
	closeItem()
	destroy()
	getChildComponentValues() Returns any child component values from the properties pane (maybe null)
	getPropertiesJSON() Returns the work item properties in a JSON format.
	getPropertiesPane()
	hasDisplayedFields() Returns a boolean value true indicating whether there are property fields to display.
	onChange()
	onCompleteRendering() An event function called after the widget is finished rendering.
	onRetrySave() This event is fired when a save operation can be retried.
	postCreate()
	resizeIt() Function to resize the widget.
	setFieldError(fieldName, errorMessage, errorValue) Sets a properties field error state.
	setFieldFocus(fieldName) Sets a properties field focus state.
	setItem(item) Sets the work item for the viewer/properties display.
	setViewerIsDirty(isDirty) Sets the dirty bit on the Viewer plug in itself.
	setViewerItemIsDirty(isDirty) Set the dirty bit on the viewer containers property pane.
	validate(focus, onEditStatus, onSaveStatus) Checks the work item properties list for having valid values.

Constructor Detail

ecm.widget.process.WorkItemViewerPane()

Method Detail

closeItem()

destroy()

getChildComponentValues()

Returns any child component values from the properties pane (maybe null)

Returns:: Array of {Object} holding child component property data

{Object} getPropertiesJSON()

Returns the work item properties in a JSON format.

Returns:: {Object} holding property data.

getPropertiesPane()

{Boolean} hasDisplayedFields()

Returns a boolean value true indicating whether there are property fields to display.

Returns:: {Boolean} true if there are property fields to display, false otherwise.

onChange()

onCompleteRendering()

An event function called after the widget is finished rendering.

onRetrySave()

This event is fired when a save operation can be retried. See ecm.widget.ItemPropertiesPane onRetrySave.

postCreate()

resizeIt()

Function to resize the widget.

setFieldError(fieldName, errorMessage, errorValue)

Sets a properties field error state.

Parameters:
fieldName: A string hold the field name.
errorMessage: A string hold the error message text to display.
errorValue: The error value.

setFieldFocus(fieldName)

Sets a properties field focus state.

Parameters:
fieldName: A string hold the field name.

setItem(item)

Sets the work item for the viewer/properties display.

Parameters:
item: A ecm.model.WorkItem object.

setViewerIsDirty(isDirty)

Sets the dirty bit on the Viewer plug in itself. Users may have modified annotations and not saved them We need a way to continue processing without showing browsers annoying close window message

Parameters:
isDirty

setViewerItemIsDirty(isDirty)

Set the dirty bit on the viewer containers property pane. Need to set to false when closing the window so the browser doesn't put up those annoying close window messages (from onbeforeunload)

Parameters:
isDirty

{Boolean} validate(focus, onEditStatus, onSaveStatus)

Checks the work item 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} true if there are no validation errors, false otherwise.