mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-11-05 22:22:54 +00:00
2fb1a11a1a
Follows-up I99acbd1699:
* "Parent method" comment
* Remove redundant slice() call to convert arguments to array,
native JavaScript methods that take array-like arguments such
as Function#apply and Array#slice are both compatible with
the Arguments objects, no need to convert it. Most invocations
already did this right but a few were recently introduced again.
* Removed silly "Document dialog." descriptions.
* Removed a few redundant "@method" tags in the near vicinity
of code I changed.
* Fixed function invocation to be either on one line or
one parameter per line. Having all arguments on one line
but the name + "(" looks confusing as it suggest there
is only 1 parameter. Same as object literals:
so:
{ foo: 1, bar }
or:
{
foo: 1,
bar: 2,
}
not:
{
foo: 1, bar: 2
}
Change-Id: I379bc2b32603bcf90aba9b4cd0112e7f027d070e
153 lines
3.8 KiB
JavaScript
153 lines
3.8 KiB
JavaScript
/*!
|
|
* VisualEditor UserInterface Dialog class.
|
|
*
|
|
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
/**
|
|
* UserInterface dialog.
|
|
*
|
|
* @class
|
|
* @abstract
|
|
* @extends ve.ui.Window
|
|
*
|
|
* @constructor
|
|
* @param {ve.ui.Surface} surface
|
|
* @param {Object} [config] Config options
|
|
*/
|
|
ve.ui.Dialog = function VeUiDialog( surface, config ) {
|
|
// Parent constructor
|
|
ve.ui.Window.call( this, surface, config );
|
|
|
|
// Properties
|
|
this.visible = false;
|
|
this.onWindowMouseWheelHandler = ve.bind( this.onWindowMouseWheel, this );
|
|
this.onDocumentKeyDownHandler = ve.bind( this.onDocumentKeyDown, this );
|
|
|
|
// Initialization
|
|
this.$.addClass( 've-ui-dialog' );
|
|
this.$.on( 'mousedown', false );
|
|
};
|
|
|
|
/* Inheritance */
|
|
|
|
ve.inheritClass( ve.ui.Dialog, ve.ui.Window );
|
|
|
|
/* Methods */
|
|
|
|
/**
|
|
* Handle close button click events.
|
|
*
|
|
* @method
|
|
*/
|
|
ve.ui.Dialog.prototype.onCloseButtonClick = function () {
|
|
this.close( 'cancel' );
|
|
};
|
|
|
|
/**
|
|
* Handle apply button click events.
|
|
*
|
|
* @method
|
|
*/
|
|
ve.ui.Dialog.prototype.onApplyButtonClick = function () {
|
|
this.close( 'apply' );
|
|
};
|
|
|
|
/**
|
|
* Handle window mouse wheel events.
|
|
*
|
|
* @method
|
|
* @param {jQuery.Event} e Mouse wheel event
|
|
*/
|
|
ve.ui.Dialog.prototype.onWindowMouseWheel = function () {
|
|
return false;
|
|
};
|
|
|
|
/**
|
|
* Handle document key down events.
|
|
*
|
|
* @method
|
|
* @param {jQuery.Event} e Key down event
|
|
*/
|
|
ve.ui.Dialog.prototype.onDocumentKeyDown = function ( e ) {
|
|
switch ( e.which ) {
|
|
case ve.Keys.PAGEUP:
|
|
case ve.Keys.PAGEDOWN:
|
|
case ve.Keys.END:
|
|
case ve.Keys.HOME:
|
|
case ve.Keys.LEFT:
|
|
case ve.Keys.UP:
|
|
case ve.Keys.RIGHT:
|
|
case ve.Keys.DOWN:
|
|
// Prevent any key events that might cause scrolling
|
|
return false;
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Open window.
|
|
*
|
|
* Wraps the parent open method. Disables native top-level window scrolling behavior.
|
|
*
|
|
* @method
|
|
* @emits setup
|
|
* @emits open
|
|
*/
|
|
ve.ui.Dialog.prototype.open = function () {
|
|
ve.ui.Window.prototype.open.call( this );
|
|
// Prevent scrolling in top-level window
|
|
$( window ).on( 'mousewheel', this.onWindowMouseWheelHandler );
|
|
$( document ).on( 'keydown', this.onDocumentKeyDownHandler );
|
|
};
|
|
|
|
/**
|
|
* Close dialog.
|
|
*
|
|
* Wraps the parent close method. Allows animation by delaying parent close call, while still
|
|
* providing the same recursion blocking. Restores native top-level window scrolling behavior.
|
|
*
|
|
* @method
|
|
* @param {boolean} action Action that caused the window to be closed
|
|
* @emits close
|
|
*/
|
|
ve.ui.Dialog.prototype.close = function ( action ) {
|
|
if ( !this.closing ) {
|
|
this.$.addClass( 've-ui-dialog-closing' );
|
|
setTimeout( ve.bind( function () {
|
|
ve.ui.Window.prototype.close.call( this, action );
|
|
this.$.removeClass( 've-ui-dialog-closing' );
|
|
}, this ), 250 );
|
|
// Allow scrolling in top-level window
|
|
$( window ).off( 'mousewheel', this.onWindowMouseWheelHandler );
|
|
$( document ).off( 'keydown', this.onDocumentKeyDownHandler );
|
|
}
|
|
};
|
|
|
|
ve.ui.Dialog.prototype.initialize = function () {
|
|
// Parent method
|
|
ve.ui.Window.prototype.initialize.call( this );
|
|
|
|
// Properties
|
|
this.applyButton = new ve.ui.ButtonWidget( {
|
|
'$$': this.$$, 'label': ve.msg( 'visualeditor-dialog-action-apply' ), 'flags': ['primary']
|
|
} );
|
|
this.closeButton = new ve.ui.IconButtonWidget( {
|
|
'$$': this.$$, 'title': ve.msg( 'visualeditor-dialog-action-close' ), 'icon': 'close'
|
|
} );
|
|
|
|
// Events
|
|
this.closeButton.connect( this, { 'click': 'onCloseButtonClick' } );
|
|
this.applyButton.connect( this, { 'click': 'onApplyButtonClick' } );
|
|
|
|
// Initialization
|
|
this.closeButton.$.addClass( 've-ui-window-closeButton' );
|
|
this.applyButton.$.addClass( 've-ui-window-applyButton' );
|
|
this.$head.append( this.closeButton.$ );
|
|
this.$foot.append( this.applyButton.$ );
|
|
};
|
|
|
|
/* Initialization */
|
|
|
|
ve.ui.Dialog.static.addLocalStylesheets( [ 've.ui.Dialog.css' ] );
|