Class ecm.widget.process.WorkItemPropertiesPane
Extends
dijit._Widget.
Provides a widget that is used to view or edit the properties of a work item.
Defined in: <ecm\widget\process\WorkItemPropertiesPane.js>.
Constructor Summary
Constructor Attributes | Constructor Name and Description |
---|---|
Method Summary
Method Attributes | Method Name and Description |
---|---|
destroy()
|
|
Returns the pseudo ecm.model.ContentClass object holding the work item property attributes.
|
|
Returns the work item properties in a JSON format.
|
|
Returns a boolean value true indicating whether there are property fields to display.
|
|
onChange()
|
|
An event function called after the widget is finished rendering.
|
|
This event is fired when a save operation can be retried.
|
|
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 properties display.
|
|
validate(focus, onEditStatus, onSaveStatus)
Checks the work item properties list for having valid values.
|
Method Detail
destroy()
{ecm.model.ContentClass} getContentClass()
Returns the pseudo ecm.model.ContentClass object holding the work item property attributes.
- Returns:
- {ecm.model.ContentClass} object holding pseudo class.
{Object} getPropertiesJSON()
Returns the work item properties in a JSON format.
- Returns:
- {Object} holding property data.
{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.CommonPropertiesPane
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 properties display.
- Parameters:
- item
- A ecm.model.WorkItem object.
{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.