Merge "Add semantic tags to license info text"
[lhc/web/wiklou.git] / resources / lib / oojs-ui / oojs-ui-windows.js
1 /*!
2 * OOjs UI v0.24.4
3 * https://www.mediawiki.org/wiki/OOjs_UI
4 *
5 * Copyright 2011–2018 OOjs UI Team and other contributors.
6 * Released under the MIT license
7 * http://oojs.mit-license.org
8 *
9 * Date: 2018-01-02T19:08:58Z
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 [OOjs UI documentation on MediaWiki] [1] for more information
22 * and examples.
23 *
24 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/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 * Please see the [OOjs UI 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/OOjs_UI/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 [OOjs UI documentation on MediaWiki][2] for more information and examples.
211 *
212 * [2]:https://www.mediawiki.org/wiki/OOjs_UI/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 [OOjs UI documentation on MediaWiki][1].
609 *
610 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/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 [OOjs UI documentation on MediaWiki] [1].
862 *
863 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/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 [OOjs UI documentation on MediaWiki][1] for more information.
993 *
994 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/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 if ( this.currentWindow ) {
1138 this.updateWindowSize( this.currentWindow );
1139 }
1140 };
1141
1142 /**
1143 * Check if window is opening.
1144 *
1145 * @param {OO.ui.Window} win Window to check
1146 * @return {boolean} Window is opening
1147 */
1148 OO.ui.WindowManager.prototype.isOpening = function ( win ) {
1149 return win === this.currentWindow && !!this.lifecycle &&
1150 this.lifecycle.isOpening();
1151 };
1152
1153 /**
1154 * Check if window is closing.
1155 *
1156 * @param {OO.ui.Window} win Window to check
1157 * @return {boolean} Window is closing
1158 */
1159 OO.ui.WindowManager.prototype.isClosing = function ( win ) {
1160 return win === this.currentWindow && !!this.lifecycle &&
1161 this.lifecycle.isClosing();
1162 };
1163
1164 /**
1165 * Check if window is opened.
1166 *
1167 * @param {OO.ui.Window} win Window to check
1168 * @return {boolean} Window is opened
1169 */
1170 OO.ui.WindowManager.prototype.isOpened = function ( win ) {
1171 return win === this.currentWindow && !!this.lifecycle &&
1172 this.lifecycle.isOpened();
1173 };
1174
1175 /**
1176 * Check if a window is being managed.
1177 *
1178 * @param {OO.ui.Window} win Window to check
1179 * @return {boolean} Window is being managed
1180 */
1181 OO.ui.WindowManager.prototype.hasWindow = function ( win ) {
1182 var name;
1183
1184 for ( name in this.windows ) {
1185 if ( this.windows[ name ] === win ) {
1186 return true;
1187 }
1188 }
1189
1190 return false;
1191 };
1192
1193 /**
1194 * Get the number of milliseconds to wait after opening begins before executing the ‘setup’ process.
1195 *
1196 * @param {OO.ui.Window} win Window being opened
1197 * @param {Object} [data] Window opening data
1198 * @return {number} Milliseconds to wait
1199 */
1200 OO.ui.WindowManager.prototype.getSetupDelay = function () {
1201 return 0;
1202 };
1203
1204 /**
1205 * Get the number of milliseconds to wait after setup has finished before executing the ‘ready’ process.
1206 *
1207 * @param {OO.ui.Window} win Window being opened
1208 * @param {Object} [data] Window opening data
1209 * @return {number} Milliseconds to wait
1210 */
1211 OO.ui.WindowManager.prototype.getReadyDelay = function () {
1212 return 0;
1213 };
1214
1215 /**
1216 * Get the number of milliseconds to wait after closing has begun before executing the 'hold' process.
1217 *
1218 * @param {OO.ui.Window} win Window being closed
1219 * @param {Object} [data] Window closing data
1220 * @return {number} Milliseconds to wait
1221 */
1222 OO.ui.WindowManager.prototype.getHoldDelay = function () {
1223 return 0;
1224 };
1225
1226 /**
1227 * Get the number of milliseconds to wait after the ‘hold’ process has finished before
1228 * executing the ‘teardown’ process.
1229 *
1230 * @param {OO.ui.Window} win Window being closed
1231 * @param {Object} [data] Window closing data
1232 * @return {number} Milliseconds to wait
1233 */
1234 OO.ui.WindowManager.prototype.getTeardownDelay = function () {
1235 return this.modal ? 250 : 0;
1236 };
1237
1238 /**
1239 * Get a window by its symbolic name.
1240 *
1241 * If the window is not yet instantiated and its symbolic name is recognized by a factory, it will be
1242 * instantiated and added to the window manager automatically. Please see the [OOjs UI documentation on MediaWiki][3]
1243 * for more information about using factories.
1244 * [3]: https://www.mediawiki.org/wiki/OOjs_UI/Windows/Window_managers
1245 *
1246 * @param {string} name Symbolic name of the window
1247 * @return {jQuery.Promise} Promise resolved with matching window, or rejected with an OO.ui.Error
1248 * @throws {Error} An error is thrown if the symbolic name is not recognized by the factory.
1249 * @throws {Error} An error is thrown if the named window is not recognized as a managed window.
1250 */
1251 OO.ui.WindowManager.prototype.getWindow = function ( name ) {
1252 var deferred = $.Deferred(),
1253 win = this.windows[ name ];
1254
1255 if ( !( win instanceof OO.ui.Window ) ) {
1256 if ( this.factory ) {
1257 if ( !this.factory.lookup( name ) ) {
1258 deferred.reject( new OO.ui.Error(
1259 'Cannot auto-instantiate window: symbolic name is unrecognized by the factory'
1260 ) );
1261 } else {
1262 win = this.factory.create( name );
1263 this.addWindows( [ win ] );
1264 deferred.resolve( win );
1265 }
1266 } else {
1267 deferred.reject( new OO.ui.Error(
1268 'Cannot get unmanaged window: symbolic name unrecognized as a managed window'
1269 ) );
1270 }
1271 } else {
1272 deferred.resolve( win );
1273 }
1274
1275 return deferred.promise();
1276 };
1277
1278 /**
1279 * Get current window.
1280 *
1281 * @return {OO.ui.Window|null} Currently opening/opened/closing window
1282 */
1283 OO.ui.WindowManager.prototype.getCurrentWindow = function () {
1284 return this.currentWindow;
1285 };
1286
1287 /**
1288 * Open a window.
1289 *
1290 * @param {OO.ui.Window|string} win Window object or symbolic name of window to open
1291 * @param {Object} [data] Window opening data
1292 * @param {jQuery|null} [data.$returnFocusTo] Element to which the window will return focus when closed.
1293 * Defaults the current activeElement. If set to null, focus isn't changed on close.
1294 * @return {OO.ui.WindowInstance|jQuery.Promise} A lifecycle object representing this particular
1295 * opening of the window. For backwards-compatibility, then object is also a Thenable that is resolved
1296 * when the window is done opening, with nested promise for when closing starts. This behaviour
1297 * is deprecated and is not compatible with jQuery 3. See T163510.
1298 * @fires opening
1299 */
1300 OO.ui.WindowManager.prototype.openWindow = function ( win, data, lifecycle, compatOpening ) {
1301 var error,
1302 manager = this;
1303 data = data || {};
1304
1305 // Internal parameter 'lifecycle' allows this method to always return
1306 // a lifecycle even if the window still needs to be created
1307 // asynchronously when 'win' is a string.
1308 lifecycle = lifecycle || new OO.ui.WindowInstance();
1309 compatOpening = compatOpening || $.Deferred();
1310
1311 // Turn lifecycle into a Thenable for backwards-compatibility with
1312 // the deprecated nested-promise behaviour, see T163510.
1313 [ 'state', 'always', 'catch', 'pipe', 'then', 'promise', 'progress', 'done', 'fail' ]
1314 .forEach( function ( method ) {
1315 lifecycle[ method ] = function () {
1316 OO.ui.warnDeprecation(
1317 'Using the return value of openWindow as a promise is deprecated. ' +
1318 'Use .openWindow( ... ).opening.' + method + '( ... ) instead.'
1319 );
1320 return compatOpening[ method ].apply( this, arguments );
1321 };
1322 } );
1323
1324 // Argument handling
1325 if ( typeof win === 'string' ) {
1326 this.getWindow( win ).then(
1327 function ( win ) {
1328 manager.openWindow( win, data, lifecycle, compatOpening );
1329 },
1330 function ( err ) {
1331 lifecycle.deferreds.opening.reject( err );
1332 }
1333 );
1334 return lifecycle;
1335 }
1336
1337 // Error handling
1338 if ( !this.hasWindow( win ) ) {
1339 error = 'Cannot open window: window is not attached to manager';
1340 } else if ( this.lifecycle && this.lifecycle.isOpened() ) {
1341 error = 'Cannot open window: another window is open';
1342 } else if ( this.preparingToOpen || ( this.lifecycle && this.lifecycle.isOpening() ) ) {
1343 error = 'Cannot open window: another window is opening';
1344 }
1345
1346 if ( error ) {
1347 compatOpening.reject( new OO.ui.Error( error ) );
1348 lifecycle.deferreds.opening.reject( new OO.ui.Error( error ) );
1349 return lifecycle;
1350 }
1351
1352 // If a window is currently closing, wait for it to complete
1353 this.preparingToOpen = $.when( this.lifecycle && this.lifecycle.closed );
1354 // Ensure handlers get called after preparingToOpen is set
1355 this.preparingToOpen.done( function () {
1356 if ( manager.modal ) {
1357 manager.toggleGlobalEvents( true );
1358 manager.toggleAriaIsolation( true );
1359 }
1360 manager.$returnFocusTo = data.$returnFocusTo !== undefined ? data.$returnFocusTo : $( document.activeElement );
1361 manager.currentWindow = win;
1362 manager.lifecycle = lifecycle;
1363 manager.preparingToOpen = null;
1364 manager.emit( 'opening', win, compatOpening, data );
1365 lifecycle.deferreds.opening.resolve( data );
1366 setTimeout( function () {
1367 manager.compatOpened = $.Deferred();
1368 win.setup( data ).then( function () {
1369 manager.updateWindowSize( win );
1370 compatOpening.notify( { state: 'setup' } );
1371 setTimeout( function () {
1372 win.ready( data ).then( function () {
1373 compatOpening.notify( { state: 'ready' } );
1374 lifecycle.deferreds.opened.resolve( data );
1375 compatOpening.resolve( manager.compatOpened.promise(), data );
1376 }, function () {
1377 lifecycle.deferreds.opened.reject();
1378 compatOpening.reject();
1379 manager.closeWindow( win );
1380 } );
1381 }, manager.getReadyDelay() );
1382 }, function () {
1383 lifecycle.deferreds.opened.reject();
1384 compatOpening.reject();
1385 manager.closeWindow( win );
1386 } );
1387 }, manager.getSetupDelay() );
1388 } );
1389
1390 return lifecycle;
1391 };
1392
1393 /**
1394 * Close a window.
1395 *
1396 * @param {OO.ui.Window|string} win Window object or symbolic name of window to close
1397 * @param {Object} [data] Window closing data
1398 * @return {OO.ui.WindowInstance|jQuery.Promise} A lifecycle object representing this particular
1399 * opening of the window. For backwards-compatibility, the object is also a Thenable that is resolved
1400 * when the window is done closing, see T163510.
1401 * @fires closing
1402 */
1403 OO.ui.WindowManager.prototype.closeWindow = function ( win, data ) {
1404 var error,
1405 manager = this,
1406 compatClosing = $.Deferred(),
1407 lifecycle = this.lifecycle,
1408 compatOpened;
1409
1410 // Argument handling
1411 if ( typeof win === 'string' ) {
1412 win = this.windows[ win ];
1413 } else if ( !this.hasWindow( win ) ) {
1414 win = null;
1415 }
1416
1417 // Error handling
1418 if ( !lifecycle ) {
1419 error = 'Cannot close window: no window is currently open';
1420 } else if ( !win ) {
1421 error = 'Cannot close window: window is not attached to manager';
1422 } else if ( win !== this.currentWindow || this.lifecycle.isClosed() ) {
1423 error = 'Cannot close window: window already closed with different data';
1424 } else if ( this.preparingToClose || this.lifecycle.isClosing() ) {
1425 error = 'Cannot close window: window already closing with different data';
1426 }
1427
1428 if ( error ) {
1429 // This function was called for the wrong window and we don't want to mess with the current
1430 // window's state.
1431 lifecycle = new OO.ui.WindowInstance();
1432 // Pretend the window has been opened, so that we can pretend to fail to close it.
1433 lifecycle.deferreds.opening.resolve( {} );
1434 lifecycle.deferreds.opened.resolve( {} );
1435 }
1436
1437 // Turn lifecycle into a Thenable for backwards-compatibility with
1438 // the deprecated nested-promise behaviour, see T163510.
1439 [ 'state', 'always', 'catch', 'pipe', 'then', 'promise', 'progress', 'done', 'fail' ]
1440 .forEach( function ( method ) {
1441 lifecycle[ method ] = function () {
1442 OO.ui.warnDeprecation(
1443 'Using the return value of closeWindow as a promise is deprecated. ' +
1444 'Use .closeWindow( ... ).closed.' + method + '( ... ) instead.'
1445 );
1446 return compatClosing[ method ].apply( this, arguments );
1447 };
1448 } );
1449
1450 if ( error ) {
1451 compatClosing.reject( new OO.ui.Error( error ) );
1452 lifecycle.deferreds.closing.reject( new OO.ui.Error( error ) );
1453 return lifecycle;
1454 }
1455
1456 // If the window is currently opening, close it when it's done
1457 this.preparingToClose = $.when( this.lifecycle.opened );
1458 // Ensure handlers get called after preparingToClose is set
1459 this.preparingToClose.always( function () {
1460 manager.preparingToClose = null;
1461 manager.emit( 'closing', win, compatClosing, data );
1462 lifecycle.deferreds.closing.resolve( data );
1463 compatOpened = manager.compatOpened;
1464 manager.compatOpened = null;
1465 compatOpened.resolve( compatClosing.promise(), data );
1466 setTimeout( function () {
1467 win.hold( data ).then( function () {
1468 compatClosing.notify( { state: 'hold' } );
1469 setTimeout( function () {
1470 win.teardown( data ).then( function () {
1471 compatClosing.notify( { state: 'teardown' } );
1472 if ( manager.modal ) {
1473 manager.toggleGlobalEvents( false );
1474 manager.toggleAriaIsolation( false );
1475 }
1476 if ( manager.$returnFocusTo && manager.$returnFocusTo.length ) {
1477 manager.$returnFocusTo[ 0 ].focus();
1478 }
1479 manager.currentWindow = null;
1480 manager.lifecycle = null;
1481 lifecycle.deferreds.closed.resolve( data );
1482 compatClosing.resolve( data );
1483 } );
1484 }, manager.getTeardownDelay() );
1485 } );
1486 }, manager.getHoldDelay() );
1487 } );
1488
1489 return lifecycle;
1490 };
1491
1492 /**
1493 * Add windows to the window manager.
1494 *
1495 * Windows can be added by reference, symbolic name, or explicitly defined symbolic names.
1496 * See the [OOjs ui documentation on MediaWiki] [2] for examples.
1497 * [2]: https://www.mediawiki.org/wiki/OOjs_UI/Windows/Window_managers
1498 *
1499 * This function can be called in two manners:
1500 *
1501 * 1. `.addWindows( [ windowA, windowB, ... ] )` (where `windowA`, `windowB` are OO.ui.Window objects)
1502 *
1503 * This syntax registers windows under the symbolic names defined in their `.static.name`
1504 * properties. For example, if `windowA.constructor.static.name` is `'nameA'`, calling
1505 * `.openWindow( 'nameA' )` afterwards will open the window `windowA`. This syntax requires the
1506 * static name to be set, otherwise an exception will be thrown.
1507 *
1508 * This is the recommended way, as it allows for an easier switch to using a window factory.
1509 *
1510 * 2. `.addWindows( { nameA: windowA, nameB: windowB, ... } )`
1511 *
1512 * This syntax registers windows under the explicitly given symbolic names. In this example,
1513 * calling `.openWindow( 'nameA' )` afterwards will open the window `windowA`, regardless of what
1514 * its `.static.name` is set to. The static name is not required to be set.
1515 *
1516 * This should only be used if you need to override the default symbolic names.
1517 *
1518 * Example:
1519 *
1520 * var windowManager = new OO.ui.WindowManager();
1521 * $( 'body' ).append( windowManager.$element );
1522 *
1523 * // Add a window under the default name: see OO.ui.MessageDialog.static.name
1524 * windowManager.addWindows( [ new OO.ui.MessageDialog() ] );
1525 * // Add a window under an explicit name
1526 * windowManager.addWindows( { myMessageDialog: new OO.ui.MessageDialog() } );
1527 *
1528 * // Open window by default name
1529 * windowManager.openWindow( 'message' );
1530 * // Open window by explicitly given name
1531 * windowManager.openWindow( 'myMessageDialog' );
1532 *
1533 *
1534 * @param {Object.<string,OO.ui.Window>|OO.ui.Window[]} windows An array of window objects specified
1535 * by reference, symbolic name, or explicitly defined symbolic names.
1536 * @throws {Error} An error is thrown if a window is added by symbolic name, but has neither an
1537 * explicit nor a statically configured symbolic name.
1538 */
1539 OO.ui.WindowManager.prototype.addWindows = function ( windows ) {
1540 var i, len, win, name, list;
1541
1542 if ( Array.isArray( windows ) ) {
1543 // Convert to map of windows by looking up symbolic names from static configuration
1544 list = {};
1545 for ( i = 0, len = windows.length; i < len; i++ ) {
1546 name = windows[ i ].constructor.static.name;
1547 if ( !name ) {
1548 throw new Error( 'Windows must have a `name` static property defined.' );
1549 }
1550 list[ name ] = windows[ i ];
1551 }
1552 } else if ( OO.isPlainObject( windows ) ) {
1553 list = windows;
1554 }
1555
1556 // Add windows
1557 for ( name in list ) {
1558 win = list[ name ];
1559 this.windows[ name ] = win.toggle( false );
1560 this.$element.append( win.$element );
1561 win.setManager( this );
1562 }
1563 };
1564
1565 /**
1566 * Remove the specified windows from the windows manager.
1567 *
1568 * Windows will be closed before they are removed. If you wish to remove all windows, you may wish to use
1569 * the #clearWindows method instead. If you no longer need the window manager and want to ensure that it no
1570 * longer listens to events, use the #destroy method.
1571 *
1572 * @param {string[]} names Symbolic names of windows to remove
1573 * @return {jQuery.Promise} Promise resolved when window is closed and removed
1574 * @throws {Error} An error is thrown if the named windows are not managed by the window manager.
1575 */
1576 OO.ui.WindowManager.prototype.removeWindows = function ( names ) {
1577 var i, len, win, name, cleanupWindow,
1578 manager = this,
1579 promises = [],
1580 cleanup = function ( name, win ) {
1581 delete manager.windows[ name ];
1582 win.$element.detach();
1583 };
1584
1585 for ( i = 0, len = names.length; i < len; i++ ) {
1586 name = names[ i ];
1587 win = this.windows[ name ];
1588 if ( !win ) {
1589 throw new Error( 'Cannot remove window' );
1590 }
1591 cleanupWindow = cleanup.bind( null, name, win );
1592 promises.push( this.closeWindow( name ).closed.then( cleanupWindow, cleanupWindow ) );
1593 }
1594
1595 return $.when.apply( $, promises );
1596 };
1597
1598 /**
1599 * Remove all windows from the window manager.
1600 *
1601 * Windows will be closed before they are removed. Note that the window manager, though not in use, will still
1602 * listen to events. If the window manager will not be used again, you may wish to use the #destroy method instead.
1603 * To remove just a subset of windows, use the #removeWindows method.
1604 *
1605 * @return {jQuery.Promise} Promise resolved when all windows are closed and removed
1606 */
1607 OO.ui.WindowManager.prototype.clearWindows = function () {
1608 return this.removeWindows( Object.keys( this.windows ) );
1609 };
1610
1611 /**
1612 * Set dialog size. In general, this method should not be called directly.
1613 *
1614 * Fullscreen mode will be used if the dialog is too wide to fit in the screen.
1615 *
1616 * @param {OO.ui.Window} win Window to update, should be the current window
1617 * @chainable
1618 */
1619 OO.ui.WindowManager.prototype.updateWindowSize = function ( win ) {
1620 var isFullscreen;
1621
1622 // Bypass for non-current, and thus invisible, windows
1623 if ( win !== this.currentWindow ) {
1624 return;
1625 }
1626
1627 isFullscreen = win.getSize() === 'full';
1628
1629 this.$element.toggleClass( 'oo-ui-windowManager-fullscreen', isFullscreen );
1630 this.$element.toggleClass( 'oo-ui-windowManager-floating', !isFullscreen );
1631 win.setDimensions( win.getSizeProperties() );
1632
1633 this.emit( 'resize', win );
1634
1635 return this;
1636 };
1637
1638 /**
1639 * Bind or unbind global events for scrolling.
1640 *
1641 * @private
1642 * @param {boolean} [on] Bind global events
1643 * @chainable
1644 */
1645 OO.ui.WindowManager.prototype.toggleGlobalEvents = function ( on ) {
1646 var scrollWidth, bodyMargin,
1647 $body = $( this.getElementDocument().body ),
1648 // We could have multiple window managers open so only modify
1649 // the body css at the bottom of the stack
1650 stackDepth = $body.data( 'windowManagerGlobalEvents' ) || 0;
1651
1652 on = on === undefined ? !!this.globalEvents : !!on;
1653
1654 if ( on ) {
1655 if ( !this.globalEvents ) {
1656 $( this.getElementWindow() ).on( {
1657 // Start listening for top-level window dimension changes
1658 'orientationchange resize': this.onWindowResizeHandler
1659 } );
1660 if ( stackDepth === 0 ) {
1661 scrollWidth = window.innerWidth - document.documentElement.clientWidth;
1662 bodyMargin = parseFloat( $body.css( 'margin-right' ) ) || 0;
1663 $body.css( {
1664 overflow: 'hidden',
1665 'margin-right': bodyMargin + scrollWidth
1666 } );
1667 }
1668 stackDepth++;
1669 this.globalEvents = true;
1670 }
1671 } else if ( this.globalEvents ) {
1672 $( this.getElementWindow() ).off( {
1673 // Stop listening for top-level window dimension changes
1674 'orientationchange resize': this.onWindowResizeHandler
1675 } );
1676 stackDepth--;
1677 if ( stackDepth === 0 ) {
1678 $body.css( {
1679 overflow: '',
1680 'margin-right': ''
1681 } );
1682 }
1683 this.globalEvents = false;
1684 }
1685 $body.data( 'windowManagerGlobalEvents', stackDepth );
1686
1687 return this;
1688 };
1689
1690 /**
1691 * Toggle screen reader visibility of content other than the window manager.
1692 *
1693 * @private
1694 * @param {boolean} [isolate] Make only the window manager visible to screen readers
1695 * @chainable
1696 */
1697 OO.ui.WindowManager.prototype.toggleAriaIsolation = function ( isolate ) {
1698 var $topLevelElement;
1699 isolate = isolate === undefined ? !this.$ariaHidden : !!isolate;
1700
1701 if ( isolate ) {
1702 if ( !this.$ariaHidden ) {
1703 // Find the top level element containing the window manager or the
1704 // window manager's element itself in case its a direct child of body
1705 $topLevelElement = this.$element.parentsUntil( 'body' ).last();
1706 $topLevelElement = $topLevelElement.length === 0 ? this.$element : $topLevelElement;
1707
1708 // In case previously set by another window manager
1709 this.$element.removeAttr( 'aria-hidden' );
1710
1711 // Hide everything other than the window manager from screen readers
1712 this.$ariaHidden = $( 'body' )
1713 .children()
1714 .not( 'script' )
1715 .not( $topLevelElement )
1716 .attr( 'aria-hidden', true );
1717 }
1718 } else if ( this.$ariaHidden ) {
1719 // Restore screen reader visibility
1720 this.$ariaHidden.removeAttr( 'aria-hidden' );
1721 this.$ariaHidden = null;
1722
1723 // and hide the window manager
1724 this.$element.attr( 'aria-hidden', true );
1725 }
1726
1727 return this;
1728 };
1729
1730 /**
1731 * Destroy the window manager.
1732 *
1733 * Destroying the window manager ensures that it will no longer listen to events. If you would like to
1734 * continue using the window manager, but wish to remove all windows from it, use the #clearWindows method
1735 * instead.
1736 */
1737 OO.ui.WindowManager.prototype.destroy = function () {
1738 this.toggleGlobalEvents( false );
1739 this.toggleAriaIsolation( false );
1740 this.clearWindows();
1741 this.$element.remove();
1742 };
1743
1744 /**
1745 * A window is a container for elements that are in a child frame. They are used with
1746 * a window manager (OO.ui.WindowManager), which is used to open and close the window and control
1747 * its presentation. The size of a window is specified using a symbolic name (e.g., ‘small’, ‘medium’,
1748 * ‘large’), which is interpreted by the window manager. If the requested size is not recognized,
1749 * the window manager will choose a sensible fallback.
1750 *
1751 * The lifecycle of a window has three primary stages (opening, opened, and closing) in which
1752 * different processes are executed:
1753 *
1754 * **opening**: The opening stage begins when the window manager's {@link OO.ui.WindowManager#openWindow
1755 * openWindow} or the window's {@link #open open} methods are used, and the window manager begins to open
1756 * the window.
1757 *
1758 * - {@link #getSetupProcess} method is called and its result executed
1759 * - {@link #getReadyProcess} method is called and its result executed
1760 *
1761 * **opened**: The window is now open
1762 *
1763 * **closing**: The closing stage begins when the window manager's
1764 * {@link OO.ui.WindowManager#closeWindow closeWindow}
1765 * or the window's {@link #close} methods are used, and the window manager begins to close the window.
1766 *
1767 * - {@link #getHoldProcess} method is called and its result executed
1768 * - {@link #getTeardownProcess} method is called and its result executed. The window is now closed
1769 *
1770 * Each of the window's processes (setup, ready, hold, and teardown) can be extended in subclasses
1771 * by overriding the window's #getSetupProcess, #getReadyProcess, #getHoldProcess and #getTeardownProcess
1772 * methods. Note that each {@link OO.ui.Process process} is executed in series, so asynchronous
1773 * processing can complete. Always assume window processes are executed asynchronously.
1774 *
1775 * For more information, please see the [OOjs UI documentation on MediaWiki] [1].
1776 *
1777 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Windows
1778 *
1779 * @abstract
1780 * @class
1781 * @extends OO.ui.Element
1782 * @mixins OO.EventEmitter
1783 *
1784 * @constructor
1785 * @param {Object} [config] Configuration options
1786 * @cfg {string} [size] Symbolic name of the dialog size: `small`, `medium`, `large`, `larger` or
1787 * `full`. If omitted, the value of the {@link #static-size static size} property will be used.
1788 */
1789 OO.ui.Window = function OoUiWindow( config ) {
1790 // Configuration initialization
1791 config = config || {};
1792
1793 // Parent constructor
1794 OO.ui.Window.parent.call( this, config );
1795
1796 // Mixin constructors
1797 OO.EventEmitter.call( this );
1798
1799 // Properties
1800 this.manager = null;
1801 this.size = config.size || this.constructor.static.size;
1802 this.$frame = $( '<div>' );
1803 /**
1804 * Overlay element to use for the `$overlay` configuration option of widgets that support it.
1805 * Things put inside of it are overlaid on top of the window and are not bound to its dimensions.
1806 * See <https://www.mediawiki.org/wiki/OOjs_UI/Concepts#Overlays>.
1807 *
1808 * MyDialog.prototype.initialize = function () {
1809 * ...
1810 * var popupButton = new OO.ui.PopupButtonWidget( {
1811 * $overlay: this.$overlay,
1812 * label: 'Popup button',
1813 * popup: {
1814 * $content: $( '<p>Popup contents.</p><p>Popup contents.</p><p>Popup contents.</p>' ),
1815 * padded: true
1816 * }
1817 * } );
1818 * ...
1819 * };
1820 *
1821 * @property {jQuery}
1822 */
1823 this.$overlay = $( '<div>' );
1824 this.$content = $( '<div>' );
1825
1826 this.$focusTrapBefore = $( '<div>' ).prop( 'tabIndex', 0 );
1827 this.$focusTrapAfter = $( '<div>' ).prop( 'tabIndex', 0 );
1828 this.$focusTraps = this.$focusTrapBefore.add( this.$focusTrapAfter );
1829
1830 // Initialization
1831 this.$overlay.addClass( 'oo-ui-window-overlay' );
1832 this.$content
1833 .addClass( 'oo-ui-window-content' )
1834 .attr( 'tabindex', 0 );
1835 this.$frame
1836 .addClass( 'oo-ui-window-frame' )
1837 .append( this.$focusTrapBefore, this.$content, this.$focusTrapAfter );
1838
1839 this.$element
1840 .addClass( 'oo-ui-window' )
1841 .append( this.$frame, this.$overlay );
1842
1843 // Initially hidden - using #toggle may cause errors if subclasses override toggle with methods
1844 // that reference properties not initialized at that time of parent class construction
1845 // TODO: Find a better way to handle post-constructor setup
1846 this.visible = false;
1847 this.$element.addClass( 'oo-ui-element-hidden' );
1848 };
1849
1850 /* Setup */
1851
1852 OO.inheritClass( OO.ui.Window, OO.ui.Element );
1853 OO.mixinClass( OO.ui.Window, OO.EventEmitter );
1854
1855 /* Static Properties */
1856
1857 /**
1858 * Symbolic name of the window size: `small`, `medium`, `large`, `larger` or `full`.
1859 *
1860 * The static size is used if no #size is configured during construction.
1861 *
1862 * @static
1863 * @inheritable
1864 * @property {string}
1865 */
1866 OO.ui.Window.static.size = 'medium';
1867
1868 /* Methods */
1869
1870 /**
1871 * Handle mouse down events.
1872 *
1873 * @private
1874 * @param {jQuery.Event} e Mouse down event
1875 */
1876 OO.ui.Window.prototype.onMouseDown = function ( e ) {
1877 // Prevent clicking on the click-block from stealing focus
1878 if ( e.target === this.$element[ 0 ] ) {
1879 return false;
1880 }
1881 };
1882
1883 /**
1884 * Check if the window has been initialized.
1885 *
1886 * Initialization occurs when a window is added to a manager.
1887 *
1888 * @return {boolean} Window has been initialized
1889 */
1890 OO.ui.Window.prototype.isInitialized = function () {
1891 return !!this.manager;
1892 };
1893
1894 /**
1895 * Check if the window is visible.
1896 *
1897 * @return {boolean} Window is visible
1898 */
1899 OO.ui.Window.prototype.isVisible = function () {
1900 return this.visible;
1901 };
1902
1903 /**
1904 * Check if the window is opening.
1905 *
1906 * This method is a wrapper around the window manager's {@link OO.ui.WindowManager#isOpening isOpening}
1907 * method.
1908 *
1909 * @return {boolean} Window is opening
1910 */
1911 OO.ui.Window.prototype.isOpening = function () {
1912 return this.manager.isOpening( this );
1913 };
1914
1915 /**
1916 * Check if the window is closing.
1917 *
1918 * This method is a wrapper around the window manager's {@link OO.ui.WindowManager#isClosing isClosing} method.
1919 *
1920 * @return {boolean} Window is closing
1921 */
1922 OO.ui.Window.prototype.isClosing = function () {
1923 return this.manager.isClosing( this );
1924 };
1925
1926 /**
1927 * Check if the window is opened.
1928 *
1929 * This method is a wrapper around the window manager's {@link OO.ui.WindowManager#isOpened isOpened} method.
1930 *
1931 * @return {boolean} Window is opened
1932 */
1933 OO.ui.Window.prototype.isOpened = function () {
1934 return this.manager.isOpened( this );
1935 };
1936
1937 /**
1938 * Get the window manager.
1939 *
1940 * All windows must be attached to a window manager, which is used to open
1941 * and close the window and control its presentation.
1942 *
1943 * @return {OO.ui.WindowManager} Manager of window
1944 */
1945 OO.ui.Window.prototype.getManager = function () {
1946 return this.manager;
1947 };
1948
1949 /**
1950 * Get the symbolic name of the window size (e.g., `small` or `medium`).
1951 *
1952 * @return {string} Symbolic name of the size: `small`, `medium`, `large`, `larger`, `full`
1953 */
1954 OO.ui.Window.prototype.getSize = function () {
1955 var viewport = OO.ui.Element.static.getDimensions( this.getElementWindow() ),
1956 sizes = this.manager.constructor.static.sizes,
1957 size = this.size;
1958
1959 if ( !sizes[ size ] ) {
1960 size = this.manager.constructor.static.defaultSize;
1961 }
1962 if ( size !== 'full' && viewport.rect.right - viewport.rect.left < sizes[ size ].width ) {
1963 size = 'full';
1964 }
1965
1966 return size;
1967 };
1968
1969 /**
1970 * Get the size properties associated with the current window size
1971 *
1972 * @return {Object} Size properties
1973 */
1974 OO.ui.Window.prototype.getSizeProperties = function () {
1975 return this.manager.constructor.static.sizes[ this.getSize() ];
1976 };
1977
1978 /**
1979 * Disable transitions on window's frame for the duration of the callback function, then enable them
1980 * back.
1981 *
1982 * @private
1983 * @param {Function} callback Function to call while transitions are disabled
1984 */
1985 OO.ui.Window.prototype.withoutSizeTransitions = function ( callback ) {
1986 // Temporarily resize the frame so getBodyHeight() can use scrollHeight measurements.
1987 // Disable transitions first, otherwise we'll get values from when the window was animating.
1988 // We need to build the transition CSS properties using these specific properties since
1989 // Firefox doesn't return anything useful when asked just for 'transition'.
1990 var oldTransition = this.$frame.css( 'transition-property' ) + ' ' +
1991 this.$frame.css( 'transition-duration' ) + ' ' +
1992 this.$frame.css( 'transition-timing-function' ) + ' ' +
1993 this.$frame.css( 'transition-delay' );
1994
1995 this.$frame.css( 'transition', 'none' );
1996 callback();
1997
1998 // Force reflow to make sure the style changes done inside callback
1999 // really are not transitioned
2000 this.$frame.height();
2001 this.$frame.css( 'transition', oldTransition );
2002 };
2003
2004 /**
2005 * Get the height of the full window contents (i.e., the window head, body and foot together).
2006 *
2007 * What consistitutes the head, body, and foot varies depending on the window type.
2008 * A {@link OO.ui.MessageDialog message dialog} displays a title and message in its body,
2009 * and any actions in the foot. A {@link OO.ui.ProcessDialog process dialog} displays a title
2010 * and special actions in the head, and dialog content in the body.
2011 *
2012 * To get just the height of the dialog body, use the #getBodyHeight method.
2013 *
2014 * @return {number} The height of the window contents (the dialog head, body and foot) in pixels
2015 */
2016 OO.ui.Window.prototype.getContentHeight = function () {
2017 var bodyHeight,
2018 win = this,
2019 bodyStyleObj = this.$body[ 0 ].style,
2020 frameStyleObj = this.$frame[ 0 ].style;
2021
2022 // Temporarily resize the frame so getBodyHeight() can use scrollHeight measurements.
2023 // Disable transitions first, otherwise we'll get values from when the window was animating.
2024 this.withoutSizeTransitions( function () {
2025 var oldHeight = frameStyleObj.height,
2026 oldPosition = bodyStyleObj.position;
2027 frameStyleObj.height = '1px';
2028 // Force body to resize to new width
2029 bodyStyleObj.position = 'relative';
2030 bodyHeight = win.getBodyHeight();
2031 frameStyleObj.height = oldHeight;
2032 bodyStyleObj.position = oldPosition;
2033 } );
2034
2035 return (
2036 // Add buffer for border
2037 ( this.$frame.outerHeight() - this.$frame.innerHeight() ) +
2038 // Use combined heights of children
2039 ( this.$head.outerHeight( true ) + bodyHeight + this.$foot.outerHeight( true ) )
2040 );
2041 };
2042
2043 /**
2044 * Get the height of the window body.
2045 *
2046 * To get the height of the full window contents (the window body, head, and foot together),
2047 * use #getContentHeight.
2048 *
2049 * When this function is called, the window will temporarily have been resized
2050 * to height=1px, so .scrollHeight measurements can be taken accurately.
2051 *
2052 * @return {number} Height of the window body in pixels
2053 */
2054 OO.ui.Window.prototype.getBodyHeight = function () {
2055 return this.$body[ 0 ].scrollHeight;
2056 };
2057
2058 /**
2059 * Get the directionality of the frame (right-to-left or left-to-right).
2060 *
2061 * @return {string} Directionality: `'ltr'` or `'rtl'`
2062 */
2063 OO.ui.Window.prototype.getDir = function () {
2064 return OO.ui.Element.static.getDir( this.$content ) || 'ltr';
2065 };
2066
2067 /**
2068 * Get the 'setup' process.
2069 *
2070 * The setup process is used to set up a window for use in a particular context,
2071 * based on the `data` argument. This method is called during the opening phase of the window’s
2072 * lifecycle.
2073 *
2074 * Override this method to add additional steps to the ‘setup’ process the parent method provides
2075 * using the {@link OO.ui.Process#first first} and {@link OO.ui.Process#next next} methods
2076 * of OO.ui.Process.
2077 *
2078 * To add window content that persists between openings, you may wish to use the #initialize method
2079 * instead.
2080 *
2081 * @param {Object} [data] Window opening data
2082 * @return {OO.ui.Process} Setup process
2083 */
2084 OO.ui.Window.prototype.getSetupProcess = function () {
2085 return new OO.ui.Process();
2086 };
2087
2088 /**
2089 * Get the ‘ready’ process.
2090 *
2091 * The ready process is used to ready a window for use in a particular
2092 * context, based on the `data` argument. This method is called during the opening phase of
2093 * the window’s lifecycle, after the window has been {@link #getSetupProcess setup}.
2094 *
2095 * Override this method to add additional steps to the ‘ready’ process the parent method
2096 * provides using the {@link OO.ui.Process#first first} and {@link OO.ui.Process#next next}
2097 * methods of OO.ui.Process.
2098 *
2099 * @param {Object} [data] Window opening data
2100 * @return {OO.ui.Process} Ready process
2101 */
2102 OO.ui.Window.prototype.getReadyProcess = function () {
2103 return new OO.ui.Process();
2104 };
2105
2106 /**
2107 * Get the 'hold' process.
2108 *
2109 * The hold process is used to keep a window from being used in a particular context,
2110 * based on the `data` argument. This method is called during the closing phase of the window’s
2111 * lifecycle.
2112 *
2113 * Override this method to add additional steps to the 'hold' process the parent method provides
2114 * using the {@link OO.ui.Process#first first} and {@link OO.ui.Process#next next} methods
2115 * of OO.ui.Process.
2116 *
2117 * @param {Object} [data] Window closing data
2118 * @return {OO.ui.Process} Hold process
2119 */
2120 OO.ui.Window.prototype.getHoldProcess = function () {
2121 return new OO.ui.Process();
2122 };
2123
2124 /**
2125 * Get the ‘teardown’ process.
2126 *
2127 * The teardown process is used to teardown a window after use. During teardown,
2128 * user interactions within the window are conveyed and the window is closed, based on the `data`
2129 * argument. This method is called during the closing phase of the window’s lifecycle.
2130 *
2131 * Override this method to add additional steps to the ‘teardown’ process the parent method provides
2132 * using the {@link OO.ui.Process#first first} and {@link OO.ui.Process#next next} methods
2133 * of OO.ui.Process.
2134 *
2135 * @param {Object} [data] Window closing data
2136 * @return {OO.ui.Process} Teardown process
2137 */
2138 OO.ui.Window.prototype.getTeardownProcess = function () {
2139 return new OO.ui.Process();
2140 };
2141
2142 /**
2143 * Set the window manager.
2144 *
2145 * This will cause the window to initialize. Calling it more than once will cause an error.
2146 *
2147 * @param {OO.ui.WindowManager} manager Manager for this window
2148 * @throws {Error} An error is thrown if the method is called more than once
2149 * @chainable
2150 */
2151 OO.ui.Window.prototype.setManager = function ( manager ) {
2152 if ( this.manager ) {
2153 throw new Error( 'Cannot set window manager, window already has a manager' );
2154 }
2155
2156 this.manager = manager;
2157 this.initialize();
2158
2159 return this;
2160 };
2161
2162 /**
2163 * Set the window size by symbolic name (e.g., 'small' or 'medium')
2164 *
2165 * @param {string} size Symbolic name of size: `small`, `medium`, `large`, `larger` or
2166 * `full`
2167 * @chainable
2168 */
2169 OO.ui.Window.prototype.setSize = function ( size ) {
2170 this.size = size;
2171 this.updateSize();
2172 return this;
2173 };
2174
2175 /**
2176 * Update the window size.
2177 *
2178 * @throws {Error} An error is thrown if the window is not attached to a window manager
2179 * @chainable
2180 */
2181 OO.ui.Window.prototype.updateSize = function () {
2182 if ( !this.manager ) {
2183 throw new Error( 'Cannot update window size, must be attached to a manager' );
2184 }
2185
2186 this.manager.updateWindowSize( this );
2187
2188 return this;
2189 };
2190
2191 /**
2192 * Set window dimensions. This method is called by the {@link OO.ui.WindowManager window manager}
2193 * when the window is opening. In general, setDimensions should not be called directly.
2194 *
2195 * To set the size of the window, use the #setSize method.
2196 *
2197 * @param {Object} dim CSS dimension properties
2198 * @param {string|number} [dim.width] Width
2199 * @param {string|number} [dim.minWidth] Minimum width
2200 * @param {string|number} [dim.maxWidth] Maximum width
2201 * @param {string|number} [dim.height] Height, omit to set based on height of contents
2202 * @param {string|number} [dim.minHeight] Minimum height
2203 * @param {string|number} [dim.maxHeight] Maximum height
2204 * @chainable
2205 */
2206 OO.ui.Window.prototype.setDimensions = function ( dim ) {
2207 var height,
2208 win = this,
2209 styleObj = this.$frame[ 0 ].style;
2210
2211 // Calculate the height we need to set using the correct width
2212 if ( dim.height === undefined ) {
2213 this.withoutSizeTransitions( function () {
2214 var oldWidth = styleObj.width;
2215 win.$frame.css( 'width', dim.width || '' );
2216 height = win.getContentHeight();
2217 styleObj.width = oldWidth;
2218 } );
2219 } else {
2220 height = dim.height;
2221 }
2222
2223 this.$frame.css( {
2224 width: dim.width || '',
2225 minWidth: dim.minWidth || '',
2226 maxWidth: dim.maxWidth || '',
2227 height: height || '',
2228 minHeight: dim.minHeight || '',
2229 maxHeight: dim.maxHeight || ''
2230 } );
2231
2232 return this;
2233 };
2234
2235 /**
2236 * Initialize window contents.
2237 *
2238 * Before the window is opened for the first time, #initialize is called so that content that
2239 * persists between openings can be added to the window.
2240 *
2241 * To set up a window with new content each time the window opens, use #getSetupProcess.
2242 *
2243 * @throws {Error} An error is thrown if the window is not attached to a window manager
2244 * @chainable
2245 */
2246 OO.ui.Window.prototype.initialize = function () {
2247 if ( !this.manager ) {
2248 throw new Error( 'Cannot initialize window, must be attached to a manager' );
2249 }
2250
2251 // Properties
2252 this.$head = $( '<div>' );
2253 this.$body = $( '<div>' );
2254 this.$foot = $( '<div>' );
2255 this.$document = $( this.getElementDocument() );
2256
2257 // Events
2258 this.$element.on( 'mousedown', this.onMouseDown.bind( this ) );
2259
2260 // Initialization
2261 this.$head.addClass( 'oo-ui-window-head' );
2262 this.$body.addClass( 'oo-ui-window-body' );
2263 this.$foot.addClass( 'oo-ui-window-foot' );
2264 this.$content.append( this.$head, this.$body, this.$foot );
2265
2266 return this;
2267 };
2268
2269 /**
2270 * Called when someone tries to focus the hidden element at the end of the dialog.
2271 * Sends focus back to the start of the dialog.
2272 *
2273 * @param {jQuery.Event} event Focus event
2274 */
2275 OO.ui.Window.prototype.onFocusTrapFocused = function ( event ) {
2276 var backwards = this.$focusTrapBefore.is( event.target ),
2277 element = OO.ui.findFocusable( this.$content, backwards );
2278 if ( element ) {
2279 // There's a focusable element inside the content, at the front or
2280 // back depending on which focus trap we hit; select it.
2281 element.focus();
2282 } else {
2283 // There's nothing focusable inside the content. As a fallback,
2284 // this.$content is focusable, and focusing it will keep our focus
2285 // properly trapped. It's not a *meaningful* focus, since it's just
2286 // the content-div for the Window, but it's better than letting focus
2287 // escape into the page.
2288 this.$content.focus();
2289 }
2290 };
2291
2292 /**
2293 * Open the window.
2294 *
2295 * This method is a wrapper around a call to the window manager’s {@link OO.ui.WindowManager#openWindow openWindow}
2296 * method, which returns a promise resolved when the window is done opening.
2297 *
2298 * To customize the window each time it opens, use #getSetupProcess or #getReadyProcess.
2299 *
2300 * @param {Object} [data] Window opening data
2301 * @return {jQuery.Promise} Promise resolved with a value when the window is opened, or rejected
2302 * if the window fails to open. When the promise is resolved successfully, the first argument of the
2303 * value is a new promise, which is resolved when the window begins closing.
2304 * @throws {Error} An error is thrown if the window is not attached to a window manager
2305 */
2306 OO.ui.Window.prototype.open = function ( data ) {
2307 if ( !this.manager ) {
2308 throw new Error( 'Cannot open window, must be attached to a manager' );
2309 }
2310
2311 return this.manager.openWindow( this, data );
2312 };
2313
2314 /**
2315 * Close the window.
2316 *
2317 * This method is a wrapper around a call to the window
2318 * manager’s {@link OO.ui.WindowManager#closeWindow closeWindow} method,
2319 * which returns a closing promise resolved when the window is done closing.
2320 *
2321 * The window's #getHoldProcess and #getTeardownProcess methods are called during the closing
2322 * phase of the window’s lifecycle and can be used to specify closing behavior each time
2323 * the window closes.
2324 *
2325 * @param {Object} [data] Window closing data
2326 * @return {jQuery.Promise} Promise resolved when window is closed
2327 * @throws {Error} An error is thrown if the window is not attached to a window manager
2328 */
2329 OO.ui.Window.prototype.close = function ( data ) {
2330 if ( !this.manager ) {
2331 throw new Error( 'Cannot close window, must be attached to a manager' );
2332 }
2333
2334 return this.manager.closeWindow( this, data );
2335 };
2336
2337 /**
2338 * Setup window.
2339 *
2340 * This is called by OO.ui.WindowManager during window opening, and should not be called directly
2341 * by other systems.
2342 *
2343 * @param {Object} [data] Window opening data
2344 * @return {jQuery.Promise} Promise resolved when window is setup
2345 */
2346 OO.ui.Window.prototype.setup = function ( data ) {
2347 var win = this;
2348
2349 this.toggle( true );
2350
2351 this.focusTrapHandler = OO.ui.bind( this.onFocusTrapFocused, this );
2352 this.$focusTraps.on( 'focus', this.focusTrapHandler );
2353
2354 return this.getSetupProcess( data ).execute().then( function () {
2355 // Force redraw by asking the browser to measure the elements' widths
2356 win.$element.addClass( 'oo-ui-window-active oo-ui-window-setup' ).width();
2357 win.$content.addClass( 'oo-ui-window-content-setup' ).width();
2358 } );
2359 };
2360
2361 /**
2362 * Ready window.
2363 *
2364 * This is called by OO.ui.WindowManager during window opening, and should not be called directly
2365 * by other systems.
2366 *
2367 * @param {Object} [data] Window opening data
2368 * @return {jQuery.Promise} Promise resolved when window is ready
2369 */
2370 OO.ui.Window.prototype.ready = function ( data ) {
2371 var win = this;
2372
2373 this.$content.focus();
2374 return this.getReadyProcess( data ).execute().then( function () {
2375 // Force redraw by asking the browser to measure the elements' widths
2376 win.$element.addClass( 'oo-ui-window-ready' ).width();
2377 win.$content.addClass( 'oo-ui-window-content-ready' ).width();
2378 } );
2379 };
2380
2381 /**
2382 * Hold window.
2383 *
2384 * This is called by OO.ui.WindowManager during window closing, and should not be called directly
2385 * by other systems.
2386 *
2387 * @param {Object} [data] Window closing data
2388 * @return {jQuery.Promise} Promise resolved when window is held
2389 */
2390 OO.ui.Window.prototype.hold = function ( data ) {
2391 var win = this;
2392
2393 return this.getHoldProcess( data ).execute().then( function () {
2394 // Get the focused element within the window's content
2395 var $focus = win.$content.find( OO.ui.Element.static.getDocument( win.$content ).activeElement );
2396
2397 // Blur the focused element
2398 if ( $focus.length ) {
2399 $focus[ 0 ].blur();
2400 }
2401
2402 // Force redraw by asking the browser to measure the elements' widths
2403 win.$element.removeClass( 'oo-ui-window-ready' ).width();
2404 win.$content.removeClass( 'oo-ui-window-content-ready' ).width();
2405 } );
2406 };
2407
2408 /**
2409 * Teardown window.
2410 *
2411 * This is called by OO.ui.WindowManager during window closing, and should not be called directly
2412 * by other systems.
2413 *
2414 * @param {Object} [data] Window closing data
2415 * @return {jQuery.Promise} Promise resolved when window is torn down
2416 */
2417 OO.ui.Window.prototype.teardown = function ( data ) {
2418 var win = this;
2419
2420 return this.getTeardownProcess( data ).execute().then( function () {
2421 // Force redraw by asking the browser to measure the elements' widths
2422 win.$element.removeClass( 'oo-ui-window-active oo-ui-window-setup' ).width();
2423 win.$content.removeClass( 'oo-ui-window-content-setup' ).width();
2424 win.$focusTraps.off( 'focus', win.focusTrapHandler );
2425 win.toggle( false );
2426 } );
2427 };
2428
2429 /**
2430 * The Dialog class serves as the base class for the other types of dialogs.
2431 * Unless extended to include controls, the rendered dialog box is a simple window
2432 * that users can close by hitting the ‘Esc’ key. Dialog windows are used with OO.ui.WindowManager,
2433 * which opens, closes, and controls the presentation of the window. See the
2434 * [OOjs UI documentation on MediaWiki] [1] for more information.
2435 *
2436 * @example
2437 * // A simple dialog window.
2438 * function MyDialog( config ) {
2439 * MyDialog.parent.call( this, config );
2440 * }
2441 * OO.inheritClass( MyDialog, OO.ui.Dialog );
2442 * MyDialog.static.name = 'myDialog';
2443 * MyDialog.prototype.initialize = function () {
2444 * MyDialog.parent.prototype.initialize.call( this );
2445 * this.content = new OO.ui.PanelLayout( { padded: true, expanded: false } );
2446 * this.content.$element.append( '<p>A simple dialog window. Press \'Esc\' to close.</p>' );
2447 * this.$body.append( this.content.$element );
2448 * };
2449 * MyDialog.prototype.getBodyHeight = function () {
2450 * return this.content.$element.outerHeight( true );
2451 * };
2452 * var myDialog = new MyDialog( {
2453 * size: 'medium'
2454 * } );
2455 * // Create and append a window manager, which opens and closes the window.
2456 * var windowManager = new OO.ui.WindowManager();
2457 * $( 'body' ).append( windowManager.$element );
2458 * windowManager.addWindows( [ myDialog ] );
2459 * // Open the window!
2460 * windowManager.openWindow( myDialog );
2461 *
2462 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Windows/Dialogs
2463 *
2464 * @abstract
2465 * @class
2466 * @extends OO.ui.Window
2467 * @mixins OO.ui.mixin.PendingElement
2468 *
2469 * @constructor
2470 * @param {Object} [config] Configuration options
2471 */
2472 OO.ui.Dialog = function OoUiDialog( config ) {
2473 // Parent constructor
2474 OO.ui.Dialog.parent.call( this, config );
2475
2476 // Mixin constructors
2477 OO.ui.mixin.PendingElement.call( this );
2478
2479 // Properties
2480 this.actions = new OO.ui.ActionSet();
2481 this.attachedActions = [];
2482 this.currentAction = null;
2483 this.onDialogKeyDownHandler = this.onDialogKeyDown.bind( this );
2484
2485 // Events
2486 this.actions.connect( this, {
2487 click: 'onActionClick',
2488 change: 'onActionsChange'
2489 } );
2490
2491 // Initialization
2492 this.$element
2493 .addClass( 'oo-ui-dialog' )
2494 .attr( 'role', 'dialog' );
2495 };
2496
2497 /* Setup */
2498
2499 OO.inheritClass( OO.ui.Dialog, OO.ui.Window );
2500 OO.mixinClass( OO.ui.Dialog, OO.ui.mixin.PendingElement );
2501
2502 /* Static Properties */
2503
2504 /**
2505 * Symbolic name of dialog.
2506 *
2507 * The dialog class must have a symbolic name in order to be registered with OO.Factory.
2508 * Please see the [OOjs UI documentation on MediaWiki] [3] for more information.
2509 *
2510 * [3]: https://www.mediawiki.org/wiki/OOjs_UI/Windows/Window_managers
2511 *
2512 * @abstract
2513 * @static
2514 * @inheritable
2515 * @property {string}
2516 */
2517 OO.ui.Dialog.static.name = '';
2518
2519 /**
2520 * The dialog title.
2521 *
2522 * The title can be specified as a plaintext string, a {@link OO.ui.mixin.LabelElement Label} node, or a function
2523 * that will produce a Label node or string. The title can also be specified with data passed to the
2524 * constructor (see #getSetupProcess). In this case, the static value will be overridden.
2525 *
2526 * @abstract
2527 * @static
2528 * @inheritable
2529 * @property {jQuery|string|Function}
2530 */
2531 OO.ui.Dialog.static.title = '';
2532
2533 /**
2534 * An array of configured {@link OO.ui.ActionWidget action widgets}.
2535 *
2536 * Actions can also be specified with data passed to the constructor (see #getSetupProcess). In this case, the static
2537 * value will be overridden.
2538 *
2539 * [2]: https://www.mediawiki.org/wiki/OOjs_UI/Windows/Process_Dialogs#Action_sets
2540 *
2541 * @static
2542 * @inheritable
2543 * @property {Object[]}
2544 */
2545 OO.ui.Dialog.static.actions = [];
2546
2547 /**
2548 * Close the dialog when the 'Esc' key is pressed.
2549 *
2550 * @static
2551 * @abstract
2552 * @inheritable
2553 * @property {boolean}
2554 */
2555 OO.ui.Dialog.static.escapable = true;
2556
2557 /* Methods */
2558
2559 /**
2560 * Handle frame document key down events.
2561 *
2562 * @private
2563 * @param {jQuery.Event} e Key down event
2564 */
2565 OO.ui.Dialog.prototype.onDialogKeyDown = function ( e ) {
2566 var actions;
2567 if ( e.which === OO.ui.Keys.ESCAPE && this.constructor.static.escapable ) {
2568 this.executeAction( '' );
2569 e.preventDefault();
2570 e.stopPropagation();
2571 } else if ( e.which === OO.ui.Keys.ENTER && ( e.ctrlKey || e.metaKey ) ) {
2572 actions = this.actions.get( { flags: 'primary', visible: true, disabled: false } );
2573 if ( actions.length > 0 ) {
2574 this.executeAction( actions[ 0 ].getAction() );
2575 e.preventDefault();
2576 e.stopPropagation();
2577 }
2578 }
2579 };
2580
2581 /**
2582 * Handle action click events.
2583 *
2584 * @private
2585 * @param {OO.ui.ActionWidget} action Action that was clicked
2586 */
2587 OO.ui.Dialog.prototype.onActionClick = function ( action ) {
2588 if ( !this.isPending() ) {
2589 this.executeAction( action.getAction() );
2590 }
2591 };
2592
2593 /**
2594 * Handle actions change event.
2595 *
2596 * @private
2597 */
2598 OO.ui.Dialog.prototype.onActionsChange = function () {
2599 this.detachActions();
2600 if ( !this.isClosing() ) {
2601 this.attachActions();
2602 }
2603 };
2604
2605 /**
2606 * Get the set of actions used by the dialog.
2607 *
2608 * @return {OO.ui.ActionSet}
2609 */
2610 OO.ui.Dialog.prototype.getActions = function () {
2611 return this.actions;
2612 };
2613
2614 /**
2615 * Get a process for taking action.
2616 *
2617 * When you override this method, you can create a new OO.ui.Process and return it, or add additional
2618 * accept steps to the process the parent method provides using the {@link OO.ui.Process#first 'first'}
2619 * and {@link OO.ui.Process#next 'next'} methods of OO.ui.Process.
2620 *
2621 * @param {string} [action] Symbolic name of action
2622 * @return {OO.ui.Process} Action process
2623 */
2624 OO.ui.Dialog.prototype.getActionProcess = function ( action ) {
2625 return new OO.ui.Process()
2626 .next( function () {
2627 if ( !action ) {
2628 // An empty action always closes the dialog without data, which should always be
2629 // safe and make no changes
2630 this.close();
2631 }
2632 }, this );
2633 };
2634
2635 /**
2636 * @inheritdoc
2637 *
2638 * @param {Object} [data] Dialog opening data
2639 * @param {jQuery|string|Function|null} [data.title] Dialog title, omit to use
2640 * the {@link #static-title static title}
2641 * @param {Object[]} [data.actions] List of configuration options for each
2642 * {@link OO.ui.ActionWidget action widget}, omit to use {@link #static-actions static actions}.
2643 */
2644 OO.ui.Dialog.prototype.getSetupProcess = function ( data ) {
2645 data = data || {};
2646
2647 // Parent method
2648 return OO.ui.Dialog.parent.prototype.getSetupProcess.call( this, data )
2649 .next( function () {
2650 var config = this.constructor.static,
2651 actions = data.actions !== undefined ? data.actions : config.actions,
2652 title = data.title !== undefined ? data.title : config.title;
2653
2654 this.title.setLabel( title ).setTitle( title );
2655 this.actions.add( this.getActionWidgets( actions ) );
2656
2657 this.$element.on( 'keydown', this.onDialogKeyDownHandler );
2658 }, this );
2659 };
2660
2661 /**
2662 * @inheritdoc
2663 */
2664 OO.ui.Dialog.prototype.getTeardownProcess = function ( data ) {
2665 // Parent method
2666 return OO.ui.Dialog.parent.prototype.getTeardownProcess.call( this, data )
2667 .first( function () {
2668 this.$element.off( 'keydown', this.onDialogKeyDownHandler );
2669
2670 this.actions.clear();
2671 this.currentAction = null;
2672 }, this );
2673 };
2674
2675 /**
2676 * @inheritdoc
2677 */
2678 OO.ui.Dialog.prototype.initialize = function () {
2679 // Parent method
2680 OO.ui.Dialog.parent.prototype.initialize.call( this );
2681
2682 // Properties
2683 this.title = new OO.ui.LabelWidget();
2684
2685 // Initialization
2686 this.$content.addClass( 'oo-ui-dialog-content' );
2687 this.$element.attr( 'aria-labelledby', this.title.getElementId() );
2688 this.setPendingElement( this.$head );
2689 };
2690
2691 /**
2692 * Get action widgets from a list of configs
2693 *
2694 * @param {Object[]} actions Action widget configs
2695 * @return {OO.ui.ActionWidget[]} Action widgets
2696 */
2697 OO.ui.Dialog.prototype.getActionWidgets = function ( actions ) {
2698 var i, len, widgets = [];
2699 for ( i = 0, len = actions.length; i < len; i++ ) {
2700 widgets.push(
2701 new OO.ui.ActionWidget( actions[ i ] )
2702 );
2703 }
2704 return widgets;
2705 };
2706
2707 /**
2708 * Attach action actions.
2709 *
2710 * @protected
2711 */
2712 OO.ui.Dialog.prototype.attachActions = function () {
2713 // Remember the list of potentially attached actions
2714 this.attachedActions = this.actions.get();
2715 };
2716
2717 /**
2718 * Detach action actions.
2719 *
2720 * @protected
2721 * @chainable
2722 */
2723 OO.ui.Dialog.prototype.detachActions = function () {
2724 var i, len;
2725
2726 // Detach all actions that may have been previously attached
2727 for ( i = 0, len = this.attachedActions.length; i < len; i++ ) {
2728 this.attachedActions[ i ].$element.detach();
2729 }
2730 this.attachedActions = [];
2731 };
2732
2733 /**
2734 * Execute an action.
2735 *
2736 * @param {string} action Symbolic name of action to execute
2737 * @return {jQuery.Promise} Promise resolved when action completes, rejected if it fails
2738 */
2739 OO.ui.Dialog.prototype.executeAction = function ( action ) {
2740 this.pushPending();
2741 this.currentAction = action;
2742 return this.getActionProcess( action ).execute()
2743 .always( this.popPending.bind( this ) );
2744 };
2745
2746 /**
2747 * MessageDialogs display a confirmation or alert message. By default, the rendered dialog box
2748 * consists of a header that contains the dialog title, a body with the message, and a footer that
2749 * contains any {@link OO.ui.ActionWidget action widgets}. The MessageDialog class is the only type
2750 * of {@link OO.ui.Dialog dialog} that is usually instantiated directly.
2751 *
2752 * There are two basic types of message dialogs, confirmation and alert:
2753 *
2754 * - **confirmation**: the dialog title describes what a progressive action will do and the message provides
2755 * more details about the consequences.
2756 * - **alert**: the dialog title describes which event occurred and the message provides more information
2757 * about why the event occurred.
2758 *
2759 * The MessageDialog class specifies two actions: ‘accept’, the primary
2760 * action (e.g., ‘ok’) and ‘reject,’ the safe action (e.g., ‘cancel’). Both will close the window,
2761 * passing along the selected action.
2762 *
2763 * For more information and examples, please see the [OOjs UI documentation on MediaWiki][1].
2764 *
2765 * @example
2766 * // Example: Creating and opening a message dialog window.
2767 * var messageDialog = new OO.ui.MessageDialog();
2768 *
2769 * // Create and append a window manager.
2770 * var windowManager = new OO.ui.WindowManager();
2771 * $( 'body' ).append( windowManager.$element );
2772 * windowManager.addWindows( [ messageDialog ] );
2773 * // Open the window.
2774 * windowManager.openWindow( messageDialog, {
2775 * title: 'Basic message dialog',
2776 * message: 'This is the message'
2777 * } );
2778 *
2779 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Windows/Message_Dialogs
2780 *
2781 * @class
2782 * @extends OO.ui.Dialog
2783 *
2784 * @constructor
2785 * @param {Object} [config] Configuration options
2786 */
2787 OO.ui.MessageDialog = function OoUiMessageDialog( config ) {
2788 // Parent constructor
2789 OO.ui.MessageDialog.parent.call( this, config );
2790
2791 // Properties
2792 this.verticalActionLayout = null;
2793
2794 // Initialization
2795 this.$element.addClass( 'oo-ui-messageDialog' );
2796 };
2797
2798 /* Setup */
2799
2800 OO.inheritClass( OO.ui.MessageDialog, OO.ui.Dialog );
2801
2802 /* Static Properties */
2803
2804 /**
2805 * @static
2806 * @inheritdoc
2807 */
2808 OO.ui.MessageDialog.static.name = 'message';
2809
2810 /**
2811 * @static
2812 * @inheritdoc
2813 */
2814 OO.ui.MessageDialog.static.size = 'small';
2815
2816 /**
2817 * Dialog title.
2818 *
2819 * The title of a confirmation dialog describes what a progressive action will do. The
2820 * title of an alert dialog describes which event occurred.
2821 *
2822 * @static
2823 * @inheritable
2824 * @property {jQuery|string|Function|null}
2825 */
2826 OO.ui.MessageDialog.static.title = null;
2827
2828 /**
2829 * The message displayed in the dialog body.
2830 *
2831 * A confirmation message describes the consequences of a progressive action. An alert
2832 * message describes why an event occurred.
2833 *
2834 * @static
2835 * @inheritable
2836 * @property {jQuery|string|Function|null}
2837 */
2838 OO.ui.MessageDialog.static.message = null;
2839
2840 /**
2841 * @static
2842 * @inheritdoc
2843 */
2844 OO.ui.MessageDialog.static.actions = [
2845 // Note that OO.ui.alert() and OO.ui.confirm() rely on these.
2846 { action: 'accept', label: OO.ui.deferMsg( 'ooui-dialog-message-accept' ), flags: 'primary' },
2847 { action: 'reject', label: OO.ui.deferMsg( 'ooui-dialog-message-reject' ), flags: 'safe' }
2848 ];
2849
2850 /* Methods */
2851
2852 /**
2853 * @inheritdoc
2854 */
2855 OO.ui.MessageDialog.prototype.setManager = function ( manager ) {
2856 OO.ui.MessageDialog.parent.prototype.setManager.call( this, manager );
2857
2858 // Events
2859 this.manager.connect( this, {
2860 resize: 'onResize'
2861 } );
2862
2863 return this;
2864 };
2865
2866 /**
2867 * Handle window resized events.
2868 *
2869 * @private
2870 */
2871 OO.ui.MessageDialog.prototype.onResize = function () {
2872 var dialog = this;
2873 dialog.fitActions();
2874 // Wait for CSS transition to finish and do it again :(
2875 setTimeout( function () {
2876 dialog.fitActions();
2877 }, 300 );
2878 };
2879
2880 /**
2881 * Toggle action layout between vertical and horizontal.
2882 *
2883 * @private
2884 * @param {boolean} [value] Layout actions vertically, omit to toggle
2885 * @chainable
2886 */
2887 OO.ui.MessageDialog.prototype.toggleVerticalActionLayout = function ( value ) {
2888 value = value === undefined ? !this.verticalActionLayout : !!value;
2889
2890 if ( value !== this.verticalActionLayout ) {
2891 this.verticalActionLayout = value;
2892 this.$actions
2893 .toggleClass( 'oo-ui-messageDialog-actions-vertical', value )
2894 .toggleClass( 'oo-ui-messageDialog-actions-horizontal', !value );
2895 }
2896
2897 return this;
2898 };
2899
2900 /**
2901 * @inheritdoc
2902 */
2903 OO.ui.MessageDialog.prototype.getActionProcess = function ( action ) {
2904 if ( action ) {
2905 return new OO.ui.Process( function () {
2906 this.close( { action: action } );
2907 }, this );
2908 }
2909 return OO.ui.MessageDialog.parent.prototype.getActionProcess.call( this, action );
2910 };
2911
2912 /**
2913 * @inheritdoc
2914 *
2915 * @param {Object} [data] Dialog opening data
2916 * @param {jQuery|string|Function|null} [data.title] Description of the action being confirmed
2917 * @param {jQuery|string|Function|null} [data.message] Description of the action's consequence
2918 * @param {string} [data.size] Symbolic name of the dialog size, see OO.ui.Window
2919 * @param {Object[]} [data.actions] List of OO.ui.ActionOptionWidget configuration options for each
2920 * action item
2921 */
2922 OO.ui.MessageDialog.prototype.getSetupProcess = function ( data ) {
2923 data = data || {};
2924
2925 // Parent method
2926 return OO.ui.MessageDialog.parent.prototype.getSetupProcess.call( this, data )
2927 .next( function () {
2928 this.title.setLabel(
2929 data.title !== undefined ? data.title : this.constructor.static.title
2930 );
2931 this.message.setLabel(
2932 data.message !== undefined ? data.message : this.constructor.static.message
2933 );
2934 this.size = data.size !== undefined ? data.size : this.constructor.static.size;
2935 }, this );
2936 };
2937
2938 /**
2939 * @inheritdoc
2940 */
2941 OO.ui.MessageDialog.prototype.getReadyProcess = function ( data ) {
2942 data = data || {};
2943
2944 // Parent method
2945 return OO.ui.MessageDialog.parent.prototype.getReadyProcess.call( this, data )
2946 .next( function () {
2947 // Focus the primary action button
2948 var actions = this.actions.get();
2949 actions = actions.filter( function ( action ) {
2950 return action.getFlags().indexOf( 'primary' ) > -1;
2951 } );
2952 if ( actions.length > 0 ) {
2953 actions[ 0 ].focus();
2954 }
2955 }, this );
2956 };
2957
2958 /**
2959 * @inheritdoc
2960 */
2961 OO.ui.MessageDialog.prototype.getBodyHeight = function () {
2962 var bodyHeight, oldOverflow,
2963 $scrollable = this.container.$element;
2964
2965 oldOverflow = $scrollable[ 0 ].style.overflow;
2966 $scrollable[ 0 ].style.overflow = 'hidden';
2967
2968 OO.ui.Element.static.reconsiderScrollbars( $scrollable[ 0 ] );
2969
2970 bodyHeight = this.text.$element.outerHeight( true );
2971 $scrollable[ 0 ].style.overflow = oldOverflow;
2972
2973 return bodyHeight;
2974 };
2975
2976 /**
2977 * @inheritdoc
2978 */
2979 OO.ui.MessageDialog.prototype.setDimensions = function ( dim ) {
2980 var $scrollable = this.container.$element;
2981 OO.ui.MessageDialog.parent.prototype.setDimensions.call( this, dim );
2982
2983 // Twiddle the overflow property, otherwise an unnecessary scrollbar will be produced.
2984 // Need to do it after transition completes (250ms), add 50ms just in case.
2985 setTimeout( function () {
2986 var oldOverflow = $scrollable[ 0 ].style.overflow,
2987 activeElement = document.activeElement;
2988
2989 $scrollable[ 0 ].style.overflow = 'hidden';
2990
2991 OO.ui.Element.static.reconsiderScrollbars( $scrollable[ 0 ] );
2992
2993 // Check reconsiderScrollbars didn't destroy our focus, as we
2994 // are doing this after the ready process.
2995 if ( activeElement && activeElement !== document.activeElement && activeElement.focus ) {
2996 activeElement.focus();
2997 }
2998
2999 $scrollable[ 0 ].style.overflow = oldOverflow;
3000 }, 300 );
3001
3002 return this;
3003 };
3004
3005 /**
3006 * @inheritdoc
3007 */
3008 OO.ui.MessageDialog.prototype.initialize = function () {
3009 // Parent method
3010 OO.ui.MessageDialog.parent.prototype.initialize.call( this );
3011
3012 // Properties
3013 this.$actions = $( '<div>' );
3014 this.container = new OO.ui.PanelLayout( {
3015 scrollable: true, classes: [ 'oo-ui-messageDialog-container' ]
3016 } );
3017 this.text = new OO.ui.PanelLayout( {
3018 padded: true, expanded: false, classes: [ 'oo-ui-messageDialog-text' ]
3019 } );
3020 this.message = new OO.ui.LabelWidget( {
3021 classes: [ 'oo-ui-messageDialog-message' ]
3022 } );
3023
3024 // Initialization
3025 this.title.$element.addClass( 'oo-ui-messageDialog-title' );
3026 this.$content.addClass( 'oo-ui-messageDialog-content' );
3027 this.container.$element.append( this.text.$element );
3028 this.text.$element.append( this.title.$element, this.message.$element );
3029 this.$body.append( this.container.$element );
3030 this.$actions.addClass( 'oo-ui-messageDialog-actions' );
3031 this.$foot.append( this.$actions );
3032 };
3033
3034 /**
3035 * @inheritdoc
3036 */
3037 OO.ui.MessageDialog.prototype.attachActions = function () {
3038 var i, len, other, special, others;
3039
3040 // Parent method
3041 OO.ui.MessageDialog.parent.prototype.attachActions.call( this );
3042
3043 special = this.actions.getSpecial();
3044 others = this.actions.getOthers();
3045
3046 if ( special.safe ) {
3047 this.$actions.append( special.safe.$element );
3048 special.safe.toggleFramed( false );
3049 }
3050 if ( others.length ) {
3051 for ( i = 0, len = others.length; i < len; i++ ) {
3052 other = others[ i ];
3053 this.$actions.append( other.$element );
3054 other.toggleFramed( false );
3055 }
3056 }
3057 if ( special.primary ) {
3058 this.$actions.append( special.primary.$element );
3059 special.primary.toggleFramed( false );
3060 }
3061
3062 if ( !this.isOpening() ) {
3063 // If the dialog is currently opening, this will be called automatically soon.
3064 // This also calls #fitActions.
3065 this.updateSize();
3066 }
3067 };
3068
3069 /**
3070 * Fit action actions into columns or rows.
3071 *
3072 * Columns will be used if all labels can fit without overflow, otherwise rows will be used.
3073 *
3074 * @private
3075 */
3076 OO.ui.MessageDialog.prototype.fitActions = function () {
3077 var i, len, action,
3078 previous = this.verticalActionLayout,
3079 actions = this.actions.get();
3080
3081 // Detect clipping
3082 this.toggleVerticalActionLayout( false );
3083 for ( i = 0, len = actions.length; i < len; i++ ) {
3084 action = actions[ i ];
3085 if ( action.$element.innerWidth() < action.$label.outerWidth( true ) ) {
3086 this.toggleVerticalActionLayout( true );
3087 break;
3088 }
3089 }
3090
3091 // Move the body out of the way of the foot
3092 this.$body.css( 'bottom', this.$foot.outerHeight( true ) );
3093
3094 if ( this.verticalActionLayout !== previous ) {
3095 // We changed the layout, window height might need to be updated.
3096 this.updateSize();
3097 }
3098 };
3099
3100 /**
3101 * ProcessDialog windows encapsulate a {@link OO.ui.Process process} and all of the code necessary
3102 * to complete it. If the process terminates with an error, a customizable {@link OO.ui.Error error
3103 * interface} alerts users to the trouble, permitting the user to dismiss the error and try again when
3104 * relevant. The ProcessDialog class is always extended and customized with the actions and content
3105 * required for each process.
3106 *
3107 * The process dialog box consists of a header that visually represents the ‘working’ state of long
3108 * processes with an animation. The header contains the dialog title as well as
3109 * two {@link OO.ui.ActionWidget action widgets}: a ‘safe’ action on the left (e.g., ‘Cancel’) and
3110 * a ‘primary’ action on the right (e.g., ‘Done’).
3111 *
3112 * Like other windows, the process dialog is managed by a {@link OO.ui.WindowManager window manager}.
3113 * Please see the [OOjs UI documentation on MediaWiki][1] for more information and examples.
3114 *
3115 * @example
3116 * // Example: Creating and opening a process dialog window.
3117 * function MyProcessDialog( config ) {
3118 * MyProcessDialog.parent.call( this, config );
3119 * }
3120 * OO.inheritClass( MyProcessDialog, OO.ui.ProcessDialog );
3121 *
3122 * MyProcessDialog.static.name = 'myProcessDialog';
3123 * MyProcessDialog.static.title = 'Process dialog';
3124 * MyProcessDialog.static.actions = [
3125 * { action: 'save', label: 'Done', flags: 'primary' },
3126 * { label: 'Cancel', flags: 'safe' }
3127 * ];
3128 *
3129 * MyProcessDialog.prototype.initialize = function () {
3130 * MyProcessDialog.parent.prototype.initialize.apply( this, arguments );
3131 * this.content = new OO.ui.PanelLayout( { padded: true, expanded: false } );
3132 * 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>' );
3133 * this.$body.append( this.content.$element );
3134 * };
3135 * MyProcessDialog.prototype.getActionProcess = function ( action ) {
3136 * var dialog = this;
3137 * if ( action ) {
3138 * return new OO.ui.Process( function () {
3139 * dialog.close( { action: action } );
3140 * } );
3141 * }
3142 * return MyProcessDialog.parent.prototype.getActionProcess.call( this, action );
3143 * };
3144 *
3145 * var windowManager = new OO.ui.WindowManager();
3146 * $( 'body' ).append( windowManager.$element );
3147 *
3148 * var dialog = new MyProcessDialog();
3149 * windowManager.addWindows( [ dialog ] );
3150 * windowManager.openWindow( dialog );
3151 *
3152 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Windows/Process_Dialogs
3153 *
3154 * @abstract
3155 * @class
3156 * @extends OO.ui.Dialog
3157 *
3158 * @constructor
3159 * @param {Object} [config] Configuration options
3160 */
3161 OO.ui.ProcessDialog = function OoUiProcessDialog( config ) {
3162 // Parent constructor
3163 OO.ui.ProcessDialog.parent.call( this, config );
3164
3165 // Properties
3166 this.fitOnOpen = false;
3167
3168 // Initialization
3169 this.$element.addClass( 'oo-ui-processDialog' );
3170 };
3171
3172 /* Setup */
3173
3174 OO.inheritClass( OO.ui.ProcessDialog, OO.ui.Dialog );
3175
3176 /* Methods */
3177
3178 /**
3179 * Handle dismiss button click events.
3180 *
3181 * Hides errors.
3182 *
3183 * @private
3184 */
3185 OO.ui.ProcessDialog.prototype.onDismissErrorButtonClick = function () {
3186 this.hideErrors();
3187 };
3188
3189 /**
3190 * Handle retry button click events.
3191 *
3192 * Hides errors and then tries again.
3193 *
3194 * @private
3195 */
3196 OO.ui.ProcessDialog.prototype.onRetryButtonClick = function () {
3197 this.hideErrors();
3198 this.executeAction( this.currentAction );
3199 };
3200
3201 /**
3202 * @inheritdoc
3203 */
3204 OO.ui.ProcessDialog.prototype.initialize = function () {
3205 // Parent method
3206 OO.ui.ProcessDialog.parent.prototype.initialize.call( this );
3207
3208 // Properties
3209 this.$navigation = $( '<div>' );
3210 this.$location = $( '<div>' );
3211 this.$safeActions = $( '<div>' );
3212 this.$primaryActions = $( '<div>' );
3213 this.$otherActions = $( '<div>' );
3214 this.dismissButton = new OO.ui.ButtonWidget( {
3215 label: OO.ui.msg( 'ooui-dialog-process-dismiss' )
3216 } );
3217 this.retryButton = new OO.ui.ButtonWidget();
3218 this.$errors = $( '<div>' );
3219 this.$errorsTitle = $( '<div>' );
3220
3221 // Events
3222 this.dismissButton.connect( this, { click: 'onDismissErrorButtonClick' } );
3223 this.retryButton.connect( this, { click: 'onRetryButtonClick' } );
3224
3225 // Initialization
3226 this.title.$element.addClass( 'oo-ui-processDialog-title' );
3227 this.$location
3228 .append( this.title.$element )
3229 .addClass( 'oo-ui-processDialog-location' );
3230 this.$safeActions.addClass( 'oo-ui-processDialog-actions-safe' );
3231 this.$primaryActions.addClass( 'oo-ui-processDialog-actions-primary' );
3232 this.$otherActions.addClass( 'oo-ui-processDialog-actions-other' );
3233 this.$errorsTitle
3234 .addClass( 'oo-ui-processDialog-errors-title' )
3235 .text( OO.ui.msg( 'ooui-dialog-process-error' ) );
3236 this.$errors
3237 .addClass( 'oo-ui-processDialog-errors oo-ui-element-hidden' )
3238 .append( this.$errorsTitle, this.dismissButton.$element, this.retryButton.$element );
3239 this.$content
3240 .addClass( 'oo-ui-processDialog-content' )
3241 .append( this.$errors );
3242 this.$navigation
3243 .addClass( 'oo-ui-processDialog-navigation' )
3244 // Note: Order of appends below is important. These are in the order
3245 // we want tab to go through them. Display-order is handled entirely
3246 // by CSS absolute-positioning. As such, primary actions like "done"
3247 // should go first.
3248 .append( this.$primaryActions, this.$location, this.$safeActions );
3249 this.$head.append( this.$navigation );
3250 this.$foot.append( this.$otherActions );
3251 };
3252
3253 /**
3254 * @inheritdoc
3255 */
3256 OO.ui.ProcessDialog.prototype.getActionWidgets = function ( actions ) {
3257 var i, len, config,
3258 isMobile = OO.ui.isMobile(),
3259 widgets = [];
3260
3261 for ( i = 0, len = actions.length; i < len; i++ ) {
3262 config = $.extend( { framed: !OO.ui.isMobile() }, actions[ i ] );
3263 if ( isMobile &&
3264 ( config.flags === 'back' || ( Array.isArray( config.flags ) && config.flags.indexOf( 'back' ) !== -1 ) )
3265 ) {
3266 $.extend( config, {
3267 icon: 'previous',
3268 label: ''
3269 } );
3270 }
3271 widgets.push(
3272 new OO.ui.ActionWidget( config )
3273 );
3274 }
3275 return widgets;
3276 };
3277
3278 /**
3279 * @inheritdoc
3280 */
3281 OO.ui.ProcessDialog.prototype.attachActions = function () {
3282 var i, len, other, special, others;
3283
3284 // Parent method
3285 OO.ui.ProcessDialog.parent.prototype.attachActions.call( this );
3286
3287 special = this.actions.getSpecial();
3288 others = this.actions.getOthers();
3289 if ( special.primary ) {
3290 this.$primaryActions.append( special.primary.$element );
3291 }
3292 for ( i = 0, len = others.length; i < len; i++ ) {
3293 other = others[ i ];
3294 this.$otherActions.append( other.$element );
3295 }
3296 if ( special.safe ) {
3297 this.$safeActions.append( special.safe.$element );
3298 }
3299
3300 this.fitLabel();
3301 this.$body.css( 'bottom', this.$foot.outerHeight( true ) );
3302 };
3303
3304 /**
3305 * @inheritdoc
3306 */
3307 OO.ui.ProcessDialog.prototype.executeAction = function ( action ) {
3308 var process = this;
3309 return OO.ui.ProcessDialog.parent.prototype.executeAction.call( this, action )
3310 .fail( function ( errors ) {
3311 process.showErrors( errors || [] );
3312 } );
3313 };
3314
3315 /**
3316 * @inheritdoc
3317 */
3318 OO.ui.ProcessDialog.prototype.setDimensions = function () {
3319 // Parent method
3320 OO.ui.ProcessDialog.parent.prototype.setDimensions.apply( this, arguments );
3321
3322 this.fitLabel();
3323 };
3324
3325 /**
3326 * Fit label between actions.
3327 *
3328 * @private
3329 * @chainable
3330 */
3331 OO.ui.ProcessDialog.prototype.fitLabel = function () {
3332 var safeWidth, primaryWidth, biggerWidth, labelWidth, navigationWidth, leftWidth, rightWidth,
3333 size = this.getSizeProperties();
3334
3335 if ( typeof size.width !== 'number' ) {
3336 if ( this.isOpened() ) {
3337 navigationWidth = this.$head.width() - 20;
3338 } else if ( this.isOpening() ) {
3339 if ( !this.fitOnOpen ) {
3340 // Size is relative and the dialog isn't open yet, so wait.
3341 // FIXME: This should ideally be handled by setup somehow.
3342 this.manager.lifecycle.opened.done( this.fitLabel.bind( this ) );
3343 this.fitOnOpen = true;
3344 }
3345 return;
3346 } else {
3347 return;
3348 }
3349 } else {
3350 navigationWidth = size.width - 20;
3351 }
3352
3353 safeWidth = this.$safeActions.is( ':visible' ) ? this.$safeActions.width() : 0;
3354 primaryWidth = this.$primaryActions.is( ':visible' ) ? this.$primaryActions.width() : 0;
3355 biggerWidth = Math.max( safeWidth, primaryWidth );
3356
3357 labelWidth = this.title.$element.width();
3358
3359 if ( 2 * biggerWidth + labelWidth < navigationWidth ) {
3360 // We have enough space to center the label
3361 leftWidth = rightWidth = biggerWidth;
3362 } else {
3363 // Let's hope we at least have enough space not to overlap, because we can't wrap the label…
3364 if ( this.getDir() === 'ltr' ) {
3365 leftWidth = safeWidth;
3366 rightWidth = primaryWidth;
3367 } else {
3368 leftWidth = primaryWidth;
3369 rightWidth = safeWidth;
3370 }
3371 }
3372
3373 this.$location.css( { paddingLeft: leftWidth, paddingRight: rightWidth } );
3374
3375 return this;
3376 };
3377
3378 /**
3379 * Handle errors that occurred during accept or reject processes.
3380 *
3381 * @private
3382 * @param {OO.ui.Error[]|OO.ui.Error} errors Errors to be handled
3383 */
3384 OO.ui.ProcessDialog.prototype.showErrors = function ( errors ) {
3385 var i, len, $item, actions,
3386 items = [],
3387 abilities = {},
3388 recoverable = true,
3389 warning = false;
3390
3391 if ( errors instanceof OO.ui.Error ) {
3392 errors = [ errors ];
3393 }
3394
3395 for ( i = 0, len = errors.length; i < len; i++ ) {
3396 if ( !errors[ i ].isRecoverable() ) {
3397 recoverable = false;
3398 }
3399 if ( errors[ i ].isWarning() ) {
3400 warning = true;
3401 }
3402 $item = $( '<div>' )
3403 .addClass( 'oo-ui-processDialog-error' )
3404 .append( errors[ i ].getMessage() );
3405 items.push( $item[ 0 ] );
3406 }
3407 this.$errorItems = $( items );
3408 if ( recoverable ) {
3409 abilities[ this.currentAction ] = true;
3410 // Copy the flags from the first matching action
3411 actions = this.actions.get( { actions: this.currentAction } );
3412 if ( actions.length ) {
3413 this.retryButton.clearFlags().setFlags( actions[ 0 ].getFlags() );
3414 }
3415 } else {
3416 abilities[ this.currentAction ] = false;
3417 this.actions.setAbilities( abilities );
3418 }
3419 if ( warning ) {
3420 this.retryButton.setLabel( OO.ui.msg( 'ooui-dialog-process-continue' ) );
3421 } else {
3422 this.retryButton.setLabel( OO.ui.msg( 'ooui-dialog-process-retry' ) );
3423 }
3424 this.retryButton.toggle( recoverable );
3425 this.$errorsTitle.after( this.$errorItems );
3426 this.$errors.removeClass( 'oo-ui-element-hidden' ).scrollTop( 0 );
3427 };
3428
3429 /**
3430 * Hide errors.
3431 *
3432 * @private
3433 */
3434 OO.ui.ProcessDialog.prototype.hideErrors = function () {
3435 this.$errors.addClass( 'oo-ui-element-hidden' );
3436 if ( this.$errorItems ) {
3437 this.$errorItems.remove();
3438 this.$errorItems = null;
3439 }
3440 };
3441
3442 /**
3443 * @inheritdoc
3444 */
3445 OO.ui.ProcessDialog.prototype.getTeardownProcess = function ( data ) {
3446 // Parent method
3447 return OO.ui.ProcessDialog.parent.prototype.getTeardownProcess.call( this, data )
3448 .first( function () {
3449 // Make sure to hide errors
3450 this.hideErrors();
3451 this.fitOnOpen = false;
3452 }, this );
3453 };
3454
3455 /**
3456 * @class OO.ui
3457 */
3458
3459 /**
3460 * Lazy-initialize and return a global OO.ui.WindowManager instance, used by OO.ui.alert and
3461 * OO.ui.confirm.
3462 *
3463 * @private
3464 * @return {OO.ui.WindowManager}
3465 */
3466 OO.ui.getWindowManager = function () {
3467 if ( !OO.ui.windowManager ) {
3468 OO.ui.windowManager = new OO.ui.WindowManager();
3469 $( 'body' ).append( OO.ui.windowManager.$element );
3470 OO.ui.windowManager.addWindows( [ new OO.ui.MessageDialog() ] );
3471 }
3472 return OO.ui.windowManager;
3473 };
3474
3475 /**
3476 * Display a quick modal alert dialog, using a OO.ui.MessageDialog. While the dialog is open, the
3477 * rest of the page will be dimmed out and the user won't be able to interact with it. The dialog
3478 * has only one action button, labelled "OK", clicking it will simply close the dialog.
3479 *
3480 * A window manager is created automatically when this function is called for the first time.
3481 *
3482 * @example
3483 * OO.ui.alert( 'Something happened!' ).done( function () {
3484 * console.log( 'User closed the dialog.' );
3485 * } );
3486 *
3487 * OO.ui.alert( 'Something larger happened!', { size: 'large' } );
3488 *
3489 * @param {jQuery|string} text Message text to display
3490 * @param {Object} [options] Additional options, see OO.ui.MessageDialog#getSetupProcess
3491 * @return {jQuery.Promise} Promise resolved when the user closes the dialog
3492 */
3493 OO.ui.alert = function ( text, options ) {
3494 return OO.ui.getWindowManager().openWindow( 'message', $.extend( {
3495 message: text,
3496 actions: [ OO.ui.MessageDialog.static.actions[ 0 ] ]
3497 }, options ) ).closed.then( function () {
3498 return undefined;
3499 } );
3500 };
3501
3502 /**
3503 * Display a quick modal confirmation dialog, using a OO.ui.MessageDialog. While the dialog is open,
3504 * the rest of the page will be dimmed out and the user won't be able to interact with it. The
3505 * dialog has two action buttons, one to confirm an operation (labelled "OK") and one to cancel it
3506 * (labelled "Cancel").
3507 *
3508 * A window manager is created automatically when this function is called for the first time.
3509 *
3510 * @example
3511 * OO.ui.confirm( 'Are you sure?' ).done( function ( confirmed ) {
3512 * if ( confirmed ) {
3513 * console.log( 'User clicked "OK"!' );
3514 * } else {
3515 * console.log( 'User clicked "Cancel" or closed the dialog.' );
3516 * }
3517 * } );
3518 *
3519 * @param {jQuery|string} text Message text to display
3520 * @param {Object} [options] Additional options, see OO.ui.MessageDialog#getSetupProcess
3521 * @return {jQuery.Promise} Promise resolved when the user closes the dialog. If the user chose to
3522 * confirm, the promise will resolve to boolean `true`; otherwise, it will resolve to boolean
3523 * `false`.
3524 */
3525 OO.ui.confirm = function ( text, options ) {
3526 return OO.ui.getWindowManager().openWindow( 'message', $.extend( {
3527 message: text
3528 }, options ) ).closed.then( function ( data ) {
3529 return !!( data && data.action === 'accept' );
3530 } );
3531 };
3532
3533 /**
3534 * Display a quick modal prompt dialog, using a OO.ui.MessageDialog. While the dialog is open,
3535 * the rest of the page will be dimmed out and the user won't be able to interact with it. The
3536 * dialog has a text input widget and two action buttons, one to confirm an operation (labelled "OK")
3537 * and one to cancel it (labelled "Cancel").
3538 *
3539 * A window manager is created automatically when this function is called for the first time.
3540 *
3541 * @example
3542 * OO.ui.prompt( 'Choose a line to go to', { textInput: { placeholder: 'Line number' } } ).done( function ( result ) {
3543 * if ( result !== null ) {
3544 * console.log( 'User typed "' + result + '" then clicked "OK".' );
3545 * } else {
3546 * console.log( 'User clicked "Cancel" or closed the dialog.' );
3547 * }
3548 * } );
3549 *
3550 * @param {jQuery|string} text Message text to display
3551 * @param {Object} [options] Additional options, see OO.ui.MessageDialog#getSetupProcess
3552 * @param {Object} [options.textInput] Additional options for text input widget, see OO.ui.TextInputWidget
3553 * @return {jQuery.Promise} Promise resolved when the user closes the dialog. If the user chose to
3554 * confirm, the promise will resolve with the value of the text input widget; otherwise, it will
3555 * resolve to `null`.
3556 */
3557 OO.ui.prompt = function ( text, options ) {
3558 var instance,
3559 manager = OO.ui.getWindowManager(),
3560 textInput = new OO.ui.TextInputWidget( ( options && options.textInput ) || {} ),
3561 textField = new OO.ui.FieldLayout( textInput, {
3562 align: 'top',
3563 label: text
3564 } );
3565
3566 instance = manager.openWindow( 'message', $.extend( {
3567 message: textField.$element
3568 }, options ) );
3569
3570 // TODO: This is a little hacky, and could be done by extending MessageDialog instead.
3571 instance.opened.then( function () {
3572 textInput.on( 'enter', function () {
3573 manager.getCurrentWindow().close( { action: 'accept' } );
3574 } );
3575 textInput.focus();
3576 } );
3577
3578 return instance.closed.then( function ( data ) {
3579 return data && data.action === 'accept' ? textInput.getValue() : null;
3580 } );
3581 };
3582
3583 }( OO ) );
3584
3585 //# sourceMappingURL=oojs-ui-windows.js.map