Class ecm.model.ViewerMapping

Extends ecm.model._ModelObject.
Represents the mapping that is used to determine the viewer that is used to display to a particular item type. This class maintains the information from a single line in the viewer configuration that maps the item attributes to the type of viewer that is used. Private functions should not be used to access public members of the class. Access member variables directly. For example:

var obj = new ViewerMapping({ id: "myviewermapping", name: "myviewermapping"});
console.debug("Viewer Mapping ID=" + obj.id);

Note: Private getter methods, such as getContentType, will be removed in a future release.
Defined in: <ecm\model\ViewerMapping.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	ecm.model.ViewerMapping(properties) Constructs a viewer mapping.

Field Summary

Field Attributes	Field Name and Description
	contentType  The content type (mime type).
	itemType  A content class id.
	previewOnly  Flag indicating that this viewer mapping is to be used for Preview only.
	serverType  The server type.
	viewer  An instance of ecm.model.Viewer related to this mapping.

Fields borrowed from class ecm.model._ModelObject:

categorization, id, isRecurring, name, nameFilter, pane, status, type, userId

Method Summary

Method Attributes	Method Name and Description
	equals(viewer)
	getKey() Returns a unique identifying key for this mapping.
	useViewer(item, explicitMatchRequired, contentClass, forPreview) returns the viewer if the viewer should be used for the given contentType, serverType, itemType

Methods borrowed from class ecm.model._ModelObject:

destroy, onChange, own, refresh, toString

Field Detail

contentType

---

itemType

---

previewOnly

Since:

2.0.3.

---

serverType

---

viewer

Method Detail

equals(viewer)

Parameters:

viewer

---

getKey()

---

useViewer(item, explicitMatchRequired, contentClass, forPreview)

Parameters:

item

explicitMatchRequired

contentClass

forPreview

---