/**
* 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 renderer can be used to both display a count of comments on a particular node as well as providing
* a link to where comments can be added, edited or deleted. The link can either be to particular page
* or alternatively can be used with a [VerticalReveal]{@link module:alfresco/layout/VerticalReveal},
* the [DialogService]{@link module:alfresco/services/DialogService} or some other widget or service to
* display a [Comments List]{@link module:alfresco/renderers/CommentsList}. For example the
* standard Document Library [Detailed View]{@link module:alfresco/documentlibrary/views/AlfDetailedView}
* uses the [VerticalReveal]{@link module:alfresco/layout/VerticalReveal} approach to allow inline commenting.
*
* @module aikau/core/BaseWidget
* @mixes external:dijit/_OnDijitClickMixin
* @mixes module:alfresco/core/UrlUtilsMixin
* @mixes module:alfresco/renderers/_JsNodeMixin
* @mixes module:alfresco/navigation/_HtmlAnchorMixin
* @mixes module:alfresco/renderers/_PublishPayloadMixin
* @author Dave Draper
*/
define(["dojo/_base/declare",
"aikau/core/BaseWidget",
"dijit/_OnDijitClickMixin",
"alfresco/renderers/_JsNodeMixin",
"alfresco/navigation/_HtmlAnchorMixin",
"alfresco/renderers/_PublishPayloadMixin",
"alfresco/core/UrlUtilsMixin",
"dojo/_base/lang",
"dojo/dom-class"],
function(declare, BaseWidget, _OnDijitClickMixin, _JsNodeMixin, _HtmlAnchorMixin,
_PublishPayloadMixin, UrlUtilsMixin, lang, domClass) {
return declare([BaseWidget, _OnDijitClickMixin, _JsNodeMixin, _HtmlAnchorMixin, UrlUtilsMixin, _PublishPayloadMixin], {
/**
* An array of the i18n files to use with this widget.
*
* @instance
* @type {object[]}
* @default [{i18nFile: "./i18n/Comments.properties"}]
*/
i18nRequirements: [{i18nFile: "./i18n/Comments.properties"}],
/**
* An array of the CSS files to use with this widget.
*
* @instance
* @type {object[]}
* @default [{cssFile:"./css/Comments.css"}]
*/
cssRequirements: [{cssFile:"./css/Comments.css"}],
/**
* The dot-notation property to use for the count of comments. Can be overridden.
*
* @instance
* @type {string}
* @default
*/
commentCountProperty: "node.properties.fm:commentCount",
/**
* The type of comment link URL. Should only be overridden by extending modules
* not through configuration.
*
* @instance
* @type {string}
* @default
*/
targetUrlType: "FULL_PATH",
/**
* The comment link target, defaults to opening the link in the current browser
* tab or window.
*
* @instance
* @type {string}
* @default
*/
linkTarget: "CURRENT",
/**
* The topic to subscribe to in order to get the latest count of comments.
*
* @instance
* @type {string}
* @default
*/
subscriptionTopic: null,
/**
* Overrides [the inherited function]{@link module:aikau/core/BaseWidget#createWidgetDom}
* to construct the DOM for the widget using native browser capabilities.
*
* @instance
* @since 1.0.101
*/
createWidgetDom: function alfresco_renderers_Comments__createWidgetDom() {
this.domNode = document.createElement("span");
this.domNode.classList.add("alfresco-renderers-Comments");
var linkNode = document.createElement("span");
linkNode.classList.add("comment-link");
linkNode.setAttribute("tabindex", "0");
linkNode.setAttribute("title", this.title);
linkNode.textContent = this.commentLabel;
this._attach(linkNode, "ondijitclick", lang.hitch(this, this.onCommentClick));
this.countNode = document.createElement("span");
this.countNode.classList.add("count");
this.countNode.classList.add("hidden");
this.countNode.textContent = this.commentCount;
this.domNode.appendChild(linkNode);
this.domNode.appendChild(this.countNode);
},
/**
* Set up the attributes to be used when rendering the template.
*
* @instance
*/
postMixInProperties: function alfresco_renderers_Comments__postMixInProperties() {
this.commentLabel = this.message("comments.label");
// Get a tooltip appropriate for the node type...
var isContainer = lang.getObject("node.isContainer", false, this.currentItem);
if (isContainer)
{
this.label = this.message("comments.folder.tooltip");
}
else
{
this.label = this.message("comments.document.tooltip");
}
// By default this will generate a link to details page for the current Node. However,
// if a publishTopic is provided then it will publish on topic is provided
if (!this.publishTopic)
{
// Get the URL for making a comment...
// TODO: This should be replaced by publishing an action to allow greater control over how comments are made
// TODO: Need to add siteId and repositoryUrl from somewhere
// TODO: The actionUrls approach is neither performant nor configurable so should be replaced.
var actionUrls = this.getActionUrls(this.currentItem, null, null);
var urlType = (isContainer ? "folderDetailsUrl" : "documentDetailsUrl");
if (actionUrls[urlType])
{
this.targetUrl = actionUrls[urlType] + "#comment";
}
else
{
this.targetUrl = "";
}
}
// Get the count of comments if there are any...
this.commentCount = lang.getObject(this.commentCountProperty, false, this.currentItem);
if (!this.commentCount)
{
this.commentCount = 0;
}
},
/**
* Returns an array containing the selector that identifies the span to wrap in an anchor.
* This overrides the [mixed in function]{@link module:alfresco/navigation/_HtmlAnchorMixin}
* that just returns an empty array.
*
* @instance
*/
getAnchorTargetSelectors: function alfresco_renderers_Comments__getAnchorTargetSelectors() {
return ["span.comment-link"];
},
/**
* @instance
*/
postCreate: function alfresco_renderers_Comments__postCreate() {
if (this.commentCount || this.commentCount === 0)
{
domClass.remove(this.countNode, "hidden");
}
this.makeAnchor(this.targetUrl, this.targetUrlType);
if (this.subscriptionTopic)
{
this.alfSubscribe(this.subscriptionTopic, lang.hitch(this, this.onCommentCountUpdate));
}
},
/**
* The dot-notation property to retrieve from the payload published on the
* [subscriptionTopic]{@link module:alfresco/renderers/Comments#subscriptionTopic}
* to use to set the comment count with. By default this assumes it will be triggered
* from an [list]{@link module:alfresco/lists/AlfList} publishing on the same scope and
* therefore uses the total number of documents that this list contains.
*
* @instance
* @type {string}
* @default
*/
publicationCountProperty: "totalRecords",
/**
* Called whenever the [subscriptionTopic]{@link module:alfresco/renderers/Comments#subscriptionTopic}
* is published on and updates the rendered count of comments with the attribute defined by
* the [publicationCountProperty]{@link module:alfresco/renderers/Comments#publicationCountProperty}.
*
* @instance
* @param {object} payload
*/
onCommentCountUpdate: function alfresco_renderers_Comments__onCommentCountUpdate(payload) {
var updatedCount = lang.getObject(this.publicationCountProperty, false, payload);
if (updatedCount || updatedCount === 0)
{
this.countNode.innerHTML = updatedCount;
}
},
/**
* Handles clicking on the comments link click and issues a navigation request unless
* a specific publishTopic has been provided (in which case that topic will be published
* on instead using the configured publishPayload).
*
* @instance
* @param {object} evt The click event
*/
onCommentClick: function alfresco_renderers_Comments__onCommentClick(/*jshint unused:false*/ evt) {
if (this.publishTopic)
{
// Clone the configured payload to avoid collisions with other instances...
this.publishPayload = lang.clone(this.publishPayload);
var generatedPayload = this.getGeneratedPayload(true);
this.alfPublish(this.publishTopic, generatedPayload, this.publishGlobal);
}
else
{
this.alfPublish("ALF_NAVIGATE_TO_PAGE", { url: this.targetUrl,
type: this.targetUrlType,
target: this.linkTarget});
}
}
});
});
Alfresco Aikau Widgets