/**
* Copyright (C) 2005-2016 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* This extends the standard [document]{@link module:alfresco/documentlibrary/AlfDocument} module to add in support
* for showing thumbnails for containers and [previews]{@link module:alfresco/preview/AlfDocumentPreview} for documents.
* It was written specifically to support the [filmstrip view]{@link module:alfresco/documentlibrary/views/AlfFilmStripView}.
*
* @module alfresco/documentlibrary/views/layouts/AlfFilmStripViewDocument
* @extends module:alfresco/documentlibrary/AlfDocument
* @mixes module:alfresco/core/ResizeMixin
* @author Dave Draper
*/
define(["dojo/_base/declare",
"alfresco/documentlibrary/AlfDocument",
"alfresco/core/ResizeMixin",
"dojo/_base/lang",
"dojo/_base/array",
"dijit/registry",
"dojo/dom-construct",
"dojo/dom-geometry",
"dojo/dom-style",
"dojo/query",
"dojo/NodeList-dom"],
function(declare, AlfDocument, ResizeMixin, lang, array, registry, domConstruct, domGeom, domStyle, query, /*jshint unused:false*/ nodeListDom) {
return declare([AlfDocument, ResizeMixin], {
/**
* This is used to set the [heightAdjustment]{@link module:alfresco/layout/HeightMixin#heightAdjustment}
* of the rendered [previewer]{@link module:alfresco/preview/AlfDocumentPreview}.
*
* @instance
* @type {number}
* @default
* @since 1.0.41
*/
heightAdjustment: 0,
/**
* This is used to set the [heightMode]{@link module:alfresco/layout/HeightMixin#heightMode}
* of the rendered [previewer]{@link module:alfresco/preview/AlfDocumentPreview}.
*
* @instance
* @type {string}
* @default
* @since 1.0.41
*/
heightMode: "AUTO",
/**
* The value configured is passed to the
* [widgetsForPluginsOverrides]{@link module:alfresco/preview/AlfDocumentPreview#widgetsForPluginsOverrides}
* of the [widgetsForPluginsOverrides]{@link module:alfresco/preview/AlfDocumentPreview} that is rendered
* by default.
*
* @instance
* @type {object[]}
* @default
* @since 1.0.51
*/
previewerPluginOverrides: null,
/**
* Overrides the [inherited function]{@link module:alfresco/documentlibrary/AlfDocument#postMixInProperties}
* to prevent the subscription to the standard document request from being created.
*
* @instance
*/
postMixInProperties: function alfresco_documentlibrary_views_layouts_AlfFilmStripViewDocument__postMixInProperties() {
// Intentionally does nothing.
},
/**
* Sets up a NodeRef specific subscription if the current item is a document (such that the document data is only
* requested if asked for by the [Film Strip View]{@link module:alfresco/documentlibrary/views/AlfFilmStripView})
* and if the current item is a container then the standard thumbnail is rendered
*
* @instance
*/
postCreate: function alfresco_documentlibrary_views_layouts_AlfFilmStripViewDocument__postCreate() {
this.isContainer = lang.getObject("currentItem.node.isContainer", false, this);
this.nodeRef = lang.getObject("currentItem.nodeRef", false, this) || lang.getObject("currentItem.node.nodeRef", false, this);
if (this.isContainer === null)
{
// No container information, no subscription
}
else if (this.isContainer === true)
{
// This is a container, assume it's a folder and render the folder thumbnail.
this.processWidgets(lang.clone(this.widgetsForContainer), this.containerNode);
this.alfSetupResizeSubscriptions(this.resizeThumbnails, this);
}
else if (this.isContainer === false)
{
// This is a document so we can subscribe to the expected request to display content
this.widgets = [{
name: "alfresco/preview/AlfDocumentPreview",
config: {
heightMode: this.heightMode,
heightAdjustment: this.heightAdjustment,
widgetsForPluginsOverrides: this.previewerPluginOverrides
}
}];
this.alfSubscribe("ALF_FILMSTRIP_DOCUMENT_REQUEST__" + this.nodeRef, lang.hitch(this, this.requestDocument, this.nodeRef));
}
},
/**
* This function is only called when a container thumbnail is being displayed and it will update
* the thumbnail image as the overall size of the containing DOM element changes.
*
* @instance
*/
resizeThumbnails: function alfresco_documentlibrary_views_layouts_AlfFilmStripViewDocument__resizeThumbnails() {
var computedStyle = domStyle.getComputedStyle(this.domNode);
var output = domGeom.getMarginBox(this.domNode, computedStyle);
var x = output.w; // NOTE: This is probably too big in most cases :)
query(".alfresco-renderers-Thumbnail > span.inner > img", this.domNode).style({
width: x + "px",
height: x + "px"
});
},
/**
* Tracks whether or not the document has already been rendered
*
* @instance
* @type {boolean}
* @default
*/
_documentRequested: false,
/**
* This function is provided so that explicit requests can be made to generate the preview
*
* @instance
*/
render: function alfresco_documentlibrary_views_layouts_AlfFilmStripViewDocument__render() {
if (!this.isContainer && this.nodeRef)
{
this.requestDocument(this.nodeRef);
}
},
/**
* Handles requests to obtain document data in order create a document preview. The specific node is requested
* via the [DocumentService]{@link module:alfresco/services/DocumentService}.
*
* @instance
* @param {string} nodeRef The NodeRef to request the data for
* @param {object} payload The payload of the request
*/
requestDocument: function alfresco_documentlibrary_views_layouts_AlfFilmStripViewDocument__requestDocument(nodeRef, payload) {
if (!this._documentRequested)
{
var uuid = this.generateUuid();
this.alfSubscribe(uuid + "_SUCCESS", lang.hitch(this, this.onDocumentLoaded));
this.alfPublish("ALF_RETRIEVE_SINGLE_DOCUMENT_REQUEST", {
nodeRef: nodeRef,
alfResponseTopic: this.pubSubScope + uuid
}, true);
this._documentRequested = true;
}
},
/**
* Defines the widgets to use for containers.
*
* @instance
* @type {array}
*/
widgetsForContainer: [
{
name: "alfresco/renderers/Thumbnail",
config: {
folderImage: "folder-256.png"
}
}
]
});
});
Alfresco Aikau Widgets