Class ecm.widget.viewer.AppletViewer
Extends
ecm.widget.viewer.IframeDocViewer.
The IBM Content Manager OnDemand Viewer Applet widget.
Defined in: <ecm\widget\viewer\AppletViewer.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 |
---|---|
canOpenItem(item)
Determine if the viewer can open the item on the current client and mid-tier platforms.
|
|
Close the item.
|
|
Return the Applet Viewer Applet instance.
|
|
Return the page number of the current page that is being viewed.
|
|
Determine if the viewer is Applet-based.
|
|
isDirty()
Determine if the viewer contains unsaved changes.
|
|
isLocked()
Determine if the item being shown in the viewer is locked.
|
|
Determine if the viewer is printing the document.
|
|
onDirty(dirty)
|
|
saveAnnotations(callback)
Save all annotation changes.
|
- Methods borrowed from class ecm.widget.viewer.IframeDocViewer:
- isIframeViewer, isLoaded, isLoading, setItem, showItem, unloadIframe
- Methods borrowed from class ecm.widget.viewer.DocViewer:
- delegateToDownload, getItem, ignoreDirty, isPluginViewer, onDocumentLoaded, onFallback, onLoad, onViewerFocusOut, setIsLoading
Method Detail
{Boolean} canOpenItem(item)
Determine if the viewer can open the item on the current client and mid-tier platforms. In the following
cases, this method will return
false
:
- The browser does not have a Java plug-in installed or available.
- The document is an office type of document, and the client system is not Windows 32 or 64-bit.
- Parameters:
- item
- The item to test.
- Returns:
- {Boolean} A value of
true
orfalse
, indicating whether this viewer can open the specified item.
closeItem()
Close the item. Terminate display of the document in the viewer, and clear any states related to the item
that is assigned to this viewer.
getNativeViewer()
Return the Applet Viewer Applet instance.
- Since:
- 2.0.3.3
{number} getPageNumber()
Return the page number of the current page that is being viewed.
- Returns:
- {number} A number that represents the current page being viewed.
{Boolean} isAppletViewer()
Determine if the viewer is Applet-based. Returns
true
.
- Returns:
- {Boolean} A value of
true
.
{Boolean} isDirty()
Determine if the viewer contains unsaved changes.
- Returns:
- {Boolean} A value of
true
orfalse
, if annotations have been added, modified, or deleted.
{Boolean} isLocked()
Determine if the item being shown in the viewer is locked.
- Returns:
- {Boolean} A value of
true
orfalse
, if the viewer has locked the item or sees the item as locked.
{Boolean} isPrinting()
Determine if the viewer is printing the document.
- Returns:
- {Boolean} A value of
true
orfalse
, if the viewer is in the process of printing a document.
onDirty(dirty)
- Parameters:
- dirty
saveAnnotations(callback)
Save all annotation changes.
- Parameters:
- callback
- If specified, call the callback upon completion of the save.