wikimedia/mediawiki-extensions-VisualEditor
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor synced 2024-11-12 09:09:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update actions on live inspectors and preview dialogs

Browse source 
Make inspectors inheriting from MWLiveExtensionInspector
and dialogs inheriting from MWExtensionPreviewDialog
update their 'done' action every time updatePreview is
called. Since both mix in ExtensionWindow, two new methods,
updateActions and isModified are added there.

This should make it more difficult to insert an empty node
accidentally or create a transaction just by opening and
closing an inspector or dialog.

For more complicated dialogs, or inspectors or dialogs
that don't live-update, this behaviour will have to be
implemented separately.

Bug: T155330
Change-Id: Iacafa01fcd419faaec9b112c96be86693a57d561
This commit is contained in:
Thalia 2017-01-14 15:03:36 -08:00
parent 171286c120
commit 43c2865f90
3 changed files with 61 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
modules/ve-mw/ui/dialogs/ve.ui.MWExtensionPreviewDialog.js
View file

@ -19,8 +19,7 @@ ve.ui.MWExtensionPreviewDialog = function VeUiMWExtensionPreviewDialog() {
// Parent constructor
ve.ui.MWExtensionPreviewDialog.super.apply( this, arguments );
// Late bind onChangeHandler to a debounced updatePreview
this.onChangeHandler = ve.debounce( this.updatePreview.bind( this ), 250 );
this.updatePreviewDebounced = ve.debounce( this.updatePreview.bind( this ), 250 );
};
/* Inheritance */
@ -72,6 +71,16 @@ ve.ui.MWExtensionPreviewDialog.prototype.getSetupProcess = function ( data ) {
}, this );
};
/**
* @inheritdoc
*/
ve.ui.MWExtensionPreviewDialog.prototype.onChange = function () {
// Parent method
ve.ui.MWExtensionPreviewDialog.super.prototype.onChange.call( this );
this.updatePreviewDebounced();
};
/**
* Update the node rendering to reflect the current content in the dialog.
*/

13
modules/ve-mw/ui/inspectors/ve.ui.MWLiveExtensionInspector.js
View file

@ -19,8 +19,7 @@ ve.ui.MWLiveExtensionInspector = function VeUiMWLiveExtensionInspector() {
// Parent constructor
ve.ui.MWLiveExtensionInspector.super.apply( this, arguments );
// Late bind onChangeHandler to a debounced updatePreview
this.onChangeHandler = ve.debounce( this.updatePreview.bind( this ), 250 );
this.updatePreviewDebounced = ve.debounce( this.updatePreview.bind( this ), 250 );
};
/* Inheritance */
@ -113,6 +112,16 @@ ve.ui.MWLiveExtensionInspector.prototype.removeNode = function () {
ve.ui.MWLiveExtensionInspector.super.prototype.removeNode.call( this );
};
/**
* @inheritdoc
*/
ve.ui.MWLiveExtensionInspector.prototype.onChange = function () {
// Parent method
ve.ui.MWLiveExtensionInspector.super.prototype.onChange.call( this );
this.updatePreviewDebounced();
};
/**
* Update the node rendering to reflect the current content in the inspector.
*/

39
modules/ve-mw/ui/ve.ui.MWExtensionWindow.js
View file

@ -17,6 +17,9 @@
ve.ui.MWExtensionWindow = function VeUiMWExtensionWindow() {
this.whitespace = null;
this.input = null;
this.originalMwData = null;
this.onChangeHandler = ve.debounce( this.onChange.bind( this ), 0 );
};
/* Inheritance */
@ -80,6 +83,7 @@ ve.ui.MWExtensionWindow.prototype.getSetupProcess = function ( data, process ) {
if ( this.selectedNode ) {
this.input.setValueAndWhitespace( this.selectedNode.getAttribute( 'mw' ).body.extsrc );
this.originalMwData = this.selectedNode.getAttribute( 'mw' );
} else {
if ( !this.constructor.static.modelClasses[ 0 ].static.isContent ) {
// New nodes should use linebreaks for blocks
@ -92,6 +96,9 @@ ve.ui.MWExtensionWindow.prototype.getSetupProcess = function ( data, process ) {
dir = this.constructor.static.dir || data.dir;
this.input.setDir( dir );
this.actions.setAbilities( { done: false } );
this.input.connect( this, { change: 'onChangeHandler' } );
}, this );
};
@ -126,6 +133,38 @@ ve.ui.MWExtensionWindow.prototype.getActionProcess = function ( action, process
}, this );
};
/**
* Handle change event.
*/
ve.ui.MWExtensionWindow.prototype.onChange = function () {
this.updateActions();
};
/**
* Update the 'done' action according to whether there are changes
*/
ve.ui.MWExtensionWindow.prototype.updateActions = function () {
this.actions.setAbilities( { done: this.isModified() } );
};
/**
* Check if mwData would be modified if window contents were applied
*
* @return {boolean} mwData would be modified
*/
ve.ui.MWExtensionWindow.prototype.isModified = function () {
var mwDataCopy, modified;
if ( this.originalMwData ) {
mwDataCopy = ve.copy( this.originalMwData );
this.updateMwData( mwDataCopy );
modified = !ve.compare( this.originalMwData, mwDataCopy );
} else {
modified = true;
}
return modified;
};
/**
* Create an new data element for the model class associated with this inspector
*