Class ecm.widget.viewer.DocViewer

Extends dijit._Widget.
Provides a base class for all document viewer widgets. All document viewers in ICN have this widget/class as their base.
Defined in: <ecm\widget\viewer\DocViewer.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	ecm.widget.viewer.DocViewer()

Field Summary

Field Attributes	Field Name and Description
	docViewerClass  Sets the document viewer's CSS class for the DocViewer container.
	item  The item assigned to this doc viewer.
	preview  Indicates whether this instance of DocViewer is being used for preview.
	showErrorOnFallback  Indicates whether or not to show an error dialog, stating that no viewers are available to view a document, when the onFallback handler does not find a backup viewer.
	startingPage  The page to start on when initially opening the item to view.
	viewerDef  The instance of ecm.model.Viewer associated with this DocViewer instance.

Method Summary

Method Attributes	Method Name and Description
	canOpenItem(item) Determines if the viewer can open the item on the current client and mid-tier platforms.
	changesNeedInteraction() Determines if the viewer contains unsaved changes that need user interaction.
	closeItem() Closes the item.
	delegateToDownload(item) Return true if the caller should initate the download action instead of showing the item in this viewer.
	disableAnnotationEdit() Disable editing annotations
	disableMergeSplitMode() Disable the Merge and Split mode.
	enableAnnotationEdit() Enable editing annotations
	enableMergeSplitMode() Enable the Merge and Split mode.
	getItem(callback, refresh, refreshItem, version) Gets an instance of the item assigned to this viewer.
	getNativeViewer() Returns an instance of the object representing the native viewer implementation of this DocViewer, if available.
	getPageNumber() Returns the page number of the current page being viewed, if the viewer supports paging.
	ignoreDirty(onWindowClose) Determines if the user should be prompted to save changes when isDirty is true.
	isActive() Determines if the viewer is active.
	isAppletViewer() Determines if the viewer is Applet-based.
	isBookmarkSupported() Determines if bookmarks are supported for the document.
	isDirty() Determines if the viewer contains unsaved changes.
	isIframeViewer() Determines if the viewer is iframe-based.
	isLoaded() Determines if the document has completed loading.
	isLoading() Determines if the current document is in the process of being loaded.
	isLocked() Determines if the item being shown in the viewer is locked.
	isMergeSplitSupported() Determines if the Merge and Split is supported for the document.
	isPluginViewer() Indicates whether the viewer uses a browser plugin.
	isPrinting() Determines if the viewer is printing the document.
	isSplitViewSupported() Returns true if the viewer supports split view layouts
	onAnnotationsSaved(item, resetEditItem, savedFromConfirm) Called when annotations are saved and properties require refresh to current version.
	onDirty(dirty) Called when the contained viewer dirty state changes, either by acquiring unsaved changes, and when changes are saved.
	onDocumentLoaded() This event fires when the document has loaded.
	onFallback(notFoundCallback) Called when the viewer is unable to successfully open the document.
	onItemAdd(item) Called when the contained viewer adds a new item.
	onItemUpdate(item, resetOriginalItem, keepPageNumber) Called when the contained viewer updates the item.
	onLoad() If this is an iframe-based viewer, this event fires for the iframe onload event
	onMergeSplitModeFailed() Called when the Merge and Split mode failed.
	onOriginalItemChange() Called when the original item used to open the viewer is changed.
	onViewerFocusOut(movingup) Called when the contained viewer programmatically gives up focus.
	reloadItem(item, viewerReused) Reloads the item of this viewer.
	resetItem(item, viewerReused, keepPageNumber) Resets the item of this viewer.
	saveAnnotations(callback, errorback, savedFromConfirm) Saves all annotation changes, if annotation editing is supported.
	setIsLoading(loading) Sets the loading status for this widget.
	setItem(item, pageNumber, viewerReused, version) Assigns an item to this viewer.
	showItem(callback) Displays the item, if an item has been set on this viewer.
	unloadIframe() If the viewer is an iframe viewer, this call sets its src to "about:blank".

Field Detail

docViewerClass

---

item

Deprecated:

This item property is not guaranteed to be in the correct window context, so it can only be used to obtain the document id/properties required for the viewer to obtain the document content and annotations. Use getItem instead.

---

preview

Since:

2.0.2

---

showErrorOnFallback

Since:

2.0.3

---

startingPage

Since:

2.0.2

---

viewerDef

Since:

2.0.2

Method Detail

{Boolean} canOpenItem(item)

Parameters:

item

The item to test.

Returns:

{Boolean} True or false, indicating whether this viewer can open the specified item.

---

{Boolean} changesNeedInteraction()

Returns:

{Boolean} True or false, if there are unsaved changes that need user interaction.

---

closeItem()

---

delegateToDownload(item)

Parameters:

item

Since:

2.0.2

---

disableAnnotationEdit()

---

disableMergeSplitMode()

Since:

3.0.1

---

enableAnnotationEdit()

---

enableMergeSplitMode()

Since:

3.0.1

---

getItem(callback, refresh, refreshItem, version)

Parameters:

callback

The callback to call upon completion, the item instance will be passed as the sole parameter to this callback.

refresh

Specify true or false, to refresh the item.

refreshItem

Specify the fresh item to be used.

version

The version of the document to retrieve. Defaults to "specific". (optional)

Since:

2.0.3

---

getNativeViewer()

Since:

2.0.3.3

---

{number} getPageNumber()

Returns:

{number}

---

{Boolean} ignoreDirty(onWindowClose)

Parameters:

onWindowClose

The flag to indicate if this method is called while the window is being closed by the user.

Returns:

{Boolean} True or false, if the isDirty value sould be ignored.

---

{Boolean} isActive()

Returns:

{Boolean} True or false, if the viewer is active.

---

{Boolean} isAppletViewer()

Returns:

{Boolean} True or false, if the viewer is Applet-based.

---

{Boolean} isBookmarkSupported()

Since:

3.0.1

Returns:

{Boolean} True or false, if bookmarks are supported.

---

{Boolean} isDirty()

Returns:

{Boolean} True or false, if there are unsaved changes.

---

{Boolean} isIframeViewer()

Returns:

{Boolean} True or false, if the viewer is presented within an internal iframe

---

{Boolean} isLoaded()

Returns:

{Boolean} True or false, if loading and display of the document has completed.

---

{Boolean} isLoading()

Returns:

{Boolean} True or false, if the document is in the process of loading into the viewer.

---

{Boolean} isLocked()

Returns:

{Boolean} True or false, if the viewer has locked the item or sees the item as locked.

---

{Boolean} isMergeSplitSupported()

Since:

3.0.1

Returns:

{Boolean} True or false, if the Merge and Split is supported.

---

{Boolean} isPluginViewer()

Since:

2.0.3

Returns:

{Boolean} True or false, if the viewer is Plugin-based.

---

{Boolean} isPrinting()

Returns:

{Boolean} True or false, if the viewer is in the process of printing a document.

---

isSplitViewSupported()

Since:

3.0.7.2

---

onAnnotationsSaved(item, resetEditItem, savedFromConfirm)

Parameters:

item

The item containing the annotations saved.

resetEditItem

The flag to reset the item in the properties pane.

savedFromConfirm

Indicates the save was from the user confirming when moving to a new document.

Since:

3.0.7

---

onDirty(dirty)

Parameters:

dirty

boolean indicating whether the new viewer state is dirty or not.

Since:

2.0.2

---

onDocumentLoaded()

---

onFallback(notFoundCallback)

Parameters:

notFoundCallback

If specified, this method will be called by the ContentViewer framework, when there is no fallback viewer available for the item being viewed.

---

onItemAdd(item)

Parameters:

item

Since:

3.0.1

---

onItemUpdate(item, resetOriginalItem, keepPageNumber)

Parameters:

item

The updated item.

resetOriginalItem

The flag to reset the viewer with the original item once refreshed.

keepPageNumber

Since:

3.0.1

---

onLoad()

---

onMergeSplitModeFailed()

Since:

3.0.1

---

onOriginalItemChange()

Since:

3.0.7

---

onViewerFocusOut(movingup)

Parameters:

movingup

Boolean, to set to true if the focus out is the result of a shift-tab, otherwise false.

---

reloadItem(item, viewerReused)

Parameters:

item

The item being assigned to this viewer.

viewerReused

The flag to indicate the viewer should be reused. (optional)

Since:

3.0.10

---

resetItem(item, viewerReused, keepPageNumber)

Parameters:

item

The item being assigned to this viewer.

viewerReused

The flag to indicate the viewer should be reused. (optional)

keepPageNumber

Since:

3.0.7

---

saveAnnotations(callback, errorback, savedFromConfirm)

Parameters:

callback

If specified, call the callback upon completion of the save.

errorback

If specified, call the callback upon failure of the save.

savedFromConfirm

Indicates the save is due to the user confirming to save when when closing the current document.

---

setIsLoading(loading)

Parameters:

loading

Since:

2.0.2

---

setItem(item, pageNumber, viewerReused, version)

Parameters:

item

The item being assigned to this viewer.

pageNumber

For document viewers that support page control, the page number to start on. If not specified, page 1 is assumed. (optional)

viewerReused

The flag to indicate the viewer should be reused. (optional)

version

The version of the document to be retrieved, i.e., "current", "released", or "specific". (optional)

---

showItem(callback)

Parameters:

callback

The callback to call on successful completion of this call. (optional)

---

unloadIframe()

---