/*! * ObjectOriented UserInterface Dialog class. * * @copyright 2011-2013 OOJS Team and others; see AUTHORS.txt * @license The MIT License (MIT); see LICENSE.txt */ /** * Modal dialog box. * * @class * @abstract * @extends OO.ui.Window * * @constructor * @param {OO.ui.WindowSet} windowSet Window set this dialog is part of * @param {Object} [config] Configuration options * @cfg {boolean} [footless] Hide foot * @cfg {boolean} [small] Make the dialog small */ OO.ui.Dialog = function OoUiDialog( windowSet, config ) { // Configuration initialization config = config || {}; // Parent constructor OO.ui.Window.call( this, windowSet, config ); // Properties this.visible = false; this.footless = !!config.footless; this.small = !!config.small; this.onWindowMouseWheelHandler = OO.ui.bind( this.onWindowMouseWheel, this ); this.onDocumentKeyDownHandler = OO.ui.bind( this.onDocumentKeyDown, this ); // Events this.$.on( 'mousedown', false ); // Initialization this.$.addClass( 'oo-ui-dialog' ); }; /* Inheritance */ OO.inheritClass( OO.ui.Dialog, OO.ui.Window ); /* Static Properties */ /** * Symbolic name of dialog. * * @abstract * @static * @property {string} * @inheritable */ OO.ui.Dialog.static.name = ''; /* Methods */ /** * Handle close button click events. * * @method */ OO.ui.Dialog.prototype.onCloseButtonClick = function () { this.close( 'cancel' ); }; /** * Handle window mouse wheel events. * * @method * @param {jQuery.Event} e Mouse wheel event */ OO.ui.Dialog.prototype.onWindowMouseWheel = function () { return false; }; /** * Handle document key down events. * * @method * @param {jQuery.Event} e Key down event */ OO.ui.Dialog.prototype.onDocumentKeyDown = function ( e ) { switch ( e.which ) { case OO.ui.Keys.PAGEUP: case OO.ui.Keys.PAGEDOWN: case OO.ui.Keys.END: case OO.ui.Keys.HOME: case OO.ui.Keys.LEFT: case OO.ui.Keys.UP: case OO.ui.Keys.RIGHT: case OO.ui.Keys.DOWN: // Prevent any key events that might cause scrolling return false; } }; /** * Handle frame document key down events. * * @method * @param {jQuery.Event} e Key down event */ OO.ui.Dialog.prototype.onFrameDocumentKeyDown = function ( e ) { if ( e.which === OO.ui.Keys.ESCAPE ) { this.close( 'cancel' ); return false; } }; /** * Open window. * * Wraps the parent open method. Disables native top-level window scrolling behavior. * * @method * @param {Object} [config] Configuration options for window setup * @fires setup * @fires open */ OO.ui.Dialog.prototype.open = function ( config ) { OO.ui.Window.prototype.open.call( this, config ); // 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 * @fires close */ OO.ui.Dialog.prototype.close = function ( action ) { if ( !this.closing ) { this.$.addClass( 'oo-ui-dialog-closing' ); setTimeout( OO.ui.bind( function () { OO.ui.Window.prototype.close.call( this, action ); this.$.removeClass( 'oo-ui-dialog-closing' ); }, this ), 250 ); // Allow scrolling in top-level window $( window ).off( 'mousewheel', this.onWindowMouseWheelHandler ); $( document ).off( 'keydown', this.onDocumentKeyDownHandler ); } }; /** */ OO.ui.Dialog.prototype.initialize = function () { // Parent method OO.ui.Window.prototype.initialize.call( this ); // Properties this.closeButton = new OO.ui.IconButtonWidget( { '$$': this.$$, 'title': OO.ui.msg( 'ooui-dialog-action-close' ), 'icon': 'close' } ); // Events this.closeButton.connect( this, { 'click': 'onCloseButtonClick' } ); this.frame.$document.on( 'keydown', OO.ui.bind( this.onFrameDocumentKeyDown, this ) ); // Initialization this.frame.$content.addClass( 'oo-ui-dialog-content' ); if ( this.footless ) { this.frame.$content.addClass( 'oo-ui-dialog-content-footless' ); } if ( this.small ) { this.$frame.addClass( 'oo-ui-window-frame-small' ); } this.closeButton.$.addClass( 'oo-ui-window-closeButton' ); this.$head.append( this.closeButton.$ ); };