Class icm.pgwidget.viewer.Viewer

Extends icm.base.BasePageWidget, icm.pgwidget.viewer.dijit.ViewerContentPane.
Provides Viewer widget. The widget represents ICN Content Viewer which can be used to open or preview Case documents or task attachments. Specific viewer used by widget for rendering various types of documents is defined by Viewer Map used by Case Manager desktop.
Defined in: <icm/pgwidget/viewer/Viewer.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	icm.pgwidget.viewer.Viewer()

Field Summary

Field Attributes	Field Name and Description
	isViewer Must be true for implementations of viewer which are used as Case Manager page widgets.
	showLayouts Shows the layout toolbar buttons, which include tabbed view, horizontal split, vertical split, or edit properties.

Method Summary

Method Attributes	Method Name and Description
	constructor(dimension) Constructs the Viewer page widget, a wrapper of Content Navigator's Content Viewer.
	handleICM_ClearContentEvent() Handler for icm.ClearContent event.
	handleICM_OpenDocumentEvent(payload) Handler for icm.OpenDocument event.
	handleICM_SelectCaseEvent(payload) Handler for the icm.SelectCase event.
	handleICM_SendCaseInfoEvent(payload) Handler for the icm.SendCaseInfo event.
	handleICM_SendWorkItemEvent(payload) Handler for icm.SendWorkItem event.
	postCreate()
	reset()

Constructor Detail

icm.pgwidget.viewer.Viewer()

Field Detail

isViewer

Must be true for implementations of viewer which are used as Case Manager page widgets. Open action will open document in Content Navigator viewer if isViewer is undeclared or false. Page returns its "dirty" state including viewer's state if isViewer set to true. If isViewer is not declared or set to false "dirty" state of viewer is ignored and page will close without warning even if viewer has unsaved annotations.

showLayouts

Shows the layout toolbar buttons, which include tabbed view, horizontal split, vertical split, or edit properties.

Method Detail

constructor(dimension)

Constructs the Viewer page widget, a wrapper of Content Navigator's Content Viewer.

Parameters:
dimension: An optional object that defines height of this dijit's container, for example {height: "400px"}.

Deprecated:: From 5.2.1 use constructor of ViewerContentPane directly for all integration.

handleICM_ClearContentEvent()

Handler for icm.ClearContent event. Clears contents of Viewer widget, clears cached Ids, and closes all tabs.

handleICM_OpenDocumentEvent(payload)

Handler for icm.OpenDocument event. The document that is contained in the event payload will be opened in the Viewer widget.

Parameters:

{object} payload

contentItem: An ecm.model.ContentItem object that represents the document to be opened.
action: A string that indicates whether the Viewer is to execute the Open action or the Preview action. The action can be "open" or "preview".

Example: payload = { "contentItem": contentItem, "action": action };

handleICM_SelectCaseEvent(payload)

Handler for the icm.SelectCase event. Save the case ID in the cache and close the currently viewed document to prepare for opening another case.

Parameters:

{object} payload

caseEditable: An icm.model.CaseEditable object that represents the case for which the ID is to be saved.

Example: payload = { "caseEditable": caseEditable };

handleICM_SendCaseInfoEvent(payload)

Handler for the icm.SendCaseInfo event. Save the Case ID in the cache and close currently viewed documents to prepare for opening documents from another case.

Parameters:

{object} payload

caseEditable: An icm.model.CaseEditable object that represents the case for which the ID is to be saved.
coordination: An icm.util.Coordination object that is used internally by the widgets in the same page.

Example: payload = { "caseEditable": caseEditable, "coordination": coordination };

handleICM_SendWorkItemEvent(payload)

Handler for icm.SendWorkItem event. Viewer widget will save the work item ID in the cache and close the currently viewed attachments to prepare for opening the attachments for another work item.

Parameters:

{object} payload

workItemEditable: An {icm.model.WorkItemEditable} object that represents the work item for which the ID is to be saved.
coordination: An icm.util.Coordination object that is used internally by the widgets in the same page.

Example: payload = { "workItemEditable": workItemEditable, "coordination": coordination };

postCreate()

reset()

Deprecated:: From 5.2.1 use destroy directly on ViewerContentPane.