3 * https://www.mediawiki.org/wiki/OOjs_UI
5 * Copyright 2011–2017 OOjs UI Team and other contributors.
6 * Released under the MIT license
7 * http://oojs.mit-license.org
9 * Date: 2017-05-31T19:07:36Z
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
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
24 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Windows/Process_Dialogs#Action_sets
27 * @extends OO.ui.ButtonWidget
28 * @mixins OO.ui.mixin.PendingElement
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
38 OO
.ui
.ActionWidget
= function OoUiActionWidget( config
) {
39 // Configuration initialization
40 config
= $.extend( { framed
: false }, config
);
43 OO
.ui
.ActionWidget
.parent
.call( this, config
);
46 OO
.ui
.mixin
.PendingElement
.call( this, config
);
49 this.action
= config
.action
|| '';
50 this.modes
= config
.modes
|| [];
55 this.$element
.addClass( 'oo-ui-actionWidget' );
60 OO
.inheritClass( OO
.ui
.ActionWidget
, OO
.ui
.ButtonWidget
);
61 OO
.mixinClass( OO
.ui
.ActionWidget
, OO
.ui
.mixin
.PendingElement
);
66 * Check if the action is configured to be available in the specified `mode`.
68 * @param {string} mode Name of mode
69 * @return {boolean} The action is configured with the mode
71 OO
.ui
.ActionWidget
.prototype.hasMode = function ( mode
) {
72 return this.modes
.indexOf( mode
) !== -1;
76 * Get the symbolic name of the action (e.g., ‘continue’ or ‘cancel’).
80 OO
.ui
.ActionWidget
.prototype.getAction = function () {
85 * Get the symbolic name of the mode or modes for which the action is configured to be available.
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
93 OO
.ui
.ActionWidget
.prototype.getModes = function () {
94 return this.modes
.slice();
97 /* eslint-disable no-unused-vars */
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}.
103 * ActionSets contain two types of actions:
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.
108 * Please see the [OOjs UI documentation on MediaWiki][1] for more information.
111 * // Example: An action set used in a process dialog
112 * function MyProcessDialog( config ) {
113 * MyProcessDialog.parent.call( this, config );
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', 'constructive' ] },
121 * { action: 'help', modes: 'edit', label: 'Help' },
122 * { modes: 'edit', label: 'Cancel', flags: 'safe' },
123 * { action: 'back', modes: 'help', label: 'Back', flags: 'safe' }
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 ]
135 * this.$body.append( this.stackLayout.$element );
137 * MyProcessDialog.prototype.getSetupProcess = function ( data ) {
138 * return MyProcessDialog.parent.prototype.getSetupProcess.call( this, data )
139 * .next( function () {
140 * this.actions.setMode( 'edit' );
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' ) {
152 * return new OO.ui.Process( function () {
156 * return MyProcessDialog.parent.prototype.getActionProcess.call( this, action );
158 * MyProcessDialog.prototype.getBodyHeight = function () {
159 * return this.panel1.$element.outerHeight( true );
161 * var windowManager = new OO.ui.WindowManager();
162 * $( 'body' ).append( windowManager.$element );
163 * var dialog = new MyProcessDialog( {
166 * windowManager.addWindows( [ dialog ] );
167 * windowManager.openWindow( dialog );
169 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Windows/Process_Dialogs#Action_sets
173 * @mixins OO.EventEmitter
176 * @param {Object} [config] Configuration options
178 OO
.ui
.ActionSet
= function OoUiActionSet( config
) {
179 // Configuration initialization
180 config
= config
|| {};
182 // Mixin constructors
183 OO
.EventEmitter
.call( this );
188 actions
: 'getAction',
192 this.categorized
= {};
195 this.organized
= false;
196 this.changing
= false;
197 this.changed
= false;
199 /* eslint-enable no-unused-vars */
203 OO
.mixinClass( OO
.ui
.ActionSet
, OO
.EventEmitter
);
205 /* Static Properties */
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.
212 * [2]:https://www.mediawiki.org/wiki/OOjs_UI/Windows/Process_Dialogs
219 OO
.ui
.ActionSet
.static.specialFlags
= [ 'safe', 'primary' ];
226 * A 'click' event is emitted when an action is clicked.
228 * @param {OO.ui.ActionWidget} action Action that was clicked
234 * An 'add' event is emitted when actions are {@link #method-add added} to the action set.
236 * @param {OO.ui.ActionWidget[]} added Actions added
242 * A 'remove' event is emitted when actions are {@link #method-remove removed}
243 * or {@link #clear cleared}.
245 * @param {OO.ui.ActionWidget[]} added Actions removed
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.
259 * Handle action change events.
264 OO
.ui
.ActionSet
.prototype.onActionChange = function () {
265 this.organized
= false;
266 if ( this.changing
) {
269 this.emit( 'change' );
274 * Check if an action is one of the special actions.
276 * @param {OO.ui.ActionWidget} action Action to check
277 * @return {boolean} Action is special
279 OO
.ui
.ActionSet
.prototype.isSpecial = function ( action
) {
282 for ( flag
in this.special
) {
283 if ( action
=== this.special
[ flag
] ) {
292 * Get action widgets based on the specified filter: ‘actions’, ‘flags’, ‘modes’, ‘visible’,
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
303 OO
.ui
.ActionSet
.prototype.get = function ( filters
) {
304 var i
, len
, list
, category
, actions
, index
, match
, matches
;
309 // Collect category candidates
311 for ( category
in this.categorized
) {
312 list
= filters
[ category
];
314 if ( !Array
.isArray( list
) ) {
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
);
325 // Remove by boolean filters
326 for ( i
= 0, len
= matches
.length
; i
< len
; i
++ ) {
327 match
= matches
[ i
];
329 ( filters
.visible
!== undefined && match
.isVisible() !== filters
.visible
) ||
330 ( filters
.disabled
!== undefined && match
.isDisabled() !== filters
.disabled
)
332 matches
.splice( i
, 1 );
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 );
344 index
= matches
.lastIndexOf( match
);
349 return this.list
.slice();
353 * Get 'special' actions.
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.
358 * @return {OO.ui.ActionWidget[]|null} 'Special' action widgets.
360 OO
.ui
.ActionSet
.prototype.getSpecial = function () {
362 return $.extend( {}, this.special
);
366 * Get 'other' actions.
368 * Other actions include all non-special visible action widgets.
370 * @return {OO.ui.ActionWidget[]} 'Other' action widgets
372 OO
.ui
.ActionSet
.prototype.getOthers = function () {
374 return this.others
.slice();
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.
381 * @param {string} mode The mode. Only actions configured to be available in the specified
382 * mode will be made visible.
387 OO
.ui
.ActionSet
.prototype.setMode = function ( mode
) {
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
) );
396 this.organized
= false;
397 this.changing
= false;
398 this.emit( 'change' );
404 * Set the abilities of the specified actions.
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`
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.
414 OO
.ui
.ActionSet
.prototype.setAbilities = function ( actions
) {
415 var i
, len
, action
, item
;
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
] );
429 * Executes a function once per action.
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.
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
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' );
452 * Add action widgets to the action set.
454 * @param {OO.ui.ActionWidget[]} actions Action widgets to add
459 OO
.ui
.ActionSet
.prototype.add = function ( actions
) {
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' ]
469 this.list
.push( action
);
471 this.organized
= false;
472 this.emit( 'add', actions
);
473 this.changing
= false;
474 this.emit( 'change' );
480 * Remove action widgets from the set.
482 * To remove all actions, you may wish to use the #clear method instead.
484 * @param {OO.ui.ActionWidget[]} actions Action widgets to remove
489 OO
.ui
.ActionSet
.prototype.remove = function ( actions
) {
490 var i
, len
, index
, action
;
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 );
501 this.organized
= false;
502 this.emit( 'remove', actions
);
503 this.changing
= false;
504 this.emit( 'change' );
510 * Remove all action widets from the set.
512 * To remove only specified actions, use the {@link #method-remove remove} method instead.
518 OO
.ui
.ActionSet
.prototype.clear = function () {
520 removed
= this.list
.slice();
522 this.changing
= true;
523 for ( i
= 0, len
= this.list
.length
; i
< len
; i
++ ) {
524 action
= this.list
[ i
];
525 action
.disconnect( this );
530 this.organized
= false;
531 this.emit( 'remove', removed
);
532 this.changing
= false;
533 this.emit( 'change' );
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.
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
;
551 if ( !this.organized
) {
552 this.categorized
= {};
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
] = {};
563 list
= action
[ this.categories
[ category
] ]();
564 if ( !Array
.isArray( list
) ) {
567 for ( j
= 0, jLen
= list
.length
; j
< jLen
; j
++ ) {
569 if ( !this.categorized
[ category
][ item
] ) {
570 this.categorized
[ category
][ item
] = [];
572 this.categorized
[ category
][ item
].push( action
);
575 // Populate special/others
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
;
586 this.others
.push( action
);
590 this.organized
= true;
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.
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.
605 * If the error is a warning, the error interface will include a 'Dismiss' and a 'Continue' button, which will try the
608 * For an example of error interfaces, please see the [OOjs UI documentation on MediaWiki][1].
610 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Windows/Process_Dialogs#Processes_and_errors
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.
624 OO
.ui
.Error
= function OoUiError( message
, config
) {
625 // Allow passing positional parameters inside the config object
626 if ( OO
.isPlainObject( message
) && config
=== undefined ) {
628 message
= config
.message
;
631 // Configuration initialization
632 config
= config
|| {};
635 this.message
= message
instanceof jQuery
? message
: String( message
);
636 this.recoverable
= config
.recoverable
=== undefined || !!config
.recoverable
;
637 this.warning
= !!config
.warning
;
642 OO
.initClass( OO
.ui
.Error
);
647 * Check if the error is recoverable.
649 * If the error is recoverable, users are able to try the process again.
651 * @return {boolean} Error is recoverable
653 OO
.ui
.Error
.prototype.isRecoverable = function () {
654 return this.recoverable
;
658 * Check if the error is a warning.
660 * If the error is a warning, the error interface will include a 'Dismiss' and a 'Continue' button.
662 * @return {boolean} Error is warning
664 OO
.ui
.Error
.prototype.isWarning = function () {
669 * Get error message as DOM nodes.
671 * @return {jQuery} Error message in DOM nodes
673 OO
.ui
.Error
.prototype.getMessage = function () {
674 return this.message
instanceof jQuery
?
675 this.message
.clone() :
676 $( '<div>' ).text( this.message
).contents();
680 * Get the error message text.
682 * @return {string} Error message
684 OO
.ui
.Error
.prototype.getMessageText = function () {
685 return this.message
instanceof jQuery
? this.message
.text() : this.message
;
689 * A Process is a list of steps that are called in sequence. The step can be a number, a jQuery promise,
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.
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.
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.
711 OO
.ui
.Process = function ( step
, context
) {
716 if ( step
!== undefined ) {
717 this.next( step
, context
);
723 OO
.initClass( OO
.ui
.Process
);
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.
734 OO
.ui
.Process
.prototype.execute = function () {
738 * Continue execution.
741 * @param {Array} step A function and the context it should be called in
742 * @return {Function} Function that continues the process
744 function proceed( step
) {
746 // Execute step in the correct context
748 result
= step
.callback
.call( step
.context
);
750 if ( result
=== false ) {
751 // Use rejected promise for boolean false results
752 return $.Deferred().reject( [] ).promise();
754 if ( typeof result
=== 'number' ) {
756 throw new Error( 'Cannot go back in time: flux capacitor is out of service' );
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();
763 if ( result
instanceof OO
.ui
.Error
) {
764 // Use rejected promise for error
765 return $.Deferred().reject( [ result
] ).promise();
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();
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();
776 // Use resolved promise for other results
777 return $.Deferred().resolve().promise();
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
] ) );
788 promise
= $.Deferred().resolve().promise();
795 * Create a process step.
798 * @param {number|jQuery.Promise|Function} step
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
812 OO
.ui
.Process
.prototype.createStep = function ( step
, context
) {
813 if ( typeof step
=== 'number' || $.isFunction( step
.promise
) ) {
815 callback: function () {
821 if ( $.isFunction( step
) ) {
827 throw new Error( 'Cannot create process step: number, promise or function expected' );
831 * Add step to the beginning of the process.
833 * @inheritdoc #createStep
834 * @return {OO.ui.Process} this
837 OO
.ui
.Process
.prototype.first = function ( step
, context
) {
838 this.steps
.unshift( this.createStep( step
, context
) );
843 * Add step to the end of the process.
845 * @inheritdoc #createStep
846 * @return {OO.ui.Process} this
849 OO
.ui
.Process
.prototype.next = function ( step
, context
) {
850 this.steps
.push( this.createStep( step
, context
) );
855 * A window instance represents the life cycle for one single opening of a window
858 * While OO.ui.WindowManager will reuse OO.ui.Window objects, each time a window is
859 * opened, a new lifecycle starts.
861 * For more information, please see the [OOjs UI documentation on MediaWiki] [1].
863 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Windows
869 OO
.ui
.WindowInstance
= function OOuiWindowInstance() {
871 opening
: $.Deferred(),
872 opened
: $.Deferred(),
873 closing
: $.Deferred(),
881 this.deferreds
= deferreds
;
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.
888 * @property {jQuery.Promise}
890 this.opening
= deferreds
.opening
.promise();
892 * @property {jQuery.Promise}
894 this.opened
= this.opening
.then( function () {
895 return deferreds
.opened
;
898 * @property {jQuery.Promise}
900 this.closing
= this.opened
.then( function () {
901 return deferreds
.closing
;
904 * @property {jQuery.Promise}
906 this.closed
= this.closing
.then( function () {
907 return deferreds
.closed
;
913 OO
.initClass( OO
.ui
.WindowInstance
);
916 * Window managers are used to open and close {@link OO.ui.Window windows} and control their presentation.
917 * Managed windows are mutually exclusive. If a new window is opened while a current window is opening
918 * or is opened, the current window will be closed and any ongoing {@link OO.ui.Process process} will be cancelled. Windows
919 * themselves are persistent and—rather than being torn down when closed—can be repopulated with the
920 * pertinent data and reused.
922 * Over the lifecycle of a window, the window manager makes available three promises: `opening`,
923 * `opened`, and `closing`, which represent the primary stages of the cycle:
925 * **Opening**: the opening stage begins when the window manager’s #openWindow or a window’s
926 * {@link OO.ui.Window#open open} method is used, and the window manager begins to open the window.
928 * - an `opening` event is emitted with an `opening` promise
929 * - the #getSetupDelay method is called and the returned value is used to time a pause in execution before the
930 * window’s {@link OO.ui.Window#method-setup setup} method is called which executes OO.ui.Window#getSetupProcess.
931 * - a `setup` progress notification is emitted from the `opening` promise
932 * - the #getReadyDelay method is called the returned value is used to time a pause in execution before the
933 * window’s {@link OO.ui.Window#method-ready ready} method is called which executes OO.ui.Window#getReadyProcess.
934 * - a `ready` progress notification is emitted from the `opening` promise
935 * - the `opening` promise is resolved with an `opened` promise
937 * **Opened**: the window is now open.
939 * **Closing**: the closing stage begins when the window manager's #closeWindow or the
940 * window's {@link OO.ui.Window#close close} methods is used, and the window manager begins
941 * to close the window.
943 * - the `opened` promise is resolved with `closing` promise and a `closing` event is emitted
944 * - the #getHoldDelay method is called and the returned value is used to time a pause in execution before
945 * the window's {@link OO.ui.Window#getHoldProcess getHoldProces} method is called on the
946 * window and its result executed
947 * - a `hold` progress notification is emitted from the `closing` promise
948 * - the #getTeardownDelay() method is called and the returned value is used to time a pause in execution before
949 * the window's {@link OO.ui.Window#getTeardownProcess getTeardownProcess} method is called on the
950 * window and its result executed
951 * - a `teardown` progress notification is emitted from the `closing` promise
952 * - the `closing` promise is resolved. The window is now closed
954 * See the [OOjs UI documentation on MediaWiki][1] for more information.
956 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Windows/Window_managers
959 * @extends OO.ui.Element
960 * @mixins OO.EventEmitter
963 * @param {Object} [config] Configuration options
964 * @cfg {OO.Factory} [factory] Window factory to use for automatic instantiation
965 * Note that window classes that are instantiated with a factory must have
966 * a {@link OO.ui.Dialog#static-name static name} property that specifies a symbolic name.
967 * @cfg {boolean} [modal=true] Prevent interaction outside the dialog
969 OO
.ui
.WindowManager
= function OoUiWindowManager( config
) {
970 // Configuration initialization
971 config
= config
|| {};
973 // Parent constructor
974 OO
.ui
.WindowManager
.parent
.call( this, config
);
976 // Mixin constructors
977 OO
.EventEmitter
.call( this );
980 this.factory
= config
.factory
;
981 this.modal
= config
.modal
=== undefined || !!config
.modal
;
983 // Deprecated placeholder promise given to compatOpening in openWindow()
984 // that is resolved in closeWindow().
985 this.compatOpened
= null;
986 this.preparingToOpen
= null;
987 this.preparingToClose
= null;
988 this.currentWindow
= null;
989 this.globalEvents
= false;
990 this.$returnFocusTo
= null;
991 this.$ariaHidden
= null;
992 this.onWindowResizeTimeout
= null;
993 this.onWindowResizeHandler
= this.onWindowResize
.bind( this );
994 this.afterWindowResizeHandler
= this.afterWindowResize
.bind( this );
998 .addClass( 'oo-ui-windowManager' )
999 .toggleClass( 'oo-ui-windowManager-modal', this.modal
);
1004 OO
.inheritClass( OO
.ui
.WindowManager
, OO
.ui
.Element
);
1005 OO
.mixinClass( OO
.ui
.WindowManager
, OO
.EventEmitter
);
1010 * An 'opening' event is emitted when the window begins to be opened.
1013 * @param {OO.ui.Window} win Window that's being opened
1014 * @param {jQuery.Promise} opened A promise resolved with a value when the window is opened successfully.
1015 * This promise also emits `setup` and `ready` notifications. When this promise is resolved, the first
1016 * argument of the value is an 'closed' promise, the second argument is the opening data.
1017 * @param {Object} data Window opening data
1021 * A 'closing' event is emitted when the window begins to be closed.
1024 * @param {OO.ui.Window} win Window that's being closed
1025 * @param {jQuery.Promise} closed A promise resolved with a value when the window is closed successfully.
1026 * This promise also emits `hold` and `teardown` notifications. When this promise is resolved, the first
1027 * argument of its value is the closing data.
1028 * @param {Object} data Window closing data
1032 * A 'resize' event is emitted when a window is resized.
1035 * @param {OO.ui.Window} win Window that was resized
1038 /* Static Properties */
1041 * Map of the symbolic name of each window size and its CSS properties.
1045 * @property {Object}
1047 OO
.ui
.WindowManager
.static.sizes
= {
1061 // These can be non-numeric because they are never used in calculations
1068 * Symbolic name of the default window size.
1070 * The default size is used if the window's requested size is not recognized.
1074 * @property {string}
1076 OO
.ui
.WindowManager
.static.defaultSize
= 'medium';
1081 * Handle window resize events.
1084 * @param {jQuery.Event} e Window resize event
1086 OO
.ui
.WindowManager
.prototype.onWindowResize = function () {
1087 clearTimeout( this.onWindowResizeTimeout
);
1088 this.onWindowResizeTimeout
= setTimeout( this.afterWindowResizeHandler
, 200 );
1092 * Handle window resize events.
1095 * @param {jQuery.Event} e Window resize event
1097 OO
.ui
.WindowManager
.prototype.afterWindowResize = function () {
1098 if ( this.currentWindow
) {
1099 this.updateWindowSize( this.currentWindow
);
1104 * Check if window is opening.
1106 * @param {OO.ui.Window} win Window to check
1107 * @return {boolean} Window is opening
1109 OO
.ui
.WindowManager
.prototype.isOpening = function ( win
) {
1110 return win
=== this.currentWindow
&& !!this.lifecycle
&&
1111 this.lifecycle
.opened
.state() === 'pending';
1115 * Check if window is closing.
1117 * @param {OO.ui.Window} win Window to check
1118 * @return {boolean} Window is closing
1120 OO
.ui
.WindowManager
.prototype.isClosing = function ( win
) {
1121 return win
=== this.currentWindow
&& !!this.lifecycle
&&
1122 this.lifecycle
.closing
.state() === 'resolved' &&
1123 this.lifecycle
.closed
.state() === 'pending';
1127 * Check if window is opened.
1129 * @param {OO.ui.Window} win Window to check
1130 * @return {boolean} Window is opened
1132 OO
.ui
.WindowManager
.prototype.isOpened = function ( win
) {
1133 return win
=== this.currentWindow
&& !!this.lifecycle
&&
1134 this.lifecycle
.opened
.state() === 'resolved' &&
1135 this.lifecycle
.closing
.state() === 'pending';
1139 * Check if a window is being managed.
1141 * @param {OO.ui.Window} win Window to check
1142 * @return {boolean} Window is being managed
1144 OO
.ui
.WindowManager
.prototype.hasWindow = function ( win
) {
1147 for ( name
in this.windows
) {
1148 if ( this.windows
[ name
] === win
) {
1157 * Get the number of milliseconds to wait after opening begins before executing the ‘setup’ process.
1159 * @param {OO.ui.Window} win Window being opened
1160 * @param {Object} [data] Window opening data
1161 * @return {number} Milliseconds to wait
1163 OO
.ui
.WindowManager
.prototype.getSetupDelay = function () {
1168 * Get the number of milliseconds to wait after setup has finished before executing the ‘ready’ process.
1170 * @param {OO.ui.Window} win Window being opened
1171 * @param {Object} [data] Window opening data
1172 * @return {number} Milliseconds to wait
1174 OO
.ui
.WindowManager
.prototype.getReadyDelay = function () {
1179 * Get the number of milliseconds to wait after closing has begun before executing the 'hold' process.
1181 * @param {OO.ui.Window} win Window being closed
1182 * @param {Object} [data] Window closing data
1183 * @return {number} Milliseconds to wait
1185 OO
.ui
.WindowManager
.prototype.getHoldDelay = function () {
1190 * Get the number of milliseconds to wait after the ‘hold’ process has finished before
1191 * executing the ‘teardown’ process.
1193 * @param {OO.ui.Window} win Window being closed
1194 * @param {Object} [data] Window closing data
1195 * @return {number} Milliseconds to wait
1197 OO
.ui
.WindowManager
.prototype.getTeardownDelay = function () {
1198 return this.modal
? 250 : 0;
1202 * Get a window by its symbolic name.
1204 * If the window is not yet instantiated and its symbolic name is recognized by a factory, it will be
1205 * instantiated and added to the window manager automatically. Please see the [OOjs UI documentation on MediaWiki][3]
1206 * for more information about using factories.
1207 * [3]: https://www.mediawiki.org/wiki/OOjs_UI/Windows/Window_managers
1209 * @param {string} name Symbolic name of the window
1210 * @return {jQuery.Promise} Promise resolved with matching window, or rejected with an OO.ui.Error
1211 * @throws {Error} An error is thrown if the symbolic name is not recognized by the factory.
1212 * @throws {Error} An error is thrown if the named window is not recognized as a managed window.
1214 OO
.ui
.WindowManager
.prototype.getWindow = function ( name
) {
1215 var deferred
= $.Deferred(),
1216 win
= this.windows
[ name
];
1218 if ( !( win
instanceof OO
.ui
.Window
) ) {
1219 if ( this.factory
) {
1220 if ( !this.factory
.lookup( name
) ) {
1221 deferred
.reject( new OO
.ui
.Error(
1222 'Cannot auto-instantiate window: symbolic name is unrecognized by the factory'
1225 win
= this.factory
.create( name
);
1226 this.addWindows( [ win
] );
1227 deferred
.resolve( win
);
1230 deferred
.reject( new OO
.ui
.Error(
1231 'Cannot get unmanaged window: symbolic name unrecognized as a managed window'
1235 deferred
.resolve( win
);
1238 return deferred
.promise();
1242 * Get current window.
1244 * @return {OO.ui.Window|null} Currently opening/opened/closing window
1246 OO
.ui
.WindowManager
.prototype.getCurrentWindow = function () {
1247 return this.currentWindow
;
1253 * @param {OO.ui.Window|string} win Window object or symbolic name of window to open
1254 * @param {Object} [data] Window opening data
1255 * @param {jQuery|null} [data.$returnFocusTo] Element to which the window will return focus when closed.
1256 * Defaults the current activeElement. If set to null, focus isn't changed on close.
1257 * @return {OO.ui.WindowInstance|jQuery.Promise} A lifecycle object representing this particular
1258 * opening of the window. For backwards-compatibility, then object is also a Thenable that is resolved
1259 * when the window is done opening, with nested promise for when closing starts. This behaviour
1260 * is deprecated and is not compatible with jQuery 3 (T163510).
1263 OO
.ui
.WindowManager
.prototype.openWindow = function ( win
, data
, lifecycle
, compatOpening
) {
1267 // Internal parameter 'lifecycle' allows this method to always return
1268 // a lifecycle even if the window still needs to be created
1269 // asynchronously when 'win' is a string.
1270 lifecycle
= lifecycle
|| new OO
.ui
.WindowInstance();
1271 compatOpening
= compatOpening
|| $.Deferred();
1273 // Turn lifecycle into a Thenable for backwards-compatibility with
1274 // the deprecated nested-promise behaviour (T163510).
1275 [ 'state', 'always', 'catch', 'pipe', 'then', 'promise', 'progress', 'done', 'fail' ]
1276 .forEach( function ( method
) {
1277 lifecycle
[ method
] = function () {
1278 OO
.ui
.warnDeprecation(
1279 'Using the return value of openWindow as a promise is deprecated. ' +
1280 'Use .openWindow( ... ).opening.' + method
+ '( ... ) instead.'
1282 return compatOpening
[ method
].apply( this, arguments
);
1286 // Argument handling
1287 if ( typeof win
=== 'string' ) {
1288 this.getWindow( win
).then(
1290 manager
.openWindow( win
, data
, lifecycle
, compatOpening
);
1293 lifecycle
.deferreds
.opening
.reject( err
);
1300 if ( !this.hasWindow( win
) ) {
1301 compatOpening
.reject( new OO
.ui
.Error(
1302 'Cannot open window: window is not attached to manager'
1304 lifecycle
.deferreds
.opening
.reject( new OO
.ui
.Error(
1305 'Cannot open window: window is not attached to manager'
1309 if ( this.preparingToOpen
|| ( this.lifecycle
&& this.lifecycle
.closing
.state() !== 'resolved' ) ) {
1310 compatOpening
.reject( new OO
.ui
.Error(
1311 'Cannot open window: another window is opening or open'
1313 lifecycle
.deferreds
.opening
.reject( new OO
.ui
.Error(
1314 'Cannot open window: another window is opening or open'
1319 // If a window is currently closing, wait for it to complete
1320 this.preparingToOpen
= $.when( this.lifecycle
&& this.lifecycle
.closed
);
1321 // Ensure handlers get called after preparingToOpen is set
1322 this.preparingToOpen
.done( function () {
1323 if ( manager
.modal
) {
1324 manager
.toggleGlobalEvents( true );
1325 manager
.toggleAriaIsolation( true );
1327 manager
.$returnFocusTo
= data
.$returnFocusTo
!== undefined ? data
.$returnFocusTo
: $( document
.activeElement
);
1328 manager
.currentWindow
= win
;
1329 manager
.lifecycle
= lifecycle
;
1330 manager
.preparingToOpen
= null;
1331 manager
.emit( 'opening', win
, compatOpening
, data
);
1332 lifecycle
.deferreds
.opening
.resolve( data
);
1333 setTimeout( function () {
1334 manager
.compatOpened
= $.Deferred();
1335 win
.setup( data
).then( function () {
1336 manager
.updateWindowSize( win
);
1337 compatOpening
.notify( { state
: 'setup' } );
1338 setTimeout( function () {
1339 win
.ready( data
).then( function () {
1340 compatOpening
.notify( { state
: 'ready' } );
1341 lifecycle
.deferreds
.opened
.resolve( data
);
1342 compatOpening
.resolve( manager
.compatOpened
.promise(), data
);
1344 lifecycle
.deferreds
.opened
.reject();
1345 compatOpening
.reject();
1346 manager
.closeWindow( win
);
1348 }, manager
.getReadyDelay() );
1350 lifecycle
.deferreds
.opened
.reject();
1351 compatOpening
.reject();
1352 manager
.closeWindow( win
);
1354 }, manager
.getSetupDelay() );
1363 * @param {OO.ui.Window|string} win Window object or symbolic name of window to close
1364 * @param {Object} [data] Window closing data
1365 * @return {OO.ui.WindowInstance|jQuery.Promise} A lifecycle object representing this particular
1366 * opening of the window. For backwards-compatibility, the object is also a Thenable that is resolved
1367 * when the window is done closing (T163510).
1370 OO
.ui
.WindowManager
.prototype.closeWindow = function ( win
, data
) {
1373 compatClosing
= $.Deferred(),
1374 lifecycle
= this.lifecycle
,
1377 // Argument handling
1378 if ( typeof win
=== 'string' ) {
1379 win
= this.windows
[ win
];
1380 } else if ( !this.hasWindow( win
) ) {
1386 error
= 'Cannot close window: no window is currently open';
1387 } else if ( !win
) {
1388 error
= 'Cannot close window: window is not attached to manager';
1389 } else if ( win
!== this.currentWindow
) {
1390 error
= 'Cannot close window: window already closed with different data';
1391 } else if ( this.preparingToClose
|| lifecycle
.closing
.state() === 'resolved' ) {
1392 error
= 'Cannot close window: window already closing with different data';
1396 // This function was called for the wrong window and we don't want to mess with the current
1398 lifecycle
= new OO
.ui
.WindowInstance();
1399 // Pretend the window has been opened, so that we can pretend to fail to close it.
1400 lifecycle
.deferreds
.opening
.resolve( {} );
1401 lifecycle
.deferreds
.opened
.resolve( {} );
1404 // Turn lifecycle into a Thenable for backwards-compatibility with
1405 // the deprecated nested-promise behaviour (T163510).
1406 [ 'state', 'always', 'catch', 'pipe', 'then', 'promise', 'progress', 'done', 'fail' ]
1407 .forEach( function ( method
) {
1408 lifecycle
[ method
] = function () {
1409 OO
.ui
.warnDeprecation(
1410 'Using the return value of closeWindow as a promise is deprecated. ' +
1411 'Use .closeWindow( ... ).closed.' + method
+ '( ... ) instead.'
1413 return compatClosing
[ method
].apply( this, arguments
);
1418 compatClosing
.reject( new OO
.ui
.Error( error
) );
1419 lifecycle
.deferreds
.closing
.reject( new OO
.ui
.Error( error
) );
1423 // If the window is currently opening, close it when it's done
1424 this.preparingToClose
= $.when( this.lifecycle
.opened
);
1425 // Ensure handlers get called after preparingToClose is set
1426 this.preparingToClose
.always( function () {
1427 manager
.preparingToClose
= null;
1428 manager
.emit( 'closing', win
, compatClosing
, data
);
1429 lifecycle
.deferreds
.closing
.resolve( data
);
1430 compatOpened
= manager
.compatOpened
;
1431 manager
.compatOpened
= null;
1432 compatOpened
.resolve( compatClosing
.promise(), data
);
1433 setTimeout( function () {
1434 win
.hold( data
).then( function () {
1435 compatClosing
.notify( { state
: 'hold' } );
1436 setTimeout( function () {
1437 win
.teardown( data
).then( function () {
1438 compatClosing
.notify( { state
: 'teardown' } );
1439 if ( manager
.modal
) {
1440 manager
.toggleGlobalEvents( false );
1441 manager
.toggleAriaIsolation( false );
1443 if ( manager
.$returnFocusTo
&& manager
.$returnFocusTo
.length
) {
1444 manager
.$returnFocusTo
[ 0 ].focus();
1446 manager
.currentWindow
= null;
1447 manager
.lifecycle
= null;
1448 lifecycle
.deferreds
.closed
.resolve( data
);
1449 compatClosing
.resolve( data
);
1451 }, manager
.getTeardownDelay() );
1453 }, manager
.getHoldDelay() );
1460 * Add windows to the window manager.
1462 * Windows can be added by reference, symbolic name, or explicitly defined symbolic names.
1463 * See the [OOjs ui documentation on MediaWiki] [2] for examples.
1464 * [2]: https://www.mediawiki.org/wiki/OOjs_UI/Windows/Window_managers
1466 * This function can be called in two manners:
1468 * 1. `.addWindows( [ windowA, windowB, ... ] )` (where `windowA`, `windowB` are OO.ui.Window objects)
1470 * This syntax registers windows under the symbolic names defined in their `.static.name`
1471 * properties. For example, if `windowA.constructor.static.name` is `'nameA'`, calling
1472 * `.openWindow( 'nameA' )` afterwards will open the window `windowA`. This syntax requires the
1473 * static name to be set, otherwise an exception will be thrown.
1475 * This is the recommended way, as it allows for an easier switch to using a window factory.
1477 * 2. `.addWindows( { nameA: windowA, nameB: windowB, ... } )`
1479 * This syntax registers windows under the explicitly given symbolic names. In this example,
1480 * calling `.openWindow( 'nameA' )` afterwards will open the window `windowA`, regardless of what
1481 * its `.static.name` is set to. The static name is not required to be set.
1483 * This should only be used if you need to override the default symbolic names.
1487 * var windowManager = new OO.ui.WindowManager();
1488 * $( 'body' ).append( windowManager.$element );
1490 * // Add a window under the default name: see OO.ui.MessageDialog.static.name
1491 * windowManager.addWindows( [ new OO.ui.MessageDialog() ] );
1492 * // Add a window under an explicit name
1493 * windowManager.addWindows( { myMessageDialog: new OO.ui.MessageDialog() } );
1495 * // Open window by default name
1496 * windowManager.openWindow( 'message' );
1497 * // Open window by explicitly given name
1498 * windowManager.openWindow( 'myMessageDialog' );
1501 * @param {Object.<string,OO.ui.Window>|OO.ui.Window[]} windows An array of window objects specified
1502 * by reference, symbolic name, or explicitly defined symbolic names.
1503 * @throws {Error} An error is thrown if a window is added by symbolic name, but has neither an
1504 * explicit nor a statically configured symbolic name.
1506 OO
.ui
.WindowManager
.prototype.addWindows = function ( windows
) {
1507 var i
, len
, win
, name
, list
;
1509 if ( Array
.isArray( windows
) ) {
1510 // Convert to map of windows by looking up symbolic names from static configuration
1512 for ( i
= 0, len
= windows
.length
; i
< len
; i
++ ) {
1513 name
= windows
[ i
].constructor.static.name
;
1515 throw new Error( 'Windows must have a `name` static property defined.' );
1517 list
[ name
] = windows
[ i
];
1519 } else if ( OO
.isPlainObject( windows
) ) {
1524 for ( name
in list
) {
1526 this.windows
[ name
] = win
.toggle( false );
1527 this.$element
.append( win
.$element
);
1528 win
.setManager( this );
1533 * Remove the specified windows from the windows manager.
1535 * Windows will be closed before they are removed. If you wish to remove all windows, you may wish to use
1536 * the #clearWindows method instead. If you no longer need the window manager and want to ensure that it no
1537 * longer listens to events, use the #destroy method.
1539 * @param {string[]} names Symbolic names of windows to remove
1540 * @return {jQuery.Promise} Promise resolved when window is closed and removed
1541 * @throws {Error} An error is thrown if the named windows are not managed by the window manager.
1543 OO
.ui
.WindowManager
.prototype.removeWindows = function ( names
) {
1544 var i
, len
, win
, name
, cleanupWindow
,
1547 cleanup = function ( name
, win
) {
1548 delete manager
.windows
[ name
];
1549 win
.$element
.detach();
1552 for ( i
= 0, len
= names
.length
; i
< len
; i
++ ) {
1554 win
= this.windows
[ name
];
1556 throw new Error( 'Cannot remove window' );
1558 cleanupWindow
= cleanup
.bind( null, name
, win
);
1559 promises
.push( this.closeWindow( name
).closed
.then( cleanupWindow
, cleanupWindow
) );
1562 return $.when
.apply( $, promises
);
1566 * Remove all windows from the window manager.
1568 * Windows will be closed before they are removed. Note that the window manager, though not in use, will still
1569 * listen to events. If the window manager will not be used again, you may wish to use the #destroy method instead.
1570 * To remove just a subset of windows, use the #removeWindows method.
1572 * @return {jQuery.Promise} Promise resolved when all windows are closed and removed
1574 OO
.ui
.WindowManager
.prototype.clearWindows = function () {
1575 return this.removeWindows( Object
.keys( this.windows
) );
1579 * Set dialog size. In general, this method should not be called directly.
1581 * Fullscreen mode will be used if the dialog is too wide to fit in the screen.
1583 * @param {OO.ui.Window} win Window to update, should be the current window
1586 OO
.ui
.WindowManager
.prototype.updateWindowSize = function ( win
) {
1589 // Bypass for non-current, and thus invisible, windows
1590 if ( win
!== this.currentWindow
) {
1594 isFullscreen
= win
.getSize() === 'full';
1596 this.$element
.toggleClass( 'oo-ui-windowManager-fullscreen', isFullscreen
);
1597 this.$element
.toggleClass( 'oo-ui-windowManager-floating', !isFullscreen
);
1598 win
.setDimensions( win
.getSizeProperties() );
1600 this.emit( 'resize', win
);
1606 * Bind or unbind global events for scrolling.
1609 * @param {boolean} [on] Bind global events
1612 OO
.ui
.WindowManager
.prototype.toggleGlobalEvents = function ( on
) {
1613 var scrollWidth
, bodyMargin
,
1614 $body
= $( this.getElementDocument().body
),
1615 // We could have multiple window managers open so only modify
1616 // the body css at the bottom of the stack
1617 stackDepth
= $body
.data( 'windowManagerGlobalEvents' ) || 0;
1619 on
= on
=== undefined ? !!this.globalEvents
: !!on
;
1622 if ( !this.globalEvents
) {
1623 $( this.getElementWindow() ).on( {
1624 // Start listening for top-level window dimension changes
1625 'orientationchange resize': this.onWindowResizeHandler
1627 if ( stackDepth
=== 0 ) {
1628 scrollWidth
= window
.innerWidth
- document
.documentElement
.clientWidth
;
1629 bodyMargin
= parseFloat( $body
.css( 'margin-right' ) ) || 0;
1632 'margin-right': bodyMargin
+ scrollWidth
1636 this.globalEvents
= true;
1638 } else if ( this.globalEvents
) {
1639 $( this.getElementWindow() ).off( {
1640 // Stop listening for top-level window dimension changes
1641 'orientationchange resize': this.onWindowResizeHandler
1644 if ( stackDepth
=== 0 ) {
1650 this.globalEvents
= false;
1652 $body
.data( 'windowManagerGlobalEvents', stackDepth
);
1658 * Toggle screen reader visibility of content other than the window manager.
1661 * @param {boolean} [isolate] Make only the window manager visible to screen readers
1664 OO
.ui
.WindowManager
.prototype.toggleAriaIsolation = function ( isolate
) {
1665 isolate
= isolate
=== undefined ? !this.$ariaHidden
: !!isolate
;
1668 if ( !this.$ariaHidden
) {
1669 // Hide everything other than the window manager from screen readers
1670 this.$ariaHidden
= $( 'body' )
1672 .not( this.$element
.parentsUntil( 'body' ).last() )
1673 .attr( 'aria-hidden', '' );
1675 } else if ( this.$ariaHidden
) {
1676 // Restore screen reader visibility
1677 this.$ariaHidden
.removeAttr( 'aria-hidden' );
1678 this.$ariaHidden
= null;
1685 * Destroy the window manager.
1687 * Destroying the window manager ensures that it will no longer listen to events. If you would like to
1688 * continue using the window manager, but wish to remove all windows from it, use the #clearWindows method
1691 OO
.ui
.WindowManager
.prototype.destroy = function () {
1692 this.toggleGlobalEvents( false );
1693 this.toggleAriaIsolation( false );
1694 this.clearWindows();
1695 this.$element
.remove();
1699 * A window is a container for elements that are in a child frame. They are used with
1700 * a window manager (OO.ui.WindowManager), which is used to open and close the window and control
1701 * its presentation. The size of a window is specified using a symbolic name (e.g., ‘small’, ‘medium’,
1702 * ‘large’), which is interpreted by the window manager. If the requested size is not recognized,
1703 * the window manager will choose a sensible fallback.
1705 * The lifecycle of a window has three primary stages (opening, opened, and closing) in which
1706 * different processes are executed:
1708 * **opening**: The opening stage begins when the window manager's {@link OO.ui.WindowManager#openWindow
1709 * openWindow} or the window's {@link #open open} methods are used, and the window manager begins to open
1712 * - {@link #getSetupProcess} method is called and its result executed
1713 * - {@link #getReadyProcess} method is called and its result executed
1715 * **opened**: The window is now open
1717 * **closing**: The closing stage begins when the window manager's
1718 * {@link OO.ui.WindowManager#closeWindow closeWindow}
1719 * or the window's {@link #close} methods are used, and the window manager begins to close the window.
1721 * - {@link #getHoldProcess} method is called and its result executed
1722 * - {@link #getTeardownProcess} method is called and its result executed. The window is now closed
1724 * Each of the window's processes (setup, ready, hold, and teardown) can be extended in subclasses
1725 * by overriding the window's #getSetupProcess, #getReadyProcess, #getHoldProcess and #getTeardownProcess
1726 * methods. Note that each {@link OO.ui.Process process} is executed in series, so asynchronous
1727 * processing can complete. Always assume window processes are executed asynchronously.
1729 * For more information, please see the [OOjs UI documentation on MediaWiki] [1].
1731 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Windows
1735 * @extends OO.ui.Element
1736 * @mixins OO.EventEmitter
1739 * @param {Object} [config] Configuration options
1740 * @cfg {string} [size] Symbolic name of the dialog size: `small`, `medium`, `large`, `larger` or
1741 * `full`. If omitted, the value of the {@link #static-size static size} property will be used.
1743 OO
.ui
.Window
= function OoUiWindow( config
) {
1744 // Configuration initialization
1745 config
= config
|| {};
1747 // Parent constructor
1748 OO
.ui
.Window
.parent
.call( this, config
);
1750 // Mixin constructors
1751 OO
.EventEmitter
.call( this );
1754 this.manager
= null;
1755 this.size
= config
.size
|| this.constructor.static.size
;
1756 this.$frame
= $( '<div>' );
1758 * Overlay element to use for the `$overlay` configuration option of widgets that support it.
1759 * Things put inside of it are overlaid on top of the window and are not bound to its dimensions.
1760 * See <https://www.mediawiki.org/wiki/OOjs_UI/Concepts#Overlays>.
1762 * MyDialog.prototype.initialize = function () {
1764 * var popupButton = new OO.ui.PopupButtonWidget( {
1765 * $overlay: this.$overlay,
1766 * label: 'Popup button',
1768 * $content: $( '<p>Popup contents.</p><p>Popup contents.</p><p>Popup contents.</p>' ),
1775 * @property {jQuery}
1777 this.$overlay
= $( '<div>' );
1778 this.$content
= $( '<div>' );
1780 this.$focusTrapBefore
= $( '<div>' ).prop( 'tabIndex', 0 );
1781 this.$focusTrapAfter
= $( '<div>' ).prop( 'tabIndex', 0 );
1782 this.$focusTraps
= this.$focusTrapBefore
.add( this.$focusTrapAfter
);
1785 this.$overlay
.addClass( 'oo-ui-window-overlay' );
1787 .addClass( 'oo-ui-window-content' )
1788 .attr( 'tabindex', 0 );
1790 .addClass( 'oo-ui-window-frame' )
1791 .append( this.$focusTrapBefore
, this.$content
, this.$focusTrapAfter
);
1794 .addClass( 'oo-ui-window' )
1795 .append( this.$frame
, this.$overlay
);
1797 // Initially hidden - using #toggle may cause errors if subclasses override toggle with methods
1798 // that reference properties not initialized at that time of parent class construction
1799 // TODO: Find a better way to handle post-constructor setup
1800 this.visible
= false;
1801 this.$element
.addClass( 'oo-ui-element-hidden' );
1806 OO
.inheritClass( OO
.ui
.Window
, OO
.ui
.Element
);
1807 OO
.mixinClass( OO
.ui
.Window
, OO
.EventEmitter
);
1809 /* Static Properties */
1812 * Symbolic name of the window size: `small`, `medium`, `large`, `larger` or `full`.
1814 * The static size is used if no #size is configured during construction.
1818 * @property {string}
1820 OO
.ui
.Window
.static.size
= 'medium';
1825 * Handle mouse down events.
1828 * @param {jQuery.Event} e Mouse down event
1830 OO
.ui
.Window
.prototype.onMouseDown = function ( e
) {
1831 // Prevent clicking on the click-block from stealing focus
1832 if ( e
.target
=== this.$element
[ 0 ] ) {
1838 * Check if the window has been initialized.
1840 * Initialization occurs when a window is added to a manager.
1842 * @return {boolean} Window has been initialized
1844 OO
.ui
.Window
.prototype.isInitialized = function () {
1845 return !!this.manager
;
1849 * Check if the window is visible.
1851 * @return {boolean} Window is visible
1853 OO
.ui
.Window
.prototype.isVisible = function () {
1854 return this.visible
;
1858 * Check if the window is opening.
1860 * This method is a wrapper around the window manager's {@link OO.ui.WindowManager#isOpening isOpening}
1863 * @return {boolean} Window is opening
1865 OO
.ui
.Window
.prototype.isOpening = function () {
1866 return this.manager
.isOpening( this );
1870 * Check if the window is closing.
1872 * This method is a wrapper around the window manager's {@link OO.ui.WindowManager#isClosing isClosing} method.
1874 * @return {boolean} Window is closing
1876 OO
.ui
.Window
.prototype.isClosing = function () {
1877 return this.manager
.isClosing( this );
1881 * Check if the window is opened.
1883 * This method is a wrapper around the window manager's {@link OO.ui.WindowManager#isOpened isOpened} method.
1885 * @return {boolean} Window is opened
1887 OO
.ui
.Window
.prototype.isOpened = function () {
1888 return this.manager
.isOpened( this );
1892 * Get the window manager.
1894 * All windows must be attached to a window manager, which is used to open
1895 * and close the window and control its presentation.
1897 * @return {OO.ui.WindowManager} Manager of window
1899 OO
.ui
.Window
.prototype.getManager = function () {
1900 return this.manager
;
1904 * Get the symbolic name of the window size (e.g., `small` or `medium`).
1906 * @return {string} Symbolic name of the size: `small`, `medium`, `large`, `larger`, `full`
1908 OO
.ui
.Window
.prototype.getSize = function () {
1909 var viewport
= OO
.ui
.Element
.static.getDimensions( this.getElementWindow() ),
1910 sizes
= this.manager
.constructor.static.sizes
,
1913 if ( !sizes
[ size
] ) {
1914 size
= this.manager
.constructor.static.defaultSize
;
1916 if ( size
!== 'full' && viewport
.rect
.right
- viewport
.rect
.left
< sizes
[ size
].width
) {
1924 * Get the size properties associated with the current window size
1926 * @return {Object} Size properties
1928 OO
.ui
.Window
.prototype.getSizeProperties = function () {
1929 return this.manager
.constructor.static.sizes
[ this.getSize() ];
1933 * Disable transitions on window's frame for the duration of the callback function, then enable them
1937 * @param {Function} callback Function to call while transitions are disabled
1939 OO
.ui
.Window
.prototype.withoutSizeTransitions = function ( callback
) {
1940 // Temporarily resize the frame so getBodyHeight() can use scrollHeight measurements.
1941 // Disable transitions first, otherwise we'll get values from when the window was animating.
1942 // We need to build the transition CSS properties using these specific properties since
1943 // Firefox doesn't return anything useful when asked just for 'transition'.
1944 var oldTransition
= this.$frame
.css( 'transition-property' ) + ' ' +
1945 this.$frame
.css( 'transition-duration' ) + ' ' +
1946 this.$frame
.css( 'transition-timing-function' ) + ' ' +
1947 this.$frame
.css( 'transition-delay' );
1949 this.$frame
.css( 'transition', 'none' );
1952 // Force reflow to make sure the style changes done inside callback
1953 // really are not transitioned
1954 this.$frame
.height();
1955 this.$frame
.css( 'transition', oldTransition
);
1959 * Get the height of the full window contents (i.e., the window head, body and foot together).
1961 * What consistitutes the head, body, and foot varies depending on the window type.
1962 * A {@link OO.ui.MessageDialog message dialog} displays a title and message in its body,
1963 * and any actions in the foot. A {@link OO.ui.ProcessDialog process dialog} displays a title
1964 * and special actions in the head, and dialog content in the body.
1966 * To get just the height of the dialog body, use the #getBodyHeight method.
1968 * @return {number} The height of the window contents (the dialog head, body and foot) in pixels
1970 OO
.ui
.Window
.prototype.getContentHeight = function () {
1973 bodyStyleObj
= this.$body
[ 0 ].style
,
1974 frameStyleObj
= this.$frame
[ 0 ].style
;
1976 // Temporarily resize the frame so getBodyHeight() can use scrollHeight measurements.
1977 // Disable transitions first, otherwise we'll get values from when the window was animating.
1978 this.withoutSizeTransitions( function () {
1979 var oldHeight
= frameStyleObj
.height
,
1980 oldPosition
= bodyStyleObj
.position
;
1981 frameStyleObj
.height
= '1px';
1982 // Force body to resize to new width
1983 bodyStyleObj
.position
= 'relative';
1984 bodyHeight
= win
.getBodyHeight();
1985 frameStyleObj
.height
= oldHeight
;
1986 bodyStyleObj
.position
= oldPosition
;
1990 // Add buffer for border
1991 ( this.$frame
.outerHeight() - this.$frame
.innerHeight() ) +
1992 // Use combined heights of children
1993 ( this.$head
.outerHeight( true ) + bodyHeight
+ this.$foot
.outerHeight( true ) )
1998 * Get the height of the window body.
2000 * To get the height of the full window contents (the window body, head, and foot together),
2001 * use #getContentHeight.
2003 * When this function is called, the window will temporarily have been resized
2004 * to height=1px, so .scrollHeight measurements can be taken accurately.
2006 * @return {number} Height of the window body in pixels
2008 OO
.ui
.Window
.prototype.getBodyHeight = function () {
2009 return this.$body
[ 0 ].scrollHeight
;
2013 * Get the directionality of the frame (right-to-left or left-to-right).
2015 * @return {string} Directionality: `'ltr'` or `'rtl'`
2017 OO
.ui
.Window
.prototype.getDir = function () {
2018 return OO
.ui
.Element
.static.getDir( this.$content
) || 'ltr';
2022 * Get the 'setup' process.
2024 * The setup process is used to set up a window for use in a particular context,
2025 * based on the `data` argument. This method is called during the opening phase of the window’s
2028 * Override this method to add additional steps to the ‘setup’ process the parent method provides
2029 * using the {@link OO.ui.Process#first first} and {@link OO.ui.Process#next next} methods
2032 * To add window content that persists between openings, you may wish to use the #initialize method
2035 * @param {Object} [data] Window opening data
2036 * @return {OO.ui.Process} Setup process
2038 OO
.ui
.Window
.prototype.getSetupProcess = function () {
2039 return new OO
.ui
.Process();
2043 * Get the ‘ready’ process.
2045 * The ready process is used to ready a window for use in a particular
2046 * context, based on the `data` argument. This method is called during the opening phase of
2047 * the window’s lifecycle, after the window has been {@link #getSetupProcess setup}.
2049 * Override this method to add additional steps to the ‘ready’ process the parent method
2050 * provides using the {@link OO.ui.Process#first first} and {@link OO.ui.Process#next next}
2051 * methods of OO.ui.Process.
2053 * @param {Object} [data] Window opening data
2054 * @return {OO.ui.Process} Ready process
2056 OO
.ui
.Window
.prototype.getReadyProcess = function () {
2057 return new OO
.ui
.Process();
2061 * Get the 'hold' process.
2063 * The hold process is used to keep a window from being used in a particular context,
2064 * based on the `data` argument. This method is called during the closing phase of the window’s
2067 * Override this method to add additional steps to the 'hold' process the parent method provides
2068 * using the {@link OO.ui.Process#first first} and {@link OO.ui.Process#next next} methods
2071 * @param {Object} [data] Window closing data
2072 * @return {OO.ui.Process} Hold process
2074 OO
.ui
.Window
.prototype.getHoldProcess = function () {
2075 return new OO
.ui
.Process();
2079 * Get the ‘teardown’ process.
2081 * The teardown process is used to teardown a window after use. During teardown,
2082 * user interactions within the window are conveyed and the window is closed, based on the `data`
2083 * argument. This method is called during the closing phase of the window’s lifecycle.
2085 * Override this method to add additional steps to the ‘teardown’ process the parent method provides
2086 * using the {@link OO.ui.Process#first first} and {@link OO.ui.Process#next next} methods
2089 * @param {Object} [data] Window closing data
2090 * @return {OO.ui.Process} Teardown process
2092 OO
.ui
.Window
.prototype.getTeardownProcess = function () {
2093 return new OO
.ui
.Process();
2097 * Set the window manager.
2099 * This will cause the window to initialize. Calling it more than once will cause an error.
2101 * @param {OO.ui.WindowManager} manager Manager for this window
2102 * @throws {Error} An error is thrown if the method is called more than once
2105 OO
.ui
.Window
.prototype.setManager = function ( manager
) {
2106 if ( this.manager
) {
2107 throw new Error( 'Cannot set window manager, window already has a manager' );
2110 this.manager
= manager
;
2117 * Set the window size by symbolic name (e.g., 'small' or 'medium')
2119 * @param {string} size Symbolic name of size: `small`, `medium`, `large`, `larger` or
2123 OO
.ui
.Window
.prototype.setSize = function ( size
) {
2130 * Update the window size.
2132 * @throws {Error} An error is thrown if the window is not attached to a window manager
2135 OO
.ui
.Window
.prototype.updateSize = function () {
2136 if ( !this.manager
) {
2137 throw new Error( 'Cannot update window size, must be attached to a manager' );
2140 this.manager
.updateWindowSize( this );
2146 * Set window dimensions. This method is called by the {@link OO.ui.WindowManager window manager}
2147 * when the window is opening. In general, setDimensions should not be called directly.
2149 * To set the size of the window, use the #setSize method.
2151 * @param {Object} dim CSS dimension properties
2152 * @param {string|number} [dim.width] Width
2153 * @param {string|number} [dim.minWidth] Minimum width
2154 * @param {string|number} [dim.maxWidth] Maximum width
2155 * @param {string|number} [dim.height] Height, omit to set based on height of contents
2156 * @param {string|number} [dim.minHeight] Minimum height
2157 * @param {string|number} [dim.maxHeight] Maximum height
2160 OO
.ui
.Window
.prototype.setDimensions = function ( dim
) {
2163 styleObj
= this.$frame
[ 0 ].style
;
2165 // Calculate the height we need to set using the correct width
2166 if ( dim
.height
=== undefined ) {
2167 this.withoutSizeTransitions( function () {
2168 var oldWidth
= styleObj
.width
;
2169 win
.$frame
.css( 'width', dim
.width
|| '' );
2170 height
= win
.getContentHeight();
2171 styleObj
.width
= oldWidth
;
2174 height
= dim
.height
;
2178 width
: dim
.width
|| '',
2179 minWidth
: dim
.minWidth
|| '',
2180 maxWidth
: dim
.maxWidth
|| '',
2181 height
: height
|| '',
2182 minHeight
: dim
.minHeight
|| '',
2183 maxHeight
: dim
.maxHeight
|| ''
2190 * Initialize window contents.
2192 * Before the window is opened for the first time, #initialize is called so that content that
2193 * persists between openings can be added to the window.
2195 * To set up a window with new content each time the window opens, use #getSetupProcess.
2197 * @throws {Error} An error is thrown if the window is not attached to a window manager
2200 OO
.ui
.Window
.prototype.initialize = function () {
2201 if ( !this.manager
) {
2202 throw new Error( 'Cannot initialize window, must be attached to a manager' );
2206 this.$head
= $( '<div>' );
2207 this.$body
= $( '<div>' );
2208 this.$foot
= $( '<div>' );
2209 this.$document
= $( this.getElementDocument() );
2212 this.$element
.on( 'mousedown', this.onMouseDown
.bind( this ) );
2215 this.$head
.addClass( 'oo-ui-window-head' );
2216 this.$body
.addClass( 'oo-ui-window-body' );
2217 this.$foot
.addClass( 'oo-ui-window-foot' );
2218 this.$content
.append( this.$head
, this.$body
, this.$foot
);
2224 * Called when someone tries to focus the hidden element at the end of the dialog.
2225 * Sends focus back to the start of the dialog.
2227 * @param {jQuery.Event} event Focus event
2229 OO
.ui
.Window
.prototype.onFocusTrapFocused = function ( event
) {
2230 var backwards
= this.$focusTrapBefore
.is( event
.target
),
2231 element
= OO
.ui
.findFocusable( this.$content
, backwards
);
2233 // There's a focusable element inside the content, at the front or
2234 // back depending on which focus trap we hit; select it.
2237 // There's nothing focusable inside the content. As a fallback,
2238 // this.$content is focusable, and focusing it will keep our focus
2239 // properly trapped. It's not a *meaningful* focus, since it's just
2240 // the content-div for the Window, but it's better than letting focus
2241 // escape into the page.
2242 this.$content
.focus();
2249 * This method is a wrapper around a call to the window manager’s {@link OO.ui.WindowManager#openWindow openWindow}
2250 * method, which returns a promise resolved when the window is done opening.
2252 * To customize the window each time it opens, use #getSetupProcess or #getReadyProcess.
2254 * @param {Object} [data] Window opening data
2255 * @return {jQuery.Promise} Promise resolved with a value when the window is opened, or rejected
2256 * if the window fails to open. When the promise is resolved successfully, the first argument of the
2257 * value is a new promise, which is resolved when the window begins closing.
2258 * @throws {Error} An error is thrown if the window is not attached to a window manager
2260 OO
.ui
.Window
.prototype.open = function ( data
) {
2261 if ( !this.manager
) {
2262 throw new Error( 'Cannot open window, must be attached to a manager' );
2265 return this.manager
.openWindow( this, data
);
2271 * This method is a wrapper around a call to the window
2272 * manager’s {@link OO.ui.WindowManager#closeWindow closeWindow} method,
2273 * which returns a closing promise resolved when the window is done closing.
2275 * The window's #getHoldProcess and #getTeardownProcess methods are called during the closing
2276 * phase of the window’s lifecycle and can be used to specify closing behavior each time
2277 * the window closes.
2279 * @param {Object} [data] Window closing data
2280 * @return {jQuery.Promise} Promise resolved when window is closed
2281 * @throws {Error} An error is thrown if the window is not attached to a window manager
2283 OO
.ui
.Window
.prototype.close = function ( data
) {
2284 if ( !this.manager
) {
2285 throw new Error( 'Cannot close window, must be attached to a manager' );
2288 return this.manager
.closeWindow( this, data
);
2294 * This is called by OO.ui.WindowManager during window opening, and should not be called directly
2297 * @param {Object} [data] Window opening data
2298 * @return {jQuery.Promise} Promise resolved when window is setup
2300 OO
.ui
.Window
.prototype.setup = function ( data
) {
2303 this.toggle( true );
2305 this.focusTrapHandler
= OO
.ui
.bind( this.onFocusTrapFocused
, this );
2306 this.$focusTraps
.on( 'focus', this.focusTrapHandler
);
2308 return this.getSetupProcess( data
).execute().then( function () {
2309 // Force redraw by asking the browser to measure the elements' widths
2310 win
.$element
.addClass( 'oo-ui-window-active oo-ui-window-setup' ).width();
2311 win
.$content
.addClass( 'oo-ui-window-content-setup' ).width();
2318 * This is called by OO.ui.WindowManager during window opening, and should not be called directly
2321 * @param {Object} [data] Window opening data
2322 * @return {jQuery.Promise} Promise resolved when window is ready
2324 OO
.ui
.Window
.prototype.ready = function ( data
) {
2327 this.$content
.focus();
2328 return this.getReadyProcess( data
).execute().then( function () {
2329 // Force redraw by asking the browser to measure the elements' widths
2330 win
.$element
.addClass( 'oo-ui-window-ready' ).width();
2331 win
.$content
.addClass( 'oo-ui-window-content-ready' ).width();
2338 * This is called by OO.ui.WindowManager during window closing, and should not be called directly
2341 * @param {Object} [data] Window closing data
2342 * @return {jQuery.Promise} Promise resolved when window is held
2344 OO
.ui
.Window
.prototype.hold = function ( data
) {
2347 return this.getHoldProcess( data
).execute().then( function () {
2348 // Get the focused element within the window's content
2349 var $focus
= win
.$content
.find( OO
.ui
.Element
.static.getDocument( win
.$content
).activeElement
);
2351 // Blur the focused element
2352 if ( $focus
.length
) {
2356 // Force redraw by asking the browser to measure the elements' widths
2357 win
.$element
.removeClass( 'oo-ui-window-ready' ).width();
2358 win
.$content
.removeClass( 'oo-ui-window-content-ready' ).width();
2365 * This is called by OO.ui.WindowManager during window closing, and should not be called directly
2368 * @param {Object} [data] Window closing data
2369 * @return {jQuery.Promise} Promise resolved when window is torn down
2371 OO
.ui
.Window
.prototype.teardown = function ( data
) {
2374 return this.getTeardownProcess( data
).execute().then( function () {
2375 // Force redraw by asking the browser to measure the elements' widths
2376 win
.$element
.removeClass( 'oo-ui-window-active oo-ui-window-setup' ).width();
2377 win
.$content
.removeClass( 'oo-ui-window-content-setup' ).width();
2378 win
.$focusTraps
.off( 'focus', win
.focusTrapHandler
);
2379 win
.toggle( false );
2384 * The Dialog class serves as the base class for the other types of dialogs.
2385 * Unless extended to include controls, the rendered dialog box is a simple window
2386 * that users can close by hitting the ‘Esc’ key. Dialog windows are used with OO.ui.WindowManager,
2387 * which opens, closes, and controls the presentation of the window. See the
2388 * [OOjs UI documentation on MediaWiki] [1] for more information.
2391 * // A simple dialog window.
2392 * function MyDialog( config ) {
2393 * MyDialog.parent.call( this, config );
2395 * OO.inheritClass( MyDialog, OO.ui.Dialog );
2396 * MyDialog.static.name = 'myDialog';
2397 * MyDialog.prototype.initialize = function () {
2398 * MyDialog.parent.prototype.initialize.call( this );
2399 * this.content = new OO.ui.PanelLayout( { padded: true, expanded: false } );
2400 * this.content.$element.append( '<p>A simple dialog window. Press \'Esc\' to close.</p>' );
2401 * this.$body.append( this.content.$element );
2403 * MyDialog.prototype.getBodyHeight = function () {
2404 * return this.content.$element.outerHeight( true );
2406 * var myDialog = new MyDialog( {
2409 * // Create and append a window manager, which opens and closes the window.
2410 * var windowManager = new OO.ui.WindowManager();
2411 * $( 'body' ).append( windowManager.$element );
2412 * windowManager.addWindows( [ myDialog ] );
2413 * // Open the window!
2414 * windowManager.openWindow( myDialog );
2416 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Windows/Dialogs
2420 * @extends OO.ui.Window
2421 * @mixins OO.ui.mixin.PendingElement
2424 * @param {Object} [config] Configuration options
2426 OO
.ui
.Dialog
= function OoUiDialog( config
) {
2427 // Parent constructor
2428 OO
.ui
.Dialog
.parent
.call( this, config
);
2430 // Mixin constructors
2431 OO
.ui
.mixin
.PendingElement
.call( this );
2434 this.actions
= new OO
.ui
.ActionSet();
2435 this.attachedActions
= [];
2436 this.currentAction
= null;
2437 this.onDialogKeyDownHandler
= this.onDialogKeyDown
.bind( this );
2440 this.actions
.connect( this, {
2441 click
: 'onActionClick',
2442 change
: 'onActionsChange'
2447 .addClass( 'oo-ui-dialog' )
2448 .attr( 'role', 'dialog' );
2453 OO
.inheritClass( OO
.ui
.Dialog
, OO
.ui
.Window
);
2454 OO
.mixinClass( OO
.ui
.Dialog
, OO
.ui
.mixin
.PendingElement
);
2456 /* Static Properties */
2459 * Symbolic name of dialog.
2461 * The dialog class must have a symbolic name in order to be registered with OO.Factory.
2462 * Please see the [OOjs UI documentation on MediaWiki] [3] for more information.
2464 * [3]: https://www.mediawiki.org/wiki/OOjs_UI/Windows/Window_managers
2469 * @property {string}
2471 OO
.ui
.Dialog
.static.name
= '';
2476 * The title can be specified as a plaintext string, a {@link OO.ui.mixin.LabelElement Label} node, or a function
2477 * that will produce a Label node or string. The title can also be specified with data passed to the
2478 * constructor (see #getSetupProcess). In this case, the static value will be overridden.
2483 * @property {jQuery|string|Function}
2485 OO
.ui
.Dialog
.static.title
= '';
2488 * An array of configured {@link OO.ui.ActionWidget action widgets}.
2490 * Actions can also be specified with data passed to the constructor (see #getSetupProcess). In this case, the static
2491 * value will be overridden.
2493 * [2]: https://www.mediawiki.org/wiki/OOjs_UI/Windows/Process_Dialogs#Action_sets
2497 * @property {Object[]}
2499 OO
.ui
.Dialog
.static.actions
= [];
2502 * Close the dialog when the 'Esc' key is pressed.
2507 * @property {boolean}
2509 OO
.ui
.Dialog
.static.escapable
= true;
2514 * Handle frame document key down events.
2517 * @param {jQuery.Event} e Key down event
2519 OO
.ui
.Dialog
.prototype.onDialogKeyDown = function ( e
) {
2521 if ( e
.which
=== OO
.ui
.Keys
.ESCAPE
&& this.constructor.static.escapable
) {
2522 this.executeAction( '' );
2524 e
.stopPropagation();
2525 } else if ( e
.which
=== OO
.ui
.Keys
.ENTER
&& ( e
.ctrlKey
|| e
.metaKey
) ) {
2526 actions
= this.actions
.get( { flags
: 'primary', visible
: true, disabled
: false } );
2527 if ( actions
.length
> 0 ) {
2528 this.executeAction( actions
[ 0 ].getAction() );
2530 e
.stopPropagation();
2536 * Handle action click events.
2539 * @param {OO.ui.ActionWidget} action Action that was clicked
2541 OO
.ui
.Dialog
.prototype.onActionClick = function ( action
) {
2542 if ( !this.isPending() ) {
2543 this.executeAction( action
.getAction() );
2548 * Handle actions change event.
2552 OO
.ui
.Dialog
.prototype.onActionsChange = function () {
2553 this.detachActions();
2554 if ( !this.isClosing() ) {
2555 this.attachActions();
2560 * Get the set of actions used by the dialog.
2562 * @return {OO.ui.ActionSet}
2564 OO
.ui
.Dialog
.prototype.getActions = function () {
2565 return this.actions
;
2569 * Get a process for taking action.
2571 * When you override this method, you can create a new OO.ui.Process and return it, or add additional
2572 * accept steps to the process the parent method provides using the {@link OO.ui.Process#first 'first'}
2573 * and {@link OO.ui.Process#next 'next'} methods of OO.ui.Process.
2575 * @param {string} [action] Symbolic name of action
2576 * @return {OO.ui.Process} Action process
2578 OO
.ui
.Dialog
.prototype.getActionProcess = function ( action
) {
2579 return new OO
.ui
.Process()
2580 .next( function () {
2582 // An empty action always closes the dialog without data, which should always be
2583 // safe and make no changes
2592 * @param {Object} [data] Dialog opening data
2593 * @param {jQuery|string|Function|null} [data.title] Dialog title, omit to use
2594 * the {@link #static-title static title}
2595 * @param {Object[]} [data.actions] List of configuration options for each
2596 * {@link OO.ui.ActionWidget action widget}, omit to use {@link #static-actions static actions}.
2598 OO
.ui
.Dialog
.prototype.getSetupProcess = function ( data
) {
2602 return OO
.ui
.Dialog
.parent
.prototype.getSetupProcess
.call( this, data
)
2603 .next( function () {
2604 var config
= this.constructor.static,
2605 actions
= data
.actions
!== undefined ? data
.actions
: config
.actions
,
2606 title
= data
.title
!== undefined ? data
.title
: config
.title
;
2608 this.title
.setLabel( title
).setTitle( title
);
2609 this.actions
.add( this.getActionWidgets( actions
) );
2611 this.$element
.on( 'keydown', this.onDialogKeyDownHandler
);
2618 OO
.ui
.Dialog
.prototype.getTeardownProcess = function ( data
) {
2620 return OO
.ui
.Dialog
.parent
.prototype.getTeardownProcess
.call( this, data
)
2621 .first( function () {
2622 this.$element
.off( 'keydown', this.onDialogKeyDownHandler
);
2624 this.actions
.clear();
2625 this.currentAction
= null;
2632 OO
.ui
.Dialog
.prototype.initialize = function () {
2634 OO
.ui
.Dialog
.parent
.prototype.initialize
.call( this );
2637 this.title
= new OO
.ui
.LabelWidget();
2640 this.$content
.addClass( 'oo-ui-dialog-content' );
2641 this.$element
.attr( 'aria-labelledby', this.title
.getElementId() );
2642 this.setPendingElement( this.$head
);
2646 * Get action widgets from a list of configs
2648 * @param {Object[]} actions Action widget configs
2649 * @return {OO.ui.ActionWidget[]} Action widgets
2651 OO
.ui
.Dialog
.prototype.getActionWidgets = function ( actions
) {
2652 var i
, len
, widgets
= [];
2653 for ( i
= 0, len
= actions
.length
; i
< len
; i
++ ) {
2655 new OO
.ui
.ActionWidget( actions
[ i
] )
2662 * Attach action actions.
2666 OO
.ui
.Dialog
.prototype.attachActions = function () {
2667 // Remember the list of potentially attached actions
2668 this.attachedActions
= this.actions
.get();
2672 * Detach action actions.
2677 OO
.ui
.Dialog
.prototype.detachActions = function () {
2680 // Detach all actions that may have been previously attached
2681 for ( i
= 0, len
= this.attachedActions
.length
; i
< len
; i
++ ) {
2682 this.attachedActions
[ i
].$element
.detach();
2684 this.attachedActions
= [];
2688 * Execute an action.
2690 * @param {string} action Symbolic name of action to execute
2691 * @return {jQuery.Promise} Promise resolved when action completes, rejected if it fails
2693 OO
.ui
.Dialog
.prototype.executeAction = function ( action
) {
2695 this.currentAction
= action
;
2696 return this.getActionProcess( action
).execute()
2697 .always( this.popPending
.bind( this ) );
2701 * MessageDialogs display a confirmation or alert message. By default, the rendered dialog box
2702 * consists of a header that contains the dialog title, a body with the message, and a footer that
2703 * contains any {@link OO.ui.ActionWidget action widgets}. The MessageDialog class is the only type
2704 * of {@link OO.ui.Dialog dialog} that is usually instantiated directly.
2706 * There are two basic types of message dialogs, confirmation and alert:
2708 * - **confirmation**: the dialog title describes what a progressive action will do and the message provides
2709 * more details about the consequences.
2710 * - **alert**: the dialog title describes which event occurred and the message provides more information
2711 * about why the event occurred.
2713 * The MessageDialog class specifies two actions: ‘accept’, the primary
2714 * action (e.g., ‘ok’) and ‘reject,’ the safe action (e.g., ‘cancel’). Both will close the window,
2715 * passing along the selected action.
2717 * For more information and examples, please see the [OOjs UI documentation on MediaWiki][1].
2720 * // Example: Creating and opening a message dialog window.
2721 * var messageDialog = new OO.ui.MessageDialog();
2723 * // Create and append a window manager.
2724 * var windowManager = new OO.ui.WindowManager();
2725 * $( 'body' ).append( windowManager.$element );
2726 * windowManager.addWindows( [ messageDialog ] );
2727 * // Open the window.
2728 * windowManager.openWindow( messageDialog, {
2729 * title: 'Basic message dialog',
2730 * message: 'This is the message'
2733 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Windows/Message_Dialogs
2736 * @extends OO.ui.Dialog
2739 * @param {Object} [config] Configuration options
2741 OO
.ui
.MessageDialog
= function OoUiMessageDialog( config
) {
2742 // Parent constructor
2743 OO
.ui
.MessageDialog
.parent
.call( this, config
);
2746 this.verticalActionLayout
= null;
2749 this.$element
.addClass( 'oo-ui-messageDialog' );
2754 OO
.inheritClass( OO
.ui
.MessageDialog
, OO
.ui
.Dialog
);
2756 /* Static Properties */
2762 OO
.ui
.MessageDialog
.static.name
= 'message';
2768 OO
.ui
.MessageDialog
.static.size
= 'small';
2773 * The title of a confirmation dialog describes what a progressive action will do. The
2774 * title of an alert dialog describes which event occurred.
2778 * @property {jQuery|string|Function|null}
2780 OO
.ui
.MessageDialog
.static.title
= null;
2783 * The message displayed in the dialog body.
2785 * A confirmation message describes the consequences of a progressive action. An alert
2786 * message describes why an event occurred.
2790 * @property {jQuery|string|Function|null}
2792 OO
.ui
.MessageDialog
.static.message
= null;
2798 OO
.ui
.MessageDialog
.static.actions
= [
2799 // Note that OO.ui.alert() and OO.ui.confirm() rely on these.
2800 { action
: 'accept', label
: OO
.ui
.deferMsg( 'ooui-dialog-message-accept' ), flags
: 'primary' },
2801 { action
: 'reject', label
: OO
.ui
.deferMsg( 'ooui-dialog-message-reject' ), flags
: 'safe' }
2809 OO
.ui
.MessageDialog
.prototype.setManager = function ( manager
) {
2810 OO
.ui
.MessageDialog
.parent
.prototype.setManager
.call( this, manager
);
2813 this.manager
.connect( this, {
2821 * Handle window resized events.
2825 OO
.ui
.MessageDialog
.prototype.onResize = function () {
2827 dialog
.fitActions();
2828 // Wait for CSS transition to finish and do it again :(
2829 setTimeout( function () {
2830 dialog
.fitActions();
2835 * Toggle action layout between vertical and horizontal.
2838 * @param {boolean} [value] Layout actions vertically, omit to toggle
2841 OO
.ui
.MessageDialog
.prototype.toggleVerticalActionLayout = function ( value
) {
2842 value
= value
=== undefined ? !this.verticalActionLayout
: !!value
;
2844 if ( value
!== this.verticalActionLayout
) {
2845 this.verticalActionLayout
= value
;
2847 .toggleClass( 'oo-ui-messageDialog-actions-vertical', value
)
2848 .toggleClass( 'oo-ui-messageDialog-actions-horizontal', !value
);
2857 OO
.ui
.MessageDialog
.prototype.getActionProcess = function ( action
) {
2859 return new OO
.ui
.Process( function () {
2860 this.close( { action
: action
} );
2863 return OO
.ui
.MessageDialog
.parent
.prototype.getActionProcess
.call( this, action
);
2869 * @param {Object} [data] Dialog opening data
2870 * @param {jQuery|string|Function|null} [data.title] Description of the action being confirmed
2871 * @param {jQuery|string|Function|null} [data.message] Description of the action's consequence
2872 * @param {string} [data.size] Symbolic name of the dialog size, see OO.ui.Window
2873 * @param {Object[]} [data.actions] List of OO.ui.ActionOptionWidget configuration options for each
2876 OO
.ui
.MessageDialog
.prototype.getSetupProcess = function ( data
) {
2880 return OO
.ui
.MessageDialog
.parent
.prototype.getSetupProcess
.call( this, data
)
2881 .next( function () {
2882 this.title
.setLabel(
2883 data
.title
!== undefined ? data
.title
: this.constructor.static.title
2885 this.message
.setLabel(
2886 data
.message
!== undefined ? data
.message
: this.constructor.static.message
2888 this.size
= data
.size
!== undefined ? data
.size
: this.constructor.static.size
;
2895 OO
.ui
.MessageDialog
.prototype.getReadyProcess = function ( data
) {
2899 return OO
.ui
.MessageDialog
.parent
.prototype.getReadyProcess
.call( this, data
)
2900 .next( function () {
2901 // Focus the primary action button
2902 var actions
= this.actions
.get();
2903 actions
= actions
.filter( function ( action
) {
2904 return action
.getFlags().indexOf( 'primary' ) > -1;
2906 if ( actions
.length
> 0 ) {
2907 actions
[ 0 ].focus();
2915 OO
.ui
.MessageDialog
.prototype.getBodyHeight = function () {
2916 var bodyHeight
, oldOverflow
,
2917 $scrollable
= this.container
.$element
;
2919 oldOverflow
= $scrollable
[ 0 ].style
.overflow
;
2920 $scrollable
[ 0 ].style
.overflow
= 'hidden';
2922 OO
.ui
.Element
.static.reconsiderScrollbars( $scrollable
[ 0 ] );
2924 bodyHeight
= this.text
.$element
.outerHeight( true );
2925 $scrollable
[ 0 ].style
.overflow
= oldOverflow
;
2933 OO
.ui
.MessageDialog
.prototype.setDimensions = function ( dim
) {
2934 var $scrollable
= this.container
.$element
;
2935 OO
.ui
.MessageDialog
.parent
.prototype.setDimensions
.call( this, dim
);
2937 // Twiddle the overflow property, otherwise an unnecessary scrollbar will be produced.
2938 // Need to do it after transition completes (250ms), add 50ms just in case.
2939 setTimeout( function () {
2940 var oldOverflow
= $scrollable
[ 0 ].style
.overflow
,
2941 activeElement
= document
.activeElement
;
2943 $scrollable
[ 0 ].style
.overflow
= 'hidden';
2945 OO
.ui
.Element
.static.reconsiderScrollbars( $scrollable
[ 0 ] );
2947 // Check reconsiderScrollbars didn't destroy our focus, as we
2948 // are doing this after the ready process.
2949 if ( activeElement
&& activeElement
!== document
.activeElement
&& activeElement
.focus
) {
2950 activeElement
.focus();
2953 $scrollable
[ 0 ].style
.overflow
= oldOverflow
;
2962 OO
.ui
.MessageDialog
.prototype.initialize = function () {
2964 OO
.ui
.MessageDialog
.parent
.prototype.initialize
.call( this );
2967 this.$actions
= $( '<div>' );
2968 this.container
= new OO
.ui
.PanelLayout( {
2969 scrollable
: true, classes
: [ 'oo-ui-messageDialog-container' ]
2971 this.text
= new OO
.ui
.PanelLayout( {
2972 padded
: true, expanded
: false, classes
: [ 'oo-ui-messageDialog-text' ]
2974 this.message
= new OO
.ui
.LabelWidget( {
2975 classes
: [ 'oo-ui-messageDialog-message' ]
2979 this.title
.$element
.addClass( 'oo-ui-messageDialog-title' );
2980 this.$content
.addClass( 'oo-ui-messageDialog-content' );
2981 this.container
.$element
.append( this.text
.$element
);
2982 this.text
.$element
.append( this.title
.$element
, this.message
.$element
);
2983 this.$body
.append( this.container
.$element
);
2984 this.$actions
.addClass( 'oo-ui-messageDialog-actions' );
2985 this.$foot
.append( this.$actions
);
2991 OO
.ui
.MessageDialog
.prototype.attachActions = function () {
2992 var i
, len
, other
, special
, others
;
2995 OO
.ui
.MessageDialog
.parent
.prototype.attachActions
.call( this );
2997 special
= this.actions
.getSpecial();
2998 others
= this.actions
.getOthers();
3000 if ( special
.safe
) {
3001 this.$actions
.append( special
.safe
.$element
);
3002 special
.safe
.toggleFramed( false );
3004 if ( others
.length
) {
3005 for ( i
= 0, len
= others
.length
; i
< len
; i
++ ) {
3006 other
= others
[ i
];
3007 this.$actions
.append( other
.$element
);
3008 other
.toggleFramed( false );
3011 if ( special
.primary
) {
3012 this.$actions
.append( special
.primary
.$element
);
3013 special
.primary
.toggleFramed( false );
3016 if ( !this.isOpening() ) {
3017 // If the dialog is currently opening, this will be called automatically soon.
3018 // This also calls #fitActions.
3024 * Fit action actions into columns or rows.
3026 * Columns will be used if all labels can fit without overflow, otherwise rows will be used.
3030 OO
.ui
.MessageDialog
.prototype.fitActions = function () {
3032 previous
= this.verticalActionLayout
,
3033 actions
= this.actions
.get();
3036 this.toggleVerticalActionLayout( false );
3037 for ( i
= 0, len
= actions
.length
; i
< len
; i
++ ) {
3038 action
= actions
[ i
];
3039 if ( action
.$element
.innerWidth() < action
.$label
.outerWidth( true ) ) {
3040 this.toggleVerticalActionLayout( true );
3045 // Move the body out of the way of the foot
3046 this.$body
.css( 'bottom', this.$foot
.outerHeight( true ) );
3048 if ( this.verticalActionLayout
!== previous
) {
3049 // We changed the layout, window height might need to be updated.
3055 * ProcessDialog windows encapsulate a {@link OO.ui.Process process} and all of the code necessary
3056 * to complete it. If the process terminates with an error, a customizable {@link OO.ui.Error error
3057 * interface} alerts users to the trouble, permitting the user to dismiss the error and try again when
3058 * relevant. The ProcessDialog class is always extended and customized with the actions and content
3059 * required for each process.
3061 * The process dialog box consists of a header that visually represents the ‘working’ state of long
3062 * processes with an animation. The header contains the dialog title as well as
3063 * two {@link OO.ui.ActionWidget action widgets}: a ‘safe’ action on the left (e.g., ‘Cancel’) and
3064 * a ‘primary’ action on the right (e.g., ‘Done’).
3066 * Like other windows, the process dialog is managed by a {@link OO.ui.WindowManager window manager}.
3067 * Please see the [OOjs UI documentation on MediaWiki][1] for more information and examples.
3070 * // Example: Creating and opening a process dialog window.
3071 * function MyProcessDialog( config ) {
3072 * MyProcessDialog.parent.call( this, config );
3074 * OO.inheritClass( MyProcessDialog, OO.ui.ProcessDialog );
3076 * MyProcessDialog.static.name = 'myProcessDialog';
3077 * MyProcessDialog.static.title = 'Process dialog';
3078 * MyProcessDialog.static.actions = [
3079 * { action: 'save', label: 'Done', flags: 'primary' },
3080 * { label: 'Cancel', flags: 'safe' }
3083 * MyProcessDialog.prototype.initialize = function () {
3084 * MyProcessDialog.parent.prototype.initialize.apply( this, arguments );
3085 * this.content = new OO.ui.PanelLayout( { padded: true, expanded: false } );
3086 * 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>' );
3087 * this.$body.append( this.content.$element );
3089 * MyProcessDialog.prototype.getActionProcess = function ( action ) {
3090 * var dialog = this;
3092 * return new OO.ui.Process( function () {
3093 * dialog.close( { action: action } );
3096 * return MyProcessDialog.parent.prototype.getActionProcess.call( this, action );
3099 * var windowManager = new OO.ui.WindowManager();
3100 * $( 'body' ).append( windowManager.$element );
3102 * var dialog = new MyProcessDialog();
3103 * windowManager.addWindows( [ dialog ] );
3104 * windowManager.openWindow( dialog );
3106 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Windows/Process_Dialogs
3110 * @extends OO.ui.Dialog
3113 * @param {Object} [config] Configuration options
3115 OO
.ui
.ProcessDialog
= function OoUiProcessDialog( config
) {
3116 // Parent constructor
3117 OO
.ui
.ProcessDialog
.parent
.call( this, config
);
3120 this.fitOnOpen
= false;
3123 this.$element
.addClass( 'oo-ui-processDialog' );
3128 OO
.inheritClass( OO
.ui
.ProcessDialog
, OO
.ui
.Dialog
);
3133 * Handle dismiss button click events.
3139 OO
.ui
.ProcessDialog
.prototype.onDismissErrorButtonClick = function () {
3144 * Handle retry button click events.
3146 * Hides errors and then tries again.
3150 OO
.ui
.ProcessDialog
.prototype.onRetryButtonClick = function () {
3152 this.executeAction( this.currentAction
);
3158 OO
.ui
.ProcessDialog
.prototype.initialize = function () {
3160 OO
.ui
.ProcessDialog
.parent
.prototype.initialize
.call( this );
3163 this.$navigation
= $( '<div>' );
3164 this.$location
= $( '<div>' );
3165 this.$safeActions
= $( '<div>' );
3166 this.$primaryActions
= $( '<div>' );
3167 this.$otherActions
= $( '<div>' );
3168 this.dismissButton
= new OO
.ui
.ButtonWidget( {
3169 label
: OO
.ui
.msg( 'ooui-dialog-process-dismiss' )
3171 this.retryButton
= new OO
.ui
.ButtonWidget();
3172 this.$errors
= $( '<div>' );
3173 this.$errorsTitle
= $( '<div>' );
3176 this.dismissButton
.connect( this, { click
: 'onDismissErrorButtonClick' } );
3177 this.retryButton
.connect( this, { click
: 'onRetryButtonClick' } );
3180 this.title
.$element
.addClass( 'oo-ui-processDialog-title' );
3182 .append( this.title
.$element
)
3183 .addClass( 'oo-ui-processDialog-location' );
3184 this.$safeActions
.addClass( 'oo-ui-processDialog-actions-safe' );
3185 this.$primaryActions
.addClass( 'oo-ui-processDialog-actions-primary' );
3186 this.$otherActions
.addClass( 'oo-ui-processDialog-actions-other' );
3188 .addClass( 'oo-ui-processDialog-errors-title' )
3189 .text( OO
.ui
.msg( 'ooui-dialog-process-error' ) );
3191 .addClass( 'oo-ui-processDialog-errors oo-ui-element-hidden' )
3192 .append( this.$errorsTitle
, this.dismissButton
.$element
, this.retryButton
.$element
);
3194 .addClass( 'oo-ui-processDialog-content' )
3195 .append( this.$errors
);
3197 .addClass( 'oo-ui-processDialog-navigation' )
3198 // Note: Order of appends below is important. These are in the order
3199 // we want tab to go through them. Display-order is handled entirely
3200 // by CSS absolute-positioning. As such, primary actions like "done"
3202 .append( this.$primaryActions
, this.$location
, this.$safeActions
);
3203 this.$head
.append( this.$navigation
);
3204 this.$foot
.append( this.$otherActions
);
3210 OO
.ui
.ProcessDialog
.prototype.getActionWidgets = function ( actions
) {
3212 isMobile
= OO
.ui
.isMobile(),
3215 for ( i
= 0, len
= actions
.length
; i
< len
; i
++ ) {
3216 config
= $.extend( { framed
: !OO
.ui
.isMobile() }, actions
[ i
] );
3218 ( config
.flags
=== 'back' || ( Array
.isArray( config
.flags
) && config
.flags
.indexOf( 'back' ) !== -1 ) )
3226 new OO
.ui
.ActionWidget( config
)
3235 OO
.ui
.ProcessDialog
.prototype.attachActions = function () {
3236 var i
, len
, other
, special
, others
;
3239 OO
.ui
.ProcessDialog
.parent
.prototype.attachActions
.call( this );
3241 special
= this.actions
.getSpecial();
3242 others
= this.actions
.getOthers();
3243 if ( special
.primary
) {
3244 this.$primaryActions
.append( special
.primary
.$element
);
3246 for ( i
= 0, len
= others
.length
; i
< len
; i
++ ) {
3247 other
= others
[ i
];
3248 this.$otherActions
.append( other
.$element
);
3250 if ( special
.safe
) {
3251 this.$safeActions
.append( special
.safe
.$element
);
3255 this.$body
.css( 'bottom', this.$foot
.outerHeight( true ) );
3261 OO
.ui
.ProcessDialog
.prototype.executeAction = function ( action
) {
3263 return OO
.ui
.ProcessDialog
.parent
.prototype.executeAction
.call( this, action
)
3264 .fail( function ( errors
) {
3265 process
.showErrors( errors
|| [] );
3272 OO
.ui
.ProcessDialog
.prototype.setDimensions = function () {
3274 OO
.ui
.ProcessDialog
.parent
.prototype.setDimensions
.apply( this, arguments
);
3280 * Fit label between actions.
3285 OO
.ui
.ProcessDialog
.prototype.fitLabel = function () {
3286 var safeWidth
, primaryWidth
, biggerWidth
, labelWidth
, navigationWidth
, leftWidth
, rightWidth
,
3287 size
= this.getSizeProperties();
3289 if ( typeof size
.width
!== 'number' ) {
3290 if ( this.isOpened() ) {
3291 navigationWidth
= this.$head
.width() - 20;
3292 } else if ( this.isOpening() ) {
3293 if ( !this.fitOnOpen
) {
3294 // Size is relative and the dialog isn't open yet, so wait.
3295 // FIXME: This should ideally be handled by setup somehow.
3296 this.manager
.lifecycle
.opened
.done( this.fitLabel
.bind( this ) );
3297 this.fitOnOpen
= true;
3304 navigationWidth
= size
.width
- 20;
3307 safeWidth
= this.$safeActions
.is( ':visible' ) ? this.$safeActions
.width() : 0;
3308 primaryWidth
= this.$primaryActions
.is( ':visible' ) ? this.$primaryActions
.width() : 0;
3309 biggerWidth
= Math
.max( safeWidth
, primaryWidth
);
3311 labelWidth
= this.title
.$element
.width();
3313 if ( 2 * biggerWidth
+ labelWidth
< navigationWidth
) {
3314 // We have enough space to center the label
3315 leftWidth
= rightWidth
= biggerWidth
;
3317 // Let's hope we at least have enough space not to overlap, because we can't wrap the label…
3318 if ( this.getDir() === 'ltr' ) {
3319 leftWidth
= safeWidth
;
3320 rightWidth
= primaryWidth
;
3322 leftWidth
= primaryWidth
;
3323 rightWidth
= safeWidth
;
3327 this.$location
.css( { paddingLeft
: leftWidth
, paddingRight
: rightWidth
} );
3333 * Handle errors that occurred during accept or reject processes.
3336 * @param {OO.ui.Error[]|OO.ui.Error} errors Errors to be handled
3338 OO
.ui
.ProcessDialog
.prototype.showErrors = function ( errors
) {
3339 var i
, len
, $item
, actions
,
3345 if ( errors
instanceof OO
.ui
.Error
) {
3346 errors
= [ errors
];
3349 for ( i
= 0, len
= errors
.length
; i
< len
; i
++ ) {
3350 if ( !errors
[ i
].isRecoverable() ) {
3351 recoverable
= false;
3353 if ( errors
[ i
].isWarning() ) {
3356 $item
= $( '<div>' )
3357 .addClass( 'oo-ui-processDialog-error' )
3358 .append( errors
[ i
].getMessage() );
3359 items
.push( $item
[ 0 ] );
3361 this.$errorItems
= $( items
);
3362 if ( recoverable
) {
3363 abilities
[ this.currentAction
] = true;
3364 // Copy the flags from the first matching action
3365 actions
= this.actions
.get( { actions
: this.currentAction
} );
3366 if ( actions
.length
) {
3367 this.retryButton
.clearFlags().setFlags( actions
[ 0 ].getFlags() );
3370 abilities
[ this.currentAction
] = false;
3371 this.actions
.setAbilities( abilities
);
3374 this.retryButton
.setLabel( OO
.ui
.msg( 'ooui-dialog-process-continue' ) );
3376 this.retryButton
.setLabel( OO
.ui
.msg( 'ooui-dialog-process-retry' ) );
3378 this.retryButton
.toggle( recoverable
);
3379 this.$errorsTitle
.after( this.$errorItems
);
3380 this.$errors
.removeClass( 'oo-ui-element-hidden' ).scrollTop( 0 );
3388 OO
.ui
.ProcessDialog
.prototype.hideErrors = function () {
3389 this.$errors
.addClass( 'oo-ui-element-hidden' );
3390 if ( this.$errorItems
) {
3391 this.$errorItems
.remove();
3392 this.$errorItems
= null;
3399 OO
.ui
.ProcessDialog
.prototype.getTeardownProcess = function ( data
) {
3401 return OO
.ui
.ProcessDialog
.parent
.prototype.getTeardownProcess
.call( this, data
)
3402 .first( function () {
3403 // Make sure to hide errors
3405 this.fitOnOpen
= false;
3414 * Lazy-initialize and return a global OO.ui.WindowManager instance, used by OO.ui.alert and
3418 * @return {OO.ui.WindowManager}
3420 OO
.ui
.getWindowManager = function () {
3421 if ( !OO
.ui
.windowManager
) {
3422 OO
.ui
.windowManager
= new OO
.ui
.WindowManager();
3423 $( 'body' ).append( OO
.ui
.windowManager
.$element
);
3424 OO
.ui
.windowManager
.addWindows( [ new OO
.ui
.MessageDialog() ] );
3426 return OO
.ui
.windowManager
;
3430 * Display a quick modal alert dialog, using a OO.ui.MessageDialog. While the dialog is open, the
3431 * rest of the page will be dimmed out and the user won't be able to interact with it. The dialog
3432 * has only one action button, labelled "OK", clicking it will simply close the dialog.
3434 * A window manager is created automatically when this function is called for the first time.
3437 * OO.ui.alert( 'Something happened!' ).done( function () {
3438 * console.log( 'User closed the dialog.' );
3441 * OO.ui.alert( 'Something larger happened!', { size: 'large' } );
3443 * @param {jQuery|string} text Message text to display
3444 * @param {Object} [options] Additional options, see OO.ui.MessageDialog#getSetupProcess
3445 * @return {jQuery.Promise} Promise resolved when the user closes the dialog
3447 OO
.ui
.alert = function ( text
, options
) {
3448 return OO
.ui
.getWindowManager().openWindow( 'message', $.extend( {
3450 actions
: [ OO
.ui
.MessageDialog
.static.actions
[ 0 ] ]
3451 }, options
) ).closed
.then( function () {
3457 * Display a quick modal confirmation dialog, using a OO.ui.MessageDialog. While the dialog is open,
3458 * the rest of the page will be dimmed out and the user won't be able to interact with it. The
3459 * dialog has two action buttons, one to confirm an operation (labelled "OK") and one to cancel it
3460 * (labelled "Cancel").
3462 * A window manager is created automatically when this function is called for the first time.
3465 * OO.ui.confirm( 'Are you sure?' ).done( function ( confirmed ) {
3466 * if ( confirmed ) {
3467 * console.log( 'User clicked "OK"!' );
3469 * console.log( 'User clicked "Cancel" or closed the dialog.' );
3473 * @param {jQuery|string} text Message text to display
3474 * @param {Object} [options] Additional options, see OO.ui.MessageDialog#getSetupProcess
3475 * @return {jQuery.Promise} Promise resolved when the user closes the dialog. If the user chose to
3476 * confirm, the promise will resolve to boolean `true`; otherwise, it will resolve to boolean
3479 OO
.ui
.confirm = function ( text
, options
) {
3480 return OO
.ui
.getWindowManager().openWindow( 'message', $.extend( {
3482 }, options
) ).closed
.then( function ( data
) {
3483 return !!( data
&& data
.action
=== 'accept' );
3488 * Display a quick modal prompt dialog, using a OO.ui.MessageDialog. While the dialog is open,
3489 * the rest of the page will be dimmed out and the user won't be able to interact with it. The
3490 * dialog has a text input widget and two action buttons, one to confirm an operation (labelled "OK")
3491 * and one to cancel it (labelled "Cancel").
3493 * A window manager is created automatically when this function is called for the first time.
3496 * OO.ui.prompt( 'Choose a line to go to', { textInput: { placeholder: 'Line number' } } ).done( function ( result ) {
3497 * if ( result !== null ) {
3498 * console.log( 'User typed "' + result + '" then clicked "OK".' );
3500 * console.log( 'User clicked "Cancel" or closed the dialog.' );
3504 * @param {jQuery|string} text Message text to display
3505 * @param {Object} [options] Additional options, see OO.ui.MessageDialog#getSetupProcess
3506 * @param {Object} [options.textInput] Additional options for text input widget, see OO.ui.TextInputWidget
3507 * @return {jQuery.Promise} Promise resolved when the user closes the dialog. If the user chose to
3508 * confirm, the promise will resolve with the value of the text input widget; otherwise, it will
3509 * resolve to `null`.
3511 OO
.ui
.prompt = function ( text
, options
) {
3513 manager
= OO
.ui
.getWindowManager(),
3514 textInput
= new OO
.ui
.TextInputWidget( ( options
&& options
.textInput
) || {} ),
3515 textField
= new OO
.ui
.FieldLayout( textInput
, {
3520 instance
= manager
.openWindow( 'message', $.extend( {
3521 message
: textField
.$element
3524 // TODO: This is a little hacky, and could be done by extending MessageDialog instead.
3525 instance
.opened
.then( function () {
3526 textInput
.on( 'enter', function () {
3527 manager
.getCurrentWindow().close( { action
: 'accept' } );
3532 return instance
.closed
.then( function ( data
) {
3533 return data
&& data
.action
=== 'accept' ? textInput
.getValue() : null;
3539 //# sourceMappingURL=oojs-ui-windows.js.map