Class ecm.widget.dialog.ContentViewerWindow

Provides a separate browser window that displays the ContentViewer widget.
Defined in: <ecm\widget\dialog\ContentViewerWindow.js>.

Constructor Summary

Constructor Attributes Constructor Name and Description
 
ecm.widget.dialog.ContentViewerWindow()

Method Summary

Method Attributes Method Name and Description
 
constructor()
<static>  
ecm.widget.dialog.ContentViewerWindow.ContentViewerWindow.getSizeAndPosition()
Returns the size and position of the viewer window as an Object.
<static>  
ecm.widget.dialog.ContentViewerWindow.ContentViewerWindow.saveSizeAndPosition()
Persists the size and position of the viewer window in a browser localStorage.
 
onDocumentClosed(item, preview)
Called when an item is closed in the viewer.
 
onDocumentOpened(item, preview)
Called when an item is opened in the viewer.
 
onViewerWindowClosed()
This event is called when the viewer window closes.
 
onViewerWindowOpened()
This event is called when the viewer window opens and the ContentViewer is ready to use.
 
open(item, openInBackground, openMessage)
Opens an item in the viewer.
 
openInMergeSplit(item, openInBackground, openMessage)
Opens an item in Merge and Split mode.
 
preview(item, openInBackground)
Previews an item in the viewer.

Constructor Detail

ecm.widget.dialog.ContentViewerWindow()

Method Detail

constructor()

<static> ecm.widget.dialog.ContentViewerWindow.ContentViewerWindow.getSizeAndPosition()

Returns the size and position of the viewer window as an Object.
Returns:
An object containing the size and position of the window. The object contains left, top, width and height. For example: {left: 0, top: 0, width: 100, height: 100}

<static> ecm.widget.dialog.ContentViewerWindow.ContentViewerWindow.saveSizeAndPosition()

Persists the size and position of the viewer window in a browser localStorage.

onDocumentClosed(item, preview)

Called when an item is closed in the viewer.
Parameters:
item
the item that was opened
preview
boolean indicating if closed from preview mode
Since:
3.0

onDocumentOpened(item, preview)

Called when an item is opened in the viewer.
Parameters:
item
the item that was opened
preview
boolean indicating if opened in preview mode
Since:
3.0

onViewerWindowClosed()

This event is called when the viewer window closes.

onViewerWindowOpened()

This event is called when the viewer window opens and the ContentViewer is ready to use.

open(item, openInBackground, openMessage)

Opens an item in the viewer.
Parameters:
item
The item to view.
openInBackground
openMessage
The ecm.model.message to display after the documents are opened.
Since:
3.0.1

openInMergeSplit(item, openInBackground, openMessage)

Opens an item in Merge and Split mode.
Parameters:
item
The item to view.
openInBackground
openMessage
The ecm.model.message to display after the documents are opened.
Since:
3.0.1

preview(item, openInBackground)

Previews an item in the viewer.
Parameters:
item
The item to view.
openInBackground