# all files / src/dialogs/ MessageDialog.js

93.81% Statements 91/97
61.29% Branches 19/31
100% Functions 17/17
93.81% Lines 91/97

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    35
    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    48
    49
    50
    51
    52
    53
    54
    55
    56
    57
    58
    59
    60
    61
    62
    63
    64
    65
    66
    67
    68
    69
    70
    71
    72
    73
    74
    75
    76
    77
    78
    79
    80
    81
    82
    83
    84
    85
    86
    87
    88
    89
    90
    91
    92
    93
    94
    95
    96
    97
    98
    99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300
    301
    302
    303
    304
    305
    306
    307
    308
    309
    310
    311
    312
    313
    314
    315
    316
    317
    318
    319
    320
    321
    322
    323
    324
    325
    326
    327
    328
    329
    330
    331
    332
    333

    1×

    1×

    1×

    1×

    1×

    1×

    1×

    1×

    1×

    1×

    1×
    12×

    12×
    1×
    1×

    12×

    1×
    5×
    5×
    5×

    1×
    5×

    5×

    5×

    5×

    5×

    1×
    5×

    5×

    5×
    5×
    9×

    5×
    5×

    1×
    6×

    6×
    6×

    6×

    6×
    6×

    6×

    1×
    6×

    6×

    6×
    6×

    6×

    6×

    6×

    6×

    6×

    6×
    6×

    6×

    1×

    1×

    1×
    1×

    1×

    1×

    1×
    1×
    1×
    1×
    1×
    1×
    1×

    1×

    9×

    1×
    5×

    5×

    5×
    5×

    5×
    4×
    4×

    5×

    5×
    5×
    5×

    1×
    12×

    12×
    12×
    20×
    20×

    12×

    12×

    1×

     /**
     * MessageDialogs display a confirmation or alert message. By default, the rendered dialog box
     * consists of a header that contains the dialog title, a body with the message, and a footer that
     * contains any {@link OO.ui.ActionWidget action widgets}. The MessageDialog class is the only type
     * of {@link OO.ui.Dialog dialog} that is usually instantiated directly.
     *
     * There are two basic types of message dialogs, confirmation and alert:
     *
     * - **confirmation**: the dialog title describes what a progressive action will do and the message provides
     *  more details about the consequences.
     * - **alert**: the dialog title describes which event occurred and the message provides more information
     *  about why the event occurred.
     *
     * The MessageDialog class specifies two actions: ‘accept’, the primary
     * action (e.g., ‘ok’) and ‘reject,’ the safe action (e.g., ‘cancel’). Both will close the window,
     * passing along the selected action.
     *
     * For more information and examples, please see the [OOUI documentation on MediaWiki][1].
     *
     *     @example
     *     // Example: Creating and opening a message dialog window.
     *     var messageDialog = new OO.ui.MessageDialog();
     *
     *     // Create and append a window manager.
     *     var windowManager = new OO.ui.WindowManager();
     *     $( 'body' ).append( windowManager.$element );
     *     windowManager.addWindows( [ messageDialog ] );
     *     // Open the window.
     *     windowManager.openWindow( messageDialog, {
     *         title: 'Basic message dialog',
     *         message: 'This is the message'
     *     } );
     *
     * [1]: https://www.mediawiki.org/wiki/OOUI/Windows/Message_Dialogs
     *
     * @class
     * @extends OO.ui.Dialog
     *
     * @constructor
     * @param {Object} [config] Configuration options
     */
    OO.ui.MessageDialog = function OoUiMessageDialog( config ) {
    	// Parent constructor
    	OO.ui.MessageDialog.parent.call( this, config );

    	// Properties
    	this.verticalActionLayout = null;

    	// Initialization
    	this.$element.addClass( 'oo-ui-messageDialog' );
    };

    /* Setup */

    OO.inheritClass( OO.ui.MessageDialog, OO.ui.Dialog );

    /* Static Properties */

    /**
     * @static
     * @inheritdoc
     */
    OO.ui.MessageDialog.static.name = 'message';

    /**
     * @static
     * @inheritdoc
     */
    OO.ui.MessageDialog.static.size = 'small';

    /**
     * Dialog title.
     *
     * The title of a confirmation dialog describes what a progressive action will do. The
     * title of an alert dialog describes which event occurred.
     *
     * @static
     * @inheritable
     * @property {jQuery|string|Function|null}
     */
    OO.ui.MessageDialog.static.title = null;

    /**
     * The message displayed in the dialog body.
     *
     * A confirmation message describes the consequences of a progressive action. An alert
     * message describes why an event occurred.
     *
     * @static
     * @inheritable
     * @property {jQuery|string|Function|null}
     */
    OO.ui.MessageDialog.static.message = null;

    /**
     * @static
     * @inheritdoc
     */
    OO.ui.MessageDialog.static.actions = [
    	// Note that OO.ui.alert() and OO.ui.confirm() rely on these.
    	{ action: 'accept', label: OO.ui.deferMsg( 'ooui-dialog-message-accept' ), flags: 'primary' },
    	{ action: 'reject', label: OO.ui.deferMsg( 'ooui-dialog-message-reject' ), flags: 'safe' }
    ];

    /* Methods */

    /**
     * Toggle action layout between vertical and horizontal.
     *
     * @private
     * @param {boolean} [value] Layout actions vertically, omit to toggle
     * @chainable
     */
    OO.ui.MessageDialog.prototype.toggleVerticalActionLayout = function ( value ) {
    	value = value === undefined ? !this.verticalActionLayout : !!value;

    	if ( value !== this.verticalActionLayout ) {
    		this.verticalActionLayout = value;
    		this.$actions
    			.toggleClass( 'oo-ui-messageDialog-actions-vertical', value )
    			.toggleClass( 'oo-ui-messageDialog-actions-horizontal', !value );
    	}

    	return this;
    };

    /**
     * @inheritdoc
     */
    OO.ui.MessageDialog.prototype.getActionProcess = function ( action ) {
    	Eif ( action ) {
    		return new OO.ui.Process( function () {
    			this.close( { action: action } );
    		}, this );
    	}
    	return OO.ui.MessageDialog.parent.prototype.getActionProcess.call( this, action );
    };

    /**
     * @inheritdoc
     *
     * @param {Object} [data] Dialog opening data
     * @param {jQuery|string|Function|null} [data.title] Description of the action being confirmed
     * @param {jQuery|string|Function|null} [data.message] Description of the action's consequence
     * @param {string} [data.size] Symbolic name of the dialog size, see OO.ui.Window
     * @param {Object[]} [data.actions] List of OO.ui.ActionOptionWidget configuration options for each
     *   action item
     */
    OO.ui.MessageDialog.prototype.getSetupProcess = function ( data ) {
    	data = data || {};

    	// Parent method
    	return OO.ui.MessageDialog.parent.prototype.getSetupProcess.call( this, data )
    		.next( function () {
    			this.title.setLabel(
    				data.title !== undefined ? data.title : this.constructor.static.title
    			);
    			this.message.setLabel(
    				data.message !== undefined ? data.message : this.constructor.static.message
    			);
    			this.size = data.size !== undefined ? data.size : this.constructor.static.size;
    		}, this );
    };

    /**
     * @inheritdoc
     */
    OO.ui.MessageDialog.prototype.getReadyProcess = function ( data ) {
    	data = data || {};

    	// Parent method
    	return OO.ui.MessageDialog.parent.prototype.getReadyProcess.call( this, data )
    		.next( function () {
    			// Focus the primary action button
    			var actions = this.actions.get();
    			actions = actions.filter( function ( action ) {
    				return action.getFlags().indexOf( 'primary' ) > -1;
    			} );
    			Eif ( actions.length > 0 ) {
    				actions[ 0 ].focus();
    			}
    		}, this );
    };

    /**
     * @inheritdoc
     */
    OO.ui.MessageDialog.prototype.getBodyHeight = function () {
    	var bodyHeight, oldOverflow,
    		$scrollable = this.container.$element;

    	oldOverflow = $scrollable[ 0 ].style.overflow;
    	$scrollable[ 0 ].style.overflow = 'hidden';

    	OO.ui.Element.static.reconsiderScrollbars( $scrollable[ 0 ] );

    	bodyHeight = this.text.$element.outerHeight( true );
    	$scrollable[ 0 ].style.overflow = oldOverflow;

    	return bodyHeight;
    };

    /**
     * @inheritdoc
     */
    OO.ui.MessageDialog.prototype.setDimensions = function ( dim ) {
    	var
    		dialog = this,
    		$scrollable = this.container.$element;
    	OO.ui.MessageDialog.parent.prototype.setDimensions.call( this, dim );

    	// Twiddle the overflow property, otherwise an unnecessary scrollbar will be produced.
    	// Need to do it after transition completes (250ms), add 50ms just in case.
    	setTimeout( function () {
    		var oldOverflow = $scrollable[ 0 ].style.overflow,
    			activeElement = document.activeElement;

    		$scrollable[ 0 ].style.overflow = 'hidden';

    		OO.ui.Element.static.reconsiderScrollbars( $scrollable[ 0 ] );

    		// Check reconsiderScrollbars didn't destroy our focus, as we
    		// are doing this after the ready process.
    		Iif ( activeElement && activeElement !== document.activeElement && activeElement.focus ) {
    			activeElement.focus();
    		}

    		$scrollable[ 0 ].style.overflow = oldOverflow;
    	}, 300 );

    	dialog.fitActions();
    	// Wait for CSS transition to finish and do it again :(
    	setTimeout( function () {
    		dialog.fitActions();
    	}, 300 );

    	return this;
    };

    /**
     * @inheritdoc
     */
    OO.ui.MessageDialog.prototype.initialize = function () {
    	// Parent method
    	OO.ui.MessageDialog.parent.prototype.initialize.call( this );

    	// Properties
    	this.$actions = $( '<div>' );
    	this.container = new OO.ui.PanelLayout( {
    		scrollable: true, classes: [ 'oo-ui-messageDialog-container' ]
    	} );
    	this.text = new OO.ui.PanelLayout( {
    		padded: true, expanded: false, classes: [ 'oo-ui-messageDialog-text' ]
    	} );
    	this.message = new OO.ui.LabelWidget( {
    		classes: [ 'oo-ui-messageDialog-message' ]
    	} );

    	// Initialization
    	this.title.$element.addClass( 'oo-ui-messageDialog-title' );
    	this.$content.addClass( 'oo-ui-messageDialog-content' );
    	this.container.$element.append( this.text.$element );
    	this.text.$element.append( this.title.$element, this.message.$element );
    	this.$body.append( this.container.$element );
    	this.$actions.addClass( 'oo-ui-messageDialog-actions' );
    	this.$foot.append( this.$actions );
    };

    /**
     * @inheritdoc
     */
    OO.ui.MessageDialog.prototype.getActionWidgetConfig = function ( config ) {
    	// Force unframed
    	return $.extend( {}, config, { framed: false } );
    };

    /**
     * @inheritdoc
     */
    OO.ui.MessageDialog.prototype.attachActions = function () {
    	var i, len, special, others;

    	// Parent method
    	OO.ui.MessageDialog.parent.prototype.attachActions.call( this );

    	special = this.actions.getSpecial();
    	others = this.actions.getOthers();

    	if ( special.safe ) {
    		this.$actions.append( special.safe.$element );
    		special.safe.toggleFramed( true );
    	}
    	for ( i = 0, len = others.length; i < len; i++ ) {
    		this.$actions.append( others[ i ].$element );
    		others[ i ].toggleFramed( true );
    	}
    	Eif ( special.primary ) {
    		this.$actions.append( special.primary.$element );
    		special.primary.toggleFramed( true );
    	}
    };

    /**
     * Fit action actions into columns or rows.
     *
     * Columns will be used if all labels can fit without overflow, otherwise rows will be used.
     *
     * @private
     */
    OO.ui.MessageDialog.prototype.fitActions = function () {
    	var i, len, action,
    		previous = this.verticalActionLayout,
    		actions = this.actions.get();

    	// Detect clipping
    	this.toggleVerticalActionLayout( false );
    	for ( i = 0, len = actions.length; i < len; i++ ) {
    		action = actions[ i ];
    		Iif ( action.$element[ 0 ].scrollWidth > action.$element[ 0 ].clientWidth ) {
    			this.toggleVerticalActionLayout( true );
    			break;
    		}
    	}

    	// Move the body out of the way of the foot
    	this.$body.css( 'bottom', this.$foot.outerHeight( true ) );

    	if ( this.verticalActionLayout !== previous ) {
    		// We changed the layout, window height might need to be updated.
    		this.updateSize();
    	}
    };