mediawiki-extensions-Visual.../modules/ve-mw/ui/inspectors/ve.ui.MWExtensionInspector.js
Ed Sanders 9beb92a102 Delete extensions nodes which have been made empty
If they have allowedEmpty=false.

Also remove unnecessary instanceof check.

Change-Id: I388202c9da5673534486b1d9d345296feeec53c3
2014-04-25 16:13:31 -07:00

168 lines
4 KiB
JavaScript

/*!
* VisualEditor UserInterface MWExtensionInspector class.
*
* @copyright 2011-2014 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* MediaWiki extension inspector.
*
* @class
* @abstract
* @extends ve.ui.Inspector
*
* @constructor
* @param {Object} [config] Configuration options
*/
ve.ui.MWExtensionInspector = function VeUiMWExtensionInspector( config ) {
// Parent constructor
ve.ui.Inspector.call( this, config );
};
/* Inheritance */
OO.inheritClass( ve.ui.MWExtensionInspector, ve.ui.Inspector );
/* Static properties */
ve.ui.MWExtensionInspector.static.placeholder = null;
ve.ui.MWExtensionInspector.static.nodeModel = null;
ve.ui.MWExtensionInspector.static.removable = false;
/**
* Extension is allowed to have empty contents
*
* @static
* @property {boolean}
* @inheritable
*/
ve.ui.MWExtensionInspector.static.allowedEmpty = false;
/**
* Inspector's directionality, 'ltr' or 'rtl'
*
* Leave as null to use the directionality of the current fragment.
*
* @static
* @property {string|null}
* @inheritable
*/
ve.ui.MWExtensionInspector.static.dir = null;
/* Methods */
/**
* Handle frame ready events.
*
* @method
*/
ve.ui.MWExtensionInspector.prototype.initialize = function () {
// Parent method
ve.ui.Inspector.prototype.initialize.call( this );
this.input = new OO.ui.TextInputWidget( {
'$': this.$,
'multiline': true
} );
this.input.$element.addClass( 've-ui-mwExtensionInspector-input' );
// Initialization
this.$form.append( this.input.$element );
};
/**
* Get the placeholder text for the content input area.
*
* @returns {string} Placeholder text
*/
ve.ui.MWExtensionInspector.prototype.getInputPlaceholder = function () {
return '';
};
/**
* @inheritdoc
*/
ve.ui.MWExtensionInspector.prototype.setup = function ( data ) {
// Parent method
ve.ui.Inspector.prototype.setup.call( this, data );
// Initialization
this.node = this.getFragment().getSelectedNode();
// Make sure we're inspecting the right type of node
if ( !( this.node instanceof this.constructor.static.nodeModel ) ) {
this.node = null;
}
this.input.setValue( this.node ? this.node.getAttribute( 'mw' ).body.extsrc : '' );
this.input.$input.attr( 'placeholder', this.getInputPlaceholder() );
var dir = this.constructor.static.dir || data.dir;
this.input.setRTL( dir === 'rtl' );
};
/**
* @inheritdoc
*/
ve.ui.MWExtensionInspector.prototype.ready = function () {
// Parent method
ve.ui.Inspector.prototype.ready.call( this );
// Focus the input
this.input.$input.focus().select();
};
/**
* @inheritdoc
*/
ve.ui.MWExtensionInspector.prototype.teardown = function ( data ) {
var mwData,
surfaceModel = this.getFragment().getSurface();
if ( this.constructor.static.allowedEmpty || this.input.getValue() !== '' ) {
if ( this.node ) {
mwData = ve.copy( this.node.getAttribute( 'mw' ) );
this.updateMwData( mwData );
surfaceModel.change(
ve.dm.Transaction.newFromAttributeChanges(
surfaceModel.getDocument(), this.node.getOuterRange().start, { 'mw': mwData }
)
);
} else {
mwData = {
'name': this.constructor.static.nodeModel.static.extensionName,
'attrs': {},
'body': {}
};
this.updateMwData( mwData );
surfaceModel.getFragment().collapseRangeToEnd().insertContent( [
{
'type': this.constructor.static.nodeModel.static.name,
'attributes': {
'mw': mwData
}
},
{ 'type': '/' + this.constructor.static.nodeModel.static.name }
] );
}
} else if ( this.node && !this.constructor.static.allowedEmpty ) {
// Content has been emptied on a node which isn't allowed to
// be empty, so delete it.
surfaceModel.getFragment().removeContent();
}
// Parent method
ve.ui.Inspector.prototype.teardown.call( this, data );
};
/**
* Update mwData object with the new values from the inspector
*
* @param {Object} mwData MediaWiki data object
*/
ve.ui.MWExtensionInspector.prototype.updateMwData = function ( mwData ) {
mwData.body.extsrc = this.input.getValue();
};