mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-09-27 20:26:46 +00:00
104 lines
2.5 KiB
JavaScript
104 lines
2.5 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
|
|
* @param {Object} [config] Config options
|
|
*/
|
|
ve.ce.GeneratedContentNode = function VeCeGeneratedContentNode( model, config ) {
|
|
// Parent constructor
|
|
ve.ce.LeafNode.call( this, model, config );
|
|
|
|
// 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.emit( 'teardown' );
|
|
this.$.empty().append( store.value( index ) );
|
|
this.emit( 'setup' );
|
|
} 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 );
|