Class ecm.widget.viewer.FilenetViewer


Extends ecm.widget.viewer.IframeDocViewer.
Provides the FileNet Viewer widget.
Defined in: <ecm\widget\viewer\FilenetViewer.js>.

Constructor Summary

Constructor Attributes Constructor Name and Description
 
Fields borrowed from class ecm.widget.viewer.DocViewer:
docViewerClass, item, preview, showErrorOnFallback, startingPage, viewerDef

Method Summary

Method Attributes Method Name and Description
 
Determines if the viewer can open the item on the current client and mid-tier platforms.
 
Closes the item.
 
Return the Daeja ViewONE Pro Applet instance.
 
Returns the page number of the current page being viewed.
 
 
Determines if the viewer is Applet-based.
 
Determines if the viewer contains unsaved changes.
 
Determines if the document has completed loading.
 
Determines if the current document is in the process of being loaded into the viewer.
 
Determines if the viewer is printing the document.
 
saveAnnotations(callback)
Saves all annotation changes.
 
Displays the item, if an item has been set on this viewer.
Methods borrowed from class ecm.widget.viewer.IframeDocViewer:
isIframeViewer, setItem, unloadIframe
Methods borrowed from class ecm.widget.viewer.DocViewer:
delegateToDownload, getItem, isLocked, isPluginViewer, onDirty, onDocumentLoaded, onFallback, onLoad, onViewerFocusOut, setIsLoading

Constructor Detail

ecm.widget.viewer.FilenetViewer()

Method Detail

{Boolean} canOpenItem(item)

Determines if the viewer can open the item on the current client and mid-tier platforms. In the following cases, this method will return false:
Parameters:
item
The item to test.
Returns:
{Boolean} A value of true or false, indicating whether this viewer can open the specified item.

closeItem()

Closes the item. Terminates display of the document in the viewer, and clears any states related to the item assigned to this viewer.

getNativeViewer()

Return the Daeja ViewONE Pro Applet instance.
Since:
2.0.3.3

{number} getPageNumber()

Returns the page number of the current page being viewed.
Returns:
{number}

ignoreDirty()


{Boolean} isAppletViewer()

Determines if the viewer is Applet-based. Returns true.
Returns:
{Boolean} True.

{Boolean} isDirty()

Determines if the viewer contains unsaved changes.
Returns:
{Boolean} A value of true or false, if annotations have been added, modified, or deleted.

{Boolean} isLoaded()

Determines if the document has completed loading.
Returns:
{Boolean} A value of true or false, if loading and display of the document has completed.

{Boolean} isLoading()

Determines if the current document is in the process of being loaded into the viewer.
Returns:
{Boolean} A value of true or false, if the document is in the process of loading into the viewer.

{Boolean} isPrinting()

Determines if the viewer is printing the document.
Returns:
{Boolean} A value of true or false, if the viewer is in the process of printing a document.

saveAnnotations(callback)

Saves all annotation changes.
Parameters:
callback
If specified, call the callback upon completion of the save.

showItem()

Displays the item, if an item has been set on this viewer. The callback will be called on successful completion of showing the item.