Merge "Use {{int:}} on MediaWiki:Blockedtext and MediaWiki:Autoblockedtext"
[lhc/web/wiklou.git] / resources / lib / oojs-ui / oojs-ui-windows.js
1 /*!
2 * OOUI v0.27.0
3 * https://www.mediawiki.org/wiki/OOUI
4 *
5 * Copyright 2011–2018 OOUI Team and other contributors.
6 * Released under the MIT license
7 * http://oojs.mit-license.org
8 *
9 * Date: 2018-05-09T00:44:45Z
10 */
11 ( function ( OO ) {
12
13 'use strict';
14
15 /**
16 * An ActionWidget is a {@link OO.ui.ButtonWidget button widget} that executes an action.
17 * Action widgets are used with OO.ui.ActionSet, which manages the behavior and availability
18 * of the actions.
19 *
20 * Both actions and action sets are primarily used with {@link OO.ui.Dialog Dialogs}.
21 * Please see the [OOUI documentation on MediaWiki] [1] for more information
22 * and examples.
23 *
24 * [1]: https://www.mediawiki.org/wiki/OOUI/Windows/Process_Dialogs#Action_sets
25 *
26 * @class
27 * @extends OO.ui.ButtonWidget
28 * @mixins OO.ui.mixin.PendingElement
29 *
30 * @constructor
31 * @param {Object} [config] Configuration options
32 * @cfg {string} [action] Symbolic name of the action (e.g., ‘continue’ or ‘cancel’).
33 * @cfg {string[]} [modes] Symbolic names of the modes (e.g., ‘edit’ or ‘read’) in which the action
34 * should be made available. See the action set's {@link OO.ui.ActionSet#setMode setMode} method
35 * for more information about setting modes.
36 * @cfg {boolean} [framed=false] Render the action button with a frame
37 */
38 OO.ui.ActionWidget = function OoUiActionWidget( config ) {
39 // Configuration initialization
40 config = $.extend( { framed: false }, config );
41
42 // Parent constructor
43 OO.ui.ActionWidget.parent.call( this, config );
44
45 // Mixin constructors
46 OO.ui.mixin.PendingElement.call( this, config );
47
48 // Properties
49 this.action = config.action || '';
50 this.modes = config.modes || [];
51 this.width = 0;
52 this.height = 0;
53
54 // Initialization
55 this.$element.addClass( 'oo-ui-actionWidget' );
56 };
57
58 /* Setup */
59
60 OO.inheritClass( OO.ui.ActionWidget, OO.ui.ButtonWidget );
61 OO.mixinClass( OO.ui.ActionWidget, OO.ui.mixin.PendingElement );
62
63 /* Methods */
64
65 /**
66 * Check if the action is configured to be available in the specified `mode`.
67 *
68 * @param {string} mode Name of mode
69 * @return {boolean} The action is configured with the mode
70 */
71 OO.ui.ActionWidget.prototype.hasMode = function ( mode ) {
72 return this.modes.indexOf( mode ) !== -1;
73 };
74
75 /**
76 * Get the symbolic name of the action (e.g., ‘continue’ or ‘cancel’).
77 *
78 * @return {string}
79 */
80 OO.ui.ActionWidget.prototype.getAction = function () {
81 return this.action;
82 };
83
84 /**
85 * Get the symbolic name of the mode or modes for which the action is configured to be available.
86 *
87 * The current mode is set with the action set's {@link OO.ui.ActionSet#setMode setMode} method.
88 * Only actions that are configured to be avaiable in the current mode will be visible. All other actions
89 * are hidden.
90 *
91 * @return {string[]}
92 */
93 OO.ui.ActionWidget.prototype.getModes = function () {
94 return this.modes.slice();
95 };
96
97 /* eslint-disable no-unused-vars */
98 /**
99 * ActionSets manage the behavior of the {@link OO.ui.ActionWidget action widgets} that comprise them.
100 * Actions can be made available for specific contexts (modes) and circumstances
101 * (abilities). Action sets are primarily used with {@link OO.ui.Dialog Dialogs}.
102 *
103 * ActionSets contain two types of actions:
104 *
105 * - Special: Special actions are the first visible actions with special flags, such as 'safe' and 'primary', the default special flags. Additional special flags can be configured in subclasses with the static #specialFlags property.
106 * - Other: Other actions include all non-special visible actions.
107 *
108 * See the [OOUI documentation on MediaWiki][1] for more information.
109 *
110 * @example
111 * // Example: An action set used in a process dialog
112 * function MyProcessDialog( config ) {
113 * MyProcessDialog.parent.call( this, config );
114 * }
115 * OO.inheritClass( MyProcessDialog, OO.ui.ProcessDialog );
116 * MyProcessDialog.static.title = 'An action set in a process dialog';
117 * MyProcessDialog.static.name = 'myProcessDialog';
118 * // An action set that uses modes ('edit' and 'help' mode, in this example).
119 * MyProcessDialog.static.actions = [
120 * { action: 'continue', modes: 'edit', label: 'Continue', flags: [ 'primary', 'progressive' ] },
121 * { action: 'help', modes: 'edit', label: 'Help' },
122 * { modes: 'edit', label: 'Cancel', flags: 'safe' },
123 * { action: 'back', modes: 'help', label: 'Back', flags: 'safe' }
124 * ];
125 *
126 * MyProcessDialog.prototype.initialize = function () {
127 * MyProcessDialog.parent.prototype.initialize.apply( this, arguments );
128 * this.panel1 = new OO.ui.PanelLayout( { padded: true, expanded: false } );
129 * this.panel1.$element.append( '<p>This dialog uses an action set (continue, help, cancel, back) configured with modes. This is edit mode. Click \'help\' to see help mode.</p>' );
130 * this.panel2 = new OO.ui.PanelLayout( { padded: true, expanded: false } );
131 * this.panel2.$element.append( '<p>This is help mode. Only the \'back\' action widget is configured to be visible here. Click \'back\' to return to \'edit\' mode.</p>' );
132 * this.stackLayout = new OO.ui.StackLayout( {
133 * items: [ this.panel1, this.panel2 ]
134 * } );
135 * this.$body.append( this.stackLayout.$element );
136 * };
137 * MyProcessDialog.prototype.getSetupProcess = function ( data ) {
138 * return MyProcessDialog.parent.prototype.getSetupProcess.call( this, data )
139 * .next( function () {
140 * this.actions.setMode( 'edit' );
141 * }, this );
142 * };
143 * MyProcessDialog.prototype.getActionProcess = function ( action ) {
144 * if ( action === 'help' ) {
145 * this.actions.setMode( 'help' );
146 * this.stackLayout.setItem( this.panel2 );
147 * } else if ( action === 'back' ) {
148 * this.actions.setMode( 'edit' );
149 * this.stackLayout.setItem( this.panel1 );
150 * } else if ( action === 'continue' ) {
151 * var dialog = this;
152 * return new OO.ui.Process( function () {
153 * dialog.close();
154 * } );
155 * }
156 * return MyProcessDialog.parent.prototype.getActionProcess.call( this, action );
157 * };
158 * MyProcessDialog.prototype.getBodyHeight = function () {
159 * return this.panel1.$element.outerHeight( true );
160 * };
161 * var windowManager = new OO.ui.WindowManager();
162 * $( 'body' ).append( windowManager.$element );
163 * var dialog = new MyProcessDialog( {
164 * size: 'medium'
165 * } );
166 * windowManager.addWindows( [ dialog ] );
167 * windowManager.openWindow( dialog );
168 *
169 * [1]: https://www.mediawiki.org/wiki/OOUI/Windows/Process_Dialogs#Action_sets
170 *
171 * @abstract
172 * @class
173 * @mixins OO.EventEmitter
174 *
175 * @constructor
176 * @param {Object} [config] Configuration options
177 */
178 OO.ui.ActionSet = function OoUiActionSet( config ) {
179 // Configuration initialization
180 config = config || {};
181
182 // Mixin constructors
183 OO.EventEmitter.call( this );
184
185 // Properties
186 this.list = [];
187 this.categories = {
188 actions: 'getAction',
189 flags: 'getFlags',
190 modes: 'getModes'
191 };
192 this.categorized = {};
193 this.special = {};
194 this.others = [];
195 this.organized = false;
196 this.changing = false;
197 this.changed = false;
198 };
199 /* eslint-enable no-unused-vars */
200
201 /* Setup */
202
203 OO.mixinClass( OO.ui.ActionSet, OO.EventEmitter );
204
205 /* Static Properties */
206
207 /**
208 * Symbolic name of the flags used to identify special actions. Special actions are displayed in the
209 * header of a {@link OO.ui.ProcessDialog process dialog}.
210 * See the [OOUI documentation on MediaWiki][2] for more information and examples.
211 *
212 * [2]:https://www.mediawiki.org/wiki/OOUI/Windows/Process_Dialogs
213 *
214 * @abstract
215 * @static
216 * @inheritable
217 * @property {string}
218 */
219 OO.ui.ActionSet.static.specialFlags = [ 'safe', 'primary' ];
220
221 /* Events */
222
223 /**
224 * @event click
225 *
226 * A 'click' event is emitted when an action is clicked.
227 *
228 * @param {OO.ui.ActionWidget} action Action that was clicked
229 */
230
231 /**
232 * @event add
233 *
234 * An 'add' event is emitted when actions are {@link #method-add added} to the action set.
235 *
236 * @param {OO.ui.ActionWidget[]} added Actions added
237 */
238
239 /**
240 * @event remove
241 *
242 * A 'remove' event is emitted when actions are {@link #method-remove removed}
243 * or {@link #clear cleared}.
244 *
245 * @param {OO.ui.ActionWidget[]} added Actions removed
246 */
247
248 /**
249 * @event change
250 *
251 * A 'change' event is emitted when actions are {@link #method-add added}, {@link #clear cleared},
252 * or {@link #method-remove removed} from the action set or when the {@link #setMode mode} is changed.
253 *
254 */
255
256 /* Methods */
257
258 /**
259 * Handle action change events.
260 *
261 * @private
262 * @fires change
263 */
264 OO.ui.ActionSet.prototype.onActionChange = function () {
265 this.organized = false;
266 if ( this.changing ) {
267 this.changed = true;
268 } else {
269 this.emit( 'change' );
270 }
271 };
272
273 /**
274 * Check if an action is one of the special actions.
275 *
276 * @param {OO.ui.ActionWidget} action Action to check
277 * @return {boolean} Action is special
278 */
279 OO.ui.ActionSet.prototype.isSpecial = function ( action ) {
280 var flag;
281
282 for ( flag in this.special ) {
283 if ( action === this.special[ flag ] ) {
284 return true;
285 }
286 }
287
288 return false;
289 };
290
291 /**
292 * Get action widgets based on the specified filter: ‘actions’, ‘flags’, ‘modes’, ‘visible’,
293 * or ‘disabled’.
294 *
295 * @param {Object} [filters] Filters to use, omit to get all actions
296 * @param {string|string[]} [filters.actions] Actions that action widgets must have
297 * @param {string|string[]} [filters.flags] Flags that action widgets must have (e.g., 'safe')
298 * @param {string|string[]} [filters.modes] Modes that action widgets must have
299 * @param {boolean} [filters.visible] Action widgets must be visible
300 * @param {boolean} [filters.disabled] Action widgets must be disabled
301 * @return {OO.ui.ActionWidget[]} Action widgets matching all criteria
302 */
303 OO.ui.ActionSet.prototype.get = function ( filters ) {
304 var i, len, list, category, actions, index, match, matches;
305
306 if ( filters ) {
307 this.organize();
308
309 // Collect category candidates
310 matches = [];
311 for ( category in this.categorized ) {
312 list = filters[ category ];
313 if ( list ) {
314 if ( !Array.isArray( list ) ) {
315 list = [ list ];
316 }
317 for ( i = 0, len = list.length; i < len; i++ ) {
318 actions = this.categorized[ category ][ list[ i ] ];
319 if ( Array.isArray( actions ) ) {
320 matches.push.apply( matches, actions );
321 }
322 }
323 }
324 }
325 // Remove by boolean filters
326 for ( i = 0, len = matches.length; i < len; i++ ) {
327 match = matches[ i ];
328 if (
329 ( filters.visible !== undefined && match.isVisible() !== filters.visible ) ||
330 ( filters.disabled !== undefined && match.isDisabled() !== filters.disabled )
331 ) {
332 matches.splice( i, 1 );
333 len--;
334 i--;
335 }
336 }
337 // Remove duplicates
338 for ( i = 0, len = matches.length; i < len; i++ ) {
339 match = matches[ i ];
340 index = matches.lastIndexOf( match );
341 while ( index !== i ) {
342 matches.splice( index, 1 );
343 len--;
344 index = matches.lastIndexOf( match );
345 }
346 }
347 return matches;
348 }
349 return this.list.slice();
350 };
351
352 /**
353 * Get 'special' actions.
354 *
355 * Special actions are the first visible action widgets with special flags, such as 'safe' and 'primary'.
356 * Special flags can be configured in subclasses by changing the static #specialFlags property.
357 *
358 * @return {OO.ui.ActionWidget[]|null} 'Special' action widgets.
359 */
360 OO.ui.ActionSet.prototype.getSpecial = function () {
361 this.organize();
362 return $.extend( {}, this.special );
363 };
364
365 /**
366 * Get 'other' actions.
367 *
368 * Other actions include all non-special visible action widgets.
369 *
370 * @return {OO.ui.ActionWidget[]} 'Other' action widgets
371 */
372 OO.ui.ActionSet.prototype.getOthers = function () {
373 this.organize();
374 return this.others.slice();
375 };
376
377 /**
378 * Set the mode (e.g., ‘edit’ or ‘view’). Only {@link OO.ui.ActionWidget#modes actions} configured
379 * to be available in the specified mode will be made visible. All other actions will be hidden.
380 *
381 * @param {string} mode The mode. Only actions configured to be available in the specified
382 * mode will be made visible.
383 * @chainable
384 * @fires toggle
385 * @fires change
386 */
387 OO.ui.ActionSet.prototype.setMode = function ( mode ) {
388 var i, len, action;
389
390 this.changing = true;
391 for ( i = 0, len = this.list.length; i < len; i++ ) {
392 action = this.list[ i ];
393 action.toggle( action.hasMode( mode ) );
394 }
395
396 this.organized = false;
397 this.changing = false;
398 this.emit( 'change' );
399
400 return this;
401 };
402
403 /**
404 * Set the abilities of the specified actions.
405 *
406 * Action widgets that are configured with the specified actions will be enabled
407 * or disabled based on the boolean values specified in the `actions`
408 * parameter.
409 *
410 * @param {Object.<string,boolean>} actions A list keyed by action name with boolean
411 * values that indicate whether or not the action should be enabled.
412 * @chainable
413 */
414 OO.ui.ActionSet.prototype.setAbilities = function ( actions ) {
415 var i, len, action, item;
416
417 for ( i = 0, len = this.list.length; i < len; i++ ) {
418 item = this.list[ i ];
419 action = item.getAction();
420 if ( actions[ action ] !== undefined ) {
421 item.setDisabled( !actions[ action ] );
422 }
423 }
424
425 return this;
426 };
427
428 /**
429 * Executes a function once per action.
430 *
431 * When making changes to multiple actions, use this method instead of iterating over the actions
432 * manually to defer emitting a #change event until after all actions have been changed.
433 *
434 * @param {Object|null} filter Filters to use to determine which actions to iterate over; see #get
435 * @param {Function} callback Callback to run for each action; callback is invoked with three
436 * arguments: the action, the action's index, the list of actions being iterated over
437 * @chainable
438 */
439 OO.ui.ActionSet.prototype.forEach = function ( filter, callback ) {
440 this.changed = false;
441 this.changing = true;
442 this.get( filter ).forEach( callback );
443 this.changing = false;
444 if ( this.changed ) {
445 this.emit( 'change' );
446 }
447
448 return this;
449 };
450
451 /**
452 * Add action widgets to the action set.
453 *
454 * @param {OO.ui.ActionWidget[]} actions Action widgets to add
455 * @chainable
456 * @fires add
457 * @fires change
458 */
459 OO.ui.ActionSet.prototype.add = function ( actions ) {
460 var i, len, action;
461
462 this.changing = true;
463 for ( i = 0, len = actions.length; i < len; i++ ) {
464 action = actions[ i ];
465 action.connect( this, {
466 click: [ 'emit', 'click', action ],
467 toggle: [ 'onActionChange' ]
468 } );
469 this.list.push( action );
470 }
471 this.organized = false;
472 this.emit( 'add', actions );
473 this.changing = false;
474 this.emit( 'change' );
475
476 return this;
477 };
478
479 /**
480 * Remove action widgets from the set.
481 *
482 * To remove all actions, you may wish to use the #clear method instead.
483 *
484 * @param {OO.ui.ActionWidget[]} actions Action widgets to remove
485 * @chainable
486 * @fires remove
487 * @fires change
488 */
489 OO.ui.ActionSet.prototype.remove = function ( actions ) {
490 var i, len, index, action;
491
492 this.changing = true;
493 for ( i = 0, len = actions.length; i < len; i++ ) {
494 action = actions[ i ];
495 index = this.list.indexOf( action );
496 if ( index !== -1 ) {
497 action.disconnect( this );
498 this.list.splice( index, 1 );
499 }
500 }
501 this.organized = false;
502 this.emit( 'remove', actions );
503 this.changing = false;
504 this.emit( 'change' );
505
506 return this;
507 };
508
509 /**
510 * Remove all action widets from the set.
511 *
512 * To remove only specified actions, use the {@link #method-remove remove} method instead.
513 *
514 * @chainable
515 * @fires remove
516 * @fires change
517 */
518 OO.ui.ActionSet.prototype.clear = function () {
519 var i, len, action,
520 removed = this.list.slice();
521
522 this.changing = true;
523 for ( i = 0, len = this.list.length; i < len; i++ ) {
524 action = this.list[ i ];
525 action.disconnect( this );
526 }
527
528 this.list = [];
529
530 this.organized = false;
531 this.emit( 'remove', removed );
532 this.changing = false;
533 this.emit( 'change' );
534
535 return this;
536 };
537
538 /**
539 * Organize actions.
540 *
541 * This is called whenever organized information is requested. It will only reorganize the actions
542 * if something has changed since the last time it ran.
543 *
544 * @private
545 * @chainable
546 */
547 OO.ui.ActionSet.prototype.organize = function () {
548 var i, iLen, j, jLen, flag, action, category, list, item, special,
549 specialFlags = this.constructor.static.specialFlags;
550
551 if ( !this.organized ) {
552 this.categorized = {};
553 this.special = {};
554 this.others = [];
555 for ( i = 0, iLen = this.list.length; i < iLen; i++ ) {
556 action = this.list[ i ];
557 if ( action.isVisible() ) {
558 // Populate categories
559 for ( category in this.categories ) {
560 if ( !this.categorized[ category ] ) {
561 this.categorized[ category ] = {};
562 }
563 list = action[ this.categories[ category ] ]();
564 if ( !Array.isArray( list ) ) {
565 list = [ list ];
566 }
567 for ( j = 0, jLen = list.length; j < jLen; j++ ) {
568 item = list[ j ];
569 if ( !this.categorized[ category ][ item ] ) {
570 this.categorized[ category ][ item ] = [];
571 }
572 this.categorized[ category ][ item ].push( action );
573 }
574 }
575 // Populate special/others
576 special = false;
577 for ( j = 0, jLen = specialFlags.length; j < jLen; j++ ) {
578 flag = specialFlags[ j ];
579 if ( !this.special[ flag ] && action.hasFlag( flag ) ) {
580 this.special[ flag ] = action;
581 special = true;
582 break;
583 }
584 }
585 if ( !special ) {
586 this.others.push( action );
587 }
588 }
589 }
590 this.organized = true;
591 }
592
593 return this;
594 };
595
596 /**
597 * Errors contain a required message (either a string or jQuery selection) that is used to describe what went wrong
598 * in a {@link OO.ui.Process process}. The error's #recoverable and #warning configurations are used to customize the
599 * appearance and functionality of the error interface.
600 *
601 * The basic error interface contains a formatted error message as well as two buttons: 'Dismiss' and 'Try again' (i.e., the error
602 * is 'recoverable' by default). If the error is not recoverable, the 'Try again' button will not be rendered and the widget
603 * that initiated the failed process will be disabled.
604 *
605 * If the error is a warning, the error interface will include a 'Dismiss' and a 'Continue' button, which will try the
606 * process again.
607 *
608 * For an example of error interfaces, please see the [OOUI documentation on MediaWiki][1].
609 *
610 * [1]: https://www.mediawiki.org/wiki/OOUI/Windows/Process_Dialogs#Processes_and_errors
611 *
612 * @class
613 *
614 * @constructor
615 * @param {string|jQuery} message Description of error
616 * @param {Object} [config] Configuration options
617 * @cfg {boolean} [recoverable=true] Error is recoverable.
618 * By default, errors are recoverable, and users can try the process again.
619 * @cfg {boolean} [warning=false] Error is a warning.
620 * If the error is a warning, the error interface will include a
621 * 'Dismiss' and a 'Continue' button. It is the responsibility of the developer to ensure that the warning
622 * is not triggered a second time if the user chooses to continue.
623 */
624 OO.ui.Error = function OoUiError( message, config ) {
625 // Allow passing positional parameters inside the config object
626 if ( OO.isPlainObject( message ) && config === undefined ) {
627 config = message;
628 message = config.message;
629 }
630
631 // Configuration initialization
632 config = config || {};
633
634 // Properties
635 this.message = message instanceof jQuery ? message : String( message );
636 this.recoverable = config.recoverable === undefined || !!config.recoverable;
637 this.warning = !!config.warning;
638 };
639
640 /* Setup */
641
642 OO.initClass( OO.ui.Error );
643
644 /* Methods */
645
646 /**
647 * Check if the error is recoverable.
648 *
649 * If the error is recoverable, users are able to try the process again.
650 *
651 * @return {boolean} Error is recoverable
652 */
653 OO.ui.Error.prototype.isRecoverable = function () {
654 return this.recoverable;
655 };
656
657 /**
658 * Check if the error is a warning.
659 *
660 * If the error is a warning, the error interface will include a 'Dismiss' and a 'Continue' button.
661 *
662 * @return {boolean} Error is warning
663 */
664 OO.ui.Error.prototype.isWarning = function () {
665 return this.warning;
666 };
667
668 /**
669 * Get error message as DOM nodes.
670 *
671 * @return {jQuery} Error message in DOM nodes
672 */
673 OO.ui.Error.prototype.getMessage = function () {
674 return this.message instanceof jQuery ?
675 this.message.clone() :
676 $( '<div>' ).text( this.message ).contents();
677 };
678
679 /**
680 * Get the error message text.
681 *
682 * @return {string} Error message
683 */
684 OO.ui.Error.prototype.getMessageText = function () {
685 return this.message instanceof jQuery ? this.message.text() : this.message;
686 };
687
688 /**
689 * A Process is a list of steps that are called in sequence. The step can be a number, a jQuery promise,
690 * or a function:
691 *
692 * - **number**: the process will wait for the specified number of milliseconds before proceeding.
693 * - **promise**: the process will continue to the next step when the promise is successfully resolved
694 * or stop if the promise is rejected.
695 * - **function**: the process will execute the function. The process will stop if the function returns
696 * either a boolean `false` or a promise that is rejected; if the function returns a number, the process
697 * will wait for that number of milliseconds before proceeding.
698 *
699 * If the process fails, an {@link OO.ui.Error error} is generated. Depending on how the error is
700 * configured, users can dismiss the error and try the process again, or not. If a process is stopped,
701 * its remaining steps will not be performed.
702 *
703 * @class
704 *
705 * @constructor
706 * @param {number|jQuery.Promise|Function} step Number of miliseconds to wait before proceeding, promise
707 * that must be resolved before proceeding, or a function to execute. See #createStep for more information. see #createStep for more information
708 * @param {Object} [context=null] Execution context of the function. The context is ignored if the step is
709 * a number or promise.
710 */
711 OO.ui.Process = function ( step, context ) {
712 // Properties
713 this.steps = [];
714
715 // Initialization
716 if ( step !== undefined ) {
717 this.next( step, context );
718 }
719 };
720
721 /* Setup */
722
723 OO.initClass( OO.ui.Process );
724
725 /* Methods */
726
727 /**
728 * Start the process.
729 *
730 * @return {jQuery.Promise} Promise that is resolved when all steps have successfully completed.
731 * If any of the steps return a promise that is rejected or a boolean false, this promise is rejected
732 * and any remaining steps are not performed.
733 */
734 OO.ui.Process.prototype.execute = function () {
735 var i, len, promise;
736
737 /**
738 * Continue execution.
739 *
740 * @ignore
741 * @param {Array} step A function and the context it should be called in
742 * @return {Function} Function that continues the process
743 */
744 function proceed( step ) {
745 return function () {
746 // Execute step in the correct context
747 var deferred,
748 result = step.callback.call( step.context );
749
750 if ( result === false ) {
751 // Use rejected promise for boolean false results
752 return $.Deferred().reject( [] ).promise();
753 }
754 if ( typeof result === 'number' ) {
755 if ( result < 0 ) {
756 throw new Error( 'Cannot go back in time: flux capacitor is out of service' );
757 }
758 // Use a delayed promise for numbers, expecting them to be in milliseconds
759 deferred = $.Deferred();
760 setTimeout( deferred.resolve, result );
761 return deferred.promise();
762 }
763 if ( result instanceof OO.ui.Error ) {
764 // Use rejected promise for error
765 return $.Deferred().reject( [ result ] ).promise();
766 }
767 if ( Array.isArray( result ) && result.length && result[ 0 ] instanceof OO.ui.Error ) {
768 // Use rejected promise for list of errors
769 return $.Deferred().reject( result ).promise();
770 }
771 // Duck-type the object to see if it can produce a promise
772 if ( result && $.isFunction( result.promise ) ) {
773 // Use a promise generated from the result
774 return result.promise();
775 }
776 // Use resolved promise for other results
777 return $.Deferred().resolve().promise();
778 };
779 }
780
781 if ( this.steps.length ) {
782 // Generate a chain reaction of promises
783 promise = proceed( this.steps[ 0 ] )();
784 for ( i = 1, len = this.steps.length; i < len; i++ ) {
785 promise = promise.then( proceed( this.steps[ i ] ) );
786 }
787 } else {
788 promise = $.Deferred().resolve().promise();
789 }
790
791 return promise;
792 };
793
794 /**
795 * Create a process step.
796 *
797 * @private
798 * @param {number|jQuery.Promise|Function} step
799 *
800 * - Number of milliseconds to wait before proceeding
801 * - Promise that must be resolved before proceeding
802 * - Function to execute
803 * - If the function returns a boolean false the process will stop
804 * - If the function returns a promise, the process will continue to the next
805 * step when the promise is resolved or stop if the promise is rejected
806 * - If the function returns a number, the process will wait for that number of
807 * milliseconds before proceeding
808 * @param {Object} [context=null] Execution context of the function. The context is
809 * ignored if the step is a number or promise.
810 * @return {Object} Step object, with `callback` and `context` properties
811 */
812 OO.ui.Process.prototype.createStep = function ( step, context ) {
813 if ( typeof step === 'number' || $.isFunction( step.promise ) ) {
814 return {
815 callback: function () {
816 return step;
817 },
818 context: null
819 };
820 }
821 if ( $.isFunction( step ) ) {
822 return {
823 callback: step,
824 context: context
825 };
826 }
827 throw new Error( 'Cannot create process step: number, promise or function expected' );
828 };
829
830 /**
831 * Add step to the beginning of the process.
832 *
833 * @inheritdoc #createStep
834 * @return {OO.ui.Process} this
835 * @chainable
836 */
837 OO.ui.Process.prototype.first = function ( step, context ) {
838 this.steps.unshift( this.createStep( step, context ) );
839 return this;
840 };
841
842 /**
843 * Add step to the end of the process.
844 *
845 * @inheritdoc #createStep
846 * @return {OO.ui.Process} this
847 * @chainable
848 */
849 OO.ui.Process.prototype.next = function ( step, context ) {
850 this.steps.push( this.createStep( step, context ) );
851 return this;
852 };
853
854 /**
855 * A window instance represents the life cycle for one single opening of a window
856 * until its closing.
857 *
858 * While OO.ui.WindowManager will reuse OO.ui.Window objects, each time a window is
859 * opened, a new lifecycle starts.
860 *
861 * For more information, please see the [OOUI documentation on MediaWiki] [1].
862 *
863 * [1]: https://www.mediawiki.org/wiki/OOUI/Windows
864 *
865 * @class
866 *
867 * @constructor
868 */
869 OO.ui.WindowInstance = function OOuiWindowInstance() {
870 var deferreds = {
871 opening: $.Deferred(),
872 opened: $.Deferred(),
873 closing: $.Deferred(),
874 closed: $.Deferred()
875 };
876
877 /**
878 * @private
879 * @property {Object}
880 */
881 this.deferreds = deferreds;
882
883 // Set these up as chained promises so that rejecting of
884 // an earlier stage automatically rejects the subsequent
885 // would-be stages as well.
886
887 /**
888 * @property {jQuery.Promise}
889 */
890 this.opening = deferreds.opening.promise();
891 /**
892 * @property {jQuery.Promise}
893 */
894 this.opened = this.opening.then( function () {
895 return deferreds.opened;
896 } );
897 /**
898 * @property {jQuery.Promise}
899 */
900 this.closing = this.opened.then( function () {
901 return deferreds.closing;
902 } );
903 /**
904 * @property {jQuery.Promise}
905 */
906 this.closed = this.closing.then( function () {
907 return deferreds.closed;
908 } );
909 };
910
911 /* Setup */
912
913 OO.initClass( OO.ui.WindowInstance );
914
915 /**
916 * Check if window is opening.
917 *
918 * @return {boolean} Window is opening
919 */
920 OO.ui.WindowInstance.prototype.isOpening = function () {
921 return this.deferreds.opened.state() === 'pending';
922 };
923
924 /**
925 * Check if window is opened.
926 *
927 * @return {boolean} Window is opened
928 */
929 OO.ui.WindowInstance.prototype.isOpened = function () {
930 return this.deferreds.opened.state() === 'resolved' &&
931 this.deferreds.closing.state() === 'pending';
932 };
933
934 /**
935 * Check if window is closing.
936 *
937 * @return {boolean} Window is closing
938 */
939 OO.ui.WindowInstance.prototype.isClosing = function () {
940 return this.deferreds.closing.state() === 'resolved' &&
941 this.deferreds.closed.state() === 'pending';
942 };
943
944 /**
945 * Check if window is closed.
946 *
947 * @return {boolean} Window is closed
948 */
949 OO.ui.WindowInstance.prototype.isClosed = function () {
950 return this.deferreds.closed.state() === 'resolved';
951 };
952
953 /**
954 * Window managers are used to open and close {@link OO.ui.Window windows} and control their presentation.
955 * Managed windows are mutually exclusive. If a new window is opened while a current window is opening
956 * or is opened, the current window will be closed and any ongoing {@link OO.ui.Process process} will be cancelled. Windows
957 * themselves are persistent and—rather than being torn down when closed—can be repopulated with the
958 * pertinent data and reused.
959 *
960 * Over the lifecycle of a window, the window manager makes available three promises: `opening`,
961 * `opened`, and `closing`, which represent the primary stages of the cycle:
962 *
963 * **Opening**: the opening stage begins when the window manager’s #openWindow or a window’s
964 * {@link OO.ui.Window#open open} method is used, and the window manager begins to open the window.
965 *
966 * - an `opening` event is emitted with an `opening` promise
967 * - the #getSetupDelay method is called and the returned value is used to time a pause in execution before the
968 * window’s {@link OO.ui.Window#method-setup setup} method is called which executes OO.ui.Window#getSetupProcess.
969 * - a `setup` progress notification is emitted from the `opening` promise
970 * - the #getReadyDelay method is called the returned value is used to time a pause in execution before the
971 * window’s {@link OO.ui.Window#method-ready ready} method is called which executes OO.ui.Window#getReadyProcess.
972 * - a `ready` progress notification is emitted from the `opening` promise
973 * - the `opening` promise is resolved with an `opened` promise
974 *
975 * **Opened**: the window is now open.
976 *
977 * **Closing**: the closing stage begins when the window manager's #closeWindow or the
978 * window's {@link OO.ui.Window#close close} methods is used, and the window manager begins
979 * to close the window.
980 *
981 * - the `opened` promise is resolved with `closing` promise and a `closing` event is emitted
982 * - the #getHoldDelay method is called and the returned value is used to time a pause in execution before
983 * the window's {@link OO.ui.Window#getHoldProcess getHoldProces} method is called on the
984 * window and its result executed
985 * - a `hold` progress notification is emitted from the `closing` promise
986 * - the #getTeardownDelay() method is called and the returned value is used to time a pause in execution before
987 * the window's {@link OO.ui.Window#getTeardownProcess getTeardownProcess} method is called on the
988 * window and its result executed
989 * - a `teardown` progress notification is emitted from the `closing` promise
990 * - the `closing` promise is resolved. The window is now closed
991 *
992 * See the [OOUI documentation on MediaWiki][1] for more information.
993 *
994 * [1]: https://www.mediawiki.org/wiki/OOUI/Windows/Window_managers
995 *
996 * @class
997 * @extends OO.ui.Element
998 * @mixins OO.EventEmitter
999 *
1000 * @constructor
1001 * @param {Object} [config] Configuration options
1002 * @cfg {OO.Factory} [factory] Window factory to use for automatic instantiation
1003 * Note that window classes that are instantiated with a factory must have
1004 * a {@link OO.ui.Dialog#static-name static name} property that specifies a symbolic name.
1005 * @cfg {boolean} [modal=true] Prevent interaction outside the dialog
1006 */
1007 OO.ui.WindowManager = function OoUiWindowManager( config ) {
1008 // Configuration initialization
1009 config = config || {};
1010
1011 // Parent constructor
1012 OO.ui.WindowManager.parent.call( this, config );
1013
1014 // Mixin constructors
1015 OO.EventEmitter.call( this );
1016
1017 // Properties
1018 this.factory = config.factory;
1019 this.modal = config.modal === undefined || !!config.modal;
1020 this.windows = {};
1021 // Deprecated placeholder promise given to compatOpening in openWindow()
1022 // that is resolved in closeWindow().
1023 this.compatOpened = null;
1024 this.preparingToOpen = null;
1025 this.preparingToClose = null;
1026 this.currentWindow = null;
1027 this.globalEvents = false;
1028 this.$returnFocusTo = null;
1029 this.$ariaHidden = null;
1030 this.onWindowResizeTimeout = null;
1031 this.onWindowResizeHandler = this.onWindowResize.bind( this );
1032 this.afterWindowResizeHandler = this.afterWindowResize.bind( this );
1033
1034 // Initialization
1035 this.$element
1036 .addClass( 'oo-ui-windowManager' )
1037 .attr( 'aria-hidden', true )
1038 .toggleClass( 'oo-ui-windowManager-modal', this.modal );
1039 };
1040
1041 /* Setup */
1042
1043 OO.inheritClass( OO.ui.WindowManager, OO.ui.Element );
1044 OO.mixinClass( OO.ui.WindowManager, OO.EventEmitter );
1045
1046 /* Events */
1047
1048 /**
1049 * An 'opening' event is emitted when the window begins to be opened.
1050 *
1051 * @event opening
1052 * @param {OO.ui.Window} win Window that's being opened
1053 * @param {jQuery.Promise} opened A promise resolved with a value when the window is opened successfully.
1054 * This promise also emits `setup` and `ready` notifications. When this promise is resolved, the first
1055 * argument of the value is an 'closed' promise, the second argument is the opening data.
1056 * @param {Object} data Window opening data
1057 */
1058
1059 /**
1060 * A 'closing' event is emitted when the window begins to be closed.
1061 *
1062 * @event closing
1063 * @param {OO.ui.Window} win Window that's being closed
1064 * @param {jQuery.Promise} closed A promise resolved with a value when the window is closed successfully.
1065 * This promise also emits `hold` and `teardown` notifications. When this promise is resolved, the first
1066 * argument of its value is the closing data.
1067 * @param {Object} data Window closing data
1068 */
1069
1070 /**
1071 * A 'resize' event is emitted when a window is resized.
1072 *
1073 * @event resize
1074 * @param {OO.ui.Window} win Window that was resized
1075 */
1076
1077 /* Static Properties */
1078
1079 /**
1080 * Map of the symbolic name of each window size and its CSS properties.
1081 *
1082 * @static
1083 * @inheritable
1084 * @property {Object}
1085 */
1086 OO.ui.WindowManager.static.sizes = {
1087 small: {
1088 width: 300
1089 },
1090 medium: {
1091 width: 500
1092 },
1093 large: {
1094 width: 700
1095 },
1096 larger: {
1097 width: 900
1098 },
1099 full: {
1100 // These can be non-numeric because they are never used in calculations
1101 width: '100%',
1102 height: '100%'
1103 }
1104 };
1105
1106 /**
1107 * Symbolic name of the default window size.
1108 *
1109 * The default size is used if the window's requested size is not recognized.
1110 *
1111 * @static
1112 * @inheritable
1113 * @property {string}
1114 */
1115 OO.ui.WindowManager.static.defaultSize = 'medium';
1116
1117 /* Methods */
1118
1119 /**
1120 * Handle window resize events.
1121 *
1122 * @private
1123 * @param {jQuery.Event} e Window resize event
1124 */
1125 OO.ui.WindowManager.prototype.onWindowResize = function () {
1126 clearTimeout( this.onWindowResizeTimeout );
1127 this.onWindowResizeTimeout = setTimeout( this.afterWindowResizeHandler, 200 );
1128 };
1129
1130 /**
1131 * Handle window resize events.
1132 *
1133 * @private
1134 * @param {jQuery.Event} e Window resize event
1135 */
1136 OO.ui.WindowManager.prototype.afterWindowResize = function () {
1137 var currentFocusedElement = document.activeElement;
1138 if ( this.currentWindow ) {
1139 this.updateWindowSize( this.currentWindow );
1140
1141 // Restore focus to the original element if it has changed.
1142 // When a layout change is made on resize inputs lose focus
1143 // on Android (Chrome and Firefox). See T162127.
1144 if ( currentFocusedElement !== document.activeElement ) {
1145 currentFocusedElement.focus();
1146 }
1147 }
1148 };
1149
1150 /**
1151 * Check if window is opening.
1152 *
1153 * @param {OO.ui.Window} win Window to check
1154 * @return {boolean} Window is opening
1155 */
1156 OO.ui.WindowManager.prototype.isOpening = function ( win ) {
1157 return win === this.currentWindow && !!this.lifecycle &&
1158 this.lifecycle.isOpening();
1159 };
1160
1161 /**
1162 * Check if window is closing.
1163 *
1164 * @param {OO.ui.Window} win Window to check
1165 * @return {boolean} Window is closing
1166 */
1167 OO.ui.WindowManager.prototype.isClosing = function ( win ) {
1168 return win === this.currentWindow && !!this.lifecycle &&
1169 this.lifecycle.isClosing();
1170 };
1171
1172 /**
1173 * Check if window is opened.
1174 *
1175 * @param {OO.ui.Window} win Window to check
1176 * @return {boolean} Window is opened
1177 */
1178 OO.ui.WindowManager.prototype.isOpened = function ( win ) {
1179 return win === this.currentWindow && !!this.lifecycle &&
1180 this.lifecycle.isOpened();
1181 };
1182
1183 /**
1184 * Check if a window is being managed.
1185 *
1186 * @param {OO.ui.Window} win Window to check
1187 * @return {boolean} Window is being managed
1188 */
1189 OO.ui.WindowManager.prototype.hasWindow = function ( win ) {
1190 var name;
1191
1192 for ( name in this.windows ) {
1193 if ( this.windows[ name ] === win ) {
1194 return true;
1195 }
1196 }
1197
1198 return false;
1199 };
1200
1201 /**
1202 * Get the number of milliseconds to wait after opening begins before executing the ‘setup’ process.
1203 *
1204 * @param {OO.ui.Window} win Window being opened
1205 * @param {Object} [data] Window opening data
1206 * @return {number} Milliseconds to wait
1207 */
1208 OO.ui.WindowManager.prototype.getSetupDelay = function () {
1209 return 0;
1210 };
1211
1212 /**
1213 * Get the number of milliseconds to wait after setup has finished before executing the ‘ready’ process.
1214 *
1215 * @param {OO.ui.Window} win Window being opened
1216 * @param {Object} [data] Window opening data
1217 * @return {number} Milliseconds to wait
1218 */
1219 OO.ui.WindowManager.prototype.getReadyDelay = function () {
1220 return 0;
1221 };
1222
1223 /**
1224 * Get the number of milliseconds to wait after closing has begun before executing the 'hold' process.
1225 *
1226 * @param {OO.ui.Window} win Window being closed
1227 * @param {Object} [data] Window closing data
1228 * @return {number} Milliseconds to wait
1229 */
1230 OO.ui.WindowManager.prototype.getHoldDelay = function () {
1231 return 0;
1232 };
1233
1234 /**
1235 * Get the number of milliseconds to wait after the ‘hold’ process has finished before
1236 * executing the ‘teardown’ process.
1237 *
1238 * @param {OO.ui.Window} win Window being closed
1239 * @param {Object} [data] Window closing data
1240 * @return {number} Milliseconds to wait
1241 */
1242 OO.ui.WindowManager.prototype.getTeardownDelay = function () {
1243 return this.modal ? 250 : 0;
1244 };
1245
1246 /**
1247 * Get a window by its symbolic name.
1248 *
1249 * If the window is not yet instantiated and its symbolic name is recognized by a factory, it will be
1250 * instantiated and added to the window manager automatically. Please see the [OOUI documentation on MediaWiki][3]
1251 * for more information about using factories.
1252 * [3]: https://www.mediawiki.org/wiki/OOUI/Windows/Window_managers
1253 *
1254 * @param {string} name Symbolic name of the window
1255 * @return {jQuery.Promise} Promise resolved with matching window, or rejected with an OO.ui.Error
1256 * @throws {Error} An error is thrown if the symbolic name is not recognized by the factory.
1257 * @throws {Error} An error is thrown if the named window is not recognized as a managed window.
1258 */
1259 OO.ui.WindowManager.prototype.getWindow = function ( name ) {
1260 var deferred = $.Deferred(),
1261 win = this.windows[ name ];
1262
1263 if ( !( win instanceof OO.ui.Window ) ) {
1264 if ( this.factory ) {
1265 if ( !this.factory.lookup( name ) ) {
1266 deferred.reject( new OO.ui.Error(
1267 'Cannot auto-instantiate window: symbolic name is unrecognized by the factory'
1268 ) );
1269 } else {
1270 win = this.factory.create( name );
1271 this.addWindows( [ win ] );
1272 deferred.resolve( win );
1273 }
1274 } else {
1275 deferred.reject( new OO.ui.Error(
1276 'Cannot get unmanaged window: symbolic name unrecognized as a managed window'
1277 ) );
1278 }
1279 } else {
1280 deferred.resolve( win );
1281 }
1282
1283 return deferred.promise();
1284 };
1285
1286 /**
1287 * Get current window.
1288 *
1289 * @return {OO.ui.Window|null} Currently opening/opened/closing window
1290 */
1291 OO.ui.WindowManager.prototype.getCurrentWindow = function () {
1292 return this.currentWindow;
1293 };
1294
1295 /**
1296 * Open a window.
1297 *
1298 * @param {OO.ui.Window|string} win Window object or symbolic name of window to open
1299 * @param {Object} [data] Window opening data
1300 * @param {jQuery|null} [data.$returnFocusTo] Element to which the window will return focus when closed.
1301 * Defaults the current activeElement. If set to null, focus isn't changed on close.
1302 * @return {OO.ui.WindowInstance|jQuery.Promise} A lifecycle object representing this particular
1303 * opening of the window. For backwards-compatibility, then object is also a Thenable that is resolved
1304 * when the window is done opening, with nested promise for when closing starts. This behaviour
1305 * is deprecated and is not compatible with jQuery 3. See T163510.
1306 * @fires opening
1307 */
1308 OO.ui.WindowManager.prototype.openWindow = function ( win, data, lifecycle, compatOpening ) {
1309 var error,
1310 manager = this;
1311 data = data || {};
1312
1313 // Internal parameter 'lifecycle' allows this method to always return
1314 // a lifecycle even if the window still needs to be created
1315 // asynchronously when 'win' is a string.
1316 lifecycle = lifecycle || new OO.ui.WindowInstance();
1317 compatOpening = compatOpening || $.Deferred();
1318
1319 // Turn lifecycle into a Thenable for backwards-compatibility with
1320 // the deprecated nested-promise behaviour, see T163510.
1321 [ 'state', 'always', 'catch', 'pipe', 'then', 'promise', 'progress', 'done', 'fail' ]
1322 .forEach( function ( method ) {
1323 lifecycle[ method ] = function () {
1324 OO.ui.warnDeprecation(
1325 'Using the return value of openWindow as a promise is deprecated. ' +
1326 'Use .openWindow( ... ).opening.' + method + '( ... ) instead.'
1327 );
1328 return compatOpening[ method ].apply( this, arguments );
1329 };
1330 } );
1331
1332 // Argument handling
1333 if ( typeof win === 'string' ) {
1334 this.getWindow( win ).then(
1335 function ( win ) {
1336 manager.openWindow( win, data, lifecycle, compatOpening );
1337 },
1338 function ( err ) {
1339 lifecycle.deferreds.opening.reject( err );
1340 }
1341 );
1342 return lifecycle;
1343 }
1344
1345 // Error handling
1346 if ( !this.hasWindow( win ) ) {
1347 error = 'Cannot open window: window is not attached to manager';
1348 } else if ( this.lifecycle && this.lifecycle.isOpened() ) {
1349 error = 'Cannot open window: another window is open';
1350 } else if ( this.preparingToOpen || ( this.lifecycle && this.lifecycle.isOpening() ) ) {
1351 error = 'Cannot open window: another window is opening';
1352 }
1353
1354 if ( error ) {
1355 compatOpening.reject( new OO.ui.Error( error ) );
1356 lifecycle.deferreds.opening.reject( new OO.ui.Error( error ) );
1357 return lifecycle;
1358 }
1359
1360 // If a window is currently closing, wait for it to complete
1361 this.preparingToOpen = $.when( this.lifecycle && this.lifecycle.closed );
1362 // Ensure handlers get called after preparingToOpen is set
1363 this.preparingToOpen.done( function () {
1364 if ( manager.modal ) {
1365 manager.toggleGlobalEvents( true );
1366 manager.toggleAriaIsolation( true );
1367 }
1368 manager.$returnFocusTo = data.$returnFocusTo !== undefined ? data.$returnFocusTo : $( document.activeElement );
1369 manager.currentWindow = win;
1370 manager.lifecycle = lifecycle;
1371 manager.preparingToOpen = null;
1372 manager.emit( 'opening', win, compatOpening, data );
1373 lifecycle.deferreds.opening.resolve( data );
1374 setTimeout( function () {
1375 manager.compatOpened = $.Deferred();
1376 win.setup( data ).then( function () {
1377 manager.updateWindowSize( win );
1378 compatOpening.notify( { state: 'setup' } );
1379 setTimeout( function () {
1380 win.ready( data ).then( function () {
1381 compatOpening.notify( { state: 'ready' } );
1382 lifecycle.deferreds.opened.resolve( data );
1383 compatOpening.resolve( manager.compatOpened.promise(), data );
1384 }, function () {
1385 lifecycle.deferreds.opened.reject();
1386 compatOpening.reject();
1387 manager.closeWindow( win );
1388 } );
1389 }, manager.getReadyDelay() );
1390 }, function () {
1391 lifecycle.deferreds.opened.reject();
1392 compatOpening.reject();
1393 manager.closeWindow( win );
1394 } );
1395 }, manager.getSetupDelay() );
1396 } );
1397
1398 return lifecycle;
1399 };
1400
1401 /**
1402 * Close a window.
1403 *
1404 * @param {OO.ui.Window|string} win Window object or symbolic name of window to close
1405 * @param {Object} [data] Window closing data
1406 * @return {OO.ui.WindowInstance|jQuery.Promise} A lifecycle object representing this particular
1407 * opening of the window. For backwards-compatibility, the object is also a Thenable that is resolved
1408 * when the window is done closing, see T163510.
1409 * @fires closing
1410 */
1411 OO.ui.WindowManager.prototype.closeWindow = function ( win, data ) {
1412 var error,
1413 manager = this,
1414 compatClosing = $.Deferred(),
1415 lifecycle = this.lifecycle,
1416 compatOpened;
1417
1418 // Argument handling
1419 if ( typeof win === 'string' ) {
1420 win = this.windows[ win ];
1421 } else if ( !this.hasWindow( win ) ) {
1422 win = null;
1423 }
1424
1425 // Error handling
1426 if ( !lifecycle ) {
1427 error = 'Cannot close window: no window is currently open';
1428 } else if ( !win ) {
1429 error = 'Cannot close window: window is not attached to manager';
1430 } else if ( win !== this.currentWindow || this.lifecycle.isClosed() ) {
1431 error = 'Cannot close window: window already closed with different data';
1432 } else if ( this.preparingToClose || this.lifecycle.isClosing() ) {
1433 error = 'Cannot close window: window already closing with different data';
1434 }
1435
1436 if ( error ) {
1437 // This function was called for the wrong window and we don't want to mess with the current
1438 // window's state.
1439 lifecycle = new OO.ui.WindowInstance();
1440 // Pretend the window has been opened, so that we can pretend to fail to close it.
1441 lifecycle.deferreds.opening.resolve( {} );
1442 lifecycle.deferreds.opened.resolve( {} );
1443 }
1444
1445 // Turn lifecycle into a Thenable for backwards-compatibility with
1446 // the deprecated nested-promise behaviour, see T163510.
1447 [ 'state', 'always', 'catch', 'pipe', 'then', 'promise', 'progress', 'done', 'fail' ]
1448 .forEach( function ( method ) {
1449 lifecycle[ method ] = function () {
1450 OO.ui.warnDeprecation(
1451 'Using the return value of closeWindow as a promise is deprecated. ' +
1452 'Use .closeWindow( ... ).closed.' + method + '( ... ) instead.'
1453 );
1454 return compatClosing[ method ].apply( this, arguments );
1455 };
1456 } );
1457
1458 if ( error ) {
1459 compatClosing.reject( new OO.ui.Error( error ) );
1460 lifecycle.deferreds.closing.reject( new OO.ui.Error( error ) );
1461 return lifecycle;
1462 }
1463
1464 // If the window is currently opening, close it when it's done
1465 this.preparingToClose = $.when( this.lifecycle.opened );
1466 // Ensure handlers get called after preparingToClose is set
1467 this.preparingToClose.always( function () {
1468 manager.preparingToClose = null;
1469 manager.emit( 'closing', win, compatClosing, data );
1470 lifecycle.deferreds.closing.resolve( data );
1471 compatOpened = manager.compatOpened;
1472 manager.compatOpened = null;
1473 compatOpened.resolve( compatClosing.promise(), data );
1474 setTimeout( function () {
1475 win.hold( data ).then( function () {
1476 compatClosing.notify( { state: 'hold' } );
1477 setTimeout( function () {
1478 win.teardown( data ).then( function () {
1479 compatClosing.notify( { state: 'teardown' } );
1480 if ( manager.modal ) {
1481 manager.toggleGlobalEvents( false );
1482 manager.toggleAriaIsolation( false );
1483 }
1484 if ( manager.$returnFocusTo && manager.$returnFocusTo.length ) {
1485 manager.$returnFocusTo[ 0 ].focus();
1486 }
1487 manager.currentWindow = null;
1488 manager.lifecycle = null;
1489 lifecycle.deferreds.closed.resolve( data );
1490 compatClosing.resolve( data );
1491 } );
1492 }, manager.getTeardownDelay() );
1493 } );
1494 }, manager.getHoldDelay() );
1495 } );
1496
1497 return lifecycle;
1498 };
1499
1500 /**
1501 * Add windows to the window manager.
1502 *
1503 * Windows can be added by reference, symbolic name, or explicitly defined symbolic names.
1504 * See the [OOUI documentation on MediaWiki] [2] for examples.
1505 * [2]: https://www.mediawiki.org/wiki/OOUI/Windows/Window_managers
1506 *
1507 * This function can be called in two manners:
1508 *
1509 * 1. `.addWindows( [ windowA, windowB, ... ] )` (where `windowA`, `windowB` are OO.ui.Window objects)
1510 *
1511 * This syntax registers windows under the symbolic names defined in their `.static.name`
1512 * properties. For example, if `windowA.constructor.static.name` is `'nameA'`, calling
1513 * `.openWindow( 'nameA' )` afterwards will open the window `windowA`. This syntax requires the
1514 * static name to be set, otherwise an exception will be thrown.
1515 *
1516 * This is the recommended way, as it allows for an easier switch to using a window factory.
1517 *
1518 * 2. `.addWindows( { nameA: windowA, nameB: windowB, ... } )`
1519 *
1520 * This syntax registers windows under the explicitly given symbolic names. In this example,
1521 * calling `.openWindow( 'nameA' )` afterwards will open the window `windowA`, regardless of what
1522 * its `.static.name` is set to. The static name is not required to be set.
1523 *
1524 * This should only be used if you need to override the default symbolic names.
1525 *
1526 * Example:
1527 *
1528 * var windowManager = new OO.ui.WindowManager();
1529 * $( 'body' ).append( windowManager.$element );
1530 *
1531 * // Add a window under the default name: see OO.ui.MessageDialog.static.name
1532 * windowManager.addWindows( [ new OO.ui.MessageDialog() ] );
1533 * // Add a window under an explicit name
1534 * windowManager.addWindows( { myMessageDialog: new OO.ui.MessageDialog() } );
1535 *
1536 * // Open window by default name
1537 * windowManager.openWindow( 'message' );
1538 * // Open window by explicitly given name
1539 * windowManager.openWindow( 'myMessageDialog' );
1540 *
1541 *
1542 * @param {Object.<string,OO.ui.Window>|OO.ui.Window[]} windows An array of window objects specified
1543 * by reference, symbolic name, or explicitly defined symbolic names.
1544 * @throws {Error} An error is thrown if a window is added by symbolic name, but has neither an
1545 * explicit nor a statically configured symbolic name.
1546 */
1547 OO.ui.WindowManager.prototype.addWindows = function ( windows ) {
1548 var i, len, win, name, list;
1549
1550 if ( Array.isArray( windows ) ) {
1551 // Convert to map of windows by looking up symbolic names from static configuration
1552 list = {};
1553 for ( i = 0, len = windows.length; i < len; i++ ) {
1554 name = windows[ i ].constructor.static.name;
1555 if ( !name ) {
1556 throw new Error( 'Windows must have a `name` static property defined.' );
1557 }
1558 list[ name ] = windows[ i ];
1559 }
1560 } else if ( OO.isPlainObject( windows ) ) {
1561 list = windows;
1562 }
1563
1564 // Add windows
1565 for ( name in list ) {
1566 win = list[ name ];
1567 this.windows[ name ] = win.toggle( false );
1568 this.$element.append( win.$element );
1569 win.setManager( this );
1570 }
1571 };
1572
1573 /**
1574 * Remove the specified windows from the windows manager.
1575 *
1576 * Windows will be closed before they are removed. If you wish to remove all windows, you may wish to use
1577 * the #clearWindows method instead. If you no longer need the window manager and want to ensure that it no
1578 * longer listens to events, use the #destroy method.
1579 *
1580 * @param {string[]} names Symbolic names of windows to remove
1581 * @return {jQuery.Promise} Promise resolved when window is closed and removed
1582 * @throws {Error} An error is thrown if the named windows are not managed by the window manager.
1583 */
1584 OO.ui.WindowManager.prototype.removeWindows = function ( names ) {
1585 var i, len, win, name, cleanupWindow,
1586 manager = this,
1587 promises = [],
1588 cleanup = function ( name, win ) {
1589 delete manager.windows[ name ];
1590 win.$element.detach();
1591 };
1592
1593 for ( i = 0, len = names.length; i < len; i++ ) {
1594 name = names[ i ];
1595 win = this.windows[ name ];
1596 if ( !win ) {
1597 throw new Error( 'Cannot remove window' );
1598 }
1599 cleanupWindow = cleanup.bind( null, name, win );
1600 promises.push( this.closeWindow( name ).closed.then( cleanupWindow, cleanupWindow ) );
1601 }
1602
1603 return $.when.apply( $, promises );
1604 };
1605
1606 /**
1607 * Remove all windows from the window manager.
1608 *
1609 * Windows will be closed before they are removed. Note that the window manager, though not in use, will still
1610 * listen to events. If the window manager will not be used again, you may wish to use the #destroy method instead.
1611 * To remove just a subset of windows, use the #removeWindows method.
1612 *
1613 * @return {jQuery.Promise} Promise resolved when all windows are closed and removed
1614 */
1615 OO.ui.WindowManager.prototype.clearWindows = function () {
1616 return this.removeWindows( Object.keys( this.windows ) );
1617 };
1618
1619 /**
1620 * Set dialog size. In general, this method should not be called directly.
1621 *
1622 * Fullscreen mode will be used if the dialog is too wide to fit in the screen.
1623 *
1624 * @param {OO.ui.Window} win Window to update, should be the current window
1625 * @chainable
1626 */
1627 OO.ui.WindowManager.prototype.updateWindowSize = function ( win ) {
1628 var isFullscreen;
1629
1630 // Bypass for non-current, and thus invisible, windows
1631 if ( win !== this.currentWindow ) {
1632 return;
1633 }
1634
1635 isFullscreen = win.getSize() === 'full';
1636
1637 this.$element.toggleClass( 'oo-ui-windowManager-fullscreen', isFullscreen );
1638 this.$element.toggleClass( 'oo-ui-windowManager-floating', !isFullscreen );
1639 win.setDimensions( win.getSizeProperties() );
1640
1641 this.emit( 'resize', win );
1642
1643 return this;
1644 };
1645
1646 /**
1647 * Bind or unbind global events for scrolling.
1648 *
1649 * @private
1650 * @param {boolean} [on] Bind global events
1651 * @chainable
1652 */
1653 OO.ui.WindowManager.prototype.toggleGlobalEvents = function ( on ) {
1654 var scrollWidth, bodyMargin,
1655 $body = $( this.getElementDocument().body ),
1656 // We could have multiple window managers open so only modify
1657 // the body css at the bottom of the stack
1658 stackDepth = $body.data( 'windowManagerGlobalEvents' ) || 0;
1659
1660 on = on === undefined ? !!this.globalEvents : !!on;
1661
1662 if ( on ) {
1663 if ( !this.globalEvents ) {
1664 $( this.getElementWindow() ).on( {
1665 // Start listening for top-level window dimension changes
1666 'orientationchange resize': this.onWindowResizeHandler
1667 } );
1668 if ( stackDepth === 0 ) {
1669 scrollWidth = window.innerWidth - document.documentElement.clientWidth;
1670 bodyMargin = parseFloat( $body.css( 'margin-right' ) ) || 0;
1671 $body.css( {
1672 overflow: 'hidden',
1673 'margin-right': bodyMargin + scrollWidth
1674 } );
1675 }
1676 stackDepth++;
1677 this.globalEvents = true;
1678 }
1679 } else if ( this.globalEvents ) {
1680 $( this.getElementWindow() ).off( {
1681 // Stop listening for top-level window dimension changes
1682 'orientationchange resize': this.onWindowResizeHandler
1683 } );
1684 stackDepth--;
1685 if ( stackDepth === 0 ) {
1686 $body.css( {
1687 overflow: '',
1688 'margin-right': ''
1689 } );
1690 }
1691 this.globalEvents = false;
1692 }
1693 $body.data( 'windowManagerGlobalEvents', stackDepth );
1694
1695 return this;
1696 };
1697
1698 /**
1699 * Toggle screen reader visibility of content other than the window manager.
1700 *
1701 * @private
1702 * @param {boolean} [isolate] Make only the window manager visible to screen readers
1703 * @chainable
1704 */
1705 OO.ui.WindowManager.prototype.toggleAriaIsolation = function ( isolate ) {
1706 var $topLevelElement;
1707 isolate = isolate === undefined ? !this.$ariaHidden : !!isolate;
1708
1709 if ( isolate ) {
1710 if ( !this.$ariaHidden ) {
1711 // Find the top level element containing the window manager or the
1712 // window manager's element itself in case its a direct child of body
1713 $topLevelElement = this.$element.parentsUntil( 'body' ).last();
1714 $topLevelElement = $topLevelElement.length === 0 ? this.$element : $topLevelElement;
1715
1716 // In case previously set by another window manager
1717 this.$element.removeAttr( 'aria-hidden' );
1718
1719 // Hide everything other than the window manager from screen readers
1720 this.$ariaHidden = $( 'body' )
1721 .children()
1722 .not( 'script' )
1723 .not( $topLevelElement )
1724 .attr( 'aria-hidden', true );
1725 }
1726 } else if ( this.$ariaHidden ) {
1727 // Restore screen reader visibility
1728 this.$ariaHidden.removeAttr( 'aria-hidden' );
1729 this.$ariaHidden = null;
1730
1731 // and hide the window manager
1732 this.$element.attr( 'aria-hidden', true );
1733 }
1734
1735 return this;
1736 };
1737
1738 /**
1739 * Destroy the window manager.
1740 *
1741 * Destroying the window manager ensures that it will no longer listen to events. If you would like to
1742 * continue using the window manager, but wish to remove all windows from it, use the #clearWindows method
1743 * instead.
1744 */
1745 OO.ui.WindowManager.prototype.destroy = function () {
1746 this.toggleGlobalEvents( false );
1747 this.toggleAriaIsolation( false );
1748 this.clearWindows();
1749 this.$element.remove();
1750 };
1751
1752 /**
1753 * A window is a container for elements that are in a child frame. They are used with
1754 * a window manager (OO.ui.WindowManager), which is used to open and close the window and control
1755 * its presentation. The size of a window is specified using a symbolic name (e.g., ‘small’, ‘medium’,
1756 * ‘large’), which is interpreted by the window manager. If the requested size is not recognized,
1757 * the window manager will choose a sensible fallback.
1758 *
1759 * The lifecycle of a window has three primary stages (opening, opened, and closing) in which
1760 * different processes are executed:
1761 *
1762 * **opening**: The opening stage begins when the window manager's {@link OO.ui.WindowManager#openWindow
1763 * openWindow} or the window's {@link #open open} methods are used, and the window manager begins to open
1764 * the window.
1765 *
1766 * - {@link #getSetupProcess} method is called and its result executed
1767 * - {@link #getReadyProcess} method is called and its result executed
1768 *
1769 * **opened**: The window is now open
1770 *
1771 * **closing**: The closing stage begins when the window manager's
1772 * {@link OO.ui.WindowManager#closeWindow closeWindow}
1773 * or the window's {@link #close} methods are used, and the window manager begins to close the window.
1774 *
1775 * - {@link #getHoldProcess} method is called and its result executed
1776 * - {@link #getTeardownProcess} method is called and its result executed. The window is now closed
1777 *
1778 * Each of the window's processes (setup, ready, hold, and teardown) can be extended in subclasses
1779 * by overriding the window's #getSetupProcess, #getReadyProcess, #getHoldProcess and #getTeardownProcess
1780 * methods. Note that each {@link OO.ui.Process process} is executed in series, so asynchronous
1781 * processing can complete. Always assume window processes are executed asynchronously.
1782 *
1783 * For more information, please see the [OOUI documentation on MediaWiki] [1].
1784 *
1785 * [1]: https://www.mediawiki.org/wiki/OOUI/Windows
1786 *
1787 * @abstract
1788 * @class
1789 * @extends OO.ui.Element
1790 * @mixins OO.EventEmitter
1791 *
1792 * @constructor
1793 * @param {Object} [config] Configuration options
1794 * @cfg {string} [size] Symbolic name of the dialog size: `small`, `medium`, `large`, `larger` or
1795 * `full`. If omitted, the value of the {@link #static-size static size} property will be used.
1796 */
1797 OO.ui.Window = function OoUiWindow( config ) {
1798 // Configuration initialization
1799 config = config || {};
1800
1801 // Parent constructor
1802 OO.ui.Window.parent.call( this, config );
1803
1804 // Mixin constructors
1805 OO.EventEmitter.call( this );
1806
1807 // Properties
1808 this.manager = null;
1809 this.size = config.size || this.constructor.static.size;
1810 this.$frame = $( '<div>' );
1811 /**
1812 * Overlay element to use for the `$overlay` configuration option of widgets that support it.
1813 * Things put inside of it are overlaid on top of the window and are not bound to its dimensions.
1814 * See <https://www.mediawiki.org/wiki/OOUI/Concepts#Overlays>.
1815 *
1816 * MyDialog.prototype.initialize = function () {
1817 * ...
1818 * var popupButton = new OO.ui.PopupButtonWidget( {
1819 * $overlay: this.$overlay,
1820 * label: 'Popup button',
1821 * popup: {
1822 * $content: $( '<p>Popup contents.</p><p>Popup contents.</p><p>Popup contents.</p>' ),
1823 * padded: true
1824 * }
1825 * } );
1826 * ...
1827 * };
1828 *
1829 * @property {jQuery}
1830 */
1831 this.$overlay = $( '<div>' );
1832 this.$content = $( '<div>' );
1833
1834 this.$focusTrapBefore = $( '<div>' ).prop( 'tabIndex', 0 );
1835 this.$focusTrapAfter = $( '<div>' ).prop( 'tabIndex', 0 );
1836 this.$focusTraps = this.$focusTrapBefore.add( this.$focusTrapAfter );
1837
1838 // Initialization
1839 this.$overlay.addClass( 'oo-ui-window-overlay' );
1840 this.$content
1841 .addClass( 'oo-ui-window-content' )
1842 .attr( 'tabindex', 0 );
1843 this.$frame
1844 .addClass( 'oo-ui-window-frame' )
1845 .append( this.$focusTrapBefore, this.$content, this.$focusTrapAfter );
1846
1847 this.$element
1848 .addClass( 'oo-ui-window' )
1849 .append( this.$frame, this.$overlay );
1850
1851 // Initially hidden - using #toggle may cause errors if subclasses override toggle with methods
1852 // that reference properties not initialized at that time of parent class construction
1853 // TODO: Find a better way to handle post-constructor setup
1854 this.visible = false;
1855 this.$element.addClass( 'oo-ui-element-hidden' );
1856 };
1857
1858 /* Setup */
1859
1860 OO.inheritClass( OO.ui.Window, OO.ui.Element );
1861 OO.mixinClass( OO.ui.Window, OO.EventEmitter );
1862
1863 /* Static Properties */
1864
1865 /**
1866 * Symbolic name of the window size: `small`, `medium`, `large`, `larger` or `full`.
1867 *
1868 * The static size is used if no #size is configured during construction.
1869 *
1870 * @static
1871 * @inheritable
1872 * @property {string}
1873 */
1874 OO.ui.Window.static.size = 'medium';
1875
1876 /* Methods */
1877
1878 /**
1879 * Handle mouse down events.
1880 *
1881 * @private
1882 * @param {jQuery.Event} e Mouse down event
1883 */
1884 OO.ui.Window.prototype.onMouseDown = function ( e ) {
1885 // Prevent clicking on the click-block from stealing focus
1886 if ( e.target === this.$element[ 0 ] ) {
1887 return false;
1888 }
1889 };
1890
1891 /**
1892 * Check if the window has been initialized.
1893 *
1894 * Initialization occurs when a window is added to a manager.
1895 *
1896 * @return {boolean} Window has been initialized
1897 */
1898 OO.ui.Window.prototype.isInitialized = function () {
1899 return !!this.manager;
1900 };
1901
1902 /**
1903 * Check if the window is visible.
1904 *
1905 * @return {boolean} Window is visible
1906 */
1907 OO.ui.Window.prototype.isVisible = function () {
1908 return this.visible;
1909 };
1910
1911 /**
1912 * Check if the window is opening.
1913 *
1914 * This method is a wrapper around the window manager's {@link OO.ui.WindowManager#isOpening isOpening}
1915 * method.
1916 *
1917 * @return {boolean} Window is opening
1918 */
1919 OO.ui.Window.prototype.isOpening = function () {
1920 return this.manager.isOpening( this );
1921 };
1922
1923 /**
1924 * Check if the window is closing.
1925 *
1926 * This method is a wrapper around the window manager's {@link OO.ui.WindowManager#isClosing isClosing} method.
1927 *
1928 * @return {boolean} Window is closing
1929 */
1930 OO.ui.Window.prototype.isClosing = function () {
1931 return this.manager.isClosing( this );
1932 };
1933
1934 /**
1935 * Check if the window is opened.
1936 *
1937 * This method is a wrapper around the window manager's {@link OO.ui.WindowManager#isOpened isOpened} method.
1938 *
1939 * @return {boolean} Window is opened
1940 */
1941 OO.ui.Window.prototype.isOpened = function () {
1942 return this.manager.isOpened( this );
1943 };
1944
1945 /**
1946 * Get the window manager.
1947 *
1948 * All windows must be attached to a window manager, which is used to open
1949 * and close the window and control its presentation.
1950 *
1951 * @return {OO.ui.WindowManager} Manager of window
1952 */
1953 OO.ui.Window.prototype.getManager = function () {
1954 return this.manager;
1955 };
1956
1957 /**
1958 * Get the symbolic name of the window size (e.g., `small` or `medium`).
1959 *
1960 * @return {string} Symbolic name of the size: `small`, `medium`, `large`, `larger`, `full`
1961 */
1962 OO.ui.Window.prototype.getSize = function () {
1963 var viewport = OO.ui.Element.static.getDimensions( this.getElementWindow() ),
1964 sizes = this.manager.constructor.static.sizes,
1965 size = this.size;
1966
1967 if ( !sizes[ size ] ) {
1968 size = this.manager.constructor.static.defaultSize;
1969 }
1970 if ( size !== 'full' && viewport.rect.right - viewport.rect.left < sizes[ size ].width ) {
1971 size = 'full';
1972 }
1973
1974 return size;
1975 };
1976
1977 /**
1978 * Get the size properties associated with the current window size
1979 *
1980 * @return {Object} Size properties
1981 */
1982 OO.ui.Window.prototype.getSizeProperties = function () {
1983 return this.manager.constructor.static.sizes[ this.getSize() ];
1984 };
1985
1986 /**
1987 * Disable transitions on window's frame for the duration of the callback function, then enable them
1988 * back.
1989 *
1990 * @private
1991 * @param {Function} callback Function to call while transitions are disabled
1992 */
1993 OO.ui.Window.prototype.withoutSizeTransitions = function ( callback ) {
1994 // Temporarily resize the frame so getBodyHeight() can use scrollHeight measurements.
1995 // Disable transitions first, otherwise we'll get values from when the window was animating.
1996 // We need to build the transition CSS properties using these specific properties since
1997 // Firefox doesn't return anything useful when asked just for 'transition'.
1998 var oldTransition = this.$frame.css( 'transition-property' ) + ' ' +
1999 this.$frame.css( 'transition-duration' ) + ' ' +
2000 this.$frame.css( 'transition-timing-function' ) + ' ' +
2001 this.$frame.css( 'transition-delay' );
2002
2003 this.$frame.css( 'transition', 'none' );
2004 callback();
2005
2006 // Force reflow to make sure the style changes done inside callback
2007 // really are not transitioned
2008 this.$frame.height();
2009 this.$frame.css( 'transition', oldTransition );
2010 };
2011
2012 /**
2013 * Get the height of the full window contents (i.e., the window head, body and foot together).
2014 *
2015 * What consistitutes the head, body, and foot varies depending on the window type.
2016 * A {@link OO.ui.MessageDialog message dialog} displays a title and message in its body,
2017 * and any actions in the foot. A {@link OO.ui.ProcessDialog process dialog} displays a title
2018 * and special actions in the head, and dialog content in the body.
2019 *
2020 * To get just the height of the dialog body, use the #getBodyHeight method.
2021 *
2022 * @return {number} The height of the window contents (the dialog head, body and foot) in pixels
2023 */
2024 OO.ui.Window.prototype.getContentHeight = function () {
2025 var bodyHeight,
2026 win = this,
2027 bodyStyleObj = this.$body[ 0 ].style,
2028 frameStyleObj = this.$frame[ 0 ].style;
2029
2030 // Temporarily resize the frame so getBodyHeight() can use scrollHeight measurements.
2031 // Disable transitions first, otherwise we'll get values from when the window was animating.
2032 this.withoutSizeTransitions( function () {
2033 var oldHeight = frameStyleObj.height,
2034 oldPosition = bodyStyleObj.position;
2035 frameStyleObj.height = '1px';
2036 // Force body to resize to new width
2037 bodyStyleObj.position = 'relative';
2038 bodyHeight = win.getBodyHeight();
2039 frameStyleObj.height = oldHeight;
2040 bodyStyleObj.position = oldPosition;
2041 } );
2042
2043 return (
2044 // Add buffer for border
2045 ( this.$frame.outerHeight() - this.$frame.innerHeight() ) +
2046 // Use combined heights of children
2047 ( this.$head.outerHeight( true ) + bodyHeight + this.$foot.outerHeight( true ) )
2048 );
2049 };
2050
2051 /**
2052 * Get the height of the window body.
2053 *
2054 * To get the height of the full window contents (the window body, head, and foot together),
2055 * use #getContentHeight.
2056 *
2057 * When this function is called, the window will temporarily have been resized
2058 * to height=1px, so .scrollHeight measurements can be taken accurately.
2059 *
2060 * @return {number} Height of the window body in pixels
2061 */
2062 OO.ui.Window.prototype.getBodyHeight = function () {
2063 return this.$body[ 0 ].scrollHeight;
2064 };
2065
2066 /**
2067 * Get the directionality of the frame (right-to-left or left-to-right).
2068 *
2069 * @return {string} Directionality: `'ltr'` or `'rtl'`
2070 */
2071 OO.ui.Window.prototype.getDir = function () {
2072 return OO.ui.Element.static.getDir( this.$content ) || 'ltr';
2073 };
2074
2075 /**
2076 * Get the 'setup' process.
2077 *
2078 * The setup process is used to set up a window for use in a particular context,
2079 * based on the `data` argument. This method is called during the opening phase of the window’s
2080 * lifecycle.
2081 *
2082 * Override this method to add additional steps to the ‘setup’ process the parent method provides
2083 * using the {@link OO.ui.Process#first first} and {@link OO.ui.Process#next next} methods
2084 * of OO.ui.Process.
2085 *
2086 * To add window content that persists between openings, you may wish to use the #initialize method
2087 * instead.
2088 *
2089 * @param {Object} [data] Window opening data
2090 * @return {OO.ui.Process} Setup process
2091 */
2092 OO.ui.Window.prototype.getSetupProcess = function () {
2093 return new OO.ui.Process();
2094 };
2095
2096 /**
2097 * Get the ‘ready’ process.
2098 *
2099 * The ready process is used to ready a window for use in a particular
2100 * context, based on the `data` argument. This method is called during the opening phase of
2101 * the window’s lifecycle, after the window has been {@link #getSetupProcess setup}.
2102 *
2103 * Override this method to add additional steps to the ‘ready’ process the parent method
2104 * provides using the {@link OO.ui.Process#first first} and {@link OO.ui.Process#next next}
2105 * methods of OO.ui.Process.
2106 *
2107 * @param {Object} [data] Window opening data
2108 * @return {OO.ui.Process} Ready process
2109 */
2110 OO.ui.Window.prototype.getReadyProcess = function () {
2111 return new OO.ui.Process();
2112 };
2113
2114 /**
2115 * Get the 'hold' process.
2116 *
2117 * The hold process is used to keep a window from being used in a particular context,
2118 * based on the `data` argument. This method is called during the closing phase of the window’s
2119 * lifecycle.
2120 *
2121 * Override this method to add additional steps to the 'hold' process the parent method provides
2122 * using the {@link OO.ui.Process#first first} and {@link OO.ui.Process#next next} methods
2123 * of OO.ui.Process.
2124 *
2125 * @param {Object} [data] Window closing data
2126 * @return {OO.ui.Process} Hold process
2127 */
2128 OO.ui.Window.prototype.getHoldProcess = function () {
2129 return new OO.ui.Process();
2130 };
2131
2132 /**
2133 * Get the ‘teardown’ process.
2134 *
2135 * The teardown process is used to teardown a window after use. During teardown,
2136 * user interactions within the window are conveyed and the window is closed, based on the `data`
2137 * argument. This method is called during the closing phase of the window’s lifecycle.
2138 *
2139 * Override this method to add additional steps to the ‘teardown’ process the parent method provides
2140 * using the {@link OO.ui.Process#first first} and {@link OO.ui.Process#next next} methods
2141 * of OO.ui.Process.
2142 *
2143 * @param {Object} [data] Window closing data
2144 * @return {OO.ui.Process} Teardown process
2145 */
2146 OO.ui.Window.prototype.getTeardownProcess = function () {
2147 return new OO.ui.Process();
2148 };
2149
2150 /**
2151 * Set the window manager.
2152 *
2153 * This will cause the window to initialize. Calling it more than once will cause an error.
2154 *
2155 * @param {OO.ui.WindowManager} manager Manager for this window
2156 * @throws {Error} An error is thrown if the method is called more than once
2157 * @chainable
2158 */
2159 OO.ui.Window.prototype.setManager = function ( manager ) {
2160 if ( this.manager ) {
2161 throw new Error( 'Cannot set window manager, window already has a manager' );
2162 }
2163
2164 this.manager = manager;
2165 this.initialize();
2166
2167 return this;
2168 };
2169
2170 /**
2171 * Set the window size by symbolic name (e.g., 'small' or 'medium')
2172 *
2173 * @param {string} size Symbolic name of size: `small`, `medium`, `large`, `larger` or
2174 * `full`
2175 * @chainable
2176 */
2177 OO.ui.Window.prototype.setSize = function ( size ) {
2178 this.size = size;
2179 this.updateSize();
2180 return this;
2181 };
2182
2183 /**
2184 * Update the window size.
2185 *
2186 * @throws {Error} An error is thrown if the window is not attached to a window manager
2187 * @chainable
2188 */
2189 OO.ui.Window.prototype.updateSize = function () {
2190 if ( !this.manager ) {
2191 throw new Error( 'Cannot update window size, must be attached to a manager' );
2192 }
2193
2194 this.manager.updateWindowSize( this );
2195
2196 return this;
2197 };
2198
2199 /**
2200 * Set window dimensions. This method is called by the {@link OO.ui.WindowManager window manager}
2201 * when the window is opening. In general, setDimensions should not be called directly.
2202 *
2203 * To set the size of the window, use the #setSize method.
2204 *
2205 * @param {Object} dim CSS dimension properties
2206 * @param {string|number} [dim.width] Width
2207 * @param {string|number} [dim.minWidth] Minimum width
2208 * @param {string|number} [dim.maxWidth] Maximum width
2209 * @param {string|number} [dim.height] Height, omit to set based on height of contents
2210 * @param {string|number} [dim.minHeight] Minimum height
2211 * @param {string|number} [dim.maxHeight] Maximum height
2212 * @chainable
2213 */
2214 OO.ui.Window.prototype.setDimensions = function ( dim ) {
2215 var height,
2216 win = this,
2217 styleObj = this.$frame[ 0 ].style;
2218
2219 // Calculate the height we need to set using the correct width
2220 if ( dim.height === undefined ) {
2221 this.withoutSizeTransitions( function () {
2222 var oldWidth = styleObj.width;
2223 win.$frame.css( 'width', dim.width || '' );
2224 height = win.getContentHeight();
2225 styleObj.width = oldWidth;
2226 } );
2227 } else {
2228 height = dim.height;
2229 }
2230
2231 this.$frame.css( {
2232 width: dim.width || '',
2233 minWidth: dim.minWidth || '',
2234 maxWidth: dim.maxWidth || '',
2235 height: height || '',
2236 minHeight: dim.minHeight || '',
2237 maxHeight: dim.maxHeight || ''
2238 } );
2239
2240 return this;
2241 };
2242
2243 /**
2244 * Initialize window contents.
2245 *
2246 * Before the window is opened for the first time, #initialize is called so that content that
2247 * persists between openings can be added to the window.
2248 *
2249 * To set up a window with new content each time the window opens, use #getSetupProcess.
2250 *
2251 * @throws {Error} An error is thrown if the window is not attached to a window manager
2252 * @chainable
2253 */
2254 OO.ui.Window.prototype.initialize = function () {
2255 if ( !this.manager ) {
2256 throw new Error( 'Cannot initialize window, must be attached to a manager' );
2257 }
2258
2259 // Properties
2260 this.$head = $( '<div>' );
2261 this.$body = $( '<div>' );
2262 this.$foot = $( '<div>' );
2263 this.$document = $( this.getElementDocument() );
2264
2265 // Events
2266 this.$element.on( 'mousedown', this.onMouseDown.bind( this ) );
2267
2268 // Initialization
2269 this.$head.addClass( 'oo-ui-window-head' );
2270 this.$body.addClass( 'oo-ui-window-body' );
2271 this.$foot.addClass( 'oo-ui-window-foot' );
2272 this.$content.append( this.$head, this.$body, this.$foot );
2273
2274 return this;
2275 };
2276
2277 /**
2278 * Called when someone tries to focus the hidden element at the end of the dialog.
2279 * Sends focus back to the start of the dialog.
2280 *
2281 * @param {jQuery.Event} event Focus event
2282 */
2283 OO.ui.Window.prototype.onFocusTrapFocused = function ( event ) {
2284 var backwards = this.$focusTrapBefore.is( event.target ),
2285 element = OO.ui.findFocusable( this.$content, backwards );
2286 if ( element ) {
2287 // There's a focusable element inside the content, at the front or
2288 // back depending on which focus trap we hit; select it.
2289 element.focus();
2290 } else {
2291 // There's nothing focusable inside the content. As a fallback,
2292 // this.$content is focusable, and focusing it will keep our focus
2293 // properly trapped. It's not a *meaningful* focus, since it's just
2294 // the content-div for the Window, but it's better than letting focus
2295 // escape into the page.
2296 this.$content.focus();
2297 }
2298 };
2299
2300 /**
2301 * Open the window.
2302 *
2303 * This method is a wrapper around a call to the window manager’s {@link OO.ui.WindowManager#openWindow openWindow}
2304 * method, which returns a promise resolved when the window is done opening.
2305 *
2306 * To customize the window each time it opens, use #getSetupProcess or #getReadyProcess.
2307 *
2308 * @param {Object} [data] Window opening data
2309 * @return {jQuery.Promise} Promise resolved with a value when the window is opened, or rejected
2310 * if the window fails to open. When the promise is resolved successfully, the first argument of the
2311 * value is a new promise, which is resolved when the window begins closing.
2312 * @throws {Error} An error is thrown if the window is not attached to a window manager
2313 */
2314 OO.ui.Window.prototype.open = function ( data ) {
2315 if ( !this.manager ) {
2316 throw new Error( 'Cannot open window, must be attached to a manager' );
2317 }
2318
2319 return this.manager.openWindow( this, data );
2320 };
2321
2322 /**
2323 * Close the window.
2324 *
2325 * This method is a wrapper around a call to the window
2326 * manager’s {@link OO.ui.WindowManager#closeWindow closeWindow} method,
2327 * which returns a closing promise resolved when the window is done closing.
2328 *
2329 * The window's #getHoldProcess and #getTeardownProcess methods are called during the closing
2330 * phase of the window’s lifecycle and can be used to specify closing behavior each time
2331 * the window closes.
2332 *
2333 * @param {Object} [data] Window closing data
2334 * @return {jQuery.Promise} Promise resolved when window is closed
2335 * @throws {Error} An error is thrown if the window is not attached to a window manager
2336 */
2337 OO.ui.Window.prototype.close = function ( data ) {
2338 if ( !this.manager ) {
2339 throw new Error( 'Cannot close window, must be attached to a manager' );
2340 }
2341
2342 return this.manager.closeWindow( this, data );
2343 };
2344
2345 /**
2346 * Setup window.
2347 *
2348 * This is called by OO.ui.WindowManager during window opening, and should not be called directly
2349 * by other systems.
2350 *
2351 * @param {Object} [data] Window opening data
2352 * @return {jQuery.Promise} Promise resolved when window is setup
2353 */
2354 OO.ui.Window.prototype.setup = function ( data ) {
2355 var win = this;
2356
2357 this.toggle( true );
2358
2359 this.focusTrapHandler = OO.ui.bind( this.onFocusTrapFocused, this );
2360 this.$focusTraps.on( 'focus', this.focusTrapHandler );
2361
2362 return this.getSetupProcess( data ).execute().then( function () {
2363 // Force redraw by asking the browser to measure the elements' widths
2364 win.$element.addClass( 'oo-ui-window-active oo-ui-window-setup' ).width();
2365 win.$content.addClass( 'oo-ui-window-content-setup' ).width();
2366 } );
2367 };
2368
2369 /**
2370 * Ready window.
2371 *
2372 * This is called by OO.ui.WindowManager during window opening, and should not be called directly
2373 * by other systems.
2374 *
2375 * @param {Object} [data] Window opening data
2376 * @return {jQuery.Promise} Promise resolved when window is ready
2377 */
2378 OO.ui.Window.prototype.ready = function ( data ) {
2379 var win = this;
2380
2381 this.$content.focus();
2382 return this.getReadyProcess( data ).execute().then( function () {
2383 // Force redraw by asking the browser to measure the elements' widths
2384 win.$element.addClass( 'oo-ui-window-ready' ).width();
2385 win.$content.addClass( 'oo-ui-window-content-ready' ).width();
2386 } );
2387 };
2388
2389 /**
2390 * Hold window.
2391 *
2392 * This is called by OO.ui.WindowManager during window closing, and should not be called directly
2393 * by other systems.
2394 *
2395 * @param {Object} [data] Window closing data
2396 * @return {jQuery.Promise} Promise resolved when window is held
2397 */
2398 OO.ui.Window.prototype.hold = function ( data ) {
2399 var win = this;
2400
2401 return this.getHoldProcess( data ).execute().then( function () {
2402 // Get the focused element within the window's content
2403 var $focus = win.$content.find( OO.ui.Element.static.getDocument( win.$content ).activeElement );
2404
2405 // Blur the focused element
2406 if ( $focus.length ) {
2407 $focus[ 0 ].blur();
2408 }
2409
2410 // Force redraw by asking the browser to measure the elements' widths
2411 win.$element.removeClass( 'oo-ui-window-ready' ).width();
2412 win.$content.removeClass( 'oo-ui-window-content-ready' ).width();
2413 } );
2414 };
2415
2416 /**
2417 * Teardown window.
2418 *
2419 * This is called by OO.ui.WindowManager during window closing, and should not be called directly
2420 * by other systems.
2421 *
2422 * @param {Object} [data] Window closing data
2423 * @return {jQuery.Promise} Promise resolved when window is torn down
2424 */
2425 OO.ui.Window.prototype.teardown = function ( data ) {
2426 var win = this;
2427
2428 return this.getTeardownProcess( data ).execute().then( function () {
2429 // Force redraw by asking the browser to measure the elements' widths
2430 win.$element.removeClass( 'oo-ui-window-active oo-ui-window-setup' ).width();
2431 win.$content.removeClass( 'oo-ui-window-content-setup' ).width();
2432 win.$focusTraps.off( 'focus', win.focusTrapHandler );
2433 win.toggle( false );
2434 } );
2435 };
2436
2437 /**
2438 * The Dialog class serves as the base class for the other types of dialogs.
2439 * Unless extended to include controls, the rendered dialog box is a simple window
2440 * that users can close by hitting the ‘Esc’ key. Dialog windows are used with OO.ui.WindowManager,
2441 * which opens, closes, and controls the presentation of the window. See the
2442 * [OOUI documentation on MediaWiki] [1] for more information.
2443 *
2444 * @example
2445 * // A simple dialog window.
2446 * function MyDialog( config ) {
2447 * MyDialog.parent.call( this, config );
2448 * }
2449 * OO.inheritClass( MyDialog, OO.ui.Dialog );
2450 * MyDialog.static.name = 'myDialog';
2451 * MyDialog.prototype.initialize = function () {
2452 * MyDialog.parent.prototype.initialize.call( this );
2453 * this.content = new OO.ui.PanelLayout( { padded: true, expanded: false } );
2454 * this.content.$element.append( '<p>A simple dialog window. Press \'Esc\' to close.</p>' );
2455 * this.$body.append( this.content.$element );
2456 * };
2457 * MyDialog.prototype.getBodyHeight = function () {
2458 * return this.content.$element.outerHeight( true );
2459 * };
2460 * var myDialog = new MyDialog( {
2461 * size: 'medium'
2462 * } );
2463 * // Create and append a window manager, which opens and closes the window.
2464 * var windowManager = new OO.ui.WindowManager();
2465 * $( 'body' ).append( windowManager.$element );
2466 * windowManager.addWindows( [ myDialog ] );
2467 * // Open the window!
2468 * windowManager.openWindow( myDialog );
2469 *
2470 * [1]: https://www.mediawiki.org/wiki/OOUI/Windows/Dialogs
2471 *
2472 * @abstract
2473 * @class
2474 * @extends OO.ui.Window
2475 * @mixins OO.ui.mixin.PendingElement
2476 *
2477 * @constructor
2478 * @param {Object} [config] Configuration options
2479 */
2480 OO.ui.Dialog = function OoUiDialog( config ) {
2481 // Parent constructor
2482 OO.ui.Dialog.parent.call( this, config );
2483
2484 // Mixin constructors
2485 OO.ui.mixin.PendingElement.call( this );
2486
2487 // Properties
2488 this.actions = new OO.ui.ActionSet();
2489 this.attachedActions = [];
2490 this.currentAction = null;
2491 this.onDialogKeyDownHandler = this.onDialogKeyDown.bind( this );
2492
2493 // Events
2494 this.actions.connect( this, {
2495 click: 'onActionClick',
2496 change: 'onActionsChange'
2497 } );
2498
2499 // Initialization
2500 this.$element
2501 .addClass( 'oo-ui-dialog' )
2502 .attr( 'role', 'dialog' );
2503 };
2504
2505 /* Setup */
2506
2507 OO.inheritClass( OO.ui.Dialog, OO.ui.Window );
2508 OO.mixinClass( OO.ui.Dialog, OO.ui.mixin.PendingElement );
2509
2510 /* Static Properties */
2511
2512 /**
2513 * Symbolic name of dialog.
2514 *
2515 * The dialog class must have a symbolic name in order to be registered with OO.Factory.
2516 * Please see the [OOUI documentation on MediaWiki] [3] for more information.
2517 *
2518 * [3]: https://www.mediawiki.org/wiki/OOUI/Windows/Window_managers
2519 *
2520 * @abstract
2521 * @static
2522 * @inheritable
2523 * @property {string}
2524 */
2525 OO.ui.Dialog.static.name = '';
2526
2527 /**
2528 * The dialog title.
2529 *
2530 * The title can be specified as a plaintext string, a {@link OO.ui.mixin.LabelElement Label} node, or a function
2531 * that will produce a Label node or string. The title can also be specified with data passed to the
2532 * constructor (see #getSetupProcess). In this case, the static value will be overridden.
2533 *
2534 * @abstract
2535 * @static
2536 * @inheritable
2537 * @property {jQuery|string|Function}
2538 */
2539 OO.ui.Dialog.static.title = '';
2540
2541 /**
2542 * An array of configured {@link OO.ui.ActionWidget action widgets}.
2543 *
2544 * Actions can also be specified with data passed to the constructor (see #getSetupProcess). In this case, the static
2545 * value will be overridden.
2546 *
2547 * [2]: https://www.mediawiki.org/wiki/OOUI/Windows/Process_Dialogs#Action_sets
2548 *
2549 * @static
2550 * @inheritable
2551 * @property {Object[]}
2552 */
2553 OO.ui.Dialog.static.actions = [];
2554
2555 /**
2556 * Close the dialog when the 'Esc' key is pressed.
2557 *
2558 * @static
2559 * @abstract
2560 * @inheritable
2561 * @property {boolean}
2562 */
2563 OO.ui.Dialog.static.escapable = true;
2564
2565 /* Methods */
2566
2567 /**
2568 * Handle frame document key down events.
2569 *
2570 * @private
2571 * @param {jQuery.Event} e Key down event
2572 */
2573 OO.ui.Dialog.prototype.onDialogKeyDown = function ( e ) {
2574 var actions;
2575 if ( e.which === OO.ui.Keys.ESCAPE && this.constructor.static.escapable ) {
2576 this.executeAction( '' );
2577 e.preventDefault();
2578 e.stopPropagation();
2579 } else if ( e.which === OO.ui.Keys.ENTER && ( e.ctrlKey || e.metaKey ) ) {
2580 actions = this.actions.get( { flags: 'primary', visible: true, disabled: false } );
2581 if ( actions.length > 0 ) {
2582 this.executeAction( actions[ 0 ].getAction() );
2583 e.preventDefault();
2584 e.stopPropagation();
2585 }
2586 }
2587 };
2588
2589 /**
2590 * Handle action click events.
2591 *
2592 * @private
2593 * @param {OO.ui.ActionWidget} action Action that was clicked
2594 */
2595 OO.ui.Dialog.prototype.onActionClick = function ( action ) {
2596 if ( !this.isPending() ) {
2597 this.executeAction( action.getAction() );
2598 }
2599 };
2600
2601 /**
2602 * Handle actions change event.
2603 *
2604 * @private
2605 */
2606 OO.ui.Dialog.prototype.onActionsChange = function () {
2607 this.detachActions();
2608 if ( !this.isClosing() ) {
2609 this.attachActions();
2610 if ( !this.isOpening() ) {
2611 // If the dialog is currently opening, this will be called automatically soon.
2612 this.updateSize();
2613 }
2614 }
2615 };
2616
2617 /**
2618 * Get the set of actions used by the dialog.
2619 *
2620 * @return {OO.ui.ActionSet}
2621 */
2622 OO.ui.Dialog.prototype.getActions = function () {
2623 return this.actions;
2624 };
2625
2626 /**
2627 * Get a process for taking action.
2628 *
2629 * When you override this method, you can create a new OO.ui.Process and return it, or add additional
2630 * accept steps to the process the parent method provides using the {@link OO.ui.Process#first 'first'}
2631 * and {@link OO.ui.Process#next 'next'} methods of OO.ui.Process.
2632 *
2633 * @param {string} [action] Symbolic name of action
2634 * @return {OO.ui.Process} Action process
2635 */
2636 OO.ui.Dialog.prototype.getActionProcess = function ( action ) {
2637 return new OO.ui.Process()
2638 .next( function () {
2639 if ( !action ) {
2640 // An empty action always closes the dialog without data, which should always be
2641 // safe and make no changes
2642 this.close();
2643 }
2644 }, this );
2645 };
2646
2647 /**
2648 * @inheritdoc
2649 *
2650 * @param {Object} [data] Dialog opening data
2651 * @param {jQuery|string|Function|null} [data.title] Dialog title, omit to use
2652 * the {@link #static-title static title}
2653 * @param {Object[]} [data.actions] List of configuration options for each
2654 * {@link OO.ui.ActionWidget action widget}, omit to use {@link #static-actions static actions}.
2655 */
2656 OO.ui.Dialog.prototype.getSetupProcess = function ( data ) {
2657 data = data || {};
2658
2659 // Parent method
2660 return OO.ui.Dialog.parent.prototype.getSetupProcess.call( this, data )
2661 .next( function () {
2662 var config = this.constructor.static,
2663 actions = data.actions !== undefined ? data.actions : config.actions,
2664 title = data.title !== undefined ? data.title : config.title;
2665
2666 this.title.setLabel( title ).setTitle( title );
2667 this.actions.add( this.getActionWidgets( actions ) );
2668
2669 this.$element.on( 'keydown', this.onDialogKeyDownHandler );
2670 }, this );
2671 };
2672
2673 /**
2674 * @inheritdoc
2675 */
2676 OO.ui.Dialog.prototype.getTeardownProcess = function ( data ) {
2677 // Parent method
2678 return OO.ui.Dialog.parent.prototype.getTeardownProcess.call( this, data )
2679 .first( function () {
2680 this.$element.off( 'keydown', this.onDialogKeyDownHandler );
2681
2682 this.actions.clear();
2683 this.currentAction = null;
2684 }, this );
2685 };
2686
2687 /**
2688 * @inheritdoc
2689 */
2690 OO.ui.Dialog.prototype.initialize = function () {
2691 // Parent method
2692 OO.ui.Dialog.parent.prototype.initialize.call( this );
2693
2694 // Properties
2695 this.title = new OO.ui.LabelWidget();
2696
2697 // Initialization
2698 this.$content.addClass( 'oo-ui-dialog-content' );
2699 this.$element.attr( 'aria-labelledby', this.title.getElementId() );
2700 this.setPendingElement( this.$head );
2701 };
2702
2703 /**
2704 * Get action widgets from a list of configs
2705 *
2706 * @param {Object[]} actions Action widget configs
2707 * @return {OO.ui.ActionWidget[]} Action widgets
2708 */
2709 OO.ui.Dialog.prototype.getActionWidgets = function ( actions ) {
2710 var i, len, widgets = [];
2711 for ( i = 0, len = actions.length; i < len; i++ ) {
2712 widgets.push(
2713 new OO.ui.ActionWidget( actions[ i ] )
2714 );
2715 }
2716 return widgets;
2717 };
2718
2719 /**
2720 * Attach action actions.
2721 *
2722 * @protected
2723 */
2724 OO.ui.Dialog.prototype.attachActions = function () {
2725 // Remember the list of potentially attached actions
2726 this.attachedActions = this.actions.get();
2727 };
2728
2729 /**
2730 * Detach action actions.
2731 *
2732 * @protected
2733 * @chainable
2734 */
2735 OO.ui.Dialog.prototype.detachActions = function () {
2736 var i, len;
2737
2738 // Detach all actions that may have been previously attached
2739 for ( i = 0, len = this.attachedActions.length; i < len; i++ ) {
2740 this.attachedActions[ i ].$element.detach();
2741 }
2742 this.attachedActions = [];
2743 };
2744
2745 /**
2746 * Execute an action.
2747 *
2748 * @param {string} action Symbolic name of action to execute
2749 * @return {jQuery.Promise} Promise resolved when action completes, rejected if it fails
2750 */
2751 OO.ui.Dialog.prototype.executeAction = function ( action ) {
2752 this.pushPending();
2753 this.currentAction = action;
2754 return this.getActionProcess( action ).execute()
2755 .always( this.popPending.bind( this ) );
2756 };
2757
2758 /**
2759 * MessageDialogs display a confirmation or alert message. By default, the rendered dialog box
2760 * consists of a header that contains the dialog title, a body with the message, and a footer that
2761 * contains any {@link OO.ui.ActionWidget action widgets}. The MessageDialog class is the only type
2762 * of {@link OO.ui.Dialog dialog} that is usually instantiated directly.
2763 *
2764 * There are two basic types of message dialogs, confirmation and alert:
2765 *
2766 * - **confirmation**: the dialog title describes what a progressive action will do and the message provides
2767 * more details about the consequences.
2768 * - **alert**: the dialog title describes which event occurred and the message provides more information
2769 * about why the event occurred.
2770 *
2771 * The MessageDialog class specifies two actions: ‘accept’, the primary
2772 * action (e.g., ‘ok’) and ‘reject,’ the safe action (e.g., ‘cancel’). Both will close the window,
2773 * passing along the selected action.
2774 *
2775 * For more information and examples, please see the [OOUI documentation on MediaWiki][1].
2776 *
2777 * @example
2778 * // Example: Creating and opening a message dialog window.
2779 * var messageDialog = new OO.ui.MessageDialog();
2780 *
2781 * // Create and append a window manager.
2782 * var windowManager = new OO.ui.WindowManager();
2783 * $( 'body' ).append( windowManager.$element );
2784 * windowManager.addWindows( [ messageDialog ] );
2785 * // Open the window.
2786 * windowManager.openWindow( messageDialog, {
2787 * title: 'Basic message dialog',
2788 * message: 'This is the message'
2789 * } );
2790 *
2791 * [1]: https://www.mediawiki.org/wiki/OOUI/Windows/Message_Dialogs
2792 *
2793 * @class
2794 * @extends OO.ui.Dialog
2795 *
2796 * @constructor
2797 * @param {Object} [config] Configuration options
2798 */
2799 OO.ui.MessageDialog = function OoUiMessageDialog( config ) {
2800 // Parent constructor
2801 OO.ui.MessageDialog.parent.call( this, config );
2802
2803 // Properties
2804 this.verticalActionLayout = null;
2805
2806 // Initialization
2807 this.$element.addClass( 'oo-ui-messageDialog' );
2808 };
2809
2810 /* Setup */
2811
2812 OO.inheritClass( OO.ui.MessageDialog, OO.ui.Dialog );
2813
2814 /* Static Properties */
2815
2816 /**
2817 * @static
2818 * @inheritdoc
2819 */
2820 OO.ui.MessageDialog.static.name = 'message';
2821
2822 /**
2823 * @static
2824 * @inheritdoc
2825 */
2826 OO.ui.MessageDialog.static.size = 'small';
2827
2828 /**
2829 * Dialog title.
2830 *
2831 * The title of a confirmation dialog describes what a progressive action will do. The
2832 * title of an alert dialog describes which event occurred.
2833 *
2834 * @static
2835 * @inheritable
2836 * @property {jQuery|string|Function|null}
2837 */
2838 OO.ui.MessageDialog.static.title = null;
2839
2840 /**
2841 * The message displayed in the dialog body.
2842 *
2843 * A confirmation message describes the consequences of a progressive action. An alert
2844 * message describes why an event occurred.
2845 *
2846 * @static
2847 * @inheritable
2848 * @property {jQuery|string|Function|null}
2849 */
2850 OO.ui.MessageDialog.static.message = null;
2851
2852 /**
2853 * @static
2854 * @inheritdoc
2855 */
2856 OO.ui.MessageDialog.static.actions = [
2857 // Note that OO.ui.alert() and OO.ui.confirm() rely on these.
2858 { action: 'accept', label: OO.ui.deferMsg( 'ooui-dialog-message-accept' ), flags: 'primary' },
2859 { action: 'reject', label: OO.ui.deferMsg( 'ooui-dialog-message-reject' ), flags: 'safe' }
2860 ];
2861
2862 /* Methods */
2863
2864 /**
2865 * Toggle action layout between vertical and horizontal.
2866 *
2867 * @private
2868 * @param {boolean} [value] Layout actions vertically, omit to toggle
2869 * @chainable
2870 */
2871 OO.ui.MessageDialog.prototype.toggleVerticalActionLayout = function ( value ) {
2872 value = value === undefined ? !this.verticalActionLayout : !!value;
2873
2874 if ( value !== this.verticalActionLayout ) {
2875 this.verticalActionLayout = value;
2876 this.$actions
2877 .toggleClass( 'oo-ui-messageDialog-actions-vertical', value )
2878 .toggleClass( 'oo-ui-messageDialog-actions-horizontal', !value );
2879 }
2880
2881 return this;
2882 };
2883
2884 /**
2885 * @inheritdoc
2886 */
2887 OO.ui.MessageDialog.prototype.getActionProcess = function ( action ) {
2888 if ( action ) {
2889 return new OO.ui.Process( function () {
2890 this.close( { action: action } );
2891 }, this );
2892 }
2893 return OO.ui.MessageDialog.parent.prototype.getActionProcess.call( this, action );
2894 };
2895
2896 /**
2897 * @inheritdoc
2898 *
2899 * @param {Object} [data] Dialog opening data
2900 * @param {jQuery|string|Function|null} [data.title] Description of the action being confirmed
2901 * @param {jQuery|string|Function|null} [data.message] Description of the action's consequence
2902 * @param {string} [data.size] Symbolic name of the dialog size, see OO.ui.Window
2903 * @param {Object[]} [data.actions] List of OO.ui.ActionOptionWidget configuration options for each
2904 * action item
2905 */
2906 OO.ui.MessageDialog.prototype.getSetupProcess = function ( data ) {
2907 data = data || {};
2908
2909 // Parent method
2910 return OO.ui.MessageDialog.parent.prototype.getSetupProcess.call( this, data )
2911 .next( function () {
2912 this.title.setLabel(
2913 data.title !== undefined ? data.title : this.constructor.static.title
2914 );
2915 this.message.setLabel(
2916 data.message !== undefined ? data.message : this.constructor.static.message
2917 );
2918 this.size = data.size !== undefined ? data.size : this.constructor.static.size;
2919 }, this );
2920 };
2921
2922 /**
2923 * @inheritdoc
2924 */
2925 OO.ui.MessageDialog.prototype.getReadyProcess = function ( data ) {
2926 data = data || {};
2927
2928 // Parent method
2929 return OO.ui.MessageDialog.parent.prototype.getReadyProcess.call( this, data )
2930 .next( function () {
2931 // Focus the primary action button
2932 var actions = this.actions.get();
2933 actions = actions.filter( function ( action ) {
2934 return action.getFlags().indexOf( 'primary' ) > -1;
2935 } );
2936 if ( actions.length > 0 ) {
2937 actions[ 0 ].focus();
2938 }
2939 }, this );
2940 };
2941
2942 /**
2943 * @inheritdoc
2944 */
2945 OO.ui.MessageDialog.prototype.getBodyHeight = function () {
2946 var bodyHeight, oldOverflow,
2947 $scrollable = this.container.$element;
2948
2949 oldOverflow = $scrollable[ 0 ].style.overflow;
2950 $scrollable[ 0 ].style.overflow = 'hidden';
2951
2952 OO.ui.Element.static.reconsiderScrollbars( $scrollable[ 0 ] );
2953
2954 bodyHeight = this.text.$element.outerHeight( true );
2955 $scrollable[ 0 ].style.overflow = oldOverflow;
2956
2957 return bodyHeight;
2958 };
2959
2960 /**
2961 * @inheritdoc
2962 */
2963 OO.ui.MessageDialog.prototype.setDimensions = function ( dim ) {
2964 var
2965 dialog = this,
2966 $scrollable = this.container.$element;
2967 OO.ui.MessageDialog.parent.prototype.setDimensions.call( this, dim );
2968
2969 // Twiddle the overflow property, otherwise an unnecessary scrollbar will be produced.
2970 // Need to do it after transition completes (250ms), add 50ms just in case.
2971 setTimeout( function () {
2972 var oldOverflow = $scrollable[ 0 ].style.overflow,
2973 activeElement = document.activeElement;
2974
2975 $scrollable[ 0 ].style.overflow = 'hidden';
2976
2977 OO.ui.Element.static.reconsiderScrollbars( $scrollable[ 0 ] );
2978
2979 // Check reconsiderScrollbars didn't destroy our focus, as we
2980 // are doing this after the ready process.
2981 if ( activeElement && activeElement !== document.activeElement && activeElement.focus ) {
2982 activeElement.focus();
2983 }
2984
2985 $scrollable[ 0 ].style.overflow = oldOverflow;
2986 }, 300 );
2987
2988 dialog.fitActions();
2989 // Wait for CSS transition to finish and do it again :(
2990 setTimeout( function () {
2991 dialog.fitActions();
2992 }, 300 );
2993
2994 return this;
2995 };
2996
2997 /**
2998 * @inheritdoc
2999 */
3000 OO.ui.MessageDialog.prototype.initialize = function () {
3001 // Parent method
3002 OO.ui.MessageDialog.parent.prototype.initialize.call( this );
3003
3004 // Properties
3005 this.$actions = $( '<div>' );
3006 this.container = new OO.ui.PanelLayout( {
3007 scrollable: true, classes: [ 'oo-ui-messageDialog-container' ]
3008 } );
3009 this.text = new OO.ui.PanelLayout( {
3010 padded: true, expanded: false, classes: [ 'oo-ui-messageDialog-text' ]
3011 } );
3012 this.message = new OO.ui.LabelWidget( {
3013 classes: [ 'oo-ui-messageDialog-message' ]
3014 } );
3015
3016 // Initialization
3017 this.title.$element.addClass( 'oo-ui-messageDialog-title' );
3018 this.$content.addClass( 'oo-ui-messageDialog-content' );
3019 this.container.$element.append( this.text.$element );
3020 this.text.$element.append( this.title.$element, this.message.$element );
3021 this.$body.append( this.container.$element );
3022 this.$actions.addClass( 'oo-ui-messageDialog-actions' );
3023 this.$foot.append( this.$actions );
3024 };
3025
3026 /**
3027 * @inheritdoc
3028 */
3029 OO.ui.MessageDialog.prototype.attachActions = function () {
3030 var i, len, other, special, others;
3031
3032 // Parent method
3033 OO.ui.MessageDialog.parent.prototype.attachActions.call( this );
3034
3035 special = this.actions.getSpecial();
3036 others = this.actions.getOthers();
3037
3038 if ( special.safe ) {
3039 this.$actions.append( special.safe.$element );
3040 special.safe.toggleFramed( false );
3041 }
3042 if ( others.length ) {
3043 for ( i = 0, len = others.length; i < len; i++ ) {
3044 other = others[ i ];
3045 this.$actions.append( other.$element );
3046 other.toggleFramed( false );
3047 }
3048 }
3049 if ( special.primary ) {
3050 this.$actions.append( special.primary.$element );
3051 special.primary.toggleFramed( false );
3052 }
3053 };
3054
3055 /**
3056 * Fit action actions into columns or rows.
3057 *
3058 * Columns will be used if all labels can fit without overflow, otherwise rows will be used.
3059 *
3060 * @private
3061 */
3062 OO.ui.MessageDialog.prototype.fitActions = function () {
3063 var i, len, action,
3064 previous = this.verticalActionLayout,
3065 actions = this.actions.get();
3066
3067 // Detect clipping
3068 this.toggleVerticalActionLayout( false );
3069 for ( i = 0, len = actions.length; i < len; i++ ) {
3070 action = actions[ i ];
3071 if ( action.$element.innerWidth() < action.$label.outerWidth( true ) ) {
3072 this.toggleVerticalActionLayout( true );
3073 break;
3074 }
3075 }
3076
3077 // Move the body out of the way of the foot
3078 this.$body.css( 'bottom', this.$foot.outerHeight( true ) );
3079
3080 if ( this.verticalActionLayout !== previous ) {
3081 // We changed the layout, window height might need to be updated.
3082 this.updateSize();
3083 }
3084 };
3085
3086 /**
3087 * ProcessDialog windows encapsulate a {@link OO.ui.Process process} and all of the code necessary
3088 * to complete it. If the process terminates with an error, a customizable {@link OO.ui.Error error
3089 * interface} alerts users to the trouble, permitting the user to dismiss the error and try again when
3090 * relevant. The ProcessDialog class is always extended and customized with the actions and content
3091 * required for each process.
3092 *
3093 * The process dialog box consists of a header that visually represents the ‘working’ state of long
3094 * processes with an animation. The header contains the dialog title as well as
3095 * two {@link OO.ui.ActionWidget action widgets}: a ‘safe’ action on the left (e.g., ‘Cancel’) and
3096 * a ‘primary’ action on the right (e.g., ‘Done’).
3097 *
3098 * Like other windows, the process dialog is managed by a {@link OO.ui.WindowManager window manager}.
3099 * Please see the [OOUI documentation on MediaWiki][1] for more information and examples.
3100 *
3101 * @example
3102 * // Example: Creating and opening a process dialog window.
3103 * function MyProcessDialog( config ) {
3104 * MyProcessDialog.parent.call( this, config );
3105 * }
3106 * OO.inheritClass( MyProcessDialog, OO.ui.ProcessDialog );
3107 *
3108 * MyProcessDialog.static.name = 'myProcessDialog';
3109 * MyProcessDialog.static.title = 'Process dialog';
3110 * MyProcessDialog.static.actions = [
3111 * { action: 'save', label: 'Done', flags: 'primary' },
3112 * { label: 'Cancel', flags: 'safe' }
3113 * ];
3114 *
3115 * MyProcessDialog.prototype.initialize = function () {
3116 * MyProcessDialog.parent.prototype.initialize.apply( this, arguments );
3117 * this.content = new OO.ui.PanelLayout( { padded: true, expanded: false } );
3118 * this.content.$element.append( '<p>This is a process dialog window. The header contains the title and two buttons: \'Cancel\' (a safe action) on the left and \'Done\' (a primary action) on the right.</p>' );
3119 * this.$body.append( this.content.$element );
3120 * };
3121 * MyProcessDialog.prototype.getActionProcess = function ( action ) {
3122 * var dialog = this;
3123 * if ( action ) {
3124 * return new OO.ui.Process( function () {
3125 * dialog.close( { action: action } );
3126 * } );
3127 * }
3128 * return MyProcessDialog.parent.prototype.getActionProcess.call( this, action );
3129 * };
3130 *
3131 * var windowManager = new OO.ui.WindowManager();
3132 * $( 'body' ).append( windowManager.$element );
3133 *
3134 * var dialog = new MyProcessDialog();
3135 * windowManager.addWindows( [ dialog ] );
3136 * windowManager.openWindow( dialog );
3137 *
3138 * [1]: https://www.mediawiki.org/wiki/OOUI/Windows/Process_Dialogs
3139 *
3140 * @abstract
3141 * @class
3142 * @extends OO.ui.Dialog
3143 *
3144 * @constructor
3145 * @param {Object} [config] Configuration options
3146 */
3147 OO.ui.ProcessDialog = function OoUiProcessDialog( config ) {
3148 // Parent constructor
3149 OO.ui.ProcessDialog.parent.call( this, config );
3150
3151 // Properties
3152 this.fitOnOpen = false;
3153
3154 // Initialization
3155 this.$element.addClass( 'oo-ui-processDialog' );
3156 };
3157
3158 /* Setup */
3159
3160 OO.inheritClass( OO.ui.ProcessDialog, OO.ui.Dialog );
3161
3162 /* Methods */
3163
3164 /**
3165 * Handle dismiss button click events.
3166 *
3167 * Hides errors.
3168 *
3169 * @private
3170 */
3171 OO.ui.ProcessDialog.prototype.onDismissErrorButtonClick = function () {
3172 this.hideErrors();
3173 };
3174
3175 /**
3176 * Handle retry button click events.
3177 *
3178 * Hides errors and then tries again.
3179 *
3180 * @private
3181 */
3182 OO.ui.ProcessDialog.prototype.onRetryButtonClick = function () {
3183 this.hideErrors();
3184 this.executeAction( this.currentAction );
3185 };
3186
3187 /**
3188 * @inheritdoc
3189 */
3190 OO.ui.ProcessDialog.prototype.initialize = function () {
3191 // Parent method
3192 OO.ui.ProcessDialog.parent.prototype.initialize.call( this );
3193
3194 // Properties
3195 this.$navigation = $( '<div>' );
3196 this.$location = $( '<div>' );
3197 this.$safeActions = $( '<div>' );
3198 this.$primaryActions = $( '<div>' );
3199 this.$otherActions = $( '<div>' );
3200 this.dismissButton = new OO.ui.ButtonWidget( {
3201 label: OO.ui.msg( 'ooui-dialog-process-dismiss' )
3202 } );
3203 this.retryButton = new OO.ui.ButtonWidget();
3204 this.$errors = $( '<div>' );
3205 this.$errorsTitle = $( '<div>' );
3206
3207 // Events
3208 this.dismissButton.connect( this, { click: 'onDismissErrorButtonClick' } );
3209 this.retryButton.connect( this, { click: 'onRetryButtonClick' } );
3210
3211 // Initialization
3212 this.title.$element.addClass( 'oo-ui-processDialog-title' );
3213 this.$location
3214 .append( this.title.$element )
3215 .addClass( 'oo-ui-processDialog-location' );
3216 this.$safeActions.addClass( 'oo-ui-processDialog-actions-safe' );
3217 this.$primaryActions.addClass( 'oo-ui-processDialog-actions-primary' );
3218 this.$otherActions.addClass( 'oo-ui-processDialog-actions-other' );
3219 this.$errorsTitle
3220 .addClass( 'oo-ui-processDialog-errors-title' )
3221 .text( OO.ui.msg( 'ooui-dialog-process-error' ) );
3222 this.$errors
3223 .addClass( 'oo-ui-processDialog-errors oo-ui-element-hidden' )
3224 .append( this.$errorsTitle, this.dismissButton.$element, this.retryButton.$element );
3225 this.$content
3226 .addClass( 'oo-ui-processDialog-content' )
3227 .append( this.$errors );
3228 this.$navigation
3229 .addClass( 'oo-ui-processDialog-navigation' )
3230 // Note: Order of appends below is important. These are in the order
3231 // we want tab to go through them. Display-order is handled entirely
3232 // by CSS absolute-positioning. As such, primary actions like "done"
3233 // should go first.
3234 .append( this.$primaryActions, this.$location, this.$safeActions );
3235 this.$head.append( this.$navigation );
3236 this.$foot.append( this.$otherActions );
3237 };
3238
3239 /**
3240 * @inheritdoc
3241 */
3242 OO.ui.ProcessDialog.prototype.getActionWidgets = function ( actions ) {
3243 var i, len, config,
3244 isMobile = OO.ui.isMobile(),
3245 widgets = [];
3246
3247 for ( i = 0, len = actions.length; i < len; i++ ) {
3248 config = $.extend( { framed: !OO.ui.isMobile() }, actions[ i ] );
3249 if ( isMobile &&
3250 ( config.flags === 'back' || ( Array.isArray( config.flags ) && config.flags.indexOf( 'back' ) !== -1 ) )
3251 ) {
3252 $.extend( config, {
3253 icon: 'previous',
3254 label: ''
3255 } );
3256 }
3257 widgets.push(
3258 new OO.ui.ActionWidget( config )
3259 );
3260 }
3261 return widgets;
3262 };
3263
3264 /**
3265 * @inheritdoc
3266 */
3267 OO.ui.ProcessDialog.prototype.attachActions = function () {
3268 var i, len, other, special, others;
3269
3270 // Parent method
3271 OO.ui.ProcessDialog.parent.prototype.attachActions.call( this );
3272
3273 special = this.actions.getSpecial();
3274 others = this.actions.getOthers();
3275 if ( special.primary ) {
3276 this.$primaryActions.append( special.primary.$element );
3277 }
3278 for ( i = 0, len = others.length; i < len; i++ ) {
3279 other = others[ i ];
3280 this.$otherActions.append( other.$element );
3281 }
3282 if ( special.safe ) {
3283 this.$safeActions.append( special.safe.$element );
3284 }
3285 };
3286
3287 /**
3288 * @inheritdoc
3289 */
3290 OO.ui.ProcessDialog.prototype.executeAction = function ( action ) {
3291 var process = this;
3292 return OO.ui.ProcessDialog.parent.prototype.executeAction.call( this, action )
3293 .fail( function ( errors ) {
3294 process.showErrors( errors || [] );
3295 } );
3296 };
3297
3298 /**
3299 * @inheritdoc
3300 */
3301 OO.ui.ProcessDialog.prototype.setDimensions = function () {
3302 var dialog = this;
3303
3304 // Parent method
3305 OO.ui.ProcessDialog.parent.prototype.setDimensions.apply( this, arguments );
3306
3307 this.fitLabel();
3308
3309 // If there are many actions, they might be shown on multiple lines. Their layout can change when
3310 // resizing the dialog and when changing the actions. Adjust the height of the footer to fit them.
3311 dialog.$body.css( 'bottom', dialog.$foot.outerHeight( true ) );
3312 // Wait for CSS transition to finish and do it again :(
3313 setTimeout( function () {
3314 dialog.$body.css( 'bottom', dialog.$foot.outerHeight( true ) );
3315 }, 300 );
3316 };
3317
3318 /**
3319 * Fit label between actions.
3320 *
3321 * @private
3322 * @chainable
3323 */
3324 OO.ui.ProcessDialog.prototype.fitLabel = function () {
3325 var safeWidth, primaryWidth, biggerWidth, labelWidth, navigationWidth, leftWidth, rightWidth,
3326 size = this.getSizeProperties();
3327
3328 if ( typeof size.width !== 'number' ) {
3329 if ( this.isOpened() ) {
3330 navigationWidth = this.$head.width() - 20;
3331 } else if ( this.isOpening() ) {
3332 if ( !this.fitOnOpen ) {
3333 // Size is relative and the dialog isn't open yet, so wait.
3334 // FIXME: This should ideally be handled by setup somehow.
3335 this.manager.lifecycle.opened.done( this.fitLabel.bind( this ) );
3336 this.fitOnOpen = true;
3337 }
3338 return;
3339 } else {
3340 return;
3341 }
3342 } else {
3343 navigationWidth = size.width - 20;
3344 }
3345
3346 safeWidth = this.$safeActions.is( ':visible' ) ? this.$safeActions.width() : 0;
3347 primaryWidth = this.$primaryActions.is( ':visible' ) ? this.$primaryActions.width() : 0;
3348 biggerWidth = Math.max( safeWidth, primaryWidth );
3349
3350 labelWidth = this.title.$element.width();
3351
3352 if ( 2 * biggerWidth + labelWidth < navigationWidth ) {
3353 // We have enough space to center the label
3354 leftWidth = rightWidth = biggerWidth;
3355 } else {
3356 // Let's hope we at least have enough space not to overlap, because we can't wrap the label…
3357 if ( this.getDir() === 'ltr' ) {
3358 leftWidth = safeWidth;
3359 rightWidth = primaryWidth;
3360 } else {
3361 leftWidth = primaryWidth;
3362 rightWidth = safeWidth;
3363 }
3364 }
3365
3366 this.$location.css( { paddingLeft: leftWidth, paddingRight: rightWidth } );
3367
3368 return this;
3369 };
3370
3371 /**
3372 * Handle errors that occurred during accept or reject processes.
3373 *
3374 * @private
3375 * @param {OO.ui.Error[]|OO.ui.Error} errors Errors to be handled
3376 */
3377 OO.ui.ProcessDialog.prototype.showErrors = function ( errors ) {
3378 var i, len, $item, actions,
3379 items = [],
3380 abilities = {},
3381 recoverable = true,
3382 warning = false;
3383
3384 if ( errors instanceof OO.ui.Error ) {
3385 errors = [ errors ];
3386 }
3387
3388 for ( i = 0, len = errors.length; i < len; i++ ) {
3389 if ( !errors[ i ].isRecoverable() ) {
3390 recoverable = false;
3391 }
3392 if ( errors[ i ].isWarning() ) {
3393 warning = true;
3394 }
3395 $item = $( '<div>' )
3396 .addClass( 'oo-ui-processDialog-error' )
3397 .append( errors[ i ].getMessage() );
3398 items.push( $item[ 0 ] );
3399 }
3400 this.$errorItems = $( items );
3401 if ( recoverable ) {
3402 abilities[ this.currentAction ] = true;
3403 // Copy the flags from the first matching action
3404 actions = this.actions.get( { actions: this.currentAction } );
3405 if ( actions.length ) {
3406 this.retryButton.clearFlags().setFlags( actions[ 0 ].getFlags() );
3407 }
3408 } else {
3409 abilities[ this.currentAction ] = false;
3410 this.actions.setAbilities( abilities );
3411 }
3412 if ( warning ) {
3413 this.retryButton.setLabel( OO.ui.msg( 'ooui-dialog-process-continue' ) );
3414 } else {
3415 this.retryButton.setLabel( OO.ui.msg( 'ooui-dialog-process-retry' ) );
3416 }
3417 this.retryButton.toggle( recoverable );
3418 this.$errorsTitle.after( this.$errorItems );
3419 this.$errors.removeClass( 'oo-ui-element-hidden' ).scrollTop( 0 );
3420 };
3421
3422 /**
3423 * Hide errors.
3424 *
3425 * @private
3426 */
3427 OO.ui.ProcessDialog.prototype.hideErrors = function () {
3428 this.$errors.addClass( 'oo-ui-element-hidden' );
3429 if ( this.$errorItems ) {
3430 this.$errorItems.remove();
3431 this.$errorItems = null;
3432 }
3433 };
3434
3435 /**
3436 * @inheritdoc
3437 */
3438 OO.ui.ProcessDialog.prototype.getTeardownProcess = function ( data ) {
3439 // Parent method
3440 return OO.ui.ProcessDialog.parent.prototype.getTeardownProcess.call( this, data )
3441 .first( function () {
3442 // Make sure to hide errors
3443 this.hideErrors();
3444 this.fitOnOpen = false;
3445 }, this );
3446 };
3447
3448 /**
3449 * @class OO.ui
3450 */
3451
3452 /**
3453 * Lazy-initialize and return a global OO.ui.WindowManager instance, used by OO.ui.alert and
3454 * OO.ui.confirm.
3455 *
3456 * @private
3457 * @return {OO.ui.WindowManager}
3458 */
3459 OO.ui.getWindowManager = function () {
3460 if ( !OO.ui.windowManager ) {
3461 OO.ui.windowManager = new OO.ui.WindowManager();
3462 $( 'body' ).append( OO.ui.windowManager.$element );
3463 OO.ui.windowManager.addWindows( [ new OO.ui.MessageDialog() ] );
3464 }
3465 return OO.ui.windowManager;
3466 };
3467
3468 /**
3469 * Display a quick modal alert dialog, using a OO.ui.MessageDialog. While the dialog is open, the
3470 * rest of the page will be dimmed out and the user won't be able to interact with it. The dialog
3471 * has only one action button, labelled "OK", clicking it will simply close the dialog.
3472 *
3473 * A window manager is created automatically when this function is called for the first time.
3474 *
3475 * @example
3476 * OO.ui.alert( 'Something happened!' ).done( function () {
3477 * console.log( 'User closed the dialog.' );
3478 * } );
3479 *
3480 * OO.ui.alert( 'Something larger happened!', { size: 'large' } );
3481 *
3482 * @param {jQuery|string} text Message text to display
3483 * @param {Object} [options] Additional options, see OO.ui.MessageDialog#getSetupProcess
3484 * @return {jQuery.Promise} Promise resolved when the user closes the dialog
3485 */
3486 OO.ui.alert = function ( text, options ) {
3487 return OO.ui.getWindowManager().openWindow( 'message', $.extend( {
3488 message: text,
3489 actions: [ OO.ui.MessageDialog.static.actions[ 0 ] ]
3490 }, options ) ).closed.then( function () {
3491 return undefined;
3492 } );
3493 };
3494
3495 /**
3496 * Display a quick modal confirmation dialog, using a OO.ui.MessageDialog. While the dialog is open,
3497 * the rest of the page will be dimmed out and the user won't be able to interact with it. The
3498 * dialog has two action buttons, one to confirm an operation (labelled "OK") and one to cancel it
3499 * (labelled "Cancel").
3500 *
3501 * A window manager is created automatically when this function is called for the first time.
3502 *
3503 * @example
3504 * OO.ui.confirm( 'Are you sure?' ).done( function ( confirmed ) {
3505 * if ( confirmed ) {
3506 * console.log( 'User clicked "OK"!' );
3507 * } else {
3508 * console.log( 'User clicked "Cancel" or closed the dialog.' );
3509 * }
3510 * } );
3511 *
3512 * @param {jQuery|string} text Message text to display
3513 * @param {Object} [options] Additional options, see OO.ui.MessageDialog#getSetupProcess
3514 * @return {jQuery.Promise} Promise resolved when the user closes the dialog. If the user chose to
3515 * confirm, the promise will resolve to boolean `true`; otherwise, it will resolve to boolean
3516 * `false`.
3517 */
3518 OO.ui.confirm = function ( text, options ) {
3519 return OO.ui.getWindowManager().openWindow( 'message', $.extend( {
3520 message: text
3521 }, options ) ).closed.then( function ( data ) {
3522 return !!( data && data.action === 'accept' );
3523 } );
3524 };
3525
3526 /**
3527 * Display a quick modal prompt dialog, using a OO.ui.MessageDialog. While the dialog is open,
3528 * the rest of the page will be dimmed out and the user won't be able to interact with it. The
3529 * dialog has a text input widget and two action buttons, one to confirm an operation (labelled "OK")
3530 * and one to cancel it (labelled "Cancel").
3531 *
3532 * A window manager is created automatically when this function is called for the first time.
3533 *
3534 * @example
3535 * OO.ui.prompt( 'Choose a line to go to', { textInput: { placeholder: 'Line number' } } ).done( function ( result ) {
3536 * if ( result !== null ) {
3537 * console.log( 'User typed "' + result + '" then clicked "OK".' );
3538 * } else {
3539 * console.log( 'User clicked "Cancel" or closed the dialog.' );
3540 * }
3541 * } );
3542 *
3543 * @param {jQuery|string} text Message text to display
3544 * @param {Object} [options] Additional options, see OO.ui.MessageDialog#getSetupProcess
3545 * @param {Object} [options.textInput] Additional options for text input widget, see OO.ui.TextInputWidget
3546 * @return {jQuery.Promise} Promise resolved when the user closes the dialog. If the user chose to
3547 * confirm, the promise will resolve with the value of the text input widget; otherwise, it will
3548 * resolve to `null`.
3549 */
3550 OO.ui.prompt = function ( text, options ) {
3551 var instance,
3552 manager = OO.ui.getWindowManager(),
3553 textInput = new OO.ui.TextInputWidget( ( options && options.textInput ) || {} ),
3554 textField = new OO.ui.FieldLayout( textInput, {
3555 align: 'top',
3556 label: text
3557 } );
3558
3559 instance = manager.openWindow( 'message', $.extend( {
3560 message: textField.$element
3561 }, options ) );
3562
3563 // TODO: This is a little hacky, and could be done by extending MessageDialog instead.
3564 instance.opened.then( function () {
3565 textInput.on( 'enter', function () {
3566 manager.getCurrentWindow().close( { action: 'accept' } );
3567 } );
3568 textInput.focus();
3569 } );
3570
3571 return instance.closed.then( function ( data ) {
3572 return data && data.action === 'accept' ? textInput.getValue() : null;
3573 } );
3574 };
3575
3576 }( OO ) );
3577
3578 //# sourceMappingURL=oojs-ui-windows.js.map