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);
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 |
---|---|
The content type (mime type).
|
|
A content class id.
|
|
Flag indicating that this viewer mapping is to be used for Preview only.
|
|
The server type.
|
|
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, getSortCriteria, onChange, own, refresh, toString
Constructor Detail
ecm.model.ViewerMapping(properties)
Constructs a viewer mapping. Note that viewer mappings are normally constructed as part of desktop loading and do
not need to be constructed explicitly.
- Parameters:
- properties
- The properties of the viewer mapping. These can be any of the public fields defined below and on ecm.model._ModelObject.
Field Detail
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.
- Since:
- 2.0.3
serverType
The server type.
viewer
An instance of ecm.model.Viewer related to this mapping.
Method Detail
equals(viewer)
- Parameters:
- 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
- Parameters:
- item
- explicitMatchRequired
- contentClass
- forPreview