Class ecm.widget.viewer.BoxViewer


Extends ecm.widget.viewer.DocViewer.
Provides the Box Viewer widget.
Defined in: <ecm\widget\viewer\BoxViewer.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.
 
Determines if the document has completed loading.
 
Displays the item, if an item has been set on this viewer.
Methods borrowed from class ecm.widget.viewer.DocViewer:
closeItem, delegateToDownload, getItem, getNativeViewer, getPageNumber, ignoreDirty, isAppletViewer, isDirty, isIframeViewer, isLoading, isLocked, isPluginViewer, isPrinting, onDirty, onDocumentLoaded, onFallback, onLoad, onViewerFocusOut, saveAnnotations, setIsLoading, setItem, unloadIframe

Constructor Detail

ecm.widget.viewer.BoxViewer()

Method Detail

{Boolean} canOpenItem(item)

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

{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.

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.