Class icm.pgwidget.properties.Properties


Extends icm.pgwidget.properties.dijit._Properties.
Class that represents the Properties Widget
Defined in: <icm/pgwidget/properties/Properties.js>.

Constructor Summary

Constructor Attributes Constructor Name and Description
 
icm.pgwidget.properties.Properties()

Method Summary

Method Attributes Method Name and Description
 
handleICM_ClearContentEvent()
Handler for icm.ClearContent event.
 
handleICM_PageDeactivatedEvent()
Handler for icm.PageDeactivated event.
 
handleICM_SendCaseInfoEvent(payload)
Handler for the icm.SendCaseInfo event.
 
handleICM_SendNewCaseInfoEvent(payload)
Handler for the icm.SendNewCaseInfo event.
 
handleICM_SendNewTaskInfoEvent(payload)
Handler for the icm.SendNewTaskInfo event.
 
handleICM_SendWorkItemEvent(payload)
Handler for the icm.SendWorkItem event.
 
handleICM_UpdateFieldsEvent(payload)
Handler for the icm.UpdateFields event.
 
handleICM_UpdatePropertiesEvent(payload)
Handler for the icm.UpdateProperties event.
Methods borrowed from class icm.pgwidget.properties.dijit._Properties:
adjustDirtyState, bindController, closeView, constructor, destroyRecursive, getComparator, getFilter, getMarkup, getPropertyIds, getRegistry, getResources, getViewDefinitionId, getViewDefinitionUrl, openView, resize, setDirtyState, unbindController

Constructor Detail

icm.pgwidget.properties.Properties()

Method Detail

handleICM_ClearContentEvent()

Handler for icm.ClearContent event. Clears contents of Properties widget.

handleICM_PageDeactivatedEvent()

Handler for icm.PageDeactivated event. Clears message tooltip of Properties widget.

handleICM_SendCaseInfoEvent(payload)

Handler for the icm.SendCaseInfo event. Properties widget will display the case properties in the widget UI.
Parameters:
payload 
 	Example: payload = {
			"caseEditable": caseEditable,
			"coordination": coordination
		};

handleICM_SendNewCaseInfoEvent(payload)

Handler for the icm.SendNewCaseInfo event.
Parameters:
payload 
 	Example: payload = {
			"caseEditable": caseEditable,
			"coordination": coordination
		};

handleICM_SendNewTaskInfoEvent(payload)

Handler for the icm.SendNewTaskInfo event.
Parameters:
payload 
 	Example: payload = {
			"taskEditable": taskEditable,
			"coordination": coordination
		};

handleICM_SendWorkItemEvent(payload)

Handler for the icm.SendWorkItem event.
Parameters:
payload 
 Example: payload = {
				"workItemEditable": workItemEditable,
				"coordination": coordination
			};

handleICM_UpdateFieldsEvent(payload)

Handler for the icm.UpdateFields event.
Parameters:
payload
  • changes: A JSON object that contains the unique identifier and value for each property that is to be modified. 
 Example: payload = {
				"changes": [
					{
						id: prop1,
						collectionId: collection1,
						value: value1
					},
					{
						id: prop2,
						collectionId: collection2,
						value: value2
					}
				]
			};

handleICM_UpdatePropertiesEvent(payload)

Handler for the icm.UpdateProperties event.
Parameters:
payload
  • changes: A JSON object that contains the property, value, error (optional), row (optional), for each property that is to be modified. 
 Example: payload = {
				"changes": [
					{
						property: property,
						value: value1,
						[error]: error,
						[row]: row
					},
					{
						property: property,
						value: value1,
						[error]: error,
						[row]: row
					}
				]
			};