mediawiki-extensions-Visual.../modules/ve-mw/ui/inspectors/ve.ui.MWLiveExtensionInspector.js
James D. Forrester fbdff76263 Update VE core submodule to master (f2277ea)
New changes:
56de6f5 Localisation updates from https://translatewiki.net.
f8bda64 Widgetise demo menu
6ac48d8 Localisation updates from https://translatewiki.net.
365e131 builderloader: Omit value for boolean "disabled" attribute per HTML5
706e4b3 Prevent double counting of DM nodes in getNodeAndOffset
b141a7d Update OOjs UI to v0.1.0-pre (d2451ac748)
c5b3921 Localisation updates from https://translatewiki.net.
1606983 Update reference to ConfirmationDialog to use MessageDialog

Deletions:
* Styles for ve.ui.MWBetaWelcomeDialog - not needed anymore because
  OO.ui.MessageDialog provides them
* Styles for ve.ui.MWGalleryInspector - not needed anymore because
  ve.ui.MWExtensionInspector provides part of them and the rest are being
  replaced by programatic sizing

Modifications:
* ve.ui.MWLinkTargetInputWidget - Added support for validation and href
  getter
* Split message between tool and dialog title for ve.ui.MWEditModeTool
  and ve.ui.MWWikitextSwitchConfirmDialog

General changes:
* Updated inheritance.
* Added manager param to constructors of dialogs and inspectors.
* Updated use of show/hide with toggle.
* Added meaningful descriptions of dialog and inspector classes.
* Configured dialog and inspector sizes statically.
* Configured dialog action buttons statically.
* Interfaced with OO.ui.ActionSet to control action buttons.
* Moved applyChanges code into getActionProcess methods.
* Always using .next in setup/ready process getters and .first in
  hold/teardown process getters.

Change-Id: Ia74732e6e32c0808eee021f0a26225b9e6c3f971
2014-07-14 23:24:45 +00:00

111 lines
3.1 KiB
JavaScript

/*!
* 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 {OO.ui.WindowManager} manager Manager of window
* @param {Object} [config] Configuration options
*/
ve.ui.MWLiveExtensionInspector = function VeUiMWLiveExtensionInspector( manager, config ) {
// Parent constructor
ve.ui.MWExtensionInspector.call( this, manager, config );
// Late bind onChangeHanlder 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.getTeardownProcess = function ( data ) {
return ve.ui.MWLiveExtensionInspector.super.prototype.getTeardownProcess.call( this, data )
.first( function () {
this.input.off( 'change', this.onChangeHandler );
this.getFragment().getSurface().applyStaging();
}, 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 } );
}
};