mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-12-01 17:36:35 +00:00
7233ea8f1b
The EventEmitter API we inherited from Node.js and then bastardized was getting awkward and cumbersome. The number of uses of ve.bind was getting out of control, and removing events meant caching the bound method in a property. Many of the "features" of EventEmitter wasn't even being used, some causing overhead, others just causing bloat. This change cleans up how EventEmitter is used throughout the codebase. The new event emitter API includes: * emit - identical to the previous API, no longer throws an error if you emit error without a handler * once - identical to the previous API, still introduces a wrapper* on - compatible with the previous API but has some new features * off - identical to removeListener in the previous API * connect - very similar to addListenerMethods but doesn't wrap callbacks in closures anymore * disconnect - new, basically the opposite of addListenerMethods Another change that is made in this commit is mixing in rather than inheriting from EventEmitter. Finally, there are changes throughout the codebase anywhere connect/disconnect could be used. Change-Id: Ic3085d39172a8a719ce7f036690f673e59848d3a
101 lines
2.4 KiB
JavaScript
101 lines
2.4 KiB
JavaScript
/*!
|
|
* VisualEditor ContentEditable GeneratedContentNode class.
|
|
*
|
|
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
/**
|
|
* ContentEditable generated content node.
|
|
*
|
|
* @class
|
|
* @abstract
|
|
* @extends ve.ce.LeafNode
|
|
* @constructor
|
|
* @param {ve.dm.GeneratedContentNode} model Model to observe
|
|
*/
|
|
ve.ce.GeneratedContentNode = function VeCeGeneratedContentNode( model ) {
|
|
// Parent constructor
|
|
ve.ce.LeafNode.call( this, model );
|
|
|
|
// DOM Changes
|
|
this.$.addClass( 've-ce-generatedContentNode' );
|
|
this.$.attr( 'contenteditable', false );
|
|
|
|
// Events
|
|
this.model.connect( this, { 'update': 'onUpdate' } );
|
|
|
|
// Initialization
|
|
this.onUpdate();
|
|
};
|
|
|
|
/* Inheritance */
|
|
|
|
ve.inheritClass( ve.ce.GeneratedContentNode, ve.ce.LeafNode );
|
|
|
|
/* Static Properties */
|
|
|
|
ve.ce.GeneratedContentNode.static.name = 'generatedContent';
|
|
|
|
/* Methods */
|
|
|
|
/**
|
|
* Handle update events.
|
|
*
|
|
* @method
|
|
*/
|
|
ve.ce.GeneratedContentNode.prototype.onUpdate = function () {
|
|
var store = this.model.doc.getStore(),
|
|
index = store.indexOfHash( ve.getHash( this.model ) );
|
|
if ( index !== null ) {
|
|
this.$.empty().append( store.value( index ) );
|
|
} else {
|
|
this.startGenerating();
|
|
this.generateContents()
|
|
.done( ve.bind( this.doneGenerating, this ) )
|
|
.fail( ve.bind( this.failGenerating, this ) );
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Start a deferred process to generate the contents of the node.
|
|
* @returns {jQuery.Promise} Promise object
|
|
*/
|
|
ve.ce.GeneratedContentNode.prototype.generateContents = function () {
|
|
throw new Error( 've.ce.GeneratedContentNode subclass must implement generateContents' );
|
|
};
|
|
|
|
/**
|
|
* Called when the node starts generating new content.
|
|
* @method
|
|
*/
|
|
ve.ce.GeneratedContentNode.prototype.startGenerating = function () {
|
|
// TODO: add 'generating' style
|
|
};
|
|
|
|
/**
|
|
* Called when the node successfully finishes generating new content.
|
|
*
|
|
* @method
|
|
* @param {HTMLElement[]} domElements Generated content
|
|
*/
|
|
ve.ce.GeneratedContentNode.prototype.doneGenerating = function ( domElements ) {
|
|
var store = this.model.doc.getStore(),
|
|
hash = ve.getHash( this.model );
|
|
store.index( domElements, hash );
|
|
// TODO: remove 'generating' style
|
|
this.onUpdate();
|
|
};
|
|
|
|
/**
|
|
* Called when the has failed to generate new content.
|
|
* @method
|
|
*/
|
|
ve.ce.GeneratedContentNode.prototype.failGenerating = function () {
|
|
// TODO: remove 'generating' style
|
|
};
|
|
|
|
/* Registration */
|
|
|
|
ve.ce.nodeFactory.register( ve.ce.GeneratedContentNode );
|