mediawiki-extensions-Visual.../modules/ve/ce/nodes/ve.ce.GeneratedContentNode.js
Ed Sanders 6ad61d4ddb Add data model support for MediaWiki references
So far just read-only.

Bug: 39599
Change-Id: I6daff5c5969e5fdc871f8f346cf790b4302ae080
2013-04-23 10:17:42 +01:00

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.addListenerMethod( 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.$.html( 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 {string} contents Generated content
*/
ve.ce.GeneratedContentNode.prototype.doneGenerating = function ( contents ) {
var store = this.model.doc.getStore(),
hash = ve.getHash( this.model );
store.index( contents, 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 );