248 lines
8.5 KiB
JavaScript
248 lines
8.5 KiB
JavaScript
;(function (define, undefined) {
|
|
'use strict';
|
|
define([
|
|
'jquery', 'underscore', 'annotator', 'js/edxnotes/utils/utils'
|
|
], function ($, _, Annotator, Utils) {
|
|
var _t = Annotator._t;
|
|
|
|
/**
|
|
* We currently run JQuery 1.7.2 in Jasmine tests and LMS.
|
|
* AnnotatorJS 1.2.9. uses two calls to addBack (in the two functions
|
|
* 'isAnnotator' and 'onHighlightMouseover') which was only defined in
|
|
* JQuery 1.8.0. In LMS, it works without throwing an error because
|
|
* JQuery.UI 1.10.0 adds support to jQuery<1.8 by augmenting '$.fn' with
|
|
* that missing function. It is not the case for all Jasmine unit tests,
|
|
* so we add it here if necessary.
|
|
**/
|
|
if (!$.fn.addBack) {
|
|
$.fn.addBack = function (selector) {
|
|
return this.add(
|
|
selector === null ? this.prevObject : this.prevObject.filter(selector)
|
|
);
|
|
};
|
|
}
|
|
|
|
/**
|
|
* The original _setupDynamicStyle uses a very expensive call to
|
|
* Util.maxZIndex(...) that sets the z-index of .annotator-adder,
|
|
* .annotator-outer, .annotator-notice, .annotator-filter. We set these
|
|
* values in annotator.min.css instead and do nothing here.
|
|
*/
|
|
Annotator.prototype._setupDynamicStyle = function() { };
|
|
|
|
Annotator.frozenSrc = null;
|
|
|
|
/**
|
|
* Modifies Annotator.Plugin.Auth.haveValidToken to make it work with a new
|
|
* token format.
|
|
**/
|
|
Annotator.Plugin.Auth.prototype.haveValidToken = function() {
|
|
return (
|
|
this._unsafeToken &&
|
|
this._unsafeToken.sub &&
|
|
this._unsafeToken.exp &&
|
|
this._unsafeToken.iat &&
|
|
this.timeToExpiry() > 0
|
|
);
|
|
};
|
|
|
|
/**
|
|
* Modifies Annotator.Plugin.Auth.timeToExpiry to make it work with a new
|
|
* token format.
|
|
**/
|
|
Annotator.Plugin.Auth.prototype.timeToExpiry = function() {
|
|
var now = new Date().getTime() / 1000,
|
|
expiry = this._unsafeToken.exp,
|
|
timeToExpiry = expiry - now;
|
|
|
|
return (timeToExpiry > 0) ? timeToExpiry : 0;
|
|
};
|
|
|
|
/**
|
|
* Modifies Annotator.highlightRange to add a "tabindex=0" attribute
|
|
* to the <span class="annotator-hl"> markup that encloses the note.
|
|
* These are then focusable via the TAB key.
|
|
**/
|
|
Annotator.prototype.highlightRange = _.compose(
|
|
function (results) {
|
|
$('.annotator-hl', this.wrapper).attr('tabindex', 0);
|
|
return results;
|
|
},
|
|
Annotator.prototype.highlightRange
|
|
);
|
|
|
|
/**
|
|
* Modifies Annotator.destroy to unbind click.edxnotes:freeze from the
|
|
* document and reset isFrozen to default value, false.
|
|
**/
|
|
Annotator.prototype.destroy = _.compose(
|
|
Annotator.prototype.destroy,
|
|
function () {
|
|
// We are destroying the instance that has the popup visible, revert to default,
|
|
// unfreeze all instances and set their isFrozen to false
|
|
if (this === Annotator.frozenSrc) {
|
|
this.unfreezeAll();
|
|
} else {
|
|
// Unfreeze only this instance and unbound associated 'click.edxnotes:freeze' handler
|
|
$(document).off('click.edxnotes:freeze' + this.uid);
|
|
this.isFrozen = false;
|
|
}
|
|
|
|
if (this.logger && this.logger.destroy) {
|
|
this.logger.destroy();
|
|
}
|
|
// Unbind onNoteClick from click
|
|
this.viewer.element.off('click', this.onNoteClick);
|
|
this.wrapper.off('click', '.annotator-hl');
|
|
}
|
|
);
|
|
|
|
/**
|
|
* Modifies Annotator.Viewer.html.item template to add an i18n for the
|
|
* buttons.
|
|
**/
|
|
Annotator.Viewer.prototype.html.item = [
|
|
'<li class="annotator-annotation annotator-item">',
|
|
'<span class="annotator-controls">',
|
|
'<a href="#" title="', _t('View as webpage'), '" class="annotator-link">',
|
|
_t('View as webpage'),
|
|
'</a>',
|
|
'<button title="', _t('Edit'), '" class="annotator-edit">',
|
|
_t('Edit'),
|
|
'</button>',
|
|
'<button title="', _t('Delete'), '" class="annotator-delete">',
|
|
_t('Delete'),
|
|
'</button>',
|
|
'</span>',
|
|
'</li>'
|
|
].join('');
|
|
|
|
/**
|
|
* Overrides Annotator._setupViewer to add a "click" event on viewer and to
|
|
* improve line breaks.
|
|
**/
|
|
Annotator.prototype._setupViewer = function () {
|
|
var self = this;
|
|
this.viewer = new Annotator.Viewer({readOnly: this.options.readOnly});
|
|
this.viewer.element.on('click', _.bind(this.onNoteClick, this));
|
|
this.viewer.hide()
|
|
.on("edit", this.onEditAnnotation)
|
|
.on("delete", this.onDeleteAnnotation)
|
|
.addField({
|
|
load: function (field, annotation) {
|
|
if (annotation.text) {
|
|
$(field).html(Utils.nl2br(Annotator.Util.escape(annotation.text)));
|
|
} else {
|
|
$(field).html('<i>' + _t('No Comment') + '</i>');
|
|
self.publish('annotationViewerTextField', [field, annotation]);
|
|
}
|
|
}
|
|
})
|
|
.element.appendTo(this.wrapper).bind({
|
|
"mouseover": this.clearViewerHideTimer,
|
|
"mouseout": this.startViewerHideTimer
|
|
});
|
|
return this;
|
|
};
|
|
|
|
Annotator.Editor.prototype.isShown = Annotator.Viewer.prototype.isShown;
|
|
|
|
/**
|
|
* Modifies Annotator.onHighlightMouseover to avoid showing the viewer if the
|
|
* editor is opened.
|
|
**/
|
|
Annotator.prototype.onHighlightMouseover = _.wrap(
|
|
Annotator.prototype.onHighlightMouseover,
|
|
function (func, event) {
|
|
// Do nothing if the editor is opened.
|
|
if (this.editor.isShown()) {
|
|
return false;
|
|
}
|
|
return func.call(this, event);
|
|
},
|
|
Annotator.prototype._setupViewer
|
|
);
|
|
|
|
/**
|
|
* Modifies Annotator._setupWrapper to add a "click" event on '.annotator-hl'.
|
|
**/
|
|
Annotator.prototype._setupWrapper = _.compose(
|
|
function () {
|
|
this.element.on('click', '.annotator-hl', _.bind(this.onHighlightClick, this));
|
|
return this;
|
|
},
|
|
Annotator.prototype._setupWrapper
|
|
);
|
|
|
|
Annotator.Editor.prototype.isShown = Annotator.Viewer.prototype.isShown;
|
|
|
|
$.extend(true, Annotator.prototype, {
|
|
isFrozen: false,
|
|
uid: _.uniqueId(),
|
|
|
|
onHighlightClick: function (event) {
|
|
event.stopPropagation();
|
|
if (!this.editor.isShown()) {
|
|
this.unfreezeAll();
|
|
this.onHighlightMouseover.call(this, event);
|
|
Annotator.frozenSrc = this;
|
|
this.freezeAll();
|
|
}
|
|
},
|
|
|
|
onNoteClick: function (event) {
|
|
event.stopPropagation();
|
|
Annotator.Util.preventEventDefault(event);
|
|
if (!$(event.target).is('.annotator-delete')) {
|
|
Annotator.frozenSrc = this;
|
|
this.freezeAll();
|
|
}
|
|
},
|
|
|
|
freeze: function () {
|
|
if (!this.isFrozen) {
|
|
// Remove default events
|
|
this.removeEvents();
|
|
this.viewer.element.unbind('mouseover mouseout');
|
|
this.uid = _.uniqueId();
|
|
$(document).on('click.edxnotes:freeze' + this.uid, _.bind(this.unfreeze, this));
|
|
this.isFrozen = true;
|
|
}
|
|
return this;
|
|
},
|
|
|
|
unfreeze: function () {
|
|
if (this.isFrozen) {
|
|
// Add default events
|
|
this.addEvents();
|
|
this.viewer.element.bind({
|
|
'mouseover': this.clearViewerHideTimer,
|
|
'mouseout': this.startViewerHideTimer
|
|
});
|
|
this.viewer.hide();
|
|
$(document).off('click.edxnotes:freeze' + this.uid);
|
|
this.isFrozen = false;
|
|
Annotator.frozenSrc = null;
|
|
}
|
|
return this;
|
|
},
|
|
|
|
freezeAll: function () {
|
|
_.invoke(Annotator._instances, 'freeze');
|
|
return this;
|
|
},
|
|
|
|
unfreezeAll: function () {
|
|
_.invoke(Annotator._instances, 'unfreeze');
|
|
return this;
|
|
},
|
|
|
|
showFrozenViewer: function (annotations, location) {
|
|
this.showViewer(annotations, location);
|
|
this.freezeAll();
|
|
return this;
|
|
}
|
|
});
|
|
});
|
|
}).call(this, define || RequireJS.define);
|