mediawiki-extensions-VisualEditor/modules/ve-mw/ui/inspectors/ve.ui.MWLiveExtensionInspector.js

/*!
 * VisualEditor UserInterface MWLiveExtensionInspector class.
 *
 * @copyright 2011-2014 VisualEditor Team and others; see AUTHORS.txt
 * @license The MIT License (MIT); see LICENSE.txt
 */

/**
 * Inspector for editing generic MediaWiki extensions with dynamic rendering.
 *
 * @class
 * @abstract
 * @extends ve.ui.MWExtensionInspector
 *
 * @constructor
 * @param {Object} [config] Configuration options
 */
ve.ui.MWLiveExtensionInspector = function VeUiMWLiveExtensionInspector( config ) {
	// Parent constructor
	ve.ui.MWExtensionInspector.call( this, config );

	// Late bind onChangeHandler to a debounced updatePreview
	this.onChangeHandler = ve.debounce( this.updatePreview.bind( this ), 250 );
};

/* Inheritance */

OO.inheritClass( ve.ui.MWLiveExtensionInspector, ve.ui.MWExtensionInspector );

/* Static properties */

/**
 * Name of extension in the mw data, if different from inspector name
 *
 * @static
 * @property {string}
 * @inheritable
 */
ve.ui.MWLiveExtensionInspector.static.mwName = null;

/* Methods */

/**
 * Create an MW data object for a new node
 * @returns {Object} MW data
 */
ve.ui.MWLiveExtensionInspector.prototype.getNewMwData = function () {
	return {
		name: this.constructor.static.mwName || this.constructor.static.name,
		attrs: {},
		body: {
			extsrc: ''
		}
	};
};

/**
 * @inheritdoc
 */
ve.ui.MWLiveExtensionInspector.prototype.getSetupProcess = function ( data ) {
	return ve.ui.MWLiveExtensionInspector.super.prototype.getSetupProcess.call( this, data )
		.next( function () {
			// Initialization
			this.getFragment().getSurface().pushStaging();

			if ( !this.node ) {
				// Create a new node
				// collapseRangeToEnd returns a new fragment
				this.fragment = this.getFragment().collapseRangeToEnd().insertContent( [
					{
						type: this.constructor.static.nodeModel.static.name,
						attributes: { mw: this.getNewMwData() }
					},
					{ type: '/' + this.constructor.static.nodeModel.static.name }
				] );
				// Check if the node was inserted at a structural offset and wrapped in a paragraph
				if ( this.getFragment().getRange().getLength() === 4 ) {
					this.fragment = this.getFragment().adjustRange( 1, -1 );
				}
				this.getFragment().select();
				this.node = this.getFragment().getSelectedNode();
			}
			this.input.on( 'change', this.onChangeHandler );
		}, this );
};

/**
 * @inheritdoc
 */
ve.ui.MWLiveExtensionInspector.prototype.insertOrUpdateNode = function () {
	// No need to call parent method as changes have already been made
	// to the model in staging, just need to apply them.
	this.input.off( 'change', this.onChangeHandler );
	this.getFragment().getSurface().applyStaging();
};

/**
 * @inheritdoc
 */
ve.ui.MWLiveExtensionInspector.prototype.removeNode = function () {
	this.getFragment().getSurface().popStaging();
	ve.ui.MWLiveExtensionInspector.super.prototype.removeNode.call( this );
};

/**
 * Update the node rendering to reflect the current content in the inspector.
 */
ve.ui.MWLiveExtensionInspector.prototype.updatePreview = function () {
	var mwData = ve.copy( this.node.getAttribute( 'mw' ) );

	mwData.body.extsrc = this.input.getValue();

	if ( this.visible ) {
		this.getFragment().changeAttributes( { mw: mwData } );
	}
};