Class ecm.widget.viewer.ContentViewerPane

Provides an embeddable viewer widget. ContentViewer creates instances of this widget, to open single viewer instances.
Defined in: <ecm\widget\viewer\ContentViewerPane.js>.

Constructor Summary

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

Field Summary

Field Attributes	Field Name and Description
	docViewer The instance of `DocViewer` opened within this widget.
	viewerItem The `ViewerItem` instance for the item currently being viewed.

Method Summary

Method Attributes	Method Name and Description
	activateViewer()
	closeItem()
	confirmClose(closeCallback, cancelCallback) Requests to close the viewer.
	getId()
	getItemIndex()
	getNextItem()
	getPageNumber()
	getPrevItem()
	getSaveOrWaitStatus(listHeading, nameList, asHtml)
	getSaveOrWaitStatusMessage(nameList, asHtml)
	hasNextItem()
	hasPrevItem()
	hideViewer() Hides the viewer if it is Applet-based, and on browsers where hiding is required in order to display other DOJO widgets in the same area of the display.
	isDirty()
	isLocked()
	isPrinting()
	isViewerLoaded()
	isViewerLoading()
	nextPageRequired()
	onClose(closeCallback, cancelCallback)
	openItem(viewerItem, pageNumber, callback) Open an item in this viewer.
	retrieveNextPage(callback)
	showViewer() Shows the viewer if it was previously hidden using hideViewer.
	unloadIframe()

Constructor Detail

ecm.widget.viewer.ContentViewerPane()

Field Detail

docViewer

The instance of DocViewer opened within this widget.

Since:: 2.0.1

viewerItem

The ViewerItem instance for the item currently being viewed.

Method Detail

activateViewer()

closeItem()

Deprecated:: As of 2.0.1. Use the DocViewer framework for document viewer specific operations instead.

confirmClose(closeCallback, cancelCallback)

Requests to close the viewer. If the viewer contains unsaved changes, or in the middle of printing, the user will be asked if they wish to abandon work, prior to closing. If the user confirms to close the viewer, the closeCallback is called. If they confirm to cancel closing, the cancelCallback is called.

Parameters:
closeCallback: Called when it is okay to close the viewer.
cancelCallback: Called when the viewer should not be closed.

getId()

getItemIndex()

Deprecated:: as of 2.0.1. This method is intended for internal use, and is being replaced.

getNextItem()

Deprecated:: as of 2.0.1. Use the ViewerItem framework for item specific operations instead.

getPageNumber()

getPrevItem()

Deprecated:: as of 2.0.1. Use the ViewerItem framework for item specific operations instead.

getSaveOrWaitStatus(listHeading, nameList, asHtml)

Parameters:
listHeading
nameList
asHtml

Deprecated:: as of 2.0.1. There is no replacement. Intended for internal use only.

getSaveOrWaitStatusMessage(nameList, asHtml)

Parameters:
nameList
asHtml

Deprecated:: as of 2.0.1. There is no replacement. Intended for internal use only.

hasNextItem()

Deprecated:: as of 2.0.1. Use the ViewerItem framework for item specific operations instead.

hasPrevItem()

Deprecated:: as of 2.0.1. Use the ViewerItem framework for item specific operations instead.

hideViewer()

Hides the viewer if it is Applet-based, and on browsers where hiding is required in order to display other DOJO widgets in the same area of the display. Use this call to work around Applet z-ordering issues.

isDirty()

Deprecated:: As of 2.0.1. Use the DocViewer framework for document viewer specific operations instead.

isLocked()

Deprecated:: As of 2.0.1. Use the DocViewer framework for document viewer specific operations instead.

isPrinting()

Deprecated:: As of 2.0.1. Use the DocViewer framework for document viewer specific operations instead.

isViewerLoaded()

Deprecated:: as of 2.0.1. Use docViewer.isLoaded() instead.

isViewerLoading()

nextPageRequired()

Deprecated:: as of 2.0.1. Use the ViewerItem framework for item specific operations instead.

onClose(closeCallback, cancelCallback)

Parameters:
closeCallback
cancelCallback

Deprecated:: as of 2.0.1. Replaced by closeViewer.

openItem(viewerItem, pageNumber, callback)

Open an item in this viewer. This call assigns the item to the viewer. Call activateViewer to display the item.

Parameters:
viewerItem: An instance of ViewerItem representing the item to open.
pageNumber: If specified, the page number to start viewing on. If not specified, or if the contained viewer does not support setting the viewing page, the viewer will open on page 1.
callback

retrieveNextPage(callback)

Parameters:
callback

Deprecated:: as of 2.0.1. Use the ViewerItem framework for item specific operations instead.

showViewer()

Shows the viewer if it was previously hidden using hideViewer.

unloadIframe()

Deprecated:: as of 2.0.1. Use the DocViewer framework for document viewer specific operations instead.