Merge "Start using the Assert helper class for checking parameters."
[lhc/web/wiklou.git] / resources / lib / oojs-ui / oojs-ui.js
1 /*!
2 * OOjs UI v0.11.2
3 * https://www.mediawiki.org/wiki/OOjs_UI
4 *
5 * Copyright 2011–2015 OOjs Team and other contributors.
6 * Released under the MIT license
7 * http://oojs.mit-license.org
8 *
9 * Date: 2015-05-11T17:24:27Z
10 */
11 ( function ( OO ) {
12
13 'use strict';
14
15 /**
16 * Namespace for all classes, static methods and static properties.
17 *
18 * @class
19 * @singleton
20 */
21 OO.ui = {};
22
23 OO.ui.bind = $.proxy;
24
25 /**
26 * @property {Object}
27 */
28 OO.ui.Keys = {
29 UNDEFINED: 0,
30 BACKSPACE: 8,
31 DELETE: 46,
32 LEFT: 37,
33 RIGHT: 39,
34 UP: 38,
35 DOWN: 40,
36 ENTER: 13,
37 END: 35,
38 HOME: 36,
39 TAB: 9,
40 PAGEUP: 33,
41 PAGEDOWN: 34,
42 ESCAPE: 27,
43 SHIFT: 16,
44 SPACE: 32
45 };
46
47 /**
48 * Check if an element is focusable.
49 * Inspired from :focusable in jQueryUI v1.11.4 - 2015-04-14
50 *
51 * @param {jQuery} element Element to test
52 * @return {Boolean} [description]
53 */
54 OO.ui.isFocusableElement = function ( $element ) {
55 var node = $element[0],
56 nodeName = node.nodeName.toLowerCase(),
57 // Check if the element have tabindex set
58 isInElementGroup = /^(input|select|textarea|button|object)$/.test( nodeName ),
59 // Check if the element is a link with href or if it has tabindex
60 isOtherElement = (
61 ( nodeName === 'a' && node.href ) ||
62 !isNaN( $element.attr( 'tabindex' ) )
63 ),
64 // Check if the element is visible
65 isVisible = (
66 // This is quicker than calling $element.is( ':visible' )
67 $.expr.filters.visible( node ) &&
68 // Check that all parents are visible
69 !$element.parents().addBack().filter( function () {
70 return $.css( this, 'visibility' ) === 'hidden';
71 } ).length
72 );
73
74 return (
75 ( isInElementGroup ? !node.disabled : isOtherElement ) &&
76 isVisible
77 );
78 };
79
80 /**
81 * Get the user's language and any fallback languages.
82 *
83 * These language codes are used to localize user interface elements in the user's language.
84 *
85 * In environments that provide a localization system, this function should be overridden to
86 * return the user's language(s). The default implementation returns English (en) only.
87 *
88 * @return {string[]} Language codes, in descending order of priority
89 */
90 OO.ui.getUserLanguages = function () {
91 return [ 'en' ];
92 };
93
94 /**
95 * Get a value in an object keyed by language code.
96 *
97 * @param {Object.<string,Mixed>} obj Object keyed by language code
98 * @param {string|null} [lang] Language code, if omitted or null defaults to any user language
99 * @param {string} [fallback] Fallback code, used if no matching language can be found
100 * @return {Mixed} Local value
101 */
102 OO.ui.getLocalValue = function ( obj, lang, fallback ) {
103 var i, len, langs;
104
105 // Requested language
106 if ( obj[ lang ] ) {
107 return obj[ lang ];
108 }
109 // Known user language
110 langs = OO.ui.getUserLanguages();
111 for ( i = 0, len = langs.length; i < len; i++ ) {
112 lang = langs[ i ];
113 if ( obj[ lang ] ) {
114 return obj[ lang ];
115 }
116 }
117 // Fallback language
118 if ( obj[ fallback ] ) {
119 return obj[ fallback ];
120 }
121 // First existing language
122 for ( lang in obj ) {
123 return obj[ lang ];
124 }
125
126 return undefined;
127 };
128
129 /**
130 * Check if a node is contained within another node
131 *
132 * Similar to jQuery#contains except a list of containers can be supplied
133 * and a boolean argument allows you to include the container in the match list
134 *
135 * @param {HTMLElement|HTMLElement[]} containers Container node(s) to search in
136 * @param {HTMLElement} contained Node to find
137 * @param {boolean} [matchContainers] Include the container(s) in the list of nodes to match, otherwise only match descendants
138 * @return {boolean} The node is in the list of target nodes
139 */
140 OO.ui.contains = function ( containers, contained, matchContainers ) {
141 var i;
142 if ( !Array.isArray( containers ) ) {
143 containers = [ containers ];
144 }
145 for ( i = containers.length - 1; i >= 0; i-- ) {
146 if ( ( matchContainers && contained === containers[ i ] ) || $.contains( containers[ i ], contained ) ) {
147 return true;
148 }
149 }
150 return false;
151 };
152
153 /**
154 * Return a function, that, as long as it continues to be invoked, will not
155 * be triggered. The function will be called after it stops being called for
156 * N milliseconds. If `immediate` is passed, trigger the function on the
157 * leading edge, instead of the trailing.
158 *
159 * Ported from: http://underscorejs.org/underscore.js
160 *
161 * @param {Function} func
162 * @param {number} wait
163 * @param {boolean} immediate
164 * @return {Function}
165 */
166 OO.ui.debounce = function ( func, wait, immediate ) {
167 var timeout;
168 return function () {
169 var context = this,
170 args = arguments,
171 later = function () {
172 timeout = null;
173 if ( !immediate ) {
174 func.apply( context, args );
175 }
176 };
177 if ( immediate && !timeout ) {
178 func.apply( context, args );
179 }
180 clearTimeout( timeout );
181 timeout = setTimeout( later, wait );
182 };
183 };
184
185 /**
186 * Reconstitute a JavaScript object corresponding to a widget created by
187 * the PHP implementation.
188 *
189 * This is an alias for `OO.ui.Element.static.infuse()`.
190 *
191 * @param {string|HTMLElement|jQuery} idOrNode
192 * A DOM id (if a string) or node for the widget to infuse.
193 * @return {OO.ui.Element}
194 * The `OO.ui.Element` corresponding to this (infusable) document node.
195 */
196 OO.ui.infuse = function ( idOrNode ) {
197 return OO.ui.Element.static.infuse( idOrNode );
198 };
199
200 ( function () {
201 /**
202 * Message store for the default implementation of OO.ui.msg
203 *
204 * Environments that provide a localization system should not use this, but should override
205 * OO.ui.msg altogether.
206 *
207 * @private
208 */
209 var messages = {
210 // Tool tip for a button that moves items in a list down one place
211 'ooui-outline-control-move-down': 'Move item down',
212 // Tool tip for a button that moves items in a list up one place
213 'ooui-outline-control-move-up': 'Move item up',
214 // Tool tip for a button that removes items from a list
215 'ooui-outline-control-remove': 'Remove item',
216 // Label for the toolbar group that contains a list of all other available tools
217 'ooui-toolbar-more': 'More',
218 // Label for the fake tool that expands the full list of tools in a toolbar group
219 'ooui-toolgroup-expand': 'More',
220 // Label for the fake tool that collapses the full list of tools in a toolbar group
221 'ooui-toolgroup-collapse': 'Fewer',
222 // Default label for the accept button of a confirmation dialog
223 'ooui-dialog-message-accept': 'OK',
224 // Default label for the reject button of a confirmation dialog
225 'ooui-dialog-message-reject': 'Cancel',
226 // Title for process dialog error description
227 'ooui-dialog-process-error': 'Something went wrong',
228 // Label for process dialog dismiss error button, visible when describing errors
229 'ooui-dialog-process-dismiss': 'Dismiss',
230 // Label for process dialog retry action button, visible when describing only recoverable errors
231 'ooui-dialog-process-retry': 'Try again',
232 // Label for process dialog retry action button, visible when describing only warnings
233 'ooui-dialog-process-continue': 'Continue'
234 };
235
236 /**
237 * Get a localized message.
238 *
239 * In environments that provide a localization system, this function should be overridden to
240 * return the message translated in the user's language. The default implementation always returns
241 * English messages.
242 *
243 * After the message key, message parameters may optionally be passed. In the default implementation,
244 * any occurrences of $1 are replaced with the first parameter, $2 with the second parameter, etc.
245 * Alternative implementations of OO.ui.msg may use any substitution system they like, as long as
246 * they support unnamed, ordered message parameters.
247 *
248 * @abstract
249 * @param {string} key Message key
250 * @param {Mixed...} [params] Message parameters
251 * @return {string} Translated message with parameters substituted
252 */
253 OO.ui.msg = function ( key ) {
254 var message = messages[ key ],
255 params = Array.prototype.slice.call( arguments, 1 );
256 if ( typeof message === 'string' ) {
257 // Perform $1 substitution
258 message = message.replace( /\$(\d+)/g, function ( unused, n ) {
259 var i = parseInt( n, 10 );
260 return params[ i - 1 ] !== undefined ? params[ i - 1 ] : '$' + n;
261 } );
262 } else {
263 // Return placeholder if message not found
264 message = '[' + key + ']';
265 }
266 return message;
267 };
268
269 /**
270 * Package a message and arguments for deferred resolution.
271 *
272 * Use this when you are statically specifying a message and the message may not yet be present.
273 *
274 * @param {string} key Message key
275 * @param {Mixed...} [params] Message parameters
276 * @return {Function} Function that returns the resolved message when executed
277 */
278 OO.ui.deferMsg = function () {
279 var args = arguments;
280 return function () {
281 return OO.ui.msg.apply( OO.ui, args );
282 };
283 };
284
285 /**
286 * Resolve a message.
287 *
288 * If the message is a function it will be executed, otherwise it will pass through directly.
289 *
290 * @param {Function|string} msg Deferred message, or message text
291 * @return {string} Resolved message
292 */
293 OO.ui.resolveMsg = function ( msg ) {
294 if ( $.isFunction( msg ) ) {
295 return msg();
296 }
297 return msg;
298 };
299
300 } )();
301
302 /**
303 * Element that can be marked as pending.
304 *
305 * @abstract
306 * @class
307 *
308 * @constructor
309 * @param {Object} [config] Configuration options
310 * @cfg {jQuery} [$pending] Element to mark as pending, defaults to this.$element
311 */
312 OO.ui.PendingElement = function OoUiPendingElement( config ) {
313 // Configuration initialization
314 config = config || {};
315
316 // Properties
317 this.pending = 0;
318 this.$pending = null;
319
320 // Initialisation
321 this.setPendingElement( config.$pending || this.$element );
322 };
323
324 /* Setup */
325
326 OO.initClass( OO.ui.PendingElement );
327
328 /* Methods */
329
330 /**
331 * Set the pending element (and clean up any existing one).
332 *
333 * @param {jQuery} $pending The element to set to pending.
334 */
335 OO.ui.PendingElement.prototype.setPendingElement = function ( $pending ) {
336 if ( this.$pending ) {
337 this.$pending.removeClass( 'oo-ui-pendingElement-pending' );
338 }
339
340 this.$pending = $pending;
341 if ( this.pending > 0 ) {
342 this.$pending.addClass( 'oo-ui-pendingElement-pending' );
343 }
344 };
345
346 /**
347 * Check if input is pending.
348 *
349 * @return {boolean}
350 */
351 OO.ui.PendingElement.prototype.isPending = function () {
352 return !!this.pending;
353 };
354
355 /**
356 * Increase the pending stack.
357 *
358 * @chainable
359 */
360 OO.ui.PendingElement.prototype.pushPending = function () {
361 if ( this.pending === 0 ) {
362 this.$pending.addClass( 'oo-ui-pendingElement-pending' );
363 this.updateThemeClasses();
364 }
365 this.pending++;
366
367 return this;
368 };
369
370 /**
371 * Reduce the pending stack.
372 *
373 * Clamped at zero.
374 *
375 * @chainable
376 */
377 OO.ui.PendingElement.prototype.popPending = function () {
378 if ( this.pending === 1 ) {
379 this.$pending.removeClass( 'oo-ui-pendingElement-pending' );
380 this.updateThemeClasses();
381 }
382 this.pending = Math.max( 0, this.pending - 1 );
383
384 return this;
385 };
386
387 /**
388 * ActionSets manage the behavior of the {@link OO.ui.ActionWidget action widgets} that comprise them.
389 * Actions can be made available for specific contexts (modes) and circumstances
390 * (abilities). Action sets are primarily used with {@link OO.ui.Dialog Dialogs}.
391 *
392 * ActionSets contain two types of actions:
393 *
394 * - 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.
395 * - Other: Other actions include all non-special visible actions.
396 *
397 * Please see the [OOjs UI documentation on MediaWiki][1] for more information.
398 *
399 * @example
400 * // Example: An action set used in a process dialog
401 * function MyProcessDialog( config ) {
402 * MyProcessDialog.super.call( this, config );
403 * }
404 * OO.inheritClass( MyProcessDialog, OO.ui.ProcessDialog );
405 * MyProcessDialog.static.title = 'An action set in a process dialog';
406 * // An action set that uses modes ('edit' and 'help' mode, in this example).
407 * MyProcessDialog.static.actions = [
408 * { action: 'continue', modes: 'edit', label: 'Continue', flags: [ 'primary', 'constructive' ] },
409 * { action: 'help', modes: 'edit', label: 'Help' },
410 * { modes: 'edit', label: 'Cancel', flags: 'safe' },
411 * { action: 'back', modes: 'help', label: 'Back', flags: 'safe' }
412 * ];
413 *
414 * MyProcessDialog.prototype.initialize = function () {
415 * MyProcessDialog.super.prototype.initialize.apply( this, arguments );
416 * this.panel1 = new OO.ui.PanelLayout( { padded: true, expanded: false } );
417 * 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>' );
418 * this.panel2 = new OO.ui.PanelLayout( { padded: true, expanded: false } );
419 * 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>' );
420 * this.stackLayout = new OO.ui.StackLayout( {
421 * items: [ this.panel1, this.panel2 ]
422 * } );
423 * this.$body.append( this.stackLayout.$element );
424 * };
425 * MyProcessDialog.prototype.getSetupProcess = function ( data ) {
426 * return MyProcessDialog.super.prototype.getSetupProcess.call( this, data )
427 * .next( function () {
428 * this.actions.setMode( 'edit' );
429 * }, this );
430 * };
431 * MyProcessDialog.prototype.getActionProcess = function ( action ) {
432 * if ( action === 'help' ) {
433 * this.actions.setMode( 'help' );
434 * this.stackLayout.setItem( this.panel2 );
435 * } else if ( action === 'back' ) {
436 * this.actions.setMode( 'edit' );
437 * this.stackLayout.setItem( this.panel1 );
438 * } else if ( action === 'continue' ) {
439 * var dialog = this;
440 * return new OO.ui.Process( function () {
441 * dialog.close();
442 * } );
443 * }
444 * return MyProcessDialog.super.prototype.getActionProcess.call( this, action );
445 * };
446 * MyProcessDialog.prototype.getBodyHeight = function () {
447 * return this.panel1.$element.outerHeight( true );
448 * };
449 * var windowManager = new OO.ui.WindowManager();
450 * $( 'body' ).append( windowManager.$element );
451 * var dialog = new MyProcessDialog( {
452 * size: 'medium'
453 * } );
454 * windowManager.addWindows( [ dialog ] );
455 * windowManager.openWindow( dialog );
456 *
457 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Windows/Process_Dialogs#Action_sets
458 *
459 * @abstract
460 * @class
461 * @mixins OO.EventEmitter
462 *
463 * @constructor
464 * @param {Object} [config] Configuration options
465 */
466 OO.ui.ActionSet = function OoUiActionSet( config ) {
467 // Configuration initialization
468 config = config || {};
469
470 // Mixin constructors
471 OO.EventEmitter.call( this );
472
473 // Properties
474 this.list = [];
475 this.categories = {
476 actions: 'getAction',
477 flags: 'getFlags',
478 modes: 'getModes'
479 };
480 this.categorized = {};
481 this.special = {};
482 this.others = [];
483 this.organized = false;
484 this.changing = false;
485 this.changed = false;
486 };
487
488 /* Setup */
489
490 OO.mixinClass( OO.ui.ActionSet, OO.EventEmitter );
491
492 /* Static Properties */
493
494 /**
495 * Symbolic name of the flags used to identify special actions. Special actions are displayed in the
496 * header of a {@link OO.ui.ProcessDialog process dialog}.
497 * See the [OOjs UI documentation on MediaWiki][2] for more information and examples.
498 *
499 * [2]:https://www.mediawiki.org/wiki/OOjs_UI/Windows/Process_Dialogs
500 *
501 * @abstract
502 * @static
503 * @inheritable
504 * @property {string}
505 */
506 OO.ui.ActionSet.static.specialFlags = [ 'safe', 'primary' ];
507
508 /* Events */
509
510 /**
511 * @event click
512 *
513 * A 'click' event is emitted when an action is clicked.
514 *
515 * @param {OO.ui.ActionWidget} action Action that was clicked
516 */
517
518 /**
519 * @event resize
520 *
521 * A 'resize' event is emitted when an action widget is resized.
522 *
523 * @param {OO.ui.ActionWidget} action Action that was resized
524 */
525
526 /**
527 * @event add
528 *
529 * An 'add' event is emitted when actions are {@link #method-add added} to the action set.
530 *
531 * @param {OO.ui.ActionWidget[]} added Actions added
532 */
533
534 /**
535 * @event remove
536 *
537 * A 'remove' event is emitted when actions are {@link #method-remove removed}
538 * or {@link #clear cleared}.
539 *
540 * @param {OO.ui.ActionWidget[]} added Actions removed
541 */
542
543 /**
544 * @event change
545 *
546 * A 'change' event is emitted when actions are {@link #method-add added}, {@link #clear cleared},
547 * or {@link #method-remove removed} from the action set or when the {@link #setMode mode} is changed.
548 *
549 */
550
551 /* Methods */
552
553 /**
554 * Handle action change events.
555 *
556 * @private
557 * @fires change
558 */
559 OO.ui.ActionSet.prototype.onActionChange = function () {
560 this.organized = false;
561 if ( this.changing ) {
562 this.changed = true;
563 } else {
564 this.emit( 'change' );
565 }
566 };
567
568 /**
569 * Check if an action is one of the special actions.
570 *
571 * @param {OO.ui.ActionWidget} action Action to check
572 * @return {boolean} Action is special
573 */
574 OO.ui.ActionSet.prototype.isSpecial = function ( action ) {
575 var flag;
576
577 for ( flag in this.special ) {
578 if ( action === this.special[ flag ] ) {
579 return true;
580 }
581 }
582
583 return false;
584 };
585
586 /**
587 * Get action widgets based on the specified filter: ‘actions’, ‘flags’, ‘modes’, ‘visible’,
588 * or ‘disabled’.
589 *
590 * @param {Object} [filters] Filters to use, omit to get all actions
591 * @param {string|string[]} [filters.actions] Actions that action widgets must have
592 * @param {string|string[]} [filters.flags] Flags that action widgets must have (e.g., 'safe')
593 * @param {string|string[]} [filters.modes] Modes that action widgets must have
594 * @param {boolean} [filters.visible] Action widgets must be visible
595 * @param {boolean} [filters.disabled] Action widgets must be disabled
596 * @return {OO.ui.ActionWidget[]} Action widgets matching all criteria
597 */
598 OO.ui.ActionSet.prototype.get = function ( filters ) {
599 var i, len, list, category, actions, index, match, matches;
600
601 if ( filters ) {
602 this.organize();
603
604 // Collect category candidates
605 matches = [];
606 for ( category in this.categorized ) {
607 list = filters[ category ];
608 if ( list ) {
609 if ( !Array.isArray( list ) ) {
610 list = [ list ];
611 }
612 for ( i = 0, len = list.length; i < len; i++ ) {
613 actions = this.categorized[ category ][ list[ i ] ];
614 if ( Array.isArray( actions ) ) {
615 matches.push.apply( matches, actions );
616 }
617 }
618 }
619 }
620 // Remove by boolean filters
621 for ( i = 0, len = matches.length; i < len; i++ ) {
622 match = matches[ i ];
623 if (
624 ( filters.visible !== undefined && match.isVisible() !== filters.visible ) ||
625 ( filters.disabled !== undefined && match.isDisabled() !== filters.disabled )
626 ) {
627 matches.splice( i, 1 );
628 len--;
629 i--;
630 }
631 }
632 // Remove duplicates
633 for ( i = 0, len = matches.length; i < len; i++ ) {
634 match = matches[ i ];
635 index = matches.lastIndexOf( match );
636 while ( index !== i ) {
637 matches.splice( index, 1 );
638 len--;
639 index = matches.lastIndexOf( match );
640 }
641 }
642 return matches;
643 }
644 return this.list.slice();
645 };
646
647 /**
648 * Get 'special' actions.
649 *
650 * Special actions are the first visible action widgets with special flags, such as 'safe' and 'primary'.
651 * Special flags can be configured in subclasses by changing the static #specialFlags property.
652 *
653 * @return {OO.ui.ActionWidget[]|null} 'Special' action widgets.
654 */
655 OO.ui.ActionSet.prototype.getSpecial = function () {
656 this.organize();
657 return $.extend( {}, this.special );
658 };
659
660 /**
661 * Get 'other' actions.
662 *
663 * Other actions include all non-special visible action widgets.
664 *
665 * @return {OO.ui.ActionWidget[]} 'Other' action widgets
666 */
667 OO.ui.ActionSet.prototype.getOthers = function () {
668 this.organize();
669 return this.others.slice();
670 };
671
672 /**
673 * Set the mode (e.g., ‘edit’ or ‘view’). Only {@link OO.ui.ActionWidget#modes actions} configured
674 * to be available in the specified mode will be made visible. All other actions will be hidden.
675 *
676 * @param {string} mode The mode. Only actions configured to be available in the specified
677 * mode will be made visible.
678 * @chainable
679 * @fires toggle
680 * @fires change
681 */
682 OO.ui.ActionSet.prototype.setMode = function ( mode ) {
683 var i, len, action;
684
685 this.changing = true;
686 for ( i = 0, len = this.list.length; i < len; i++ ) {
687 action = this.list[ i ];
688 action.toggle( action.hasMode( mode ) );
689 }
690
691 this.organized = false;
692 this.changing = false;
693 this.emit( 'change' );
694
695 return this;
696 };
697
698 /**
699 * Set the abilities of the specified actions.
700 *
701 * Action widgets that are configured with the specified actions will be enabled
702 * or disabled based on the boolean values specified in the `actions`
703 * parameter.
704 *
705 * @param {Object.<string,boolean>} actions A list keyed by action name with boolean
706 * values that indicate whether or not the action should be enabled.
707 * @chainable
708 */
709 OO.ui.ActionSet.prototype.setAbilities = function ( actions ) {
710 var i, len, action, item;
711
712 for ( i = 0, len = this.list.length; i < len; i++ ) {
713 item = this.list[ i ];
714 action = item.getAction();
715 if ( actions[ action ] !== undefined ) {
716 item.setDisabled( !actions[ action ] );
717 }
718 }
719
720 return this;
721 };
722
723 /**
724 * Executes a function once per action.
725 *
726 * When making changes to multiple actions, use this method instead of iterating over the actions
727 * manually to defer emitting a #change event until after all actions have been changed.
728 *
729 * @param {Object|null} actions Filters to use to determine which actions to iterate over; see #get
730 * @param {Function} callback Callback to run for each action; callback is invoked with three
731 * arguments: the action, the action's index, the list of actions being iterated over
732 * @chainable
733 */
734 OO.ui.ActionSet.prototype.forEach = function ( filter, callback ) {
735 this.changed = false;
736 this.changing = true;
737 this.get( filter ).forEach( callback );
738 this.changing = false;
739 if ( this.changed ) {
740 this.emit( 'change' );
741 }
742
743 return this;
744 };
745
746 /**
747 * Add action widgets to the action set.
748 *
749 * @param {OO.ui.ActionWidget[]} actions Action widgets to add
750 * @chainable
751 * @fires add
752 * @fires change
753 */
754 OO.ui.ActionSet.prototype.add = function ( actions ) {
755 var i, len, action;
756
757 this.changing = true;
758 for ( i = 0, len = actions.length; i < len; i++ ) {
759 action = actions[ i ];
760 action.connect( this, {
761 click: [ 'emit', 'click', action ],
762 resize: [ 'emit', 'resize', action ],
763 toggle: [ 'onActionChange' ]
764 } );
765 this.list.push( action );
766 }
767 this.organized = false;
768 this.emit( 'add', actions );
769 this.changing = false;
770 this.emit( 'change' );
771
772 return this;
773 };
774
775 /**
776 * Remove action widgets from the set.
777 *
778 * To remove all actions, you may wish to use the #clear method instead.
779 *
780 * @param {OO.ui.ActionWidget[]} actions Action widgets to remove
781 * @chainable
782 * @fires remove
783 * @fires change
784 */
785 OO.ui.ActionSet.prototype.remove = function ( actions ) {
786 var i, len, index, action;
787
788 this.changing = true;
789 for ( i = 0, len = actions.length; i < len; i++ ) {
790 action = actions[ i ];
791 index = this.list.indexOf( action );
792 if ( index !== -1 ) {
793 action.disconnect( this );
794 this.list.splice( index, 1 );
795 }
796 }
797 this.organized = false;
798 this.emit( 'remove', actions );
799 this.changing = false;
800 this.emit( 'change' );
801
802 return this;
803 };
804
805 /**
806 * Remove all action widets from the set.
807 *
808 * To remove only specified actions, use the {@link #method-remove remove} method instead.
809 *
810 * @chainable
811 * @fires remove
812 * @fires change
813 */
814 OO.ui.ActionSet.prototype.clear = function () {
815 var i, len, action,
816 removed = this.list.slice();
817
818 this.changing = true;
819 for ( i = 0, len = this.list.length; i < len; i++ ) {
820 action = this.list[ i ];
821 action.disconnect( this );
822 }
823
824 this.list = [];
825
826 this.organized = false;
827 this.emit( 'remove', removed );
828 this.changing = false;
829 this.emit( 'change' );
830
831 return this;
832 };
833
834 /**
835 * Organize actions.
836 *
837 * This is called whenever organized information is requested. It will only reorganize the actions
838 * if something has changed since the last time it ran.
839 *
840 * @private
841 * @chainable
842 */
843 OO.ui.ActionSet.prototype.organize = function () {
844 var i, iLen, j, jLen, flag, action, category, list, item, special,
845 specialFlags = this.constructor.static.specialFlags;
846
847 if ( !this.organized ) {
848 this.categorized = {};
849 this.special = {};
850 this.others = [];
851 for ( i = 0, iLen = this.list.length; i < iLen; i++ ) {
852 action = this.list[ i ];
853 if ( action.isVisible() ) {
854 // Populate categories
855 for ( category in this.categories ) {
856 if ( !this.categorized[ category ] ) {
857 this.categorized[ category ] = {};
858 }
859 list = action[ this.categories[ category ] ]();
860 if ( !Array.isArray( list ) ) {
861 list = [ list ];
862 }
863 for ( j = 0, jLen = list.length; j < jLen; j++ ) {
864 item = list[ j ];
865 if ( !this.categorized[ category ][ item ] ) {
866 this.categorized[ category ][ item ] = [];
867 }
868 this.categorized[ category ][ item ].push( action );
869 }
870 }
871 // Populate special/others
872 special = false;
873 for ( j = 0, jLen = specialFlags.length; j < jLen; j++ ) {
874 flag = specialFlags[ j ];
875 if ( !this.special[ flag ] && action.hasFlag( flag ) ) {
876 this.special[ flag ] = action;
877 special = true;
878 break;
879 }
880 }
881 if ( !special ) {
882 this.others.push( action );
883 }
884 }
885 }
886 this.organized = true;
887 }
888
889 return this;
890 };
891
892 /**
893 * Each Element represents a rendering in the DOM—a button or an icon, for example, or anything
894 * that is visible to a user. Unlike {@link OO.ui.Widget widgets}, plain elements usually do not have events
895 * connected to them and can't be interacted with.
896 *
897 * @abstract
898 * @class
899 *
900 * @constructor
901 * @param {Object} [config] Configuration options
902 * @cfg {string[]} [classes] The names of the CSS classes to apply to the element. CSS styles are added
903 * to the top level (e.g., the outermost div) of the element. See the [OOjs UI documentation on MediaWiki][2]
904 * for an example.
905 * [2]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Buttons_and_Switches#cssExample
906 * @cfg {string} [id] The HTML id attribute used in the rendered tag.
907 * @cfg {string} [text] Text to insert
908 * @cfg {Array} [content] An array of content elements to append (after #text).
909 * Strings will be html-escaped; use an OO.ui.HtmlSnippet to append raw HTML.
910 * Instances of OO.ui.Element will have their $element appended.
911 * @cfg {jQuery} [$content] Content elements to append (after #text)
912 * @cfg {Mixed} [data] Custom data of any type or combination of types (e.g., string, number, array, object).
913 * Data can also be specified with the #setData method.
914 */
915 OO.ui.Element = function OoUiElement( config ) {
916 // Configuration initialization
917 config = config || {};
918
919 // Properties
920 this.$ = $;
921 this.visible = true;
922 this.data = config.data;
923 this.$element = config.$element ||
924 $( document.createElement( this.getTagName() ) );
925 this.elementGroup = null;
926 this.debouncedUpdateThemeClassesHandler = this.debouncedUpdateThemeClasses.bind( this );
927 this.updateThemeClassesPending = false;
928
929 // Initialization
930 if ( Array.isArray( config.classes ) ) {
931 this.$element.addClass( config.classes.join( ' ' ) );
932 }
933 if ( config.id ) {
934 this.$element.attr( 'id', config.id );
935 }
936 if ( config.text ) {
937 this.$element.text( config.text );
938 }
939 if ( config.content ) {
940 // The `content` property treats plain strings as text; use an
941 // HtmlSnippet to append HTML content. `OO.ui.Element`s get their
942 // appropriate $element appended.
943 this.$element.append( config.content.map( function ( v ) {
944 if ( typeof v === 'string' ) {
945 // Escape string so it is properly represented in HTML.
946 return document.createTextNode( v );
947 } else if ( v instanceof OO.ui.HtmlSnippet ) {
948 // Bypass escaping.
949 return v.toString();
950 } else if ( v instanceof OO.ui.Element ) {
951 return v.$element;
952 }
953 return v;
954 } ) );
955 }
956 if ( config.$content ) {
957 // The `$content` property treats plain strings as HTML.
958 this.$element.append( config.$content );
959 }
960 };
961
962 /* Setup */
963
964 OO.initClass( OO.ui.Element );
965
966 /* Static Properties */
967
968 /**
969 * The name of the HTML tag used by the element.
970 *
971 * The static value may be ignored if the #getTagName method is overridden.
972 *
973 * @static
974 * @inheritable
975 * @property {string}
976 */
977 OO.ui.Element.static.tagName = 'div';
978
979 /* Static Methods */
980
981 /**
982 * Reconstitute a JavaScript object corresponding to a widget created
983 * by the PHP implementation.
984 *
985 * @param {string|HTMLElement|jQuery} idOrNode
986 * A DOM id (if a string) or node for the widget to infuse.
987 * @return {OO.ui.Element}
988 * The `OO.ui.Element` corresponding to this (infusable) document node.
989 * For `Tag` objects emitted on the HTML side (used occasionally for content)
990 * the value returned is a newly-created Element wrapping around the existing
991 * DOM node.
992 */
993 OO.ui.Element.static.infuse = function ( idOrNode ) {
994 var obj = OO.ui.Element.static.unsafeInfuse( idOrNode, true );
995 // Verify that the type matches up.
996 // FIXME: uncomment after T89721 is fixed (see T90929)
997 /*
998 if ( !( obj instanceof this['class'] ) ) {
999 throw new Error( 'Infusion type mismatch!' );
1000 }
1001 */
1002 return obj;
1003 };
1004
1005 /**
1006 * Implementation helper for `infuse`; skips the type check and has an
1007 * extra property so that only the top-level invocation touches the DOM.
1008 * @private
1009 * @param {string|HTMLElement|jQuery} idOrNode
1010 * @param {boolean} top True only for top-level invocation.
1011 * @return {OO.ui.Element}
1012 */
1013 OO.ui.Element.static.unsafeInfuse = function ( idOrNode, top ) {
1014 // look for a cached result of a previous infusion.
1015 var id, $elem, data, cls, obj;
1016 if ( typeof idOrNode === 'string' ) {
1017 id = idOrNode;
1018 $elem = $( document.getElementById( id ) );
1019 } else {
1020 $elem = $( idOrNode );
1021 id = $elem.attr( 'id' );
1022 }
1023 data = $elem.data( 'ooui-infused' );
1024 if ( data ) {
1025 // cached!
1026 if ( data === true ) {
1027 throw new Error( 'Circular dependency! ' + id );
1028 }
1029 return data;
1030 }
1031 if ( !$elem.length ) {
1032 throw new Error( 'Widget not found: ' + id );
1033 }
1034 data = $elem.attr( 'data-ooui' );
1035 if ( !data ) {
1036 throw new Error( 'No infusion data found: ' + id );
1037 }
1038 try {
1039 data = $.parseJSON( data );
1040 } catch ( _ ) {
1041 data = null;
1042 }
1043 if ( !( data && data._ ) ) {
1044 throw new Error( 'No valid infusion data found: ' + id );
1045 }
1046 if ( data._ === 'Tag' ) {
1047 // Special case: this is a raw Tag; wrap existing node, don't rebuild.
1048 return new OO.ui.Element( { $element: $elem } );
1049 }
1050 cls = OO.ui[data._];
1051 if ( !cls ) {
1052 throw new Error( 'Unknown widget type: ' + id );
1053 }
1054 $elem.data( 'ooui-infused', true ); // prevent loops
1055 data.id = id; // implicit
1056 data = OO.copy( data, null, function deserialize( value ) {
1057 if ( OO.isPlainObject( value ) ) {
1058 if ( value.tag ) {
1059 return OO.ui.Element.static.unsafeInfuse( value.tag, false );
1060 }
1061 if ( value.html ) {
1062 return new OO.ui.HtmlSnippet( value.html );
1063 }
1064 }
1065 } );
1066 // jscs:disable requireCapitalizedConstructors
1067 obj = new cls( data ); // rebuild widget
1068 // now replace old DOM with this new DOM.
1069 if ( top ) {
1070 $elem.replaceWith( obj.$element );
1071 }
1072 obj.$element.data( 'ooui-infused', obj );
1073 // set the 'data-ooui' attribute so we can identify infused widgets
1074 obj.$element.attr( 'data-ooui', '' );
1075 return obj;
1076 };
1077
1078 /**
1079 * Get a jQuery function within a specific document.
1080 *
1081 * @static
1082 * @param {jQuery|HTMLElement|HTMLDocument|Window} context Context to bind the function to
1083 * @param {jQuery} [$iframe] HTML iframe element that contains the document, omit if document is
1084 * not in an iframe
1085 * @return {Function} Bound jQuery function
1086 */
1087 OO.ui.Element.static.getJQuery = function ( context, $iframe ) {
1088 function wrapper( selector ) {
1089 return $( selector, wrapper.context );
1090 }
1091
1092 wrapper.context = this.getDocument( context );
1093
1094 if ( $iframe ) {
1095 wrapper.$iframe = $iframe;
1096 }
1097
1098 return wrapper;
1099 };
1100
1101 /**
1102 * Get the document of an element.
1103 *
1104 * @static
1105 * @param {jQuery|HTMLElement|HTMLDocument|Window} obj Object to get the document for
1106 * @return {HTMLDocument|null} Document object
1107 */
1108 OO.ui.Element.static.getDocument = function ( obj ) {
1109 // jQuery - selections created "offscreen" won't have a context, so .context isn't reliable
1110 return ( obj[ 0 ] && obj[ 0 ].ownerDocument ) ||
1111 // Empty jQuery selections might have a context
1112 obj.context ||
1113 // HTMLElement
1114 obj.ownerDocument ||
1115 // Window
1116 obj.document ||
1117 // HTMLDocument
1118 ( obj.nodeType === 9 && obj ) ||
1119 null;
1120 };
1121
1122 /**
1123 * Get the window of an element or document.
1124 *
1125 * @static
1126 * @param {jQuery|HTMLElement|HTMLDocument|Window} obj Context to get the window for
1127 * @return {Window} Window object
1128 */
1129 OO.ui.Element.static.getWindow = function ( obj ) {
1130 var doc = this.getDocument( obj );
1131 return doc.parentWindow || doc.defaultView;
1132 };
1133
1134 /**
1135 * Get the direction of an element or document.
1136 *
1137 * @static
1138 * @param {jQuery|HTMLElement|HTMLDocument|Window} obj Context to get the direction for
1139 * @return {string} Text direction, either 'ltr' or 'rtl'
1140 */
1141 OO.ui.Element.static.getDir = function ( obj ) {
1142 var isDoc, isWin;
1143
1144 if ( obj instanceof jQuery ) {
1145 obj = obj[ 0 ];
1146 }
1147 isDoc = obj.nodeType === 9;
1148 isWin = obj.document !== undefined;
1149 if ( isDoc || isWin ) {
1150 if ( isWin ) {
1151 obj = obj.document;
1152 }
1153 obj = obj.body;
1154 }
1155 return $( obj ).css( 'direction' );
1156 };
1157
1158 /**
1159 * Get the offset between two frames.
1160 *
1161 * TODO: Make this function not use recursion.
1162 *
1163 * @static
1164 * @param {Window} from Window of the child frame
1165 * @param {Window} [to=window] Window of the parent frame
1166 * @param {Object} [offset] Offset to start with, used internally
1167 * @return {Object} Offset object, containing left and top properties
1168 */
1169 OO.ui.Element.static.getFrameOffset = function ( from, to, offset ) {
1170 var i, len, frames, frame, rect;
1171
1172 if ( !to ) {
1173 to = window;
1174 }
1175 if ( !offset ) {
1176 offset = { top: 0, left: 0 };
1177 }
1178 if ( from.parent === from ) {
1179 return offset;
1180 }
1181
1182 // Get iframe element
1183 frames = from.parent.document.getElementsByTagName( 'iframe' );
1184 for ( i = 0, len = frames.length; i < len; i++ ) {
1185 if ( frames[ i ].contentWindow === from ) {
1186 frame = frames[ i ];
1187 break;
1188 }
1189 }
1190
1191 // Recursively accumulate offset values
1192 if ( frame ) {
1193 rect = frame.getBoundingClientRect();
1194 offset.left += rect.left;
1195 offset.top += rect.top;
1196 if ( from !== to ) {
1197 this.getFrameOffset( from.parent, offset );
1198 }
1199 }
1200 return offset;
1201 };
1202
1203 /**
1204 * Get the offset between two elements.
1205 *
1206 * The two elements may be in a different frame, but in that case the frame $element is in must
1207 * be contained in the frame $anchor is in.
1208 *
1209 * @static
1210 * @param {jQuery} $element Element whose position to get
1211 * @param {jQuery} $anchor Element to get $element's position relative to
1212 * @return {Object} Translated position coordinates, containing top and left properties
1213 */
1214 OO.ui.Element.static.getRelativePosition = function ( $element, $anchor ) {
1215 var iframe, iframePos,
1216 pos = $element.offset(),
1217 anchorPos = $anchor.offset(),
1218 elementDocument = this.getDocument( $element ),
1219 anchorDocument = this.getDocument( $anchor );
1220
1221 // If $element isn't in the same document as $anchor, traverse up
1222 while ( elementDocument !== anchorDocument ) {
1223 iframe = elementDocument.defaultView.frameElement;
1224 if ( !iframe ) {
1225 throw new Error( '$element frame is not contained in $anchor frame' );
1226 }
1227 iframePos = $( iframe ).offset();
1228 pos.left += iframePos.left;
1229 pos.top += iframePos.top;
1230 elementDocument = iframe.ownerDocument;
1231 }
1232 pos.left -= anchorPos.left;
1233 pos.top -= anchorPos.top;
1234 return pos;
1235 };
1236
1237 /**
1238 * Get element border sizes.
1239 *
1240 * @static
1241 * @param {HTMLElement} el Element to measure
1242 * @return {Object} Dimensions object with `top`, `left`, `bottom` and `right` properties
1243 */
1244 OO.ui.Element.static.getBorders = function ( el ) {
1245 var doc = el.ownerDocument,
1246 win = doc.parentWindow || doc.defaultView,
1247 style = win && win.getComputedStyle ?
1248 win.getComputedStyle( el, null ) :
1249 el.currentStyle,
1250 $el = $( el ),
1251 top = parseFloat( style ? style.borderTopWidth : $el.css( 'borderTopWidth' ) ) || 0,
1252 left = parseFloat( style ? style.borderLeftWidth : $el.css( 'borderLeftWidth' ) ) || 0,
1253 bottom = parseFloat( style ? style.borderBottomWidth : $el.css( 'borderBottomWidth' ) ) || 0,
1254 right = parseFloat( style ? style.borderRightWidth : $el.css( 'borderRightWidth' ) ) || 0;
1255
1256 return {
1257 top: top,
1258 left: left,
1259 bottom: bottom,
1260 right: right
1261 };
1262 };
1263
1264 /**
1265 * Get dimensions of an element or window.
1266 *
1267 * @static
1268 * @param {HTMLElement|Window} el Element to measure
1269 * @return {Object} Dimensions object with `borders`, `scroll`, `scrollbar` and `rect` properties
1270 */
1271 OO.ui.Element.static.getDimensions = function ( el ) {
1272 var $el, $win,
1273 doc = el.ownerDocument || el.document,
1274 win = doc.parentWindow || doc.defaultView;
1275
1276 if ( win === el || el === doc.documentElement ) {
1277 $win = $( win );
1278 return {
1279 borders: { top: 0, left: 0, bottom: 0, right: 0 },
1280 scroll: {
1281 top: $win.scrollTop(),
1282 left: $win.scrollLeft()
1283 },
1284 scrollbar: { right: 0, bottom: 0 },
1285 rect: {
1286 top: 0,
1287 left: 0,
1288 bottom: $win.innerHeight(),
1289 right: $win.innerWidth()
1290 }
1291 };
1292 } else {
1293 $el = $( el );
1294 return {
1295 borders: this.getBorders( el ),
1296 scroll: {
1297 top: $el.scrollTop(),
1298 left: $el.scrollLeft()
1299 },
1300 scrollbar: {
1301 right: $el.innerWidth() - el.clientWidth,
1302 bottom: $el.innerHeight() - el.clientHeight
1303 },
1304 rect: el.getBoundingClientRect()
1305 };
1306 }
1307 };
1308
1309 /**
1310 * Get scrollable object parent
1311 *
1312 * documentElement can't be used to get or set the scrollTop
1313 * property on Blink. Changing and testing its value lets us
1314 * use 'body' or 'documentElement' based on what is working.
1315 *
1316 * https://code.google.com/p/chromium/issues/detail?id=303131
1317 *
1318 * @static
1319 * @param {HTMLElement} el Element to find scrollable parent for
1320 * @return {HTMLElement} Scrollable parent
1321 */
1322 OO.ui.Element.static.getRootScrollableElement = function ( el ) {
1323 var scrollTop, body;
1324
1325 if ( OO.ui.scrollableElement === undefined ) {
1326 body = el.ownerDocument.body;
1327 scrollTop = body.scrollTop;
1328 body.scrollTop = 1;
1329
1330 if ( body.scrollTop === 1 ) {
1331 body.scrollTop = scrollTop;
1332 OO.ui.scrollableElement = 'body';
1333 } else {
1334 OO.ui.scrollableElement = 'documentElement';
1335 }
1336 }
1337
1338 return el.ownerDocument[ OO.ui.scrollableElement ];
1339 };
1340
1341 /**
1342 * Get closest scrollable container.
1343 *
1344 * Traverses up until either a scrollable element or the root is reached, in which case the window
1345 * will be returned.
1346 *
1347 * @static
1348 * @param {HTMLElement} el Element to find scrollable container for
1349 * @param {string} [dimension] Dimension of scrolling to look for; `x`, `y` or omit for either
1350 * @return {HTMLElement} Closest scrollable container
1351 */
1352 OO.ui.Element.static.getClosestScrollableContainer = function ( el, dimension ) {
1353 var i, val,
1354 props = [ 'overflow' ],
1355 $parent = $( el ).parent();
1356
1357 if ( dimension === 'x' || dimension === 'y' ) {
1358 props.push( 'overflow-' + dimension );
1359 }
1360
1361 while ( $parent.length ) {
1362 if ( $parent[ 0 ] === this.getRootScrollableElement( el ) ) {
1363 return $parent[ 0 ];
1364 }
1365 i = props.length;
1366 while ( i-- ) {
1367 val = $parent.css( props[ i ] );
1368 if ( val === 'auto' || val === 'scroll' ) {
1369 return $parent[ 0 ];
1370 }
1371 }
1372 $parent = $parent.parent();
1373 }
1374 return this.getDocument( el ).body;
1375 };
1376
1377 /**
1378 * Scroll element into view.
1379 *
1380 * @static
1381 * @param {HTMLElement} el Element to scroll into view
1382 * @param {Object} [config] Configuration options
1383 * @param {string} [config.duration] jQuery animation duration value
1384 * @param {string} [config.direction] Scroll in only one direction, e.g. 'x' or 'y', omit
1385 * to scroll in both directions
1386 * @param {Function} [config.complete] Function to call when scrolling completes
1387 */
1388 OO.ui.Element.static.scrollIntoView = function ( el, config ) {
1389 // Configuration initialization
1390 config = config || {};
1391
1392 var rel, anim = {},
1393 callback = typeof config.complete === 'function' && config.complete,
1394 sc = this.getClosestScrollableContainer( el, config.direction ),
1395 $sc = $( sc ),
1396 eld = this.getDimensions( el ),
1397 scd = this.getDimensions( sc ),
1398 $win = $( this.getWindow( el ) );
1399
1400 // Compute the distances between the edges of el and the edges of the scroll viewport
1401 if ( $sc.is( 'html, body' ) ) {
1402 // If the scrollable container is the root, this is easy
1403 rel = {
1404 top: eld.rect.top,
1405 bottom: $win.innerHeight() - eld.rect.bottom,
1406 left: eld.rect.left,
1407 right: $win.innerWidth() - eld.rect.right
1408 };
1409 } else {
1410 // Otherwise, we have to subtract el's coordinates from sc's coordinates
1411 rel = {
1412 top: eld.rect.top - ( scd.rect.top + scd.borders.top ),
1413 bottom: scd.rect.bottom - scd.borders.bottom - scd.scrollbar.bottom - eld.rect.bottom,
1414 left: eld.rect.left - ( scd.rect.left + scd.borders.left ),
1415 right: scd.rect.right - scd.borders.right - scd.scrollbar.right - eld.rect.right
1416 };
1417 }
1418
1419 if ( !config.direction || config.direction === 'y' ) {
1420 if ( rel.top < 0 ) {
1421 anim.scrollTop = scd.scroll.top + rel.top;
1422 } else if ( rel.top > 0 && rel.bottom < 0 ) {
1423 anim.scrollTop = scd.scroll.top + Math.min( rel.top, -rel.bottom );
1424 }
1425 }
1426 if ( !config.direction || config.direction === 'x' ) {
1427 if ( rel.left < 0 ) {
1428 anim.scrollLeft = scd.scroll.left + rel.left;
1429 } else if ( rel.left > 0 && rel.right < 0 ) {
1430 anim.scrollLeft = scd.scroll.left + Math.min( rel.left, -rel.right );
1431 }
1432 }
1433 if ( !$.isEmptyObject( anim ) ) {
1434 $sc.stop( true ).animate( anim, config.duration || 'fast' );
1435 if ( callback ) {
1436 $sc.queue( function ( next ) {
1437 callback();
1438 next();
1439 } );
1440 }
1441 } else {
1442 if ( callback ) {
1443 callback();
1444 }
1445 }
1446 };
1447
1448 /**
1449 * Force the browser to reconsider whether it really needs to render scrollbars inside the element
1450 * and reserve space for them, because it probably doesn't.
1451 *
1452 * Workaround primarily for <https://code.google.com/p/chromium/issues/detail?id=387290>, but also
1453 * similar bugs in other browsers. "Just" forcing a reflow is not sufficient in all cases, we need
1454 * to first actually detach (or hide, but detaching is simpler) all children, *then* force a reflow,
1455 * and then reattach (or show) them back.
1456 *
1457 * @static
1458 * @param {HTMLElement} el Element to reconsider the scrollbars on
1459 */
1460 OO.ui.Element.static.reconsiderScrollbars = function ( el ) {
1461 var i, len, nodes = [];
1462 // Detach all children
1463 while ( el.firstChild ) {
1464 nodes.push( el.firstChild );
1465 el.removeChild( el.firstChild );
1466 }
1467 // Force reflow
1468 void el.offsetHeight;
1469 // Reattach all children
1470 for ( i = 0, len = nodes.length; i < len; i++ ) {
1471 el.appendChild( nodes[ i ] );
1472 }
1473 };
1474
1475 /* Methods */
1476
1477 /**
1478 * Toggle visibility of an element.
1479 *
1480 * @param {boolean} [show] Make element visible, omit to toggle visibility
1481 * @fires visible
1482 * @chainable
1483 */
1484 OO.ui.Element.prototype.toggle = function ( show ) {
1485 show = show === undefined ? !this.visible : !!show;
1486
1487 if ( show !== this.isVisible() ) {
1488 this.visible = show;
1489 this.$element.toggleClass( 'oo-ui-element-hidden', !this.visible );
1490 this.emit( 'toggle', show );
1491 }
1492
1493 return this;
1494 };
1495
1496 /**
1497 * Check if element is visible.
1498 *
1499 * @return {boolean} element is visible
1500 */
1501 OO.ui.Element.prototype.isVisible = function () {
1502 return this.visible;
1503 };
1504
1505 /**
1506 * Get element data.
1507 *
1508 * @return {Mixed} Element data
1509 */
1510 OO.ui.Element.prototype.getData = function () {
1511 return this.data;
1512 };
1513
1514 /**
1515 * Set element data.
1516 *
1517 * @param {Mixed} Element data
1518 * @chainable
1519 */
1520 OO.ui.Element.prototype.setData = function ( data ) {
1521 this.data = data;
1522 return this;
1523 };
1524
1525 /**
1526 * Check if element supports one or more methods.
1527 *
1528 * @param {string|string[]} methods Method or list of methods to check
1529 * @return {boolean} All methods are supported
1530 */
1531 OO.ui.Element.prototype.supports = function ( methods ) {
1532 var i, len,
1533 support = 0;
1534
1535 methods = Array.isArray( methods ) ? methods : [ methods ];
1536 for ( i = 0, len = methods.length; i < len; i++ ) {
1537 if ( $.isFunction( this[ methods[ i ] ] ) ) {
1538 support++;
1539 }
1540 }
1541
1542 return methods.length === support;
1543 };
1544
1545 /**
1546 * Update the theme-provided classes.
1547 *
1548 * @localdoc This is called in element mixins and widget classes any time state changes.
1549 * Updating is debounced, minimizing overhead of changing multiple attributes and
1550 * guaranteeing that theme updates do not occur within an element's constructor
1551 */
1552 OO.ui.Element.prototype.updateThemeClasses = function () {
1553 if ( !this.updateThemeClassesPending ) {
1554 this.updateThemeClassesPending = true;
1555 setTimeout( this.debouncedUpdateThemeClassesHandler );
1556 }
1557 };
1558
1559 /**
1560 * @private
1561 */
1562 OO.ui.Element.prototype.debouncedUpdateThemeClasses = function () {
1563 OO.ui.theme.updateElementClasses( this );
1564 this.updateThemeClassesPending = false;
1565 };
1566
1567 /**
1568 * Get the HTML tag name.
1569 *
1570 * Override this method to base the result on instance information.
1571 *
1572 * @return {string} HTML tag name
1573 */
1574 OO.ui.Element.prototype.getTagName = function () {
1575 return this.constructor.static.tagName;
1576 };
1577
1578 /**
1579 * Check if the element is attached to the DOM
1580 * @return {boolean} The element is attached to the DOM
1581 */
1582 OO.ui.Element.prototype.isElementAttached = function () {
1583 return $.contains( this.getElementDocument(), this.$element[ 0 ] );
1584 };
1585
1586 /**
1587 * Get the DOM document.
1588 *
1589 * @return {HTMLDocument} Document object
1590 */
1591 OO.ui.Element.prototype.getElementDocument = function () {
1592 // Don't cache this in other ways either because subclasses could can change this.$element
1593 return OO.ui.Element.static.getDocument( this.$element );
1594 };
1595
1596 /**
1597 * Get the DOM window.
1598 *
1599 * @return {Window} Window object
1600 */
1601 OO.ui.Element.prototype.getElementWindow = function () {
1602 return OO.ui.Element.static.getWindow( this.$element );
1603 };
1604
1605 /**
1606 * Get closest scrollable container.
1607 */
1608 OO.ui.Element.prototype.getClosestScrollableElementContainer = function () {
1609 return OO.ui.Element.static.getClosestScrollableContainer( this.$element[ 0 ] );
1610 };
1611
1612 /**
1613 * Get group element is in.
1614 *
1615 * @return {OO.ui.GroupElement|null} Group element, null if none
1616 */
1617 OO.ui.Element.prototype.getElementGroup = function () {
1618 return this.elementGroup;
1619 };
1620
1621 /**
1622 * Set group element is in.
1623 *
1624 * @param {OO.ui.GroupElement|null} group Group element, null if none
1625 * @chainable
1626 */
1627 OO.ui.Element.prototype.setElementGroup = function ( group ) {
1628 this.elementGroup = group;
1629 return this;
1630 };
1631
1632 /**
1633 * Scroll element into view.
1634 *
1635 * @param {Object} [config] Configuration options
1636 */
1637 OO.ui.Element.prototype.scrollElementIntoView = function ( config ) {
1638 return OO.ui.Element.static.scrollIntoView( this.$element[ 0 ], config );
1639 };
1640
1641 /**
1642 * Layouts are containers for elements and are used to arrange other widgets of arbitrary type in a way
1643 * that is centrally controlled and can be updated dynamically. Layouts can be, and usually are, combined.
1644 * See {@link OO.ui.FieldsetLayout FieldsetLayout}, {@link OO.ui.FieldLayout FieldLayout}, {@link OO.ui.FormLayout FormLayout},
1645 * {@link OO.ui.PanelLayout PanelLayout}, {@link OO.ui.StackLayout StackLayout}, {@link OO.ui.PageLayout PageLayout},
1646 * and {@link OO.ui.BookletLayout BookletLayout} for more information and examples.
1647 *
1648 * @abstract
1649 * @class
1650 * @extends OO.ui.Element
1651 * @mixins OO.EventEmitter
1652 *
1653 * @constructor
1654 * @param {Object} [config] Configuration options
1655 */
1656 OO.ui.Layout = function OoUiLayout( config ) {
1657 // Configuration initialization
1658 config = config || {};
1659
1660 // Parent constructor
1661 OO.ui.Layout.super.call( this, config );
1662
1663 // Mixin constructors
1664 OO.EventEmitter.call( this );
1665
1666 // Initialization
1667 this.$element.addClass( 'oo-ui-layout' );
1668 };
1669
1670 /* Setup */
1671
1672 OO.inheritClass( OO.ui.Layout, OO.ui.Element );
1673 OO.mixinClass( OO.ui.Layout, OO.EventEmitter );
1674
1675 /**
1676 * Widgets are compositions of one or more OOjs UI elements that users can both view
1677 * and interact with. All widgets can be configured and modified via a standard API,
1678 * and their state can change dynamically according to a model.
1679 *
1680 * @abstract
1681 * @class
1682 * @extends OO.ui.Element
1683 * @mixins OO.EventEmitter
1684 *
1685 * @constructor
1686 * @param {Object} [config] Configuration options
1687 * @cfg {boolean} [disabled=false] Disable the widget. Disabled widgets cannot be used and their
1688 * appearance reflects this state.
1689 */
1690 OO.ui.Widget = function OoUiWidget( config ) {
1691 // Initialize config
1692 config = $.extend( { disabled: false }, config );
1693
1694 // Parent constructor
1695 OO.ui.Widget.super.call( this, config );
1696
1697 // Mixin constructors
1698 OO.EventEmitter.call( this );
1699
1700 // Properties
1701 this.disabled = null;
1702 this.wasDisabled = null;
1703
1704 // Initialization
1705 this.$element.addClass( 'oo-ui-widget' );
1706 this.setDisabled( !!config.disabled );
1707 };
1708
1709 /* Setup */
1710
1711 OO.inheritClass( OO.ui.Widget, OO.ui.Element );
1712 OO.mixinClass( OO.ui.Widget, OO.EventEmitter );
1713
1714 /* Events */
1715
1716 /**
1717 * @event disable
1718 *
1719 * A 'disable' event is emitted when a widget is disabled.
1720 *
1721 * @param {boolean} disabled Widget is disabled
1722 */
1723
1724 /**
1725 * @event toggle
1726 *
1727 * A 'toggle' event is emitted when the visibility of the widget changes.
1728 *
1729 * @param {boolean} visible Widget is visible
1730 */
1731
1732 /* Methods */
1733
1734 /**
1735 * Check if the widget is disabled.
1736 *
1737 * @return {boolean} Widget is disabled
1738 */
1739 OO.ui.Widget.prototype.isDisabled = function () {
1740 return this.disabled;
1741 };
1742
1743 /**
1744 * Set the 'disabled' state of the widget.
1745 *
1746 * When a widget is disabled, it cannot be used and its appearance is updated to reflect this state.
1747 *
1748 * @param {boolean} disabled Disable widget
1749 * @chainable
1750 */
1751 OO.ui.Widget.prototype.setDisabled = function ( disabled ) {
1752 var isDisabled;
1753
1754 this.disabled = !!disabled;
1755 isDisabled = this.isDisabled();
1756 if ( isDisabled !== this.wasDisabled ) {
1757 this.$element.toggleClass( 'oo-ui-widget-disabled', isDisabled );
1758 this.$element.toggleClass( 'oo-ui-widget-enabled', !isDisabled );
1759 this.$element.attr( 'aria-disabled', isDisabled.toString() );
1760 this.emit( 'disable', isDisabled );
1761 this.updateThemeClasses();
1762 }
1763 this.wasDisabled = isDisabled;
1764
1765 return this;
1766 };
1767
1768 /**
1769 * Update the disabled state, in case of changes in parent widget.
1770 *
1771 * @chainable
1772 */
1773 OO.ui.Widget.prototype.updateDisabled = function () {
1774 this.setDisabled( this.disabled );
1775 return this;
1776 };
1777
1778 /**
1779 * A window is a container for elements that are in a child frame. They are used with
1780 * a window manager (OO.ui.WindowManager), which is used to open and close the window and control
1781 * its presentation. The size of a window is specified using a symbolic name (e.g., ‘small’, ‘medium’,
1782 * ‘large’), which is interpreted by the window manager. If the requested size is not recognized,
1783 * the window manager will choose a sensible fallback.
1784 *
1785 * The lifecycle of a window has three primary stages (opening, opened, and closing) in which
1786 * different processes are executed:
1787 *
1788 * **opening**: The opening stage begins when the window manager's {@link OO.ui.WindowManager#openWindow
1789 * openWindow} or the window's {@link #open open} methods are used, and the window manager begins to open
1790 * the window.
1791 *
1792 * - {@link #getSetupProcess} method is called and its result executed
1793 * - {@link #getReadyProcess} method is called and its result executed
1794 *
1795 * **opened**: The window is now open
1796 *
1797 * **closing**: The closing stage begins when the window manager's
1798 * {@link OO.ui.WindowManager#closeWindow closeWindow}
1799 * or the window's {@link #close} methods are used, and the window manager begins to close the window.
1800 *
1801 * - {@link #getHoldProcess} method is called and its result executed
1802 * - {@link #getTeardownProcess} method is called and its result executed. The window is now closed
1803 *
1804 * Each of the window's processes (setup, ready, hold, and teardown) can be extended in subclasses
1805 * by overriding the window's #getSetupProcess, #getReadyProcess, #getHoldProcess and #getTeardownProcess
1806 * methods. Note that each {@link OO.ui.Process process} is executed in series, so asynchronous
1807 * processing can complete. Always assume window processes are executed asynchronously.
1808 *
1809 * For more information, please see the [OOjs UI documentation on MediaWiki] [1].
1810 *
1811 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Windows
1812 *
1813 * @abstract
1814 * @class
1815 * @extends OO.ui.Element
1816 * @mixins OO.EventEmitter
1817 *
1818 * @constructor
1819 * @param {Object} [config] Configuration options
1820 * @cfg {string} [size] Symbolic name of the dialog size: `small`, `medium`, `large`, `larger` or
1821 * `full`. If omitted, the value of the {@link #static-size static size} property will be used.
1822 */
1823 OO.ui.Window = function OoUiWindow( config ) {
1824 // Configuration initialization
1825 config = config || {};
1826
1827 // Parent constructor
1828 OO.ui.Window.super.call( this, config );
1829
1830 // Mixin constructors
1831 OO.EventEmitter.call( this );
1832
1833 // Properties
1834 this.manager = null;
1835 this.size = config.size || this.constructor.static.size;
1836 this.$frame = $( '<div>' );
1837 this.$overlay = $( '<div>' );
1838 this.$content = $( '<div>' );
1839
1840 // Initialization
1841 this.$overlay.addClass( 'oo-ui-window-overlay' );
1842 this.$content
1843 .addClass( 'oo-ui-window-content' )
1844 .attr( 'tabindex', 0 );
1845 this.$frame
1846 .addClass( 'oo-ui-window-frame' )
1847 .append( this.$content );
1848
1849 this.$element
1850 .addClass( 'oo-ui-window' )
1851 .append( this.$frame, this.$overlay );
1852
1853 // Initially hidden - using #toggle may cause errors if subclasses override toggle with methods
1854 // that reference properties not initialized at that time of parent class construction
1855 // TODO: Find a better way to handle post-constructor setup
1856 this.visible = false;
1857 this.$element.addClass( 'oo-ui-element-hidden' );
1858 };
1859
1860 /* Setup */
1861
1862 OO.inheritClass( OO.ui.Window, OO.ui.Element );
1863 OO.mixinClass( OO.ui.Window, OO.EventEmitter );
1864
1865 /* Static Properties */
1866
1867 /**
1868 * Symbolic name of the window size: `small`, `medium`, `large`, `larger` or `full`.
1869 *
1870 * The static size is used if no #size is configured during construction.
1871 *
1872 * @static
1873 * @inheritable
1874 * @property {string}
1875 */
1876 OO.ui.Window.static.size = 'medium';
1877
1878 /* Methods */
1879
1880 /**
1881 * Handle mouse down events.
1882 *
1883 * @private
1884 * @param {jQuery.Event} e Mouse down event
1885 */
1886 OO.ui.Window.prototype.onMouseDown = function ( e ) {
1887 // Prevent clicking on the click-block from stealing focus
1888 if ( e.target === this.$element[ 0 ] ) {
1889 return false;
1890 }
1891 };
1892
1893 /**
1894 * Check if the window has been initialized.
1895 *
1896 * Initialization occurs when a window is added to a manager.
1897 *
1898 * @return {boolean} Window has been initialized
1899 */
1900 OO.ui.Window.prototype.isInitialized = function () {
1901 return !!this.manager;
1902 };
1903
1904 /**
1905 * Check if the window is visible.
1906 *
1907 * @return {boolean} Window is visible
1908 */
1909 OO.ui.Window.prototype.isVisible = function () {
1910 return this.visible;
1911 };
1912
1913 /**
1914 * Check if the window is opening.
1915 *
1916 * This method is a wrapper around the window manager's {@link OO.ui.WindowManager#isOpening isOpening}
1917 * method.
1918 *
1919 * @return {boolean} Window is opening
1920 */
1921 OO.ui.Window.prototype.isOpening = function () {
1922 return this.manager.isOpening( this );
1923 };
1924
1925 /**
1926 * Check if the window is closing.
1927 *
1928 * This method is a wrapper around the window manager's {@link OO.ui.WindowManager#isClosing isClosing} method.
1929 *
1930 * @return {boolean} Window is closing
1931 */
1932 OO.ui.Window.prototype.isClosing = function () {
1933 return this.manager.isClosing( this );
1934 };
1935
1936 /**
1937 * Check if the window is opened.
1938 *
1939 * This method is a wrapper around the window manager's {@link OO.ui.WindowManager#isOpened isOpened} method.
1940 *
1941 * @return {boolean} Window is opened
1942 */
1943 OO.ui.Window.prototype.isOpened = function () {
1944 return this.manager.isOpened( this );
1945 };
1946
1947 /**
1948 * Get the window manager.
1949 *
1950 * All windows must be attached to a window manager, which is used to open
1951 * and close the window and control its presentation.
1952 *
1953 * @return {OO.ui.WindowManager} Manager of window
1954 */
1955 OO.ui.Window.prototype.getManager = function () {
1956 return this.manager;
1957 };
1958
1959 /**
1960 * Get the symbolic name of the window size (e.g., `small` or `medium`).
1961 *
1962 * @return {string} Symbolic name of the size: `small`, `medium`, `large`, `larger`, `full`
1963 */
1964 OO.ui.Window.prototype.getSize = function () {
1965 return this.size;
1966 };
1967
1968 /**
1969 * Disable transitions on window's frame for the duration of the callback function, then enable them
1970 * back.
1971 *
1972 * @private
1973 * @param {Function} callback Function to call while transitions are disabled
1974 */
1975 OO.ui.Window.prototype.withoutSizeTransitions = function ( callback ) {
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 var oldTransition,
1979 styleObj = this.$frame[ 0 ].style;
1980 oldTransition = styleObj.transition || styleObj.OTransition || styleObj.MsTransition ||
1981 styleObj.MozTransition || styleObj.WebkitTransition;
1982 styleObj.transition = styleObj.OTransition = styleObj.MsTransition =
1983 styleObj.MozTransition = styleObj.WebkitTransition = 'none';
1984 callback();
1985 // Force reflow to make sure the style changes done inside callback really are not transitioned
1986 this.$frame.height();
1987 styleObj.transition = styleObj.OTransition = styleObj.MsTransition =
1988 styleObj.MozTransition = styleObj.WebkitTransition = oldTransition;
1989 };
1990
1991 /**
1992 * Get the height of the full window contents (i.e., the window head, body and foot together).
1993 *
1994 * What consistitutes the head, body, and foot varies depending on the window type.
1995 * A {@link OO.ui.MessageDialog message dialog} displays a title and message in its body,
1996 * and any actions in the foot. A {@link OO.ui.ProcessDialog process dialog} displays a title
1997 * and special actions in the head, and dialog content in the body.
1998 *
1999 * To get just the height of the dialog body, use the #getBodyHeight method.
2000 *
2001 * @return {number} The height of the window contents (the dialog head, body and foot) in pixels
2002 */
2003 OO.ui.Window.prototype.getContentHeight = function () {
2004 var bodyHeight,
2005 win = this,
2006 bodyStyleObj = this.$body[ 0 ].style,
2007 frameStyleObj = this.$frame[ 0 ].style;
2008
2009 // Temporarily resize the frame so getBodyHeight() can use scrollHeight measurements.
2010 // Disable transitions first, otherwise we'll get values from when the window was animating.
2011 this.withoutSizeTransitions( function () {
2012 var oldHeight = frameStyleObj.height,
2013 oldPosition = bodyStyleObj.position;
2014 frameStyleObj.height = '1px';
2015 // Force body to resize to new width
2016 bodyStyleObj.position = 'relative';
2017 bodyHeight = win.getBodyHeight();
2018 frameStyleObj.height = oldHeight;
2019 bodyStyleObj.position = oldPosition;
2020 } );
2021
2022 return (
2023 // Add buffer for border
2024 ( this.$frame.outerHeight() - this.$frame.innerHeight() ) +
2025 // Use combined heights of children
2026 ( this.$head.outerHeight( true ) + bodyHeight + this.$foot.outerHeight( true ) )
2027 );
2028 };
2029
2030 /**
2031 * Get the height of the window body.
2032 *
2033 * To get the height of the full window contents (the window body, head, and foot together),
2034 * use #getContentHeight.
2035 *
2036 * When this function is called, the window will temporarily have been resized
2037 * to height=1px, so .scrollHeight measurements can be taken accurately.
2038 *
2039 * @return {number} Height of the window body in pixels
2040 */
2041 OO.ui.Window.prototype.getBodyHeight = function () {
2042 return this.$body[ 0 ].scrollHeight;
2043 };
2044
2045 /**
2046 * Get the directionality of the frame (right-to-left or left-to-right).
2047 *
2048 * @return {string} Directionality: `'ltr'` or `'rtl'`
2049 */
2050 OO.ui.Window.prototype.getDir = function () {
2051 return this.dir;
2052 };
2053
2054 /**
2055 * Get the 'setup' process.
2056 *
2057 * The setup process is used to set up a window for use in a particular context,
2058 * based on the `data` argument. This method is called during the opening phase of the window’s
2059 * lifecycle.
2060 *
2061 * Override this method to add additional steps to the ‘setup’ process the parent method provides
2062 * using the {@link OO.ui.Process#first first} and {@link OO.ui.Process#next next} methods
2063 * of OO.ui.Process.
2064 *
2065 * To add window content that persists between openings, you may wish to use the #initialize method
2066 * instead.
2067 *
2068 * @abstract
2069 * @param {Object} [data] Window opening data
2070 * @return {OO.ui.Process} Setup process
2071 */
2072 OO.ui.Window.prototype.getSetupProcess = function () {
2073 return new OO.ui.Process();
2074 };
2075
2076 /**
2077 * Get the ‘ready’ process.
2078 *
2079 * The ready process is used to ready a window for use in a particular
2080 * context, based on the `data` argument. This method is called during the opening phase of
2081 * the window’s lifecycle, after the window has been {@link #getSetupProcess setup}.
2082 *
2083 * Override this method to add additional steps to the ‘ready’ process the parent method
2084 * provides using the {@link OO.ui.Process#first first} and {@link OO.ui.Process#next next}
2085 * methods of OO.ui.Process.
2086 *
2087 * @abstract
2088 * @param {Object} [data] Window opening data
2089 * @return {OO.ui.Process} Ready process
2090 */
2091 OO.ui.Window.prototype.getReadyProcess = function () {
2092 return new OO.ui.Process();
2093 };
2094
2095 /**
2096 * Get the 'hold' process.
2097 *
2098 * The hold proccess is used to keep a window from being used in a particular context,
2099 * based on the `data` argument. This method is called during the closing phase of the window’s
2100 * lifecycle.
2101 *
2102 * Override this method to add additional steps to the 'hold' process the parent method provides
2103 * using the {@link OO.ui.Process#first first} and {@link OO.ui.Process#next next} methods
2104 * of OO.ui.Process.
2105 *
2106 * @abstract
2107 * @param {Object} [data] Window closing data
2108 * @return {OO.ui.Process} Hold process
2109 */
2110 OO.ui.Window.prototype.getHoldProcess = function () {
2111 return new OO.ui.Process();
2112 };
2113
2114 /**
2115 * Get the ‘teardown’ process.
2116 *
2117 * The teardown process is used to teardown a window after use. During teardown,
2118 * user interactions within the window are conveyed and the window is closed, based on the `data`
2119 * argument. This method is called during the closing phase of the window’s lifecycle.
2120 *
2121 * Override this method to add additional steps to the ‘teardown’ process the parent method provides
2122 * using the {@link OO.ui.Process#first first} and {@link OO.ui.Process#next next} methods
2123 * of OO.ui.Process.
2124 *
2125 * @abstract
2126 * @param {Object} [data] Window closing data
2127 * @return {OO.ui.Process} Teardown process
2128 */
2129 OO.ui.Window.prototype.getTeardownProcess = function () {
2130 return new OO.ui.Process();
2131 };
2132
2133 /**
2134 * Set the window manager.
2135 *
2136 * This will cause the window to initialize. Calling it more than once will cause an error.
2137 *
2138 * @param {OO.ui.WindowManager} manager Manager for this window
2139 * @throws {Error} An error is thrown if the method is called more than once
2140 * @chainable
2141 */
2142 OO.ui.Window.prototype.setManager = function ( manager ) {
2143 if ( this.manager ) {
2144 throw new Error( 'Cannot set window manager, window already has a manager' );
2145 }
2146
2147 this.manager = manager;
2148 this.initialize();
2149
2150 return this;
2151 };
2152
2153 /**
2154 * Set the window size by symbolic name (e.g., 'small' or 'medium')
2155 *
2156 * @param {string} size Symbolic name of size: `small`, `medium`, `large`, `larger` or
2157 * `full`
2158 * @chainable
2159 */
2160 OO.ui.Window.prototype.setSize = function ( size ) {
2161 this.size = size;
2162 this.updateSize();
2163 return this;
2164 };
2165
2166 /**
2167 * Update the window size.
2168 *
2169 * @throws {Error} An error is thrown if the window is not attached to a window manager
2170 * @chainable
2171 */
2172 OO.ui.Window.prototype.updateSize = function () {
2173 if ( !this.manager ) {
2174 throw new Error( 'Cannot update window size, must be attached to a manager' );
2175 }
2176
2177 this.manager.updateWindowSize( this );
2178
2179 return this;
2180 };
2181
2182 /**
2183 * Set window dimensions. This method is called by the {@link OO.ui.WindowManager window manager}
2184 * when the window is opening. In general, setDimensions should not be called directly.
2185 *
2186 * To set the size of the window, use the #setSize method.
2187 *
2188 * @param {Object} dim CSS dimension properties
2189 * @param {string|number} [dim.width] Width
2190 * @param {string|number} [dim.minWidth] Minimum width
2191 * @param {string|number} [dim.maxWidth] Maximum width
2192 * @param {string|number} [dim.width] Height, omit to set based on height of contents
2193 * @param {string|number} [dim.minWidth] Minimum height
2194 * @param {string|number} [dim.maxWidth] Maximum height
2195 * @chainable
2196 */
2197 OO.ui.Window.prototype.setDimensions = function ( dim ) {
2198 var height,
2199 win = this,
2200 styleObj = this.$frame[ 0 ].style;
2201
2202 // Calculate the height we need to set using the correct width
2203 if ( dim.height === undefined ) {
2204 this.withoutSizeTransitions( function () {
2205 var oldWidth = styleObj.width;
2206 win.$frame.css( 'width', dim.width || '' );
2207 height = win.getContentHeight();
2208 styleObj.width = oldWidth;
2209 } );
2210 } else {
2211 height = dim.height;
2212 }
2213
2214 this.$frame.css( {
2215 width: dim.width || '',
2216 minWidth: dim.minWidth || '',
2217 maxWidth: dim.maxWidth || '',
2218 height: height || '',
2219 minHeight: dim.minHeight || '',
2220 maxHeight: dim.maxHeight || ''
2221 } );
2222
2223 return this;
2224 };
2225
2226 /**
2227 * Initialize window contents.
2228 *
2229 * Before the window is opened for the first time, #initialize is called so that content that
2230 * persists between openings can be added to the window.
2231 *
2232 * To set up a window with new content each time the window opens, use #getSetupProcess.
2233 *
2234 * @throws {Error} An error is thrown if the window is not attached to a window manager
2235 * @chainable
2236 */
2237 OO.ui.Window.prototype.initialize = function () {
2238 if ( !this.manager ) {
2239 throw new Error( 'Cannot initialize window, must be attached to a manager' );
2240 }
2241
2242 // Properties
2243 this.$head = $( '<div>' );
2244 this.$body = $( '<div>' );
2245 this.$foot = $( '<div>' );
2246 this.dir = OO.ui.Element.static.getDir( this.$content ) || 'ltr';
2247 this.$document = $( this.getElementDocument() );
2248
2249 // Events
2250 this.$element.on( 'mousedown', this.onMouseDown.bind( this ) );
2251
2252 // Initialization
2253 this.$head.addClass( 'oo-ui-window-head' );
2254 this.$body.addClass( 'oo-ui-window-body' );
2255 this.$foot.addClass( 'oo-ui-window-foot' );
2256 this.$content.append( this.$head, this.$body, this.$foot );
2257
2258 return this;
2259 };
2260
2261 /**
2262 * Open the window.
2263 *
2264 * This method is a wrapper around a call to the window manager’s {@link OO.ui.WindowManager#openWindow openWindow}
2265 * method, which returns a promise resolved when the window is done opening.
2266 *
2267 * To customize the window each time it opens, use #getSetupProcess or #getReadyProcess.
2268 *
2269 * @param {Object} [data] Window opening data
2270 * @return {jQuery.Promise} Promise resolved with a value when the window is opened, or rejected
2271 * if the window fails to open. When the promise is resolved successfully, the first argument of the
2272 * value is a new promise, which is resolved when the window begins closing.
2273 * @throws {Error} An error is thrown if the window is not attached to a window manager
2274 */
2275 OO.ui.Window.prototype.open = function ( data ) {
2276 if ( !this.manager ) {
2277 throw new Error( 'Cannot open window, must be attached to a manager' );
2278 }
2279
2280 return this.manager.openWindow( this, data );
2281 };
2282
2283 /**
2284 * Close the window.
2285 *
2286 * This method is a wrapper around a call to the window
2287 * manager’s {@link OO.ui.WindowManager#closeWindow closeWindow} method,
2288 * which returns a closing promise resolved when the window is done closing.
2289 *
2290 * The window's #getHoldProcess and #getTeardownProcess methods are called during the closing
2291 * phase of the window’s lifecycle and can be used to specify closing behavior each time
2292 * the window closes.
2293 *
2294 * @param {Object} [data] Window closing data
2295 * @return {jQuery.Promise} Promise resolved when window is closed
2296 * @throws {Error} An error is thrown if the window is not attached to a window manager
2297 */
2298 OO.ui.Window.prototype.close = function ( data ) {
2299 if ( !this.manager ) {
2300 throw new Error( 'Cannot close window, must be attached to a manager' );
2301 }
2302
2303 return this.manager.closeWindow( this, data );
2304 };
2305
2306 /**
2307 * Setup window.
2308 *
2309 * This is called by OO.ui.WindowManager during window opening, and should not be called directly
2310 * by other systems.
2311 *
2312 * @param {Object} [data] Window opening data
2313 * @return {jQuery.Promise} Promise resolved when window is setup
2314 */
2315 OO.ui.Window.prototype.setup = function ( data ) {
2316 var win = this,
2317 deferred = $.Deferred();
2318
2319 this.toggle( true );
2320
2321 this.getSetupProcess( data ).execute().done( function () {
2322 // Force redraw by asking the browser to measure the elements' widths
2323 win.$element.addClass( 'oo-ui-window-active oo-ui-window-setup' ).width();
2324 win.$content.addClass( 'oo-ui-window-content-setup' ).width();
2325 deferred.resolve();
2326 } );
2327
2328 return deferred.promise();
2329 };
2330
2331 /**
2332 * Ready window.
2333 *
2334 * This is called by OO.ui.WindowManager during window opening, and should not be called directly
2335 * by other systems.
2336 *
2337 * @param {Object} [data] Window opening data
2338 * @return {jQuery.Promise} Promise resolved when window is ready
2339 */
2340 OO.ui.Window.prototype.ready = function ( data ) {
2341 var win = this,
2342 deferred = $.Deferred();
2343
2344 this.$content.focus();
2345 this.getReadyProcess( data ).execute().done( function () {
2346 // Force redraw by asking the browser to measure the elements' widths
2347 win.$element.addClass( 'oo-ui-window-ready' ).width();
2348 win.$content.addClass( 'oo-ui-window-content-ready' ).width();
2349 deferred.resolve();
2350 } );
2351
2352 return deferred.promise();
2353 };
2354
2355 /**
2356 * Hold window.
2357 *
2358 * This is called by OO.ui.WindowManager during window closing, and should not be called directly
2359 * by other systems.
2360 *
2361 * @param {Object} [data] Window closing data
2362 * @return {jQuery.Promise} Promise resolved when window is held
2363 */
2364 OO.ui.Window.prototype.hold = function ( data ) {
2365 var win = this,
2366 deferred = $.Deferred();
2367
2368 this.getHoldProcess( data ).execute().done( function () {
2369 // Get the focused element within the window's content
2370 var $focus = win.$content.find( OO.ui.Element.static.getDocument( win.$content ).activeElement );
2371
2372 // Blur the focused element
2373 if ( $focus.length ) {
2374 $focus[ 0 ].blur();
2375 }
2376
2377 // Force redraw by asking the browser to measure the elements' widths
2378 win.$element.removeClass( 'oo-ui-window-ready' ).width();
2379 win.$content.removeClass( 'oo-ui-window-content-ready' ).width();
2380 deferred.resolve();
2381 } );
2382
2383 return deferred.promise();
2384 };
2385
2386 /**
2387 * Teardown window.
2388 *
2389 * This is called by OO.ui.WindowManager during window closing, and should not be called directly
2390 * by other systems.
2391 *
2392 * @param {Object} [data] Window closing data
2393 * @return {jQuery.Promise} Promise resolved when window is torn down
2394 */
2395 OO.ui.Window.prototype.teardown = function ( data ) {
2396 var win = this;
2397
2398 return this.getTeardownProcess( data ).execute()
2399 .done( function () {
2400 // Force redraw by asking the browser to measure the elements' widths
2401 win.$element.removeClass( 'oo-ui-window-active oo-ui-window-setup' ).width();
2402 win.$content.removeClass( 'oo-ui-window-content-setup' ).width();
2403 win.toggle( false );
2404 } );
2405 };
2406
2407 /**
2408 * The Dialog class serves as the base class for the other types of dialogs.
2409 * Unless extended to include controls, the rendered dialog box is a simple window
2410 * that users can close by hitting the ‘Esc’ key. Dialog windows are used with OO.ui.WindowManager,
2411 * which opens, closes, and controls the presentation of the window. See the
2412 * [OOjs UI documentation on MediaWiki] [1] for more information.
2413 *
2414 * @example
2415 * // A simple dialog window.
2416 * function MyDialog( config ) {
2417 * MyDialog.super.call( this, config );
2418 * }
2419 * OO.inheritClass( MyDialog, OO.ui.Dialog );
2420 * MyDialog.prototype.initialize = function () {
2421 * MyDialog.super.prototype.initialize.call( this );
2422 * this.content = new OO.ui.PanelLayout( { padded: true, expanded: false } );
2423 * this.content.$element.append( '<p>A simple dialog window. Press \'Esc\' to close.</p>' );
2424 * this.$body.append( this.content.$element );
2425 * };
2426 * MyDialog.prototype.getBodyHeight = function () {
2427 * return this.content.$element.outerHeight( true );
2428 * };
2429 * var myDialog = new MyDialog( {
2430 * size: 'medium'
2431 * } );
2432 * // Create and append a window manager, which opens and closes the window.
2433 * var windowManager = new OO.ui.WindowManager();
2434 * $( 'body' ).append( windowManager.$element );
2435 * windowManager.addWindows( [ myDialog ] );
2436 * // Open the window!
2437 * windowManager.openWindow( myDialog );
2438 *
2439 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Windows/Dialogs
2440 *
2441 * @abstract
2442 * @class
2443 * @extends OO.ui.Window
2444 * @mixins OO.ui.PendingElement
2445 *
2446 * @constructor
2447 * @param {Object} [config] Configuration options
2448 */
2449 OO.ui.Dialog = function OoUiDialog( config ) {
2450 // Parent constructor
2451 OO.ui.Dialog.super.call( this, config );
2452
2453 // Mixin constructors
2454 OO.ui.PendingElement.call( this );
2455
2456 // Properties
2457 this.actions = new OO.ui.ActionSet();
2458 this.attachedActions = [];
2459 this.currentAction = null;
2460 this.onDocumentKeyDownHandler = this.onDocumentKeyDown.bind( this );
2461
2462 // Events
2463 this.actions.connect( this, {
2464 click: 'onActionClick',
2465 resize: 'onActionResize',
2466 change: 'onActionsChange'
2467 } );
2468
2469 // Initialization
2470 this.$element
2471 .addClass( 'oo-ui-dialog' )
2472 .attr( 'role', 'dialog' );
2473 };
2474
2475 /* Setup */
2476
2477 OO.inheritClass( OO.ui.Dialog, OO.ui.Window );
2478 OO.mixinClass( OO.ui.Dialog, OO.ui.PendingElement );
2479
2480 /* Static Properties */
2481
2482 /**
2483 * Symbolic name of dialog.
2484 *
2485 * The dialog class must have a symbolic name in order to be registered with OO.Factory.
2486 * Please see the [OOjs UI documentation on MediaWiki] [3] for more information.
2487 *
2488 * [3]: https://www.mediawiki.org/wiki/OOjs_UI/Windows/Window_managers
2489 *
2490 * @abstract
2491 * @static
2492 * @inheritable
2493 * @property {string}
2494 */
2495 OO.ui.Dialog.static.name = '';
2496
2497 /**
2498 * The dialog title.
2499 *
2500 * The title can be specified as a plaintext string, a {@link OO.ui.LabelElement Label} node, or a function
2501 * that will produce a Label node or string. The title can also be specified with data passed to the
2502 * constructor (see #getSetupProcess). In this case, the static value will be overriden.
2503 *
2504 * @abstract
2505 * @static
2506 * @inheritable
2507 * @property {jQuery|string|Function}
2508 */
2509 OO.ui.Dialog.static.title = '';
2510
2511 /**
2512 * An array of configured {@link OO.ui.ActionWidget action widgets}.
2513 *
2514 * Actions can also be specified with data passed to the constructor (see #getSetupProcess). In this case, the static
2515 * value will be overriden.
2516 *
2517 * [2]: https://www.mediawiki.org/wiki/OOjs_UI/Windows/Process_Dialogs#Action_sets
2518 *
2519 * @static
2520 * @inheritable
2521 * @property {Object[]}
2522 */
2523 OO.ui.Dialog.static.actions = [];
2524
2525 /**
2526 * Close the dialog when the 'Esc' key is pressed.
2527 *
2528 * @static
2529 * @abstract
2530 * @inheritable
2531 * @property {boolean}
2532 */
2533 OO.ui.Dialog.static.escapable = true;
2534
2535 /* Methods */
2536
2537 /**
2538 * Handle frame document key down events.
2539 *
2540 * @private
2541 * @param {jQuery.Event} e Key down event
2542 */
2543 OO.ui.Dialog.prototype.onDocumentKeyDown = function ( e ) {
2544 if ( e.which === OO.ui.Keys.ESCAPE ) {
2545 this.close();
2546 e.preventDefault();
2547 e.stopPropagation();
2548 }
2549 };
2550
2551 /**
2552 * Handle action resized events.
2553 *
2554 * @private
2555 * @param {OO.ui.ActionWidget} action Action that was resized
2556 */
2557 OO.ui.Dialog.prototype.onActionResize = function () {
2558 // Override in subclass
2559 };
2560
2561 /**
2562 * Handle action click events.
2563 *
2564 * @private
2565 * @param {OO.ui.ActionWidget} action Action that was clicked
2566 */
2567 OO.ui.Dialog.prototype.onActionClick = function ( action ) {
2568 if ( !this.isPending() ) {
2569 this.executeAction( action.getAction() );
2570 }
2571 };
2572
2573 /**
2574 * Handle actions change event.
2575 *
2576 * @private
2577 */
2578 OO.ui.Dialog.prototype.onActionsChange = function () {
2579 this.detachActions();
2580 if ( !this.isClosing() ) {
2581 this.attachActions();
2582 }
2583 };
2584
2585 /**
2586 * Get the set of actions used by the dialog.
2587 *
2588 * @return {OO.ui.ActionSet}
2589 */
2590 OO.ui.Dialog.prototype.getActions = function () {
2591 return this.actions;
2592 };
2593
2594 /**
2595 * Get a process for taking action.
2596 *
2597 * When you override this method, you can create a new OO.ui.Process and return it, or add additional
2598 * accept steps to the process the parent method provides using the {@link OO.ui.Process#first 'first'}
2599 * and {@link OO.ui.Process#next 'next'} methods of OO.ui.Process.
2600 *
2601 * @abstract
2602 * @param {string} [action] Symbolic name of action
2603 * @return {OO.ui.Process} Action process
2604 */
2605 OO.ui.Dialog.prototype.getActionProcess = function ( action ) {
2606 return new OO.ui.Process()
2607 .next( function () {
2608 if ( !action ) {
2609 // An empty action always closes the dialog without data, which should always be
2610 // safe and make no changes
2611 this.close();
2612 }
2613 }, this );
2614 };
2615
2616 /**
2617 * @inheritdoc
2618 *
2619 * @param {Object} [data] Dialog opening data
2620 * @param {jQuery|string|Function|null} [data.title] Dialog title, omit to use
2621 * the {@link #static-title static title}
2622 * @param {Object[]} [data.actions] List of configuration options for each
2623 * {@link OO.ui.ActionWidget action widget}, omit to use {@link #static-actions static actions}.
2624 */
2625 OO.ui.Dialog.prototype.getSetupProcess = function ( data ) {
2626 data = data || {};
2627
2628 // Parent method
2629 return OO.ui.Dialog.super.prototype.getSetupProcess.call( this, data )
2630 .next( function () {
2631 var config = this.constructor.static,
2632 actions = data.actions !== undefined ? data.actions : config.actions;
2633
2634 this.title.setLabel(
2635 data.title !== undefined ? data.title : this.constructor.static.title
2636 );
2637 this.actions.add( this.getActionWidgets( actions ) );
2638
2639 if ( this.constructor.static.escapable ) {
2640 this.$document.on( 'keydown', this.onDocumentKeyDownHandler );
2641 }
2642 }, this );
2643 };
2644
2645 /**
2646 * @inheritdoc
2647 */
2648 OO.ui.Dialog.prototype.getTeardownProcess = function ( data ) {
2649 // Parent method
2650 return OO.ui.Dialog.super.prototype.getTeardownProcess.call( this, data )
2651 .first( function () {
2652 if ( this.constructor.static.escapable ) {
2653 this.$document.off( 'keydown', this.onDocumentKeyDownHandler );
2654 }
2655
2656 this.actions.clear();
2657 this.currentAction = null;
2658 }, this );
2659 };
2660
2661 /**
2662 * @inheritdoc
2663 */
2664 OO.ui.Dialog.prototype.initialize = function () {
2665 // Parent method
2666 OO.ui.Dialog.super.prototype.initialize.call( this );
2667
2668 // Properties
2669 this.title = new OO.ui.LabelWidget();
2670
2671 // Initialization
2672 this.$content.addClass( 'oo-ui-dialog-content' );
2673 this.setPendingElement( this.$head );
2674 };
2675
2676 /**
2677 * Get action widgets from a list of configs
2678 *
2679 * @param {Object[]} actions Action widget configs
2680 * @return {OO.ui.ActionWidget[]} Action widgets
2681 */
2682 OO.ui.Dialog.prototype.getActionWidgets = function ( actions ) {
2683 var i, len, widgets = [];
2684 for ( i = 0, len = actions.length; i < len; i++ ) {
2685 widgets.push(
2686 new OO.ui.ActionWidget( actions[ i ] )
2687 );
2688 }
2689 return widgets;
2690 };
2691
2692 /**
2693 * Attach action actions.
2694 *
2695 * @protected
2696 */
2697 OO.ui.Dialog.prototype.attachActions = function () {
2698 // Remember the list of potentially attached actions
2699 this.attachedActions = this.actions.get();
2700 };
2701
2702 /**
2703 * Detach action actions.
2704 *
2705 * @protected
2706 * @chainable
2707 */
2708 OO.ui.Dialog.prototype.detachActions = function () {
2709 var i, len;
2710
2711 // Detach all actions that may have been previously attached
2712 for ( i = 0, len = this.attachedActions.length; i < len; i++ ) {
2713 this.attachedActions[ i ].$element.detach();
2714 }
2715 this.attachedActions = [];
2716 };
2717
2718 /**
2719 * Execute an action.
2720 *
2721 * @param {string} action Symbolic name of action to execute
2722 * @return {jQuery.Promise} Promise resolved when action completes, rejected if it fails
2723 */
2724 OO.ui.Dialog.prototype.executeAction = function ( action ) {
2725 this.pushPending();
2726 this.currentAction = action;
2727 return this.getActionProcess( action ).execute()
2728 .always( this.popPending.bind( this ) );
2729 };
2730
2731 /**
2732 * Window managers are used to open and close {@link OO.ui.Window windows} and control their presentation.
2733 * Managed windows are mutually exclusive. If a new window is opened while a current window is opening
2734 * or is opened, the current window will be closed and any ongoing {@link OO.ui.Process process} will be cancelled. Windows
2735 * themselves are persistent and—rather than being torn down when closed—can be repopulated with the
2736 * pertinent data and reused.
2737 *
2738 * Over the lifecycle of a window, the window manager makes available three promises: `opening`,
2739 * `opened`, and `closing`, which represent the primary stages of the cycle:
2740 *
2741 * **Opening**: the opening stage begins when the window manager’s #openWindow or a window’s
2742 * {@link OO.ui.Window#open open} method is used, and the window manager begins to open the window.
2743 *
2744 * - an `opening` event is emitted with an `opening` promise
2745 * - the #getSetupDelay method is called and the returned value is used to time a pause in execution before
2746 * the window’s {@link OO.ui.Window#getSetupProcess getSetupProcess} method is called on the
2747 * window and its result executed
2748 * - a `setup` progress notification is emitted from the `opening` promise
2749 * - the #getReadyDelay method is called the returned value is used to time a pause in execution before
2750 * the window’s {@link OO.ui.Window#getReadyProcess getReadyProcess} method is called on the
2751 * window and its result executed
2752 * - a `ready` progress notification is emitted from the `opening` promise
2753 * - the `opening` promise is resolved with an `opened` promise
2754 *
2755 * **Opened**: the window is now open.
2756 *
2757 * **Closing**: the closing stage begins when the window manager's #closeWindow or the
2758 * window's {@link OO.ui.Window#close close} methods is used, and the window manager begins
2759 * to close the window.
2760 *
2761 * - the `opened` promise is resolved with `closing` promise and a `closing` event is emitted
2762 * - the #getHoldDelay method is called and the returned value is used to time a pause in execution before
2763 * the window's {@link OO.ui.Window#getHoldProcess getHoldProces} method is called on the
2764 * window and its result executed
2765 * - a `hold` progress notification is emitted from the `closing` promise
2766 * - the #getTeardownDelay() method is called and the returned value is used to time a pause in execution before
2767 * the window's {@link OO.ui.Window#getTeardownProcess getTeardownProcess} method is called on the
2768 * window and its result executed
2769 * - a `teardown` progress notification is emitted from the `closing` promise
2770 * - the `closing` promise is resolved. The window is now closed
2771 *
2772 * See the [OOjs UI documentation on MediaWiki][1] for more information.
2773 *
2774 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Windows/Window_managers
2775 *
2776 * @class
2777 * @extends OO.ui.Element
2778 * @mixins OO.EventEmitter
2779 *
2780 * @constructor
2781 * @param {Object} [config] Configuration options
2782 * @cfg {OO.Factory} [factory] Window factory to use for automatic instantiation
2783 * Note that window classes that are instantiated with a factory must have
2784 * a {@link OO.ui.Dialog#static-name static name} property that specifies a symbolic name.
2785 * @cfg {boolean} [modal=true] Prevent interaction outside the dialog
2786 */
2787 OO.ui.WindowManager = function OoUiWindowManager( config ) {
2788 // Configuration initialization
2789 config = config || {};
2790
2791 // Parent constructor
2792 OO.ui.WindowManager.super.call( this, config );
2793
2794 // Mixin constructors
2795 OO.EventEmitter.call( this );
2796
2797 // Properties
2798 this.factory = config.factory;
2799 this.modal = config.modal === undefined || !!config.modal;
2800 this.windows = {};
2801 this.opening = null;
2802 this.opened = null;
2803 this.closing = null;
2804 this.preparingToOpen = null;
2805 this.preparingToClose = null;
2806 this.currentWindow = null;
2807 this.globalEvents = false;
2808 this.$ariaHidden = null;
2809 this.onWindowResizeTimeout = null;
2810 this.onWindowResizeHandler = this.onWindowResize.bind( this );
2811 this.afterWindowResizeHandler = this.afterWindowResize.bind( this );
2812
2813 // Initialization
2814 this.$element
2815 .addClass( 'oo-ui-windowManager' )
2816 .toggleClass( 'oo-ui-windowManager-modal', this.modal );
2817 };
2818
2819 /* Setup */
2820
2821 OO.inheritClass( OO.ui.WindowManager, OO.ui.Element );
2822 OO.mixinClass( OO.ui.WindowManager, OO.EventEmitter );
2823
2824 /* Events */
2825
2826 /**
2827 * An 'opening' event is emitted when the window begins to be opened.
2828 *
2829 * @event opening
2830 * @param {OO.ui.Window} win Window that's being opened
2831 * @param {jQuery.Promise} opening An `opening` promise resolved with a value when the window is opened successfully.
2832 * When the `opening` promise is resolved, the first argument of the value is an 'opened' promise, the second argument
2833 * is the opening data. The `opening` promise emits `setup` and `ready` notifications when those processes are complete.
2834 * @param {Object} data Window opening data
2835 */
2836
2837 /**
2838 * A 'closing' event is emitted when the window begins to be closed.
2839 *
2840 * @event closing
2841 * @param {OO.ui.Window} win Window that's being closed
2842 * @param {jQuery.Promise} closing A `closing` promise is resolved with a value when the window
2843 * is closed successfully. The promise emits `hold` and `teardown` notifications when those
2844 * processes are complete. When the `closing` promise is resolved, the first argument of its value
2845 * is the closing data.
2846 * @param {Object} data Window closing data
2847 */
2848
2849 /**
2850 * A 'resize' event is emitted when a window is resized.
2851 *
2852 * @event resize
2853 * @param {OO.ui.Window} win Window that was resized
2854 */
2855
2856 /* Static Properties */
2857
2858 /**
2859 * Map of the symbolic name of each window size and its CSS properties.
2860 *
2861 * @static
2862 * @inheritable
2863 * @property {Object}
2864 */
2865 OO.ui.WindowManager.static.sizes = {
2866 small: {
2867 width: 300
2868 },
2869 medium: {
2870 width: 500
2871 },
2872 large: {
2873 width: 700
2874 },
2875 larger: {
2876 width: 900
2877 },
2878 full: {
2879 // These can be non-numeric because they are never used in calculations
2880 width: '100%',
2881 height: '100%'
2882 }
2883 };
2884
2885 /**
2886 * Symbolic name of the default window size.
2887 *
2888 * The default size is used if the window's requested size is not recognized.
2889 *
2890 * @static
2891 * @inheritable
2892 * @property {string}
2893 */
2894 OO.ui.WindowManager.static.defaultSize = 'medium';
2895
2896 /* Methods */
2897
2898 /**
2899 * Handle window resize events.
2900 *
2901 * @private
2902 * @param {jQuery.Event} e Window resize event
2903 */
2904 OO.ui.WindowManager.prototype.onWindowResize = function () {
2905 clearTimeout( this.onWindowResizeTimeout );
2906 this.onWindowResizeTimeout = setTimeout( this.afterWindowResizeHandler, 200 );
2907 };
2908
2909 /**
2910 * Handle window resize events.
2911 *
2912 * @private
2913 * @param {jQuery.Event} e Window resize event
2914 */
2915 OO.ui.WindowManager.prototype.afterWindowResize = function () {
2916 if ( this.currentWindow ) {
2917 this.updateWindowSize( this.currentWindow );
2918 }
2919 };
2920
2921 /**
2922 * Check if window is opening.
2923 *
2924 * @return {boolean} Window is opening
2925 */
2926 OO.ui.WindowManager.prototype.isOpening = function ( win ) {
2927 return win === this.currentWindow && !!this.opening && this.opening.state() === 'pending';
2928 };
2929
2930 /**
2931 * Check if window is closing.
2932 *
2933 * @return {boolean} Window is closing
2934 */
2935 OO.ui.WindowManager.prototype.isClosing = function ( win ) {
2936 return win === this.currentWindow && !!this.closing && this.closing.state() === 'pending';
2937 };
2938
2939 /**
2940 * Check if window is opened.
2941 *
2942 * @return {boolean} Window is opened
2943 */
2944 OO.ui.WindowManager.prototype.isOpened = function ( win ) {
2945 return win === this.currentWindow && !!this.opened && this.opened.state() === 'pending';
2946 };
2947
2948 /**
2949 * Check if a window is being managed.
2950 *
2951 * @param {OO.ui.Window} win Window to check
2952 * @return {boolean} Window is being managed
2953 */
2954 OO.ui.WindowManager.prototype.hasWindow = function ( win ) {
2955 var name;
2956
2957 for ( name in this.windows ) {
2958 if ( this.windows[ name ] === win ) {
2959 return true;
2960 }
2961 }
2962
2963 return false;
2964 };
2965
2966 /**
2967 * Get the number of milliseconds to wait after opening begins before executing the ‘setup’ process.
2968 *
2969 * @param {OO.ui.Window} win Window being opened
2970 * @param {Object} [data] Window opening data
2971 * @return {number} Milliseconds to wait
2972 */
2973 OO.ui.WindowManager.prototype.getSetupDelay = function () {
2974 return 0;
2975 };
2976
2977 /**
2978 * Get the number of milliseconds to wait after setup has finished before executing the ‘ready’ process.
2979 *
2980 * @param {OO.ui.Window} win Window being opened
2981 * @param {Object} [data] Window opening data
2982 * @return {number} Milliseconds to wait
2983 */
2984 OO.ui.WindowManager.prototype.getReadyDelay = function () {
2985 return 0;
2986 };
2987
2988 /**
2989 * Get the number of milliseconds to wait after closing has begun before executing the 'hold' process.
2990 *
2991 * @param {OO.ui.Window} win Window being closed
2992 * @param {Object} [data] Window closing data
2993 * @return {number} Milliseconds to wait
2994 */
2995 OO.ui.WindowManager.prototype.getHoldDelay = function () {
2996 return 0;
2997 };
2998
2999 /**
3000 * Get the number of milliseconds to wait after the ‘hold’ process has finished before
3001 * executing the ‘teardown’ process.
3002 *
3003 * @param {OO.ui.Window} win Window being closed
3004 * @param {Object} [data] Window closing data
3005 * @return {number} Milliseconds to wait
3006 */
3007 OO.ui.WindowManager.prototype.getTeardownDelay = function () {
3008 return this.modal ? 250 : 0;
3009 };
3010
3011 /**
3012 * Get a window by its symbolic name.
3013 *
3014 * If the window is not yet instantiated and its symbolic name is recognized by a factory, it will be
3015 * instantiated and added to the window manager automatically. Please see the [OOjs UI documentation on MediaWiki][3]
3016 * for more information about using factories.
3017 * [3]: https://www.mediawiki.org/wiki/OOjs_UI/Windows/Window_managers
3018 *
3019 * @param {string} name Symbolic name of the window
3020 * @return {jQuery.Promise} Promise resolved with matching window, or rejected with an OO.ui.Error
3021 * @throws {Error} An error is thrown if the symbolic name is not recognized by the factory.
3022 * @throws {Error} An error is thrown if the named window is not recognized as a managed window.
3023 */
3024 OO.ui.WindowManager.prototype.getWindow = function ( name ) {
3025 var deferred = $.Deferred(),
3026 win = this.windows[ name ];
3027
3028 if ( !( win instanceof OO.ui.Window ) ) {
3029 if ( this.factory ) {
3030 if ( !this.factory.lookup( name ) ) {
3031 deferred.reject( new OO.ui.Error(
3032 'Cannot auto-instantiate window: symbolic name is unrecognized by the factory'
3033 ) );
3034 } else {
3035 win = this.factory.create( name );
3036 this.addWindows( [ win ] );
3037 deferred.resolve( win );
3038 }
3039 } else {
3040 deferred.reject( new OO.ui.Error(
3041 'Cannot get unmanaged window: symbolic name unrecognized as a managed window'
3042 ) );
3043 }
3044 } else {
3045 deferred.resolve( win );
3046 }
3047
3048 return deferred.promise();
3049 };
3050
3051 /**
3052 * Get current window.
3053 *
3054 * @return {OO.ui.Window|null} Currently opening/opened/closing window
3055 */
3056 OO.ui.WindowManager.prototype.getCurrentWindow = function () {
3057 return this.currentWindow;
3058 };
3059
3060 /**
3061 * Open a window.
3062 *
3063 * @param {OO.ui.Window|string} win Window object or symbolic name of window to open
3064 * @param {Object} [data] Window opening data
3065 * @return {jQuery.Promise} An `opening` promise resolved when the window is done opening.
3066 * See {@link #event-opening 'opening' event} for more information about `opening` promises.
3067 * @fires opening
3068 */
3069 OO.ui.WindowManager.prototype.openWindow = function ( win, data ) {
3070 var manager = this,
3071 opening = $.Deferred();
3072
3073 // Argument handling
3074 if ( typeof win === 'string' ) {
3075 return this.getWindow( win ).then( function ( win ) {
3076 return manager.openWindow( win, data );
3077 } );
3078 }
3079
3080 // Error handling
3081 if ( !this.hasWindow( win ) ) {
3082 opening.reject( new OO.ui.Error(
3083 'Cannot open window: window is not attached to manager'
3084 ) );
3085 } else if ( this.preparingToOpen || this.opening || this.opened ) {
3086 opening.reject( new OO.ui.Error(
3087 'Cannot open window: another window is opening or open'
3088 ) );
3089 }
3090
3091 // Window opening
3092 if ( opening.state() !== 'rejected' ) {
3093 // If a window is currently closing, wait for it to complete
3094 this.preparingToOpen = $.when( this.closing );
3095 // Ensure handlers get called after preparingToOpen is set
3096 this.preparingToOpen.done( function () {
3097 if ( manager.modal ) {
3098 manager.toggleGlobalEvents( true );
3099 manager.toggleAriaIsolation( true );
3100 }
3101 manager.currentWindow = win;
3102 manager.opening = opening;
3103 manager.preparingToOpen = null;
3104 manager.emit( 'opening', win, opening, data );
3105 setTimeout( function () {
3106 win.setup( data ).then( function () {
3107 manager.updateWindowSize( win );
3108 manager.opening.notify( { state: 'setup' } );
3109 setTimeout( function () {
3110 win.ready( data ).then( function () {
3111 manager.opening.notify( { state: 'ready' } );
3112 manager.opening = null;
3113 manager.opened = $.Deferred();
3114 opening.resolve( manager.opened.promise(), data );
3115 } );
3116 }, manager.getReadyDelay() );
3117 } );
3118 }, manager.getSetupDelay() );
3119 } );
3120 }
3121
3122 return opening.promise();
3123 };
3124
3125 /**
3126 * Close a window.
3127 *
3128 * @param {OO.ui.Window|string} win Window object or symbolic name of window to close
3129 * @param {Object} [data] Window closing data
3130 * @return {jQuery.Promise} A `closing` promise resolved when the window is done closing.
3131 * See {@link #event-closing 'closing' event} for more information about closing promises.
3132 * @throws {Error} An error is thrown if the window is not managed by the window manager.
3133 * @fires closing
3134 */
3135 OO.ui.WindowManager.prototype.closeWindow = function ( win, data ) {
3136 var manager = this,
3137 closing = $.Deferred(),
3138 opened;
3139
3140 // Argument handling
3141 if ( typeof win === 'string' ) {
3142 win = this.windows[ win ];
3143 } else if ( !this.hasWindow( win ) ) {
3144 win = null;
3145 }
3146
3147 // Error handling
3148 if ( !win ) {
3149 closing.reject( new OO.ui.Error(
3150 'Cannot close window: window is not attached to manager'
3151 ) );
3152 } else if ( win !== this.currentWindow ) {
3153 closing.reject( new OO.ui.Error(
3154 'Cannot close window: window already closed with different data'
3155 ) );
3156 } else if ( this.preparingToClose || this.closing ) {
3157 closing.reject( new OO.ui.Error(
3158 'Cannot close window: window already closing with different data'
3159 ) );
3160 }
3161
3162 // Window closing
3163 if ( closing.state() !== 'rejected' ) {
3164 // If the window is currently opening, close it when it's done
3165 this.preparingToClose = $.when( this.opening );
3166 // Ensure handlers get called after preparingToClose is set
3167 this.preparingToClose.done( function () {
3168 manager.closing = closing;
3169 manager.preparingToClose = null;
3170 manager.emit( 'closing', win, closing, data );
3171 opened = manager.opened;
3172 manager.opened = null;
3173 opened.resolve( closing.promise(), data );
3174 setTimeout( function () {
3175 win.hold( data ).then( function () {
3176 closing.notify( { state: 'hold' } );
3177 setTimeout( function () {
3178 win.teardown( data ).then( function () {
3179 closing.notify( { state: 'teardown' } );
3180 if ( manager.modal ) {
3181 manager.toggleGlobalEvents( false );
3182 manager.toggleAriaIsolation( false );
3183 }
3184 manager.closing = null;
3185 manager.currentWindow = null;
3186 closing.resolve( data );
3187 } );
3188 }, manager.getTeardownDelay() );
3189 } );
3190 }, manager.getHoldDelay() );
3191 } );
3192 }
3193
3194 return closing.promise();
3195 };
3196
3197 /**
3198 * Add windows to the window manager.
3199 *
3200 * Windows can be added by reference, symbolic name, or explicitly defined symbolic names.
3201 * See the [OOjs ui documentation on MediaWiki] [2] for examples.
3202 * [2]: https://www.mediawiki.org/wiki/OOjs_UI/Windows/Window_managers
3203 *
3204 * @param {Object.<string,OO.ui.Window>|OO.ui.Window[]} windows An array of window objects specified
3205 * by reference, symbolic name, or explicitly defined symbolic names.
3206 * @throws {Error} An error is thrown if a window is added by symbolic name, but has neither an
3207 * explicit nor a statically configured symbolic name.
3208 */
3209 OO.ui.WindowManager.prototype.addWindows = function ( windows ) {
3210 var i, len, win, name, list;
3211
3212 if ( Array.isArray( windows ) ) {
3213 // Convert to map of windows by looking up symbolic names from static configuration
3214 list = {};
3215 for ( i = 0, len = windows.length; i < len; i++ ) {
3216 name = windows[ i ].constructor.static.name;
3217 if ( typeof name !== 'string' ) {
3218 throw new Error( 'Cannot add window' );
3219 }
3220 list[ name ] = windows[ i ];
3221 }
3222 } else if ( OO.isPlainObject( windows ) ) {
3223 list = windows;
3224 }
3225
3226 // Add windows
3227 for ( name in list ) {
3228 win = list[ name ];
3229 this.windows[ name ] = win.toggle( false );
3230 this.$element.append( win.$element );
3231 win.setManager( this );
3232 }
3233 };
3234
3235 /**
3236 * Remove the specified windows from the windows manager.
3237 *
3238 * Windows will be closed before they are removed. If you wish to remove all windows, you may wish to use
3239 * the #clearWindows method instead. If you no longer need the window manager and want to ensure that it no
3240 * longer listens to events, use the #destroy method.
3241 *
3242 * @param {string[]} names Symbolic names of windows to remove
3243 * @return {jQuery.Promise} Promise resolved when window is closed and removed
3244 * @throws {Error} An error is thrown if the named windows are not managed by the window manager.
3245 */
3246 OO.ui.WindowManager.prototype.removeWindows = function ( names ) {
3247 var i, len, win, name, cleanupWindow,
3248 manager = this,
3249 promises = [],
3250 cleanup = function ( name, win ) {
3251 delete manager.windows[ name ];
3252 win.$element.detach();
3253 };
3254
3255 for ( i = 0, len = names.length; i < len; i++ ) {
3256 name = names[ i ];
3257 win = this.windows[ name ];
3258 if ( !win ) {
3259 throw new Error( 'Cannot remove window' );
3260 }
3261 cleanupWindow = cleanup.bind( null, name, win );
3262 promises.push( this.closeWindow( name ).then( cleanupWindow, cleanupWindow ) );
3263 }
3264
3265 return $.when.apply( $, promises );
3266 };
3267
3268 /**
3269 * Remove all windows from the window manager.
3270 *
3271 * Windows will be closed before they are removed. Note that the window manager, though not in use, will still
3272 * listen to events. If the window manager will not be used again, you may wish to use the #destroy method instead.
3273 * To remove just a subset of windows, use the #removeWindows method.
3274 *
3275 * @return {jQuery.Promise} Promise resolved when all windows are closed and removed
3276 */
3277 OO.ui.WindowManager.prototype.clearWindows = function () {
3278 return this.removeWindows( Object.keys( this.windows ) );
3279 };
3280
3281 /**
3282 * Set dialog size. In general, this method should not be called directly.
3283 *
3284 * Fullscreen mode will be used if the dialog is too wide to fit in the screen.
3285 *
3286 * @chainable
3287 */
3288 OO.ui.WindowManager.prototype.updateWindowSize = function ( win ) {
3289 // Bypass for non-current, and thus invisible, windows
3290 if ( win !== this.currentWindow ) {
3291 return;
3292 }
3293
3294 var viewport = OO.ui.Element.static.getDimensions( win.getElementWindow() ),
3295 sizes = this.constructor.static.sizes,
3296 size = win.getSize();
3297
3298 if ( !sizes[ size ] ) {
3299 size = this.constructor.static.defaultSize;
3300 }
3301 if ( size !== 'full' && viewport.rect.right - viewport.rect.left < sizes[ size ].width ) {
3302 size = 'full';
3303 }
3304
3305 this.$element.toggleClass( 'oo-ui-windowManager-fullscreen', size === 'full' );
3306 this.$element.toggleClass( 'oo-ui-windowManager-floating', size !== 'full' );
3307 win.setDimensions( sizes[ size ] );
3308
3309 this.emit( 'resize', win );
3310
3311 return this;
3312 };
3313
3314 /**
3315 * Bind or unbind global events for scrolling.
3316 *
3317 * @private
3318 * @param {boolean} [on] Bind global events
3319 * @chainable
3320 */
3321 OO.ui.WindowManager.prototype.toggleGlobalEvents = function ( on ) {
3322 on = on === undefined ? !!this.globalEvents : !!on;
3323
3324 var scrollWidth, bodyMargin,
3325 $body = $( this.getElementDocument().body ),
3326 // We could have multiple window managers open so only modify
3327 // the body css at the bottom of the stack
3328 stackDepth = $body.data( 'windowManagerGlobalEvents' ) || 0 ;
3329
3330 if ( on ) {
3331 if ( !this.globalEvents ) {
3332 $( this.getElementWindow() ).on( {
3333 // Start listening for top-level window dimension changes
3334 'orientationchange resize': this.onWindowResizeHandler
3335 } );
3336 if ( stackDepth === 0 ) {
3337 scrollWidth = window.innerWidth - document.documentElement.clientWidth;
3338 bodyMargin = parseFloat( $body.css( 'margin-right' ) ) || 0;
3339 $body.css( {
3340 overflow: 'hidden',
3341 'margin-right': bodyMargin + scrollWidth
3342 } );
3343 }
3344 stackDepth++;
3345 this.globalEvents = true;
3346 }
3347 } else if ( this.globalEvents ) {
3348 $( this.getElementWindow() ).off( {
3349 // Stop listening for top-level window dimension changes
3350 'orientationchange resize': this.onWindowResizeHandler
3351 } );
3352 stackDepth--;
3353 if ( stackDepth === 0 ) {
3354 $body.css( {
3355 overflow: '',
3356 'margin-right': ''
3357 } );
3358 }
3359 this.globalEvents = false;
3360 }
3361 $body.data( 'windowManagerGlobalEvents', stackDepth );
3362
3363 return this;
3364 };
3365
3366 /**
3367 * Toggle screen reader visibility of content other than the window manager.
3368 *
3369 * @private
3370 * @param {boolean} [isolate] Make only the window manager visible to screen readers
3371 * @chainable
3372 */
3373 OO.ui.WindowManager.prototype.toggleAriaIsolation = function ( isolate ) {
3374 isolate = isolate === undefined ? !this.$ariaHidden : !!isolate;
3375
3376 if ( isolate ) {
3377 if ( !this.$ariaHidden ) {
3378 // Hide everything other than the window manager from screen readers
3379 this.$ariaHidden = $( 'body' )
3380 .children()
3381 .not( this.$element.parentsUntil( 'body' ).last() )
3382 .attr( 'aria-hidden', '' );
3383 }
3384 } else if ( this.$ariaHidden ) {
3385 // Restore screen reader visibility
3386 this.$ariaHidden.removeAttr( 'aria-hidden' );
3387 this.$ariaHidden = null;
3388 }
3389
3390 return this;
3391 };
3392
3393 /**
3394 * Destroy the window manager.
3395 *
3396 * Destroying the window manager ensures that it will no longer listen to events. If you would like to
3397 * continue using the window manager, but wish to remove all windows from it, use the #clearWindows method
3398 * instead.
3399 */
3400 OO.ui.WindowManager.prototype.destroy = function () {
3401 this.toggleGlobalEvents( false );
3402 this.toggleAriaIsolation( false );
3403 this.clearWindows();
3404 this.$element.remove();
3405 };
3406
3407 /**
3408 * Errors contain a required message (either a string or jQuery selection) that is used to describe what went wrong
3409 * in a {@link OO.ui.Process process}. The error's #recoverable and #warning configurations are used to customize the
3410 * appearance and functionality of the error interface.
3411 *
3412 * The basic error interface contains a formatted error message as well as two buttons: 'Dismiss' and 'Try again' (i.e., the error
3413 * is 'recoverable' by default). If the error is not recoverable, the 'Try again' button will not be rendered and the widget
3414 * that initiated the failed process will be disabled.
3415 *
3416 * If the error is a warning, the error interface will include a 'Dismiss' and a 'Continue' button, which will try the
3417 * process again.
3418 *
3419 * For an example of error interfaces, please see the [OOjs UI documentation on MediaWiki][1].
3420 *
3421 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Windows/Process_Dialogs#Processes_and_errors
3422 *
3423 * @class
3424 *
3425 * @constructor
3426 * @param {string|jQuery} message Description of error
3427 * @param {Object} [config] Configuration options
3428 * @cfg {boolean} [recoverable=true] Error is recoverable.
3429 * By default, errors are recoverable, and users can try the process again.
3430 * @cfg {boolean} [warning=false] Error is a warning.
3431 * If the error is a warning, the error interface will include a
3432 * 'Dismiss' and a 'Continue' button. It is the responsibility of the developer to ensure that the warning
3433 * is not triggered a second time if the user chooses to continue.
3434 */
3435 OO.ui.Error = function OoUiError( message, config ) {
3436 // Allow passing positional parameters inside the config object
3437 if ( OO.isPlainObject( message ) && config === undefined ) {
3438 config = message;
3439 message = config.message;
3440 }
3441
3442 // Configuration initialization
3443 config = config || {};
3444
3445 // Properties
3446 this.message = message instanceof jQuery ? message : String( message );
3447 this.recoverable = config.recoverable === undefined || !!config.recoverable;
3448 this.warning = !!config.warning;
3449 };
3450
3451 /* Setup */
3452
3453 OO.initClass( OO.ui.Error );
3454
3455 /* Methods */
3456
3457 /**
3458 * Check if the error is recoverable.
3459 *
3460 * If the error is recoverable, users are able to try the process again.
3461 *
3462 * @return {boolean} Error is recoverable
3463 */
3464 OO.ui.Error.prototype.isRecoverable = function () {
3465 return this.recoverable;
3466 };
3467
3468 /**
3469 * Check if the error is a warning.
3470 *
3471 * If the error is a warning, the error interface will include a 'Dismiss' and a 'Continue' button.
3472 *
3473 * @return {boolean} Error is warning
3474 */
3475 OO.ui.Error.prototype.isWarning = function () {
3476 return this.warning;
3477 };
3478
3479 /**
3480 * Get error message as DOM nodes.
3481 *
3482 * @return {jQuery} Error message in DOM nodes
3483 */
3484 OO.ui.Error.prototype.getMessage = function () {
3485 return this.message instanceof jQuery ?
3486 this.message.clone() :
3487 $( '<div>' ).text( this.message ).contents();
3488 };
3489
3490 /**
3491 * Get the error message text.
3492 *
3493 * @return {string} Error message
3494 */
3495 OO.ui.Error.prototype.getMessageText = function () {
3496 return this.message instanceof jQuery ? this.message.text() : this.message;
3497 };
3498
3499 /**
3500 * Wraps an HTML snippet for use with configuration values which default
3501 * to strings. This bypasses the default html-escaping done to string
3502 * values.
3503 *
3504 * @class
3505 *
3506 * @constructor
3507 * @param {string} [content] HTML content
3508 */
3509 OO.ui.HtmlSnippet = function OoUiHtmlSnippet( content ) {
3510 // Properties
3511 this.content = content;
3512 };
3513
3514 /* Setup */
3515
3516 OO.initClass( OO.ui.HtmlSnippet );
3517
3518 /* Methods */
3519
3520 /**
3521 * Render into HTML.
3522 *
3523 * @return {string} Unchanged HTML snippet.
3524 */
3525 OO.ui.HtmlSnippet.prototype.toString = function () {
3526 return this.content;
3527 };
3528
3529 /**
3530 * A Process is a list of steps that are called in sequence. The step can be a number, a jQuery promise,
3531 * or a function:
3532 *
3533 * - **number**: the process will wait for the specified number of milliseconds before proceeding.
3534 * - **promise**: the process will continue to the next step when the promise is successfully resolved
3535 * or stop if the promise is rejected.
3536 * - **function**: the process will execute the function. The process will stop if the function returns
3537 * either a boolean `false` or a promise that is rejected; if the function returns a number, the process
3538 * will wait for that number of milliseconds before proceeding.
3539 *
3540 * If the process fails, an {@link OO.ui.Error error} is generated. Depending on how the error is
3541 * configured, users can dismiss the error and try the process again, or not. If a process is stopped,
3542 * its remaining steps will not be performed.
3543 *
3544 * @class
3545 *
3546 * @constructor
3547 * @param {number|jQuery.Promise|Function} step Number of miliseconds to wait before proceeding, promise
3548 * that must be resolved before proceeding, or a function to execute. See #createStep for more information. see #createStep for more information
3549 * @param {Object} [context=null] Execution context of the function. The context is ignored if the step is
3550 * a number or promise.
3551 * @return {Object} Step object, with `callback` and `context` properties
3552 */
3553 OO.ui.Process = function ( step, context ) {
3554 // Properties
3555 this.steps = [];
3556
3557 // Initialization
3558 if ( step !== undefined ) {
3559 this.next( step, context );
3560 }
3561 };
3562
3563 /* Setup */
3564
3565 OO.initClass( OO.ui.Process );
3566
3567 /* Methods */
3568
3569 /**
3570 * Start the process.
3571 *
3572 * @return {jQuery.Promise} Promise that is resolved when all steps have successfully completed.
3573 * If any of the steps return a promise that is rejected or a boolean false, this promise is rejected
3574 * and any remaining steps are not performed.
3575 */
3576 OO.ui.Process.prototype.execute = function () {
3577 var i, len, promise;
3578
3579 /**
3580 * Continue execution.
3581 *
3582 * @ignore
3583 * @param {Array} step A function and the context it should be called in
3584 * @return {Function} Function that continues the process
3585 */
3586 function proceed( step ) {
3587 return function () {
3588 // Execute step in the correct context
3589 var deferred,
3590 result = step.callback.call( step.context );
3591
3592 if ( result === false ) {
3593 // Use rejected promise for boolean false results
3594 return $.Deferred().reject( [] ).promise();
3595 }
3596 if ( typeof result === 'number' ) {
3597 if ( result < 0 ) {
3598 throw new Error( 'Cannot go back in time: flux capacitor is out of service' );
3599 }
3600 // Use a delayed promise for numbers, expecting them to be in milliseconds
3601 deferred = $.Deferred();
3602 setTimeout( deferred.resolve, result );
3603 return deferred.promise();
3604 }
3605 if ( result instanceof OO.ui.Error ) {
3606 // Use rejected promise for error
3607 return $.Deferred().reject( [ result ] ).promise();
3608 }
3609 if ( Array.isArray( result ) && result.length && result[ 0 ] instanceof OO.ui.Error ) {
3610 // Use rejected promise for list of errors
3611 return $.Deferred().reject( result ).promise();
3612 }
3613 // Duck-type the object to see if it can produce a promise
3614 if ( result && $.isFunction( result.promise ) ) {
3615 // Use a promise generated from the result
3616 return result.promise();
3617 }
3618 // Use resolved promise for other results
3619 return $.Deferred().resolve().promise();
3620 };
3621 }
3622
3623 if ( this.steps.length ) {
3624 // Generate a chain reaction of promises
3625 promise = proceed( this.steps[ 0 ] )();
3626 for ( i = 1, len = this.steps.length; i < len; i++ ) {
3627 promise = promise.then( proceed( this.steps[ i ] ) );
3628 }
3629 } else {
3630 promise = $.Deferred().resolve().promise();
3631 }
3632
3633 return promise;
3634 };
3635
3636 /**
3637 * Create a process step.
3638 *
3639 * @private
3640 * @param {number|jQuery.Promise|Function} step
3641 *
3642 * - Number of milliseconds to wait before proceeding
3643 * - Promise that must be resolved before proceeding
3644 * - Function to execute
3645 * - If the function returns a boolean false the process will stop
3646 * - If the function returns a promise, the process will continue to the next
3647 * step when the promise is resolved or stop if the promise is rejected
3648 * - If the function returns a number, the process will wait for that number of
3649 * milliseconds before proceeding
3650 * @param {Object} [context=null] Execution context of the function. The context is
3651 * ignored if the step is a number or promise.
3652 * @return {Object} Step object, with `callback` and `context` properties
3653 */
3654 OO.ui.Process.prototype.createStep = function ( step, context ) {
3655 if ( typeof step === 'number' || $.isFunction( step.promise ) ) {
3656 return {
3657 callback: function () {
3658 return step;
3659 },
3660 context: null
3661 };
3662 }
3663 if ( $.isFunction( step ) ) {
3664 return {
3665 callback: step,
3666 context: context
3667 };
3668 }
3669 throw new Error( 'Cannot create process step: number, promise or function expected' );
3670 };
3671
3672 /**
3673 * Add step to the beginning of the process.
3674 *
3675 * @inheritdoc #createStep
3676 * @return {OO.ui.Process} this
3677 * @chainable
3678 */
3679 OO.ui.Process.prototype.first = function ( step, context ) {
3680 this.steps.unshift( this.createStep( step, context ) );
3681 return this;
3682 };
3683
3684 /**
3685 * Add step to the end of the process.
3686 *
3687 * @inheritdoc #createStep
3688 * @return {OO.ui.Process} this
3689 * @chainable
3690 */
3691 OO.ui.Process.prototype.next = function ( step, context ) {
3692 this.steps.push( this.createStep( step, context ) );
3693 return this;
3694 };
3695
3696 /**
3697 * Factory for tools.
3698 *
3699 * @class
3700 * @extends OO.Factory
3701 * @constructor
3702 */
3703 OO.ui.ToolFactory = function OoUiToolFactory() {
3704 // Parent constructor
3705 OO.ui.ToolFactory.super.call( this );
3706 };
3707
3708 /* Setup */
3709
3710 OO.inheritClass( OO.ui.ToolFactory, OO.Factory );
3711
3712 /* Methods */
3713
3714 /**
3715 * Get tools from the factory
3716 *
3717 * @param {Array} include Included tools
3718 * @param {Array} exclude Excluded tools
3719 * @param {Array} promote Promoted tools
3720 * @param {Array} demote Demoted tools
3721 * @return {string[]} List of tools
3722 */
3723 OO.ui.ToolFactory.prototype.getTools = function ( include, exclude, promote, demote ) {
3724 var i, len, included, promoted, demoted,
3725 auto = [],
3726 used = {};
3727
3728 // Collect included and not excluded tools
3729 included = OO.simpleArrayDifference( this.extract( include ), this.extract( exclude ) );
3730
3731 // Promotion
3732 promoted = this.extract( promote, used );
3733 demoted = this.extract( demote, used );
3734
3735 // Auto
3736 for ( i = 0, len = included.length; i < len; i++ ) {
3737 if ( !used[ included[ i ] ] ) {
3738 auto.push( included[ i ] );
3739 }
3740 }
3741
3742 return promoted.concat( auto ).concat( demoted );
3743 };
3744
3745 /**
3746 * Get a flat list of names from a list of names or groups.
3747 *
3748 * Tools can be specified in the following ways:
3749 *
3750 * - A specific tool: `{ name: 'tool-name' }` or `'tool-name'`
3751 * - All tools in a group: `{ group: 'group-name' }`
3752 * - All tools: `'*'`
3753 *
3754 * @private
3755 * @param {Array|string} collection List of tools
3756 * @param {Object} [used] Object with names that should be skipped as properties; extracted
3757 * names will be added as properties
3758 * @return {string[]} List of extracted names
3759 */
3760 OO.ui.ToolFactory.prototype.extract = function ( collection, used ) {
3761 var i, len, item, name, tool,
3762 names = [];
3763
3764 if ( collection === '*' ) {
3765 for ( name in this.registry ) {
3766 tool = this.registry[ name ];
3767 if (
3768 // Only add tools by group name when auto-add is enabled
3769 tool.static.autoAddToCatchall &&
3770 // Exclude already used tools
3771 ( !used || !used[ name ] )
3772 ) {
3773 names.push( name );
3774 if ( used ) {
3775 used[ name ] = true;
3776 }
3777 }
3778 }
3779 } else if ( Array.isArray( collection ) ) {
3780 for ( i = 0, len = collection.length; i < len; i++ ) {
3781 item = collection[ i ];
3782 // Allow plain strings as shorthand for named tools
3783 if ( typeof item === 'string' ) {
3784 item = { name: item };
3785 }
3786 if ( OO.isPlainObject( item ) ) {
3787 if ( item.group ) {
3788 for ( name in this.registry ) {
3789 tool = this.registry[ name ];
3790 if (
3791 // Include tools with matching group
3792 tool.static.group === item.group &&
3793 // Only add tools by group name when auto-add is enabled
3794 tool.static.autoAddToGroup &&
3795 // Exclude already used tools
3796 ( !used || !used[ name ] )
3797 ) {
3798 names.push( name );
3799 if ( used ) {
3800 used[ name ] = true;
3801 }
3802 }
3803 }
3804 // Include tools with matching name and exclude already used tools
3805 } else if ( item.name && ( !used || !used[ item.name ] ) ) {
3806 names.push( item.name );
3807 if ( used ) {
3808 used[ item.name ] = true;
3809 }
3810 }
3811 }
3812 }
3813 }
3814 return names;
3815 };
3816
3817 /**
3818 * Factory for tool groups.
3819 *
3820 * @class
3821 * @extends OO.Factory
3822 * @constructor
3823 */
3824 OO.ui.ToolGroupFactory = function OoUiToolGroupFactory() {
3825 // Parent constructor
3826 OO.Factory.call( this );
3827
3828 var i, l,
3829 defaultClasses = this.constructor.static.getDefaultClasses();
3830
3831 // Register default toolgroups
3832 for ( i = 0, l = defaultClasses.length; i < l; i++ ) {
3833 this.register( defaultClasses[ i ] );
3834 }
3835 };
3836
3837 /* Setup */
3838
3839 OO.inheritClass( OO.ui.ToolGroupFactory, OO.Factory );
3840
3841 /* Static Methods */
3842
3843 /**
3844 * Get a default set of classes to be registered on construction
3845 *
3846 * @return {Function[]} Default classes
3847 */
3848 OO.ui.ToolGroupFactory.static.getDefaultClasses = function () {
3849 return [
3850 OO.ui.BarToolGroup,
3851 OO.ui.ListToolGroup,
3852 OO.ui.MenuToolGroup
3853 ];
3854 };
3855
3856 /**
3857 * Theme logic.
3858 *
3859 * @abstract
3860 * @class
3861 *
3862 * @constructor
3863 * @param {Object} [config] Configuration options
3864 */
3865 OO.ui.Theme = function OoUiTheme( config ) {
3866 // Configuration initialization
3867 config = config || {};
3868 };
3869
3870 /* Setup */
3871
3872 OO.initClass( OO.ui.Theme );
3873
3874 /* Methods */
3875
3876 /**
3877 * Get a list of classes to be applied to a widget.
3878 *
3879 * The 'on' and 'off' lists combined MUST contain keys for all classes the theme adds or removes,
3880 * otherwise state transitions will not work properly.
3881 *
3882 * @param {OO.ui.Element} element Element for which to get classes
3883 * @return {Object.<string,string[]>} Categorized class names with `on` and `off` lists
3884 */
3885 OO.ui.Theme.prototype.getElementClasses = function ( /* element */ ) {
3886 return { on: [], off: [] };
3887 };
3888
3889 /**
3890 * Update CSS classes provided by the theme.
3891 *
3892 * For elements with theme logic hooks, this should be called any time there's a state change.
3893 *
3894 * @param {OO.ui.Element} element Element for which to update classes
3895 * @return {Object.<string,string[]>} Categorized class names with `on` and `off` lists
3896 */
3897 OO.ui.Theme.prototype.updateElementClasses = function ( element ) {
3898 var classes = this.getElementClasses( element );
3899
3900 element.$element
3901 .removeClass( classes.off.join( ' ' ) )
3902 .addClass( classes.on.join( ' ' ) );
3903 };
3904
3905 /**
3906 * The TabIndexedElement class is an attribute mixin used to add additional functionality to an
3907 * element created by another class. The mixin provides a ‘tabIndex’ property, which specifies the
3908 * order in which users will navigate through the focusable elements via the "tab" key.
3909 *
3910 * @example
3911 * // TabIndexedElement is mixed into the ButtonWidget class
3912 * // to provide a tabIndex property.
3913 * var button1 = new OO.ui.ButtonWidget( {
3914 * label: 'fourth',
3915 * tabIndex: 4
3916 * } );
3917 * var button2 = new OO.ui.ButtonWidget( {
3918 * label: 'second',
3919 * tabIndex: 2
3920 * } );
3921 * var button3 = new OO.ui.ButtonWidget( {
3922 * label: 'third',
3923 * tabIndex: 3
3924 * } );
3925 * var button4 = new OO.ui.ButtonWidget( {
3926 * label: 'first',
3927 * tabIndex: 1
3928 * } );
3929 * $( 'body' ).append( button1.$element, button2.$element, button3.$element, button4.$element );
3930 *
3931 * @abstract
3932 * @class
3933 *
3934 * @constructor
3935 * @param {Object} [config] Configuration options
3936 * @cfg {jQuery} [$tabIndexed] The element that should use the tabindex functionality. By default,
3937 * the functionality is applied to the element created by the class ($element). If a different element is specified, the tabindex
3938 * functionality will be applied to it instead.
3939 * @cfg {number|null} [tabIndex=0] Number that specifies the element’s position in the tab-navigation
3940 * order (e.g., 1 for the first focusable element). Use 0 to use the default navigation order; use -1
3941 * to remove the element from the tab-navigation flow.
3942 */
3943 OO.ui.TabIndexedElement = function OoUiTabIndexedElement( config ) {
3944 // Configuration initialization
3945 config = $.extend( { tabIndex: 0 }, config );
3946
3947 // Properties
3948 this.$tabIndexed = null;
3949 this.tabIndex = null;
3950
3951 // Events
3952 this.connect( this, { disable: 'onDisable' } );
3953
3954 // Initialization
3955 this.setTabIndex( config.tabIndex );
3956 this.setTabIndexedElement( config.$tabIndexed || this.$element );
3957 };
3958
3959 /* Setup */
3960
3961 OO.initClass( OO.ui.TabIndexedElement );
3962
3963 /* Methods */
3964
3965 /**
3966 * Set the element that should use the tabindex functionality.
3967 *
3968 * This method is used to retarget a tabindex mixin so that its functionality applies
3969 * to the specified element. If an element is currently using the functionality, the mixin’s
3970 * effect on that element is removed before the new element is set up.
3971 *
3972 * @param {jQuery} $tabIndexed Element that should use the tabindex functionality
3973 * @chainable
3974 */
3975 OO.ui.TabIndexedElement.prototype.setTabIndexedElement = function ( $tabIndexed ) {
3976 var tabIndex = this.tabIndex;
3977 // Remove attributes from old $tabIndexed
3978 this.setTabIndex( null );
3979 // Force update of new $tabIndexed
3980 this.$tabIndexed = $tabIndexed;
3981 this.tabIndex = tabIndex;
3982 return this.updateTabIndex();
3983 };
3984
3985 /**
3986 * Set the value of the tabindex.
3987 *
3988 * @param {number|null} tabIndex Tabindex value, or `null` for no tabindex
3989 * @chainable
3990 */
3991 OO.ui.TabIndexedElement.prototype.setTabIndex = function ( tabIndex ) {
3992 tabIndex = typeof tabIndex === 'number' ? tabIndex : null;
3993
3994 if ( this.tabIndex !== tabIndex ) {
3995 this.tabIndex = tabIndex;
3996 this.updateTabIndex();
3997 }
3998
3999 return this;
4000 };
4001
4002 /**
4003 * Update the `tabindex` attribute, in case of changes to tab index or
4004 * disabled state.
4005 *
4006 * @private
4007 * @chainable
4008 */
4009 OO.ui.TabIndexedElement.prototype.updateTabIndex = function () {
4010 if ( this.$tabIndexed ) {
4011 if ( this.tabIndex !== null ) {
4012 // Do not index over disabled elements
4013 this.$tabIndexed.attr( {
4014 tabindex: this.isDisabled() ? -1 : this.tabIndex,
4015 // ChromeVox and NVDA do not seem to inherit this from parent elements
4016 'aria-disabled': this.isDisabled().toString()
4017 } );
4018 } else {
4019 this.$tabIndexed.removeAttr( 'tabindex aria-disabled' );
4020 }
4021 }
4022 return this;
4023 };
4024
4025 /**
4026 * Handle disable events.
4027 *
4028 * @private
4029 * @param {boolean} disabled Element is disabled
4030 */
4031 OO.ui.TabIndexedElement.prototype.onDisable = function () {
4032 this.updateTabIndex();
4033 };
4034
4035 /**
4036 * Get the value of the tabindex.
4037 *
4038 * @return {number|null} Tabindex value
4039 */
4040 OO.ui.TabIndexedElement.prototype.getTabIndex = function () {
4041 return this.tabIndex;
4042 };
4043
4044 /**
4045 * ButtonElement is often mixed into other classes to generate a button, which is a clickable
4046 * interface element that can be configured with access keys for accessibility.
4047 * See the [OOjs UI documentation on MediaWiki] [1] for examples.
4048 *
4049 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Buttons_and_Switches#Buttons
4050 * @abstract
4051 * @class
4052 *
4053 * @constructor
4054 * @param {Object} [config] Configuration options
4055 * @cfg {jQuery} [$button] The button element created by the class.
4056 * If this configuration is omitted, the button element will use a generated `<a>`.
4057 * @cfg {boolean} [framed=true] Render the button with a frame
4058 * @cfg {string} [accessKey] Button's access key
4059 */
4060 OO.ui.ButtonElement = function OoUiButtonElement( config ) {
4061 // Configuration initialization
4062 config = config || {};
4063
4064 // Properties
4065 this.$button = null;
4066 this.framed = null;
4067 this.accessKey = null;
4068 this.active = false;
4069 this.onMouseUpHandler = this.onMouseUp.bind( this );
4070 this.onMouseDownHandler = this.onMouseDown.bind( this );
4071 this.onKeyDownHandler = this.onKeyDown.bind( this );
4072 this.onKeyUpHandler = this.onKeyUp.bind( this );
4073 this.onClickHandler = this.onClick.bind( this );
4074 this.onKeyPressHandler = this.onKeyPress.bind( this );
4075
4076 // Initialization
4077 this.$element.addClass( 'oo-ui-buttonElement' );
4078 this.toggleFramed( config.framed === undefined || config.framed );
4079 this.setAccessKey( config.accessKey );
4080 this.setButtonElement( config.$button || $( '<a>' ) );
4081 };
4082
4083 /* Setup */
4084
4085 OO.initClass( OO.ui.ButtonElement );
4086
4087 /* Static Properties */
4088
4089 /**
4090 * Cancel mouse down events.
4091 *
4092 * This property is usually set to `true` to prevent the focus from changing when the button is clicked.
4093 * Classes such as {@link OO.ui.DraggableElement DraggableElement} and {@link OO.ui.ButtonOptionWidget ButtonOptionWidget}
4094 * use a value of `false` so that dragging behavior is possible and mousedown events can be handled by a
4095 * parent widget.
4096 *
4097 * @static
4098 * @inheritable
4099 * @property {boolean}
4100 */
4101 OO.ui.ButtonElement.static.cancelButtonMouseDownEvents = true;
4102
4103 /* Events */
4104
4105 /**
4106 * A 'click' event is emitted when the button element is clicked.
4107 *
4108 * @event click
4109 */
4110
4111 /* Methods */
4112
4113 /**
4114 * Set the button element.
4115 *
4116 * This method is used to retarget a button mixin so that its functionality applies to
4117 * the specified button element instead of the one created by the class. If a button element
4118 * is already set, the method will remove the mixin’s effect on that element.
4119 *
4120 * @param {jQuery} $button Element to use as button
4121 */
4122 OO.ui.ButtonElement.prototype.setButtonElement = function ( $button ) {
4123 if ( this.$button ) {
4124 this.$button
4125 .removeClass( 'oo-ui-buttonElement-button' )
4126 .removeAttr( 'role accesskey' )
4127 .off( {
4128 mousedown: this.onMouseDownHandler,
4129 keydown: this.onKeyDownHandler,
4130 click: this.onClickHandler,
4131 keypress: this.onKeyPressHandler
4132 } );
4133 }
4134
4135 this.$button = $button
4136 .addClass( 'oo-ui-buttonElement-button' )
4137 .attr( { role: 'button', accesskey: this.accessKey } )
4138 .on( {
4139 mousedown: this.onMouseDownHandler,
4140 keydown: this.onKeyDownHandler,
4141 click: this.onClickHandler,
4142 keypress: this.onKeyPressHandler
4143 } );
4144 };
4145
4146 /**
4147 * Handles mouse down events.
4148 *
4149 * @protected
4150 * @param {jQuery.Event} e Mouse down event
4151 */
4152 OO.ui.ButtonElement.prototype.onMouseDown = function ( e ) {
4153 if ( this.isDisabled() || e.which !== 1 ) {
4154 return;
4155 }
4156 this.$element.addClass( 'oo-ui-buttonElement-pressed' );
4157 // Run the mouseup handler no matter where the mouse is when the button is let go, so we can
4158 // reliably remove the pressed class
4159 this.getElementDocument().addEventListener( 'mouseup', this.onMouseUpHandler, true );
4160 // Prevent change of focus unless specifically configured otherwise
4161 if ( this.constructor.static.cancelButtonMouseDownEvents ) {
4162 return false;
4163 }
4164 };
4165
4166 /**
4167 * Handles mouse up events.
4168 *
4169 * @protected
4170 * @param {jQuery.Event} e Mouse up event
4171 */
4172 OO.ui.ButtonElement.prototype.onMouseUp = function ( e ) {
4173 if ( this.isDisabled() || e.which !== 1 ) {
4174 return;
4175 }
4176 this.$element.removeClass( 'oo-ui-buttonElement-pressed' );
4177 // Stop listening for mouseup, since we only needed this once
4178 this.getElementDocument().removeEventListener( 'mouseup', this.onMouseUpHandler, true );
4179 };
4180
4181 /**
4182 * Handles mouse click events.
4183 *
4184 * @protected
4185 * @param {jQuery.Event} e Mouse click event
4186 * @fires click
4187 */
4188 OO.ui.ButtonElement.prototype.onClick = function ( e ) {
4189 if ( !this.isDisabled() && e.which === 1 ) {
4190 if ( this.emit( 'click' ) ) {
4191 return false;
4192 }
4193 }
4194 };
4195
4196 /**
4197 * Handles key down events.
4198 *
4199 * @protected
4200 * @param {jQuery.Event} e Key down event
4201 */
4202 OO.ui.ButtonElement.prototype.onKeyDown = function ( e ) {
4203 if ( this.isDisabled() || ( e.which !== OO.ui.Keys.SPACE && e.which !== OO.ui.Keys.ENTER ) ) {
4204 return;
4205 }
4206 this.$element.addClass( 'oo-ui-buttonElement-pressed' );
4207 // Run the keyup handler no matter where the key is when the button is let go, so we can
4208 // reliably remove the pressed class
4209 this.getElementDocument().addEventListener( 'keyup', this.onKeyUpHandler, true );
4210 };
4211
4212 /**
4213 * Handles key up events.
4214 *
4215 * @protected
4216 * @param {jQuery.Event} e Key up event
4217 */
4218 OO.ui.ButtonElement.prototype.onKeyUp = function ( e ) {
4219 if ( this.isDisabled() || ( e.which !== OO.ui.Keys.SPACE && e.which !== OO.ui.Keys.ENTER ) ) {
4220 return;
4221 }
4222 this.$element.removeClass( 'oo-ui-buttonElement-pressed' );
4223 // Stop listening for keyup, since we only needed this once
4224 this.getElementDocument().removeEventListener( 'keyup', this.onKeyUpHandler, true );
4225 };
4226
4227 /**
4228 * Handles key press events.
4229 *
4230 * @protected
4231 * @param {jQuery.Event} e Key press event
4232 * @fires click
4233 */
4234 OO.ui.ButtonElement.prototype.onKeyPress = function ( e ) {
4235 if ( !this.isDisabled() && ( e.which === OO.ui.Keys.SPACE || e.which === OO.ui.Keys.ENTER ) ) {
4236 if ( this.emit( 'click' ) ) {
4237 return false;
4238 }
4239 }
4240 };
4241
4242 /**
4243 * Check if button has a frame.
4244 *
4245 * @return {boolean} Button is framed
4246 */
4247 OO.ui.ButtonElement.prototype.isFramed = function () {
4248 return this.framed;
4249 };
4250
4251 /**
4252 * Render the button with or without a frame. Omit the `framed` parameter to toggle the button frame on and off.
4253 *
4254 * @param {boolean} [framed] Make button framed, omit to toggle
4255 * @chainable
4256 */
4257 OO.ui.ButtonElement.prototype.toggleFramed = function ( framed ) {
4258 framed = framed === undefined ? !this.framed : !!framed;
4259 if ( framed !== this.framed ) {
4260 this.framed = framed;
4261 this.$element
4262 .toggleClass( 'oo-ui-buttonElement-frameless', !framed )
4263 .toggleClass( 'oo-ui-buttonElement-framed', framed );
4264 this.updateThemeClasses();
4265 }
4266
4267 return this;
4268 };
4269
4270 /**
4271 * Set the button's access key.
4272 *
4273 * @param {string} accessKey Button's access key, use empty string to remove
4274 * @chainable
4275 */
4276 OO.ui.ButtonElement.prototype.setAccessKey = function ( accessKey ) {
4277 accessKey = typeof accessKey === 'string' && accessKey.length ? accessKey : null;
4278
4279 if ( this.accessKey !== accessKey ) {
4280 if ( this.$button ) {
4281 if ( accessKey !== null ) {
4282 this.$button.attr( 'accesskey', accessKey );
4283 } else {
4284 this.$button.removeAttr( 'accesskey' );
4285 }
4286 }
4287 this.accessKey = accessKey;
4288 }
4289
4290 return this;
4291 };
4292
4293 /**
4294 * Set the button to its 'active' state.
4295 *
4296 * The active state occurs when a {@link OO.ui.ButtonOptionWidget ButtonOptionWidget} or
4297 * a {@link OO.ui.ToggleButtonWidget ToggleButtonWidget} is pressed. This method does nothing
4298 * for other button types.
4299 *
4300 * @param {boolean} [value] Make button active
4301 * @chainable
4302 */
4303 OO.ui.ButtonElement.prototype.setActive = function ( value ) {
4304 this.$element.toggleClass( 'oo-ui-buttonElement-active', !!value );
4305 return this;
4306 };
4307
4308 /**
4309 * Any OOjs UI widget that contains other widgets (such as {@link OO.ui.ButtonWidget buttons} or
4310 * {@link OO.ui.OptionWidget options}) mixes in GroupElement. Adding, removing, and clearing
4311 * items from the group is done through the interface the class provides.
4312 * For more information, please see the [OOjs UI documentation on MediaWiki] [1].
4313 *
4314 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Elements/Groups
4315 *
4316 * @abstract
4317 * @class
4318 *
4319 * @constructor
4320 * @param {Object} [config] Configuration options
4321 * @cfg {jQuery} [$group] The container element created by the class. If this configuration
4322 * is omitted, the group element will use a generated `<div>`.
4323 */
4324 OO.ui.GroupElement = function OoUiGroupElement( config ) {
4325 // Configuration initialization
4326 config = config || {};
4327
4328 // Properties
4329 this.$group = null;
4330 this.items = [];
4331 this.aggregateItemEvents = {};
4332
4333 // Initialization
4334 this.setGroupElement( config.$group || $( '<div>' ) );
4335 };
4336
4337 /* Methods */
4338
4339 /**
4340 * Set the group element.
4341 *
4342 * If an element is already set, items will be moved to the new element.
4343 *
4344 * @param {jQuery} $group Element to use as group
4345 */
4346 OO.ui.GroupElement.prototype.setGroupElement = function ( $group ) {
4347 var i, len;
4348
4349 this.$group = $group;
4350 for ( i = 0, len = this.items.length; i < len; i++ ) {
4351 this.$group.append( this.items[ i ].$element );
4352 }
4353 };
4354
4355 /**
4356 * Check if a group contains no items.
4357 *
4358 * @return {boolean} Group is empty
4359 */
4360 OO.ui.GroupElement.prototype.isEmpty = function () {
4361 return !this.items.length;
4362 };
4363
4364 /**
4365 * Get all items in the group.
4366 *
4367 * The method returns an array of item references (e.g., [button1, button2, button3]) and is useful
4368 * when synchronizing groups of items, or whenever the references are required (e.g., when removing items
4369 * from a group).
4370 *
4371 * @return {OO.ui.Element[]} An array of items.
4372 */
4373 OO.ui.GroupElement.prototype.getItems = function () {
4374 return this.items.slice( 0 );
4375 };
4376
4377 /**
4378 * Get an item by its data.
4379 *
4380 * Only the first item with matching data will be returned. To return all matching items,
4381 * use the #getItemsFromData method.
4382 *
4383 * @param {Object} data Item data to search for
4384 * @return {OO.ui.Element|null} Item with equivalent data, `null` if none exists
4385 */
4386 OO.ui.GroupElement.prototype.getItemFromData = function ( data ) {
4387 var i, len, item,
4388 hash = OO.getHash( data );
4389
4390 for ( i = 0, len = this.items.length; i < len; i++ ) {
4391 item = this.items[ i ];
4392 if ( hash === OO.getHash( item.getData() ) ) {
4393 return item;
4394 }
4395 }
4396
4397 return null;
4398 };
4399
4400 /**
4401 * Get items by their data.
4402 *
4403 * All items with matching data will be returned. To return only the first match, use the #getItemFromData method instead.
4404 *
4405 * @param {Object} data Item data to search for
4406 * @return {OO.ui.Element[]} Items with equivalent data
4407 */
4408 OO.ui.GroupElement.prototype.getItemsFromData = function ( data ) {
4409 var i, len, item,
4410 hash = OO.getHash( data ),
4411 items = [];
4412
4413 for ( i = 0, len = this.items.length; i < len; i++ ) {
4414 item = this.items[ i ];
4415 if ( hash === OO.getHash( item.getData() ) ) {
4416 items.push( item );
4417 }
4418 }
4419
4420 return items;
4421 };
4422
4423 /**
4424 * Aggregate the events emitted by the group.
4425 *
4426 * When events are aggregated, the group will listen to all contained items for the event,
4427 * and then emit the event under a new name. The new event will contain an additional leading
4428 * parameter containing the item that emitted the original event. Other arguments emitted from
4429 * the original event are passed through.
4430 *
4431 * @param {Object.<string,string|null>} events An object keyed by the name of the event that should be
4432 * aggregated (e.g., ‘click’) and the value of the new name to use (e.g., ‘groupClick’).
4433 * A `null` value will remove aggregated events.
4434
4435 * @throws {Error} An error is thrown if aggregation already exists.
4436 */
4437 OO.ui.GroupElement.prototype.aggregate = function ( events ) {
4438 var i, len, item, add, remove, itemEvent, groupEvent;
4439
4440 for ( itemEvent in events ) {
4441 groupEvent = events[ itemEvent ];
4442
4443 // Remove existing aggregated event
4444 if ( Object.prototype.hasOwnProperty.call( this.aggregateItemEvents, itemEvent ) ) {
4445 // Don't allow duplicate aggregations
4446 if ( groupEvent ) {
4447 throw new Error( 'Duplicate item event aggregation for ' + itemEvent );
4448 }
4449 // Remove event aggregation from existing items
4450 for ( i = 0, len = this.items.length; i < len; i++ ) {
4451 item = this.items[ i ];
4452 if ( item.connect && item.disconnect ) {
4453 remove = {};
4454 remove[ itemEvent ] = [ 'emit', groupEvent, item ];
4455 item.disconnect( this, remove );
4456 }
4457 }
4458 // Prevent future items from aggregating event
4459 delete this.aggregateItemEvents[ itemEvent ];
4460 }
4461
4462 // Add new aggregate event
4463 if ( groupEvent ) {
4464 // Make future items aggregate event
4465 this.aggregateItemEvents[ itemEvent ] = groupEvent;
4466 // Add event aggregation to existing items
4467 for ( i = 0, len = this.items.length; i < len; i++ ) {
4468 item = this.items[ i ];
4469 if ( item.connect && item.disconnect ) {
4470 add = {};
4471 add[ itemEvent ] = [ 'emit', groupEvent, item ];
4472 item.connect( this, add );
4473 }
4474 }
4475 }
4476 }
4477 };
4478
4479 /**
4480 * Add items to the group.
4481 *
4482 * Items will be added to the end of the group array unless the optional `index` parameter specifies
4483 * a different insertion point. Adding an existing item will move it to the end of the array or the point specified by the `index`.
4484 *
4485 * @param {OO.ui.Element[]} items An array of items to add to the group
4486 * @param {number} [index] Index of the insertion point
4487 * @chainable
4488 */
4489 OO.ui.GroupElement.prototype.addItems = function ( items, index ) {
4490 var i, len, item, event, events, currentIndex,
4491 itemElements = [];
4492
4493 for ( i = 0, len = items.length; i < len; i++ ) {
4494 item = items[ i ];
4495
4496 // Check if item exists then remove it first, effectively "moving" it
4497 currentIndex = $.inArray( item, this.items );
4498 if ( currentIndex >= 0 ) {
4499 this.removeItems( [ item ] );
4500 // Adjust index to compensate for removal
4501 if ( currentIndex < index ) {
4502 index--;
4503 }
4504 }
4505 // Add the item
4506 if ( item.connect && item.disconnect && !$.isEmptyObject( this.aggregateItemEvents ) ) {
4507 events = {};
4508 for ( event in this.aggregateItemEvents ) {
4509 events[ event ] = [ 'emit', this.aggregateItemEvents[ event ], item ];
4510 }
4511 item.connect( this, events );
4512 }
4513 item.setElementGroup( this );
4514 itemElements.push( item.$element.get( 0 ) );
4515 }
4516
4517 if ( index === undefined || index < 0 || index >= this.items.length ) {
4518 this.$group.append( itemElements );
4519 this.items.push.apply( this.items, items );
4520 } else if ( index === 0 ) {
4521 this.$group.prepend( itemElements );
4522 this.items.unshift.apply( this.items, items );
4523 } else {
4524 this.items[ index ].$element.before( itemElements );
4525 this.items.splice.apply( this.items, [ index, 0 ].concat( items ) );
4526 }
4527
4528 return this;
4529 };
4530
4531 /**
4532 * Remove the specified items from a group.
4533 *
4534 * Removed items are detached (not removed) from the DOM so that they may be reused.
4535 * To remove all items from a group, you may wish to use the #clearItems method instead.
4536 *
4537 * @param {OO.ui.Element[]} items An array of items to remove
4538 * @chainable
4539 */
4540 OO.ui.GroupElement.prototype.removeItems = function ( items ) {
4541 var i, len, item, index, remove, itemEvent;
4542
4543 // Remove specific items
4544 for ( i = 0, len = items.length; i < len; i++ ) {
4545 item = items[ i ];
4546 index = $.inArray( item, this.items );
4547 if ( index !== -1 ) {
4548 if (
4549 item.connect && item.disconnect &&
4550 !$.isEmptyObject( this.aggregateItemEvents )
4551 ) {
4552 remove = {};
4553 if ( Object.prototype.hasOwnProperty.call( this.aggregateItemEvents, itemEvent ) ) {
4554 remove[ itemEvent ] = [ 'emit', this.aggregateItemEvents[ itemEvent ], item ];
4555 }
4556 item.disconnect( this, remove );
4557 }
4558 item.setElementGroup( null );
4559 this.items.splice( index, 1 );
4560 item.$element.detach();
4561 }
4562 }
4563
4564 return this;
4565 };
4566
4567 /**
4568 * Clear all items from the group.
4569 *
4570 * Cleared items are detached from the DOM, not removed, so that they may be reused.
4571 * To remove only a subset of items from a group, use the #removeItems method.
4572 *
4573 * @chainable
4574 */
4575 OO.ui.GroupElement.prototype.clearItems = function () {
4576 var i, len, item, remove, itemEvent;
4577
4578 // Remove all items
4579 for ( i = 0, len = this.items.length; i < len; i++ ) {
4580 item = this.items[ i ];
4581 if (
4582 item.connect && item.disconnect &&
4583 !$.isEmptyObject( this.aggregateItemEvents )
4584 ) {
4585 remove = {};
4586 if ( Object.prototype.hasOwnProperty.call( this.aggregateItemEvents, itemEvent ) ) {
4587 remove[ itemEvent ] = [ 'emit', this.aggregateItemEvents[ itemEvent ], item ];
4588 }
4589 item.disconnect( this, remove );
4590 }
4591 item.setElementGroup( null );
4592 item.$element.detach();
4593 }
4594
4595 this.items = [];
4596 return this;
4597 };
4598
4599 /**
4600 * DraggableElement is a mixin class used to create elements that can be clicked
4601 * and dragged by a mouse to a new position within a group. This class must be used
4602 * in conjunction with OO.ui.DraggableGroupElement, which provides a container for
4603 * the draggable elements.
4604 *
4605 * @abstract
4606 * @class
4607 *
4608 * @constructor
4609 */
4610 OO.ui.DraggableElement = function OoUiDraggableElement() {
4611 // Properties
4612 this.index = null;
4613
4614 // Initialize and events
4615 this.$element
4616 .attr( 'draggable', true )
4617 .addClass( 'oo-ui-draggableElement' )
4618 .on( {
4619 dragstart: this.onDragStart.bind( this ),
4620 dragover: this.onDragOver.bind( this ),
4621 dragend: this.onDragEnd.bind( this ),
4622 drop: this.onDrop.bind( this )
4623 } );
4624 };
4625
4626 OO.initClass( OO.ui.DraggableElement );
4627
4628 /* Events */
4629
4630 /**
4631 * @event dragstart
4632 *
4633 * A dragstart event is emitted when the user clicks and begins dragging an item.
4634 * @param {OO.ui.DraggableElement} item The item the user has clicked and is dragging with the mouse.
4635 */
4636
4637 /**
4638 * @event dragend
4639 * A dragend event is emitted when the user drags an item and releases the mouse,
4640 * thus terminating the drag operation.
4641 */
4642
4643 /**
4644 * @event drop
4645 * A drop event is emitted when the user drags an item and then releases the mouse button
4646 * over a valid target.
4647 */
4648
4649 /* Static Properties */
4650
4651 /**
4652 * @inheritdoc OO.ui.ButtonElement
4653 */
4654 OO.ui.DraggableElement.static.cancelButtonMouseDownEvents = false;
4655
4656 /* Methods */
4657
4658 /**
4659 * Respond to dragstart event.
4660 *
4661 * @private
4662 * @param {jQuery.Event} event jQuery event
4663 * @fires dragstart
4664 */
4665 OO.ui.DraggableElement.prototype.onDragStart = function ( e ) {
4666 var dataTransfer = e.originalEvent.dataTransfer;
4667 // Define drop effect
4668 dataTransfer.dropEffect = 'none';
4669 dataTransfer.effectAllowed = 'move';
4670 // We must set up a dataTransfer data property or Firefox seems to
4671 // ignore the fact the element is draggable.
4672 try {
4673 dataTransfer.setData( 'application-x/OOjs-UI-draggable', this.getIndex() );
4674 } catch ( err ) {
4675 // The above is only for firefox. No need to set a catch clause
4676 // if it fails, move on.
4677 }
4678 // Add dragging class
4679 this.$element.addClass( 'oo-ui-draggableElement-dragging' );
4680 // Emit event
4681 this.emit( 'dragstart', this );
4682 return true;
4683 };
4684
4685 /**
4686 * Respond to dragend event.
4687 *
4688 * @private
4689 * @fires dragend
4690 */
4691 OO.ui.DraggableElement.prototype.onDragEnd = function () {
4692 this.$element.removeClass( 'oo-ui-draggableElement-dragging' );
4693 this.emit( 'dragend' );
4694 };
4695
4696 /**
4697 * Handle drop event.
4698 *
4699 * @private
4700 * @param {jQuery.Event} event jQuery event
4701 * @fires drop
4702 */
4703 OO.ui.DraggableElement.prototype.onDrop = function ( e ) {
4704 e.preventDefault();
4705 this.emit( 'drop', e );
4706 };
4707
4708 /**
4709 * In order for drag/drop to work, the dragover event must
4710 * return false and stop propogation.
4711 *
4712 * @private
4713 */
4714 OO.ui.DraggableElement.prototype.onDragOver = function ( e ) {
4715 e.preventDefault();
4716 };
4717
4718 /**
4719 * Set item index.
4720 * Store it in the DOM so we can access from the widget drag event
4721 *
4722 * @private
4723 * @param {number} Item index
4724 */
4725 OO.ui.DraggableElement.prototype.setIndex = function ( index ) {
4726 if ( this.index !== index ) {
4727 this.index = index;
4728 this.$element.data( 'index', index );
4729 }
4730 };
4731
4732 /**
4733 * Get item index
4734 *
4735 * @private
4736 * @return {number} Item index
4737 */
4738 OO.ui.DraggableElement.prototype.getIndex = function () {
4739 return this.index;
4740 };
4741
4742 /**
4743 * DraggableGroupElement is a mixin class used to create a group element to
4744 * contain draggable elements, which are items that can be clicked and dragged by a mouse.
4745 * The class is used with OO.ui.DraggableElement.
4746 *
4747 * @abstract
4748 * @class
4749 * @mixins OO.ui.GroupElement
4750 *
4751 * @constructor
4752 * @param {Object} [config] Configuration options
4753 * @cfg {string} [orientation] Item orientation: 'horizontal' or 'vertical'. The orientation
4754 * should match the layout of the items. Items displayed in a single row
4755 * or in several rows should use horizontal orientation. The vertical orientation should only be
4756 * used when the items are displayed in a single column. Defaults to 'vertical'
4757 */
4758 OO.ui.DraggableGroupElement = function OoUiDraggableGroupElement( config ) {
4759 // Configuration initialization
4760 config = config || {};
4761
4762 // Parent constructor
4763 OO.ui.GroupElement.call( this, config );
4764
4765 // Properties
4766 this.orientation = config.orientation || 'vertical';
4767 this.dragItem = null;
4768 this.itemDragOver = null;
4769 this.itemKeys = {};
4770 this.sideInsertion = '';
4771
4772 // Events
4773 this.aggregate( {
4774 dragstart: 'itemDragStart',
4775 dragend: 'itemDragEnd',
4776 drop: 'itemDrop'
4777 } );
4778 this.connect( this, {
4779 itemDragStart: 'onItemDragStart',
4780 itemDrop: 'onItemDrop',
4781 itemDragEnd: 'onItemDragEnd'
4782 } );
4783 this.$element.on( {
4784 dragover: $.proxy( this.onDragOver, this ),
4785 dragleave: $.proxy( this.onDragLeave, this )
4786 } );
4787
4788 // Initialize
4789 if ( Array.isArray( config.items ) ) {
4790 this.addItems( config.items );
4791 }
4792 this.$placeholder = $( '<div>' )
4793 .addClass( 'oo-ui-draggableGroupElement-placeholder' );
4794 this.$element
4795 .addClass( 'oo-ui-draggableGroupElement' )
4796 .append( this.$status )
4797 .toggleClass( 'oo-ui-draggableGroupElement-horizontal', this.orientation === 'horizontal' )
4798 .prepend( this.$placeholder );
4799 };
4800
4801 /* Setup */
4802 OO.mixinClass( OO.ui.DraggableGroupElement, OO.ui.GroupElement );
4803
4804 /* Events */
4805
4806 /**
4807 * A 'reorder' event is emitted when the order of items in the group changes.
4808 *
4809 * @event reorder
4810 * @param {OO.ui.DraggableElement} item Reordered item
4811 * @param {number} [newIndex] New index for the item
4812 */
4813
4814 /* Methods */
4815
4816 /**
4817 * Respond to item drag start event
4818 *
4819 * @private
4820 * @param {OO.ui.DraggableElement} item Dragged item
4821 */
4822 OO.ui.DraggableGroupElement.prototype.onItemDragStart = function ( item ) {
4823 var i, len;
4824
4825 // Map the index of each object
4826 for ( i = 0, len = this.items.length; i < len; i++ ) {
4827 this.items[ i ].setIndex( i );
4828 }
4829
4830 if ( this.orientation === 'horizontal' ) {
4831 // Set the height of the indicator
4832 this.$placeholder.css( {
4833 height: item.$element.outerHeight(),
4834 width: 2
4835 } );
4836 } else {
4837 // Set the width of the indicator
4838 this.$placeholder.css( {
4839 height: 2,
4840 width: item.$element.outerWidth()
4841 } );
4842 }
4843 this.setDragItem( item );
4844 };
4845
4846 /**
4847 * Respond to item drag end event
4848 *
4849 * @private
4850 */
4851 OO.ui.DraggableGroupElement.prototype.onItemDragEnd = function () {
4852 this.unsetDragItem();
4853 return false;
4854 };
4855
4856 /**
4857 * Handle drop event and switch the order of the items accordingly
4858 *
4859 * @private
4860 * @param {OO.ui.DraggableElement} item Dropped item
4861 * @fires reorder
4862 */
4863 OO.ui.DraggableGroupElement.prototype.onItemDrop = function ( item ) {
4864 var toIndex = item.getIndex();
4865 // Check if the dropped item is from the current group
4866 // TODO: Figure out a way to configure a list of legally droppable
4867 // elements even if they are not yet in the list
4868 if ( this.getDragItem() ) {
4869 // If the insertion point is 'after', the insertion index
4870 // is shifted to the right (or to the left in RTL, hence 'after')
4871 if ( this.sideInsertion === 'after' ) {
4872 toIndex++;
4873 }
4874 // Emit change event
4875 this.emit( 'reorder', this.getDragItem(), toIndex );
4876 }
4877 this.unsetDragItem();
4878 // Return false to prevent propogation
4879 return false;
4880 };
4881
4882 /**
4883 * Handle dragleave event.
4884 *
4885 * @private
4886 */
4887 OO.ui.DraggableGroupElement.prototype.onDragLeave = function () {
4888 // This means the item was dragged outside the widget
4889 this.$placeholder
4890 .css( 'left', 0 )
4891 .addClass( 'oo-ui-element-hidden' );
4892 };
4893
4894 /**
4895 * Respond to dragover event
4896 *
4897 * @private
4898 * @param {jQuery.Event} event Event details
4899 */
4900 OO.ui.DraggableGroupElement.prototype.onDragOver = function ( e ) {
4901 var dragOverObj, $optionWidget, itemOffset, itemMidpoint, itemBoundingRect,
4902 itemSize, cssOutput, dragPosition, itemIndex, itemPosition,
4903 clientX = e.originalEvent.clientX,
4904 clientY = e.originalEvent.clientY;
4905
4906 // Get the OptionWidget item we are dragging over
4907 dragOverObj = this.getElementDocument().elementFromPoint( clientX, clientY );
4908 $optionWidget = $( dragOverObj ).closest( '.oo-ui-draggableElement' );
4909 if ( $optionWidget[ 0 ] ) {
4910 itemOffset = $optionWidget.offset();
4911 itemBoundingRect = $optionWidget[ 0 ].getBoundingClientRect();
4912 itemPosition = $optionWidget.position();
4913 itemIndex = $optionWidget.data( 'index' );
4914 }
4915
4916 if (
4917 itemOffset &&
4918 this.isDragging() &&
4919 itemIndex !== this.getDragItem().getIndex()
4920 ) {
4921 if ( this.orientation === 'horizontal' ) {
4922 // Calculate where the mouse is relative to the item width
4923 itemSize = itemBoundingRect.width;
4924 itemMidpoint = itemBoundingRect.left + itemSize / 2;
4925 dragPosition = clientX;
4926 // Which side of the item we hover over will dictate
4927 // where the placeholder will appear, on the left or
4928 // on the right
4929 cssOutput = {
4930 left: dragPosition < itemMidpoint ? itemPosition.left : itemPosition.left + itemSize,
4931 top: itemPosition.top
4932 };
4933 } else {
4934 // Calculate where the mouse is relative to the item height
4935 itemSize = itemBoundingRect.height;
4936 itemMidpoint = itemBoundingRect.top + itemSize / 2;
4937 dragPosition = clientY;
4938 // Which side of the item we hover over will dictate
4939 // where the placeholder will appear, on the top or
4940 // on the bottom
4941 cssOutput = {
4942 top: dragPosition < itemMidpoint ? itemPosition.top : itemPosition.top + itemSize,
4943 left: itemPosition.left
4944 };
4945 }
4946 // Store whether we are before or after an item to rearrange
4947 // For horizontal layout, we need to account for RTL, as this is flipped
4948 if ( this.orientation === 'horizontal' && this.$element.css( 'direction' ) === 'rtl' ) {
4949 this.sideInsertion = dragPosition < itemMidpoint ? 'after' : 'before';
4950 } else {
4951 this.sideInsertion = dragPosition < itemMidpoint ? 'before' : 'after';
4952 }
4953 // Add drop indicator between objects
4954 this.$placeholder
4955 .css( cssOutput )
4956 .removeClass( 'oo-ui-element-hidden' );
4957 } else {
4958 // This means the item was dragged outside the widget
4959 this.$placeholder
4960 .css( 'left', 0 )
4961 .addClass( 'oo-ui-element-hidden' );
4962 }
4963 // Prevent default
4964 e.preventDefault();
4965 };
4966
4967 /**
4968 * Set a dragged item
4969 *
4970 * @param {OO.ui.DraggableElement} item Dragged item
4971 */
4972 OO.ui.DraggableGroupElement.prototype.setDragItem = function ( item ) {
4973 this.dragItem = item;
4974 };
4975
4976 /**
4977 * Unset the current dragged item
4978 */
4979 OO.ui.DraggableGroupElement.prototype.unsetDragItem = function () {
4980 this.dragItem = null;
4981 this.itemDragOver = null;
4982 this.$placeholder.addClass( 'oo-ui-element-hidden' );
4983 this.sideInsertion = '';
4984 };
4985
4986 /**
4987 * Get the item that is currently being dragged.
4988 *
4989 * @return {OO.ui.DraggableElement|null} The currently dragged item, or `null` if no item is being dragged
4990 */
4991 OO.ui.DraggableGroupElement.prototype.getDragItem = function () {
4992 return this.dragItem;
4993 };
4994
4995 /**
4996 * Check if an item in the group is currently being dragged.
4997 *
4998 * @return {Boolean} Item is being dragged
4999 */
5000 OO.ui.DraggableGroupElement.prototype.isDragging = function () {
5001 return this.getDragItem() !== null;
5002 };
5003
5004 /**
5005 * IconElement is often mixed into other classes to generate an icon.
5006 * Icons are graphics, about the size of normal text. They are used to aid the user
5007 * in locating a control or to convey information in a space-efficient way. See the
5008 * [OOjs UI documentation on MediaWiki] [1] for a list of icons
5009 * included in the library.
5010 *
5011 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Icons,_Indicators,_and_Labels#Icons
5012 *
5013 * @abstract
5014 * @class
5015 *
5016 * @constructor
5017 * @param {Object} [config] Configuration options
5018 * @cfg {jQuery} [$icon] The icon element created by the class. If this configuration is omitted,
5019 * the icon element will use a generated `<span>`. To use a different HTML tag, or to specify that
5020 * the icon element be set to an existing icon instead of the one generated by this class, set a
5021 * value using a jQuery selection. For example:
5022 *
5023 * // Use a <div> tag instead of a <span>
5024 * $icon: $("<div>")
5025 * // Use an existing icon element instead of the one generated by the class
5026 * $icon: this.$element
5027 * // Use an icon element from a child widget
5028 * $icon: this.childwidget.$element
5029 * @cfg {Object|string} [icon=''] The symbolic name of the icon (e.g., ‘remove’ or ‘menu’), or a map of
5030 * symbolic names. A map is used for i18n purposes and contains a `default` icon
5031 * name and additional names keyed by language code. The `default` name is used when no icon is keyed
5032 * by the user's language.
5033 *
5034 * Example of an i18n map:
5035 *
5036 * { default: 'bold-a', en: 'bold-b', de: 'bold-f' }
5037 * See the [OOjs UI documentation on MediaWiki] [2] for a list of icons included in the library.
5038 * [2]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Icons,_Indicators,_and_Labels#Icons
5039 * @cfg {string|Function} [iconTitle] A text string used as the icon title, or a function that returns title
5040 * text. The icon title is displayed when users move the mouse over the icon.
5041 */
5042 OO.ui.IconElement = function OoUiIconElement( config ) {
5043 // Configuration initialization
5044 config = config || {};
5045
5046 // Properties
5047 this.$icon = null;
5048 this.icon = null;
5049 this.iconTitle = null;
5050
5051 // Initialization
5052 this.setIcon( config.icon || this.constructor.static.icon );
5053 this.setIconTitle( config.iconTitle || this.constructor.static.iconTitle );
5054 this.setIconElement( config.$icon || $( '<span>' ) );
5055 };
5056
5057 /* Setup */
5058
5059 OO.initClass( OO.ui.IconElement );
5060
5061 /* Static Properties */
5062
5063 /**
5064 * The symbolic name of the icon (e.g., ‘remove’ or ‘menu’), or a map of symbolic names. A map is used
5065 * for i18n purposes and contains a `default` icon name and additional names keyed by
5066 * language code. The `default` name is used when no icon is keyed by the user's language.
5067 *
5068 * Example of an i18n map:
5069 *
5070 * { default: 'bold-a', en: 'bold-b', de: 'bold-f' }
5071 *
5072 * Note: the static property will be overridden if the #icon configuration is used.
5073 *
5074 * @static
5075 * @inheritable
5076 * @property {Object|string}
5077 */
5078 OO.ui.IconElement.static.icon = null;
5079
5080 /**
5081 * The icon title, displayed when users move the mouse over the icon. The value can be text, a
5082 * function that returns title text, or `null` for no title.
5083 *
5084 * The static property will be overridden if the #iconTitle configuration is used.
5085 *
5086 * @static
5087 * @inheritable
5088 * @property {string|Function|null}
5089 */
5090 OO.ui.IconElement.static.iconTitle = null;
5091
5092 /* Methods */
5093
5094 /**
5095 * Set the icon element. This method is used to retarget an icon mixin so that its functionality
5096 * applies to the specified icon element instead of the one created by the class. If an icon
5097 * element is already set, the mixin’s effect on that element is removed. Generated CSS classes
5098 * and mixin methods will no longer affect the element.
5099 *
5100 * @param {jQuery} $icon Element to use as icon
5101 */
5102 OO.ui.IconElement.prototype.setIconElement = function ( $icon ) {
5103 if ( this.$icon ) {
5104 this.$icon
5105 .removeClass( 'oo-ui-iconElement-icon oo-ui-icon-' + this.icon )
5106 .removeAttr( 'title' );
5107 }
5108
5109 this.$icon = $icon
5110 .addClass( 'oo-ui-iconElement-icon' )
5111 .toggleClass( 'oo-ui-icon-' + this.icon, !!this.icon );
5112 if ( this.iconTitle !== null ) {
5113 this.$icon.attr( 'title', this.iconTitle );
5114 }
5115 };
5116
5117 /**
5118 * Set icon by symbolic name (e.g., ‘remove’ or ‘menu’). Use `null` to remove an icon.
5119 * The icon parameter can also be set to a map of icon names. See the #icon config setting
5120 * for an example.
5121 *
5122 * @param {Object|string|null} icon A symbolic icon name, a {@link #icon map of icon names} keyed
5123 * by language code, or `null` to remove the icon.
5124 * @chainable
5125 */
5126 OO.ui.IconElement.prototype.setIcon = function ( icon ) {
5127 icon = OO.isPlainObject( icon ) ? OO.ui.getLocalValue( icon, null, 'default' ) : icon;
5128 icon = typeof icon === 'string' && icon.trim().length ? icon.trim() : null;
5129
5130 if ( this.icon !== icon ) {
5131 if ( this.$icon ) {
5132 if ( this.icon !== null ) {
5133 this.$icon.removeClass( 'oo-ui-icon-' + this.icon );
5134 }
5135 if ( icon !== null ) {
5136 this.$icon.addClass( 'oo-ui-icon-' + icon );
5137 }
5138 }
5139 this.icon = icon;
5140 }
5141
5142 this.$element.toggleClass( 'oo-ui-iconElement', !!this.icon );
5143 this.updateThemeClasses();
5144
5145 return this;
5146 };
5147
5148 /**
5149 * Set the icon title. Use `null` to remove the title.
5150 *
5151 * @param {string|Function|null} iconTitle A text string used as the icon title,
5152 * a function that returns title text, or `null` for no title.
5153 * @chainable
5154 */
5155 OO.ui.IconElement.prototype.setIconTitle = function ( iconTitle ) {
5156 iconTitle = typeof iconTitle === 'function' ||
5157 ( typeof iconTitle === 'string' && iconTitle.length ) ?
5158 OO.ui.resolveMsg( iconTitle ) : null;
5159
5160 if ( this.iconTitle !== iconTitle ) {
5161 this.iconTitle = iconTitle;
5162 if ( this.$icon ) {
5163 if ( this.iconTitle !== null ) {
5164 this.$icon.attr( 'title', iconTitle );
5165 } else {
5166 this.$icon.removeAttr( 'title' );
5167 }
5168 }
5169 }
5170
5171 return this;
5172 };
5173
5174 /**
5175 * Get the symbolic name of the icon.
5176 *
5177 * @return {string} Icon name
5178 */
5179 OO.ui.IconElement.prototype.getIcon = function () {
5180 return this.icon;
5181 };
5182
5183 /**
5184 * Get the icon title. The title text is displayed when a user moves the mouse over the icon.
5185 *
5186 * @return {string} Icon title text
5187 */
5188 OO.ui.IconElement.prototype.getIconTitle = function () {
5189 return this.iconTitle;
5190 };
5191
5192 /**
5193 * IndicatorElement is often mixed into other classes to generate an indicator.
5194 * Indicators are small graphics that are generally used in two ways:
5195 *
5196 * - To draw attention to the status of an item. For example, an indicator might be
5197 * used to show that an item in a list has errors that need to be resolved.
5198 * - To clarify the function of a control that acts in an exceptional way (a button
5199 * that opens a menu instead of performing an action directly, for example).
5200 *
5201 * For a list of indicators included in the library, please see the
5202 * [OOjs UI documentation on MediaWiki] [1].
5203 *
5204 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Icons,_Indicators,_and_Labels#Indicators
5205 *
5206 * @abstract
5207 * @class
5208 *
5209 * @constructor
5210 * @param {Object} [config] Configuration options
5211 * @cfg {jQuery} [$indicator] The indicator element created by the class. If this
5212 * configuration is omitted, the indicator element will use a generated `<span>`.
5213 * @cfg {string} [indicator] Symbolic name of the indicator (e.g., ‘alert’ or ‘down’).
5214 * See the [OOjs UI documentation on MediaWiki][2] for a list of indicators included
5215 * in the library.
5216 * [2]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Icons,_Indicators,_and_Labels#Indicators
5217 * @cfg {string|Function} [indicatorTitle] A text string used as the indicator title,
5218 * or a function that returns title text. The indicator title is displayed when users move
5219 * the mouse over the indicator.
5220 */
5221 OO.ui.IndicatorElement = function OoUiIndicatorElement( config ) {
5222 // Configuration initialization
5223 config = config || {};
5224
5225 // Properties
5226 this.$indicator = null;
5227 this.indicator = null;
5228 this.indicatorTitle = null;
5229
5230 // Initialization
5231 this.setIndicator( config.indicator || this.constructor.static.indicator );
5232 this.setIndicatorTitle( config.indicatorTitle || this.constructor.static.indicatorTitle );
5233 this.setIndicatorElement( config.$indicator || $( '<span>' ) );
5234 };
5235
5236 /* Setup */
5237
5238 OO.initClass( OO.ui.IndicatorElement );
5239
5240 /* Static Properties */
5241
5242 /**
5243 * Symbolic name of the indicator (e.g., ‘alert’ or ‘down’).
5244 * The static property will be overridden if the #indicator configuration is used.
5245 *
5246 * @static
5247 * @inheritable
5248 * @property {string|null}
5249 */
5250 OO.ui.IndicatorElement.static.indicator = null;
5251
5252 /**
5253 * A text string used as the indicator title, a function that returns title text, or `null`
5254 * for no title. The static property will be overridden if the #indicatorTitle configuration is used.
5255 *
5256 * @static
5257 * @inheritable
5258 * @property {string|Function|null}
5259 */
5260 OO.ui.IndicatorElement.static.indicatorTitle = null;
5261
5262 /* Methods */
5263
5264 /**
5265 * Set the indicator element.
5266 *
5267 * If an element is already set, it will be cleaned up before setting up the new element.
5268 *
5269 * @param {jQuery} $indicator Element to use as indicator
5270 */
5271 OO.ui.IndicatorElement.prototype.setIndicatorElement = function ( $indicator ) {
5272 if ( this.$indicator ) {
5273 this.$indicator
5274 .removeClass( 'oo-ui-indicatorElement-indicator oo-ui-indicator-' + this.indicator )
5275 .removeAttr( 'title' );
5276 }
5277
5278 this.$indicator = $indicator
5279 .addClass( 'oo-ui-indicatorElement-indicator' )
5280 .toggleClass( 'oo-ui-indicator-' + this.indicator, !!this.indicator );
5281 if ( this.indicatorTitle !== null ) {
5282 this.$indicator.attr( 'title', this.indicatorTitle );
5283 }
5284 };
5285
5286 /**
5287 * Set the indicator by its symbolic name: ‘alert’, ‘down’, ‘next’, ‘previous’, ‘required’, ‘up’. Use `null` to remove the indicator.
5288 *
5289 * @param {string|null} indicator Symbolic name of indicator, or `null` for no indicator
5290 * @chainable
5291 */
5292 OO.ui.IndicatorElement.prototype.setIndicator = function ( indicator ) {
5293 indicator = typeof indicator === 'string' && indicator.length ? indicator.trim() : null;
5294
5295 if ( this.indicator !== indicator ) {
5296 if ( this.$indicator ) {
5297 if ( this.indicator !== null ) {
5298 this.$indicator.removeClass( 'oo-ui-indicator-' + this.indicator );
5299 }
5300 if ( indicator !== null ) {
5301 this.$indicator.addClass( 'oo-ui-indicator-' + indicator );
5302 }
5303 }
5304 this.indicator = indicator;
5305 }
5306
5307 this.$element.toggleClass( 'oo-ui-indicatorElement', !!this.indicator );
5308 this.updateThemeClasses();
5309
5310 return this;
5311 };
5312
5313 /**
5314 * Set the indicator title.
5315 *
5316 * The title is displayed when a user moves the mouse over the indicator.
5317 *
5318 * @param {string|Function|null} indicator Indicator title text, a function that returns text, or
5319 * `null` for no indicator title
5320 * @chainable
5321 */
5322 OO.ui.IndicatorElement.prototype.setIndicatorTitle = function ( indicatorTitle ) {
5323 indicatorTitle = typeof indicatorTitle === 'function' ||
5324 ( typeof indicatorTitle === 'string' && indicatorTitle.length ) ?
5325 OO.ui.resolveMsg( indicatorTitle ) : null;
5326
5327 if ( this.indicatorTitle !== indicatorTitle ) {
5328 this.indicatorTitle = indicatorTitle;
5329 if ( this.$indicator ) {
5330 if ( this.indicatorTitle !== null ) {
5331 this.$indicator.attr( 'title', indicatorTitle );
5332 } else {
5333 this.$indicator.removeAttr( 'title' );
5334 }
5335 }
5336 }
5337
5338 return this;
5339 };
5340
5341 /**
5342 * Get the symbolic name of the indicator (e.g., ‘alert’ or ‘down’).
5343 *
5344 * @return {string} Symbolic name of indicator
5345 */
5346 OO.ui.IndicatorElement.prototype.getIndicator = function () {
5347 return this.indicator;
5348 };
5349
5350 /**
5351 * Get the indicator title.
5352 *
5353 * The title is displayed when a user moves the mouse over the indicator.
5354 *
5355 * @return {string} Indicator title text
5356 */
5357 OO.ui.IndicatorElement.prototype.getIndicatorTitle = function () {
5358 return this.indicatorTitle;
5359 };
5360
5361 /**
5362 * LabelElement is often mixed into other classes to generate a label, which
5363 * helps identify the function of an interface element.
5364 * See the [OOjs UI documentation on MediaWiki] [1] for more information.
5365 *
5366 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Icons,_Indicators,_and_Labels#Labels
5367 *
5368 * @abstract
5369 * @class
5370 *
5371 * @constructor
5372 * @param {Object} [config] Configuration options
5373 * @cfg {jQuery} [$label] The label element created by the class. If this
5374 * configuration is omitted, the label element will use a generated `<span>`.
5375 * @cfg {jQuery|string|Function|OO.ui.HtmlSnippet} [label] The label text. The label can be specified
5376 * as a plaintext string, a jQuery selection of elements, or a function that will produce a string
5377 * in the future. See the [OOjs UI documentation on MediaWiki] [2] for examples.
5378 * [2]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Icons,_Indicators,_and_Labels#Labels
5379 * @cfg {boolean} [autoFitLabel=true] Fit the label to the width of the parent element.
5380 * The label will be truncated to fit if necessary.
5381 */
5382 OO.ui.LabelElement = function OoUiLabelElement( config ) {
5383 // Configuration initialization
5384 config = config || {};
5385
5386 // Properties
5387 this.$label = null;
5388 this.label = null;
5389 this.autoFitLabel = config.autoFitLabel === undefined || !!config.autoFitLabel;
5390
5391 // Initialization
5392 this.setLabel( config.label || this.constructor.static.label );
5393 this.setLabelElement( config.$label || $( '<span>' ) );
5394 };
5395
5396 /* Setup */
5397
5398 OO.initClass( OO.ui.LabelElement );
5399
5400 /* Events */
5401
5402 /**
5403 * @event labelChange
5404 * @param {string} value
5405 */
5406
5407 /* Static Properties */
5408
5409 /**
5410 * The label text. The label can be specified as a plaintext string, a function that will
5411 * produce a string in the future, or `null` for no label. The static value will
5412 * be overridden if a label is specified with the #label config option.
5413 *
5414 * @static
5415 * @inheritable
5416 * @property {string|Function|null}
5417 */
5418 OO.ui.LabelElement.static.label = null;
5419
5420 /* Methods */
5421
5422 /**
5423 * Set the label element.
5424 *
5425 * If an element is already set, it will be cleaned up before setting up the new element.
5426 *
5427 * @param {jQuery} $label Element to use as label
5428 */
5429 OO.ui.LabelElement.prototype.setLabelElement = function ( $label ) {
5430 if ( this.$label ) {
5431 this.$label.removeClass( 'oo-ui-labelElement-label' ).empty();
5432 }
5433
5434 this.$label = $label.addClass( 'oo-ui-labelElement-label' );
5435 this.setLabelContent( this.label );
5436 };
5437
5438 /**
5439 * Set the label.
5440 *
5441 * An empty string will result in the label being hidden. A string containing only whitespace will
5442 * be converted to a single `&nbsp;`.
5443 *
5444 * @param {jQuery|string|OO.ui.HtmlSnippet|Function|null} label Label nodes; text; a function that returns nodes or
5445 * text; or null for no label
5446 * @chainable
5447 */
5448 OO.ui.LabelElement.prototype.setLabel = function ( label ) {
5449 label = typeof label === 'function' ? OO.ui.resolveMsg( label ) : label;
5450 label = ( ( typeof label === 'string' && label.length ) || label instanceof jQuery || label instanceof OO.ui.HtmlSnippet ) ? label : null;
5451
5452 this.$element.toggleClass( 'oo-ui-labelElement', !!label );
5453
5454 if ( this.label !== label ) {
5455 if ( this.$label ) {
5456 this.setLabelContent( label );
5457 }
5458 this.label = label;
5459 this.emit( 'labelChange' );
5460 }
5461
5462 return this;
5463 };
5464
5465 /**
5466 * Get the label.
5467 *
5468 * @return {jQuery|string|Function|null} Label nodes; text; a function that returns nodes or
5469 * text; or null for no label
5470 */
5471 OO.ui.LabelElement.prototype.getLabel = function () {
5472 return this.label;
5473 };
5474
5475 /**
5476 * Fit the label.
5477 *
5478 * @chainable
5479 */
5480 OO.ui.LabelElement.prototype.fitLabel = function () {
5481 if ( this.$label && this.$label.autoEllipsis && this.autoFitLabel ) {
5482 this.$label.autoEllipsis( { hasSpan: false, tooltip: true } );
5483 }
5484
5485 return this;
5486 };
5487
5488 /**
5489 * Set the content of the label.
5490 *
5491 * Do not call this method until after the label element has been set by #setLabelElement.
5492 *
5493 * @private
5494 * @param {jQuery|string|Function|null} label Label nodes; text; a function that returns nodes or
5495 * text; or null for no label
5496 */
5497 OO.ui.LabelElement.prototype.setLabelContent = function ( label ) {
5498 if ( typeof label === 'string' ) {
5499 if ( label.match( /^\s*$/ ) ) {
5500 // Convert whitespace only string to a single non-breaking space
5501 this.$label.html( '&nbsp;' );
5502 } else {
5503 this.$label.text( label );
5504 }
5505 } else if ( label instanceof OO.ui.HtmlSnippet ) {
5506 this.$label.html( label.toString() );
5507 } else if ( label instanceof jQuery ) {
5508 this.$label.empty().append( label );
5509 } else {
5510 this.$label.empty();
5511 }
5512 };
5513
5514 /**
5515 * LookupElement is a mixin that creates a {@link OO.ui.TextInputMenuSelectWidget menu} of suggested values for
5516 * a {@link OO.ui.TextInputWidget text input widget}. Suggested values are based on the characters the user types
5517 * into the text input field and, in general, the menu is only displayed when the user types. If a suggested value is chosen
5518 * from the lookup menu, that value becomes the value of the input field.
5519 *
5520 * Note that a new menu of suggested items is displayed when a value is chosen from the lookup menu. If this is
5521 * not the desired behavior, disable lookup menus with the #setLookupsDisabled method, then set the value, then
5522 * re-enable lookups.
5523 *
5524 * See the [OOjs UI demos][1] for an example.
5525 *
5526 * [1]: https://tools.wmflabs.org/oojs-ui/oojs-ui/demos/index.html#widgets-apex-vector-ltr
5527 *
5528 * @class
5529 * @abstract
5530 *
5531 * @constructor
5532 * @param {Object} [config] Configuration options
5533 * @cfg {jQuery} [$overlay] Overlay for the lookup menu; defaults to relative positioning
5534 * @cfg {jQuery} [$container=this.$element] The container element. The lookup menu is rendered beneath the specified element.
5535 * @cfg {boolean} [allowSuggestionsWhenEmpty=false] Request and display a lookup menu when the text input is empty.
5536 * By default, the lookup menu is not generated and displayed until the user begins to type.
5537 */
5538 OO.ui.LookupElement = function OoUiLookupElement( config ) {
5539 // Configuration initialization
5540 config = config || {};
5541
5542 // Properties
5543 this.$overlay = config.$overlay || this.$element;
5544 this.lookupMenu = new OO.ui.TextInputMenuSelectWidget( this, {
5545 widget: this,
5546 input: this,
5547 $container: config.$container
5548 } );
5549
5550 this.allowSuggestionsWhenEmpty = config.allowSuggestionsWhenEmpty || false;
5551
5552 this.lookupCache = {};
5553 this.lookupQuery = null;
5554 this.lookupRequest = null;
5555 this.lookupsDisabled = false;
5556 this.lookupInputFocused = false;
5557
5558 // Events
5559 this.$input.on( {
5560 focus: this.onLookupInputFocus.bind( this ),
5561 blur: this.onLookupInputBlur.bind( this ),
5562 mousedown: this.onLookupInputMouseDown.bind( this )
5563 } );
5564 this.connect( this, { change: 'onLookupInputChange' } );
5565 this.lookupMenu.connect( this, {
5566 toggle: 'onLookupMenuToggle',
5567 choose: 'onLookupMenuItemChoose'
5568 } );
5569
5570 // Initialization
5571 this.$element.addClass( 'oo-ui-lookupElement' );
5572 this.lookupMenu.$element.addClass( 'oo-ui-lookupElement-menu' );
5573 this.$overlay.append( this.lookupMenu.$element );
5574 };
5575
5576 /* Methods */
5577
5578 /**
5579 * Handle input focus event.
5580 *
5581 * @protected
5582 * @param {jQuery.Event} e Input focus event
5583 */
5584 OO.ui.LookupElement.prototype.onLookupInputFocus = function () {
5585 this.lookupInputFocused = true;
5586 this.populateLookupMenu();
5587 };
5588
5589 /**
5590 * Handle input blur event.
5591 *
5592 * @protected
5593 * @param {jQuery.Event} e Input blur event
5594 */
5595 OO.ui.LookupElement.prototype.onLookupInputBlur = function () {
5596 this.closeLookupMenu();
5597 this.lookupInputFocused = false;
5598 };
5599
5600 /**
5601 * Handle input mouse down event.
5602 *
5603 * @protected
5604 * @param {jQuery.Event} e Input mouse down event
5605 */
5606 OO.ui.LookupElement.prototype.onLookupInputMouseDown = function () {
5607 // Only open the menu if the input was already focused.
5608 // This way we allow the user to open the menu again after closing it with Esc
5609 // by clicking in the input. Opening (and populating) the menu when initially
5610 // clicking into the input is handled by the focus handler.
5611 if ( this.lookupInputFocused && !this.lookupMenu.isVisible() ) {
5612 this.populateLookupMenu();
5613 }
5614 };
5615
5616 /**
5617 * Handle input change event.
5618 *
5619 * @protected
5620 * @param {string} value New input value
5621 */
5622 OO.ui.LookupElement.prototype.onLookupInputChange = function () {
5623 if ( this.lookupInputFocused ) {
5624 this.populateLookupMenu();
5625 }
5626 };
5627
5628 /**
5629 * Handle the lookup menu being shown/hidden.
5630 *
5631 * @protected
5632 * @param {boolean} visible Whether the lookup menu is now visible.
5633 */
5634 OO.ui.LookupElement.prototype.onLookupMenuToggle = function ( visible ) {
5635 if ( !visible ) {
5636 // When the menu is hidden, abort any active request and clear the menu.
5637 // This has to be done here in addition to closeLookupMenu(), because
5638 // MenuSelectWidget will close itself when the user presses Esc.
5639 this.abortLookupRequest();
5640 this.lookupMenu.clearItems();
5641 }
5642 };
5643
5644 /**
5645 * Handle menu item 'choose' event, updating the text input value to the value of the clicked item.
5646 *
5647 * @protected
5648 * @param {OO.ui.MenuOptionWidget} item Selected item
5649 */
5650 OO.ui.LookupElement.prototype.onLookupMenuItemChoose = function ( item ) {
5651 this.setValue( item.getData() );
5652 };
5653
5654 /**
5655 * Get lookup menu.
5656 *
5657 * @private
5658 * @return {OO.ui.TextInputMenuSelectWidget}
5659 */
5660 OO.ui.LookupElement.prototype.getLookupMenu = function () {
5661 return this.lookupMenu;
5662 };
5663
5664 /**
5665 * Disable or re-enable lookups.
5666 *
5667 * When lookups are disabled, calls to #populateLookupMenu will be ignored.
5668 *
5669 * @param {boolean} disabled Disable lookups
5670 */
5671 OO.ui.LookupElement.prototype.setLookupsDisabled = function ( disabled ) {
5672 this.lookupsDisabled = !!disabled;
5673 };
5674
5675 /**
5676 * Open the menu. If there are no entries in the menu, this does nothing.
5677 *
5678 * @private
5679 * @chainable
5680 */
5681 OO.ui.LookupElement.prototype.openLookupMenu = function () {
5682 if ( !this.lookupMenu.isEmpty() ) {
5683 this.lookupMenu.toggle( true );
5684 }
5685 return this;
5686 };
5687
5688 /**
5689 * Close the menu, empty it, and abort any pending request.
5690 *
5691 * @private
5692 * @chainable
5693 */
5694 OO.ui.LookupElement.prototype.closeLookupMenu = function () {
5695 this.lookupMenu.toggle( false );
5696 this.abortLookupRequest();
5697 this.lookupMenu.clearItems();
5698 return this;
5699 };
5700
5701 /**
5702 * Request menu items based on the input's current value, and when they arrive,
5703 * populate the menu with these items and show the menu.
5704 *
5705 * If lookups have been disabled with #setLookupsDisabled, this function does nothing.
5706 *
5707 * @private
5708 * @chainable
5709 */
5710 OO.ui.LookupElement.prototype.populateLookupMenu = function () {
5711 var widget = this,
5712 value = this.getValue();
5713
5714 if ( this.lookupsDisabled ) {
5715 return;
5716 }
5717
5718 // If the input is empty, clear the menu, unless suggestions when empty are allowed.
5719 if ( !this.allowSuggestionsWhenEmpty && value === '' ) {
5720 this.closeLookupMenu();
5721 // Skip population if there is already a request pending for the current value
5722 } else if ( value !== this.lookupQuery ) {
5723 this.getLookupMenuItems()
5724 .done( function ( items ) {
5725 widget.lookupMenu.clearItems();
5726 if ( items.length ) {
5727 widget.lookupMenu
5728 .addItems( items )
5729 .toggle( true );
5730 widget.initializeLookupMenuSelection();
5731 } else {
5732 widget.lookupMenu.toggle( false );
5733 }
5734 } )
5735 .fail( function () {
5736 widget.lookupMenu.clearItems();
5737 } );
5738 }
5739
5740 return this;
5741 };
5742
5743 /**
5744 * Highlight the first selectable item in the menu.
5745 *
5746 * @private
5747 * @chainable
5748 */
5749 OO.ui.LookupElement.prototype.initializeLookupMenuSelection = function () {
5750 if ( !this.lookupMenu.getSelectedItem() ) {
5751 this.lookupMenu.highlightItem( this.lookupMenu.getFirstSelectableItem() );
5752 }
5753 };
5754
5755 /**
5756 * Get lookup menu items for the current query.
5757 *
5758 * @private
5759 * @return {jQuery.Promise} Promise object which will be passed menu items as the first argument of
5760 * the done event. If the request was aborted to make way for a subsequent request, this promise
5761 * will not be rejected: it will remain pending forever.
5762 */
5763 OO.ui.LookupElement.prototype.getLookupMenuItems = function () {
5764 var widget = this,
5765 value = this.getValue(),
5766 deferred = $.Deferred(),
5767 ourRequest;
5768
5769 this.abortLookupRequest();
5770 if ( Object.prototype.hasOwnProperty.call( this.lookupCache, value ) ) {
5771 deferred.resolve( this.getLookupMenuOptionsFromData( this.lookupCache[ value ] ) );
5772 } else {
5773 this.pushPending();
5774 this.lookupQuery = value;
5775 ourRequest = this.lookupRequest = this.getLookupRequest();
5776 ourRequest
5777 .always( function () {
5778 // We need to pop pending even if this is an old request, otherwise
5779 // the widget will remain pending forever.
5780 // TODO: this assumes that an aborted request will fail or succeed soon after
5781 // being aborted, or at least eventually. It would be nice if we could popPending()
5782 // at abort time, but only if we knew that we hadn't already called popPending()
5783 // for that request.
5784 widget.popPending();
5785 } )
5786 .done( function ( response ) {
5787 // If this is an old request (and aborting it somehow caused it to still succeed),
5788 // ignore its success completely
5789 if ( ourRequest === widget.lookupRequest ) {
5790 widget.lookupQuery = null;
5791 widget.lookupRequest = null;
5792 widget.lookupCache[ value ] = widget.getLookupCacheDataFromResponse( response );
5793 deferred.resolve( widget.getLookupMenuOptionsFromData( widget.lookupCache[ value ] ) );
5794 }
5795 } )
5796 .fail( function () {
5797 // If this is an old request (or a request failing because it's being aborted),
5798 // ignore its failure completely
5799 if ( ourRequest === widget.lookupRequest ) {
5800 widget.lookupQuery = null;
5801 widget.lookupRequest = null;
5802 deferred.reject();
5803 }
5804 } );
5805 }
5806 return deferred.promise();
5807 };
5808
5809 /**
5810 * Abort the currently pending lookup request, if any.
5811 *
5812 * @private
5813 */
5814 OO.ui.LookupElement.prototype.abortLookupRequest = function () {
5815 var oldRequest = this.lookupRequest;
5816 if ( oldRequest ) {
5817 // First unset this.lookupRequest to the fail handler will notice
5818 // that the request is no longer current
5819 this.lookupRequest = null;
5820 this.lookupQuery = null;
5821 oldRequest.abort();
5822 }
5823 };
5824
5825 /**
5826 * Get a new request object of the current lookup query value.
5827 *
5828 * @protected
5829 * @abstract
5830 * @return {jQuery.Promise} jQuery AJAX object, or promise object with an .abort() method
5831 */
5832 OO.ui.LookupElement.prototype.getLookupRequest = function () {
5833 // Stub, implemented in subclass
5834 return null;
5835 };
5836
5837 /**
5838 * Pre-process data returned by the request from #getLookupRequest.
5839 *
5840 * The return value of this function will be cached, and any further queries for the given value
5841 * will use the cache rather than doing API requests.
5842 *
5843 * @protected
5844 * @abstract
5845 * @param {Mixed} response Response from server
5846 * @return {Mixed} Cached result data
5847 */
5848 OO.ui.LookupElement.prototype.getLookupCacheDataFromResponse = function () {
5849 // Stub, implemented in subclass
5850 return [];
5851 };
5852
5853 /**
5854 * Get a list of menu option widgets from the (possibly cached) data returned by
5855 * #getLookupCacheDataFromResponse.
5856 *
5857 * @protected
5858 * @abstract
5859 * @param {Mixed} data Cached result data, usually an array
5860 * @return {OO.ui.MenuOptionWidget[]} Menu items
5861 */
5862 OO.ui.LookupElement.prototype.getLookupMenuOptionsFromData = function () {
5863 // Stub, implemented in subclass
5864 return [];
5865 };
5866
5867 /**
5868 * PopupElement is mixed into other classes to generate a {@link OO.ui.PopupWidget popup widget}.
5869 * A popup is a container for content. It is overlaid and positioned absolutely. By default, each
5870 * popup has an anchor, which is an arrow-like protrusion that points toward the popup’s origin.
5871 * See {@link OO.ui.PopupWidget PopupWidget} for an example.
5872 *
5873 * @abstract
5874 * @class
5875 *
5876 * @constructor
5877 * @param {Object} [config] Configuration options
5878 * @cfg {Object} [popup] Configuration to pass to popup
5879 * @cfg {boolean} [popup.autoClose=true] Popup auto-closes when it loses focus
5880 */
5881 OO.ui.PopupElement = function OoUiPopupElement( config ) {
5882 // Configuration initialization
5883 config = config || {};
5884
5885 // Properties
5886 this.popup = new OO.ui.PopupWidget( $.extend(
5887 { autoClose: true },
5888 config.popup,
5889 { $autoCloseIgnore: this.$element }
5890 ) );
5891 };
5892
5893 /* Methods */
5894
5895 /**
5896 * Get popup.
5897 *
5898 * @return {OO.ui.PopupWidget} Popup widget
5899 */
5900 OO.ui.PopupElement.prototype.getPopup = function () {
5901 return this.popup;
5902 };
5903
5904 /**
5905 * The FlaggedElement class is an attribute mixin, meaning that it is used to add
5906 * additional functionality to an element created by another class. The class provides
5907 * a ‘flags’ property assigned the name (or an array of names) of styling flags,
5908 * which are used to customize the look and feel of a widget to better describe its
5909 * importance and functionality.
5910 *
5911 * The library currently contains the following styling flags for general use:
5912 *
5913 * - **progressive**: Progressive styling is applied to convey that the widget will move the user forward in a process.
5914 * - **destructive**: Destructive styling is applied to convey that the widget will remove something.
5915 * - **constructive**: Constructive styling is applied to convey that the widget will create something.
5916 *
5917 * The flags affect the appearance of the buttons:
5918 *
5919 * @example
5920 * // FlaggedElement is mixed into ButtonWidget to provide styling flags
5921 * var button1 = new OO.ui.ButtonWidget( {
5922 * label: 'Constructive',
5923 * flags: 'constructive'
5924 * } );
5925 * var button2 = new OO.ui.ButtonWidget( {
5926 * label: 'Destructive',
5927 * flags: 'destructive'
5928 * } );
5929 * var button3 = new OO.ui.ButtonWidget( {
5930 * label: 'Progressive',
5931 * flags: 'progressive'
5932 * } );
5933 * $( 'body' ).append( button1.$element, button2.$element, button3.$element );
5934 *
5935 * {@link OO.ui.ActionWidget ActionWidgets}, which are a special kind of button that execute an action, use these flags: **primary** and **safe**.
5936 * Please see the [OOjs UI documentation on MediaWiki] [1] for more information.
5937 *
5938 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Elements/Flagged
5939 *
5940 * @abstract
5941 * @class
5942 *
5943 * @constructor
5944 * @param {Object} [config] Configuration options
5945 * @cfg {string|string[]} [flags] The name or names of the flags (e.g., 'constructive' or 'primary') to apply.
5946 * Please see the [OOjs UI documentation on MediaWiki] [2] for more information about available flags.
5947 * [2]: https://www.mediawiki.org/wiki/OOjs_UI/Elements/Flagged
5948 * @cfg {jQuery} [$flagged] The flagged element. By default,
5949 * the flagged functionality is applied to the element created by the class ($element).
5950 * If a different element is specified, the flagged functionality will be applied to it instead.
5951 */
5952 OO.ui.FlaggedElement = function OoUiFlaggedElement( config ) {
5953 // Configuration initialization
5954 config = config || {};
5955
5956 // Properties
5957 this.flags = {};
5958 this.$flagged = null;
5959
5960 // Initialization
5961 this.setFlags( config.flags );
5962 this.setFlaggedElement( config.$flagged || this.$element );
5963 };
5964
5965 /* Events */
5966
5967 /**
5968 * @event flag
5969 * A flag event is emitted when the #clearFlags or #setFlags methods are used. The `changes`
5970 * parameter contains the name of each modified flag and indicates whether it was
5971 * added or removed.
5972 *
5973 * @param {Object.<string,boolean>} changes Object keyed by flag name. A Boolean `true` indicates
5974 * that the flag was added, `false` that the flag was removed.
5975 */
5976
5977 /* Methods */
5978
5979 /**
5980 * Set the flagged element.
5981 *
5982 * This method is used to retarget a flagged mixin so that its functionality applies to the specified element.
5983 * If an element is already set, the method will remove the mixin’s effect on that element.
5984 *
5985 * @param {jQuery} $flagged Element that should be flagged
5986 */
5987 OO.ui.FlaggedElement.prototype.setFlaggedElement = function ( $flagged ) {
5988 var classNames = Object.keys( this.flags ).map( function ( flag ) {
5989 return 'oo-ui-flaggedElement-' + flag;
5990 } ).join( ' ' );
5991
5992 if ( this.$flagged ) {
5993 this.$flagged.removeClass( classNames );
5994 }
5995
5996 this.$flagged = $flagged.addClass( classNames );
5997 };
5998
5999 /**
6000 * Check if the specified flag is set.
6001 *
6002 * @param {string} flag Name of flag
6003 * @return {boolean} The flag is set
6004 */
6005 OO.ui.FlaggedElement.prototype.hasFlag = function ( flag ) {
6006 return flag in this.flags;
6007 };
6008
6009 /**
6010 * Get the names of all flags set.
6011 *
6012 * @return {string[]} Flag names
6013 */
6014 OO.ui.FlaggedElement.prototype.getFlags = function () {
6015 return Object.keys( this.flags );
6016 };
6017
6018 /**
6019 * Clear all flags.
6020 *
6021 * @chainable
6022 * @fires flag
6023 */
6024 OO.ui.FlaggedElement.prototype.clearFlags = function () {
6025 var flag, className,
6026 changes = {},
6027 remove = [],
6028 classPrefix = 'oo-ui-flaggedElement-';
6029
6030 for ( flag in this.flags ) {
6031 className = classPrefix + flag;
6032 changes[ flag ] = false;
6033 delete this.flags[ flag ];
6034 remove.push( className );
6035 }
6036
6037 if ( this.$flagged ) {
6038 this.$flagged.removeClass( remove.join( ' ' ) );
6039 }
6040
6041 this.updateThemeClasses();
6042 this.emit( 'flag', changes );
6043
6044 return this;
6045 };
6046
6047 /**
6048 * Add one or more flags.
6049 *
6050 * @param {string|string[]|Object.<string, boolean>} flags A flag name, an array of flag names,
6051 * or an object keyed by flag name with a boolean value that indicates whether the flag should
6052 * be added (`true`) or removed (`false`).
6053 * @chainable
6054 * @fires flag
6055 */
6056 OO.ui.FlaggedElement.prototype.setFlags = function ( flags ) {
6057 var i, len, flag, className,
6058 changes = {},
6059 add = [],
6060 remove = [],
6061 classPrefix = 'oo-ui-flaggedElement-';
6062
6063 if ( typeof flags === 'string' ) {
6064 className = classPrefix + flags;
6065 // Set
6066 if ( !this.flags[ flags ] ) {
6067 this.flags[ flags ] = true;
6068 add.push( className );
6069 }
6070 } else if ( Array.isArray( flags ) ) {
6071 for ( i = 0, len = flags.length; i < len; i++ ) {
6072 flag = flags[ i ];
6073 className = classPrefix + flag;
6074 // Set
6075 if ( !this.flags[ flag ] ) {
6076 changes[ flag ] = true;
6077 this.flags[ flag ] = true;
6078 add.push( className );
6079 }
6080 }
6081 } else if ( OO.isPlainObject( flags ) ) {
6082 for ( flag in flags ) {
6083 className = classPrefix + flag;
6084 if ( flags[ flag ] ) {
6085 // Set
6086 if ( !this.flags[ flag ] ) {
6087 changes[ flag ] = true;
6088 this.flags[ flag ] = true;
6089 add.push( className );
6090 }
6091 } else {
6092 // Remove
6093 if ( this.flags[ flag ] ) {
6094 changes[ flag ] = false;
6095 delete this.flags[ flag ];
6096 remove.push( className );
6097 }
6098 }
6099 }
6100 }
6101
6102 if ( this.$flagged ) {
6103 this.$flagged
6104 .addClass( add.join( ' ' ) )
6105 .removeClass( remove.join( ' ' ) );
6106 }
6107
6108 this.updateThemeClasses();
6109 this.emit( 'flag', changes );
6110
6111 return this;
6112 };
6113
6114 /**
6115 * TitledElement is mixed into other classes to provide a `title` attribute.
6116 * Titles are rendered by the browser and are made visible when the user moves
6117 * the mouse over the element. Titles are not visible on touch devices.
6118 *
6119 * @example
6120 * // TitledElement provides a 'title' attribute to the
6121 * // ButtonWidget class
6122 * var button = new OO.ui.ButtonWidget( {
6123 * label: 'Button with Title',
6124 * title: 'I am a button'
6125 * } );
6126 * $( 'body' ).append( button.$element );
6127 *
6128 * @abstract
6129 * @class
6130 *
6131 * @constructor
6132 * @param {Object} [config] Configuration options
6133 * @cfg {jQuery} [$titled] The element to which the `title` attribute is applied.
6134 * If this config is omitted, the title functionality is applied to $element, the
6135 * element created by the class.
6136 * @cfg {string|Function} [title] The title text or a function that returns text. If
6137 * this config is omitted, the value of the {@link #static-title static title} property is used.
6138 */
6139 OO.ui.TitledElement = function OoUiTitledElement( config ) {
6140 // Configuration initialization
6141 config = config || {};
6142
6143 // Properties
6144 this.$titled = null;
6145 this.title = null;
6146
6147 // Initialization
6148 this.setTitle( config.title || this.constructor.static.title );
6149 this.setTitledElement( config.$titled || this.$element );
6150 };
6151
6152 /* Setup */
6153
6154 OO.initClass( OO.ui.TitledElement );
6155
6156 /* Static Properties */
6157
6158 /**
6159 * The title text, a function that returns text, or `null` for no title. The value of the static property
6160 * is overridden if the #title config option is used.
6161 *
6162 * @static
6163 * @inheritable
6164 * @property {string|Function|null}
6165 */
6166 OO.ui.TitledElement.static.title = null;
6167
6168 /* Methods */
6169
6170 /**
6171 * Set the titled element.
6172 *
6173 * This method is used to retarget a titledElement mixin so that its functionality applies to the specified element.
6174 * If an element is already set, the mixin’s effect on that element is removed before the new element is set up.
6175 *
6176 * @param {jQuery} $titled Element that should use the 'titled' functionality
6177 */
6178 OO.ui.TitledElement.prototype.setTitledElement = function ( $titled ) {
6179 if ( this.$titled ) {
6180 this.$titled.removeAttr( 'title' );
6181 }
6182
6183 this.$titled = $titled;
6184 if ( this.title ) {
6185 this.$titled.attr( 'title', this.title );
6186 }
6187 };
6188
6189 /**
6190 * Set title.
6191 *
6192 * @param {string|Function|null} title Title text, a function that returns text, or `null` for no title
6193 * @chainable
6194 */
6195 OO.ui.TitledElement.prototype.setTitle = function ( title ) {
6196 title = typeof title === 'string' ? OO.ui.resolveMsg( title ) : null;
6197
6198 if ( this.title !== title ) {
6199 if ( this.$titled ) {
6200 if ( title !== null ) {
6201 this.$titled.attr( 'title', title );
6202 } else {
6203 this.$titled.removeAttr( 'title' );
6204 }
6205 }
6206 this.title = title;
6207 }
6208
6209 return this;
6210 };
6211
6212 /**
6213 * Get title.
6214 *
6215 * @return {string} Title string
6216 */
6217 OO.ui.TitledElement.prototype.getTitle = function () {
6218 return this.title;
6219 };
6220
6221 /**
6222 * Element that can be automatically clipped to visible boundaries.
6223 *
6224 * Whenever the element's natural height changes, you have to call
6225 * #clip to make sure it's still clipping correctly.
6226 *
6227 * @abstract
6228 * @class
6229 *
6230 * @constructor
6231 * @param {Object} [config] Configuration options
6232 * @cfg {jQuery} [$clippable] Nodes to clip, assigned to #$clippable, omit to use #$element
6233 */
6234 OO.ui.ClippableElement = function OoUiClippableElement( config ) {
6235 // Configuration initialization
6236 config = config || {};
6237
6238 // Properties
6239 this.$clippable = null;
6240 this.clipping = false;
6241 this.clippedHorizontally = false;
6242 this.clippedVertically = false;
6243 this.$clippableContainer = null;
6244 this.$clippableScroller = null;
6245 this.$clippableWindow = null;
6246 this.idealWidth = null;
6247 this.idealHeight = null;
6248 this.onClippableContainerScrollHandler = this.clip.bind( this );
6249 this.onClippableWindowResizeHandler = this.clip.bind( this );
6250
6251 // Initialization
6252 this.setClippableElement( config.$clippable || this.$element );
6253 };
6254
6255 /* Methods */
6256
6257 /**
6258 * Set clippable element.
6259 *
6260 * If an element is already set, it will be cleaned up before setting up the new element.
6261 *
6262 * @param {jQuery} $clippable Element to make clippable
6263 */
6264 OO.ui.ClippableElement.prototype.setClippableElement = function ( $clippable ) {
6265 if ( this.$clippable ) {
6266 this.$clippable.removeClass( 'oo-ui-clippableElement-clippable' );
6267 this.$clippable.css( { width: '', height: '', overflowX: '', overflowY: '' } );
6268 OO.ui.Element.static.reconsiderScrollbars( this.$clippable[ 0 ] );
6269 }
6270
6271 this.$clippable = $clippable.addClass( 'oo-ui-clippableElement-clippable' );
6272 this.clip();
6273 };
6274
6275 /**
6276 * Toggle clipping.
6277 *
6278 * Do not turn clipping on until after the element is attached to the DOM and visible.
6279 *
6280 * @param {boolean} [clipping] Enable clipping, omit to toggle
6281 * @chainable
6282 */
6283 OO.ui.ClippableElement.prototype.toggleClipping = function ( clipping ) {
6284 clipping = clipping === undefined ? !this.clipping : !!clipping;
6285
6286 if ( this.clipping !== clipping ) {
6287 this.clipping = clipping;
6288 if ( clipping ) {
6289 this.$clippableContainer = $( this.getClosestScrollableElementContainer() );
6290 // If the clippable container is the root, we have to listen to scroll events and check
6291 // jQuery.scrollTop on the window because of browser inconsistencies
6292 this.$clippableScroller = this.$clippableContainer.is( 'html, body' ) ?
6293 $( OO.ui.Element.static.getWindow( this.$clippableContainer ) ) :
6294 this.$clippableContainer;
6295 this.$clippableScroller.on( 'scroll', this.onClippableContainerScrollHandler );
6296 this.$clippableWindow = $( this.getElementWindow() )
6297 .on( 'resize', this.onClippableWindowResizeHandler );
6298 // Initial clip after visible
6299 this.clip();
6300 } else {
6301 this.$clippable.css( { width: '', height: '', overflowX: '', overflowY: '' } );
6302 OO.ui.Element.static.reconsiderScrollbars( this.$clippable[ 0 ] );
6303
6304 this.$clippableContainer = null;
6305 this.$clippableScroller.off( 'scroll', this.onClippableContainerScrollHandler );
6306 this.$clippableScroller = null;
6307 this.$clippableWindow.off( 'resize', this.onClippableWindowResizeHandler );
6308 this.$clippableWindow = null;
6309 }
6310 }
6311
6312 return this;
6313 };
6314
6315 /**
6316 * Check if the element will be clipped to fit the visible area of the nearest scrollable container.
6317 *
6318 * @return {boolean} Element will be clipped to the visible area
6319 */
6320 OO.ui.ClippableElement.prototype.isClipping = function () {
6321 return this.clipping;
6322 };
6323
6324 /**
6325 * Check if the bottom or right of the element is being clipped by the nearest scrollable container.
6326 *
6327 * @return {boolean} Part of the element is being clipped
6328 */
6329 OO.ui.ClippableElement.prototype.isClipped = function () {
6330 return this.clippedHorizontally || this.clippedVertically;
6331 };
6332
6333 /**
6334 * Check if the right of the element is being clipped by the nearest scrollable container.
6335 *
6336 * @return {boolean} Part of the element is being clipped
6337 */
6338 OO.ui.ClippableElement.prototype.isClippedHorizontally = function () {
6339 return this.clippedHorizontally;
6340 };
6341
6342 /**
6343 * Check if the bottom of the element is being clipped by the nearest scrollable container.
6344 *
6345 * @return {boolean} Part of the element is being clipped
6346 */
6347 OO.ui.ClippableElement.prototype.isClippedVertically = function () {
6348 return this.clippedVertically;
6349 };
6350
6351 /**
6352 * Set the ideal size. These are the dimensions the element will have when it's not being clipped.
6353 *
6354 * @param {number|string} [width] Width as a number of pixels or CSS string with unit suffix
6355 * @param {number|string} [height] Height as a number of pixels or CSS string with unit suffix
6356 */
6357 OO.ui.ClippableElement.prototype.setIdealSize = function ( width, height ) {
6358 this.idealWidth = width;
6359 this.idealHeight = height;
6360
6361 if ( !this.clipping ) {
6362 // Update dimensions
6363 this.$clippable.css( { width: width, height: height } );
6364 }
6365 // While clipping, idealWidth and idealHeight are not considered
6366 };
6367
6368 /**
6369 * Clip element to visible boundaries and allow scrolling when needed. Call this method when
6370 * the element's natural height changes.
6371 *
6372 * Element will be clipped the bottom or right of the element is within 10px of the edge of, or
6373 * overlapped by, the visible area of the nearest scrollable container.
6374 *
6375 * @chainable
6376 */
6377 OO.ui.ClippableElement.prototype.clip = function () {
6378 if ( !this.clipping ) {
6379 // this.$clippableContainer and this.$clippableWindow are null, so the below will fail
6380 return this;
6381 }
6382
6383 var buffer = 7, // Chosen by fair dice roll
6384 cOffset = this.$clippable.offset(),
6385 $container = this.$clippableContainer.is( 'html, body' ) ?
6386 this.$clippableWindow : this.$clippableContainer,
6387 ccOffset = $container.offset() || { top: 0, left: 0 },
6388 ccHeight = $container.innerHeight() - buffer,
6389 ccWidth = $container.innerWidth() - buffer,
6390 cHeight = this.$clippable.outerHeight() + buffer,
6391 cWidth = this.$clippable.outerWidth() + buffer,
6392 scrollTop = this.$clippableScroller.scrollTop(),
6393 scrollLeft = this.$clippableScroller.scrollLeft(),
6394 desiredWidth = cOffset.left < 0 ?
6395 cWidth + cOffset.left :
6396 ( ccOffset.left + scrollLeft + ccWidth ) - cOffset.left,
6397 desiredHeight = cOffset.top < 0 ?
6398 cHeight + cOffset.top :
6399 ( ccOffset.top + scrollTop + ccHeight ) - cOffset.top,
6400 naturalWidth = this.$clippable.prop( 'scrollWidth' ),
6401 naturalHeight = this.$clippable.prop( 'scrollHeight' ),
6402 clipWidth = desiredWidth < naturalWidth,
6403 clipHeight = desiredHeight < naturalHeight;
6404
6405 if ( clipWidth ) {
6406 this.$clippable.css( { overflowX: 'scroll', width: desiredWidth } );
6407 } else {
6408 this.$clippable.css( { width: this.idealWidth || '', overflowX: '' } );
6409 }
6410 if ( clipHeight ) {
6411 this.$clippable.css( { overflowY: 'scroll', height: desiredHeight } );
6412 } else {
6413 this.$clippable.css( { height: this.idealHeight || '', overflowY: '' } );
6414 }
6415
6416 // If we stopped clipping in at least one of the dimensions
6417 if ( !clipWidth || !clipHeight ) {
6418 OO.ui.Element.static.reconsiderScrollbars( this.$clippable[ 0 ] );
6419 }
6420
6421 this.clippedHorizontally = clipWidth;
6422 this.clippedVertically = clipHeight;
6423
6424 return this;
6425 };
6426
6427 /**
6428 * Generic toolbar tool.
6429 *
6430 * @abstract
6431 * @class
6432 * @extends OO.ui.Widget
6433 * @mixins OO.ui.IconElement
6434 * @mixins OO.ui.FlaggedElement
6435 * @mixins OO.ui.TabIndexedElement
6436 *
6437 * @constructor
6438 * @param {OO.ui.ToolGroup} toolGroup
6439 * @param {Object} [config] Configuration options
6440 * @cfg {string|Function} [title] Title text or a function that returns text
6441 */
6442 OO.ui.Tool = function OoUiTool( toolGroup, config ) {
6443 // Allow passing positional parameters inside the config object
6444 if ( OO.isPlainObject( toolGroup ) && config === undefined ) {
6445 config = toolGroup;
6446 toolGroup = config.toolGroup;
6447 }
6448
6449 // Configuration initialization
6450 config = config || {};
6451
6452 // Parent constructor
6453 OO.ui.Tool.super.call( this, config );
6454
6455 // Properties
6456 this.toolGroup = toolGroup;
6457 this.toolbar = this.toolGroup.getToolbar();
6458 this.active = false;
6459 this.$title = $( '<span>' );
6460 this.$accel = $( '<span>' );
6461 this.$link = $( '<a>' );
6462 this.title = null;
6463
6464 // Mixin constructors
6465 OO.ui.IconElement.call( this, config );
6466 OO.ui.FlaggedElement.call( this, config );
6467 OO.ui.TabIndexedElement.call( this, $.extend( {}, config, { $tabIndexed: this.$link } ) );
6468
6469 // Events
6470 this.toolbar.connect( this, { updateState: 'onUpdateState' } );
6471
6472 // Initialization
6473 this.$title.addClass( 'oo-ui-tool-title' );
6474 this.$accel
6475 .addClass( 'oo-ui-tool-accel' )
6476 .prop( {
6477 // This may need to be changed if the key names are ever localized,
6478 // but for now they are essentially written in English
6479 dir: 'ltr',
6480 lang: 'en'
6481 } );
6482 this.$link
6483 .addClass( 'oo-ui-tool-link' )
6484 .append( this.$icon, this.$title, this.$accel )
6485 .attr( 'role', 'button' );
6486 this.$element
6487 .data( 'oo-ui-tool', this )
6488 .addClass(
6489 'oo-ui-tool ' + 'oo-ui-tool-name-' +
6490 this.constructor.static.name.replace( /^([^\/]+)\/([^\/]+).*$/, '$1-$2' )
6491 )
6492 .append( this.$link );
6493 this.setTitle( config.title || this.constructor.static.title );
6494 };
6495
6496 /* Setup */
6497
6498 OO.inheritClass( OO.ui.Tool, OO.ui.Widget );
6499 OO.mixinClass( OO.ui.Tool, OO.ui.IconElement );
6500 OO.mixinClass( OO.ui.Tool, OO.ui.FlaggedElement );
6501 OO.mixinClass( OO.ui.Tool, OO.ui.TabIndexedElement );
6502
6503 /* Events */
6504
6505 /**
6506 * @event select
6507 */
6508
6509 /* Static Properties */
6510
6511 /**
6512 * @static
6513 * @inheritdoc
6514 */
6515 OO.ui.Tool.static.tagName = 'span';
6516
6517 /**
6518 * Symbolic name of tool.
6519 *
6520 * @abstract
6521 * @static
6522 * @inheritable
6523 * @property {string}
6524 */
6525 OO.ui.Tool.static.name = '';
6526
6527 /**
6528 * Tool group.
6529 *
6530 * @abstract
6531 * @static
6532 * @inheritable
6533 * @property {string}
6534 */
6535 OO.ui.Tool.static.group = '';
6536
6537 /**
6538 * Tool title.
6539 *
6540 * Title is used as a tooltip when the tool is part of a bar tool group, or a label when the tool
6541 * is part of a list or menu tool group. If a trigger is associated with an action by the same name
6542 * as the tool, a description of its keyboard shortcut for the appropriate platform will be
6543 * appended to the title if the tool is part of a bar tool group.
6544 *
6545 * @abstract
6546 * @static
6547 * @inheritable
6548 * @property {string|Function} Title text or a function that returns text
6549 */
6550 OO.ui.Tool.static.title = '';
6551
6552 /**
6553 * Tool can be automatically added to catch-all groups.
6554 *
6555 * @static
6556 * @inheritable
6557 * @property {boolean}
6558 */
6559 OO.ui.Tool.static.autoAddToCatchall = true;
6560
6561 /**
6562 * Tool can be automatically added to named groups.
6563 *
6564 * @static
6565 * @property {boolean}
6566 * @inheritable
6567 */
6568 OO.ui.Tool.static.autoAddToGroup = true;
6569
6570 /**
6571 * Check if this tool is compatible with given data.
6572 *
6573 * @static
6574 * @inheritable
6575 * @param {Mixed} data Data to check
6576 * @return {boolean} Tool can be used with data
6577 */
6578 OO.ui.Tool.static.isCompatibleWith = function () {
6579 return false;
6580 };
6581
6582 /* Methods */
6583
6584 /**
6585 * Handle the toolbar state being updated.
6586 *
6587 * This is an abstract method that must be overridden in a concrete subclass.
6588 *
6589 * @abstract
6590 */
6591 OO.ui.Tool.prototype.onUpdateState = function () {
6592 throw new Error(
6593 'OO.ui.Tool.onUpdateState not implemented in this subclass:' + this.constructor
6594 );
6595 };
6596
6597 /**
6598 * Handle the tool being selected.
6599 *
6600 * This is an abstract method that must be overridden in a concrete subclass.
6601 *
6602 * @abstract
6603 */
6604 OO.ui.Tool.prototype.onSelect = function () {
6605 throw new Error(
6606 'OO.ui.Tool.onSelect not implemented in this subclass:' + this.constructor
6607 );
6608 };
6609
6610 /**
6611 * Check if the button is active.
6612 *
6613 * @return {boolean} Button is active
6614 */
6615 OO.ui.Tool.prototype.isActive = function () {
6616 return this.active;
6617 };
6618
6619 /**
6620 * Make the button appear active or inactive.
6621 *
6622 * @param {boolean} state Make button appear active
6623 */
6624 OO.ui.Tool.prototype.setActive = function ( state ) {
6625 this.active = !!state;
6626 if ( this.active ) {
6627 this.$element.addClass( 'oo-ui-tool-active' );
6628 } else {
6629 this.$element.removeClass( 'oo-ui-tool-active' );
6630 }
6631 };
6632
6633 /**
6634 * Get the tool title.
6635 *
6636 * @param {string|Function} title Title text or a function that returns text
6637 * @chainable
6638 */
6639 OO.ui.Tool.prototype.setTitle = function ( title ) {
6640 this.title = OO.ui.resolveMsg( title );
6641 this.updateTitle();
6642 return this;
6643 };
6644
6645 /**
6646 * Get the tool title.
6647 *
6648 * @return {string} Title text
6649 */
6650 OO.ui.Tool.prototype.getTitle = function () {
6651 return this.title;
6652 };
6653
6654 /**
6655 * Get the tool's symbolic name.
6656 *
6657 * @return {string} Symbolic name of tool
6658 */
6659 OO.ui.Tool.prototype.getName = function () {
6660 return this.constructor.static.name;
6661 };
6662
6663 /**
6664 * Update the title.
6665 */
6666 OO.ui.Tool.prototype.updateTitle = function () {
6667 var titleTooltips = this.toolGroup.constructor.static.titleTooltips,
6668 accelTooltips = this.toolGroup.constructor.static.accelTooltips,
6669 accel = this.toolbar.getToolAccelerator( this.constructor.static.name ),
6670 tooltipParts = [];
6671
6672 this.$title.text( this.title );
6673 this.$accel.text( accel );
6674
6675 if ( titleTooltips && typeof this.title === 'string' && this.title.length ) {
6676 tooltipParts.push( this.title );
6677 }
6678 if ( accelTooltips && typeof accel === 'string' && accel.length ) {
6679 tooltipParts.push( accel );
6680 }
6681 if ( tooltipParts.length ) {
6682 this.$link.attr( 'title', tooltipParts.join( ' ' ) );
6683 } else {
6684 this.$link.removeAttr( 'title' );
6685 }
6686 };
6687
6688 /**
6689 * Destroy tool.
6690 */
6691 OO.ui.Tool.prototype.destroy = function () {
6692 this.toolbar.disconnect( this );
6693 this.$element.remove();
6694 };
6695
6696 /**
6697 * Collection of tool groups.
6698 *
6699 * The following is a minimal example using several tools and tool groups.
6700 *
6701 * @example
6702 * // Create the toolbar
6703 * var toolFactory = new OO.ui.ToolFactory();
6704 * var toolGroupFactory = new OO.ui.ToolGroupFactory();
6705 * var toolbar = new OO.ui.Toolbar( toolFactory, toolGroupFactory );
6706 *
6707 * // We will be placing status text in this element when tools are used
6708 * var $area = $( '<p>' ).text( 'Toolbar example' );
6709 *
6710 * // Define the tools that we're going to place in our toolbar
6711 *
6712 * // Create a class inheriting from OO.ui.Tool
6713 * function PictureTool() {
6714 * PictureTool.super.apply( this, arguments );
6715 * }
6716 * OO.inheritClass( PictureTool, OO.ui.Tool );
6717 * // Each tool must have a 'name' (used as an internal identifier, see later) and at least one
6718 * // of 'icon' and 'title' (displayed icon and text).
6719 * PictureTool.static.name = 'picture';
6720 * PictureTool.static.icon = 'picture';
6721 * PictureTool.static.title = 'Insert picture';
6722 * // Defines the action that will happen when this tool is selected (clicked).
6723 * PictureTool.prototype.onSelect = function () {
6724 * $area.text( 'Picture tool clicked!' );
6725 * // Never display this tool as "active" (selected).
6726 * this.setActive( false );
6727 * };
6728 * // Make this tool available in our toolFactory and thus our toolbar
6729 * toolFactory.register( PictureTool );
6730 *
6731 * // Register two more tools, nothing interesting here
6732 * function SettingsTool() {
6733 * SettingsTool.super.apply( this, arguments );
6734 * }
6735 * OO.inheritClass( SettingsTool, OO.ui.Tool );
6736 * SettingsTool.static.name = 'settings';
6737 * SettingsTool.static.icon = 'settings';
6738 * SettingsTool.static.title = 'Change settings';
6739 * SettingsTool.prototype.onSelect = function () {
6740 * $area.text( 'Settings tool clicked!' );
6741 * this.setActive( false );
6742 * };
6743 * toolFactory.register( SettingsTool );
6744 *
6745 * // Register two more tools, nothing interesting here
6746 * function StuffTool() {
6747 * StuffTool.super.apply( this, arguments );
6748 * }
6749 * OO.inheritClass( StuffTool, OO.ui.Tool );
6750 * StuffTool.static.name = 'stuff';
6751 * StuffTool.static.icon = 'ellipsis';
6752 * StuffTool.static.title = 'More stuff';
6753 * StuffTool.prototype.onSelect = function () {
6754 * $area.text( 'More stuff tool clicked!' );
6755 * this.setActive( false );
6756 * };
6757 * toolFactory.register( StuffTool );
6758 *
6759 * // This is a PopupTool. Rather than having a custom 'onSelect' action, it will display a
6760 * // little popup window (a PopupWidget).
6761 * function HelpTool( toolGroup, config ) {
6762 * OO.ui.PopupTool.call( this, toolGroup, $.extend( { popup: {
6763 * padded: true,
6764 * label: 'Help',
6765 * head: true
6766 * } }, config ) );
6767 * this.popup.$body.append( '<p>I am helpful!</p>' );
6768 * }
6769 * OO.inheritClass( HelpTool, OO.ui.PopupTool );
6770 * HelpTool.static.name = 'help';
6771 * HelpTool.static.icon = 'help';
6772 * HelpTool.static.title = 'Help';
6773 * toolFactory.register( HelpTool );
6774 *
6775 * // Finally define which tools and in what order appear in the toolbar. Each tool may only be
6776 * // used once (but not all defined tools must be used).
6777 * toolbar.setup( [
6778 * {
6779 * // 'bar' tool groups display tools' icons only, side-by-side.
6780 * type: 'bar',
6781 * include: [ 'picture', 'help' ]
6782 * },
6783 * {
6784 * // 'list' tool groups display both the titles and icons, in a dropdown list.
6785 * type: 'list',
6786 * indicator: 'down',
6787 * label: 'More',
6788 * include: [ 'settings', 'stuff' ]
6789 * }
6790 * // Note how the tools themselves are toolgroup-agnostic - the same tool can be displayed
6791 * // either in a 'list' or a 'bar'. There is a 'menu' tool group too, not showcased here,
6792 * // since it's more complicated to use. (See the next example snippet on this page.)
6793 * ] );
6794 *
6795 * // Create some UI around the toolbar and place it in the document
6796 * var frame = new OO.ui.PanelLayout( {
6797 * expanded: false,
6798 * framed: true
6799 * } );
6800 * var contentFrame = new OO.ui.PanelLayout( {
6801 * expanded: false,
6802 * padded: true
6803 * } );
6804 * frame.$element.append(
6805 * toolbar.$element,
6806 * contentFrame.$element.append( $area )
6807 * );
6808 * $( 'body' ).append( frame.$element );
6809 *
6810 * // Here is where the toolbar is actually built. This must be done after inserting it into the
6811 * // document.
6812 * toolbar.initialize();
6813 *
6814 * The following example extends the previous one to illustrate 'menu' tool groups and the usage of
6815 * 'updateState' event.
6816 *
6817 * @example
6818 * // Create the toolbar
6819 * var toolFactory = new OO.ui.ToolFactory();
6820 * var toolGroupFactory = new OO.ui.ToolGroupFactory();
6821 * var toolbar = new OO.ui.Toolbar( toolFactory, toolGroupFactory );
6822 *
6823 * // We will be placing status text in this element when tools are used
6824 * var $area = $( '<p>' ).text( 'Toolbar example' );
6825 *
6826 * // Define the tools that we're going to place in our toolbar
6827 *
6828 * // Create a class inheriting from OO.ui.Tool
6829 * function PictureTool() {
6830 * PictureTool.super.apply( this, arguments );
6831 * }
6832 * OO.inheritClass( PictureTool, OO.ui.Tool );
6833 * // Each tool must have a 'name' (used as an internal identifier, see later) and at least one
6834 * // of 'icon' and 'title' (displayed icon and text).
6835 * PictureTool.static.name = 'picture';
6836 * PictureTool.static.icon = 'picture';
6837 * PictureTool.static.title = 'Insert picture';
6838 * // Defines the action that will happen when this tool is selected (clicked).
6839 * PictureTool.prototype.onSelect = function () {
6840 * $area.text( 'Picture tool clicked!' );
6841 * // Never display this tool as "active" (selected).
6842 * this.setActive( false );
6843 * };
6844 * // The toolbar can be synchronized with the state of some external stuff, like a text
6845 * // editor's editing area, highlighting the tools (e.g. a 'bold' tool would be shown as active
6846 * // when the text cursor was inside bolded text). Here we simply disable this feature.
6847 * PictureTool.prototype.onUpdateState = function () {
6848 * };
6849 * // Make this tool available in our toolFactory and thus our toolbar
6850 * toolFactory.register( PictureTool );
6851 *
6852 * // Register two more tools, nothing interesting here
6853 * function SettingsTool() {
6854 * SettingsTool.super.apply( this, arguments );
6855 * this.reallyActive = false;
6856 * }
6857 * OO.inheritClass( SettingsTool, OO.ui.Tool );
6858 * SettingsTool.static.name = 'settings';
6859 * SettingsTool.static.icon = 'settings';
6860 * SettingsTool.static.title = 'Change settings';
6861 * SettingsTool.prototype.onSelect = function () {
6862 * $area.text( 'Settings tool clicked!' );
6863 * // Toggle the active state on each click
6864 * this.reallyActive = !this.reallyActive;
6865 * this.setActive( this.reallyActive );
6866 * // To update the menu label
6867 * this.toolbar.emit( 'updateState' );
6868 * };
6869 * SettingsTool.prototype.onUpdateState = function () {
6870 * };
6871 * toolFactory.register( SettingsTool );
6872 *
6873 * // Register two more tools, nothing interesting here
6874 * function StuffTool() {
6875 * StuffTool.super.apply( this, arguments );
6876 * this.reallyActive = false;
6877 * }
6878 * OO.inheritClass( StuffTool, OO.ui.Tool );
6879 * StuffTool.static.name = 'stuff';
6880 * StuffTool.static.icon = 'ellipsis';
6881 * StuffTool.static.title = 'More stuff';
6882 * StuffTool.prototype.onSelect = function () {
6883 * $area.text( 'More stuff tool clicked!' );
6884 * // Toggle the active state on each click
6885 * this.reallyActive = !this.reallyActive;
6886 * this.setActive( this.reallyActive );
6887 * // To update the menu label
6888 * this.toolbar.emit( 'updateState' );
6889 * };
6890 * StuffTool.prototype.onUpdateState = function () {
6891 * };
6892 * toolFactory.register( StuffTool );
6893 *
6894 * // This is a PopupTool. Rather than having a custom 'onSelect' action, it will display a
6895 * // little popup window (a PopupWidget). 'onUpdateState' is also already implemented.
6896 * function HelpTool( toolGroup, config ) {
6897 * OO.ui.PopupTool.call( this, toolGroup, $.extend( { popup: {
6898 * padded: true,
6899 * label: 'Help',
6900 * head: true
6901 * } }, config ) );
6902 * this.popup.$body.append( '<p>I am helpful!</p>' );
6903 * }
6904 * OO.inheritClass( HelpTool, OO.ui.PopupTool );
6905 * HelpTool.static.name = 'help';
6906 * HelpTool.static.icon = 'help';
6907 * HelpTool.static.title = 'Help';
6908 * toolFactory.register( HelpTool );
6909 *
6910 * // Finally define which tools and in what order appear in the toolbar. Each tool may only be
6911 * // used once (but not all defined tools must be used).
6912 * toolbar.setup( [
6913 * {
6914 * // 'bar' tool groups display tools' icons only, side-by-side.
6915 * type: 'bar',
6916 * include: [ 'picture', 'help' ]
6917 * },
6918 * {
6919 * // 'menu' tool groups display both the titles and icons, in a dropdown menu.
6920 * // Menu label indicates which items are selected.
6921 * type: 'menu',
6922 * indicator: 'down',
6923 * include: [ 'settings', 'stuff' ]
6924 * }
6925 * ] );
6926 *
6927 * // Create some UI around the toolbar and place it in the document
6928 * var frame = new OO.ui.PanelLayout( {
6929 * expanded: false,
6930 * framed: true
6931 * } );
6932 * var contentFrame = new OO.ui.PanelLayout( {
6933 * expanded: false,
6934 * padded: true
6935 * } );
6936 * frame.$element.append(
6937 * toolbar.$element,
6938 * contentFrame.$element.append( $area )
6939 * );
6940 * $( 'body' ).append( frame.$element );
6941 *
6942 * // Here is where the toolbar is actually built. This must be done after inserting it into the
6943 * // document.
6944 * toolbar.initialize();
6945 * toolbar.emit( 'updateState' );
6946 *
6947 * @class
6948 * @extends OO.ui.Element
6949 * @mixins OO.EventEmitter
6950 * @mixins OO.ui.GroupElement
6951 *
6952 * @constructor
6953 * @param {OO.ui.ToolFactory} toolFactory Factory for creating tools
6954 * @param {OO.ui.ToolGroupFactory} toolGroupFactory Factory for creating tool groups
6955 * @param {Object} [config] Configuration options
6956 * @cfg {boolean} [actions] Add an actions section opposite to the tools
6957 * @cfg {boolean} [shadow] Add a shadow below the toolbar
6958 */
6959 OO.ui.Toolbar = function OoUiToolbar( toolFactory, toolGroupFactory, config ) {
6960 // Allow passing positional parameters inside the config object
6961 if ( OO.isPlainObject( toolFactory ) && config === undefined ) {
6962 config = toolFactory;
6963 toolFactory = config.toolFactory;
6964 toolGroupFactory = config.toolGroupFactory;
6965 }
6966
6967 // Configuration initialization
6968 config = config || {};
6969
6970 // Parent constructor
6971 OO.ui.Toolbar.super.call( this, config );
6972
6973 // Mixin constructors
6974 OO.EventEmitter.call( this );
6975 OO.ui.GroupElement.call( this, config );
6976
6977 // Properties
6978 this.toolFactory = toolFactory;
6979 this.toolGroupFactory = toolGroupFactory;
6980 this.groups = [];
6981 this.tools = {};
6982 this.$bar = $( '<div>' );
6983 this.$actions = $( '<div>' );
6984 this.initialized = false;
6985 this.onWindowResizeHandler = this.onWindowResize.bind( this );
6986
6987 // Events
6988 this.$element
6989 .add( this.$bar ).add( this.$group ).add( this.$actions )
6990 .on( 'mousedown keydown', this.onPointerDown.bind( this ) );
6991
6992 // Initialization
6993 this.$group.addClass( 'oo-ui-toolbar-tools' );
6994 if ( config.actions ) {
6995 this.$bar.append( this.$actions.addClass( 'oo-ui-toolbar-actions' ) );
6996 }
6997 this.$bar
6998 .addClass( 'oo-ui-toolbar-bar' )
6999 .append( this.$group, '<div style="clear:both"></div>' );
7000 if ( config.shadow ) {
7001 this.$bar.append( '<div class="oo-ui-toolbar-shadow"></div>' );
7002 }
7003 this.$element.addClass( 'oo-ui-toolbar' ).append( this.$bar );
7004 };
7005
7006 /* Setup */
7007
7008 OO.inheritClass( OO.ui.Toolbar, OO.ui.Element );
7009 OO.mixinClass( OO.ui.Toolbar, OO.EventEmitter );
7010 OO.mixinClass( OO.ui.Toolbar, OO.ui.GroupElement );
7011
7012 /* Methods */
7013
7014 /**
7015 * Get the tool factory.
7016 *
7017 * @return {OO.ui.ToolFactory} Tool factory
7018 */
7019 OO.ui.Toolbar.prototype.getToolFactory = function () {
7020 return this.toolFactory;
7021 };
7022
7023 /**
7024 * Get the tool group factory.
7025 *
7026 * @return {OO.Factory} Tool group factory
7027 */
7028 OO.ui.Toolbar.prototype.getToolGroupFactory = function () {
7029 return this.toolGroupFactory;
7030 };
7031
7032 /**
7033 * Handles mouse down events.
7034 *
7035 * @param {jQuery.Event} e Mouse down event
7036 */
7037 OO.ui.Toolbar.prototype.onPointerDown = function ( e ) {
7038 var $closestWidgetToEvent = $( e.target ).closest( '.oo-ui-widget' ),
7039 $closestWidgetToToolbar = this.$element.closest( '.oo-ui-widget' );
7040 if ( !$closestWidgetToEvent.length || $closestWidgetToEvent[ 0 ] === $closestWidgetToToolbar[ 0 ] ) {
7041 return false;
7042 }
7043 };
7044
7045 /**
7046 * Handle window resize event.
7047 *
7048 * @private
7049 * @param {jQuery.Event} e Window resize event
7050 */
7051 OO.ui.Toolbar.prototype.onWindowResize = function () {
7052 this.$element.toggleClass(
7053 'oo-ui-toolbar-narrow',
7054 this.$bar.width() <= this.narrowThreshold
7055 );
7056 };
7057
7058 /**
7059 * Sets up handles and preloads required information for the toolbar to work.
7060 * This must be called after it is attached to a visible document and before doing anything else.
7061 */
7062 OO.ui.Toolbar.prototype.initialize = function () {
7063 this.initialized = true;
7064 this.narrowThreshold = this.$group.width() + this.$actions.width();
7065 $( this.getElementWindow() ).on( 'resize', this.onWindowResizeHandler );
7066 this.onWindowResize();
7067 };
7068
7069 /**
7070 * Setup toolbar.
7071 *
7072 * Tools can be specified in the following ways:
7073 *
7074 * - A specific tool: `{ name: 'tool-name' }` or `'tool-name'`
7075 * - All tools in a group: `{ group: 'group-name' }`
7076 * - All tools: `'*'` - Using this will make the group a list with a "More" label by default
7077 *
7078 * @param {Object.<string,Array>} groups List of tool group configurations
7079 * @param {Array|string} [groups.include] Tools to include
7080 * @param {Array|string} [groups.exclude] Tools to exclude
7081 * @param {Array|string} [groups.promote] Tools to promote to the beginning
7082 * @param {Array|string} [groups.demote] Tools to demote to the end
7083 */
7084 OO.ui.Toolbar.prototype.setup = function ( groups ) {
7085 var i, len, type, group,
7086 items = [],
7087 defaultType = 'bar';
7088
7089 // Cleanup previous groups
7090 this.reset();
7091
7092 // Build out new groups
7093 for ( i = 0, len = groups.length; i < len; i++ ) {
7094 group = groups[ i ];
7095 if ( group.include === '*' ) {
7096 // Apply defaults to catch-all groups
7097 if ( group.type === undefined ) {
7098 group.type = 'list';
7099 }
7100 if ( group.label === undefined ) {
7101 group.label = OO.ui.msg( 'ooui-toolbar-more' );
7102 }
7103 }
7104 // Check type has been registered
7105 type = this.getToolGroupFactory().lookup( group.type ) ? group.type : defaultType;
7106 items.push(
7107 this.getToolGroupFactory().create( type, this, group )
7108 );
7109 }
7110 this.addItems( items );
7111 };
7112
7113 /**
7114 * Remove all tools and groups from the toolbar.
7115 */
7116 OO.ui.Toolbar.prototype.reset = function () {
7117 var i, len;
7118
7119 this.groups = [];
7120 this.tools = {};
7121 for ( i = 0, len = this.items.length; i < len; i++ ) {
7122 this.items[ i ].destroy();
7123 }
7124 this.clearItems();
7125 };
7126
7127 /**
7128 * Destroys toolbar, removing event handlers and DOM elements.
7129 *
7130 * Call this whenever you are done using a toolbar.
7131 */
7132 OO.ui.Toolbar.prototype.destroy = function () {
7133 $( this.getElementWindow() ).off( 'resize', this.onWindowResizeHandler );
7134 this.reset();
7135 this.$element.remove();
7136 };
7137
7138 /**
7139 * Check if tool has not been used yet.
7140 *
7141 * @param {string} name Symbolic name of tool
7142 * @return {boolean} Tool is available
7143 */
7144 OO.ui.Toolbar.prototype.isToolAvailable = function ( name ) {
7145 return !this.tools[ name ];
7146 };
7147
7148 /**
7149 * Prevent tool from being used again.
7150 *
7151 * @param {OO.ui.Tool} tool Tool to reserve
7152 */
7153 OO.ui.Toolbar.prototype.reserveTool = function ( tool ) {
7154 this.tools[ tool.getName() ] = tool;
7155 };
7156
7157 /**
7158 * Allow tool to be used again.
7159 *
7160 * @param {OO.ui.Tool} tool Tool to release
7161 */
7162 OO.ui.Toolbar.prototype.releaseTool = function ( tool ) {
7163 delete this.tools[ tool.getName() ];
7164 };
7165
7166 /**
7167 * Get accelerator label for tool.
7168 *
7169 * This is a stub that should be overridden to provide access to accelerator information.
7170 *
7171 * @param {string} name Symbolic name of tool
7172 * @return {string|undefined} Tool accelerator label if available
7173 */
7174 OO.ui.Toolbar.prototype.getToolAccelerator = function () {
7175 return undefined;
7176 };
7177
7178 /**
7179 * Collection of tools.
7180 *
7181 * Tools can be specified in the following ways:
7182 *
7183 * - A specific tool: `{ name: 'tool-name' }` or `'tool-name'`
7184 * - All tools in a group: `{ group: 'group-name' }`
7185 * - All tools: `'*'`
7186 *
7187 * @abstract
7188 * @class
7189 * @extends OO.ui.Widget
7190 * @mixins OO.ui.GroupElement
7191 *
7192 * @constructor
7193 * @param {OO.ui.Toolbar} toolbar
7194 * @param {Object} [config] Configuration options
7195 * @cfg {Array|string} [include=[]] List of tools to include
7196 * @cfg {Array|string} [exclude=[]] List of tools to exclude
7197 * @cfg {Array|string} [promote=[]] List of tools to promote to the beginning
7198 * @cfg {Array|string} [demote=[]] List of tools to demote to the end
7199 */
7200 OO.ui.ToolGroup = function OoUiToolGroup( toolbar, config ) {
7201 // Allow passing positional parameters inside the config object
7202 if ( OO.isPlainObject( toolbar ) && config === undefined ) {
7203 config = toolbar;
7204 toolbar = config.toolbar;
7205 }
7206
7207 // Configuration initialization
7208 config = config || {};
7209
7210 // Parent constructor
7211 OO.ui.ToolGroup.super.call( this, config );
7212
7213 // Mixin constructors
7214 OO.ui.GroupElement.call( this, config );
7215
7216 // Properties
7217 this.toolbar = toolbar;
7218 this.tools = {};
7219 this.pressed = null;
7220 this.autoDisabled = false;
7221 this.include = config.include || [];
7222 this.exclude = config.exclude || [];
7223 this.promote = config.promote || [];
7224 this.demote = config.demote || [];
7225 this.onCapturedMouseKeyUpHandler = this.onCapturedMouseKeyUp.bind( this );
7226
7227 // Events
7228 this.$element.on( {
7229 mousedown: this.onMouseKeyDown.bind( this ),
7230 mouseup: this.onMouseKeyUp.bind( this ),
7231 keydown: this.onMouseKeyDown.bind( this ),
7232 keyup: this.onMouseKeyUp.bind( this ),
7233 focus: this.onMouseOverFocus.bind( this ),
7234 blur: this.onMouseOutBlur.bind( this ),
7235 mouseover: this.onMouseOverFocus.bind( this ),
7236 mouseout: this.onMouseOutBlur.bind( this )
7237 } );
7238 this.toolbar.getToolFactory().connect( this, { register: 'onToolFactoryRegister' } );
7239 this.aggregate( { disable: 'itemDisable' } );
7240 this.connect( this, { itemDisable: 'updateDisabled' } );
7241
7242 // Initialization
7243 this.$group.addClass( 'oo-ui-toolGroup-tools' );
7244 this.$element
7245 .addClass( 'oo-ui-toolGroup' )
7246 .append( this.$group );
7247 this.populate();
7248 };
7249
7250 /* Setup */
7251
7252 OO.inheritClass( OO.ui.ToolGroup, OO.ui.Widget );
7253 OO.mixinClass( OO.ui.ToolGroup, OO.ui.GroupElement );
7254
7255 /* Events */
7256
7257 /**
7258 * @event update
7259 */
7260
7261 /* Static Properties */
7262
7263 /**
7264 * Show labels in tooltips.
7265 *
7266 * @static
7267 * @inheritable
7268 * @property {boolean}
7269 */
7270 OO.ui.ToolGroup.static.titleTooltips = false;
7271
7272 /**
7273 * Show acceleration labels in tooltips.
7274 *
7275 * @static
7276 * @inheritable
7277 * @property {boolean}
7278 */
7279 OO.ui.ToolGroup.static.accelTooltips = false;
7280
7281 /**
7282 * Automatically disable the toolgroup when all tools are disabled
7283 *
7284 * @static
7285 * @inheritable
7286 * @property {boolean}
7287 */
7288 OO.ui.ToolGroup.static.autoDisable = true;
7289
7290 /* Methods */
7291
7292 /**
7293 * @inheritdoc
7294 */
7295 OO.ui.ToolGroup.prototype.isDisabled = function () {
7296 return this.autoDisabled || OO.ui.ToolGroup.super.prototype.isDisabled.apply( this, arguments );
7297 };
7298
7299 /**
7300 * @inheritdoc
7301 */
7302 OO.ui.ToolGroup.prototype.updateDisabled = function () {
7303 var i, item, allDisabled = true;
7304
7305 if ( this.constructor.static.autoDisable ) {
7306 for ( i = this.items.length - 1; i >= 0; i-- ) {
7307 item = this.items[ i ];
7308 if ( !item.isDisabled() ) {
7309 allDisabled = false;
7310 break;
7311 }
7312 }
7313 this.autoDisabled = allDisabled;
7314 }
7315 OO.ui.ToolGroup.super.prototype.updateDisabled.apply( this, arguments );
7316 };
7317
7318 /**
7319 * Handle mouse down and key down events.
7320 *
7321 * @param {jQuery.Event} e Mouse down or key down event
7322 */
7323 OO.ui.ToolGroup.prototype.onMouseKeyDown = function ( e ) {
7324 if (
7325 !this.isDisabled() &&
7326 ( e.which === 1 || e.which === OO.ui.Keys.SPACE || e.which === OO.ui.Keys.ENTER )
7327 ) {
7328 this.pressed = this.getTargetTool( e );
7329 if ( this.pressed ) {
7330 this.pressed.setActive( true );
7331 this.getElementDocument().addEventListener( 'mouseup', this.onCapturedMouseKeyUpHandler, true );
7332 this.getElementDocument().addEventListener( 'keyup', this.onCapturedMouseKeyUpHandler, true );
7333 }
7334 return false;
7335 }
7336 };
7337
7338 /**
7339 * Handle captured mouse up and key up events.
7340 *
7341 * @param {Event} e Mouse up or key up event
7342 */
7343 OO.ui.ToolGroup.prototype.onCapturedMouseKeyUp = function ( e ) {
7344 this.getElementDocument().removeEventListener( 'mouseup', this.onCapturedMouseKeyUpHandler, true );
7345 this.getElementDocument().removeEventListener( 'keyup', this.onCapturedMouseKeyUpHandler, true );
7346 // onMouseKeyUp may be called a second time, depending on where the mouse is when the button is
7347 // released, but since `this.pressed` will no longer be true, the second call will be ignored.
7348 this.onMouseKeyUp( e );
7349 };
7350
7351 /**
7352 * Handle mouse up and key up events.
7353 *
7354 * @param {jQuery.Event} e Mouse up or key up event
7355 */
7356 OO.ui.ToolGroup.prototype.onMouseKeyUp = function ( e ) {
7357 var tool = this.getTargetTool( e );
7358
7359 if (
7360 !this.isDisabled() && this.pressed && this.pressed === tool &&
7361 ( e.which === 1 || e.which === OO.ui.Keys.SPACE || e.which === OO.ui.Keys.ENTER )
7362 ) {
7363 this.pressed.onSelect();
7364 this.pressed = null;
7365 return false;
7366 }
7367
7368 this.pressed = null;
7369 };
7370
7371 /**
7372 * Handle mouse over and focus events.
7373 *
7374 * @param {jQuery.Event} e Mouse over or focus event
7375 */
7376 OO.ui.ToolGroup.prototype.onMouseOverFocus = function ( e ) {
7377 var tool = this.getTargetTool( e );
7378
7379 if ( this.pressed && this.pressed === tool ) {
7380 this.pressed.setActive( true );
7381 }
7382 };
7383
7384 /**
7385 * Handle mouse out and blur events.
7386 *
7387 * @param {jQuery.Event} e Mouse out or blur event
7388 */
7389 OO.ui.ToolGroup.prototype.onMouseOutBlur = function ( e ) {
7390 var tool = this.getTargetTool( e );
7391
7392 if ( this.pressed && this.pressed === tool ) {
7393 this.pressed.setActive( false );
7394 }
7395 };
7396
7397 /**
7398 * Get the closest tool to a jQuery.Event.
7399 *
7400 * Only tool links are considered, which prevents other elements in the tool such as popups from
7401 * triggering tool group interactions.
7402 *
7403 * @private
7404 * @param {jQuery.Event} e
7405 * @return {OO.ui.Tool|null} Tool, `null` if none was found
7406 */
7407 OO.ui.ToolGroup.prototype.getTargetTool = function ( e ) {
7408 var tool,
7409 $item = $( e.target ).closest( '.oo-ui-tool-link' );
7410
7411 if ( $item.length ) {
7412 tool = $item.parent().data( 'oo-ui-tool' );
7413 }
7414
7415 return tool && !tool.isDisabled() ? tool : null;
7416 };
7417
7418 /**
7419 * Handle tool registry register events.
7420 *
7421 * If a tool is registered after the group is created, we must repopulate the list to account for:
7422 *
7423 * - a tool being added that may be included
7424 * - a tool already included being overridden
7425 *
7426 * @param {string} name Symbolic name of tool
7427 */
7428 OO.ui.ToolGroup.prototype.onToolFactoryRegister = function () {
7429 this.populate();
7430 };
7431
7432 /**
7433 * Get the toolbar this group is in.
7434 *
7435 * @return {OO.ui.Toolbar} Toolbar of group
7436 */
7437 OO.ui.ToolGroup.prototype.getToolbar = function () {
7438 return this.toolbar;
7439 };
7440
7441 /**
7442 * Add and remove tools based on configuration.
7443 */
7444 OO.ui.ToolGroup.prototype.populate = function () {
7445 var i, len, name, tool,
7446 toolFactory = this.toolbar.getToolFactory(),
7447 names = {},
7448 add = [],
7449 remove = [],
7450 list = this.toolbar.getToolFactory().getTools(
7451 this.include, this.exclude, this.promote, this.demote
7452 );
7453
7454 // Build a list of needed tools
7455 for ( i = 0, len = list.length; i < len; i++ ) {
7456 name = list[ i ];
7457 if (
7458 // Tool exists
7459 toolFactory.lookup( name ) &&
7460 // Tool is available or is already in this group
7461 ( this.toolbar.isToolAvailable( name ) || this.tools[ name ] )
7462 ) {
7463 // Hack to prevent infinite recursion via ToolGroupTool. We need to reserve the tool before
7464 // creating it, but we can't call reserveTool() yet because we haven't created the tool.
7465 this.toolbar.tools[ name ] = true;
7466 tool = this.tools[ name ];
7467 if ( !tool ) {
7468 // Auto-initialize tools on first use
7469 this.tools[ name ] = tool = toolFactory.create( name, this );
7470 tool.updateTitle();
7471 }
7472 this.toolbar.reserveTool( tool );
7473 add.push( tool );
7474 names[ name ] = true;
7475 }
7476 }
7477 // Remove tools that are no longer needed
7478 for ( name in this.tools ) {
7479 if ( !names[ name ] ) {
7480 this.tools[ name ].destroy();
7481 this.toolbar.releaseTool( this.tools[ name ] );
7482 remove.push( this.tools[ name ] );
7483 delete this.tools[ name ];
7484 }
7485 }
7486 if ( remove.length ) {
7487 this.removeItems( remove );
7488 }
7489 // Update emptiness state
7490 if ( add.length ) {
7491 this.$element.removeClass( 'oo-ui-toolGroup-empty' );
7492 } else {
7493 this.$element.addClass( 'oo-ui-toolGroup-empty' );
7494 }
7495 // Re-add tools (moving existing ones to new locations)
7496 this.addItems( add );
7497 // Disabled state may depend on items
7498 this.updateDisabled();
7499 };
7500
7501 /**
7502 * Destroy tool group.
7503 */
7504 OO.ui.ToolGroup.prototype.destroy = function () {
7505 var name;
7506
7507 this.clearItems();
7508 this.toolbar.getToolFactory().disconnect( this );
7509 for ( name in this.tools ) {
7510 this.toolbar.releaseTool( this.tools[ name ] );
7511 this.tools[ name ].disconnect( this ).destroy();
7512 delete this.tools[ name ];
7513 }
7514 this.$element.remove();
7515 };
7516
7517 /**
7518 * MessageDialogs display a confirmation or alert message. By default, the rendered dialog box
7519 * consists of a header that contains the dialog title, a body with the message, and a footer that
7520 * contains any {@link OO.ui.ActionWidget action widgets}. The MessageDialog class is the only type
7521 * of {@link OO.ui.Dialog dialog} that is usually instantiated directly.
7522 *
7523 * There are two basic types of message dialogs, confirmation and alert:
7524 *
7525 * - **confirmation**: the dialog title describes what a progressive action will do and the message provides
7526 * more details about the consequences.
7527 * - **alert**: the dialog title describes which event occurred and the message provides more information
7528 * about why the event occurred.
7529 *
7530 * The MessageDialog class specifies two actions: ‘accept’, the primary
7531 * action (e.g., ‘ok’) and ‘reject,’ the safe action (e.g., ‘cancel’). Both will close the window,
7532 * passing along the selected action.
7533 *
7534 * For more information and examples, please see the [OOjs UI documentation on MediaWiki][1].
7535 *
7536 * @example
7537 * // Example: Creating and opening a message dialog window.
7538 * var messageDialog = new OO.ui.MessageDialog();
7539 *
7540 * // Create and append a window manager.
7541 * var windowManager = new OO.ui.WindowManager();
7542 * $( 'body' ).append( windowManager.$element );
7543 * windowManager.addWindows( [ messageDialog ] );
7544 * // Open the window.
7545 * windowManager.openWindow( messageDialog, {
7546 * title: 'Basic message dialog',
7547 * message: 'This is the message'
7548 * } );
7549 *
7550 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Windows/Message_Dialogs
7551 *
7552 * @class
7553 * @extends OO.ui.Dialog
7554 *
7555 * @constructor
7556 * @param {Object} [config] Configuration options
7557 */
7558 OO.ui.MessageDialog = function OoUiMessageDialog( config ) {
7559 // Parent constructor
7560 OO.ui.MessageDialog.super.call( this, config );
7561
7562 // Properties
7563 this.verticalActionLayout = null;
7564
7565 // Initialization
7566 this.$element.addClass( 'oo-ui-messageDialog' );
7567 };
7568
7569 /* Inheritance */
7570
7571 OO.inheritClass( OO.ui.MessageDialog, OO.ui.Dialog );
7572
7573 /* Static Properties */
7574
7575 OO.ui.MessageDialog.static.name = 'message';
7576
7577 OO.ui.MessageDialog.static.size = 'small';
7578
7579 OO.ui.MessageDialog.static.verbose = false;
7580
7581 /**
7582 * Dialog title.
7583 *
7584 * The title of a confirmation dialog describes what a progressive action will do. The
7585 * title of an alert dialog describes which event occurred.
7586 *
7587 * @static
7588 * @inheritable
7589 * @property {jQuery|string|Function|null}
7590 */
7591 OO.ui.MessageDialog.static.title = null;
7592
7593 /**
7594 * The message displayed in the dialog body.
7595 *
7596 * A confirmation message describes the consequences of a progressive action. An alert
7597 * message describes why an event occurred.
7598 *
7599 * @static
7600 * @inheritable
7601 * @property {jQuery|string|Function|null}
7602 */
7603 OO.ui.MessageDialog.static.message = null;
7604
7605 OO.ui.MessageDialog.static.actions = [
7606 { action: 'accept', label: OO.ui.deferMsg( 'ooui-dialog-message-accept' ), flags: 'primary' },
7607 { action: 'reject', label: OO.ui.deferMsg( 'ooui-dialog-message-reject' ), flags: 'safe' }
7608 ];
7609
7610 /* Methods */
7611
7612 /**
7613 * @inheritdoc
7614 */
7615 OO.ui.MessageDialog.prototype.setManager = function ( manager ) {
7616 OO.ui.MessageDialog.super.prototype.setManager.call( this, manager );
7617
7618 // Events
7619 this.manager.connect( this, {
7620 resize: 'onResize'
7621 } );
7622
7623 return this;
7624 };
7625
7626 /**
7627 * @inheritdoc
7628 */
7629 OO.ui.MessageDialog.prototype.onActionResize = function ( action ) {
7630 this.fitActions();
7631 return OO.ui.MessageDialog.super.prototype.onActionResize.call( this, action );
7632 };
7633
7634 /**
7635 * Handle window resized events.
7636 *
7637 * @private
7638 */
7639 OO.ui.MessageDialog.prototype.onResize = function () {
7640 var dialog = this;
7641 dialog.fitActions();
7642 // Wait for CSS transition to finish and do it again :(
7643 setTimeout( function () {
7644 dialog.fitActions();
7645 }, 300 );
7646 };
7647
7648 /**
7649 * Toggle action layout between vertical and horizontal.
7650 *
7651 *
7652 * @private
7653 * @param {boolean} [value] Layout actions vertically, omit to toggle
7654 * @chainable
7655 */
7656 OO.ui.MessageDialog.prototype.toggleVerticalActionLayout = function ( value ) {
7657 value = value === undefined ? !this.verticalActionLayout : !!value;
7658
7659 if ( value !== this.verticalActionLayout ) {
7660 this.verticalActionLayout = value;
7661 this.$actions
7662 .toggleClass( 'oo-ui-messageDialog-actions-vertical', value )
7663 .toggleClass( 'oo-ui-messageDialog-actions-horizontal', !value );
7664 }
7665
7666 return this;
7667 };
7668
7669 /**
7670 * @inheritdoc
7671 */
7672 OO.ui.MessageDialog.prototype.getActionProcess = function ( action ) {
7673 if ( action ) {
7674 return new OO.ui.Process( function () {
7675 this.close( { action: action } );
7676 }, this );
7677 }
7678 return OO.ui.MessageDialog.super.prototype.getActionProcess.call( this, action );
7679 };
7680
7681 /**
7682 * @inheritdoc
7683 *
7684 * @param {Object} [data] Dialog opening data
7685 * @param {jQuery|string|Function|null} [data.title] Description of the action being confirmed
7686 * @param {jQuery|string|Function|null} [data.message] Description of the action's consequence
7687 * @param {boolean} [data.verbose] Message is verbose and should be styled as a long message
7688 * @param {Object[]} [data.actions] List of OO.ui.ActionOptionWidget configuration options for each
7689 * action item
7690 */
7691 OO.ui.MessageDialog.prototype.getSetupProcess = function ( data ) {
7692 data = data || {};
7693
7694 // Parent method
7695 return OO.ui.MessageDialog.super.prototype.getSetupProcess.call( this, data )
7696 .next( function () {
7697 this.title.setLabel(
7698 data.title !== undefined ? data.title : this.constructor.static.title
7699 );
7700 this.message.setLabel(
7701 data.message !== undefined ? data.message : this.constructor.static.message
7702 );
7703 this.message.$element.toggleClass(
7704 'oo-ui-messageDialog-message-verbose',
7705 data.verbose !== undefined ? data.verbose : this.constructor.static.verbose
7706 );
7707 }, this );
7708 };
7709
7710 /**
7711 * @inheritdoc
7712 */
7713 OO.ui.MessageDialog.prototype.getBodyHeight = function () {
7714 var bodyHeight, oldOverflow,
7715 $scrollable = this.container.$element;
7716
7717 oldOverflow = $scrollable[ 0 ].style.overflow;
7718 $scrollable[ 0 ].style.overflow = 'hidden';
7719
7720 OO.ui.Element.static.reconsiderScrollbars( $scrollable[ 0 ] );
7721
7722 bodyHeight = this.text.$element.outerHeight( true );
7723 $scrollable[ 0 ].style.overflow = oldOverflow;
7724
7725 return bodyHeight;
7726 };
7727
7728 /**
7729 * @inheritdoc
7730 */
7731 OO.ui.MessageDialog.prototype.setDimensions = function ( dim ) {
7732 var $scrollable = this.container.$element;
7733 OO.ui.MessageDialog.super.prototype.setDimensions.call( this, dim );
7734
7735 // Twiddle the overflow property, otherwise an unnecessary scrollbar will be produced.
7736 // Need to do it after transition completes (250ms), add 50ms just in case.
7737 setTimeout( function () {
7738 var oldOverflow = $scrollable[ 0 ].style.overflow;
7739 $scrollable[ 0 ].style.overflow = 'hidden';
7740
7741 OO.ui.Element.static.reconsiderScrollbars( $scrollable[ 0 ] );
7742
7743 $scrollable[ 0 ].style.overflow = oldOverflow;
7744 }, 300 );
7745
7746 return this;
7747 };
7748
7749 /**
7750 * @inheritdoc
7751 */
7752 OO.ui.MessageDialog.prototype.initialize = function () {
7753 // Parent method
7754 OO.ui.MessageDialog.super.prototype.initialize.call( this );
7755
7756 // Properties
7757 this.$actions = $( '<div>' );
7758 this.container = new OO.ui.PanelLayout( {
7759 scrollable: true, classes: [ 'oo-ui-messageDialog-container' ]
7760 } );
7761 this.text = new OO.ui.PanelLayout( {
7762 padded: true, expanded: false, classes: [ 'oo-ui-messageDialog-text' ]
7763 } );
7764 this.message = new OO.ui.LabelWidget( {
7765 classes: [ 'oo-ui-messageDialog-message' ]
7766 } );
7767
7768 // Initialization
7769 this.title.$element.addClass( 'oo-ui-messageDialog-title' );
7770 this.$content.addClass( 'oo-ui-messageDialog-content' );
7771 this.container.$element.append( this.text.$element );
7772 this.text.$element.append( this.title.$element, this.message.$element );
7773 this.$body.append( this.container.$element );
7774 this.$actions.addClass( 'oo-ui-messageDialog-actions' );
7775 this.$foot.append( this.$actions );
7776 };
7777
7778 /**
7779 * @inheritdoc
7780 */
7781 OO.ui.MessageDialog.prototype.attachActions = function () {
7782 var i, len, other, special, others;
7783
7784 // Parent method
7785 OO.ui.MessageDialog.super.prototype.attachActions.call( this );
7786
7787 special = this.actions.getSpecial();
7788 others = this.actions.getOthers();
7789 if ( special.safe ) {
7790 this.$actions.append( special.safe.$element );
7791 special.safe.toggleFramed( false );
7792 }
7793 if ( others.length ) {
7794 for ( i = 0, len = others.length; i < len; i++ ) {
7795 other = others[ i ];
7796 this.$actions.append( other.$element );
7797 other.toggleFramed( false );
7798 }
7799 }
7800 if ( special.primary ) {
7801 this.$actions.append( special.primary.$element );
7802 special.primary.toggleFramed( false );
7803 }
7804
7805 if ( !this.isOpening() ) {
7806 // If the dialog is currently opening, this will be called automatically soon.
7807 // This also calls #fitActions.
7808 this.updateSize();
7809 }
7810 };
7811
7812 /**
7813 * Fit action actions into columns or rows.
7814 *
7815 * Columns will be used if all labels can fit without overflow, otherwise rows will be used.
7816 *
7817 * @private
7818 */
7819 OO.ui.MessageDialog.prototype.fitActions = function () {
7820 var i, len, action,
7821 previous = this.verticalActionLayout,
7822 actions = this.actions.get();
7823
7824 // Detect clipping
7825 this.toggleVerticalActionLayout( false );
7826 for ( i = 0, len = actions.length; i < len; i++ ) {
7827 action = actions[ i ];
7828 if ( action.$element.innerWidth() < action.$label.outerWidth( true ) ) {
7829 this.toggleVerticalActionLayout( true );
7830 break;
7831 }
7832 }
7833
7834 // Move the body out of the way of the foot
7835 this.$body.css( 'bottom', this.$foot.outerHeight( true ) );
7836
7837 if ( this.verticalActionLayout !== previous ) {
7838 // We changed the layout, window height might need to be updated.
7839 this.updateSize();
7840 }
7841 };
7842
7843 /**
7844 * ProcessDialog windows encapsulate a {@link OO.ui.Process process} and all of the code necessary
7845 * to complete it. If the process terminates with an error, a customizable {@link OO.ui.Error error
7846 * interface} alerts users to the trouble, permitting the user to dismiss the error and try again when
7847 * relevant. The ProcessDialog class is always extended and customized with the actions and content
7848 * required for each process.
7849 *
7850 * The process dialog box consists of a header that visually represents the ‘working’ state of long
7851 * processes with an animation. The header contains the dialog title as well as
7852 * two {@link OO.ui.ActionWidget action widgets}: a ‘safe’ action on the left (e.g., ‘Cancel’) and
7853 * a ‘primary’ action on the right (e.g., ‘Done’).
7854 *
7855 * Like other windows, the process dialog is managed by a {@link OO.ui.WindowManager window manager}.
7856 * Please see the [OOjs UI documentation on MediaWiki][1] for more information and examples.
7857 *
7858 * @example
7859 * // Example: Creating and opening a process dialog window.
7860 * function MyProcessDialog( config ) {
7861 * MyProcessDialog.super.call( this, config );
7862 * }
7863 * OO.inheritClass( MyProcessDialog, OO.ui.ProcessDialog );
7864 *
7865 * MyProcessDialog.static.title = 'Process dialog';
7866 * MyProcessDialog.static.actions = [
7867 * { action: 'save', label: 'Done', flags: 'primary' },
7868 * { label: 'Cancel', flags: 'safe' }
7869 * ];
7870 *
7871 * MyProcessDialog.prototype.initialize = function () {
7872 * MyProcessDialog.super.prototype.initialize.apply( this, arguments );
7873 * this.content = new OO.ui.PanelLayout( { padded: true, expanded: false } );
7874 * 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>' );
7875 * this.$body.append( this.content.$element );
7876 * };
7877 * MyProcessDialog.prototype.getActionProcess = function ( action ) {
7878 * var dialog = this;
7879 * if ( action ) {
7880 * return new OO.ui.Process( function () {
7881 * dialog.close( { action: action } );
7882 * } );
7883 * }
7884 * return MyProcessDialog.super.prototype.getActionProcess.call( this, action );
7885 * };
7886 *
7887 * var windowManager = new OO.ui.WindowManager();
7888 * $( 'body' ).append( windowManager.$element );
7889 *
7890 * var dialog = new MyProcessDialog();
7891 * windowManager.addWindows( [ dialog ] );
7892 * windowManager.openWindow( dialog );
7893 *
7894 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Windows/Process_Dialogs
7895 *
7896 * @abstract
7897 * @class
7898 * @extends OO.ui.Dialog
7899 *
7900 * @constructor
7901 * @param {Object} [config] Configuration options
7902 */
7903 OO.ui.ProcessDialog = function OoUiProcessDialog( config ) {
7904 // Parent constructor
7905 OO.ui.ProcessDialog.super.call( this, config );
7906
7907 // Initialization
7908 this.$element.addClass( 'oo-ui-processDialog' );
7909 };
7910
7911 /* Setup */
7912
7913 OO.inheritClass( OO.ui.ProcessDialog, OO.ui.Dialog );
7914
7915 /* Methods */
7916
7917 /**
7918 * Handle dismiss button click events.
7919 *
7920 * Hides errors.
7921 *
7922 * @private
7923 */
7924 OO.ui.ProcessDialog.prototype.onDismissErrorButtonClick = function () {
7925 this.hideErrors();
7926 };
7927
7928 /**
7929 * Handle retry button click events.
7930 *
7931 * Hides errors and then tries again.
7932 *
7933 * @private
7934 */
7935 OO.ui.ProcessDialog.prototype.onRetryButtonClick = function () {
7936 this.hideErrors();
7937 this.executeAction( this.currentAction );
7938 };
7939
7940 /**
7941 * @inheritdoc
7942 */
7943 OO.ui.ProcessDialog.prototype.onActionResize = function ( action ) {
7944 if ( this.actions.isSpecial( action ) ) {
7945 this.fitLabel();
7946 }
7947 return OO.ui.ProcessDialog.super.prototype.onActionResize.call( this, action );
7948 };
7949
7950 /**
7951 * @inheritdoc
7952 */
7953 OO.ui.ProcessDialog.prototype.initialize = function () {
7954 // Parent method
7955 OO.ui.ProcessDialog.super.prototype.initialize.call( this );
7956
7957 // Properties
7958 this.$navigation = $( '<div>' );
7959 this.$location = $( '<div>' );
7960 this.$safeActions = $( '<div>' );
7961 this.$primaryActions = $( '<div>' );
7962 this.$otherActions = $( '<div>' );
7963 this.dismissButton = new OO.ui.ButtonWidget( {
7964 label: OO.ui.msg( 'ooui-dialog-process-dismiss' )
7965 } );
7966 this.retryButton = new OO.ui.ButtonWidget();
7967 this.$errors = $( '<div>' );
7968 this.$errorsTitle = $( '<div>' );
7969
7970 // Events
7971 this.dismissButton.connect( this, { click: 'onDismissErrorButtonClick' } );
7972 this.retryButton.connect( this, { click: 'onRetryButtonClick' } );
7973
7974 // Initialization
7975 this.title.$element.addClass( 'oo-ui-processDialog-title' );
7976 this.$location
7977 .append( this.title.$element )
7978 .addClass( 'oo-ui-processDialog-location' );
7979 this.$safeActions.addClass( 'oo-ui-processDialog-actions-safe' );
7980 this.$primaryActions.addClass( 'oo-ui-processDialog-actions-primary' );
7981 this.$otherActions.addClass( 'oo-ui-processDialog-actions-other' );
7982 this.$errorsTitle
7983 .addClass( 'oo-ui-processDialog-errors-title' )
7984 .text( OO.ui.msg( 'ooui-dialog-process-error' ) );
7985 this.$errors
7986 .addClass( 'oo-ui-processDialog-errors oo-ui-element-hidden' )
7987 .append( this.$errorsTitle, this.dismissButton.$element, this.retryButton.$element );
7988 this.$content
7989 .addClass( 'oo-ui-processDialog-content' )
7990 .append( this.$errors );
7991 this.$navigation
7992 .addClass( 'oo-ui-processDialog-navigation' )
7993 .append( this.$safeActions, this.$location, this.$primaryActions );
7994 this.$head.append( this.$navigation );
7995 this.$foot.append( this.$otherActions );
7996 };
7997
7998 /**
7999 * @inheritdoc
8000 */
8001 OO.ui.ProcessDialog.prototype.getActionWidgets = function ( actions ) {
8002 var i, len, widgets = [];
8003 for ( i = 0, len = actions.length; i < len; i++ ) {
8004 widgets.push(
8005 new OO.ui.ActionWidget( $.extend( { framed: true }, actions[ i ] ) )
8006 );
8007 }
8008 return widgets;
8009 };
8010
8011 /**
8012 * @inheritdoc
8013 */
8014 OO.ui.ProcessDialog.prototype.attachActions = function () {
8015 var i, len, other, special, others;
8016
8017 // Parent method
8018 OO.ui.ProcessDialog.super.prototype.attachActions.call( this );
8019
8020 special = this.actions.getSpecial();
8021 others = this.actions.getOthers();
8022 if ( special.primary ) {
8023 this.$primaryActions.append( special.primary.$element );
8024 }
8025 for ( i = 0, len = others.length; i < len; i++ ) {
8026 other = others[ i ];
8027 this.$otherActions.append( other.$element );
8028 }
8029 if ( special.safe ) {
8030 this.$safeActions.append( special.safe.$element );
8031 }
8032
8033 this.fitLabel();
8034 this.$body.css( 'bottom', this.$foot.outerHeight( true ) );
8035 };
8036
8037 /**
8038 * @inheritdoc
8039 */
8040 OO.ui.ProcessDialog.prototype.executeAction = function ( action ) {
8041 var process = this;
8042 return OO.ui.ProcessDialog.super.prototype.executeAction.call( this, action )
8043 .fail( function ( errors ) {
8044 process.showErrors( errors || [] );
8045 } );
8046 };
8047
8048 /**
8049 * Fit label between actions.
8050 *
8051 * @private
8052 * @chainable
8053 */
8054 OO.ui.ProcessDialog.prototype.fitLabel = function () {
8055 var width = Math.max(
8056 this.$safeActions.is( ':visible' ) ? this.$safeActions.width() : 0,
8057 this.$primaryActions.is( ':visible' ) ? this.$primaryActions.width() : 0
8058 );
8059 this.$location.css( { paddingLeft: width, paddingRight: width } );
8060
8061 return this;
8062 };
8063
8064 /**
8065 * Handle errors that occurred during accept or reject processes.
8066 *
8067 * @private
8068 * @param {OO.ui.Error[]|OO.ui.Error} errors Errors to be handled
8069 */
8070 OO.ui.ProcessDialog.prototype.showErrors = function ( errors ) {
8071 var i, len, $item, actions,
8072 items = [],
8073 abilities = {},
8074 recoverable = true,
8075 warning = false;
8076
8077 if ( errors instanceof OO.ui.Error ) {
8078 errors = [ errors ];
8079 }
8080
8081 for ( i = 0, len = errors.length; i < len; i++ ) {
8082 if ( !errors[ i ].isRecoverable() ) {
8083 recoverable = false;
8084 }
8085 if ( errors[ i ].isWarning() ) {
8086 warning = true;
8087 }
8088 $item = $( '<div>' )
8089 .addClass( 'oo-ui-processDialog-error' )
8090 .append( errors[ i ].getMessage() );
8091 items.push( $item[ 0 ] );
8092 }
8093 this.$errorItems = $( items );
8094 if ( recoverable ) {
8095 abilities[this.currentAction] = true;
8096 // Copy the flags from the first matching action
8097 actions = this.actions.get( { actions: this.currentAction } );
8098 if ( actions.length ) {
8099 this.retryButton.clearFlags().setFlags( actions[0].getFlags() );
8100 }
8101 } else {
8102 abilities[this.currentAction] = false;
8103 this.actions.setAbilities( abilities );
8104 }
8105 if ( warning ) {
8106 this.retryButton.setLabel( OO.ui.msg( 'ooui-dialog-process-continue' ) );
8107 } else {
8108 this.retryButton.setLabel( OO.ui.msg( 'ooui-dialog-process-retry' ) );
8109 }
8110 this.retryButton.toggle( recoverable );
8111 this.$errorsTitle.after( this.$errorItems );
8112 this.$errors.removeClass( 'oo-ui-element-hidden' ).scrollTop( 0 );
8113 };
8114
8115 /**
8116 * Hide errors.
8117 *
8118 * @private
8119 */
8120 OO.ui.ProcessDialog.prototype.hideErrors = function () {
8121 this.$errors.addClass( 'oo-ui-element-hidden' );
8122 if ( this.$errorItems ) {
8123 this.$errorItems.remove();
8124 this.$errorItems = null;
8125 }
8126 };
8127
8128 /**
8129 * @inheritdoc
8130 */
8131 OO.ui.ProcessDialog.prototype.getTeardownProcess = function ( data ) {
8132 // Parent method
8133 return OO.ui.ProcessDialog.super.prototype.getTeardownProcess.call( this, data )
8134 .first( function () {
8135 // Make sure to hide errors
8136 this.hideErrors();
8137 }, this );
8138 };
8139
8140 /**
8141 * FieldLayouts are used with OO.ui.FieldsetLayout. Each FieldLayout requires a field-widget,
8142 * which is a widget that is specified by reference before any optional configuration settings.
8143 *
8144 * Field layouts can be configured with help text and/or labels. Labels are aligned in one of four ways:
8145 *
8146 * - **left**: The label is placed before the field-widget and aligned with the left margin.
8147 * A left-alignment is used for forms with many fields.
8148 * - **right**: The label is placed before the field-widget and aligned to the right margin.
8149 * A right-alignment is used for long but familiar forms which users tab through,
8150 * verifying the current field with a quick glance at the label.
8151 * - **top**: The label is placed above the field-widget. A top-alignment is used for brief forms
8152 * that users fill out from top to bottom.
8153 * - **inline**: The label is placed after the field-widget and aligned to the left.
8154 * An inline-alignment is best used with checkboxes or radio buttons.
8155 *
8156 * Help text is accessed via a help icon that appears in the upper right corner of the rendered field layout.
8157 * Please see the [OOjs UI documentation on MediaWiki] [1] for examples and more information.
8158 *
8159 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Layouts/Fields_and_Fieldsets
8160 * @class
8161 * @extends OO.ui.Layout
8162 * @mixins OO.ui.LabelElement
8163 *
8164 * @constructor
8165 * @param {OO.ui.Widget} fieldWidget Field widget
8166 * @param {Object} [config] Configuration options
8167 * @cfg {string} [align='left'] Alignment of the label: 'left', 'right', 'top' or 'inline'
8168 * @cfg {string} [help] Help text. When help text is specified, a help icon will appear
8169 * in the upper-right corner of the rendered field.
8170 */
8171 OO.ui.FieldLayout = function OoUiFieldLayout( fieldWidget, config ) {
8172 // Allow passing positional parameters inside the config object
8173 if ( OO.isPlainObject( fieldWidget ) && config === undefined ) {
8174 config = fieldWidget;
8175 fieldWidget = config.fieldWidget;
8176 }
8177
8178 var hasInputWidget = fieldWidget instanceof OO.ui.InputWidget;
8179
8180 // Configuration initialization
8181 config = $.extend( { align: 'left' }, config );
8182
8183 // Parent constructor
8184 OO.ui.FieldLayout.super.call( this, config );
8185
8186 // Mixin constructors
8187 OO.ui.LabelElement.call( this, config );
8188
8189 // Properties
8190 this.fieldWidget = fieldWidget;
8191 this.$field = $( '<div>' );
8192 this.$body = $( '<' + ( hasInputWidget ? 'label' : 'div' ) + '>' );
8193 this.align = null;
8194 if ( config.help ) {
8195 this.popupButtonWidget = new OO.ui.PopupButtonWidget( {
8196 classes: [ 'oo-ui-fieldLayout-help' ],
8197 framed: false,
8198 icon: 'info'
8199 } );
8200
8201 this.popupButtonWidget.getPopup().$body.append(
8202 $( '<div>' )
8203 .text( config.help )
8204 .addClass( 'oo-ui-fieldLayout-help-content' )
8205 );
8206 this.$help = this.popupButtonWidget.$element;
8207 } else {
8208 this.$help = $( [] );
8209 }
8210
8211 // Events
8212 if ( hasInputWidget ) {
8213 this.$label.on( 'click', this.onLabelClick.bind( this ) );
8214 }
8215 this.fieldWidget.connect( this, { disable: 'onFieldDisable' } );
8216
8217 // Initialization
8218 this.$element
8219 .addClass( 'oo-ui-fieldLayout' )
8220 .append( this.$help, this.$body );
8221 this.$body.addClass( 'oo-ui-fieldLayout-body' );
8222 this.$field
8223 .addClass( 'oo-ui-fieldLayout-field' )
8224 .toggleClass( 'oo-ui-fieldLayout-disable', this.fieldWidget.isDisabled() )
8225 .append( this.fieldWidget.$element );
8226
8227 this.setAlignment( config.align );
8228 };
8229
8230 /* Setup */
8231
8232 OO.inheritClass( OO.ui.FieldLayout, OO.ui.Layout );
8233 OO.mixinClass( OO.ui.FieldLayout, OO.ui.LabelElement );
8234
8235 /* Methods */
8236
8237 /**
8238 * Handle field disable events.
8239 *
8240 * @private
8241 * @param {boolean} value Field is disabled
8242 */
8243 OO.ui.FieldLayout.prototype.onFieldDisable = function ( value ) {
8244 this.$element.toggleClass( 'oo-ui-fieldLayout-disabled', value );
8245 };
8246
8247 /**
8248 * Handle label mouse click events.
8249 *
8250 * @private
8251 * @param {jQuery.Event} e Mouse click event
8252 */
8253 OO.ui.FieldLayout.prototype.onLabelClick = function () {
8254 this.fieldWidget.simulateLabelClick();
8255 return false;
8256 };
8257
8258 /**
8259 * Get the widget contained by the field.
8260 *
8261 * @return {OO.ui.Widget} Field widget
8262 */
8263 OO.ui.FieldLayout.prototype.getField = function () {
8264 return this.fieldWidget;
8265 };
8266
8267 /**
8268 * Set the field alignment mode.
8269 *
8270 * @private
8271 * @param {string} value Alignment mode, either 'left', 'right', 'top' or 'inline'
8272 * @chainable
8273 */
8274 OO.ui.FieldLayout.prototype.setAlignment = function ( value ) {
8275 if ( value !== this.align ) {
8276 // Default to 'left'
8277 if ( [ 'left', 'right', 'top', 'inline' ].indexOf( value ) === -1 ) {
8278 value = 'left';
8279 }
8280 // Reorder elements
8281 if ( value === 'inline' ) {
8282 this.$body.append( this.$field, this.$label );
8283 } else {
8284 this.$body.append( this.$label, this.$field );
8285 }
8286 // Set classes. The following classes can be used here:
8287 // * oo-ui-fieldLayout-align-left
8288 // * oo-ui-fieldLayout-align-right
8289 // * oo-ui-fieldLayout-align-top
8290 // * oo-ui-fieldLayout-align-inline
8291 if ( this.align ) {
8292 this.$element.removeClass( 'oo-ui-fieldLayout-align-' + this.align );
8293 }
8294 this.$element.addClass( 'oo-ui-fieldLayout-align-' + value );
8295 this.align = value;
8296 }
8297
8298 return this;
8299 };
8300
8301 /**
8302 * ActionFieldLayouts are used with OO.ui.FieldsetLayout. The layout consists of a field-widget, a button,
8303 * and an optional label and/or help text. The field-widget (e.g., a {@link OO.ui.TextInputWidget TextInputWidget}),
8304 * is required and is specified before any optional configuration settings.
8305 *
8306 * Labels can be aligned in one of four ways:
8307 *
8308 * - **left**: The label is placed before the field-widget and aligned with the left margin.
8309 * A left-alignment is used for forms with many fields.
8310 * - **right**: The label is placed before the field-widget and aligned to the right margin.
8311 * A right-alignment is used for long but familiar forms which users tab through,
8312 * verifying the current field with a quick glance at the label.
8313 * - **top**: The label is placed above the field-widget. A top-alignment is used for brief forms
8314 * that users fill out from top to bottom.
8315 * - **inline**: The label is placed after the field-widget and aligned to the left.
8316 * An inline-alignment is best used with checkboxes or radio buttons.
8317 *
8318 * Help text is accessed via a help icon that appears in the upper right corner of the rendered field layout when help
8319 * text is specified.
8320 *
8321 * @example
8322 * // Example of an ActionFieldLayout
8323 * var actionFieldLayout = new OO.ui.ActionFieldLayout(
8324 * new OO.ui.TextInputWidget( {
8325 * placeholder: 'Field widget'
8326 * } ),
8327 * new OO.ui.ButtonWidget( {
8328 * label: 'Button'
8329 * } ),
8330 * {
8331 * label: 'An ActionFieldLayout. This label is aligned top',
8332 * align: 'top',
8333 * help: 'This is help text'
8334 * }
8335 * );
8336 *
8337 * $( 'body' ).append( actionFieldLayout.$element );
8338 *
8339 *
8340 * @class
8341 * @extends OO.ui.FieldLayout
8342 *
8343 * @constructor
8344 * @param {OO.ui.Widget} fieldWidget Field widget
8345 * @param {OO.ui.ButtonWidget} buttonWidget Button widget
8346 * @param {Object} [config] Configuration options
8347 * @cfg {string} [align='left'] Alignment of the label: 'left', 'right', 'top' or 'inline'
8348 * @cfg {string} [help] Help text. When help text is specified, a help icon will appear in the
8349 * upper-right corner of the rendered field.
8350 */
8351 OO.ui.ActionFieldLayout = function OoUiActionFieldLayout( fieldWidget, buttonWidget, config ) {
8352 // Allow passing positional parameters inside the config object
8353 if ( OO.isPlainObject( fieldWidget ) && config === undefined ) {
8354 config = fieldWidget;
8355 fieldWidget = config.fieldWidget;
8356 buttonWidget = config.buttonWidget;
8357 }
8358
8359 // Configuration initialization
8360 config = $.extend( { align: 'left' }, config );
8361
8362 // Parent constructor
8363 OO.ui.ActionFieldLayout.super.call( this, fieldWidget, config );
8364
8365 // Properties
8366 this.fieldWidget = fieldWidget;
8367 this.buttonWidget = buttonWidget;
8368 this.$button = $( '<div>' )
8369 .addClass( 'oo-ui-actionFieldLayout-button' )
8370 .append( this.buttonWidget.$element );
8371 this.$input = $( '<div>' )
8372 .addClass( 'oo-ui-actionFieldLayout-input' )
8373 .append( this.fieldWidget.$element );
8374 this.$field
8375 .addClass( 'oo-ui-actionFieldLayout' )
8376 .append( this.$input, this.$button );
8377 };
8378
8379 /* Setup */
8380
8381 OO.inheritClass( OO.ui.ActionFieldLayout, OO.ui.FieldLayout );
8382
8383 /**
8384 * FieldsetLayouts are composed of one or more {@link OO.ui.FieldLayout FieldLayouts},
8385 * which each contain an individual widget and, optionally, a label. Each Fieldset can be
8386 * configured with a label as well. For more information and examples,
8387 * please see the [OOjs UI documentation on MediaWiki][1].
8388 *
8389 * @example
8390 * // Example of a fieldset layout
8391 * var input1 = new OO.ui.TextInputWidget( {
8392 * placeholder: 'A text input field'
8393 * } );
8394 *
8395 * var input2 = new OO.ui.TextInputWidget( {
8396 * placeholder: 'A text input field'
8397 * } );
8398 *
8399 * var fieldset = new OO.ui.FieldsetLayout( {
8400 * label: 'Example of a fieldset layout'
8401 * } );
8402 *
8403 * fieldset.addItems( [
8404 * new OO.ui.FieldLayout( input1, {
8405 * label: 'Field One'
8406 * } ),
8407 * new OO.ui.FieldLayout( input2, {
8408 * label: 'Field Two'
8409 * } )
8410 * ] );
8411 * $( 'body' ).append( fieldset.$element );
8412 *
8413 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Layouts/Fields_and_Fieldsets
8414 *
8415 * @class
8416 * @extends OO.ui.Layout
8417 * @mixins OO.ui.IconElement
8418 * @mixins OO.ui.LabelElement
8419 * @mixins OO.ui.GroupElement
8420 *
8421 * @constructor
8422 * @param {Object} [config] Configuration options
8423 * @cfg {OO.ui.FieldLayout[]} [items] An array of fields to add to the fieldset. See OO.ui.FieldLayout for more information about fields.
8424 */
8425 OO.ui.FieldsetLayout = function OoUiFieldsetLayout( config ) {
8426 // Configuration initialization
8427 config = config || {};
8428
8429 // Parent constructor
8430 OO.ui.FieldsetLayout.super.call( this, config );
8431
8432 // Mixin constructors
8433 OO.ui.IconElement.call( this, config );
8434 OO.ui.LabelElement.call( this, config );
8435 OO.ui.GroupElement.call( this, config );
8436
8437 if ( config.help ) {
8438 this.popupButtonWidget = new OO.ui.PopupButtonWidget( {
8439 classes: [ 'oo-ui-fieldsetLayout-help' ],
8440 framed: false,
8441 icon: 'info'
8442 } );
8443
8444 this.popupButtonWidget.getPopup().$body.append(
8445 $( '<div>' )
8446 .text( config.help )
8447 .addClass( 'oo-ui-fieldsetLayout-help-content' )
8448 );
8449 this.$help = this.popupButtonWidget.$element;
8450 } else {
8451 this.$help = $( [] );
8452 }
8453
8454 // Initialization
8455 this.$element
8456 .addClass( 'oo-ui-fieldsetLayout' )
8457 .prepend( this.$help, this.$icon, this.$label, this.$group );
8458 if ( Array.isArray( config.items ) ) {
8459 this.addItems( config.items );
8460 }
8461 };
8462
8463 /* Setup */
8464
8465 OO.inheritClass( OO.ui.FieldsetLayout, OO.ui.Layout );
8466 OO.mixinClass( OO.ui.FieldsetLayout, OO.ui.IconElement );
8467 OO.mixinClass( OO.ui.FieldsetLayout, OO.ui.LabelElement );
8468 OO.mixinClass( OO.ui.FieldsetLayout, OO.ui.GroupElement );
8469
8470 /**
8471 * FormLayouts are used to wrap {@link OO.ui.FieldsetLayout FieldsetLayouts} when you intend to use browser-based
8472 * form submission for the fields instead of handling them in JavaScript. Form layouts can be configured with an
8473 * HTML form action, an encoding type, and a method using the #action, #enctype, and #method configs, respectively.
8474 * See the [OOjs UI documentation on MediaWiki] [1] for more information and examples.
8475 *
8476 * Only widgets from the {@link OO.ui.InputWidget InputWidget} family support form submission. It
8477 * includes standard form elements like {@link OO.ui.CheckboxInputWidget checkboxes}, {@link
8478 * OO.ui.RadioInputWidget radio buttons} and {@link OO.ui.TextInputWidget text fields}, as well as
8479 * some fancier controls. Some controls have both regular and InputWidget variants, for example
8480 * OO.ui.DropdownWidget and OO.ui.DropdownInputWidget – only the latter support form submission and
8481 * often have simplified APIs to match the capabilities of HTML forms.
8482 * See the [OOjs UI Inputs documentation on MediaWiki] [2] for more information about InputWidgets.
8483 *
8484 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Layouts/Forms
8485 * [2]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Inputs
8486 *
8487 * @example
8488 * // Example of a form layout that wraps a fieldset layout
8489 * var input1 = new OO.ui.TextInputWidget( {
8490 * placeholder: 'Username'
8491 * } );
8492 * var input2 = new OO.ui.TextInputWidget( {
8493 * placeholder: 'Password',
8494 * type: 'password'
8495 * } );
8496 * var submit = new OO.ui.ButtonInputWidget( {
8497 * label: 'Submit'
8498 * } );
8499 *
8500 * var fieldset = new OO.ui.FieldsetLayout( {
8501 * label: 'A form layout'
8502 * } );
8503 * fieldset.addItems( [
8504 * new OO.ui.FieldLayout( input1, {
8505 * label: 'Username',
8506 * align: 'top'
8507 * } ),
8508 * new OO.ui.FieldLayout( input2, {
8509 * label: 'Password',
8510 * align: 'top'
8511 * } ),
8512 * new OO.ui.FieldLayout( submit )
8513 * ] );
8514 * var form = new OO.ui.FormLayout( {
8515 * items: [ fieldset ],
8516 * action: '/api/formhandler',
8517 * method: 'get'
8518 * } )
8519 * $( 'body' ).append( form.$element );
8520 *
8521 * @class
8522 * @extends OO.ui.Layout
8523 * @mixins OO.ui.GroupElement
8524 *
8525 * @constructor
8526 * @param {Object} [config] Configuration options
8527 * @cfg {string} [method] HTML form `method` attribute
8528 * @cfg {string} [action] HTML form `action` attribute
8529 * @cfg {string} [enctype] HTML form `enctype` attribute
8530 * @cfg {OO.ui.FieldsetLayout[]} [items] Fieldset layouts to add to the form layout.
8531 */
8532 OO.ui.FormLayout = function OoUiFormLayout( config ) {
8533 // Configuration initialization
8534 config = config || {};
8535
8536 // Parent constructor
8537 OO.ui.FormLayout.super.call( this, config );
8538
8539 // Mixin constructors
8540 OO.ui.GroupElement.call( this, $.extend( {}, config, { $group: this.$element } ) );
8541
8542 // Events
8543 this.$element.on( 'submit', this.onFormSubmit.bind( this ) );
8544
8545 // Initialization
8546 this.$element
8547 .addClass( 'oo-ui-formLayout' )
8548 .attr( {
8549 method: config.method,
8550 action: config.action,
8551 enctype: config.enctype
8552 } );
8553 if ( Array.isArray( config.items ) ) {
8554 this.addItems( config.items );
8555 }
8556 };
8557
8558 /* Setup */
8559
8560 OO.inheritClass( OO.ui.FormLayout, OO.ui.Layout );
8561 OO.mixinClass( OO.ui.FormLayout, OO.ui.GroupElement );
8562
8563 /* Events */
8564
8565 /**
8566 * A 'submit' event is emitted when the form is submitted.
8567 *
8568 * @event submit
8569 */
8570
8571 /* Static Properties */
8572
8573 OO.ui.FormLayout.static.tagName = 'form';
8574
8575 /* Methods */
8576
8577 /**
8578 * Handle form submit events.
8579 *
8580 * @private
8581 * @param {jQuery.Event} e Submit event
8582 * @fires submit
8583 */
8584 OO.ui.FormLayout.prototype.onFormSubmit = function () {
8585 if ( this.emit( 'submit' ) ) {
8586 return false;
8587 }
8588 };
8589
8590 /**
8591 * MenuLayouts combine a menu and a content {@link OO.ui.PanelLayout panel}. The menu is positioned relative to the content (after, before, top, or bottom)
8592 * and its size is customized with the #menuSize config. The content area will fill all remaining space.
8593 *
8594 * @example
8595 * var menuLayout = new OO.ui.MenuLayout( {
8596 * position: 'top'
8597 * } ),
8598 * menuPanel = new OO.ui.PanelLayout( { padded: true, expanded: true, scrollable: true } ),
8599 * contentPanel = new OO.ui.PanelLayout( { padded: true, expanded: true, scrollable: true } ),
8600 * select = new OO.ui.SelectWidget( {
8601 * items: [
8602 * new OO.ui.OptionWidget( {
8603 * data: 'before',
8604 * label: 'Before',
8605 * } ),
8606 * new OO.ui.OptionWidget( {
8607 * data: 'after',
8608 * label: 'After',
8609 * } ),
8610 * new OO.ui.OptionWidget( {
8611 * data: 'top',
8612 * label: 'Top',
8613 * } ),
8614 * new OO.ui.OptionWidget( {
8615 * data: 'bottom',
8616 * label: 'Bottom',
8617 * } )
8618 * ]
8619 * } ).on( 'select', function ( item ) {
8620 * menuLayout.setMenuPosition( item.getData() );
8621 * } );
8622 *
8623 * menuLayout.$menu.append(
8624 * menuPanel.$element.append( '<b>Menu panel</b>', select.$element )
8625 * );
8626 * menuLayout.$content.append(
8627 * contentPanel.$element.append( '<b>Content panel</b>', '<p>Note that the menu is positioned relative to the content panel: top, bottom, after, before.</p>')
8628 * );
8629 * $( 'body' ).append( menuLayout.$element );
8630 *
8631 * If menu size needs to be overridden, it can be accomplished using CSS similar to the snippet
8632 * below. MenuLayout's CSS will override the appropriate values with 'auto' or '0' to display the
8633 * menu correctly. If `menuPosition` is known beforehand, CSS rules corresponding to other positions
8634 * may be omitted.
8635 *
8636 * .oo-ui-menuLayout-menu {
8637 * height: 200px;
8638 * width: 200px;
8639 * }
8640 * .oo-ui-menuLayout-content {
8641 * top: 200px;
8642 * left: 200px;
8643 * right: 200px;
8644 * bottom: 200px;
8645 * }
8646 *
8647 * @class
8648 * @extends OO.ui.Layout
8649 *
8650 * @constructor
8651 * @param {Object} [config] Configuration options
8652 * @cfg {boolean} [showMenu=true] Show menu
8653 * @cfg {string} [menuPosition='before'] Position of menu: `top`, `after`, `bottom` or `before`
8654 */
8655 OO.ui.MenuLayout = function OoUiMenuLayout( config ) {
8656 // Configuration initialization
8657 config = $.extend( {
8658 showMenu: true,
8659 menuPosition: 'before'
8660 }, config );
8661
8662 // Parent constructor
8663 OO.ui.MenuLayout.super.call( this, config );
8664
8665 /**
8666 * Menu DOM node
8667 *
8668 * @property {jQuery}
8669 */
8670 this.$menu = $( '<div>' );
8671 /**
8672 * Content DOM node
8673 *
8674 * @property {jQuery}
8675 */
8676 this.$content = $( '<div>' );
8677
8678 // Initialization
8679 this.$menu
8680 .addClass( 'oo-ui-menuLayout-menu' );
8681 this.$content.addClass( 'oo-ui-menuLayout-content' );
8682 this.$element
8683 .addClass( 'oo-ui-menuLayout' )
8684 .append( this.$content, this.$menu );
8685 this.setMenuPosition( config.menuPosition );
8686 this.toggleMenu( config.showMenu );
8687 };
8688
8689 /* Setup */
8690
8691 OO.inheritClass( OO.ui.MenuLayout, OO.ui.Layout );
8692
8693 /* Methods */
8694
8695 /**
8696 * Toggle menu.
8697 *
8698 * @param {boolean} showMenu Show menu, omit to toggle
8699 * @chainable
8700 */
8701 OO.ui.MenuLayout.prototype.toggleMenu = function ( showMenu ) {
8702 showMenu = showMenu === undefined ? !this.showMenu : !!showMenu;
8703
8704 if ( this.showMenu !== showMenu ) {
8705 this.showMenu = showMenu;
8706 this.$element
8707 .toggleClass( 'oo-ui-menuLayout-showMenu', this.showMenu )
8708 .toggleClass( 'oo-ui-menuLayout-hideMenu', !this.showMenu );
8709 }
8710
8711 return this;
8712 };
8713
8714 /**
8715 * Check if menu is visible
8716 *
8717 * @return {boolean} Menu is visible
8718 */
8719 OO.ui.MenuLayout.prototype.isMenuVisible = function () {
8720 return this.showMenu;
8721 };
8722
8723 /**
8724 * Set menu position.
8725 *
8726 * @param {string} position Position of menu, either `top`, `after`, `bottom` or `before`
8727 * @throws {Error} If position value is not supported
8728 * @chainable
8729 */
8730 OO.ui.MenuLayout.prototype.setMenuPosition = function ( position ) {
8731 this.$element.removeClass( 'oo-ui-menuLayout-' + this.menuPosition );
8732 this.menuPosition = position;
8733 this.$element.addClass( 'oo-ui-menuLayout-' + position );
8734
8735 return this;
8736 };
8737
8738 /**
8739 * Get menu position.
8740 *
8741 * @return {string} Menu position
8742 */
8743 OO.ui.MenuLayout.prototype.getMenuPosition = function () {
8744 return this.menuPosition;
8745 };
8746
8747 /**
8748 * BookletLayouts contain {@link OO.ui.PageLayout page layouts} as well as
8749 * an {@link OO.ui.OutlineSelectWidget outline} that allows users to easily navigate
8750 * through the pages and select which one to display. By default, only one page is
8751 * displayed at a time and the outline is hidden. When a user navigates to a new page,
8752 * the booklet layout automatically focuses on the first focusable element, unless the
8753 * default setting is changed. Optionally, booklets can be configured to show
8754 * {@link OO.ui.OutlineControlsWidget controls} for adding, moving, and removing items.
8755 *
8756 * @example
8757 * // Example of a BookletLayout that contains two PageLayouts.
8758 *
8759 * function PageOneLayout( name, config ) {
8760 * PageOneLayout.super.call( this, name, config );
8761 * this.$element.append( '<p>First page</p><p>(This booklet has an outline, displayed on the left)</p>' );
8762 * }
8763 * OO.inheritClass( PageOneLayout, OO.ui.PageLayout );
8764 * PageOneLayout.prototype.setupOutlineItem = function () {
8765 * this.outlineItem.setLabel( 'Page One' );
8766 * };
8767 *
8768 * function PageTwoLayout( name, config ) {
8769 * PageTwoLayout.super.call( this, name, config );
8770 * this.$element.append( '<p>Second page</p>' );
8771 * }
8772 * OO.inheritClass( PageTwoLayout, OO.ui.PageLayout );
8773 * PageTwoLayout.prototype.setupOutlineItem = function () {
8774 * this.outlineItem.setLabel( 'Page Two' );
8775 * };
8776 *
8777 * var page1 = new PageOneLayout( 'one' ),
8778 * page2 = new PageTwoLayout( 'two' );
8779 *
8780 * var booklet = new OO.ui.BookletLayout( {
8781 * outlined: true
8782 * } );
8783 *
8784 * booklet.addPages ( [ page1, page2 ] );
8785 * $( 'body' ).append( booklet.$element );
8786 *
8787 * @class
8788 * @extends OO.ui.MenuLayout
8789 *
8790 * @constructor
8791 * @param {Object} [config] Configuration options
8792 * @cfg {boolean} [continuous=false] Show all pages, one after another
8793 * @cfg {boolean} [autoFocus=true] Focus on the first focusable element when a new page is displayed.
8794 * @cfg {boolean} [outlined=false] Show the outline. The outline is used to navigate through the pages of the booklet.
8795 * @cfg {boolean} [editable=false] Show controls for adding, removing and reordering pages
8796 */
8797 OO.ui.BookletLayout = function OoUiBookletLayout( config ) {
8798 // Configuration initialization
8799 config = config || {};
8800
8801 // Parent constructor
8802 OO.ui.BookletLayout.super.call( this, config );
8803
8804 // Properties
8805 this.currentPageName = null;
8806 this.pages = {};
8807 this.ignoreFocus = false;
8808 this.stackLayout = new OO.ui.StackLayout( { continuous: !!config.continuous } );
8809 this.$content.append( this.stackLayout.$element );
8810 this.autoFocus = config.autoFocus === undefined || !!config.autoFocus;
8811 this.outlineVisible = false;
8812 this.outlined = !!config.outlined;
8813 if ( this.outlined ) {
8814 this.editable = !!config.editable;
8815 this.outlineControlsWidget = null;
8816 this.outlineSelectWidget = new OO.ui.OutlineSelectWidget();
8817 this.outlinePanel = new OO.ui.PanelLayout( { scrollable: true } );
8818 this.$menu.append( this.outlinePanel.$element );
8819 this.outlineVisible = true;
8820 if ( this.editable ) {
8821 this.outlineControlsWidget = new OO.ui.OutlineControlsWidget(
8822 this.outlineSelectWidget
8823 );
8824 }
8825 }
8826 this.toggleMenu( this.outlined );
8827
8828 // Events
8829 this.stackLayout.connect( this, { set: 'onStackLayoutSet' } );
8830 if ( this.outlined ) {
8831 this.outlineSelectWidget.connect( this, { select: 'onOutlineSelectWidgetSelect' } );
8832 }
8833 if ( this.autoFocus ) {
8834 // Event 'focus' does not bubble, but 'focusin' does
8835 this.stackLayout.$element.on( 'focusin', this.onStackLayoutFocus.bind( this ) );
8836 }
8837
8838 // Initialization
8839 this.$element.addClass( 'oo-ui-bookletLayout' );
8840 this.stackLayout.$element.addClass( 'oo-ui-bookletLayout-stackLayout' );
8841 if ( this.outlined ) {
8842 this.outlinePanel.$element
8843 .addClass( 'oo-ui-bookletLayout-outlinePanel' )
8844 .append( this.outlineSelectWidget.$element );
8845 if ( this.editable ) {
8846 this.outlinePanel.$element
8847 .addClass( 'oo-ui-bookletLayout-outlinePanel-editable' )
8848 .append( this.outlineControlsWidget.$element );
8849 }
8850 }
8851 };
8852
8853 /* Setup */
8854
8855 OO.inheritClass( OO.ui.BookletLayout, OO.ui.MenuLayout );
8856
8857 /* Events */
8858
8859 /**
8860 * A 'set' event is emitted when a page is {@link #setPage set} to be displayed by the booklet layout.
8861 * @event set
8862 * @param {OO.ui.PageLayout} page Current page
8863 */
8864
8865 /**
8866 * An 'add' event is emitted when pages are {@link #addPages added} to the booklet layout.
8867 *
8868 * @event add
8869 * @param {OO.ui.PageLayout[]} page Added pages
8870 * @param {number} index Index pages were added at
8871 */
8872
8873 /**
8874 * A 'remove' event is emitted when pages are {@link #clearPages cleared} or
8875 * {@link #removePages removed} from the booklet.
8876 *
8877 * @event remove
8878 * @param {OO.ui.PageLayout[]} pages Removed pages
8879 */
8880
8881 /* Methods */
8882
8883 /**
8884 * Handle stack layout focus.
8885 *
8886 * @private
8887 * @param {jQuery.Event} e Focusin event
8888 */
8889 OO.ui.BookletLayout.prototype.onStackLayoutFocus = function ( e ) {
8890 var name, $target;
8891
8892 // Find the page that an element was focused within
8893 $target = $( e.target ).closest( '.oo-ui-pageLayout' );
8894 for ( name in this.pages ) {
8895 // Check for page match, exclude current page to find only page changes
8896 if ( this.pages[ name ].$element[ 0 ] === $target[ 0 ] && name !== this.currentPageName ) {
8897 this.setPage( name );
8898 break;
8899 }
8900 }
8901 };
8902
8903 /**
8904 * Handle stack layout set events.
8905 *
8906 * @private
8907 * @param {OO.ui.PanelLayout|null} page The page panel that is now the current panel
8908 */
8909 OO.ui.BookletLayout.prototype.onStackLayoutSet = function ( page ) {
8910 var layout = this;
8911 if ( page ) {
8912 page.scrollElementIntoView( { complete: function () {
8913 if ( layout.autoFocus ) {
8914 layout.focus();
8915 }
8916 } } );
8917 }
8918 };
8919
8920 /**
8921 * Focus the first input in the current page.
8922 *
8923 * If no page is selected, the first selectable page will be selected.
8924 * If the focus is already in an element on the current page, nothing will happen.
8925 * @param {number} [itemIndex] A specific item to focus on
8926 */
8927 OO.ui.BookletLayout.prototype.focus = function ( itemIndex ) {
8928 var $input, page,
8929 items = this.stackLayout.getItems();
8930
8931 if ( itemIndex !== undefined && items[ itemIndex ] ) {
8932 page = items[ itemIndex ];
8933 } else {
8934 page = this.stackLayout.getCurrentItem();
8935 }
8936
8937 if ( !page && this.outlined ) {
8938 this.selectFirstSelectablePage();
8939 page = this.stackLayout.getCurrentItem();
8940 }
8941 if ( !page ) {
8942 return;
8943 }
8944 // Only change the focus if is not already in the current page
8945 if ( !page.$element.find( ':focus' ).length ) {
8946 $input = page.$element.find( ':input:first' );
8947 if ( $input.length ) {
8948 $input[ 0 ].focus();
8949 }
8950 }
8951 };
8952
8953 /**
8954 * Find the first focusable input in the booklet layout and focus
8955 * on it.
8956 */
8957 OO.ui.BookletLayout.prototype.focusFirstFocusable = function () {
8958 var i, len,
8959 found = false,
8960 items = this.stackLayout.getItems(),
8961 checkAndFocus = function () {
8962 if ( OO.ui.isFocusableElement( $( this ) ) ) {
8963 $( this ).focus();
8964 found = true;
8965 return false;
8966 }
8967 };
8968
8969 for ( i = 0, len = items.length; i < len; i++ ) {
8970 if ( found ) {
8971 break;
8972 }
8973 // Find all potentially focusable elements in the item
8974 // and check if they are focusable
8975 items[i].$element
8976 .find( 'input, select, textarea, button, object' )
8977 /* jshint loopfunc:true */
8978 .each( checkAndFocus );
8979 }
8980 };
8981
8982 /**
8983 * Handle outline widget select events.
8984 *
8985 * @private
8986 * @param {OO.ui.OptionWidget|null} item Selected item
8987 */
8988 OO.ui.BookletLayout.prototype.onOutlineSelectWidgetSelect = function ( item ) {
8989 if ( item ) {
8990 this.setPage( item.getData() );
8991 }
8992 };
8993
8994 /**
8995 * Check if booklet has an outline.
8996 *
8997 * @return {boolean} Booklet has an outline
8998 */
8999 OO.ui.BookletLayout.prototype.isOutlined = function () {
9000 return this.outlined;
9001 };
9002
9003 /**
9004 * Check if booklet has editing controls.
9005 *
9006 * @return {boolean} Booklet is editable
9007 */
9008 OO.ui.BookletLayout.prototype.isEditable = function () {
9009 return this.editable;
9010 };
9011
9012 /**
9013 * Check if booklet has a visible outline.
9014 *
9015 * @return {boolean} Outline is visible
9016 */
9017 OO.ui.BookletLayout.prototype.isOutlineVisible = function () {
9018 return this.outlined && this.outlineVisible;
9019 };
9020
9021 /**
9022 * Hide or show the outline.
9023 *
9024 * @param {boolean} [show] Show outline, omit to invert current state
9025 * @chainable
9026 */
9027 OO.ui.BookletLayout.prototype.toggleOutline = function ( show ) {
9028 if ( this.outlined ) {
9029 show = show === undefined ? !this.outlineVisible : !!show;
9030 this.outlineVisible = show;
9031 this.toggleMenu( show );
9032 }
9033
9034 return this;
9035 };
9036
9037 /**
9038 * Get the page closest to the specified page.
9039 *
9040 * @param {OO.ui.PageLayout} page Page to use as a reference point
9041 * @return {OO.ui.PageLayout|null} Page closest to the specified page
9042 */
9043 OO.ui.BookletLayout.prototype.getClosestPage = function ( page ) {
9044 var next, prev, level,
9045 pages = this.stackLayout.getItems(),
9046 index = $.inArray( page, pages );
9047
9048 if ( index !== -1 ) {
9049 next = pages[ index + 1 ];
9050 prev = pages[ index - 1 ];
9051 // Prefer adjacent pages at the same level
9052 if ( this.outlined ) {
9053 level = this.outlineSelectWidget.getItemFromData( page.getName() ).getLevel();
9054 if (
9055 prev &&
9056 level === this.outlineSelectWidget.getItemFromData( prev.getName() ).getLevel()
9057 ) {
9058 return prev;
9059 }
9060 if (
9061 next &&
9062 level === this.outlineSelectWidget.getItemFromData( next.getName() ).getLevel()
9063 ) {
9064 return next;
9065 }
9066 }
9067 }
9068 return prev || next || null;
9069 };
9070
9071 /**
9072 * Get the outline widget.
9073 *
9074 * If the booklet is not outlined, the method will return `null`.
9075 *
9076 * @return {OO.ui.OutlineSelectWidget|null} Outline widget, or null if the booklet is not outlined
9077 */
9078 OO.ui.BookletLayout.prototype.getOutline = function () {
9079 return this.outlineSelectWidget;
9080 };
9081
9082 /**
9083 * Get the outline controls widget.
9084 *
9085 * If the outline is not editable, the method will return `null`.
9086 *
9087 * @return {OO.ui.OutlineControlsWidget|null} The outline controls widget.
9088 */
9089 OO.ui.BookletLayout.prototype.getOutlineControls = function () {
9090 return this.outlineControlsWidget;
9091 };
9092
9093 /**
9094 * Get a page by its symbolic name.
9095 *
9096 * @param {string} name Symbolic name of page
9097 * @return {OO.ui.PageLayout|undefined} Page, if found
9098 */
9099 OO.ui.BookletLayout.prototype.getPage = function ( name ) {
9100 return this.pages[ name ];
9101 };
9102
9103 /**
9104 * Get the current page.
9105 *
9106 * @return {OO.ui.PageLayout|undefined} Current page, if found
9107 */
9108 OO.ui.BookletLayout.prototype.getCurrentPage = function () {
9109 var name = this.getCurrentPageName();
9110 return name ? this.getPage( name ) : undefined;
9111 };
9112
9113 /**
9114 * Get the symbolic name of the current page.
9115 *
9116 * @return {string|null} Symbolic name of the current page
9117 */
9118 OO.ui.BookletLayout.prototype.getCurrentPageName = function () {
9119 return this.currentPageName;
9120 };
9121
9122 /**
9123 * Add pages to the booklet layout
9124 *
9125 * When pages are added with the same names as existing pages, the existing pages will be
9126 * automatically removed before the new pages are added.
9127 *
9128 * @param {OO.ui.PageLayout[]} pages Pages to add
9129 * @param {number} index Index of the insertion point
9130 * @fires add
9131 * @chainable
9132 */
9133 OO.ui.BookletLayout.prototype.addPages = function ( pages, index ) {
9134 var i, len, name, page, item, currentIndex,
9135 stackLayoutPages = this.stackLayout.getItems(),
9136 remove = [],
9137 items = [];
9138
9139 // Remove pages with same names
9140 for ( i = 0, len = pages.length; i < len; i++ ) {
9141 page = pages[ i ];
9142 name = page.getName();
9143
9144 if ( Object.prototype.hasOwnProperty.call( this.pages, name ) ) {
9145 // Correct the insertion index
9146 currentIndex = $.inArray( this.pages[ name ], stackLayoutPages );
9147 if ( currentIndex !== -1 && currentIndex + 1 < index ) {
9148 index--;
9149 }
9150 remove.push( this.pages[ name ] );
9151 }
9152 }
9153 if ( remove.length ) {
9154 this.removePages( remove );
9155 }
9156
9157 // Add new pages
9158 for ( i = 0, len = pages.length; i < len; i++ ) {
9159 page = pages[ i ];
9160 name = page.getName();
9161 this.pages[ page.getName() ] = page;
9162 if ( this.outlined ) {
9163 item = new OO.ui.OutlineOptionWidget( { data: name } );
9164 page.setOutlineItem( item );
9165 items.push( item );
9166 }
9167 }
9168
9169 if ( this.outlined && items.length ) {
9170 this.outlineSelectWidget.addItems( items, index );
9171 this.selectFirstSelectablePage();
9172 }
9173 this.stackLayout.addItems( pages, index );
9174 this.emit( 'add', pages, index );
9175
9176 return this;
9177 };
9178
9179 /**
9180 * Remove the specified pages from the booklet layout.
9181 *
9182 * To remove all pages from the booklet, you may wish to use the #clearPages method instead.
9183 *
9184 * @param {OO.ui.PageLayout[]} pages An array of pages to remove
9185 * @fires remove
9186 * @chainable
9187 */
9188 OO.ui.BookletLayout.prototype.removePages = function ( pages ) {
9189 var i, len, name, page,
9190 items = [];
9191
9192 for ( i = 0, len = pages.length; i < len; i++ ) {
9193 page = pages[ i ];
9194 name = page.getName();
9195 delete this.pages[ name ];
9196 if ( this.outlined ) {
9197 items.push( this.outlineSelectWidget.getItemFromData( name ) );
9198 page.setOutlineItem( null );
9199 }
9200 }
9201 if ( this.outlined && items.length ) {
9202 this.outlineSelectWidget.removeItems( items );
9203 this.selectFirstSelectablePage();
9204 }
9205 this.stackLayout.removeItems( pages );
9206 this.emit( 'remove', pages );
9207
9208 return this;
9209 };
9210
9211 /**
9212 * Clear all pages from the booklet layout.
9213 *
9214 * To remove only a subset of pages from the booklet, use the #removePages method.
9215 *
9216 * @fires remove
9217 * @chainable
9218 */
9219 OO.ui.BookletLayout.prototype.clearPages = function () {
9220 var i, len,
9221 pages = this.stackLayout.getItems();
9222
9223 this.pages = {};
9224 this.currentPageName = null;
9225 if ( this.outlined ) {
9226 this.outlineSelectWidget.clearItems();
9227 for ( i = 0, len = pages.length; i < len; i++ ) {
9228 pages[ i ].setOutlineItem( null );
9229 }
9230 }
9231 this.stackLayout.clearItems();
9232
9233 this.emit( 'remove', pages );
9234
9235 return this;
9236 };
9237
9238 /**
9239 * Set the current page by symbolic name.
9240 *
9241 * @fires set
9242 * @param {string} name Symbolic name of page
9243 */
9244 OO.ui.BookletLayout.prototype.setPage = function ( name ) {
9245 var selectedItem,
9246 $focused,
9247 page = this.pages[ name ];
9248
9249 if ( name !== this.currentPageName ) {
9250 if ( this.outlined ) {
9251 selectedItem = this.outlineSelectWidget.getSelectedItem();
9252 if ( selectedItem && selectedItem.getData() !== name ) {
9253 this.outlineSelectWidget.selectItemByData( name );
9254 }
9255 }
9256 if ( page ) {
9257 if ( this.currentPageName && this.pages[ this.currentPageName ] ) {
9258 this.pages[ this.currentPageName ].setActive( false );
9259 // Blur anything focused if the next page doesn't have anything focusable - this
9260 // is not needed if the next page has something focusable because once it is focused
9261 // this blur happens automatically
9262 if ( this.autoFocus && !page.$element.find( ':input' ).length ) {
9263 $focused = this.pages[ this.currentPageName ].$element.find( ':focus' );
9264 if ( $focused.length ) {
9265 $focused[ 0 ].blur();
9266 }
9267 }
9268 }
9269 this.currentPageName = name;
9270 this.stackLayout.setItem( page );
9271 page.setActive( true );
9272 this.emit( 'set', page );
9273 }
9274 }
9275 };
9276
9277 /**
9278 * Select the first selectable page.
9279 *
9280 * @chainable
9281 */
9282 OO.ui.BookletLayout.prototype.selectFirstSelectablePage = function () {
9283 if ( !this.outlineSelectWidget.getSelectedItem() ) {
9284 this.outlineSelectWidget.selectItem( this.outlineSelectWidget.getFirstSelectableItem() );
9285 }
9286
9287 return this;
9288 };
9289
9290 /**
9291 * IndexLayouts contain {@link OO.ui.CardLayout card layouts} as well as
9292 * {@link OO.ui.TabSelectWidget tabs} that allow users to easily navigate through the cards and
9293 * select which one to display. By default, only one card is displayed at a time. When a user
9294 * navigates to a new card, the index layout automatically focuses on the first focusable element,
9295 * unless the default setting is changed.
9296 *
9297 * TODO: This class is similar to BookletLayout, we may want to refactor to reduce duplication
9298 *
9299 * @example
9300 * // Example of a IndexLayout that contains two CardLayouts.
9301 *
9302 * function CardOneLayout( name, config ) {
9303 * CardOneLayout.super.call( this, name, config );
9304 * this.$element.append( '<p>First card</p>' );
9305 * }
9306 * OO.inheritClass( CardOneLayout, OO.ui.CardLayout );
9307 * CardOneLayout.prototype.setupTabItem = function () {
9308 * this.tabItem.setLabel( 'Card One' );
9309 * };
9310 *
9311 * function CardTwoLayout( name, config ) {
9312 * CardTwoLayout.super.call( this, name, config );
9313 * this.$element.append( '<p>Second card</p>' );
9314 * }
9315 * OO.inheritClass( CardTwoLayout, OO.ui.CardLayout );
9316 * CardTwoLayout.prototype.setupTabItem = function () {
9317 * this.tabItem.setLabel( 'Card Two' );
9318 * };
9319 *
9320 * var card1 = new CardOneLayout( 'one' ),
9321 * card2 = new CardTwoLayout( 'two' );
9322 *
9323 * var index = new OO.ui.IndexLayout();
9324 *
9325 * index.addCards ( [ card1, card2 ] );
9326 * $( 'body' ).append( index.$element );
9327 *
9328 * @class
9329 * @extends OO.ui.MenuLayout
9330 *
9331 * @constructor
9332 * @param {Object} [config] Configuration options
9333 * @cfg {boolean} [continuous=false] Show all cards, one after another
9334 * @cfg {boolean} [autoFocus=true] Focus on the first focusable element when a new card is displayed.
9335 */
9336 OO.ui.IndexLayout = function OoUiIndexLayout( config ) {
9337 // Configuration initialization
9338 config = $.extend( {}, config, { menuPosition: 'top' } );
9339
9340 // Parent constructor
9341 OO.ui.IndexLayout.super.call( this, config );
9342
9343 // Properties
9344 this.currentCardName = null;
9345 this.cards = {};
9346 this.ignoreFocus = false;
9347 this.stackLayout = new OO.ui.StackLayout( { continuous: !!config.continuous } );
9348 this.$content.append( this.stackLayout.$element );
9349 this.autoFocus = config.autoFocus === undefined || !!config.autoFocus;
9350
9351 this.tabSelectWidget = new OO.ui.TabSelectWidget();
9352 this.tabPanel = new OO.ui.PanelLayout();
9353 this.$menu.append( this.tabPanel.$element );
9354
9355 this.toggleMenu( true );
9356
9357 // Events
9358 this.stackLayout.connect( this, { set: 'onStackLayoutSet' } );
9359 this.tabSelectWidget.connect( this, { select: 'onTabSelectWidgetSelect' } );
9360 if ( this.autoFocus ) {
9361 // Event 'focus' does not bubble, but 'focusin' does
9362 this.stackLayout.$element.on( 'focusin', this.onStackLayoutFocus.bind( this ) );
9363 }
9364
9365 // Initialization
9366 this.$element.addClass( 'oo-ui-indexLayout' );
9367 this.stackLayout.$element.addClass( 'oo-ui-indexLayout-stackLayout' );
9368 this.tabPanel.$element
9369 .addClass( 'oo-ui-indexLayout-tabPanel' )
9370 .append( this.tabSelectWidget.$element );
9371 };
9372
9373 /* Setup */
9374
9375 OO.inheritClass( OO.ui.IndexLayout, OO.ui.MenuLayout );
9376
9377 /* Events */
9378
9379 /**
9380 * A 'set' event is emitted when a card is {@link #setCard set} to be displayed by the index layout.
9381 * @event set
9382 * @param {OO.ui.CardLayout} card Current card
9383 */
9384
9385 /**
9386 * An 'add' event is emitted when cards are {@link #addCards added} to the index layout.
9387 *
9388 * @event add
9389 * @param {OO.ui.CardLayout[]} card Added cards
9390 * @param {number} index Index cards were added at
9391 */
9392
9393 /**
9394 * A 'remove' event is emitted when cards are {@link #clearCards cleared} or
9395 * {@link #removeCards removed} from the index.
9396 *
9397 * @event remove
9398 * @param {OO.ui.CardLayout[]} cards Removed cards
9399 */
9400
9401 /* Methods */
9402
9403 /**
9404 * Handle stack layout focus.
9405 *
9406 * @private
9407 * @param {jQuery.Event} e Focusin event
9408 */
9409 OO.ui.IndexLayout.prototype.onStackLayoutFocus = function ( e ) {
9410 var name, $target;
9411
9412 // Find the card that an element was focused within
9413 $target = $( e.target ).closest( '.oo-ui-cardLayout' );
9414 for ( name in this.cards ) {
9415 // Check for card match, exclude current card to find only card changes
9416 if ( this.cards[ name ].$element[ 0 ] === $target[ 0 ] && name !== this.currentCardName ) {
9417 this.setCard( name );
9418 break;
9419 }
9420 }
9421 };
9422
9423 /**
9424 * Handle stack layout set events.
9425 *
9426 * @private
9427 * @param {OO.ui.PanelLayout|null} card The card panel that is now the current panel
9428 */
9429 OO.ui.IndexLayout.prototype.onStackLayoutSet = function ( card ) {
9430 var layout = this;
9431 if ( card ) {
9432 card.scrollElementIntoView( { complete: function () {
9433 if ( layout.autoFocus ) {
9434 layout.focus();
9435 }
9436 } } );
9437 }
9438 };
9439
9440 /**
9441 * Focus the first input in the current card.
9442 *
9443 * If no card is selected, the first selectable card will be selected.
9444 * If the focus is already in an element on the current card, nothing will happen.
9445 * @param {number} [itemIndex] A specific item to focus on
9446 */
9447 OO.ui.IndexLayout.prototype.focus = function ( itemIndex ) {
9448 var $input, card,
9449 items = this.stackLayout.getItems();
9450
9451 if ( itemIndex !== undefined && items[ itemIndex ] ) {
9452 card = items[ itemIndex ];
9453 } else {
9454 card = this.stackLayout.getCurrentItem();
9455 }
9456
9457 if ( !card ) {
9458 this.selectFirstSelectableCard();
9459 card = this.stackLayout.getCurrentItem();
9460 }
9461 if ( !card ) {
9462 return;
9463 }
9464 // Only change the focus if is not already in the current card
9465 if ( !card.$element.find( ':focus' ).length ) {
9466 $input = card.$element.find( ':input:first' );
9467 if ( $input.length ) {
9468 $input[ 0 ].focus();
9469 }
9470 }
9471 };
9472
9473 /**
9474 * Find the first focusable input in the index layout and focus
9475 * on it.
9476 */
9477 OO.ui.IndexLayout.prototype.focusFirstFocusable = function () {
9478 var i, len,
9479 found = false,
9480 items = this.stackLayout.getItems(),
9481 checkAndFocus = function () {
9482 if ( OO.ui.isFocusableElement( $( this ) ) ) {
9483 $( this ).focus();
9484 found = true;
9485 return false;
9486 }
9487 };
9488
9489 for ( i = 0, len = items.length; i < len; i++ ) {
9490 if ( found ) {
9491 break;
9492 }
9493 // Find all potentially focusable elements in the item
9494 // and check if they are focusable
9495 items[i].$element
9496 .find( 'input, select, textarea, button, object' )
9497 .each( checkAndFocus );
9498 }
9499 };
9500
9501 /**
9502 * Handle tab widget select events.
9503 *
9504 * @private
9505 * @param {OO.ui.OptionWidget|null} item Selected item
9506 */
9507 OO.ui.IndexLayout.prototype.onTabSelectWidgetSelect = function ( item ) {
9508 if ( item ) {
9509 this.setCard( item.getData() );
9510 }
9511 };
9512
9513 /**
9514 * Get the card closest to the specified card.
9515 *
9516 * @param {OO.ui.CardLayout} card Card to use as a reference point
9517 * @return {OO.ui.CardLayout|null} Card closest to the specified card
9518 */
9519 OO.ui.IndexLayout.prototype.getClosestCard = function ( card ) {
9520 var next, prev, level,
9521 cards = this.stackLayout.getItems(),
9522 index = $.inArray( card, cards );
9523
9524 if ( index !== -1 ) {
9525 next = cards[ index + 1 ];
9526 prev = cards[ index - 1 ];
9527 // Prefer adjacent cards at the same level
9528 level = this.tabSelectWidget.getItemFromData( card.getName() ).getLevel();
9529 if (
9530 prev &&
9531 level === this.tabSelectWidget.getItemFromData( prev.getName() ).getLevel()
9532 ) {
9533 return prev;
9534 }
9535 if (
9536 next &&
9537 level === this.tabSelectWidget.getItemFromData( next.getName() ).getLevel()
9538 ) {
9539 return next;
9540 }
9541 }
9542 return prev || next || null;
9543 };
9544
9545 /**
9546 * Get the tabs widget.
9547 *
9548 * @return {OO.ui.TabSelectWidget} Tabs widget
9549 */
9550 OO.ui.IndexLayout.prototype.getTabs = function () {
9551 return this.tabSelectWidget;
9552 };
9553
9554 /**
9555 * Get a card by its symbolic name.
9556 *
9557 * @param {string} name Symbolic name of card
9558 * @return {OO.ui.CardLayout|undefined} Card, if found
9559 */
9560 OO.ui.IndexLayout.prototype.getCard = function ( name ) {
9561 return this.cards[ name ];
9562 };
9563
9564 /**
9565 * Get the current card.
9566 *
9567 * @return {OO.ui.CardLayout|undefined} Current card, if found
9568 */
9569 OO.ui.IndexLayout.prototype.getCurrentCard = function () {
9570 var name = this.getCurrentCardName();
9571 return name ? this.getCard( name ) : undefined;
9572 };
9573
9574 /**
9575 * Get the symbolic name of the current card.
9576 *
9577 * @return {string|null} Symbolic name of the current card
9578 */
9579 OO.ui.IndexLayout.prototype.getCurrentCardName = function () {
9580 return this.currentCardName;
9581 };
9582
9583 /**
9584 * Add cards to the index layout
9585 *
9586 * When cards are added with the same names as existing cards, the existing cards will be
9587 * automatically removed before the new cards are added.
9588 *
9589 * @param {OO.ui.CardLayout[]} cards Cards to add
9590 * @param {number} index Index of the insertion point
9591 * @fires add
9592 * @chainable
9593 */
9594 OO.ui.IndexLayout.prototype.addCards = function ( cards, index ) {
9595 var i, len, name, card, item, currentIndex,
9596 stackLayoutCards = this.stackLayout.getItems(),
9597 remove = [],
9598 items = [];
9599
9600 // Remove cards with same names
9601 for ( i = 0, len = cards.length; i < len; i++ ) {
9602 card = cards[ i ];
9603 name = card.getName();
9604
9605 if ( Object.prototype.hasOwnProperty.call( this.cards, name ) ) {
9606 // Correct the insertion index
9607 currentIndex = $.inArray( this.cards[ name ], stackLayoutCards );
9608 if ( currentIndex !== -1 && currentIndex + 1 < index ) {
9609 index--;
9610 }
9611 remove.push( this.cards[ name ] );
9612 }
9613 }
9614 if ( remove.length ) {
9615 this.removeCards( remove );
9616 }
9617
9618 // Add new cards
9619 for ( i = 0, len = cards.length; i < len; i++ ) {
9620 card = cards[ i ];
9621 name = card.getName();
9622 this.cards[ card.getName() ] = card;
9623 item = new OO.ui.TabOptionWidget( { data: name } );
9624 card.setTabItem( item );
9625 items.push( item );
9626 }
9627
9628 if ( items.length ) {
9629 this.tabSelectWidget.addItems( items, index );
9630 this.selectFirstSelectableCard();
9631 }
9632 this.stackLayout.addItems( cards, index );
9633 this.emit( 'add', cards, index );
9634
9635 return this;
9636 };
9637
9638 /**
9639 * Remove the specified cards from the index layout.
9640 *
9641 * To remove all cards from the index, you may wish to use the #clearCards method instead.
9642 *
9643 * @param {OO.ui.CardLayout[]} cards An array of cards to remove
9644 * @fires remove
9645 * @chainable
9646 */
9647 OO.ui.IndexLayout.prototype.removeCards = function ( cards ) {
9648 var i, len, name, card,
9649 items = [];
9650
9651 for ( i = 0, len = cards.length; i < len; i++ ) {
9652 card = cards[ i ];
9653 name = card.getName();
9654 delete this.cards[ name ];
9655 items.push( this.tabSelectWidget.getItemFromData( name ) );
9656 card.setTabItem( null );
9657 }
9658 if ( items.length ) {
9659 this.tabSelectWidget.removeItems( items );
9660 this.selectFirstSelectableCard();
9661 }
9662 this.stackLayout.removeItems( cards );
9663 this.emit( 'remove', cards );
9664
9665 return this;
9666 };
9667
9668 /**
9669 * Clear all cards from the index layout.
9670 *
9671 * To remove only a subset of cards from the index, use the #removeCards method.
9672 *
9673 * @fires remove
9674 * @chainable
9675 */
9676 OO.ui.IndexLayout.prototype.clearCards = function () {
9677 var i, len,
9678 cards = this.stackLayout.getItems();
9679
9680 this.cards = {};
9681 this.currentCardName = null;
9682 this.tabSelectWidget.clearItems();
9683 for ( i = 0, len = cards.length; i < len; i++ ) {
9684 cards[ i ].setTabItem( null );
9685 }
9686 this.stackLayout.clearItems();
9687
9688 this.emit( 'remove', cards );
9689
9690 return this;
9691 };
9692
9693 /**
9694 * Set the current card by symbolic name.
9695 *
9696 * @fires set
9697 * @param {string} name Symbolic name of card
9698 */
9699 OO.ui.IndexLayout.prototype.setCard = function ( name ) {
9700 var selectedItem,
9701 $focused,
9702 card = this.cards[ name ];
9703
9704 if ( name !== this.currentCardName ) {
9705 selectedItem = this.tabSelectWidget.getSelectedItem();
9706 if ( selectedItem && selectedItem.getData() !== name ) {
9707 this.tabSelectWidget.selectItemByData( name );
9708 }
9709 if ( card ) {
9710 if ( this.currentCardName && this.cards[ this.currentCardName ] ) {
9711 this.cards[ this.currentCardName ].setActive( false );
9712 // Blur anything focused if the next card doesn't have anything focusable - this
9713 // is not needed if the next card has something focusable because once it is focused
9714 // this blur happens automatically
9715 if ( this.autoFocus && !card.$element.find( ':input' ).length ) {
9716 $focused = this.cards[ this.currentCardName ].$element.find( ':focus' );
9717 if ( $focused.length ) {
9718 $focused[ 0 ].blur();
9719 }
9720 }
9721 }
9722 this.currentCardName = name;
9723 this.stackLayout.setItem( card );
9724 card.setActive( true );
9725 this.emit( 'set', card );
9726 }
9727 }
9728 };
9729
9730 /**
9731 * Select the first selectable card.
9732 *
9733 * @chainable
9734 */
9735 OO.ui.IndexLayout.prototype.selectFirstSelectableCard = function () {
9736 if ( !this.tabSelectWidget.getSelectedItem() ) {
9737 this.tabSelectWidget.selectItem( this.tabSelectWidget.getFirstSelectableItem() );
9738 }
9739
9740 return this;
9741 };
9742
9743 /**
9744 * PanelLayouts expand to cover the entire area of their parent. They can be configured with scrolling, padding,
9745 * and a frame, and are often used together with {@link OO.ui.StackLayout StackLayouts}.
9746 *
9747 * @example
9748 * // Example of a panel layout
9749 * var panel = new OO.ui.PanelLayout( {
9750 * expanded: false,
9751 * framed: true,
9752 * padded: true,
9753 * $content: $( '<p>A panel layout with padding and a frame.</p>' )
9754 * } );
9755 * $( 'body' ).append( panel.$element );
9756 *
9757 * @class
9758 * @extends OO.ui.Layout
9759 *
9760 * @constructor
9761 * @param {Object} [config] Configuration options
9762 * @cfg {boolean} [scrollable=false] Allow vertical scrolling
9763 * @cfg {boolean} [padded=false] Add padding between the content and the edges of the panel.
9764 * @cfg {boolean} [expanded=true] Expand the panel to fill the entire parent element.
9765 * @cfg {boolean} [framed=false] Render the panel with a frame to visually separate it from outside content.
9766 */
9767 OO.ui.PanelLayout = function OoUiPanelLayout( config ) {
9768 // Configuration initialization
9769 config = $.extend( {
9770 scrollable: false,
9771 padded: false,
9772 expanded: true,
9773 framed: false
9774 }, config );
9775
9776 // Parent constructor
9777 OO.ui.PanelLayout.super.call( this, config );
9778
9779 // Initialization
9780 this.$element.addClass( 'oo-ui-panelLayout' );
9781 if ( config.scrollable ) {
9782 this.$element.addClass( 'oo-ui-panelLayout-scrollable' );
9783 }
9784 if ( config.padded ) {
9785 this.$element.addClass( 'oo-ui-panelLayout-padded' );
9786 }
9787 if ( config.expanded ) {
9788 this.$element.addClass( 'oo-ui-panelLayout-expanded' );
9789 }
9790 if ( config.framed ) {
9791 this.$element.addClass( 'oo-ui-panelLayout-framed' );
9792 }
9793 };
9794
9795 /* Setup */
9796
9797 OO.inheritClass( OO.ui.PanelLayout, OO.ui.Layout );
9798
9799 /**
9800 * CardLayouts are used within {@link OO.ui.IndexLayout index layouts} to create cards that users can select and display
9801 * from the index's optional {@link OO.ui.TabSelectWidget tab} navigation. Cards are usually not instantiated directly,
9802 * rather extended to include the required content and functionality.
9803 *
9804 * Each card must have a unique symbolic name, which is passed to the constructor. In addition, the card's tab
9805 * item is customized (with a label) using the #setupTabItem method. See
9806 * {@link OO.ui.IndexLayout IndexLayout} for an example.
9807 *
9808 * @class
9809 * @extends OO.ui.PanelLayout
9810 *
9811 * @constructor
9812 * @param {string} name Unique symbolic name of card
9813 * @param {Object} [config] Configuration options
9814 */
9815 OO.ui.CardLayout = function OoUiCardLayout( name, config ) {
9816 // Allow passing positional parameters inside the config object
9817 if ( OO.isPlainObject( name ) && config === undefined ) {
9818 config = name;
9819 name = config.name;
9820 }
9821
9822 // Configuration initialization
9823 config = $.extend( { scrollable: true }, config );
9824
9825 // Parent constructor
9826 OO.ui.CardLayout.super.call( this, config );
9827
9828 // Properties
9829 this.name = name;
9830 this.tabItem = null;
9831 this.active = false;
9832
9833 // Initialization
9834 this.$element.addClass( 'oo-ui-cardLayout' );
9835 };
9836
9837 /* Setup */
9838
9839 OO.inheritClass( OO.ui.CardLayout, OO.ui.PanelLayout );
9840
9841 /* Events */
9842
9843 /**
9844 * An 'active' event is emitted when the card becomes active. Cards become active when they are
9845 * shown in a index layout that is configured to display only one card at a time.
9846 *
9847 * @event active
9848 * @param {boolean} active Card is active
9849 */
9850
9851 /* Methods */
9852
9853 /**
9854 * Get the symbolic name of the card.
9855 *
9856 * @return {string} Symbolic name of card
9857 */
9858 OO.ui.CardLayout.prototype.getName = function () {
9859 return this.name;
9860 };
9861
9862 /**
9863 * Check if card is active.
9864 *
9865 * Cards become active when they are shown in a {@link OO.ui.IndexLayout index layout} that is configured to display
9866 * only one card at a time. Additional CSS is applied to the card's tab item to reflect the active state.
9867 *
9868 * @return {boolean} Card is active
9869 */
9870 OO.ui.CardLayout.prototype.isActive = function () {
9871 return this.active;
9872 };
9873
9874 /**
9875 * Get tab item.
9876 *
9877 * The tab item allows users to access the card from the index's tab
9878 * navigation. The tab item itself can be customized (with a label, level, etc.) using the #setupTabItem method.
9879 *
9880 * @return {OO.ui.TabOptionWidget|null} Tab option widget
9881 */
9882 OO.ui.CardLayout.prototype.getTabItem = function () {
9883 return this.tabItem;
9884 };
9885
9886 /**
9887 * Set or unset the tab item.
9888 *
9889 * Specify a {@link OO.ui.TabOptionWidget tab option} to set it,
9890 * or `null` to clear the tab item. To customize the tab item itself (e.g., to set a label or tab
9891 * level), use #setupTabItem instead of this method.
9892 *
9893 * @param {OO.ui.TabOptionWidget|null} tabItem Tab option widget, null to clear
9894 * @chainable
9895 */
9896 OO.ui.CardLayout.prototype.setTabItem = function ( tabItem ) {
9897 this.tabItem = tabItem || null;
9898 if ( tabItem ) {
9899 this.setupTabItem();
9900 }
9901 return this;
9902 };
9903
9904 /**
9905 * Set up the tab item.
9906 *
9907 * Use this method to customize the tab item (e.g., to add a label or tab level). To set or unset
9908 * the tab item itself (with a {@link OO.ui.TabOptionWidget tab option} or `null`), use
9909 * the #setTabItem method instead.
9910 *
9911 * @param {OO.ui.TabOptionWidget} tabItem Tab option widget to set up
9912 * @chainable
9913 */
9914 OO.ui.CardLayout.prototype.setupTabItem = function () {
9915 return this;
9916 };
9917
9918 /**
9919 * Set the card to its 'active' state.
9920 *
9921 * Cards become active when they are shown in a index layout that is configured to display only one card at a time. Additional
9922 * CSS is applied to the tab item to reflect the card's active state. Outside of the index
9923 * context, setting the active state on a card does nothing.
9924 *
9925 * @param {boolean} value Card is active
9926 * @fires active
9927 */
9928 OO.ui.CardLayout.prototype.setActive = function ( active ) {
9929 active = !!active;
9930
9931 if ( active !== this.active ) {
9932 this.active = active;
9933 this.$element.toggleClass( 'oo-ui-cardLayout-active', this.active );
9934 this.emit( 'active', this.active );
9935 }
9936 };
9937
9938 /**
9939 * PageLayouts are used within {@link OO.ui.BookletLayout booklet layouts} to create pages that users can select and display
9940 * from the booklet's optional {@link OO.ui.OutlineSelectWidget outline} navigation. Pages are usually not instantiated directly,
9941 * rather extended to include the required content and functionality.
9942 *
9943 * Each page must have a unique symbolic name, which is passed to the constructor. In addition, the page's outline
9944 * item is customized (with a label, outline level, etc.) using the #setupOutlineItem method. See
9945 * {@link OO.ui.BookletLayout BookletLayout} for an example.
9946 *
9947 * @class
9948 * @extends OO.ui.PanelLayout
9949 *
9950 * @constructor
9951 * @param {string} name Unique symbolic name of page
9952 * @param {Object} [config] Configuration options
9953 */
9954 OO.ui.PageLayout = function OoUiPageLayout( name, config ) {
9955 // Allow passing positional parameters inside the config object
9956 if ( OO.isPlainObject( name ) && config === undefined ) {
9957 config = name;
9958 name = config.name;
9959 }
9960
9961 // Configuration initialization
9962 config = $.extend( { scrollable: true }, config );
9963
9964 // Parent constructor
9965 OO.ui.PageLayout.super.call( this, config );
9966
9967 // Properties
9968 this.name = name;
9969 this.outlineItem = null;
9970 this.active = false;
9971
9972 // Initialization
9973 this.$element.addClass( 'oo-ui-pageLayout' );
9974 };
9975
9976 /* Setup */
9977
9978 OO.inheritClass( OO.ui.PageLayout, OO.ui.PanelLayout );
9979
9980 /* Events */
9981
9982 /**
9983 * An 'active' event is emitted when the page becomes active. Pages become active when they are
9984 * shown in a booklet layout that is configured to display only one page at a time.
9985 *
9986 * @event active
9987 * @param {boolean} active Page is active
9988 */
9989
9990 /* Methods */
9991
9992 /**
9993 * Get the symbolic name of the page.
9994 *
9995 * @return {string} Symbolic name of page
9996 */
9997 OO.ui.PageLayout.prototype.getName = function () {
9998 return this.name;
9999 };
10000
10001 /**
10002 * Check if page is active.
10003 *
10004 * Pages become active when they are shown in a {@link OO.ui.BookletLayout booklet layout} that is configured to display
10005 * only one page at a time. Additional CSS is applied to the page's outline item to reflect the active state.
10006 *
10007 * @return {boolean} Page is active
10008 */
10009 OO.ui.PageLayout.prototype.isActive = function () {
10010 return this.active;
10011 };
10012
10013 /**
10014 * Get outline item.
10015 *
10016 * The outline item allows users to access the page from the booklet's outline
10017 * navigation. The outline item itself can be customized (with a label, level, etc.) using the #setupOutlineItem method.
10018 *
10019 * @return {OO.ui.OutlineOptionWidget|null} Outline option widget
10020 */
10021 OO.ui.PageLayout.prototype.getOutlineItem = function () {
10022 return this.outlineItem;
10023 };
10024
10025 /**
10026 * Set or unset the outline item.
10027 *
10028 * Specify an {@link OO.ui.OutlineOptionWidget outline option} to set it,
10029 * or `null` to clear the outline item. To customize the outline item itself (e.g., to set a label or outline
10030 * level), use #setupOutlineItem instead of this method.
10031 *
10032 * @param {OO.ui.OutlineOptionWidget|null} outlineItem Outline option widget, null to clear
10033 * @chainable
10034 */
10035 OO.ui.PageLayout.prototype.setOutlineItem = function ( outlineItem ) {
10036 this.outlineItem = outlineItem || null;
10037 if ( outlineItem ) {
10038 this.setupOutlineItem();
10039 }
10040 return this;
10041 };
10042
10043 /**
10044 * Set up the outline item.
10045 *
10046 * Use this method to customize the outline item (e.g., to add a label or outline level). To set or unset
10047 * the outline item itself (with an {@link OO.ui.OutlineOptionWidget outline option} or `null`), use
10048 * the #setOutlineItem method instead.
10049 *
10050 * @param {OO.ui.OutlineOptionWidget} outlineItem Outline option widget to set up
10051 * @chainable
10052 */
10053 OO.ui.PageLayout.prototype.setupOutlineItem = function () {
10054 return this;
10055 };
10056
10057 /**
10058 * Set the page to its 'active' state.
10059 *
10060 * Pages become active when they are shown in a booklet layout that is configured to display only one page at a time. Additional
10061 * CSS is applied to the outline item to reflect the page's active state. Outside of the booklet
10062 * context, setting the active state on a page does nothing.
10063 *
10064 * @param {boolean} value Page is active
10065 * @fires active
10066 */
10067 OO.ui.PageLayout.prototype.setActive = function ( active ) {
10068 active = !!active;
10069
10070 if ( active !== this.active ) {
10071 this.active = active;
10072 this.$element.toggleClass( 'oo-ui-pageLayout-active', active );
10073 this.emit( 'active', this.active );
10074 }
10075 };
10076
10077 /**
10078 * StackLayouts contain a series of {@link OO.ui.PanelLayout panel layouts}. By default, only one panel is displayed
10079 * at a time, though the stack layout can also be configured to show all contained panels, one after another,
10080 * by setting the #continuous option to 'true'.
10081 *
10082 * @example
10083 * // A stack layout with two panels, configured to be displayed continously
10084 * var myStack = new OO.ui.StackLayout( {
10085 * items: [
10086 * new OO.ui.PanelLayout( {
10087 * $content: $( '<p>Panel One</p>' ),
10088 * padded: true,
10089 * framed: true
10090 * } ),
10091 * new OO.ui.PanelLayout( {
10092 * $content: $( '<p>Panel Two</p>' ),
10093 * padded: true,
10094 * framed: true
10095 * } )
10096 * ],
10097 * continuous: true
10098 * } );
10099 * $( 'body' ).append( myStack.$element );
10100 *
10101 * @class
10102 * @extends OO.ui.PanelLayout
10103 * @mixins OO.ui.GroupElement
10104 *
10105 * @constructor
10106 * @param {Object} [config] Configuration options
10107 * @cfg {boolean} [continuous=false] Show all panels, one after another. By default, only one panel is displayed at a time.
10108 * @cfg {OO.ui.Layout[]} [items] Panel layouts to add to the stack layout.
10109 */
10110 OO.ui.StackLayout = function OoUiStackLayout( config ) {
10111 // Configuration initialization
10112 config = $.extend( { scrollable: true }, config );
10113
10114 // Parent constructor
10115 OO.ui.StackLayout.super.call( this, config );
10116
10117 // Mixin constructors
10118 OO.ui.GroupElement.call( this, $.extend( {}, config, { $group: this.$element } ) );
10119
10120 // Properties
10121 this.currentItem = null;
10122 this.continuous = !!config.continuous;
10123
10124 // Initialization
10125 this.$element.addClass( 'oo-ui-stackLayout' );
10126 if ( this.continuous ) {
10127 this.$element.addClass( 'oo-ui-stackLayout-continuous' );
10128 }
10129 if ( Array.isArray( config.items ) ) {
10130 this.addItems( config.items );
10131 }
10132 };
10133
10134 /* Setup */
10135
10136 OO.inheritClass( OO.ui.StackLayout, OO.ui.PanelLayout );
10137 OO.mixinClass( OO.ui.StackLayout, OO.ui.GroupElement );
10138
10139 /* Events */
10140
10141 /**
10142 * A 'set' event is emitted when panels are {@link #addItems added}, {@link #removeItems removed},
10143 * {@link #clearItems cleared} or {@link #setItem displayed}.
10144 *
10145 * @event set
10146 * @param {OO.ui.Layout|null} item Current panel or `null` if no panel is shown
10147 */
10148
10149 /* Methods */
10150
10151 /**
10152 * Get the current panel.
10153 *
10154 * @return {OO.ui.Layout|null}
10155 */
10156 OO.ui.StackLayout.prototype.getCurrentItem = function () {
10157 return this.currentItem;
10158 };
10159
10160 /**
10161 * Unset the current item.
10162 *
10163 * @private
10164 * @param {OO.ui.StackLayout} layout
10165 * @fires set
10166 */
10167 OO.ui.StackLayout.prototype.unsetCurrentItem = function () {
10168 var prevItem = this.currentItem;
10169 if ( prevItem === null ) {
10170 return;
10171 }
10172
10173 this.currentItem = null;
10174 this.emit( 'set', null );
10175 };
10176
10177 /**
10178 * Add panel layouts to the stack layout.
10179 *
10180 * Panels will be added to the end of the stack layout array unless the optional index parameter specifies a different
10181 * insertion point. Adding a panel that is already in the stack will move it to the end of the array or the point specified
10182 * by the index.
10183 *
10184 * @param {OO.ui.Layout[]} items Panels to add
10185 * @param {number} [index] Index of the insertion point
10186 * @chainable
10187 */
10188 OO.ui.StackLayout.prototype.addItems = function ( items, index ) {
10189 // Update the visibility
10190 this.updateHiddenState( items, this.currentItem );
10191
10192 // Mixin method
10193 OO.ui.GroupElement.prototype.addItems.call( this, items, index );
10194
10195 if ( !this.currentItem && items.length ) {
10196 this.setItem( items[ 0 ] );
10197 }
10198
10199 return this;
10200 };
10201
10202 /**
10203 * Remove the specified panels from the stack layout.
10204 *
10205 * Removed panels are detached from the DOM, not removed, so that they may be reused. To remove all panels,
10206 * you may wish to use the #clearItems method instead.
10207 *
10208 * @param {OO.ui.Layout[]} items Panels to remove
10209 * @chainable
10210 * @fires set
10211 */
10212 OO.ui.StackLayout.prototype.removeItems = function ( items ) {
10213 // Mixin method
10214 OO.ui.GroupElement.prototype.removeItems.call( this, items );
10215
10216 if ( $.inArray( this.currentItem, items ) !== -1 ) {
10217 if ( this.items.length ) {
10218 this.setItem( this.items[ 0 ] );
10219 } else {
10220 this.unsetCurrentItem();
10221 }
10222 }
10223
10224 return this;
10225 };
10226
10227 /**
10228 * Clear all panels from the stack layout.
10229 *
10230 * Cleared panels are detached from the DOM, not removed, so that they may be reused. To remove only
10231 * a subset of panels, use the #removeItems method.
10232 *
10233 * @chainable
10234 * @fires set
10235 */
10236 OO.ui.StackLayout.prototype.clearItems = function () {
10237 this.unsetCurrentItem();
10238 OO.ui.GroupElement.prototype.clearItems.call( this );
10239
10240 return this;
10241 };
10242
10243 /**
10244 * Show the specified panel.
10245 *
10246 * If another panel is currently displayed, it will be hidden.
10247 *
10248 * @param {OO.ui.Layout} item Panel to show
10249 * @chainable
10250 * @fires set
10251 */
10252 OO.ui.StackLayout.prototype.setItem = function ( item ) {
10253 if ( item !== this.currentItem ) {
10254 this.updateHiddenState( this.items, item );
10255
10256 if ( $.inArray( item, this.items ) !== -1 ) {
10257 this.currentItem = item;
10258 this.emit( 'set', item );
10259 } else {
10260 this.unsetCurrentItem();
10261 }
10262 }
10263
10264 return this;
10265 };
10266
10267 /**
10268 * Update the visibility of all items in case of non-continuous view.
10269 *
10270 * Ensure all items are hidden except for the selected one.
10271 * This method does nothing when the stack is continuous.
10272 *
10273 * @private
10274 * @param {OO.ui.Layout[]} items Item list iterate over
10275 * @param {OO.ui.Layout} [selectedItem] Selected item to show
10276 */
10277 OO.ui.StackLayout.prototype.updateHiddenState = function ( items, selectedItem ) {
10278 var i, len;
10279
10280 if ( !this.continuous ) {
10281 for ( i = 0, len = items.length; i < len; i++ ) {
10282 if ( !selectedItem || selectedItem !== items[ i ] ) {
10283 items[ i ].$element.addClass( 'oo-ui-element-hidden' );
10284 }
10285 }
10286 if ( selectedItem ) {
10287 selectedItem.$element.removeClass( 'oo-ui-element-hidden' );
10288 }
10289 }
10290 };
10291
10292 /**
10293 * Horizontal bar layout of tools as icon buttons.
10294 *
10295 * @class
10296 * @extends OO.ui.ToolGroup
10297 *
10298 * @constructor
10299 * @param {OO.ui.Toolbar} toolbar
10300 * @param {Object} [config] Configuration options
10301 */
10302 OO.ui.BarToolGroup = function OoUiBarToolGroup( toolbar, config ) {
10303 // Allow passing positional parameters inside the config object
10304 if ( OO.isPlainObject( toolbar ) && config === undefined ) {
10305 config = toolbar;
10306 toolbar = config.toolbar;
10307 }
10308
10309 // Parent constructor
10310 OO.ui.BarToolGroup.super.call( this, toolbar, config );
10311
10312 // Initialization
10313 this.$element.addClass( 'oo-ui-barToolGroup' );
10314 };
10315
10316 /* Setup */
10317
10318 OO.inheritClass( OO.ui.BarToolGroup, OO.ui.ToolGroup );
10319
10320 /* Static Properties */
10321
10322 OO.ui.BarToolGroup.static.titleTooltips = true;
10323
10324 OO.ui.BarToolGroup.static.accelTooltips = true;
10325
10326 OO.ui.BarToolGroup.static.name = 'bar';
10327
10328 /**
10329 * Popup list of tools with an icon and optional label.
10330 *
10331 * @abstract
10332 * @class
10333 * @extends OO.ui.ToolGroup
10334 * @mixins OO.ui.IconElement
10335 * @mixins OO.ui.IndicatorElement
10336 * @mixins OO.ui.LabelElement
10337 * @mixins OO.ui.TitledElement
10338 * @mixins OO.ui.ClippableElement
10339 * @mixins OO.ui.TabIndexedElement
10340 *
10341 * @constructor
10342 * @param {OO.ui.Toolbar} toolbar
10343 * @param {Object} [config] Configuration options
10344 * @cfg {string} [header] Text to display at the top of the pop-up
10345 */
10346 OO.ui.PopupToolGroup = function OoUiPopupToolGroup( toolbar, config ) {
10347 // Allow passing positional parameters inside the config object
10348 if ( OO.isPlainObject( toolbar ) && config === undefined ) {
10349 config = toolbar;
10350 toolbar = config.toolbar;
10351 }
10352
10353 // Configuration initialization
10354 config = config || {};
10355
10356 // Parent constructor
10357 OO.ui.PopupToolGroup.super.call( this, toolbar, config );
10358
10359 // Properties
10360 this.active = false;
10361 this.dragging = false;
10362 this.onBlurHandler = this.onBlur.bind( this );
10363 this.$handle = $( '<span>' );
10364
10365 // Mixin constructors
10366 OO.ui.IconElement.call( this, config );
10367 OO.ui.IndicatorElement.call( this, config );
10368 OO.ui.LabelElement.call( this, config );
10369 OO.ui.TitledElement.call( this, config );
10370 OO.ui.ClippableElement.call( this, $.extend( {}, config, { $clippable: this.$group } ) );
10371 OO.ui.TabIndexedElement.call( this, $.extend( {}, config, { $tabIndexed: this.$handle } ) );
10372
10373 // Events
10374 this.$handle.on( {
10375 keydown: this.onHandleMouseKeyDown.bind( this ),
10376 keyup: this.onHandleMouseKeyUp.bind( this ),
10377 mousedown: this.onHandleMouseKeyDown.bind( this ),
10378 mouseup: this.onHandleMouseKeyUp.bind( this )
10379 } );
10380
10381 // Initialization
10382 this.$handle
10383 .addClass( 'oo-ui-popupToolGroup-handle' )
10384 .append( this.$icon, this.$label, this.$indicator );
10385 // If the pop-up should have a header, add it to the top of the toolGroup.
10386 // Note: If this feature is useful for other widgets, we could abstract it into an
10387 // OO.ui.HeaderedElement mixin constructor.
10388 if ( config.header !== undefined ) {
10389 this.$group
10390 .prepend( $( '<span>' )
10391 .addClass( 'oo-ui-popupToolGroup-header' )
10392 .text( config.header )
10393 );
10394 }
10395 this.$element
10396 .addClass( 'oo-ui-popupToolGroup' )
10397 .prepend( this.$handle );
10398 };
10399
10400 /* Setup */
10401
10402 OO.inheritClass( OO.ui.PopupToolGroup, OO.ui.ToolGroup );
10403 OO.mixinClass( OO.ui.PopupToolGroup, OO.ui.IconElement );
10404 OO.mixinClass( OO.ui.PopupToolGroup, OO.ui.IndicatorElement );
10405 OO.mixinClass( OO.ui.PopupToolGroup, OO.ui.LabelElement );
10406 OO.mixinClass( OO.ui.PopupToolGroup, OO.ui.TitledElement );
10407 OO.mixinClass( OO.ui.PopupToolGroup, OO.ui.ClippableElement );
10408 OO.mixinClass( OO.ui.PopupToolGroup, OO.ui.TabIndexedElement );
10409
10410 /* Methods */
10411
10412 /**
10413 * @inheritdoc
10414 */
10415 OO.ui.PopupToolGroup.prototype.setDisabled = function () {
10416 // Parent method
10417 OO.ui.PopupToolGroup.super.prototype.setDisabled.apply( this, arguments );
10418
10419 if ( this.isDisabled() && this.isElementAttached() ) {
10420 this.setActive( false );
10421 }
10422 };
10423
10424 /**
10425 * Handle focus being lost.
10426 *
10427 * The event is actually generated from a mouseup/keyup, so it is not a normal blur event object.
10428 *
10429 * @param {jQuery.Event} e Mouse up or key up event
10430 */
10431 OO.ui.PopupToolGroup.prototype.onBlur = function ( e ) {
10432 // Only deactivate when clicking outside the dropdown element
10433 if ( $( e.target ).closest( '.oo-ui-popupToolGroup' )[ 0 ] !== this.$element[ 0 ] ) {
10434 this.setActive( false );
10435 }
10436 };
10437
10438 /**
10439 * @inheritdoc
10440 */
10441 OO.ui.PopupToolGroup.prototype.onMouseKeyUp = function ( e ) {
10442 // Only close toolgroup when a tool was actually selected
10443 if (
10444 !this.isDisabled() && this.pressed && this.pressed === this.getTargetTool( e ) &&
10445 ( e.which === 1 || e.which === OO.ui.Keys.SPACE || e.which === OO.ui.Keys.ENTER )
10446 ) {
10447 this.setActive( false );
10448 }
10449 return OO.ui.PopupToolGroup.super.prototype.onMouseKeyUp.call( this, e );
10450 };
10451
10452 /**
10453 * Handle mouse up and key up events.
10454 *
10455 * @param {jQuery.Event} e Mouse up or key up event
10456 */
10457 OO.ui.PopupToolGroup.prototype.onHandleMouseKeyUp = function ( e ) {
10458 if (
10459 !this.isDisabled() &&
10460 ( e.which === 1 || e.which === OO.ui.Keys.SPACE || e.which === OO.ui.Keys.ENTER )
10461 ) {
10462 return false;
10463 }
10464 };
10465
10466 /**
10467 * Handle mouse down and key down events.
10468 *
10469 * @param {jQuery.Event} e Mouse down or key down event
10470 */
10471 OO.ui.PopupToolGroup.prototype.onHandleMouseKeyDown = function ( e ) {
10472 if (
10473 !this.isDisabled() &&
10474 ( e.which === 1 || e.which === OO.ui.Keys.SPACE || e.which === OO.ui.Keys.ENTER )
10475 ) {
10476 this.setActive( !this.active );
10477 return false;
10478 }
10479 };
10480
10481 /**
10482 * Switch into active mode.
10483 *
10484 * When active, mouseup events anywhere in the document will trigger deactivation.
10485 */
10486 OO.ui.PopupToolGroup.prototype.setActive = function ( value ) {
10487 value = !!value;
10488 if ( this.active !== value ) {
10489 this.active = value;
10490 if ( value ) {
10491 this.getElementDocument().addEventListener( 'mouseup', this.onBlurHandler, true );
10492 this.getElementDocument().addEventListener( 'keyup', this.onBlurHandler, true );
10493
10494 // Try anchoring the popup to the left first
10495 this.$element.addClass( 'oo-ui-popupToolGroup-active oo-ui-popupToolGroup-left' );
10496 this.toggleClipping( true );
10497 if ( this.isClippedHorizontally() ) {
10498 // Anchoring to the left caused the popup to clip, so anchor it to the right instead
10499 this.toggleClipping( false );
10500 this.$element
10501 .removeClass( 'oo-ui-popupToolGroup-left' )
10502 .addClass( 'oo-ui-popupToolGroup-right' );
10503 this.toggleClipping( true );
10504 }
10505 } else {
10506 this.getElementDocument().removeEventListener( 'mouseup', this.onBlurHandler, true );
10507 this.getElementDocument().removeEventListener( 'keyup', this.onBlurHandler, true );
10508 this.$element.removeClass(
10509 'oo-ui-popupToolGroup-active oo-ui-popupToolGroup-left oo-ui-popupToolGroup-right'
10510 );
10511 this.toggleClipping( false );
10512 }
10513 }
10514 };
10515
10516 /**
10517 * Drop down list layout of tools as labeled icon buttons.
10518 *
10519 * This layout allows some tools to be collapsible, controlled by a "More" / "Fewer" option at the
10520 * bottom of the main list. These are not automatically positioned at the bottom of the list; you
10521 * may want to use the 'promote' and 'demote' configuration options to achieve this.
10522 *
10523 * @class
10524 * @extends OO.ui.PopupToolGroup
10525 *
10526 * @constructor
10527 * @param {OO.ui.Toolbar} toolbar
10528 * @param {Object} [config] Configuration options
10529 * @cfg {Array} [allowCollapse] List of tools that can be collapsed. Remaining tools will be always
10530 * shown.
10531 * @cfg {Array} [forceExpand] List of tools that *may not* be collapsed. All remaining tools will be
10532 * allowed to be collapsed.
10533 * @cfg {boolean} [expanded=false] Whether the collapsible tools are expanded by default
10534 */
10535 OO.ui.ListToolGroup = function OoUiListToolGroup( toolbar, config ) {
10536 // Allow passing positional parameters inside the config object
10537 if ( OO.isPlainObject( toolbar ) && config === undefined ) {
10538 config = toolbar;
10539 toolbar = config.toolbar;
10540 }
10541
10542 // Configuration initialization
10543 config = config || {};
10544
10545 // Properties (must be set before parent constructor, which calls #populate)
10546 this.allowCollapse = config.allowCollapse;
10547 this.forceExpand = config.forceExpand;
10548 this.expanded = config.expanded !== undefined ? config.expanded : false;
10549 this.collapsibleTools = [];
10550
10551 // Parent constructor
10552 OO.ui.ListToolGroup.super.call( this, toolbar, config );
10553
10554 // Initialization
10555 this.$element.addClass( 'oo-ui-listToolGroup' );
10556 };
10557
10558 /* Setup */
10559
10560 OO.inheritClass( OO.ui.ListToolGroup, OO.ui.PopupToolGroup );
10561
10562 /* Static Properties */
10563
10564 OO.ui.ListToolGroup.static.name = 'list';
10565
10566 /* Methods */
10567
10568 /**
10569 * @inheritdoc
10570 */
10571 OO.ui.ListToolGroup.prototype.populate = function () {
10572 var i, len, allowCollapse = [];
10573
10574 OO.ui.ListToolGroup.super.prototype.populate.call( this );
10575
10576 // Update the list of collapsible tools
10577 if ( this.allowCollapse !== undefined ) {
10578 allowCollapse = this.allowCollapse;
10579 } else if ( this.forceExpand !== undefined ) {
10580 allowCollapse = OO.simpleArrayDifference( Object.keys( this.tools ), this.forceExpand );
10581 }
10582
10583 this.collapsibleTools = [];
10584 for ( i = 0, len = allowCollapse.length; i < len; i++ ) {
10585 if ( this.tools[ allowCollapse[ i ] ] !== undefined ) {
10586 this.collapsibleTools.push( this.tools[ allowCollapse[ i ] ] );
10587 }
10588 }
10589
10590 // Keep at the end, even when tools are added
10591 this.$group.append( this.getExpandCollapseTool().$element );
10592
10593 this.getExpandCollapseTool().toggle( this.collapsibleTools.length !== 0 );
10594 this.updateCollapsibleState();
10595 };
10596
10597 OO.ui.ListToolGroup.prototype.getExpandCollapseTool = function () {
10598 if ( this.expandCollapseTool === undefined ) {
10599 var ExpandCollapseTool = function () {
10600 ExpandCollapseTool.super.apply( this, arguments );
10601 };
10602
10603 OO.inheritClass( ExpandCollapseTool, OO.ui.Tool );
10604
10605 ExpandCollapseTool.prototype.onSelect = function () {
10606 this.toolGroup.expanded = !this.toolGroup.expanded;
10607 this.toolGroup.updateCollapsibleState();
10608 this.setActive( false );
10609 };
10610 ExpandCollapseTool.prototype.onUpdateState = function () {
10611 // Do nothing. Tool interface requires an implementation of this function.
10612 };
10613
10614 ExpandCollapseTool.static.name = 'more-fewer';
10615
10616 this.expandCollapseTool = new ExpandCollapseTool( this );
10617 }
10618 return this.expandCollapseTool;
10619 };
10620
10621 /**
10622 * @inheritdoc
10623 */
10624 OO.ui.ListToolGroup.prototype.onMouseKeyUp = function ( e ) {
10625 // Do not close the popup when the user wants to show more/fewer tools
10626 if (
10627 $( e.target ).closest( '.oo-ui-tool-name-more-fewer' ).length &&
10628 ( e.which === 1 || e.which === OO.ui.Keys.SPACE || e.which === OO.ui.Keys.ENTER )
10629 ) {
10630 // HACK: Prevent the popup list from being hidden. Skip the PopupToolGroup implementation (which
10631 // hides the popup list when a tool is selected) and call ToolGroup's implementation directly.
10632 return OO.ui.ListToolGroup.super.super.prototype.onMouseKeyUp.call( this, e );
10633 } else {
10634 return OO.ui.ListToolGroup.super.prototype.onMouseKeyUp.call( this, e );
10635 }
10636 };
10637
10638 OO.ui.ListToolGroup.prototype.updateCollapsibleState = function () {
10639 var i, len;
10640
10641 this.getExpandCollapseTool()
10642 .setIcon( this.expanded ? 'collapse' : 'expand' )
10643 .setTitle( OO.ui.msg( this.expanded ? 'ooui-toolgroup-collapse' : 'ooui-toolgroup-expand' ) );
10644
10645 for ( i = 0, len = this.collapsibleTools.length; i < len; i++ ) {
10646 this.collapsibleTools[ i ].toggle( this.expanded );
10647 }
10648 };
10649
10650 /**
10651 * Drop down menu layout of tools as selectable menu items.
10652 *
10653 * @class
10654 * @extends OO.ui.PopupToolGroup
10655 *
10656 * @constructor
10657 * @param {OO.ui.Toolbar} toolbar
10658 * @param {Object} [config] Configuration options
10659 */
10660 OO.ui.MenuToolGroup = function OoUiMenuToolGroup( toolbar, config ) {
10661 // Allow passing positional parameters inside the config object
10662 if ( OO.isPlainObject( toolbar ) && config === undefined ) {
10663 config = toolbar;
10664 toolbar = config.toolbar;
10665 }
10666
10667 // Configuration initialization
10668 config = config || {};
10669
10670 // Parent constructor
10671 OO.ui.MenuToolGroup.super.call( this, toolbar, config );
10672
10673 // Events
10674 this.toolbar.connect( this, { updateState: 'onUpdateState' } );
10675
10676 // Initialization
10677 this.$element.addClass( 'oo-ui-menuToolGroup' );
10678 };
10679
10680 /* Setup */
10681
10682 OO.inheritClass( OO.ui.MenuToolGroup, OO.ui.PopupToolGroup );
10683
10684 /* Static Properties */
10685
10686 OO.ui.MenuToolGroup.static.name = 'menu';
10687
10688 /* Methods */
10689
10690 /**
10691 * Handle the toolbar state being updated.
10692 *
10693 * When the state changes, the title of each active item in the menu will be joined together and
10694 * used as a label for the group. The label will be empty if none of the items are active.
10695 */
10696 OO.ui.MenuToolGroup.prototype.onUpdateState = function () {
10697 var name,
10698 labelTexts = [];
10699
10700 for ( name in this.tools ) {
10701 if ( this.tools[ name ].isActive() ) {
10702 labelTexts.push( this.tools[ name ].getTitle() );
10703 }
10704 }
10705
10706 this.setLabel( labelTexts.join( ', ' ) || ' ' );
10707 };
10708
10709 /**
10710 * Tool that shows a popup when selected.
10711 *
10712 * @abstract
10713 * @class
10714 * @extends OO.ui.Tool
10715 * @mixins OO.ui.PopupElement
10716 *
10717 * @constructor
10718 * @param {OO.ui.ToolGroup} toolGroup
10719 * @param {Object} [config] Configuration options
10720 */
10721 OO.ui.PopupTool = function OoUiPopupTool( toolGroup, config ) {
10722 // Allow passing positional parameters inside the config object
10723 if ( OO.isPlainObject( toolGroup ) && config === undefined ) {
10724 config = toolGroup;
10725 toolGroup = config.toolGroup;
10726 }
10727
10728 // Parent constructor
10729 OO.ui.PopupTool.super.call( this, toolGroup, config );
10730
10731 // Mixin constructors
10732 OO.ui.PopupElement.call( this, config );
10733
10734 // Initialization
10735 this.$element
10736 .addClass( 'oo-ui-popupTool' )
10737 .append( this.popup.$element );
10738 };
10739
10740 /* Setup */
10741
10742 OO.inheritClass( OO.ui.PopupTool, OO.ui.Tool );
10743 OO.mixinClass( OO.ui.PopupTool, OO.ui.PopupElement );
10744
10745 /* Methods */
10746
10747 /**
10748 * Handle the tool being selected.
10749 *
10750 * @inheritdoc
10751 */
10752 OO.ui.PopupTool.prototype.onSelect = function () {
10753 if ( !this.isDisabled() ) {
10754 this.popup.toggle();
10755 }
10756 this.setActive( false );
10757 return false;
10758 };
10759
10760 /**
10761 * Handle the toolbar state being updated.
10762 *
10763 * @inheritdoc
10764 */
10765 OO.ui.PopupTool.prototype.onUpdateState = function () {
10766 this.setActive( false );
10767 };
10768
10769 /**
10770 * Tool that has a tool group inside. This is a bad workaround for the lack of proper hierarchical
10771 * menus in toolbars (T74159).
10772 *
10773 * @abstract
10774 * @class
10775 * @extends OO.ui.Tool
10776 *
10777 * @constructor
10778 * @param {OO.ui.ToolGroup} toolGroup
10779 * @param {Object} [config] Configuration options
10780 */
10781 OO.ui.ToolGroupTool = function OoUiToolGroupTool( toolGroup, config ) {
10782 // Allow passing positional parameters inside the config object
10783 if ( OO.isPlainObject( toolGroup ) && config === undefined ) {
10784 config = toolGroup;
10785 toolGroup = config.toolGroup;
10786 }
10787
10788 // Parent constructor
10789 OO.ui.ToolGroupTool.super.call( this, toolGroup, config );
10790
10791 // Properties
10792 this.innerToolGroup = this.createGroup( this.constructor.static.groupConfig );
10793
10794 // Initialization
10795 this.$link.remove();
10796 this.$element
10797 .addClass( 'oo-ui-toolGroupTool' )
10798 .append( this.innerToolGroup.$element );
10799 };
10800
10801 /* Setup */
10802
10803 OO.inheritClass( OO.ui.ToolGroupTool, OO.ui.Tool );
10804
10805 /* Static Properties */
10806
10807 /**
10808 * Tool group configuration. See OO.ui.Toolbar#setup for the accepted values.
10809 *
10810 * @property {Object.<string,Array>}
10811 */
10812 OO.ui.ToolGroupTool.static.groupConfig = {};
10813
10814 /* Methods */
10815
10816 /**
10817 * Handle the tool being selected.
10818 *
10819 * @inheritdoc
10820 */
10821 OO.ui.ToolGroupTool.prototype.onSelect = function () {
10822 this.innerToolGroup.setActive( !this.innerToolGroup.active );
10823 return false;
10824 };
10825
10826 /**
10827 * Handle the toolbar state being updated.
10828 *
10829 * @inheritdoc
10830 */
10831 OO.ui.ToolGroupTool.prototype.onUpdateState = function () {
10832 this.setActive( false );
10833 };
10834
10835 /**
10836 * Build a OO.ui.ToolGroup from the configuration.
10837 *
10838 * @param {Object.<string,Array>} group Tool group configuration. See OO.ui.Toolbar#setup for the
10839 * accepted values.
10840 * @return {OO.ui.ListToolGroup}
10841 */
10842 OO.ui.ToolGroupTool.prototype.createGroup = function ( group ) {
10843 if ( group.include === '*' ) {
10844 // Apply defaults to catch-all groups
10845 if ( group.label === undefined ) {
10846 group.label = OO.ui.msg( 'ooui-toolbar-more' );
10847 }
10848 }
10849
10850 return this.toolbar.getToolGroupFactory().create( 'list', this.toolbar, group );
10851 };
10852
10853 /**
10854 * Mixin for OO.ui.Widget subclasses to provide OO.ui.GroupElement.
10855 *
10856 * Use together with OO.ui.ItemWidget to make disabled state inheritable.
10857 *
10858 * @private
10859 * @abstract
10860 * @class
10861 * @extends OO.ui.GroupElement
10862 *
10863 * @constructor
10864 * @param {Object} [config] Configuration options
10865 */
10866 OO.ui.GroupWidget = function OoUiGroupWidget( config ) {
10867 // Parent constructor
10868 OO.ui.GroupWidget.super.call( this, config );
10869 };
10870
10871 /* Setup */
10872
10873 OO.inheritClass( OO.ui.GroupWidget, OO.ui.GroupElement );
10874
10875 /* Methods */
10876
10877 /**
10878 * Set the disabled state of the widget.
10879 *
10880 * This will also update the disabled state of child widgets.
10881 *
10882 * @param {boolean} disabled Disable widget
10883 * @chainable
10884 */
10885 OO.ui.GroupWidget.prototype.setDisabled = function ( disabled ) {
10886 var i, len;
10887
10888 // Parent method
10889 // Note: Calling #setDisabled this way assumes this is mixed into an OO.ui.Widget
10890 OO.ui.Widget.prototype.setDisabled.call( this, disabled );
10891
10892 // During construction, #setDisabled is called before the OO.ui.GroupElement constructor
10893 if ( this.items ) {
10894 for ( i = 0, len = this.items.length; i < len; i++ ) {
10895 this.items[ i ].updateDisabled();
10896 }
10897 }
10898
10899 return this;
10900 };
10901
10902 /**
10903 * Mixin for widgets used as items in widgets that inherit OO.ui.GroupWidget.
10904 *
10905 * Item widgets have a reference to a OO.ui.GroupWidget while they are attached to the group. This
10906 * allows bidirectional communication.
10907 *
10908 * Use together with OO.ui.GroupWidget to make disabled state inheritable.
10909 *
10910 * @private
10911 * @abstract
10912 * @class
10913 *
10914 * @constructor
10915 */
10916 OO.ui.ItemWidget = function OoUiItemWidget() {
10917 //
10918 };
10919
10920 /* Methods */
10921
10922 /**
10923 * Check if widget is disabled.
10924 *
10925 * Checks parent if present, making disabled state inheritable.
10926 *
10927 * @return {boolean} Widget is disabled
10928 */
10929 OO.ui.ItemWidget.prototype.isDisabled = function () {
10930 return this.disabled ||
10931 ( this.elementGroup instanceof OO.ui.Widget && this.elementGroup.isDisabled() );
10932 };
10933
10934 /**
10935 * Set group element is in.
10936 *
10937 * @param {OO.ui.GroupElement|null} group Group element, null if none
10938 * @chainable
10939 */
10940 OO.ui.ItemWidget.prototype.setElementGroup = function ( group ) {
10941 // Parent method
10942 // Note: Calling #setElementGroup this way assumes this is mixed into an OO.ui.Element
10943 OO.ui.Element.prototype.setElementGroup.call( this, group );
10944
10945 // Initialize item disabled states
10946 this.updateDisabled();
10947
10948 return this;
10949 };
10950
10951 /**
10952 * OutlineControlsWidget is a set of controls for an {@link OO.ui.OutlineSelectWidget outline select widget}.
10953 * Controls include moving items up and down, removing items, and adding different kinds of items.
10954 * ####Currently, this class is only used by {@link OO.ui.BookletLayout booklet layouts}.####
10955 *
10956 * @class
10957 * @extends OO.ui.Widget
10958 * @mixins OO.ui.GroupElement
10959 * @mixins OO.ui.IconElement
10960 *
10961 * @constructor
10962 * @param {OO.ui.OutlineSelectWidget} outline Outline to control
10963 * @param {Object} [config] Configuration options
10964 * @cfg {Object} [abilities] List of abilties
10965 * @cfg {boolean} [abilities.move=true] Allow moving movable items
10966 * @cfg {boolean} [abilities.remove=true] Allow removing removable items
10967 */
10968 OO.ui.OutlineControlsWidget = function OoUiOutlineControlsWidget( outline, config ) {
10969 // Allow passing positional parameters inside the config object
10970 if ( OO.isPlainObject( outline ) && config === undefined ) {
10971 config = outline;
10972 outline = config.outline;
10973 }
10974
10975 // Configuration initialization
10976 config = $.extend( { icon: 'add' }, config );
10977
10978 // Parent constructor
10979 OO.ui.OutlineControlsWidget.super.call( this, config );
10980
10981 // Mixin constructors
10982 OO.ui.GroupElement.call( this, config );
10983 OO.ui.IconElement.call( this, config );
10984
10985 // Properties
10986 this.outline = outline;
10987 this.$movers = $( '<div>' );
10988 this.upButton = new OO.ui.ButtonWidget( {
10989 framed: false,
10990 icon: 'collapse',
10991 title: OO.ui.msg( 'ooui-outline-control-move-up' )
10992 } );
10993 this.downButton = new OO.ui.ButtonWidget( {
10994 framed: false,
10995 icon: 'expand',
10996 title: OO.ui.msg( 'ooui-outline-control-move-down' )
10997 } );
10998 this.removeButton = new OO.ui.ButtonWidget( {
10999 framed: false,
11000 icon: 'remove',
11001 title: OO.ui.msg( 'ooui-outline-control-remove' )
11002 } );
11003 this.abilities = { move: true, remove: true };
11004
11005 // Events
11006 outline.connect( this, {
11007 select: 'onOutlineChange',
11008 add: 'onOutlineChange',
11009 remove: 'onOutlineChange'
11010 } );
11011 this.upButton.connect( this, { click: [ 'emit', 'move', -1 ] } );
11012 this.downButton.connect( this, { click: [ 'emit', 'move', 1 ] } );
11013 this.removeButton.connect( this, { click: [ 'emit', 'remove' ] } );
11014
11015 // Initialization
11016 this.$element.addClass( 'oo-ui-outlineControlsWidget' );
11017 this.$group.addClass( 'oo-ui-outlineControlsWidget-items' );
11018 this.$movers
11019 .addClass( 'oo-ui-outlineControlsWidget-movers' )
11020 .append( this.removeButton.$element, this.upButton.$element, this.downButton.$element );
11021 this.$element.append( this.$icon, this.$group, this.$movers );
11022 this.setAbilities( config.abilities || {} );
11023 };
11024
11025 /* Setup */
11026
11027 OO.inheritClass( OO.ui.OutlineControlsWidget, OO.ui.Widget );
11028 OO.mixinClass( OO.ui.OutlineControlsWidget, OO.ui.GroupElement );
11029 OO.mixinClass( OO.ui.OutlineControlsWidget, OO.ui.IconElement );
11030
11031 /* Events */
11032
11033 /**
11034 * @event move
11035 * @param {number} places Number of places to move
11036 */
11037
11038 /**
11039 * @event remove
11040 */
11041
11042 /* Methods */
11043
11044 /**
11045 * Set abilities.
11046 *
11047 * @param {Object} abilities List of abilties
11048 * @param {boolean} [abilities.move] Allow moving movable items
11049 * @param {boolean} [abilities.remove] Allow removing removable items
11050 */
11051 OO.ui.OutlineControlsWidget.prototype.setAbilities = function ( abilities ) {
11052 var ability;
11053
11054 for ( ability in this.abilities ) {
11055 if ( abilities[ability] !== undefined ) {
11056 this.abilities[ability] = !!abilities[ability];
11057 }
11058 }
11059
11060 this.onOutlineChange();
11061 };
11062
11063 /**
11064 *
11065 * @private
11066 * Handle outline change events.
11067 */
11068 OO.ui.OutlineControlsWidget.prototype.onOutlineChange = function () {
11069 var i, len, firstMovable, lastMovable,
11070 items = this.outline.getItems(),
11071 selectedItem = this.outline.getSelectedItem(),
11072 movable = this.abilities.move && selectedItem && selectedItem.isMovable(),
11073 removable = this.abilities.remove && selectedItem && selectedItem.isRemovable();
11074
11075 if ( movable ) {
11076 i = -1;
11077 len = items.length;
11078 while ( ++i < len ) {
11079 if ( items[ i ].isMovable() ) {
11080 firstMovable = items[ i ];
11081 break;
11082 }
11083 }
11084 i = len;
11085 while ( i-- ) {
11086 if ( items[ i ].isMovable() ) {
11087 lastMovable = items[ i ];
11088 break;
11089 }
11090 }
11091 }
11092 this.upButton.setDisabled( !movable || selectedItem === firstMovable );
11093 this.downButton.setDisabled( !movable || selectedItem === lastMovable );
11094 this.removeButton.setDisabled( !removable );
11095 };
11096
11097 /**
11098 * ToggleWidget implements basic behavior of widgets with an on/off state.
11099 * Please see OO.ui.ToggleButtonWidget and OO.ui.ToggleSwitchWidget for examples.
11100 *
11101 * @abstract
11102 * @class
11103 * @extends OO.ui.Widget
11104 *
11105 * @constructor
11106 * @param {Object} [config] Configuration options
11107 * @cfg {boolean} [value=false] The toggle’s initial on/off state.
11108 * By default, the toggle is in the 'off' state.
11109 */
11110 OO.ui.ToggleWidget = function OoUiToggleWidget( config ) {
11111 // Configuration initialization
11112 config = config || {};
11113
11114 // Parent constructor
11115 OO.ui.ToggleWidget.super.call( this, config );
11116
11117 // Properties
11118 this.value = null;
11119
11120 // Initialization
11121 this.$element.addClass( 'oo-ui-toggleWidget' );
11122 this.setValue( !!config.value );
11123 };
11124
11125 /* Setup */
11126
11127 OO.inheritClass( OO.ui.ToggleWidget, OO.ui.Widget );
11128
11129 /* Events */
11130
11131 /**
11132 * @event change
11133 *
11134 * A change event is emitted when the on/off state of the toggle changes.
11135 *
11136 * @param {boolean} value Value representing the new state of the toggle
11137 */
11138
11139 /* Methods */
11140
11141 /**
11142 * Get the value representing the toggle’s state.
11143 *
11144 * @return {boolean} The on/off state of the toggle
11145 */
11146 OO.ui.ToggleWidget.prototype.getValue = function () {
11147 return this.value;
11148 };
11149
11150 /**
11151 * Set the state of the toggle: `true` for 'on', `false' for 'off'.
11152 *
11153 * @param {boolean} value The state of the toggle
11154 * @fires change
11155 * @chainable
11156 */
11157 OO.ui.ToggleWidget.prototype.setValue = function ( value ) {
11158 value = !!value;
11159 if ( this.value !== value ) {
11160 this.value = value;
11161 this.emit( 'change', value );
11162 this.$element.toggleClass( 'oo-ui-toggleWidget-on', value );
11163 this.$element.toggleClass( 'oo-ui-toggleWidget-off', !value );
11164 this.$element.attr( 'aria-checked', value.toString() );
11165 }
11166 return this;
11167 };
11168
11169 /**
11170 * A ButtonGroupWidget groups related buttons and is used together with OO.ui.ButtonWidget and
11171 * its subclasses. Each button in a group is addressed by a unique reference. Buttons can be added,
11172 * removed, and cleared from the group.
11173 *
11174 * @example
11175 * // Example: A ButtonGroupWidget with two buttons
11176 * var button1 = new OO.ui.PopupButtonWidget( {
11177 * label: 'Select a category',
11178 * icon: 'menu',
11179 * popup: {
11180 * $content: $( '<p>List of categories...</p>' ),
11181 * padded: true,
11182 * align: 'left'
11183 * }
11184 * } );
11185 * var button2 = new OO.ui.ButtonWidget( {
11186 * label: 'Add item'
11187 * });
11188 * var buttonGroup = new OO.ui.ButtonGroupWidget( {
11189 * items: [button1, button2]
11190 * } );
11191 * $( 'body' ).append( buttonGroup.$element );
11192 *
11193 * @class
11194 * @extends OO.ui.Widget
11195 * @mixins OO.ui.GroupElement
11196 *
11197 * @constructor
11198 * @param {Object} [config] Configuration options
11199 * @cfg {OO.ui.ButtonWidget[]} [items] Buttons to add
11200 */
11201 OO.ui.ButtonGroupWidget = function OoUiButtonGroupWidget( config ) {
11202 // Configuration initialization
11203 config = config || {};
11204
11205 // Parent constructor
11206 OO.ui.ButtonGroupWidget.super.call( this, config );
11207
11208 // Mixin constructors
11209 OO.ui.GroupElement.call( this, $.extend( {}, config, { $group: this.$element } ) );
11210
11211 // Initialization
11212 this.$element.addClass( 'oo-ui-buttonGroupWidget' );
11213 if ( Array.isArray( config.items ) ) {
11214 this.addItems( config.items );
11215 }
11216 };
11217
11218 /* Setup */
11219
11220 OO.inheritClass( OO.ui.ButtonGroupWidget, OO.ui.Widget );
11221 OO.mixinClass( OO.ui.ButtonGroupWidget, OO.ui.GroupElement );
11222
11223 /**
11224 * ButtonWidget is a generic widget for buttons. A wide variety of looks,
11225 * feels, and functionality can be customized via the class’s configuration options
11226 * and methods. Please see the [OOjs UI documentation on MediaWiki] [1] for more information
11227 * and examples.
11228 *
11229 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Buttons_and_Switches
11230 *
11231 * @example
11232 * // A button widget
11233 * var button = new OO.ui.ButtonWidget( {
11234 * label: 'Button with Icon',
11235 * icon: 'remove',
11236 * iconTitle: 'Remove'
11237 * } );
11238 * $( 'body' ).append( button.$element );
11239 *
11240 * NOTE: HTML form buttons should use the OO.ui.ButtonInputWidget class.
11241 *
11242 * @class
11243 * @extends OO.ui.Widget
11244 * @mixins OO.ui.ButtonElement
11245 * @mixins OO.ui.IconElement
11246 * @mixins OO.ui.IndicatorElement
11247 * @mixins OO.ui.LabelElement
11248 * @mixins OO.ui.TitledElement
11249 * @mixins OO.ui.FlaggedElement
11250 * @mixins OO.ui.TabIndexedElement
11251 *
11252 * @constructor
11253 * @param {Object} [config] Configuration options
11254 * @cfg {string} [href] Hyperlink to visit when the button is clicked.
11255 * @cfg {string} [target] The frame or window in which to open the hyperlink.
11256 * @cfg {boolean} [noFollow] Search engine traversal hint (default: true)
11257 */
11258 OO.ui.ButtonWidget = function OoUiButtonWidget( config ) {
11259 // Configuration initialization
11260 config = config || {};
11261
11262 // Parent constructor
11263 OO.ui.ButtonWidget.super.call( this, config );
11264
11265 // Mixin constructors
11266 OO.ui.ButtonElement.call( this, config );
11267 OO.ui.IconElement.call( this, config );
11268 OO.ui.IndicatorElement.call( this, config );
11269 OO.ui.LabelElement.call( this, config );
11270 OO.ui.TitledElement.call( this, $.extend( {}, config, { $titled: this.$button } ) );
11271 OO.ui.FlaggedElement.call( this, config );
11272 OO.ui.TabIndexedElement.call( this, $.extend( {}, config, { $tabIndexed: this.$button } ) );
11273
11274 // Properties
11275 this.href = null;
11276 this.target = null;
11277 this.noFollow = false;
11278
11279 // Events
11280 this.connect( this, { disable: 'onDisable' } );
11281
11282 // Initialization
11283 this.$button.append( this.$icon, this.$label, this.$indicator );
11284 this.$element
11285 .addClass( 'oo-ui-buttonWidget' )
11286 .append( this.$button );
11287 this.setHref( config.href );
11288 this.setTarget( config.target );
11289 this.setNoFollow( config.noFollow );
11290 };
11291
11292 /* Setup */
11293
11294 OO.inheritClass( OO.ui.ButtonWidget, OO.ui.Widget );
11295 OO.mixinClass( OO.ui.ButtonWidget, OO.ui.ButtonElement );
11296 OO.mixinClass( OO.ui.ButtonWidget, OO.ui.IconElement );
11297 OO.mixinClass( OO.ui.ButtonWidget, OO.ui.IndicatorElement );
11298 OO.mixinClass( OO.ui.ButtonWidget, OO.ui.LabelElement );
11299 OO.mixinClass( OO.ui.ButtonWidget, OO.ui.TitledElement );
11300 OO.mixinClass( OO.ui.ButtonWidget, OO.ui.FlaggedElement );
11301 OO.mixinClass( OO.ui.ButtonWidget, OO.ui.TabIndexedElement );
11302
11303 /* Methods */
11304
11305 /**
11306 * @inheritdoc
11307 */
11308 OO.ui.ButtonWidget.prototype.onMouseDown = function ( e ) {
11309 if ( !this.isDisabled() ) {
11310 // Remove the tab-index while the button is down to prevent the button from stealing focus
11311 this.$button.removeAttr( 'tabindex' );
11312 }
11313
11314 return OO.ui.ButtonElement.prototype.onMouseDown.call( this, e );
11315 };
11316
11317 /**
11318 * @inheritdoc
11319 */
11320 OO.ui.ButtonWidget.prototype.onMouseUp = function ( e ) {
11321 if ( !this.isDisabled() ) {
11322 // Restore the tab-index after the button is up to restore the button's accessibility
11323 this.$button.attr( 'tabindex', this.tabIndex );
11324 }
11325
11326 return OO.ui.ButtonElement.prototype.onMouseUp.call( this, e );
11327 };
11328
11329 /**
11330 * Get hyperlink location.
11331 *
11332 * @return {string} Hyperlink location
11333 */
11334 OO.ui.ButtonWidget.prototype.getHref = function () {
11335 return this.href;
11336 };
11337
11338 /**
11339 * Get hyperlink target.
11340 *
11341 * @return {string} Hyperlink target
11342 */
11343 OO.ui.ButtonWidget.prototype.getTarget = function () {
11344 return this.target;
11345 };
11346
11347 /**
11348 * Get search engine traversal hint.
11349 *
11350 * @return {boolean} Whether search engines should avoid traversing this hyperlink
11351 */
11352 OO.ui.ButtonWidget.prototype.getNoFollow = function () {
11353 return this.noFollow;
11354 };
11355
11356 /**
11357 * Set hyperlink location.
11358 *
11359 * @param {string|null} href Hyperlink location, null to remove
11360 */
11361 OO.ui.ButtonWidget.prototype.setHref = function ( href ) {
11362 href = typeof href === 'string' ? href : null;
11363
11364 if ( href !== this.href ) {
11365 this.href = href;
11366 this.updateHref();
11367 }
11368
11369 return this;
11370 };
11371
11372 /**
11373 * Update the `href` attribute, in case of changes to href or
11374 * disabled state.
11375 *
11376 * @private
11377 * @chainable
11378 */
11379 OO.ui.ButtonWidget.prototype.updateHref = function () {
11380 if ( this.href !== null && !this.isDisabled() ) {
11381 this.$button.attr( 'href', this.href );
11382 } else {
11383 this.$button.removeAttr( 'href' );
11384 }
11385
11386 return this;
11387 };
11388
11389 /**
11390 * Handle disable events.
11391 *
11392 * @private
11393 * @param {boolean} disabled Element is disabled
11394 */
11395 OO.ui.ButtonWidget.prototype.onDisable = function () {
11396 this.updateHref();
11397 };
11398
11399 /**
11400 * Set hyperlink target.
11401 *
11402 * @param {string|null} target Hyperlink target, null to remove
11403 */
11404 OO.ui.ButtonWidget.prototype.setTarget = function ( target ) {
11405 target = typeof target === 'string' ? target : null;
11406
11407 if ( target !== this.target ) {
11408 this.target = target;
11409 if ( target !== null ) {
11410 this.$button.attr( 'target', target );
11411 } else {
11412 this.$button.removeAttr( 'target' );
11413 }
11414 }
11415
11416 return this;
11417 };
11418
11419 /**
11420 * Set search engine traversal hint.
11421 *
11422 * @param {boolean} noFollow True if search engines should avoid traversing this hyperlink
11423 */
11424 OO.ui.ButtonWidget.prototype.setNoFollow = function ( noFollow ) {
11425 noFollow = typeof noFollow === 'boolean' ? noFollow : true;
11426
11427 if ( noFollow !== this.noFollow ) {
11428 this.noFollow = noFollow;
11429 if ( noFollow ) {
11430 this.$button.attr( 'rel', 'nofollow' );
11431 } else {
11432 this.$button.removeAttr( 'rel' );
11433 }
11434 }
11435
11436 return this;
11437 };
11438
11439 /**
11440 * An ActionWidget is a {@link OO.ui.ButtonWidget button widget} that executes an action.
11441 * Action widgets are used with OO.ui.ActionSet, which manages the behavior and availability
11442 * of the actions.
11443 *
11444 * Both actions and action sets are primarily used with {@link OO.ui.Dialog Dialogs}.
11445 * Please see the [OOjs UI documentation on MediaWiki] [1] for more information
11446 * and examples.
11447 *
11448 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Windows/Process_Dialogs#Action_sets
11449 *
11450 * @class
11451 * @extends OO.ui.ButtonWidget
11452 * @mixins OO.ui.PendingElement
11453 *
11454 * @constructor
11455 * @param {Object} [config] Configuration options
11456 * @cfg {string} [action] Symbolic name of the action (e.g., ‘continue’ or ‘cancel’).
11457 * @cfg {string[]} [modes] Symbolic names of the modes (e.g., ‘edit’ or ‘read’) in which the action
11458 * should be made available. See the action set's {@link OO.ui.ActionSet#setMode setMode} method
11459 * for more information about setting modes.
11460 * @cfg {boolean} [framed=false] Render the action button with a frame
11461 */
11462 OO.ui.ActionWidget = function OoUiActionWidget( config ) {
11463 // Configuration initialization
11464 config = $.extend( { framed: false }, config );
11465
11466 // Parent constructor
11467 OO.ui.ActionWidget.super.call( this, config );
11468
11469 // Mixin constructors
11470 OO.ui.PendingElement.call( this, config );
11471
11472 // Properties
11473 this.action = config.action || '';
11474 this.modes = config.modes || [];
11475 this.width = 0;
11476 this.height = 0;
11477
11478 // Initialization
11479 this.$element.addClass( 'oo-ui-actionWidget' );
11480 };
11481
11482 /* Setup */
11483
11484 OO.inheritClass( OO.ui.ActionWidget, OO.ui.ButtonWidget );
11485 OO.mixinClass( OO.ui.ActionWidget, OO.ui.PendingElement );
11486
11487 /* Events */
11488
11489 /**
11490 * A resize event is emitted when the size of the widget changes.
11491 *
11492 * @event resize
11493 */
11494
11495 /* Methods */
11496
11497 /**
11498 * Check if the action is configured to be available in the specified `mode`.
11499 *
11500 * @param {string} mode Name of mode
11501 * @return {boolean} The action is configured with the mode
11502 */
11503 OO.ui.ActionWidget.prototype.hasMode = function ( mode ) {
11504 return this.modes.indexOf( mode ) !== -1;
11505 };
11506
11507 /**
11508 * Get the symbolic name of the action (e.g., ‘continue’ or ‘cancel’).
11509 *
11510 * @return {string}
11511 */
11512 OO.ui.ActionWidget.prototype.getAction = function () {
11513 return this.action;
11514 };
11515
11516 /**
11517 * Get the symbolic name of the mode or modes for which the action is configured to be available.
11518 *
11519 * The current mode is set with the action set's {@link OO.ui.ActionSet#setMode setMode} method.
11520 * Only actions that are configured to be avaiable in the current mode will be visible. All other actions
11521 * are hidden.
11522 *
11523 * @return {string[]}
11524 */
11525 OO.ui.ActionWidget.prototype.getModes = function () {
11526 return this.modes.slice();
11527 };
11528
11529 /**
11530 * Emit a resize event if the size has changed.
11531 *
11532 * @private
11533 * @chainable
11534 */
11535 OO.ui.ActionWidget.prototype.propagateResize = function () {
11536 var width, height;
11537
11538 if ( this.isElementAttached() ) {
11539 width = this.$element.width();
11540 height = this.$element.height();
11541
11542 if ( width !== this.width || height !== this.height ) {
11543 this.width = width;
11544 this.height = height;
11545 this.emit( 'resize' );
11546 }
11547 }
11548
11549 return this;
11550 };
11551
11552 /**
11553 * @inheritdoc
11554 */
11555 OO.ui.ActionWidget.prototype.setIcon = function () {
11556 // Mixin method
11557 OO.ui.IconElement.prototype.setIcon.apply( this, arguments );
11558 this.propagateResize();
11559
11560 return this;
11561 };
11562
11563 /**
11564 * @inheritdoc
11565 */
11566 OO.ui.ActionWidget.prototype.setLabel = function () {
11567 // Mixin method
11568 OO.ui.LabelElement.prototype.setLabel.apply( this, arguments );
11569 this.propagateResize();
11570
11571 return this;
11572 };
11573
11574 /**
11575 * @inheritdoc
11576 */
11577 OO.ui.ActionWidget.prototype.setFlags = function () {
11578 // Mixin method
11579 OO.ui.FlaggedElement.prototype.setFlags.apply( this, arguments );
11580 this.propagateResize();
11581
11582 return this;
11583 };
11584
11585 /**
11586 * @inheritdoc
11587 */
11588 OO.ui.ActionWidget.prototype.clearFlags = function () {
11589 // Mixin method
11590 OO.ui.FlaggedElement.prototype.clearFlags.apply( this, arguments );
11591 this.propagateResize();
11592
11593 return this;
11594 };
11595
11596 /**
11597 * Toggle the visibility of the action button.
11598 *
11599 * @param {boolean} [show] Show button, omit to toggle visibility
11600 * @chainable
11601 */
11602 OO.ui.ActionWidget.prototype.toggle = function () {
11603 // Parent method
11604 OO.ui.ActionWidget.super.prototype.toggle.apply( this, arguments );
11605 this.propagateResize();
11606
11607 return this;
11608 };
11609
11610 /**
11611 * PopupButtonWidgets toggle the visibility of a contained {@link OO.ui.PopupWidget PopupWidget},
11612 * which is used to display additional information or options.
11613 *
11614 * @example
11615 * // Example of a popup button.
11616 * var popupButton = new OO.ui.PopupButtonWidget( {
11617 * label: 'Popup button with options',
11618 * icon: 'menu',
11619 * popup: {
11620 * $content: $( '<p>Additional options here.</p>' ),
11621 * padded: true,
11622 * align: 'force-left'
11623 * }
11624 * } );
11625 * // Append the button to the DOM.
11626 * $( 'body' ).append( popupButton.$element );
11627 *
11628 * @class
11629 * @extends OO.ui.ButtonWidget
11630 * @mixins OO.ui.PopupElement
11631 *
11632 * @constructor
11633 * @param {Object} [config] Configuration options
11634 */
11635 OO.ui.PopupButtonWidget = function OoUiPopupButtonWidget( config ) {
11636 // Parent constructor
11637 OO.ui.PopupButtonWidget.super.call( this, config );
11638
11639 // Mixin constructors
11640 OO.ui.PopupElement.call( this, config );
11641
11642 // Events
11643 this.connect( this, { click: 'onAction' } );
11644
11645 // Initialization
11646 this.$element
11647 .addClass( 'oo-ui-popupButtonWidget' )
11648 .attr( 'aria-haspopup', 'true' )
11649 .append( this.popup.$element );
11650 };
11651
11652 /* Setup */
11653
11654 OO.inheritClass( OO.ui.PopupButtonWidget, OO.ui.ButtonWidget );
11655 OO.mixinClass( OO.ui.PopupButtonWidget, OO.ui.PopupElement );
11656
11657 /* Methods */
11658
11659 /**
11660 * Handle the button action being triggered.
11661 *
11662 * @private
11663 */
11664 OO.ui.PopupButtonWidget.prototype.onAction = function () {
11665 this.popup.toggle();
11666 };
11667
11668 /**
11669 * ToggleButtons are buttons that have a state (‘on’ or ‘off’) that is represented by a
11670 * Boolean value. Like other {@link OO.ui.ButtonWidget buttons}, toggle buttons can be
11671 * configured with {@link OO.ui.IconElement icons}, {@link OO.ui.IndicatorElement indicators},
11672 * {@link OO.ui.TitledElement titles}, {@link OO.ui.FlaggedElement styling flags},
11673 * and {@link OO.ui.LabelElement labels}. Please see
11674 * the [OOjs UI documentation][1] on MediaWiki for more information.
11675 *
11676 * @example
11677 * // Toggle buttons in the 'off' and 'on' state.
11678 * var toggleButton1 = new OO.ui.ToggleButtonWidget( {
11679 * label: 'Toggle Button off'
11680 * } );
11681 * var toggleButton2 = new OO.ui.ToggleButtonWidget( {
11682 * label: 'Toggle Button on',
11683 * value: true
11684 * } );
11685 * // Append the buttons to the DOM.
11686 * $( 'body' ).append( toggleButton1.$element, toggleButton2.$element );
11687 *
11688 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Buttons_and_Switches#Toggle_buttons
11689 *
11690 * @class
11691 * @extends OO.ui.ToggleWidget
11692 * @mixins OO.ui.ButtonElement
11693 * @mixins OO.ui.IconElement
11694 * @mixins OO.ui.IndicatorElement
11695 * @mixins OO.ui.LabelElement
11696 * @mixins OO.ui.TitledElement
11697 * @mixins OO.ui.FlaggedElement
11698 * @mixins OO.ui.TabIndexedElement
11699 *
11700 * @constructor
11701 * @param {Object} [config] Configuration options
11702 * @cfg {boolean} [value=false] The toggle button’s initial on/off
11703 * state. By default, the button is in the 'off' state.
11704 */
11705 OO.ui.ToggleButtonWidget = function OoUiToggleButtonWidget( config ) {
11706 // Configuration initialization
11707 config = config || {};
11708
11709 // Parent constructor
11710 OO.ui.ToggleButtonWidget.super.call( this, config );
11711
11712 // Mixin constructors
11713 OO.ui.ButtonElement.call( this, config );
11714 OO.ui.IconElement.call( this, config );
11715 OO.ui.IndicatorElement.call( this, config );
11716 OO.ui.LabelElement.call( this, config );
11717 OO.ui.TitledElement.call( this, $.extend( {}, config, { $titled: this.$button } ) );
11718 OO.ui.FlaggedElement.call( this, config );
11719 OO.ui.TabIndexedElement.call( this, $.extend( {}, config, { $tabIndexed: this.$button } ) );
11720
11721 // Events
11722 this.connect( this, { click: 'onAction' } );
11723
11724 // Initialization
11725 this.$button.append( this.$icon, this.$label, this.$indicator );
11726 this.$element
11727 .addClass( 'oo-ui-toggleButtonWidget' )
11728 .append( this.$button );
11729 };
11730
11731 /* Setup */
11732
11733 OO.inheritClass( OO.ui.ToggleButtonWidget, OO.ui.ToggleWidget );
11734 OO.mixinClass( OO.ui.ToggleButtonWidget, OO.ui.ButtonElement );
11735 OO.mixinClass( OO.ui.ToggleButtonWidget, OO.ui.IconElement );
11736 OO.mixinClass( OO.ui.ToggleButtonWidget, OO.ui.IndicatorElement );
11737 OO.mixinClass( OO.ui.ToggleButtonWidget, OO.ui.LabelElement );
11738 OO.mixinClass( OO.ui.ToggleButtonWidget, OO.ui.TitledElement );
11739 OO.mixinClass( OO.ui.ToggleButtonWidget, OO.ui.FlaggedElement );
11740 OO.mixinClass( OO.ui.ToggleButtonWidget, OO.ui.TabIndexedElement );
11741
11742 /* Methods */
11743
11744 /**
11745 * Handle the button action being triggered.
11746 *
11747 * @private
11748 */
11749 OO.ui.ToggleButtonWidget.prototype.onAction = function () {
11750 this.setValue( !this.value );
11751 };
11752
11753 /**
11754 * @inheritdoc
11755 */
11756 OO.ui.ToggleButtonWidget.prototype.setValue = function ( value ) {
11757 value = !!value;
11758 if ( value !== this.value ) {
11759 // Might be called from parent constructor before ButtonElement constructor
11760 if ( this.$button ) {
11761 this.$button.attr( 'aria-pressed', value.toString() );
11762 }
11763 this.setActive( value );
11764 }
11765
11766 // Parent method
11767 OO.ui.ToggleButtonWidget.super.prototype.setValue.call( this, value );
11768
11769 return this;
11770 };
11771
11772 /**
11773 * @inheritdoc
11774 */
11775 OO.ui.ToggleButtonWidget.prototype.setButtonElement = function ( $button ) {
11776 if ( this.$button ) {
11777 this.$button.removeAttr( 'aria-pressed' );
11778 }
11779 OO.ui.ButtonElement.prototype.setButtonElement.call( this, $button );
11780 this.$button.attr( 'aria-pressed', this.value.toString() );
11781 };
11782
11783 /**
11784 * DropdownWidgets are not menus themselves, rather they contain a menu of options created with
11785 * OO.ui.MenuOptionWidget. The DropdownWidget takes care of opening and displaying the menu so that
11786 * users can interact with it.
11787 *
11788 * @example
11789 * // Example: A DropdownWidget with a menu that contains three options
11790 * var dropDown = new OO.ui.DropdownWidget( {
11791 * label: 'Dropdown menu: Select a menu option',
11792 * menu: {
11793 * items: [
11794 * new OO.ui.MenuOptionWidget( {
11795 * data: 'a',
11796 * label: 'First'
11797 * } ),
11798 * new OO.ui.MenuOptionWidget( {
11799 * data: 'b',
11800 * label: 'Second'
11801 * } ),
11802 * new OO.ui.MenuOptionWidget( {
11803 * data: 'c',
11804 * label: 'Third'
11805 * } )
11806 * ]
11807 * }
11808 * } );
11809 *
11810 * $( 'body' ).append( dropDown.$element );
11811 *
11812 * For more information, please see the [OOjs UI documentation on MediaWiki] [1].
11813 *
11814 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options#Menu_selects_and_options
11815 *
11816 * @class
11817 * @extends OO.ui.Widget
11818 * @mixins OO.ui.IconElement
11819 * @mixins OO.ui.IndicatorElement
11820 * @mixins OO.ui.LabelElement
11821 * @mixins OO.ui.TitledElement
11822 * @mixins OO.ui.TabIndexedElement
11823 *
11824 * @constructor
11825 * @param {Object} [config] Configuration options
11826 * @cfg {Object} [menu] Configuration options to pass to menu widget
11827 */
11828 OO.ui.DropdownWidget = function OoUiDropdownWidget( config ) {
11829 // Configuration initialization
11830 config = $.extend( { indicator: 'down' }, config );
11831
11832 // Parent constructor
11833 OO.ui.DropdownWidget.super.call( this, config );
11834
11835 // Properties (must be set before TabIndexedElement constructor call)
11836 this.$handle = this.$( '<span>' );
11837
11838 // Mixin constructors
11839 OO.ui.IconElement.call( this, config );
11840 OO.ui.IndicatorElement.call( this, config );
11841 OO.ui.LabelElement.call( this, config );
11842 OO.ui.TitledElement.call( this, $.extend( {}, config, { $titled: this.$label } ) );
11843 OO.ui.TabIndexedElement.call( this, $.extend( {}, config, { $tabIndexed: this.$handle } ) );
11844
11845 // Properties
11846 this.menu = new OO.ui.MenuSelectWidget( $.extend( { widget: this }, config.menu ) );
11847
11848 // Events
11849 this.$handle.on( {
11850 click: this.onClick.bind( this ),
11851 keypress: this.onKeyPress.bind( this )
11852 } );
11853 this.menu.connect( this, { select: 'onMenuSelect' } );
11854
11855 // Initialization
11856 this.$handle
11857 .addClass( 'oo-ui-dropdownWidget-handle' )
11858 .append( this.$icon, this.$label, this.$indicator );
11859 this.$element
11860 .addClass( 'oo-ui-dropdownWidget' )
11861 .append( this.$handle, this.menu.$element );
11862 };
11863
11864 /* Setup */
11865
11866 OO.inheritClass( OO.ui.DropdownWidget, OO.ui.Widget );
11867 OO.mixinClass( OO.ui.DropdownWidget, OO.ui.IconElement );
11868 OO.mixinClass( OO.ui.DropdownWidget, OO.ui.IndicatorElement );
11869 OO.mixinClass( OO.ui.DropdownWidget, OO.ui.LabelElement );
11870 OO.mixinClass( OO.ui.DropdownWidget, OO.ui.TitledElement );
11871 OO.mixinClass( OO.ui.DropdownWidget, OO.ui.TabIndexedElement );
11872
11873 /* Methods */
11874
11875 /**
11876 * Get the menu.
11877 *
11878 * @return {OO.ui.MenuSelectWidget} Menu of widget
11879 */
11880 OO.ui.DropdownWidget.prototype.getMenu = function () {
11881 return this.menu;
11882 };
11883
11884 /**
11885 * Handles menu select events.
11886 *
11887 * @private
11888 * @param {OO.ui.MenuOptionWidget} item Selected menu item
11889 */
11890 OO.ui.DropdownWidget.prototype.onMenuSelect = function ( item ) {
11891 var selectedLabel;
11892
11893 if ( !item ) {
11894 return;
11895 }
11896
11897 selectedLabel = item.getLabel();
11898
11899 // If the label is a DOM element, clone it, because setLabel will append() it
11900 if ( selectedLabel instanceof jQuery ) {
11901 selectedLabel = selectedLabel.clone();
11902 }
11903
11904 this.setLabel( selectedLabel );
11905 };
11906
11907 /**
11908 * Handle mouse click events.
11909 *
11910 * @private
11911 * @param {jQuery.Event} e Mouse click event
11912 */
11913 OO.ui.DropdownWidget.prototype.onClick = function ( e ) {
11914 if ( !this.isDisabled() && e.which === 1 ) {
11915 this.menu.toggle();
11916 }
11917 return false;
11918 };
11919
11920 /**
11921 * Handle key press events.
11922 *
11923 * @private
11924 * @param {jQuery.Event} e Key press event
11925 */
11926 OO.ui.DropdownWidget.prototype.onKeyPress = function ( e ) {
11927 if ( !this.isDisabled() && ( e.which === OO.ui.Keys.SPACE || e.which === OO.ui.Keys.ENTER ) ) {
11928 this.menu.toggle();
11929 return false;
11930 }
11931 };
11932
11933 /**
11934 * IconWidget is a generic widget for {@link OO.ui.IconElement icons}. In general, IconWidgets should be used with OO.ui.LabelWidget,
11935 * which creates a label that identifies the icon’s function. See the [OOjs UI documentation on MediaWiki] [1]
11936 * for a list of icons included in the library.
11937 *
11938 * @example
11939 * // An icon widget with a label
11940 * var myIcon = new OO.ui.IconWidget( {
11941 * icon: 'help',
11942 * iconTitle: 'Help'
11943 * } );
11944 * // Create a label.
11945 * var iconLabel = new OO.ui.LabelWidget( {
11946 * label: 'Help'
11947 * } );
11948 * $( 'body' ).append( myIcon.$element, iconLabel.$element );
11949 *
11950 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Icons,_Indicators,_and_Labels#Icons
11951 *
11952 * @class
11953 * @extends OO.ui.Widget
11954 * @mixins OO.ui.IconElement
11955 * @mixins OO.ui.TitledElement
11956 * @mixins OO.ui.FlaggedElement
11957 *
11958 * @constructor
11959 * @param {Object} [config] Configuration options
11960 */
11961 OO.ui.IconWidget = function OoUiIconWidget( config ) {
11962 // Configuration initialization
11963 config = config || {};
11964
11965 // Parent constructor
11966 OO.ui.IconWidget.super.call( this, config );
11967
11968 // Mixin constructors
11969 OO.ui.IconElement.call( this, $.extend( {}, config, { $icon: this.$element } ) );
11970 OO.ui.TitledElement.call( this, $.extend( {}, config, { $titled: this.$element } ) );
11971 OO.ui.FlaggedElement.call( this, $.extend( {}, config, { $flagged: this.$element } ) );
11972
11973 // Initialization
11974 this.$element.addClass( 'oo-ui-iconWidget' );
11975 };
11976
11977 /* Setup */
11978
11979 OO.inheritClass( OO.ui.IconWidget, OO.ui.Widget );
11980 OO.mixinClass( OO.ui.IconWidget, OO.ui.IconElement );
11981 OO.mixinClass( OO.ui.IconWidget, OO.ui.TitledElement );
11982 OO.mixinClass( OO.ui.IconWidget, OO.ui.FlaggedElement );
11983
11984 /* Static Properties */
11985
11986 OO.ui.IconWidget.static.tagName = 'span';
11987
11988 /**
11989 * IndicatorWidgets create indicators, which are small graphics that are generally used to draw
11990 * attention to the status of an item or to clarify the function of a control. For a list of
11991 * indicators included in the library, please see the [OOjs UI documentation on MediaWiki][1].
11992 *
11993 * @example
11994 * // Example of an indicator widget
11995 * var indicator1 = new OO.ui.IndicatorWidget( {
11996 * indicator: 'alert'
11997 * } );
11998 *
11999 * // Create a fieldset layout to add a label
12000 * var fieldset = new OO.ui.FieldsetLayout();
12001 * fieldset.addItems( [
12002 * new OO.ui.FieldLayout( indicator1, { label: 'An alert indicator:' } )
12003 * ] );
12004 * $( 'body' ).append( fieldset.$element );
12005 *
12006 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Icons,_Indicators,_and_Labels#Indicators
12007 *
12008 * @class
12009 * @extends OO.ui.Widget
12010 * @mixins OO.ui.IndicatorElement
12011 * @mixins OO.ui.TitledElement
12012 *
12013 * @constructor
12014 * @param {Object} [config] Configuration options
12015 */
12016 OO.ui.IndicatorWidget = function OoUiIndicatorWidget( config ) {
12017 // Configuration initialization
12018 config = config || {};
12019
12020 // Parent constructor
12021 OO.ui.IndicatorWidget.super.call( this, config );
12022
12023 // Mixin constructors
12024 OO.ui.IndicatorElement.call( this, $.extend( {}, config, { $indicator: this.$element } ) );
12025 OO.ui.TitledElement.call( this, $.extend( {}, config, { $titled: this.$element } ) );
12026
12027 // Initialization
12028 this.$element.addClass( 'oo-ui-indicatorWidget' );
12029 };
12030
12031 /* Setup */
12032
12033 OO.inheritClass( OO.ui.IndicatorWidget, OO.ui.Widget );
12034 OO.mixinClass( OO.ui.IndicatorWidget, OO.ui.IndicatorElement );
12035 OO.mixinClass( OO.ui.IndicatorWidget, OO.ui.TitledElement );
12036
12037 /* Static Properties */
12038
12039 OO.ui.IndicatorWidget.static.tagName = 'span';
12040
12041 /**
12042 * InputWidget is the base class for all input widgets, which
12043 * include {@link OO.ui.TextInputWidget text inputs}, {@link OO.ui.CheckboxInputWidget checkbox inputs},
12044 * {@link OO.ui.RadioInputWidget radio inputs}, and {@link OO.ui.ButtonInputWidget button inputs}.
12045 * See the [OOjs UI documentation on MediaWiki] [1] for more information and examples.
12046 *
12047 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Inputs
12048 *
12049 * @abstract
12050 * @class
12051 * @extends OO.ui.Widget
12052 * @mixins OO.ui.FlaggedElement
12053 * @mixins OO.ui.TabIndexedElement
12054 *
12055 * @constructor
12056 * @param {Object} [config] Configuration options
12057 * @cfg {string} [name=''] The value of the input’s HTML `name` attribute.
12058 * @cfg {string} [value=''] The value of the input.
12059 * @cfg {Function} [inputFilter] The name of an input filter function. Input filters modify the value of an input
12060 * before it is accepted.
12061 */
12062 OO.ui.InputWidget = function OoUiInputWidget( config ) {
12063 // Configuration initialization
12064 config = config || {};
12065
12066 // Parent constructor
12067 OO.ui.InputWidget.super.call( this, config );
12068
12069 // Properties
12070 this.$input = this.getInputElement( config );
12071 this.value = '';
12072 this.inputFilter = config.inputFilter;
12073
12074 // Mixin constructors
12075 OO.ui.FlaggedElement.call( this, config );
12076 OO.ui.TabIndexedElement.call( this, $.extend( {}, config, { $tabIndexed: this.$input } ) );
12077
12078 // Events
12079 this.$input.on( 'keydown mouseup cut paste change input select', this.onEdit.bind( this ) );
12080
12081 // Initialization
12082 this.$input
12083 .attr( 'name', config.name )
12084 .prop( 'disabled', this.isDisabled() );
12085 this.$element.addClass( 'oo-ui-inputWidget' ).append( this.$input, $( '<span>' ) );
12086 this.setValue( config.value );
12087 };
12088
12089 /* Setup */
12090
12091 OO.inheritClass( OO.ui.InputWidget, OO.ui.Widget );
12092 OO.mixinClass( OO.ui.InputWidget, OO.ui.FlaggedElement );
12093 OO.mixinClass( OO.ui.InputWidget, OO.ui.TabIndexedElement );
12094
12095 /* Events */
12096
12097 /**
12098 * @event change
12099 *
12100 * A change event is emitted when the value of the input changes.
12101 *
12102 * @param {string} value
12103 */
12104
12105 /* Methods */
12106
12107 /**
12108 * Get input element.
12109 *
12110 * Subclasses of OO.ui.InputWidget use the `config` parameter to produce different elements in
12111 * different circumstances. The element must have a `value` property (like form elements).
12112 *
12113 * @private
12114 * @param {Object} config Configuration options
12115 * @return {jQuery} Input element
12116 */
12117 OO.ui.InputWidget.prototype.getInputElement = function () {
12118 return $( '<input>' );
12119 };
12120
12121 /**
12122 * Handle potentially value-changing events.
12123 *
12124 * @private
12125 * @param {jQuery.Event} e Key down, mouse up, cut, paste, change, input, or select event
12126 */
12127 OO.ui.InputWidget.prototype.onEdit = function () {
12128 var widget = this;
12129 if ( !this.isDisabled() ) {
12130 // Allow the stack to clear so the value will be updated
12131 setTimeout( function () {
12132 widget.setValue( widget.$input.val() );
12133 } );
12134 }
12135 };
12136
12137 /**
12138 * Get the value of the input.
12139 *
12140 * @return {string} Input value
12141 */
12142 OO.ui.InputWidget.prototype.getValue = function () {
12143 // Resynchronize our internal data with DOM data. Other scripts executing on the page can modify
12144 // it, and we won't know unless they're kind enough to trigger a 'change' event.
12145 var value = this.$input.val();
12146 if ( this.value !== value ) {
12147 this.setValue( value );
12148 }
12149 return this.value;
12150 };
12151
12152 /**
12153 * Set the direction of the input, either RTL (right-to-left) or LTR (left-to-right).
12154 *
12155 * @param {boolean} isRTL
12156 * Direction is right-to-left
12157 */
12158 OO.ui.InputWidget.prototype.setRTL = function ( isRTL ) {
12159 this.$input.prop( 'dir', isRTL ? 'rtl' : 'ltr' );
12160 };
12161
12162 /**
12163 * Set the value of the input.
12164 *
12165 * @param {string} value New value
12166 * @fires change
12167 * @chainable
12168 */
12169 OO.ui.InputWidget.prototype.setValue = function ( value ) {
12170 value = this.cleanUpValue( value );
12171 // Update the DOM if it has changed. Note that with cleanUpValue, it
12172 // is possible for the DOM value to change without this.value changing.
12173 if ( this.$input.val() !== value ) {
12174 this.$input.val( value );
12175 }
12176 if ( this.value !== value ) {
12177 this.value = value;
12178 this.emit( 'change', this.value );
12179 }
12180 return this;
12181 };
12182
12183 /**
12184 * Clean up incoming value.
12185 *
12186 * Ensures value is a string, and converts undefined and null to empty string.
12187 *
12188 * @private
12189 * @param {string} value Original value
12190 * @return {string} Cleaned up value
12191 */
12192 OO.ui.InputWidget.prototype.cleanUpValue = function ( value ) {
12193 if ( value === undefined || value === null ) {
12194 return '';
12195 } else if ( this.inputFilter ) {
12196 return this.inputFilter( String( value ) );
12197 } else {
12198 return String( value );
12199 }
12200 };
12201
12202 /**
12203 * Simulate the behavior of clicking on a label bound to this input. This method is only called by
12204 * {@link OO.ui.LabelWidget LabelWidget} and {@link OO.ui.FieldLayout FieldLayout}. It should not be
12205 * called directly.
12206 */
12207 OO.ui.InputWidget.prototype.simulateLabelClick = function () {
12208 if ( !this.isDisabled() ) {
12209 if ( this.$input.is( ':checkbox, :radio' ) ) {
12210 this.$input.click();
12211 }
12212 if ( this.$input.is( ':input' ) ) {
12213 this.$input[ 0 ].focus();
12214 }
12215 }
12216 };
12217
12218 /**
12219 * @inheritdoc
12220 */
12221 OO.ui.InputWidget.prototype.setDisabled = function ( state ) {
12222 OO.ui.InputWidget.super.prototype.setDisabled.call( this, state );
12223 if ( this.$input ) {
12224 this.$input.prop( 'disabled', this.isDisabled() );
12225 }
12226 return this;
12227 };
12228
12229 /**
12230 * Focus the input.
12231 *
12232 * @chainable
12233 */
12234 OO.ui.InputWidget.prototype.focus = function () {
12235 this.$input[ 0 ].focus();
12236 return this;
12237 };
12238
12239 /**
12240 * Blur the input.
12241 *
12242 * @chainable
12243 */
12244 OO.ui.InputWidget.prototype.blur = function () {
12245 this.$input[ 0 ].blur();
12246 return this;
12247 };
12248
12249 /**
12250 * ButtonInputWidget is used to submit HTML forms and is intended to be used within
12251 * a OO.ui.FormLayout. If you do not need the button to work with HTML forms, you probably
12252 * want to use OO.ui.ButtonWidget instead. Button input widgets can be rendered as either an
12253 * HTML `<button/>` (the default) or an HTML `<input/>` tags. See the
12254 * [OOjs UI documentation on MediaWiki] [1] for more information.
12255 *
12256 * @example
12257 * // A ButtonInputWidget rendered as an HTML button, the default.
12258 * var button = new OO.ui.ButtonInputWidget( {
12259 * label: 'Input button',
12260 * icon: 'check',
12261 * value: 'check'
12262 * } );
12263 * $( 'body' ).append( button.$element );
12264 *
12265 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Inputs#Button_inputs
12266 *
12267 * @class
12268 * @extends OO.ui.InputWidget
12269 * @mixins OO.ui.ButtonElement
12270 * @mixins OO.ui.IconElement
12271 * @mixins OO.ui.IndicatorElement
12272 * @mixins OO.ui.LabelElement
12273 * @mixins OO.ui.TitledElement
12274 *
12275 * @constructor
12276 * @param {Object} [config] Configuration options
12277 * @cfg {string} [type='button'] The value of the HTML `'type'` attribute: 'button', 'submit' or 'reset'.
12278 * @cfg {boolean} [useInputTag=false] Use an `<input/>` tag instead of a `<button/>` tag, the default.
12279 * Widgets configured to be an `<input/>` do not support {@link #icon icons} and {@link #indicator indicators},
12280 * non-plaintext {@link #label labels}, or {@link #value values}. In general, useInputTag should only
12281 * be set to `true` when there’s need to support IE6 in a form with multiple buttons.
12282 */
12283 OO.ui.ButtonInputWidget = function OoUiButtonInputWidget( config ) {
12284 // Configuration initialization
12285 config = $.extend( { type: 'button', useInputTag: false }, config );
12286
12287 // Properties (must be set before parent constructor, which calls #setValue)
12288 this.useInputTag = config.useInputTag;
12289
12290 // Parent constructor
12291 OO.ui.ButtonInputWidget.super.call( this, config );
12292
12293 // Mixin constructors
12294 OO.ui.ButtonElement.call( this, $.extend( {}, config, { $button: this.$input } ) );
12295 OO.ui.IconElement.call( this, config );
12296 OO.ui.IndicatorElement.call( this, config );
12297 OO.ui.LabelElement.call( this, config );
12298 OO.ui.TitledElement.call( this, $.extend( {}, config, { $titled: this.$input } ) );
12299
12300 // Initialization
12301 if ( !config.useInputTag ) {
12302 this.$input.append( this.$icon, this.$label, this.$indicator );
12303 }
12304 this.$element.addClass( 'oo-ui-buttonInputWidget' );
12305 };
12306
12307 /* Setup */
12308
12309 OO.inheritClass( OO.ui.ButtonInputWidget, OO.ui.InputWidget );
12310 OO.mixinClass( OO.ui.ButtonInputWidget, OO.ui.ButtonElement );
12311 OO.mixinClass( OO.ui.ButtonInputWidget, OO.ui.IconElement );
12312 OO.mixinClass( OO.ui.ButtonInputWidget, OO.ui.IndicatorElement );
12313 OO.mixinClass( OO.ui.ButtonInputWidget, OO.ui.LabelElement );
12314 OO.mixinClass( OO.ui.ButtonInputWidget, OO.ui.TitledElement );
12315
12316 /* Methods */
12317
12318 /**
12319 * @inheritdoc
12320 * @private
12321 */
12322 OO.ui.ButtonInputWidget.prototype.getInputElement = function ( config ) {
12323 var html = '<' + ( config.useInputTag ? 'input' : 'button' ) + ' type="' + config.type + '">';
12324 return $( html );
12325 };
12326
12327 /**
12328 * Set label value.
12329 *
12330 * If #useInputTag is `true`, the label is set as the `value` of the `<input/>` tag.
12331 *
12332 * @param {jQuery|string|Function|null} label Label nodes, text, a function that returns nodes or
12333 * text, or `null` for no label
12334 * @chainable
12335 */
12336 OO.ui.ButtonInputWidget.prototype.setLabel = function ( label ) {
12337 OO.ui.LabelElement.prototype.setLabel.call( this, label );
12338
12339 if ( this.useInputTag ) {
12340 if ( typeof label === 'function' ) {
12341 label = OO.ui.resolveMsg( label );
12342 }
12343 if ( label instanceof jQuery ) {
12344 label = label.text();
12345 }
12346 if ( !label ) {
12347 label = '';
12348 }
12349 this.$input.val( label );
12350 }
12351
12352 return this;
12353 };
12354
12355 /**
12356 * Set the value of the input.
12357 *
12358 * This method is disabled for button inputs configured as {@link #useInputTag <input/> tags}, as
12359 * they do not support {@link #value values}.
12360 *
12361 * @param {string} value New value
12362 * @chainable
12363 */
12364 OO.ui.ButtonInputWidget.prototype.setValue = function ( value ) {
12365 if ( !this.useInputTag ) {
12366 OO.ui.ButtonInputWidget.super.prototype.setValue.call( this, value );
12367 }
12368 return this;
12369 };
12370
12371 /**
12372 * CheckboxInputWidgets, like HTML checkboxes, can be selected and/or configured with a value.
12373 * Note that these {@link OO.ui.InputWidget input widgets} are best laid out
12374 * in {@link OO.ui.FieldLayout field layouts} that use the {@link OO.ui.FieldLayout#align inline}
12375 * alignment. For more information, please see the [OOjs UI documentation on MediaWiki][1].
12376 *
12377 * This widget can be used inside a HTML form, such as a OO.ui.FormLayout.
12378 *
12379 * @example
12380 * // An example of selected, unselected, and disabled checkbox inputs
12381 * var checkbox1=new OO.ui.CheckboxInputWidget( {
12382 * value: 'a',
12383 * selected: true
12384 * } );
12385 * var checkbox2=new OO.ui.CheckboxInputWidget( {
12386 * value: 'b'
12387 * } );
12388 * var checkbox3=new OO.ui.CheckboxInputWidget( {
12389 * value:'c',
12390 * disabled: true
12391 * } );
12392 * // Create a fieldset layout with fields for each checkbox.
12393 * var fieldset = new OO.ui.FieldsetLayout( {
12394 * label: 'Checkboxes'
12395 * } );
12396 * fieldset.addItems( [
12397 * new OO.ui.FieldLayout( checkbox1, { label: 'Selected checkbox', align: 'inline' } ),
12398 * new OO.ui.FieldLayout( checkbox2, { label: 'Unselected checkbox', align: 'inline' } ),
12399 * new OO.ui.FieldLayout( checkbox3, { label: 'Disabled checkbox', align: 'inline' } ),
12400 * ] );
12401 * $( 'body' ).append( fieldset.$element );
12402 *
12403 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Inputs
12404 *
12405 * @class
12406 * @extends OO.ui.InputWidget
12407 *
12408 * @constructor
12409 * @param {Object} [config] Configuration options
12410 * @cfg {boolean} [selected=false] Select the checkbox initially. By default, the checkbox is not selected.
12411 */
12412 OO.ui.CheckboxInputWidget = function OoUiCheckboxInputWidget( config ) {
12413 // Configuration initialization
12414 config = config || {};
12415
12416 // Parent constructor
12417 OO.ui.CheckboxInputWidget.super.call( this, config );
12418
12419 // Initialization
12420 this.$element.addClass( 'oo-ui-checkboxInputWidget' );
12421 this.setSelected( config.selected !== undefined ? config.selected : false );
12422 };
12423
12424 /* Setup */
12425
12426 OO.inheritClass( OO.ui.CheckboxInputWidget, OO.ui.InputWidget );
12427
12428 /* Methods */
12429
12430 /**
12431 * @inheritdoc
12432 * @private
12433 */
12434 OO.ui.CheckboxInputWidget.prototype.getInputElement = function () {
12435 return $( '<input type="checkbox" />' );
12436 };
12437
12438 /**
12439 * @inheritdoc
12440 */
12441 OO.ui.CheckboxInputWidget.prototype.onEdit = function () {
12442 var widget = this;
12443 if ( !this.isDisabled() ) {
12444 // Allow the stack to clear so the value will be updated
12445 setTimeout( function () {
12446 widget.setSelected( widget.$input.prop( 'checked' ) );
12447 } );
12448 }
12449 };
12450
12451 /**
12452 * Set selection state of this checkbox.
12453 *
12454 * @param {boolean} state `true` for selected
12455 * @chainable
12456 */
12457 OO.ui.CheckboxInputWidget.prototype.setSelected = function ( state ) {
12458 state = !!state;
12459 if ( this.selected !== state ) {
12460 this.selected = state;
12461 this.$input.prop( 'checked', this.selected );
12462 this.emit( 'change', this.selected );
12463 }
12464 return this;
12465 };
12466
12467 /**
12468 * Check if this checkbox is selected.
12469 *
12470 * @return {boolean} Checkbox is selected
12471 */
12472 OO.ui.CheckboxInputWidget.prototype.isSelected = function () {
12473 // Resynchronize our internal data with DOM data. Other scripts executing on the page can modify
12474 // it, and we won't know unless they're kind enough to trigger a 'change' event.
12475 var selected = this.$input.prop( 'checked' );
12476 if ( this.selected !== selected ) {
12477 this.setSelected( selected );
12478 }
12479 return this.selected;
12480 };
12481
12482 /**
12483 * DropdownInputWidget is a {@link OO.ui.DropdownWidget DropdownWidget} intended to be used
12484 * within a HTML form, such as a OO.ui.FormLayout. The selected value is synchronized with the value
12485 * of a hidden HTML `input` tag. Please see the [OOjs UI documentation on MediaWiki][1] for
12486 * more information about input widgets.
12487 *
12488 * @example
12489 * // Example: A DropdownInputWidget with three options
12490 * var dropDown = new OO.ui.DropdownInputWidget( {
12491 * label: 'Dropdown menu: Select a menu option',
12492 * options: [
12493 * { data: 'a', label: 'First' } ,
12494 * { data: 'b', label: 'Second'} ,
12495 * { data: 'c', label: 'Third' }
12496 * ]
12497 * } );
12498 * $( 'body' ).append( dropDown.$element );
12499 *
12500 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Inputs
12501 *
12502 * @class
12503 * @extends OO.ui.InputWidget
12504 *
12505 * @constructor
12506 * @param {Object} [config] Configuration options
12507 * @cfg {Object[]} [options=[]] Array of menu options in the format `{ data: …, label: … }`
12508 */
12509 OO.ui.DropdownInputWidget = function OoUiDropdownInputWidget( config ) {
12510 // Configuration initialization
12511 config = config || {};
12512
12513 // Properties (must be done before parent constructor which calls #setDisabled)
12514 this.dropdownWidget = new OO.ui.DropdownWidget();
12515
12516 // Parent constructor
12517 OO.ui.DropdownInputWidget.super.call( this, config );
12518
12519 // Events
12520 this.dropdownWidget.getMenu().connect( this, { select: 'onMenuSelect' } );
12521
12522 // Initialization
12523 this.setOptions( config.options || [] );
12524 this.$element
12525 .addClass( 'oo-ui-dropdownInputWidget' )
12526 .append( this.dropdownWidget.$element );
12527 };
12528
12529 /* Setup */
12530
12531 OO.inheritClass( OO.ui.DropdownInputWidget, OO.ui.InputWidget );
12532
12533 /* Methods */
12534
12535 /**
12536 * @inheritdoc
12537 * @private
12538 */
12539 OO.ui.DropdownInputWidget.prototype.getInputElement = function () {
12540 return $( '<input type="hidden">' );
12541 };
12542
12543 /**
12544 * Handles menu select events.
12545 *
12546 * @private
12547 * @param {OO.ui.MenuOptionWidget} item Selected menu item
12548 */
12549 OO.ui.DropdownInputWidget.prototype.onMenuSelect = function ( item ) {
12550 this.setValue( item.getData() );
12551 };
12552
12553 /**
12554 * @inheritdoc
12555 */
12556 OO.ui.DropdownInputWidget.prototype.setValue = function ( value ) {
12557 this.dropdownWidget.getMenu().selectItemByData( value );
12558 OO.ui.DropdownInputWidget.super.prototype.setValue.call( this, value );
12559 return this;
12560 };
12561
12562 /**
12563 * @inheritdoc
12564 */
12565 OO.ui.DropdownInputWidget.prototype.setDisabled = function ( state ) {
12566 this.dropdownWidget.setDisabled( state );
12567 OO.ui.DropdownInputWidget.super.prototype.setDisabled.call( this, state );
12568 return this;
12569 };
12570
12571 /**
12572 * Set the options available for this input.
12573 *
12574 * @param {Object[]} options Array of menu options in the format `{ data: …, label: … }`
12575 * @chainable
12576 */
12577 OO.ui.DropdownInputWidget.prototype.setOptions = function ( options ) {
12578 var value = this.getValue();
12579
12580 // Rebuild the dropdown menu
12581 this.dropdownWidget.getMenu()
12582 .clearItems()
12583 .addItems( options.map( function ( opt ) {
12584 return new OO.ui.MenuOptionWidget( {
12585 data: opt.data,
12586 label: opt.label !== undefined ? opt.label : opt.data
12587 } );
12588 } ) );
12589
12590 // Restore the previous value, or reset to something sensible
12591 if ( this.dropdownWidget.getMenu().getItemFromData( value ) ) {
12592 // Previous value is still available, ensure consistency with the dropdown
12593 this.setValue( value );
12594 } else {
12595 // No longer valid, reset
12596 if ( options.length ) {
12597 this.setValue( options[ 0 ].data );
12598 }
12599 }
12600
12601 return this;
12602 };
12603
12604 /**
12605 * @inheritdoc
12606 */
12607 OO.ui.DropdownInputWidget.prototype.focus = function () {
12608 this.dropdownWidget.getMenu().toggle( true );
12609 return this;
12610 };
12611
12612 /**
12613 * @inheritdoc
12614 */
12615 OO.ui.DropdownInputWidget.prototype.blur = function () {
12616 this.dropdownWidget.getMenu().toggle( false );
12617 return this;
12618 };
12619
12620 /**
12621 * RadioInputWidget creates a single radio button. Because radio buttons are usually used as a set,
12622 * in most cases you will want to use a {@link OO.ui.RadioSelectWidget radio select}
12623 * with {@link OO.ui.RadioOptionWidget radio options} instead of this class. For more information,
12624 * please see the [OOjs UI documentation on MediaWiki][1].
12625 *
12626 * This widget can be used inside a HTML form, such as a OO.ui.FormLayout.
12627 *
12628 * @example
12629 * // An example of selected, unselected, and disabled radio inputs
12630 * var radio1 = new OO.ui.RadioInputWidget( {
12631 * value: 'a',
12632 * selected: true
12633 * } );
12634 * var radio2 = new OO.ui.RadioInputWidget( {
12635 * value: 'b'
12636 * } );
12637 * var radio3 = new OO.ui.RadioInputWidget( {
12638 * value: 'c',
12639 * disabled: true
12640 * } );
12641 * // Create a fieldset layout with fields for each radio button.
12642 * var fieldset = new OO.ui.FieldsetLayout( {
12643 * label: 'Radio inputs'
12644 * } );
12645 * fieldset.addItems( [
12646 * new OO.ui.FieldLayout( radio1, { label: 'Selected', align: 'inline' } ),
12647 * new OO.ui.FieldLayout( radio2, { label: 'Unselected', align: 'inline' } ),
12648 * new OO.ui.FieldLayout( radio3, { label: 'Disabled', align: 'inline' } ),
12649 * ] );
12650 * $( 'body' ).append( fieldset.$element );
12651 *
12652 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Inputs
12653 *
12654 * @class
12655 * @extends OO.ui.InputWidget
12656 *
12657 * @constructor
12658 * @param {Object} [config] Configuration options
12659 * @cfg {boolean} [selected=false] Select the radio button initially. By default, the radio button is not selected.
12660 */
12661 OO.ui.RadioInputWidget = function OoUiRadioInputWidget( config ) {
12662 // Configuration initialization
12663 config = config || {};
12664
12665 // Parent constructor
12666 OO.ui.RadioInputWidget.super.call( this, config );
12667
12668 // Initialization
12669 this.$element.addClass( 'oo-ui-radioInputWidget' );
12670 this.setSelected( config.selected !== undefined ? config.selected : false );
12671 };
12672
12673 /* Setup */
12674
12675 OO.inheritClass( OO.ui.RadioInputWidget, OO.ui.InputWidget );
12676
12677 /* Methods */
12678
12679 /**
12680 * @inheritdoc
12681 * @private
12682 */
12683 OO.ui.RadioInputWidget.prototype.getInputElement = function () {
12684 return $( '<input type="radio" />' );
12685 };
12686
12687 /**
12688 * @inheritdoc
12689 */
12690 OO.ui.RadioInputWidget.prototype.onEdit = function () {
12691 // RadioInputWidget doesn't track its state.
12692 };
12693
12694 /**
12695 * Set selection state of this radio button.
12696 *
12697 * @param {boolean} state `true` for selected
12698 * @chainable
12699 */
12700 OO.ui.RadioInputWidget.prototype.setSelected = function ( state ) {
12701 // RadioInputWidget doesn't track its state.
12702 this.$input.prop( 'checked', state );
12703 return this;
12704 };
12705
12706 /**
12707 * Check if this radio button is selected.
12708 *
12709 * @return {boolean} Radio is selected
12710 */
12711 OO.ui.RadioInputWidget.prototype.isSelected = function () {
12712 return this.$input.prop( 'checked' );
12713 };
12714
12715 /**
12716 * TextInputWidgets, like HTML text inputs, can be configured with options that customize the
12717 * size of the field as well as its presentation. In addition, these widgets can be configured
12718 * with {@link OO.ui.IconElement icons}, {@link OO.ui.IndicatorElement indicators}, an optional
12719 * validation-pattern (used to determine if an input value is valid or not) and an input filter,
12720 * which modifies incoming values rather than validating them.
12721 * Please see the [OOjs UI documentation on MediaWiki] [1] for more information and examples.
12722 *
12723 * This widget can be used inside a HTML form, such as a OO.ui.FormLayout.
12724 *
12725 * @example
12726 * // Example of a text input widget
12727 * var textInput = new OO.ui.TextInputWidget( {
12728 * value: 'Text input'
12729 * } )
12730 * $( 'body' ).append( textInput.$element );
12731 *
12732 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Inputs
12733 *
12734 * @class
12735 * @extends OO.ui.InputWidget
12736 * @mixins OO.ui.IconElement
12737 * @mixins OO.ui.IndicatorElement
12738 * @mixins OO.ui.PendingElement
12739 * @mixins OO.ui.LabelElement
12740 *
12741 * @constructor
12742 * @param {Object} [config] Configuration options
12743 * @cfg {string} [type='text'] The value of the HTML `type` attribute
12744 * @cfg {string} [placeholder] Placeholder text
12745 * @cfg {boolean} [autofocus=false] Use an HTML `autofocus` attribute to
12746 * instruct the browser to focus this widget.
12747 * @cfg {boolean} [readOnly=false] Prevent changes to the value of the text input.
12748 * @cfg {number} [maxLength] Maximum number of characters allowed in the input.
12749 * @cfg {boolean} [multiline=false] Allow multiple lines of text
12750 * @cfg {boolean} [autosize=false] Automatically resize the text input to fit its content.
12751 * Use the #maxRows config to specify a maximum number of displayed rows.
12752 * @cfg {boolean} [maxRows=10] Maximum number of rows to display when #autosize is set to true.
12753 * @cfg {string} [labelPosition='after'] The position of the inline label relative to that of
12754 * the value or placeholder text: `'before'` or `'after'`
12755 * @cfg {boolean} [required=false] Mark the field as required
12756 * @cfg {RegExp|Function|string} [validate] Validation pattern: when string, a symbolic name of a
12757 * pattern defined by the class: 'non-empty' (the value cannot be an empty string) or 'integer'
12758 * (the value must contain only numbers); when RegExp, a regular expression that must match the
12759 * value for it to be considered valid; when Function, a function receiving the value as parameter
12760 * that must return true, or promise resolving to true, for it to be considered valid.
12761 */
12762 OO.ui.TextInputWidget = function OoUiTextInputWidget( config ) {
12763 // Configuration initialization
12764 config = $.extend( {
12765 type: 'text',
12766 labelPosition: 'after',
12767 maxRows: 10
12768 }, config );
12769
12770 // Parent constructor
12771 OO.ui.TextInputWidget.super.call( this, config );
12772
12773 // Mixin constructors
12774 OO.ui.IconElement.call( this, config );
12775 OO.ui.IndicatorElement.call( this, config );
12776 OO.ui.PendingElement.call( this, config );
12777 OO.ui.LabelElement.call( this, config );
12778
12779 // Properties
12780 this.readOnly = false;
12781 this.multiline = !!config.multiline;
12782 this.autosize = !!config.autosize;
12783 this.maxRows = config.maxRows;
12784 this.validate = null;
12785
12786 // Clone for resizing
12787 if ( this.autosize ) {
12788 this.$clone = this.$input
12789 .clone()
12790 .insertAfter( this.$input )
12791 .attr( 'aria-hidden', 'true' )
12792 .addClass( 'oo-ui-element-hidden' );
12793 }
12794
12795 this.setValidation( config.validate );
12796 this.setLabelPosition( config.labelPosition );
12797
12798 // Events
12799 this.$input.on( {
12800 keypress: this.onKeyPress.bind( this ),
12801 blur: this.onBlur.bind( this )
12802 } );
12803 this.$input.one( {
12804 focus: this.onElementAttach.bind( this )
12805 } );
12806 this.$icon.on( 'mousedown', this.onIconMouseDown.bind( this ) );
12807 this.$indicator.on( 'mousedown', this.onIndicatorMouseDown.bind( this ) );
12808 this.on( 'labelChange', this.updatePosition.bind( this ) );
12809 this.connect( this, { change: 'onChange' } );
12810
12811 // Initialization
12812 this.$element
12813 .addClass( 'oo-ui-textInputWidget' )
12814 .append( this.$icon, this.$indicator );
12815 this.setReadOnly( !!config.readOnly );
12816 if ( config.placeholder ) {
12817 this.$input.attr( 'placeholder', config.placeholder );
12818 }
12819 if ( config.maxLength !== undefined ) {
12820 this.$input.attr( 'maxlength', config.maxLength );
12821 }
12822 if ( config.autofocus ) {
12823 this.$input.attr( 'autofocus', 'autofocus' );
12824 }
12825 if ( config.required ) {
12826 this.$input.attr( 'required', 'required' );
12827 this.$input.attr( 'aria-required', 'true' );
12828 }
12829 if ( this.label || config.autosize ) {
12830 this.installParentChangeDetector();
12831 }
12832 };
12833
12834 /* Setup */
12835
12836 OO.inheritClass( OO.ui.TextInputWidget, OO.ui.InputWidget );
12837 OO.mixinClass( OO.ui.TextInputWidget, OO.ui.IconElement );
12838 OO.mixinClass( OO.ui.TextInputWidget, OO.ui.IndicatorElement );
12839 OO.mixinClass( OO.ui.TextInputWidget, OO.ui.PendingElement );
12840 OO.mixinClass( OO.ui.TextInputWidget, OO.ui.LabelElement );
12841
12842 /* Static properties */
12843
12844 OO.ui.TextInputWidget.static.validationPatterns = {
12845 'non-empty': /.+/,
12846 integer: /^\d+$/
12847 };
12848
12849 /* Events */
12850
12851 /**
12852 * An `enter` event is emitted when the user presses 'enter' inside the text box.
12853 *
12854 * Not emitted if the input is multiline.
12855 *
12856 * @event enter
12857 */
12858
12859 /* Methods */
12860
12861 /**
12862 * Handle icon mouse down events.
12863 *
12864 * @private
12865 * @param {jQuery.Event} e Mouse down event
12866 * @fires icon
12867 */
12868 OO.ui.TextInputWidget.prototype.onIconMouseDown = function ( e ) {
12869 if ( e.which === 1 ) {
12870 this.$input[ 0 ].focus();
12871 return false;
12872 }
12873 };
12874
12875 /**
12876 * Handle indicator mouse down events.
12877 *
12878 * @private
12879 * @param {jQuery.Event} e Mouse down event
12880 * @fires indicator
12881 */
12882 OO.ui.TextInputWidget.prototype.onIndicatorMouseDown = function ( e ) {
12883 if ( e.which === 1 ) {
12884 this.$input[ 0 ].focus();
12885 return false;
12886 }
12887 };
12888
12889 /**
12890 * Handle key press events.
12891 *
12892 * @private
12893 * @param {jQuery.Event} e Key press event
12894 * @fires enter If enter key is pressed and input is not multiline
12895 */
12896 OO.ui.TextInputWidget.prototype.onKeyPress = function ( e ) {
12897 if ( e.which === OO.ui.Keys.ENTER && !this.multiline ) {
12898 this.emit( 'enter', e );
12899 }
12900 };
12901
12902 /**
12903 * Handle blur events.
12904 *
12905 * @private
12906 * @param {jQuery.Event} e Blur event
12907 */
12908 OO.ui.TextInputWidget.prototype.onBlur = function () {
12909 this.setValidityFlag();
12910 };
12911
12912 /**
12913 * Handle element attach events.
12914 *
12915 * @private
12916 * @param {jQuery.Event} e Element attach event
12917 */
12918 OO.ui.TextInputWidget.prototype.onElementAttach = function () {
12919 // Any previously calculated size is now probably invalid if we reattached elsewhere
12920 this.valCache = null;
12921 this.adjustSize();
12922 this.positionLabel();
12923 };
12924
12925 /**
12926 * Handle change events.
12927 *
12928 * @param {string} value
12929 * @private
12930 */
12931 OO.ui.TextInputWidget.prototype.onChange = function () {
12932 this.setValidityFlag();
12933 this.adjustSize();
12934 };
12935
12936 /**
12937 * Check if the input is {@link #readOnly read-only}.
12938 *
12939 * @return {boolean}
12940 */
12941 OO.ui.TextInputWidget.prototype.isReadOnly = function () {
12942 return this.readOnly;
12943 };
12944
12945 /**
12946 * Set the {@link #readOnly read-only} state of the input.
12947 *
12948 * @param {boolean} state Make input read-only
12949 * @chainable
12950 */
12951 OO.ui.TextInputWidget.prototype.setReadOnly = function ( state ) {
12952 this.readOnly = !!state;
12953 this.$input.prop( 'readOnly', this.readOnly );
12954 return this;
12955 };
12956
12957 /**
12958 * Support function for making #onElementAttach work across browsers.
12959 *
12960 * This whole function could be replaced with one line of code using the DOMNodeInsertedIntoDocument
12961 * event, but it's not supported by Firefox and allegedly deprecated, so we only use it as fallback.
12962 *
12963 * Due to MutationObserver performance woes, #onElementAttach is only somewhat reliably called the
12964 * first time that the element gets attached to the documented.
12965 */
12966 OO.ui.TextInputWidget.prototype.installParentChangeDetector = function () {
12967 var mutationObserver, onRemove, topmostNode, fakeParentNode,
12968 MutationObserver = window.MutationObserver || window.WebKitMutationObserver || window.MozMutationObserver,
12969 widget = this;
12970
12971 if ( MutationObserver ) {
12972 // The new way. If only it wasn't so ugly.
12973
12974 if ( this.$element.closest( 'html' ).length ) {
12975 // Widget is attached already, do nothing. This breaks the functionality of this function when
12976 // the widget is detached and reattached. Alas, doing this correctly with MutationObserver
12977 // would require observation of the whole document, which would hurt performance of other,
12978 // more important code.
12979 return;
12980 }
12981
12982 // Find topmost node in the tree
12983 topmostNode = this.$element[0];
12984 while ( topmostNode.parentNode ) {
12985 topmostNode = topmostNode.parentNode;
12986 }
12987
12988 // We have no way to detect the $element being attached somewhere without observing the entire
12989 // DOM with subtree modifications, which would hurt performance. So we cheat: we hook to the
12990 // parent node of $element, and instead detect when $element is removed from it (and thus
12991 // probably attached somewhere else). If there is no parent, we create a "fake" one. If it
12992 // doesn't get attached, we end up back here and create the parent.
12993
12994 mutationObserver = new MutationObserver( function ( mutations ) {
12995 var i, j, removedNodes;
12996 for ( i = 0; i < mutations.length; i++ ) {
12997 removedNodes = mutations[ i ].removedNodes;
12998 for ( j = 0; j < removedNodes.length; j++ ) {
12999 if ( removedNodes[ j ] === topmostNode ) {
13000 setTimeout( onRemove, 0 );
13001 return;
13002 }
13003 }
13004 }
13005 } );
13006
13007 onRemove = function () {
13008 // If the node was attached somewhere else, report it
13009 if ( widget.$element.closest( 'html' ).length ) {
13010 widget.onElementAttach();
13011 }
13012 mutationObserver.disconnect();
13013 widget.installParentChangeDetector();
13014 };
13015
13016 // Create a fake parent and observe it
13017 fakeParentNode = $( '<div>' ).append( this.$element )[0];
13018 mutationObserver.observe( fakeParentNode, { childList: true } );
13019 } else {
13020 // Using the DOMNodeInsertedIntoDocument event is much nicer and less magical, and works for
13021 // detachment and reattachment, but it's not supported by Firefox and allegedly deprecated.
13022 this.$element.on( 'DOMNodeInsertedIntoDocument', this.onElementAttach.bind( this ) );
13023 }
13024 };
13025
13026 /**
13027 * Automatically adjust the size of the text input.
13028 *
13029 * This only affects #multiline inputs that are {@link #autosize autosized}.
13030 *
13031 * @chainable
13032 */
13033 OO.ui.TextInputWidget.prototype.adjustSize = function () {
13034 var scrollHeight, innerHeight, outerHeight, maxInnerHeight, measurementError, idealHeight;
13035
13036 if ( this.multiline && this.autosize && this.$input.val() !== this.valCache ) {
13037 this.$clone
13038 .val( this.$input.val() )
13039 .attr( 'rows', '' )
13040 // Set inline height property to 0 to measure scroll height
13041 .css( 'height', 0 );
13042
13043 this.$clone.removeClass( 'oo-ui-element-hidden' );
13044
13045 this.valCache = this.$input.val();
13046
13047 scrollHeight = this.$clone[ 0 ].scrollHeight;
13048
13049 // Remove inline height property to measure natural heights
13050 this.$clone.css( 'height', '' );
13051 innerHeight = this.$clone.innerHeight();
13052 outerHeight = this.$clone.outerHeight();
13053
13054 // Measure max rows height
13055 this.$clone
13056 .attr( 'rows', this.maxRows )
13057 .css( 'height', 'auto' )
13058 .val( '' );
13059 maxInnerHeight = this.$clone.innerHeight();
13060
13061 // Difference between reported innerHeight and scrollHeight with no scrollbars present
13062 // Equals 1 on Blink-based browsers and 0 everywhere else
13063 measurementError = maxInnerHeight - this.$clone[ 0 ].scrollHeight;
13064 idealHeight = Math.min( maxInnerHeight, scrollHeight + measurementError );
13065
13066 this.$clone.addClass( 'oo-ui-element-hidden' );
13067
13068 // Only apply inline height when expansion beyond natural height is needed
13069 if ( idealHeight > innerHeight ) {
13070 // Use the difference between the inner and outer height as a buffer
13071 this.$input.css( 'height', idealHeight + ( outerHeight - innerHeight ) );
13072 } else {
13073 this.$input.css( 'height', '' );
13074 }
13075 }
13076 return this;
13077 };
13078
13079 /**
13080 * @inheritdoc
13081 * @private
13082 */
13083 OO.ui.TextInputWidget.prototype.getInputElement = function ( config ) {
13084 return config.multiline ? $( '<textarea>' ) : $( '<input type="' + config.type + '" />' );
13085 };
13086
13087 /**
13088 * Check if the input supports multiple lines.
13089 *
13090 * @return {boolean}
13091 */
13092 OO.ui.TextInputWidget.prototype.isMultiline = function () {
13093 return !!this.multiline;
13094 };
13095
13096 /**
13097 * Check if the input automatically adjusts its size.
13098 *
13099 * @return {boolean}
13100 */
13101 OO.ui.TextInputWidget.prototype.isAutosizing = function () {
13102 return !!this.autosize;
13103 };
13104
13105 /**
13106 * Select the entire text of the input.
13107 *
13108 * @chainable
13109 */
13110 OO.ui.TextInputWidget.prototype.select = function () {
13111 this.$input.select();
13112 return this;
13113 };
13114
13115 /**
13116 * Set the validation pattern.
13117 *
13118 * The validation pattern is either a regular expression, a function, or the symbolic name of a
13119 * pattern defined by the class: 'non-empty' (the value cannot be an empty string) or 'integer' (the
13120 * value must contain only numbers).
13121 *
13122 * @param {RegExp|Function|string|null} validate Regular expression, function, or the symbolic name
13123 * of a pattern (either ‘integer’ or ‘non-empty’) defined by the class.
13124 */
13125 OO.ui.TextInputWidget.prototype.setValidation = function ( validate ) {
13126 if ( validate instanceof RegExp || validate instanceof Function ) {
13127 this.validate = validate;
13128 } else {
13129 this.validate = this.constructor.static.validationPatterns[ validate ] || /.*/;
13130 }
13131 };
13132
13133 /**
13134 * Sets the 'invalid' flag appropriately.
13135 *
13136 * @param {boolean} [isValid] Optionally override validation result
13137 */
13138 OO.ui.TextInputWidget.prototype.setValidityFlag = function ( isValid ) {
13139 var widget = this,
13140 setFlag = function ( valid ) {
13141 if ( !valid ) {
13142 widget.$input.attr( 'aria-invalid', 'true' );
13143 } else {
13144 widget.$input.removeAttr( 'aria-invalid' );
13145 }
13146 widget.setFlags( { invalid: !valid } );
13147 };
13148
13149 if ( isValid !== undefined ) {
13150 setFlag( isValid );
13151 } else {
13152 this.isValid().done( setFlag );
13153 }
13154 };
13155
13156 /**
13157 * Check if a value is valid.
13158 *
13159 * This method returns a promise that resolves with a boolean `true` if the current value is
13160 * considered valid according to the supplied {@link #validate validation pattern}.
13161 *
13162 * @return {jQuery.Promise} A promise that resolves to a boolean `true` if the value is valid.
13163 */
13164 OO.ui.TextInputWidget.prototype.isValid = function () {
13165 if ( this.validate instanceof Function ) {
13166 var result = this.validate( this.getValue() );
13167 if ( $.isFunction( result.promise ) ) {
13168 return result.promise();
13169 } else {
13170 return $.Deferred().resolve( !!result ).promise();
13171 }
13172 } else {
13173 return $.Deferred().resolve( !!this.getValue().match( this.validate ) ).promise();
13174 }
13175 };
13176
13177 /**
13178 * Set the position of the inline label relative to that of the value: `‘before’` or `‘after’`.
13179 *
13180 * @param {string} labelPosition Label position, 'before' or 'after'
13181 * @chainable
13182 */
13183 OO.ui.TextInputWidget.prototype.setLabelPosition = function ( labelPosition ) {
13184 this.labelPosition = labelPosition;
13185 this.updatePosition();
13186 return this;
13187 };
13188
13189 /**
13190 * Deprecated alias of #setLabelPosition
13191 *
13192 * @deprecated Use setLabelPosition instead.
13193 */
13194 OO.ui.TextInputWidget.prototype.setPosition =
13195 OO.ui.TextInputWidget.prototype.setLabelPosition;
13196
13197 /**
13198 * Update the position of the inline label.
13199 *
13200 * This method is called by #setLabelPosition, and can also be called on its own if
13201 * something causes the label to be mispositioned.
13202 *
13203 *
13204 * @chainable
13205 */
13206 OO.ui.TextInputWidget.prototype.updatePosition = function () {
13207 var after = this.labelPosition === 'after';
13208
13209 this.$element
13210 .toggleClass( 'oo-ui-textInputWidget-labelPosition-after', !!this.label && after )
13211 .toggleClass( 'oo-ui-textInputWidget-labelPosition-before', !!this.label && !after );
13212
13213 if ( this.label ) {
13214 this.positionLabel();
13215 }
13216
13217 return this;
13218 };
13219
13220 /**
13221 * Position the label by setting the correct padding on the input.
13222 *
13223 * @private
13224 * @chainable
13225 */
13226 OO.ui.TextInputWidget.prototype.positionLabel = function () {
13227 // Clear old values
13228 this.$input
13229 // Clear old values if present
13230 .css( {
13231 'padding-right': '',
13232 'padding-left': ''
13233 } );
13234
13235 if ( this.label ) {
13236 this.$element.append( this.$label );
13237 } else {
13238 this.$label.detach();
13239 return;
13240 }
13241
13242 var after = this.labelPosition === 'after',
13243 rtl = this.$element.css( 'direction' ) === 'rtl',
13244 property = after === rtl ? 'padding-left' : 'padding-right';
13245
13246 this.$input.css( property, this.$label.outerWidth( true ) );
13247
13248 return this;
13249 };
13250
13251 /**
13252 * ComboBoxWidgets combine a {@link OO.ui.TextInputWidget text input} (where a value
13253 * can be entered manually) and a {@link OO.ui.MenuSelectWidget menu of options} (from which
13254 * a value can be chosen instead). Users can choose options from the combo box in one of two ways:
13255 *
13256 * - by typing a value in the text input field. If the value exactly matches the value of a menu
13257 * option, that option will appear to be selected.
13258 * - by choosing a value from the menu. The value of the chosen option will then appear in the text
13259 * input field.
13260 *
13261 * For more information about menus and options, please see the [OOjs UI documentation on MediaWiki][1].
13262 *
13263 * @example
13264 * // Example: A ComboBoxWidget.
13265 * var comboBox = new OO.ui.ComboBoxWidget( {
13266 * label: 'ComboBoxWidget',
13267 * input: { value: 'Option One' },
13268 * menu: {
13269 * items: [
13270 * new OO.ui.MenuOptionWidget( {
13271 * data: 'Option 1',
13272 * label: 'Option One'
13273 * } ),
13274 * new OO.ui.MenuOptionWidget( {
13275 * data: 'Option 2',
13276 * label: 'Option Two'
13277 * } ),
13278 * new OO.ui.MenuOptionWidget( {
13279 * data: 'Option 3',
13280 * label: 'Option Three'
13281 * } ),
13282 * new OO.ui.MenuOptionWidget( {
13283 * data: 'Option 4',
13284 * label: 'Option Four'
13285 * } ),
13286 * new OO.ui.MenuOptionWidget( {
13287 * data: 'Option 5',
13288 * label: 'Option Five'
13289 * } )
13290 * ]
13291 * }
13292 * } );
13293 * $( 'body' ).append( comboBox.$element );
13294 *
13295 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options#Menu_selects_and_options
13296 *
13297 * @class
13298 * @extends OO.ui.Widget
13299 * @mixins OO.ui.TabIndexedElement
13300 *
13301 * @constructor
13302 * @param {Object} [config] Configuration options
13303 * @cfg {Object} [menu] Configuration options to pass to the {@link OO.ui.MenuSelectWidget menu select widget}.
13304 * @cfg {Object} [input] Configuration options to pass to the {@link OO.ui.TextInputWidget text input widget}.
13305 * @cfg {jQuery} [$overlay] Render the menu into a separate layer. This configuration is useful in cases where
13306 * the expanded menu is larger than its containing `<div>`. The specified overlay layer is usually on top of the
13307 * containing `<div>` and has a larger area. By default, the menu uses relative positioning.
13308 */
13309 OO.ui.ComboBoxWidget = function OoUiComboBoxWidget( config ) {
13310 // Configuration initialization
13311 config = config || {};
13312
13313 // Parent constructor
13314 OO.ui.ComboBoxWidget.super.call( this, config );
13315
13316 // Properties (must be set before TabIndexedElement constructor call)
13317 this.$indicator = this.$( '<span>' );
13318
13319 // Mixin constructors
13320 OO.ui.TabIndexedElement.call( this, $.extend( {}, config, { $tabIndexed: this.$indicator } ) );
13321
13322 // Properties
13323 this.$overlay = config.$overlay || this.$element;
13324 this.input = new OO.ui.TextInputWidget( $.extend(
13325 {
13326 indicator: 'down',
13327 $indicator: this.$indicator,
13328 disabled: this.isDisabled()
13329 },
13330 config.input
13331 ) );
13332 this.input.$input.eq( 0 ).attr( {
13333 role: 'combobox',
13334 'aria-autocomplete': 'list'
13335 } );
13336 this.menu = new OO.ui.TextInputMenuSelectWidget( this.input, $.extend(
13337 {
13338 widget: this,
13339 input: this.input,
13340 disabled: this.isDisabled()
13341 },
13342 config.menu
13343 ) );
13344
13345 // Events
13346 this.$indicator.on( {
13347 click: this.onClick.bind( this ),
13348 keypress: this.onKeyPress.bind( this )
13349 } );
13350 this.input.connect( this, {
13351 change: 'onInputChange',
13352 enter: 'onInputEnter'
13353 } );
13354 this.menu.connect( this, {
13355 choose: 'onMenuChoose',
13356 add: 'onMenuItemsChange',
13357 remove: 'onMenuItemsChange'
13358 } );
13359
13360 // Initialization
13361 this.$element.addClass( 'oo-ui-comboBoxWidget' ).append( this.input.$element );
13362 this.$overlay.append( this.menu.$element );
13363 this.onMenuItemsChange();
13364 };
13365
13366 /* Setup */
13367
13368 OO.inheritClass( OO.ui.ComboBoxWidget, OO.ui.Widget );
13369 OO.mixinClass( OO.ui.ComboBoxWidget, OO.ui.TabIndexedElement );
13370
13371 /* Methods */
13372
13373 /**
13374 * Get the combobox's menu.
13375 * @return {OO.ui.TextInputMenuSelectWidget} Menu widget
13376 */
13377 OO.ui.ComboBoxWidget.prototype.getMenu = function () {
13378 return this.menu;
13379 };
13380
13381 /**
13382 * Handle input change events.
13383 *
13384 * @private
13385 * @param {string} value New value
13386 */
13387 OO.ui.ComboBoxWidget.prototype.onInputChange = function ( value ) {
13388 var match = this.menu.getItemFromData( value );
13389
13390 this.menu.selectItem( match );
13391 if ( this.menu.getHighlightedItem() ) {
13392 this.menu.highlightItem( match );
13393 }
13394
13395 if ( !this.isDisabled() ) {
13396 this.menu.toggle( true );
13397 }
13398 };
13399
13400 /**
13401 * Handle mouse click events.
13402 *
13403 *
13404 * @private
13405 * @param {jQuery.Event} e Mouse click event
13406 */
13407 OO.ui.ComboBoxWidget.prototype.onClick = function ( e ) {
13408 if ( !this.isDisabled() && e.which === 1 ) {
13409 this.menu.toggle();
13410 this.input.$input[ 0 ].focus();
13411 }
13412 return false;
13413 };
13414
13415 /**
13416 * Handle key press events.
13417 *
13418 *
13419 * @private
13420 * @param {jQuery.Event} e Key press event
13421 */
13422 OO.ui.ComboBoxWidget.prototype.onKeyPress = function ( e ) {
13423 if ( !this.isDisabled() && ( e.which === OO.ui.Keys.SPACE || e.which === OO.ui.Keys.ENTER ) ) {
13424 this.menu.toggle();
13425 this.input.$input[ 0 ].focus();
13426 return false;
13427 }
13428 };
13429
13430 /**
13431 * Handle input enter events.
13432 *
13433 * @private
13434 */
13435 OO.ui.ComboBoxWidget.prototype.onInputEnter = function () {
13436 if ( !this.isDisabled() ) {
13437 this.menu.toggle( false );
13438 }
13439 };
13440
13441 /**
13442 * Handle menu choose events.
13443 *
13444 * @private
13445 * @param {OO.ui.OptionWidget} item Chosen item
13446 */
13447 OO.ui.ComboBoxWidget.prototype.onMenuChoose = function ( item ) {
13448 this.input.setValue( item.getData() );
13449 };
13450
13451 /**
13452 * Handle menu item change events.
13453 *
13454 * @private
13455 */
13456 OO.ui.ComboBoxWidget.prototype.onMenuItemsChange = function () {
13457 var match = this.menu.getItemFromData( this.input.getValue() );
13458 this.menu.selectItem( match );
13459 if ( this.menu.getHighlightedItem() ) {
13460 this.menu.highlightItem( match );
13461 }
13462 this.$element.toggleClass( 'oo-ui-comboBoxWidget-empty', this.menu.isEmpty() );
13463 };
13464
13465 /**
13466 * @inheritdoc
13467 */
13468 OO.ui.ComboBoxWidget.prototype.setDisabled = function ( disabled ) {
13469 // Parent method
13470 OO.ui.ComboBoxWidget.super.prototype.setDisabled.call( this, disabled );
13471
13472 if ( this.input ) {
13473 this.input.setDisabled( this.isDisabled() );
13474 }
13475 if ( this.menu ) {
13476 this.menu.setDisabled( this.isDisabled() );
13477 }
13478
13479 return this;
13480 };
13481
13482 /**
13483 * LabelWidgets help identify the function of interface elements. Each LabelWidget can
13484 * be configured with a `label` option that is set to a string, a label node, or a function:
13485 *
13486 * - String: a plaintext string
13487 * - jQuery selection: a jQuery selection, used for anything other than a plaintext label, e.g., a
13488 * label that includes a link or special styling, such as a gray color or additional graphical elements.
13489 * - Function: a function that will produce a string in the future. Functions are used
13490 * in cases where the value of the label is not currently defined.
13491 *
13492 * In addition, the LabelWidget can be associated with an {@link OO.ui.InputWidget input widget}, which
13493 * will come into focus when the label is clicked.
13494 *
13495 * @example
13496 * // Examples of LabelWidgets
13497 * var label1 = new OO.ui.LabelWidget( {
13498 * label: 'plaintext label'
13499 * } );
13500 * var label2 = new OO.ui.LabelWidget( {
13501 * label: $( '<a href="default.html">jQuery label</a>' )
13502 * } );
13503 * // Create a fieldset layout with fields for each example
13504 * var fieldset = new OO.ui.FieldsetLayout();
13505 * fieldset.addItems( [
13506 * new OO.ui.FieldLayout( label1 ),
13507 * new OO.ui.FieldLayout( label2 )
13508 * ] );
13509 * $( 'body' ).append( fieldset.$element );
13510 *
13511 *
13512 * @class
13513 * @extends OO.ui.Widget
13514 * @mixins OO.ui.LabelElement
13515 *
13516 * @constructor
13517 * @param {Object} [config] Configuration options
13518 * @cfg {OO.ui.InputWidget} [input] {@link OO.ui.InputWidget Input widget} that uses the label.
13519 * Clicking the label will focus the specified input field.
13520 */
13521 OO.ui.LabelWidget = function OoUiLabelWidget( config ) {
13522 // Configuration initialization
13523 config = config || {};
13524
13525 // Parent constructor
13526 OO.ui.LabelWidget.super.call( this, config );
13527
13528 // Mixin constructors
13529 OO.ui.LabelElement.call( this, $.extend( {}, config, { $label: this.$element } ) );
13530 OO.ui.TitledElement.call( this, config );
13531
13532 // Properties
13533 this.input = config.input;
13534
13535 // Events
13536 if ( this.input instanceof OO.ui.InputWidget ) {
13537 this.$element.on( 'click', this.onClick.bind( this ) );
13538 }
13539
13540 // Initialization
13541 this.$element.addClass( 'oo-ui-labelWidget' );
13542 };
13543
13544 /* Setup */
13545
13546 OO.inheritClass( OO.ui.LabelWidget, OO.ui.Widget );
13547 OO.mixinClass( OO.ui.LabelWidget, OO.ui.LabelElement );
13548 OO.mixinClass( OO.ui.LabelWidget, OO.ui.TitledElement );
13549
13550 /* Static Properties */
13551
13552 OO.ui.LabelWidget.static.tagName = 'span';
13553
13554 /* Methods */
13555
13556 /**
13557 * Handles label mouse click events.
13558 *
13559 * @private
13560 * @param {jQuery.Event} e Mouse click event
13561 */
13562 OO.ui.LabelWidget.prototype.onClick = function () {
13563 this.input.simulateLabelClick();
13564 return false;
13565 };
13566
13567 /**
13568 * OptionWidgets are special elements that can be selected and configured with data. The
13569 * data is often unique for each option, but it does not have to be. OptionWidgets are used
13570 * with OO.ui.SelectWidget to create a selection of mutually exclusive options. For more information
13571 * and examples, please see the [OOjs UI documentation on MediaWiki][1].
13572 *
13573 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options
13574 *
13575 * @class
13576 * @extends OO.ui.Widget
13577 * @mixins OO.ui.LabelElement
13578 * @mixins OO.ui.FlaggedElement
13579 *
13580 * @constructor
13581 * @param {Object} [config] Configuration options
13582 */
13583 OO.ui.OptionWidget = function OoUiOptionWidget( config ) {
13584 // Configuration initialization
13585 config = config || {};
13586
13587 // Parent constructor
13588 OO.ui.OptionWidget.super.call( this, config );
13589
13590 // Mixin constructors
13591 OO.ui.ItemWidget.call( this );
13592 OO.ui.LabelElement.call( this, config );
13593 OO.ui.FlaggedElement.call( this, config );
13594
13595 // Properties
13596 this.selected = false;
13597 this.highlighted = false;
13598 this.pressed = false;
13599
13600 // Initialization
13601 this.$element
13602 .data( 'oo-ui-optionWidget', this )
13603 .attr( 'role', 'option' )
13604 .addClass( 'oo-ui-optionWidget' )
13605 .append( this.$label );
13606 };
13607
13608 /* Setup */
13609
13610 OO.inheritClass( OO.ui.OptionWidget, OO.ui.Widget );
13611 OO.mixinClass( OO.ui.OptionWidget, OO.ui.ItemWidget );
13612 OO.mixinClass( OO.ui.OptionWidget, OO.ui.LabelElement );
13613 OO.mixinClass( OO.ui.OptionWidget, OO.ui.FlaggedElement );
13614
13615 /* Static Properties */
13616
13617 OO.ui.OptionWidget.static.selectable = true;
13618
13619 OO.ui.OptionWidget.static.highlightable = true;
13620
13621 OO.ui.OptionWidget.static.pressable = true;
13622
13623 OO.ui.OptionWidget.static.scrollIntoViewOnSelect = false;
13624
13625 /* Methods */
13626
13627 /**
13628 * Check if the option can be selected.
13629 *
13630 * @return {boolean} Item is selectable
13631 */
13632 OO.ui.OptionWidget.prototype.isSelectable = function () {
13633 return this.constructor.static.selectable && !this.isDisabled();
13634 };
13635
13636 /**
13637 * Check if the option can be highlighted. A highlight indicates that the option
13638 * may be selected when a user presses enter or clicks. Disabled items cannot
13639 * be highlighted.
13640 *
13641 * @return {boolean} Item is highlightable
13642 */
13643 OO.ui.OptionWidget.prototype.isHighlightable = function () {
13644 return this.constructor.static.highlightable && !this.isDisabled();
13645 };
13646
13647 /**
13648 * Check if the option can be pressed. The pressed state occurs when a user mouses
13649 * down on an item, but has not yet let go of the mouse.
13650 *
13651 * @return {boolean} Item is pressable
13652 */
13653 OO.ui.OptionWidget.prototype.isPressable = function () {
13654 return this.constructor.static.pressable && !this.isDisabled();
13655 };
13656
13657 /**
13658 * Check if the option is selected.
13659 *
13660 * @return {boolean} Item is selected
13661 */
13662 OO.ui.OptionWidget.prototype.isSelected = function () {
13663 return this.selected;
13664 };
13665
13666 /**
13667 * Check if the option is highlighted. A highlight indicates that the
13668 * item may be selected when a user presses enter or clicks.
13669 *
13670 * @return {boolean} Item is highlighted
13671 */
13672 OO.ui.OptionWidget.prototype.isHighlighted = function () {
13673 return this.highlighted;
13674 };
13675
13676 /**
13677 * Check if the option is pressed. The pressed state occurs when a user mouses
13678 * down on an item, but has not yet let go of the mouse. The item may appear
13679 * selected, but it will not be selected until the user releases the mouse.
13680 *
13681 * @return {boolean} Item is pressed
13682 */
13683 OO.ui.OptionWidget.prototype.isPressed = function () {
13684 return this.pressed;
13685 };
13686
13687 /**
13688 * Set the option’s selected state. In general, all modifications to the selection
13689 * should be handled by the SelectWidget’s {@link OO.ui.SelectWidget#selectItem selectItem( [item] )}
13690 * method instead of this method.
13691 *
13692 * @param {boolean} [state=false] Select option
13693 * @chainable
13694 */
13695 OO.ui.OptionWidget.prototype.setSelected = function ( state ) {
13696 if ( this.constructor.static.selectable ) {
13697 this.selected = !!state;
13698 this.$element
13699 .toggleClass( 'oo-ui-optionWidget-selected', state )
13700 .attr( 'aria-selected', state.toString() );
13701 if ( state && this.constructor.static.scrollIntoViewOnSelect ) {
13702 this.scrollElementIntoView();
13703 }
13704 this.updateThemeClasses();
13705 }
13706 return this;
13707 };
13708
13709 /**
13710 * Set the option’s highlighted state. In general, all programmatic
13711 * modifications to the highlight should be handled by the
13712 * SelectWidget’s {@link OO.ui.SelectWidget#highlightItem highlightItem( [item] )}
13713 * method instead of this method.
13714 *
13715 * @param {boolean} [state=false] Highlight option
13716 * @chainable
13717 */
13718 OO.ui.OptionWidget.prototype.setHighlighted = function ( state ) {
13719 if ( this.constructor.static.highlightable ) {
13720 this.highlighted = !!state;
13721 this.$element.toggleClass( 'oo-ui-optionWidget-highlighted', state );
13722 this.updateThemeClasses();
13723 }
13724 return this;
13725 };
13726
13727 /**
13728 * Set the option’s pressed state. In general, all
13729 * programmatic modifications to the pressed state should be handled by the
13730 * SelectWidget’s {@link OO.ui.SelectWidget#pressItem pressItem( [item] )}
13731 * method instead of this method.
13732 *
13733 * @param {boolean} [state=false] Press option
13734 * @chainable
13735 */
13736 OO.ui.OptionWidget.prototype.setPressed = function ( state ) {
13737 if ( this.constructor.static.pressable ) {
13738 this.pressed = !!state;
13739 this.$element.toggleClass( 'oo-ui-optionWidget-pressed', state );
13740 this.updateThemeClasses();
13741 }
13742 return this;
13743 };
13744
13745 /**
13746 * DecoratedOptionWidgets are {@link OO.ui.OptionWidget options} that can be configured
13747 * with an {@link OO.ui.IconElement icon} and/or {@link OO.ui.IndicatorElement indicator}.
13748 * This class is used with OO.ui.SelectWidget to create a selection of mutually exclusive
13749 * options. For more information about options and selects, please see the
13750 * [OOjs UI documentation on MediaWiki][1].
13751 *
13752 * @example
13753 * // Decorated options in a select widget
13754 * var select = new OO.ui.SelectWidget( {
13755 * items: [
13756 * new OO.ui.DecoratedOptionWidget( {
13757 * data: 'a',
13758 * label: 'Option with icon',
13759 * icon: 'help'
13760 * } ),
13761 * new OO.ui.DecoratedOptionWidget( {
13762 * data: 'b',
13763 * label: 'Option with indicator',
13764 * indicator: 'next'
13765 * } )
13766 * ]
13767 * } );
13768 * $( 'body' ).append( select.$element );
13769 *
13770 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options
13771 *
13772 * @class
13773 * @extends OO.ui.OptionWidget
13774 * @mixins OO.ui.IconElement
13775 * @mixins OO.ui.IndicatorElement
13776 *
13777 * @constructor
13778 * @param {Object} [config] Configuration options
13779 */
13780 OO.ui.DecoratedOptionWidget = function OoUiDecoratedOptionWidget( config ) {
13781 // Parent constructor
13782 OO.ui.DecoratedOptionWidget.super.call( this, config );
13783
13784 // Mixin constructors
13785 OO.ui.IconElement.call( this, config );
13786 OO.ui.IndicatorElement.call( this, config );
13787
13788 // Initialization
13789 this.$element
13790 .addClass( 'oo-ui-decoratedOptionWidget' )
13791 .prepend( this.$icon )
13792 .append( this.$indicator );
13793 };
13794
13795 /* Setup */
13796
13797 OO.inheritClass( OO.ui.DecoratedOptionWidget, OO.ui.OptionWidget );
13798 OO.mixinClass( OO.ui.OptionWidget, OO.ui.IconElement );
13799 OO.mixinClass( OO.ui.OptionWidget, OO.ui.IndicatorElement );
13800
13801 /**
13802 * ButtonOptionWidget is a special type of {@link OO.ui.ButtonElement button element} that
13803 * can be selected and configured with data. The class is
13804 * used with OO.ui.ButtonSelectWidget to create a selection of button options. Please see the
13805 * [OOjs UI documentation on MediaWiki] [1] for more information.
13806 *
13807 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options#Button_selects_and_options
13808 *
13809 * @class
13810 * @extends OO.ui.DecoratedOptionWidget
13811 * @mixins OO.ui.ButtonElement
13812 * @mixins OO.ui.TabIndexedElement
13813 *
13814 * @constructor
13815 * @param {Object} [config] Configuration options
13816 */
13817 OO.ui.ButtonOptionWidget = function OoUiButtonOptionWidget( config ) {
13818 // Configuration initialization
13819 config = $.extend( { tabIndex: -1 }, config );
13820
13821 // Parent constructor
13822 OO.ui.ButtonOptionWidget.super.call( this, config );
13823
13824 // Mixin constructors
13825 OO.ui.ButtonElement.call( this, config );
13826 OO.ui.TabIndexedElement.call( this, $.extend( {}, config, { $tabIndexed: this.$button } ) );
13827
13828 // Initialization
13829 this.$element.addClass( 'oo-ui-buttonOptionWidget' );
13830 this.$button.append( this.$element.contents() );
13831 this.$element.append( this.$button );
13832 };
13833
13834 /* Setup */
13835
13836 OO.inheritClass( OO.ui.ButtonOptionWidget, OO.ui.DecoratedOptionWidget );
13837 OO.mixinClass( OO.ui.ButtonOptionWidget, OO.ui.ButtonElement );
13838 OO.mixinClass( OO.ui.ButtonOptionWidget, OO.ui.TabIndexedElement );
13839
13840 /* Static Properties */
13841
13842 // Allow button mouse down events to pass through so they can be handled by the parent select widget
13843 OO.ui.ButtonOptionWidget.static.cancelButtonMouseDownEvents = false;
13844
13845 OO.ui.ButtonOptionWidget.static.highlightable = false;
13846
13847 /* Methods */
13848
13849 /**
13850 * @inheritdoc
13851 */
13852 OO.ui.ButtonOptionWidget.prototype.setSelected = function ( state ) {
13853 OO.ui.ButtonOptionWidget.super.prototype.setSelected.call( this, state );
13854
13855 if ( this.constructor.static.selectable ) {
13856 this.setActive( state );
13857 }
13858
13859 return this;
13860 };
13861
13862 /**
13863 * RadioOptionWidget is an option widget that looks like a radio button.
13864 * The class is used with OO.ui.RadioSelectWidget to create a selection of radio options.
13865 * Please see the [OOjs UI documentation on MediaWiki] [1] for more information.
13866 *
13867 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options#Button_selects_and_option
13868 *
13869 * @class
13870 * @extends OO.ui.OptionWidget
13871 *
13872 * @constructor
13873 * @param {Object} [config] Configuration options
13874 */
13875 OO.ui.RadioOptionWidget = function OoUiRadioOptionWidget( config ) {
13876 // Configuration initialization
13877 config = config || {};
13878
13879 // Properties (must be done before parent constructor which calls #setDisabled)
13880 this.radio = new OO.ui.RadioInputWidget( { value: config.data, tabIndex: -1 } );
13881
13882 // Parent constructor
13883 OO.ui.RadioOptionWidget.super.call( this, config );
13884
13885 // Initialization
13886 this.$element
13887 .addClass( 'oo-ui-radioOptionWidget' )
13888 .prepend( this.radio.$element );
13889 };
13890
13891 /* Setup */
13892
13893 OO.inheritClass( OO.ui.RadioOptionWidget, OO.ui.OptionWidget );
13894
13895 /* Static Properties */
13896
13897 OO.ui.RadioOptionWidget.static.highlightable = false;
13898
13899 OO.ui.RadioOptionWidget.static.scrollIntoViewOnSelect = true;
13900
13901 OO.ui.RadioOptionWidget.static.pressable = false;
13902
13903 OO.ui.RadioOptionWidget.static.tagName = 'label';
13904
13905 /* Methods */
13906
13907 /**
13908 * @inheritdoc
13909 */
13910 OO.ui.RadioOptionWidget.prototype.setSelected = function ( state ) {
13911 OO.ui.RadioOptionWidget.super.prototype.setSelected.call( this, state );
13912
13913 this.radio.setSelected( state );
13914
13915 return this;
13916 };
13917
13918 /**
13919 * @inheritdoc
13920 */
13921 OO.ui.RadioOptionWidget.prototype.setDisabled = function ( disabled ) {
13922 OO.ui.RadioOptionWidget.super.prototype.setDisabled.call( this, disabled );
13923
13924 this.radio.setDisabled( this.isDisabled() );
13925
13926 return this;
13927 };
13928
13929 /**
13930 * MenuOptionWidget is an option widget that looks like a menu item. The class is used with
13931 * OO.ui.MenuSelectWidget to create a menu of mutually exclusive options. Please see
13932 * the [OOjs UI documentation on MediaWiki] [1] for more information.
13933 *
13934 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options#Menu_selects_and_options
13935 *
13936 * @class
13937 * @extends OO.ui.DecoratedOptionWidget
13938 *
13939 * @constructor
13940 * @param {Object} [config] Configuration options
13941 */
13942 OO.ui.MenuOptionWidget = function OoUiMenuOptionWidget( config ) {
13943 // Configuration initialization
13944 config = $.extend( { icon: 'check' }, config );
13945
13946 // Parent constructor
13947 OO.ui.MenuOptionWidget.super.call( this, config );
13948
13949 // Initialization
13950 this.$element
13951 .attr( 'role', 'menuitem' )
13952 .addClass( 'oo-ui-menuOptionWidget' );
13953 };
13954
13955 /* Setup */
13956
13957 OO.inheritClass( OO.ui.MenuOptionWidget, OO.ui.DecoratedOptionWidget );
13958
13959 /* Static Properties */
13960
13961 OO.ui.MenuOptionWidget.static.scrollIntoViewOnSelect = true;
13962
13963 /**
13964 * MenuSectionOptionWidgets are used inside {@link OO.ui.MenuSelectWidget menu select widgets} to group one or more related
13965 * {@link OO.ui.MenuOptionWidget menu options}. MenuSectionOptionWidgets cannot be highlighted or selected.
13966 *
13967 * @example
13968 * var myDropdown = new OO.ui.DropdownWidget( {
13969 * menu: {
13970 * items: [
13971 * new OO.ui.MenuSectionOptionWidget( {
13972 * label: 'Dogs'
13973 * } ),
13974 * new OO.ui.MenuOptionWidget( {
13975 * data: 'corgi',
13976 * label: 'Welsh Corgi'
13977 * } ),
13978 * new OO.ui.MenuOptionWidget( {
13979 * data: 'poodle',
13980 * label: 'Standard Poodle'
13981 * } ),
13982 * new OO.ui.MenuSectionOptionWidget( {
13983 * label: 'Cats'
13984 * } ),
13985 * new OO.ui.MenuOptionWidget( {
13986 * data: 'lion',
13987 * label: 'Lion'
13988 * } )
13989 * ]
13990 * }
13991 * } );
13992 * $( 'body' ).append( myDropdown.$element );
13993 *
13994 *
13995 * @class
13996 * @extends OO.ui.DecoratedOptionWidget
13997 *
13998 * @constructor
13999 * @param {Object} [config] Configuration options
14000 */
14001 OO.ui.MenuSectionOptionWidget = function OoUiMenuSectionOptionWidget( config ) {
14002 // Parent constructor
14003 OO.ui.MenuSectionOptionWidget.super.call( this, config );
14004
14005 // Initialization
14006 this.$element.addClass( 'oo-ui-menuSectionOptionWidget' );
14007 };
14008
14009 /* Setup */
14010
14011 OO.inheritClass( OO.ui.MenuSectionOptionWidget, OO.ui.DecoratedOptionWidget );
14012
14013 /* Static Properties */
14014
14015 OO.ui.MenuSectionOptionWidget.static.selectable = false;
14016
14017 OO.ui.MenuSectionOptionWidget.static.highlightable = false;
14018
14019 /**
14020 * OutlineOptionWidget is an item in an {@link OO.ui.OutlineSelectWidget OutlineSelectWidget}.
14021 *
14022 * Currently, this class is only used by {@link OO.ui.BookletLayout booklet layouts}, which contain
14023 * {@link OO.ui.PageLayout page layouts}. See {@link OO.ui.BookletLayout BookletLayout}
14024 * for an example.
14025 *
14026 * @class
14027 * @extends OO.ui.DecoratedOptionWidget
14028 *
14029 * @constructor
14030 * @param {Object} [config] Configuration options
14031 * @cfg {number} [level] Indentation level
14032 * @cfg {boolean} [movable] Allow modification from {@link OO.ui.OutlineControlsWidget outline controls}.
14033 */
14034 OO.ui.OutlineOptionWidget = function OoUiOutlineOptionWidget( config ) {
14035 // Configuration initialization
14036 config = config || {};
14037
14038 // Parent constructor
14039 OO.ui.OutlineOptionWidget.super.call( this, config );
14040
14041 // Properties
14042 this.level = 0;
14043 this.movable = !!config.movable;
14044 this.removable = !!config.removable;
14045
14046 // Initialization
14047 this.$element.addClass( 'oo-ui-outlineOptionWidget' );
14048 this.setLevel( config.level );
14049 };
14050
14051 /* Setup */
14052
14053 OO.inheritClass( OO.ui.OutlineOptionWidget, OO.ui.DecoratedOptionWidget );
14054
14055 /* Static Properties */
14056
14057 OO.ui.OutlineOptionWidget.static.highlightable = false;
14058
14059 OO.ui.OutlineOptionWidget.static.scrollIntoViewOnSelect = true;
14060
14061 OO.ui.OutlineOptionWidget.static.levelClass = 'oo-ui-outlineOptionWidget-level-';
14062
14063 OO.ui.OutlineOptionWidget.static.levels = 3;
14064
14065 /* Methods */
14066
14067 /**
14068 * Check if item is movable.
14069 *
14070 * Movability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
14071 *
14072 * @return {boolean} Item is movable
14073 */
14074 OO.ui.OutlineOptionWidget.prototype.isMovable = function () {
14075 return this.movable;
14076 };
14077
14078 /**
14079 * Check if item is removable.
14080 *
14081 * Removability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
14082 *
14083 * @return {boolean} Item is removable
14084 */
14085 OO.ui.OutlineOptionWidget.prototype.isRemovable = function () {
14086 return this.removable;
14087 };
14088
14089 /**
14090 * Get indentation level.
14091 *
14092 * @return {number} Indentation level
14093 */
14094 OO.ui.OutlineOptionWidget.prototype.getLevel = function () {
14095 return this.level;
14096 };
14097
14098 /**
14099 * Set movability.
14100 *
14101 * Movability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
14102 *
14103 * @param {boolean} movable Item is movable
14104 * @chainable
14105 */
14106 OO.ui.OutlineOptionWidget.prototype.setMovable = function ( movable ) {
14107 this.movable = !!movable;
14108 this.updateThemeClasses();
14109 return this;
14110 };
14111
14112 /**
14113 * Set removability.
14114 *
14115 * Removability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
14116 *
14117 * @param {boolean} movable Item is removable
14118 * @chainable
14119 */
14120 OO.ui.OutlineOptionWidget.prototype.setRemovable = function ( removable ) {
14121 this.removable = !!removable;
14122 this.updateThemeClasses();
14123 return this;
14124 };
14125
14126 /**
14127 * Set indentation level.
14128 *
14129 * @param {number} [level=0] Indentation level, in the range of [0,#maxLevel]
14130 * @chainable
14131 */
14132 OO.ui.OutlineOptionWidget.prototype.setLevel = function ( level ) {
14133 var levels = this.constructor.static.levels,
14134 levelClass = this.constructor.static.levelClass,
14135 i = levels;
14136
14137 this.level = level ? Math.max( 0, Math.min( levels - 1, level ) ) : 0;
14138 while ( i-- ) {
14139 if ( this.level === i ) {
14140 this.$element.addClass( levelClass + i );
14141 } else {
14142 this.$element.removeClass( levelClass + i );
14143 }
14144 }
14145 this.updateThemeClasses();
14146
14147 return this;
14148 };
14149
14150 /**
14151 * TabOptionWidget is an item in a {@link OO.ui.TabSelectWidget TabSelectWidget}.
14152 *
14153 * Currently, this class is only used by {@link OO.ui.IndexLayout index layouts}, which contain
14154 * {@link OO.ui.CardLayout card layouts}. See {@link OO.ui.IndexLayout IndexLayout}
14155 * for an example.
14156 *
14157 * @class
14158 * @extends OO.ui.OptionWidget
14159 *
14160 * @constructor
14161 * @param {Object} [config] Configuration options
14162 */
14163 OO.ui.TabOptionWidget = function OoUiTabOptionWidget( config ) {
14164 // Configuration initialization
14165 config = config || {};
14166
14167 // Parent constructor
14168 OO.ui.TabOptionWidget.super.call( this, config );
14169
14170 // Initialization
14171 this.$element.addClass( 'oo-ui-tabOptionWidget' );
14172 };
14173
14174 /* Setup */
14175
14176 OO.inheritClass( OO.ui.TabOptionWidget, OO.ui.OptionWidget );
14177
14178 /* Static Properties */
14179
14180 OO.ui.TabOptionWidget.static.highlightable = false;
14181
14182 /**
14183 * PopupWidget is a container for content. The popup is overlaid and positioned absolutely.
14184 * By default, each popup has an anchor that points toward its origin.
14185 * Please see the [OOjs UI documentation on Mediawiki] [1] for more information and examples.
14186 *
14187 * @example
14188 * // A popup widget.
14189 * var popup = new OO.ui.PopupWidget( {
14190 * $content: $( '<p>Hi there!</p>' ),
14191 * padded: true,
14192 * width: 300
14193 * } );
14194 *
14195 * $( 'body' ).append( popup.$element );
14196 * // To display the popup, toggle the visibility to 'true'.
14197 * popup.toggle( true );
14198 *
14199 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Popups
14200 *
14201 * @class
14202 * @extends OO.ui.Widget
14203 * @mixins OO.ui.LabelElement
14204 *
14205 * @constructor
14206 * @param {Object} [config] Configuration options
14207 * @cfg {number} [width=320] Width of popup in pixels
14208 * @cfg {number} [height] Height of popup in pixels. Omit to use the automatic height.
14209 * @cfg {boolean} [anchor=true] Show anchor pointing to origin of popup
14210 * @cfg {string} [align='center'] Alignment of the popup: `center`, `force-left`, `force-right`, `backwards` or `forwards`.
14211 * If the popup is forced-left the popup body is leaning towards the left. For force-right alignment, the body of the
14212 * popup is leaning towards the right of the screen.
14213 * Using 'backwards' is a logical direction which will result in the popup leaning towards the beginning of the sentence
14214 * in the given language, which means it will flip to the correct positioning in right-to-left languages.
14215 * Using 'forward' will also result in a logical alignment where the body of the popup leans towards the end of the
14216 * sentence in the given language.
14217 * @cfg {jQuery} [$container] Constrain the popup to the boundaries of the specified container.
14218 * See the [OOjs UI docs on MediaWiki][3] for an example.
14219 * [3]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Popups#containerExample
14220 * @cfg {number} [containerPadding=10] Padding between the popup and its container, specified as a number of pixels.
14221 * @cfg {jQuery} [$content] Content to append to the popup's body
14222 * @cfg {boolean} [autoClose=false] Automatically close the popup when it loses focus.
14223 * @cfg {jQuery} [$autoCloseIgnore] Elements that will not close the popup when clicked.
14224 * This config option is only relevant if #autoClose is set to `true`. See the [OOjs UI docs on MediaWiki][2]
14225 * for an example.
14226 * [2]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Popups#autocloseExample
14227 * @cfg {boolean} [head] Show a popup header that contains a #label (if specified) and close
14228 * button.
14229 * @cfg {boolean} [padded] Add padding to the popup's body
14230 */
14231 OO.ui.PopupWidget = function OoUiPopupWidget( config ) {
14232 // Configuration initialization
14233 config = config || {};
14234
14235 // Parent constructor
14236 OO.ui.PopupWidget.super.call( this, config );
14237
14238 // Properties (must be set before ClippableElement constructor call)
14239 this.$body = $( '<div>' );
14240
14241 // Mixin constructors
14242 OO.ui.LabelElement.call( this, config );
14243 OO.ui.ClippableElement.call( this, $.extend( {}, config, { $clippable: this.$body } ) );
14244
14245 // Properties
14246 this.$popup = $( '<div>' );
14247 this.$head = $( '<div>' );
14248 this.$anchor = $( '<div>' );
14249 // If undefined, will be computed lazily in updateDimensions()
14250 this.$container = config.$container;
14251 this.containerPadding = config.containerPadding !== undefined ? config.containerPadding : 10;
14252 this.autoClose = !!config.autoClose;
14253 this.$autoCloseIgnore = config.$autoCloseIgnore;
14254 this.transitionTimeout = null;
14255 this.anchor = null;
14256 this.width = config.width !== undefined ? config.width : 320;
14257 this.height = config.height !== undefined ? config.height : null;
14258 this.setAlignment( config.align );
14259 this.closeButton = new OO.ui.ButtonWidget( { framed: false, icon: 'close' } );
14260 this.onMouseDownHandler = this.onMouseDown.bind( this );
14261 this.onDocumentKeyDownHandler = this.onDocumentKeyDown.bind( this );
14262
14263 // Events
14264 this.closeButton.connect( this, { click: 'onCloseButtonClick' } );
14265
14266 // Initialization
14267 this.toggleAnchor( config.anchor === undefined || config.anchor );
14268 this.$body.addClass( 'oo-ui-popupWidget-body' );
14269 this.$anchor.addClass( 'oo-ui-popupWidget-anchor' );
14270 this.$head
14271 .addClass( 'oo-ui-popupWidget-head' )
14272 .append( this.$label, this.closeButton.$element );
14273 if ( !config.head ) {
14274 this.$head.addClass( 'oo-ui-element-hidden' );
14275 }
14276 this.$popup
14277 .addClass( 'oo-ui-popupWidget-popup' )
14278 .append( this.$head, this.$body );
14279 this.$element
14280 .addClass( 'oo-ui-popupWidget' )
14281 .append( this.$popup, this.$anchor );
14282 // Move content, which was added to #$element by OO.ui.Widget, to the body
14283 if ( config.$content instanceof jQuery ) {
14284 this.$body.append( config.$content );
14285 }
14286 if ( config.padded ) {
14287 this.$body.addClass( 'oo-ui-popupWidget-body-padded' );
14288 }
14289
14290 // Initially hidden - using #toggle may cause errors if subclasses override toggle with methods
14291 // that reference properties not initialized at that time of parent class construction
14292 // TODO: Find a better way to handle post-constructor setup
14293 this.visible = false;
14294 this.$element.addClass( 'oo-ui-element-hidden' );
14295 };
14296
14297 /* Setup */
14298
14299 OO.inheritClass( OO.ui.PopupWidget, OO.ui.Widget );
14300 OO.mixinClass( OO.ui.PopupWidget, OO.ui.LabelElement );
14301 OO.mixinClass( OO.ui.PopupWidget, OO.ui.ClippableElement );
14302
14303 /* Methods */
14304
14305 /**
14306 * Handles mouse down events.
14307 *
14308 * @private
14309 * @param {MouseEvent} e Mouse down event
14310 */
14311 OO.ui.PopupWidget.prototype.onMouseDown = function ( e ) {
14312 if (
14313 this.isVisible() &&
14314 !$.contains( this.$element[ 0 ], e.target ) &&
14315 ( !this.$autoCloseIgnore || !this.$autoCloseIgnore.has( e.target ).length )
14316 ) {
14317 this.toggle( false );
14318 }
14319 };
14320
14321 /**
14322 * Bind mouse down listener.
14323 *
14324 * @private
14325 */
14326 OO.ui.PopupWidget.prototype.bindMouseDownListener = function () {
14327 // Capture clicks outside popup
14328 this.getElementWindow().addEventListener( 'mousedown', this.onMouseDownHandler, true );
14329 };
14330
14331 /**
14332 * Handles close button click events.
14333 *
14334 * @private
14335 */
14336 OO.ui.PopupWidget.prototype.onCloseButtonClick = function () {
14337 if ( this.isVisible() ) {
14338 this.toggle( false );
14339 }
14340 };
14341
14342 /**
14343 * Unbind mouse down listener.
14344 *
14345 * @private
14346 */
14347 OO.ui.PopupWidget.prototype.unbindMouseDownListener = function () {
14348 this.getElementWindow().removeEventListener( 'mousedown', this.onMouseDownHandler, true );
14349 };
14350
14351 /**
14352 * Handles key down events.
14353 *
14354 * @private
14355 * @param {KeyboardEvent} e Key down event
14356 */
14357 OO.ui.PopupWidget.prototype.onDocumentKeyDown = function ( e ) {
14358 if (
14359 e.which === OO.ui.Keys.ESCAPE &&
14360 this.isVisible()
14361 ) {
14362 this.toggle( false );
14363 e.preventDefault();
14364 e.stopPropagation();
14365 }
14366 };
14367
14368 /**
14369 * Bind key down listener.
14370 *
14371 * @private
14372 */
14373 OO.ui.PopupWidget.prototype.bindKeyDownListener = function () {
14374 this.getElementWindow().addEventListener( 'keydown', this.onDocumentKeyDownHandler, true );
14375 };
14376
14377 /**
14378 * Unbind key down listener.
14379 *
14380 * @private
14381 */
14382 OO.ui.PopupWidget.prototype.unbindKeyDownListener = function () {
14383 this.getElementWindow().removeEventListener( 'keydown', this.onDocumentKeyDownHandler, true );
14384 };
14385
14386 /**
14387 * Show, hide, or toggle the visibility of the anchor.
14388 *
14389 * @param {boolean} [show] Show anchor, omit to toggle
14390 */
14391 OO.ui.PopupWidget.prototype.toggleAnchor = function ( show ) {
14392 show = show === undefined ? !this.anchored : !!show;
14393
14394 if ( this.anchored !== show ) {
14395 if ( show ) {
14396 this.$element.addClass( 'oo-ui-popupWidget-anchored' );
14397 } else {
14398 this.$element.removeClass( 'oo-ui-popupWidget-anchored' );
14399 }
14400 this.anchored = show;
14401 }
14402 };
14403
14404 /**
14405 * Check if the anchor is visible.
14406 *
14407 * @return {boolean} Anchor is visible
14408 */
14409 OO.ui.PopupWidget.prototype.hasAnchor = function () {
14410 return this.anchor;
14411 };
14412
14413 /**
14414 * @inheritdoc
14415 */
14416 OO.ui.PopupWidget.prototype.toggle = function ( show ) {
14417 show = show === undefined ? !this.isVisible() : !!show;
14418
14419 var change = show !== this.isVisible();
14420
14421 // Parent method
14422 OO.ui.PopupWidget.super.prototype.toggle.call( this, show );
14423
14424 if ( change ) {
14425 if ( show ) {
14426 if ( this.autoClose ) {
14427 this.bindMouseDownListener();
14428 this.bindKeyDownListener();
14429 }
14430 this.updateDimensions();
14431 this.toggleClipping( true );
14432 } else {
14433 this.toggleClipping( false );
14434 if ( this.autoClose ) {
14435 this.unbindMouseDownListener();
14436 this.unbindKeyDownListener();
14437 }
14438 }
14439 }
14440
14441 return this;
14442 };
14443
14444 /**
14445 * Set the size of the popup.
14446 *
14447 * Changing the size may also change the popup's position depending on the alignment.
14448 *
14449 * @param {number} width Width in pixels
14450 * @param {number} height Height in pixels
14451 * @param {boolean} [transition=false] Use a smooth transition
14452 * @chainable
14453 */
14454 OO.ui.PopupWidget.prototype.setSize = function ( width, height, transition ) {
14455 this.width = width;
14456 this.height = height !== undefined ? height : null;
14457 if ( this.isVisible() ) {
14458 this.updateDimensions( transition );
14459 }
14460 };
14461
14462 /**
14463 * Update the size and position.
14464 *
14465 * Only use this to keep the popup properly anchored. Use #setSize to change the size, and this will
14466 * be called automatically.
14467 *
14468 * @param {boolean} [transition=false] Use a smooth transition
14469 * @chainable
14470 */
14471 OO.ui.PopupWidget.prototype.updateDimensions = function ( transition ) {
14472 var popupOffset, originOffset, containerLeft, containerWidth, containerRight,
14473 popupLeft, popupRight, overlapLeft, overlapRight, anchorWidth,
14474 align = this.align,
14475 widget = this;
14476
14477 if ( !this.$container ) {
14478 // Lazy-initialize $container if not specified in constructor
14479 this.$container = $( this.getClosestScrollableElementContainer() );
14480 }
14481
14482 // Set height and width before measuring things, since it might cause our measurements
14483 // to change (e.g. due to scrollbars appearing or disappearing)
14484 this.$popup.css( {
14485 width: this.width,
14486 height: this.height !== null ? this.height : 'auto'
14487 } );
14488
14489 // If we are in RTL, we need to flip the alignment, unless it is center
14490 if ( align === 'forwards' || align === 'backwards' ) {
14491 if ( this.$container.css( 'direction' ) === 'rtl' ) {
14492 align = ( { forwards: 'force-left', backwards: 'force-right' } )[ this.align ];
14493 } else {
14494 align = ( { forwards: 'force-right', backwards: 'force-left' } )[ this.align ];
14495 }
14496
14497 }
14498
14499 // Compute initial popupOffset based on alignment
14500 popupOffset = this.width * ( { 'force-left': -1, center: -0.5, 'force-right': 0 } )[ align ];
14501
14502 // Figure out if this will cause the popup to go beyond the edge of the container
14503 originOffset = this.$element.offset().left;
14504 containerLeft = this.$container.offset().left;
14505 containerWidth = this.$container.innerWidth();
14506 containerRight = containerLeft + containerWidth;
14507 popupLeft = popupOffset - this.containerPadding;
14508 popupRight = popupOffset + this.containerPadding + this.width + this.containerPadding;
14509 overlapLeft = ( originOffset + popupLeft ) - containerLeft;
14510 overlapRight = containerRight - ( originOffset + popupRight );
14511
14512 // Adjust offset to make the popup not go beyond the edge, if needed
14513 if ( overlapRight < 0 ) {
14514 popupOffset += overlapRight;
14515 } else if ( overlapLeft < 0 ) {
14516 popupOffset -= overlapLeft;
14517 }
14518
14519 // Adjust offset to avoid anchor being rendered too close to the edge
14520 // $anchor.width() doesn't work with the pure CSS anchor (returns 0)
14521 // TODO: Find a measurement that works for CSS anchors and image anchors
14522 anchorWidth = this.$anchor[ 0 ].scrollWidth * 2;
14523 if ( popupOffset + this.width < anchorWidth ) {
14524 popupOffset = anchorWidth - this.width;
14525 } else if ( -popupOffset < anchorWidth ) {
14526 popupOffset = -anchorWidth;
14527 }
14528
14529 // Prevent transition from being interrupted
14530 clearTimeout( this.transitionTimeout );
14531 if ( transition ) {
14532 // Enable transition
14533 this.$element.addClass( 'oo-ui-popupWidget-transitioning' );
14534 }
14535
14536 // Position body relative to anchor
14537 this.$popup.css( 'margin-left', popupOffset );
14538
14539 if ( transition ) {
14540 // Prevent transitioning after transition is complete
14541 this.transitionTimeout = setTimeout( function () {
14542 widget.$element.removeClass( 'oo-ui-popupWidget-transitioning' );
14543 }, 200 );
14544 } else {
14545 // Prevent transitioning immediately
14546 this.$element.removeClass( 'oo-ui-popupWidget-transitioning' );
14547 }
14548
14549 // Reevaluate clipping state since we've relocated and resized the popup
14550 this.clip();
14551
14552 return this;
14553 };
14554
14555 /**
14556 * Set popup alignment
14557 * @param {string} align Alignment of the popup, `center`, `force-left`, `force-right`,
14558 * `backwards` or `forwards`.
14559 */
14560 OO.ui.PopupWidget.prototype.setAlignment = function ( align ) {
14561 // Validate alignment and transform deprecated values
14562 if ( [ 'left', 'right', 'force-left', 'force-right', 'backwards', 'forwards', 'center' ].indexOf( align ) > -1 ) {
14563 this.align = { left: 'force-right', right: 'force-left' }[ align ] || align;
14564 } else {
14565 this.align = 'center';
14566 }
14567 };
14568
14569 /**
14570 * Get popup alignment
14571 * @return {string} align Alignment of the popup, `center`, `force-left`, `force-right`,
14572 * `backwards` or `forwards`.
14573 */
14574 OO.ui.PopupWidget.prototype.getAlignment = function () {
14575 return this.align;
14576 };
14577
14578 /**
14579 * Progress bars visually display the status of an operation, such as a download,
14580 * and can be either determinate or indeterminate:
14581 *
14582 * - **determinate** process bars show the percent of an operation that is complete.
14583 *
14584 * - **indeterminate** process bars use a visual display of motion to indicate that an operation
14585 * is taking place. Because the extent of an indeterminate operation is unknown, the bar does
14586 * not use percentages.
14587 *
14588 * The value of the `progress` configuration determines whether the bar is determinate or indeterminate.
14589 *
14590 * @example
14591 * // Examples of determinate and indeterminate progress bars.
14592 * var progressBar1 = new OO.ui.ProgressBarWidget( {
14593 * progress: 33
14594 * } );
14595 * var progressBar2 = new OO.ui.ProgressBarWidget();
14596 *
14597 * // Create a FieldsetLayout to layout progress bars
14598 * var fieldset = new OO.ui.FieldsetLayout;
14599 * fieldset.addItems( [
14600 * new OO.ui.FieldLayout( progressBar1, {label: 'Determinate', align: 'top'}),
14601 * new OO.ui.FieldLayout( progressBar2, {label: 'Indeterminate', align: 'top'})
14602 * ] );
14603 * $( 'body' ).append( fieldset.$element );
14604 *
14605 * @class
14606 * @extends OO.ui.Widget
14607 *
14608 * @constructor
14609 * @param {Object} [config] Configuration options
14610 * @cfg {number|boolean} [progress=false] The type of progress bar (determinate or indeterminate).
14611 * To create a determinate progress bar, specify a number that reflects the initial percent complete.
14612 * By default, the progress bar is indeterminate.
14613 */
14614 OO.ui.ProgressBarWidget = function OoUiProgressBarWidget( config ) {
14615 // Configuration initialization
14616 config = config || {};
14617
14618 // Parent constructor
14619 OO.ui.ProgressBarWidget.super.call( this, config );
14620
14621 // Properties
14622 this.$bar = $( '<div>' );
14623 this.progress = null;
14624
14625 // Initialization
14626 this.setProgress( config.progress !== undefined ? config.progress : false );
14627 this.$bar.addClass( 'oo-ui-progressBarWidget-bar' );
14628 this.$element
14629 .attr( {
14630 role: 'progressbar',
14631 'aria-valuemin': 0,
14632 'aria-valuemax': 100
14633 } )
14634 .addClass( 'oo-ui-progressBarWidget' )
14635 .append( this.$bar );
14636 };
14637
14638 /* Setup */
14639
14640 OO.inheritClass( OO.ui.ProgressBarWidget, OO.ui.Widget );
14641
14642 /* Static Properties */
14643
14644 OO.ui.ProgressBarWidget.static.tagName = 'div';
14645
14646 /* Methods */
14647
14648 /**
14649 * Get the percent of the progress that has been completed. Indeterminate progresses will return `false`.
14650 *
14651 * @return {number|boolean} Progress percent
14652 */
14653 OO.ui.ProgressBarWidget.prototype.getProgress = function () {
14654 return this.progress;
14655 };
14656
14657 /**
14658 * Set the percent of the process completed or `false` for an indeterminate process.
14659 *
14660 * @param {number|boolean} progress Progress percent or `false` for indeterminate
14661 */
14662 OO.ui.ProgressBarWidget.prototype.setProgress = function ( progress ) {
14663 this.progress = progress;
14664
14665 if ( progress !== false ) {
14666 this.$bar.css( 'width', this.progress + '%' );
14667 this.$element.attr( 'aria-valuenow', this.progress );
14668 } else {
14669 this.$bar.css( 'width', '' );
14670 this.$element.removeAttr( 'aria-valuenow' );
14671 }
14672 this.$element.toggleClass( 'oo-ui-progressBarWidget-indeterminate', !progress );
14673 };
14674
14675 /**
14676 * SearchWidgets combine a {@link OO.ui.TextInputWidget text input field}, where users can type a search query,
14677 * and a {@link OO.ui.TextInputMenuSelectWidget menu} of search results, which is displayed beneath the query
14678 * field. Unlike {@link OO.ui.LookupElement lookup menus}, search result menus are always visible to the user.
14679 * Users can choose an item from the menu or type a query into the text field to search for a matching result item.
14680 * In general, search widgets are used inside a separate {@link OO.ui.Dialog dialog} window.
14681 *
14682 * Each time the query is changed, the search result menu is cleared and repopulated. Please see
14683 * the [OOjs UI demos][1] for an example.
14684 *
14685 * [1]: https://tools.wmflabs.org/oojs-ui/oojs-ui/demos/#dialogs-mediawiki-vector-ltr
14686 *
14687 * @class
14688 * @extends OO.ui.Widget
14689 *
14690 * @constructor
14691 * @param {Object} [config] Configuration options
14692 * @cfg {string|jQuery} [placeholder] Placeholder text for query input
14693 * @cfg {string} [value] Initial query value
14694 */
14695 OO.ui.SearchWidget = function OoUiSearchWidget( config ) {
14696 // Configuration initialization
14697 config = config || {};
14698
14699 // Parent constructor
14700 OO.ui.SearchWidget.super.call( this, config );
14701
14702 // Properties
14703 this.query = new OO.ui.TextInputWidget( {
14704 icon: 'search',
14705 placeholder: config.placeholder,
14706 value: config.value
14707 } );
14708 this.results = new OO.ui.SelectWidget();
14709 this.$query = $( '<div>' );
14710 this.$results = $( '<div>' );
14711
14712 // Events
14713 this.query.connect( this, {
14714 change: 'onQueryChange',
14715 enter: 'onQueryEnter'
14716 } );
14717 this.results.connect( this, {
14718 highlight: 'onResultsHighlight',
14719 select: 'onResultsSelect'
14720 } );
14721 this.query.$input.on( 'keydown', this.onQueryKeydown.bind( this ) );
14722
14723 // Initialization
14724 this.$query
14725 .addClass( 'oo-ui-searchWidget-query' )
14726 .append( this.query.$element );
14727 this.$results
14728 .addClass( 'oo-ui-searchWidget-results' )
14729 .append( this.results.$element );
14730 this.$element
14731 .addClass( 'oo-ui-searchWidget' )
14732 .append( this.$results, this.$query );
14733 };
14734
14735 /* Setup */
14736
14737 OO.inheritClass( OO.ui.SearchWidget, OO.ui.Widget );
14738
14739 /* Events */
14740
14741 /**
14742 * A 'highlight' event is emitted when an item is highlighted. The highlight indicates which
14743 * item will be selected. When a user mouses over a menu item, it is highlighted. If a search
14744 * string is typed into the query field instead, the first menu item that matches the query
14745 * will be highlighted.
14746
14747 * @event highlight
14748 * @deprecated Connect straight to getResults() events instead
14749 * @param {Object|null} item Item data or null if no item is highlighted
14750 */
14751
14752 /**
14753 * A 'select' event is emitted when an item is selected. A menu item is selected when it is clicked,
14754 * or when a user types a search query, a menu result is highlighted, and the user presses enter.
14755 *
14756 * @event select
14757 * @deprecated Connect straight to getResults() events instead
14758 * @param {Object|null} item Item data or null if no item is selected
14759 */
14760
14761 /* Methods */
14762
14763 /**
14764 * Handle query key down events.
14765 *
14766 * @private
14767 * @param {jQuery.Event} e Key down event
14768 */
14769 OO.ui.SearchWidget.prototype.onQueryKeydown = function ( e ) {
14770 var highlightedItem, nextItem,
14771 dir = e.which === OO.ui.Keys.DOWN ? 1 : ( e.which === OO.ui.Keys.UP ? -1 : 0 );
14772
14773 if ( dir ) {
14774 highlightedItem = this.results.getHighlightedItem();
14775 if ( !highlightedItem ) {
14776 highlightedItem = this.results.getSelectedItem();
14777 }
14778 nextItem = this.results.getRelativeSelectableItem( highlightedItem, dir );
14779 this.results.highlightItem( nextItem );
14780 nextItem.scrollElementIntoView();
14781 }
14782 };
14783
14784 /**
14785 * Handle select widget select events.
14786 *
14787 * Clears existing results. Subclasses should repopulate items according to new query.
14788 *
14789 * @private
14790 * @param {string} value New value
14791 */
14792 OO.ui.SearchWidget.prototype.onQueryChange = function () {
14793 // Reset
14794 this.results.clearItems();
14795 };
14796
14797 /**
14798 * Handle select widget enter key events.
14799 *
14800 * Selects highlighted item.
14801 *
14802 * @private
14803 * @param {string} value New value
14804 */
14805 OO.ui.SearchWidget.prototype.onQueryEnter = function () {
14806 // Reset
14807 this.results.selectItem( this.results.getHighlightedItem() );
14808 };
14809
14810 /**
14811 * Handle select widget highlight events.
14812 *
14813 * @private
14814 * @deprecated Connect straight to getResults() events instead
14815 * @param {OO.ui.OptionWidget} item Highlighted item
14816 * @fires highlight
14817 */
14818 OO.ui.SearchWidget.prototype.onResultsHighlight = function ( item ) {
14819 this.emit( 'highlight', item ? item.getData() : null );
14820 };
14821
14822 /**
14823 * Handle select widget select events.
14824 *
14825 * @private
14826 * @deprecated Connect straight to getResults() events instead
14827 * @param {OO.ui.OptionWidget} item Selected item
14828 * @fires select
14829 */
14830 OO.ui.SearchWidget.prototype.onResultsSelect = function ( item ) {
14831 this.emit( 'select', item ? item.getData() : null );
14832 };
14833
14834 /**
14835 * Get the query input.
14836 *
14837 * @return {OO.ui.TextInputWidget} Query input
14838 */
14839 OO.ui.SearchWidget.prototype.getQuery = function () {
14840 return this.query;
14841 };
14842
14843 /**
14844 * Get the search results menu.
14845 *
14846 * @return {OO.ui.SelectWidget} Menu of search results
14847 */
14848 OO.ui.SearchWidget.prototype.getResults = function () {
14849 return this.results;
14850 };
14851
14852 /**
14853 * A SelectWidget is of a generic selection of options. The OOjs UI library contains several types of
14854 * select widgets, including {@link OO.ui.ButtonSelectWidget button selects},
14855 * {@link OO.ui.RadioSelectWidget radio selects}, and {@link OO.ui.MenuSelectWidget
14856 * menu selects}.
14857 *
14858 * This class should be used together with OO.ui.OptionWidget or OO.ui.DecoratedOptionWidget. For more
14859 * information, please see the [OOjs UI documentation on MediaWiki][1].
14860 *
14861 * @example
14862 * // Example of a select widget with three options
14863 * var select = new OO.ui.SelectWidget( {
14864 * items: [
14865 * new OO.ui.OptionWidget( {
14866 * data: 'a',
14867 * label: 'Option One',
14868 * } ),
14869 * new OO.ui.OptionWidget( {
14870 * data: 'b',
14871 * label: 'Option Two',
14872 * } ),
14873 * new OO.ui.OptionWidget( {
14874 * data: 'c',
14875 * label: 'Option Three',
14876 * } )
14877 * ]
14878 * } );
14879 * $( 'body' ).append( select.$element );
14880 *
14881 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options
14882 *
14883 * @abstract
14884 * @class
14885 * @extends OO.ui.Widget
14886 * @mixins OO.ui.GroupElement
14887 *
14888 * @constructor
14889 * @param {Object} [config] Configuration options
14890 * @cfg {OO.ui.OptionWidget[]} [items] An array of options to add to the select.
14891 * Options are created with {@link OO.ui.OptionWidget OptionWidget} classes. See
14892 * the [OOjs UI documentation on MediaWiki] [2] for examples.
14893 * [2]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options
14894 */
14895 OO.ui.SelectWidget = function OoUiSelectWidget( config ) {
14896 // Configuration initialization
14897 config = config || {};
14898
14899 // Parent constructor
14900 OO.ui.SelectWidget.super.call( this, config );
14901
14902 // Mixin constructors
14903 OO.ui.GroupWidget.call( this, $.extend( {}, config, { $group: this.$element } ) );
14904
14905 // Properties
14906 this.pressed = false;
14907 this.selecting = null;
14908 this.onMouseUpHandler = this.onMouseUp.bind( this );
14909 this.onMouseMoveHandler = this.onMouseMove.bind( this );
14910 this.onKeyDownHandler = this.onKeyDown.bind( this );
14911
14912 // Events
14913 this.$element.on( {
14914 mousedown: this.onMouseDown.bind( this ),
14915 mouseover: this.onMouseOver.bind( this ),
14916 mouseleave: this.onMouseLeave.bind( this )
14917 } );
14918
14919 // Initialization
14920 this.$element
14921 .addClass( 'oo-ui-selectWidget oo-ui-selectWidget-depressed' )
14922 .attr( 'role', 'listbox' );
14923 if ( Array.isArray( config.items ) ) {
14924 this.addItems( config.items );
14925 }
14926 };
14927
14928 /* Setup */
14929
14930 OO.inheritClass( OO.ui.SelectWidget, OO.ui.Widget );
14931
14932 // Need to mixin base class as well
14933 OO.mixinClass( OO.ui.SelectWidget, OO.ui.GroupElement );
14934 OO.mixinClass( OO.ui.SelectWidget, OO.ui.GroupWidget );
14935
14936 /* Events */
14937
14938 /**
14939 * @event highlight
14940 *
14941 * A `highlight` event is emitted when the highlight is changed with the #highlightItem method.
14942 *
14943 * @param {OO.ui.OptionWidget|null} item Highlighted item
14944 */
14945
14946 /**
14947 * @event press
14948 *
14949 * A `press` event is emitted when the #pressItem method is used to programmatically modify the
14950 * pressed state of an option.
14951 *
14952 * @param {OO.ui.OptionWidget|null} item Pressed item
14953 */
14954
14955 /**
14956 * @event select
14957 *
14958 * A `select` event is emitted when the selection is modified programmatically with the #selectItem method.
14959 *
14960 * @param {OO.ui.OptionWidget|null} item Selected item
14961 */
14962
14963 /**
14964 * @event choose
14965 * A `choose` event is emitted when an item is chosen with the #chooseItem method.
14966 * @param {OO.ui.OptionWidget} item Chosen item
14967 */
14968
14969 /**
14970 * @event add
14971 *
14972 * An `add` event is emitted when options are added to the select with the #addItems method.
14973 *
14974 * @param {OO.ui.OptionWidget[]} items Added items
14975 * @param {number} index Index of insertion point
14976 */
14977
14978 /**
14979 * @event remove
14980 *
14981 * A `remove` event is emitted when options are removed from the select with the #clearItems
14982 * or #removeItems methods.
14983 *
14984 * @param {OO.ui.OptionWidget[]} items Removed items
14985 */
14986
14987 /* Methods */
14988
14989 /**
14990 * Handle mouse down events.
14991 *
14992 * @private
14993 * @param {jQuery.Event} e Mouse down event
14994 */
14995 OO.ui.SelectWidget.prototype.onMouseDown = function ( e ) {
14996 var item;
14997
14998 if ( !this.isDisabled() && e.which === 1 ) {
14999 this.togglePressed( true );
15000 item = this.getTargetItem( e );
15001 if ( item && item.isSelectable() ) {
15002 this.pressItem( item );
15003 this.selecting = item;
15004 this.getElementDocument().addEventListener(
15005 'mouseup',
15006 this.onMouseUpHandler,
15007 true
15008 );
15009 this.getElementDocument().addEventListener(
15010 'mousemove',
15011 this.onMouseMoveHandler,
15012 true
15013 );
15014 }
15015 }
15016 return false;
15017 };
15018
15019 /**
15020 * Handle mouse up events.
15021 *
15022 * @private
15023 * @param {jQuery.Event} e Mouse up event
15024 */
15025 OO.ui.SelectWidget.prototype.onMouseUp = function ( e ) {
15026 var item;
15027
15028 this.togglePressed( false );
15029 if ( !this.selecting ) {
15030 item = this.getTargetItem( e );
15031 if ( item && item.isSelectable() ) {
15032 this.selecting = item;
15033 }
15034 }
15035 if ( !this.isDisabled() && e.which === 1 && this.selecting ) {
15036 this.pressItem( null );
15037 this.chooseItem( this.selecting );
15038 this.selecting = null;
15039 }
15040
15041 this.getElementDocument().removeEventListener(
15042 'mouseup',
15043 this.onMouseUpHandler,
15044 true
15045 );
15046 this.getElementDocument().removeEventListener(
15047 'mousemove',
15048 this.onMouseMoveHandler,
15049 true
15050 );
15051
15052 return false;
15053 };
15054
15055 /**
15056 * Handle mouse move events.
15057 *
15058 * @private
15059 * @param {jQuery.Event} e Mouse move event
15060 */
15061 OO.ui.SelectWidget.prototype.onMouseMove = function ( e ) {
15062 var item;
15063
15064 if ( !this.isDisabled() && this.pressed ) {
15065 item = this.getTargetItem( e );
15066 if ( item && item !== this.selecting && item.isSelectable() ) {
15067 this.pressItem( item );
15068 this.selecting = item;
15069 }
15070 }
15071 return false;
15072 };
15073
15074 /**
15075 * Handle mouse over events.
15076 *
15077 * @private
15078 * @param {jQuery.Event} e Mouse over event
15079 */
15080 OO.ui.SelectWidget.prototype.onMouseOver = function ( e ) {
15081 var item;
15082
15083 if ( !this.isDisabled() ) {
15084 item = this.getTargetItem( e );
15085 this.highlightItem( item && item.isHighlightable() ? item : null );
15086 }
15087 return false;
15088 };
15089
15090 /**
15091 * Handle mouse leave events.
15092 *
15093 * @private
15094 * @param {jQuery.Event} e Mouse over event
15095 */
15096 OO.ui.SelectWidget.prototype.onMouseLeave = function () {
15097 if ( !this.isDisabled() ) {
15098 this.highlightItem( null );
15099 }
15100 return false;
15101 };
15102
15103 /**
15104 * Handle key down events.
15105 *
15106 * @protected
15107 * @param {jQuery.Event} e Key down event
15108 */
15109 OO.ui.SelectWidget.prototype.onKeyDown = function ( e ) {
15110 var nextItem,
15111 handled = false,
15112 currentItem = this.getHighlightedItem() || this.getSelectedItem();
15113
15114 if ( !this.isDisabled() && this.isVisible() ) {
15115 switch ( e.keyCode ) {
15116 case OO.ui.Keys.ENTER:
15117 if ( currentItem && currentItem.constructor.static.highlightable ) {
15118 // Was only highlighted, now let's select it. No-op if already selected.
15119 this.chooseItem( currentItem );
15120 handled = true;
15121 }
15122 break;
15123 case OO.ui.Keys.UP:
15124 case OO.ui.Keys.LEFT:
15125 nextItem = this.getRelativeSelectableItem( currentItem, -1 );
15126 handled = true;
15127 break;
15128 case OO.ui.Keys.DOWN:
15129 case OO.ui.Keys.RIGHT:
15130 nextItem = this.getRelativeSelectableItem( currentItem, 1 );
15131 handled = true;
15132 break;
15133 case OO.ui.Keys.ESCAPE:
15134 case OO.ui.Keys.TAB:
15135 if ( currentItem && currentItem.constructor.static.highlightable ) {
15136 currentItem.setHighlighted( false );
15137 }
15138 this.unbindKeyDownListener();
15139 // Don't prevent tabbing away / defocusing
15140 handled = false;
15141 break;
15142 }
15143
15144 if ( nextItem ) {
15145 if ( nextItem.constructor.static.highlightable ) {
15146 this.highlightItem( nextItem );
15147 } else {
15148 this.chooseItem( nextItem );
15149 }
15150 nextItem.scrollElementIntoView();
15151 }
15152
15153 if ( handled ) {
15154 // Can't just return false, because e is not always a jQuery event
15155 e.preventDefault();
15156 e.stopPropagation();
15157 }
15158 }
15159 };
15160
15161 /**
15162 * Bind key down listener.
15163 *
15164 * @protected
15165 */
15166 OO.ui.SelectWidget.prototype.bindKeyDownListener = function () {
15167 this.getElementWindow().addEventListener( 'keydown', this.onKeyDownHandler, true );
15168 };
15169
15170 /**
15171 * Unbind key down listener.
15172 *
15173 * @protected
15174 */
15175 OO.ui.SelectWidget.prototype.unbindKeyDownListener = function () {
15176 this.getElementWindow().removeEventListener( 'keydown', this.onKeyDownHandler, true );
15177 };
15178
15179 /**
15180 * Get the closest item to a jQuery.Event.
15181 *
15182 * @private
15183 * @param {jQuery.Event} e
15184 * @return {OO.ui.OptionWidget|null} Outline item widget, `null` if none was found
15185 */
15186 OO.ui.SelectWidget.prototype.getTargetItem = function ( e ) {
15187 return $( e.target ).closest( '.oo-ui-optionWidget' ).data( 'oo-ui-optionWidget' ) || null;
15188 };
15189
15190 /**
15191 * Get selected item.
15192 *
15193 * @return {OO.ui.OptionWidget|null} Selected item, `null` if no item is selected
15194 */
15195 OO.ui.SelectWidget.prototype.getSelectedItem = function () {
15196 var i, len;
15197
15198 for ( i = 0, len = this.items.length; i < len; i++ ) {
15199 if ( this.items[ i ].isSelected() ) {
15200 return this.items[ i ];
15201 }
15202 }
15203 return null;
15204 };
15205
15206 /**
15207 * Get highlighted item.
15208 *
15209 * @return {OO.ui.OptionWidget|null} Highlighted item, `null` if no item is highlighted
15210 */
15211 OO.ui.SelectWidget.prototype.getHighlightedItem = function () {
15212 var i, len;
15213
15214 for ( i = 0, len = this.items.length; i < len; i++ ) {
15215 if ( this.items[ i ].isHighlighted() ) {
15216 return this.items[ i ];
15217 }
15218 }
15219 return null;
15220 };
15221
15222 /**
15223 * Toggle pressed state.
15224 *
15225 * Press is a state that occurs when a user mouses down on an item, but
15226 * has not yet let go of the mouse. The item may appear selected, but it will not be selected
15227 * until the user releases the mouse.
15228 *
15229 * @param {boolean} pressed An option is being pressed
15230 */
15231 OO.ui.SelectWidget.prototype.togglePressed = function ( pressed ) {
15232 if ( pressed === undefined ) {
15233 pressed = !this.pressed;
15234 }
15235 if ( pressed !== this.pressed ) {
15236 this.$element
15237 .toggleClass( 'oo-ui-selectWidget-pressed', pressed )
15238 .toggleClass( 'oo-ui-selectWidget-depressed', !pressed );
15239 this.pressed = pressed;
15240 }
15241 };
15242
15243 /**
15244 * Highlight an option. If the `item` param is omitted, no options will be highlighted
15245 * and any existing highlight will be removed. The highlight is mutually exclusive.
15246 *
15247 * @param {OO.ui.OptionWidget} [item] Item to highlight, omit for no highlight
15248 * @fires highlight
15249 * @chainable
15250 */
15251 OO.ui.SelectWidget.prototype.highlightItem = function ( item ) {
15252 var i, len, highlighted,
15253 changed = false;
15254
15255 for ( i = 0, len = this.items.length; i < len; i++ ) {
15256 highlighted = this.items[ i ] === item;
15257 if ( this.items[ i ].isHighlighted() !== highlighted ) {
15258 this.items[ i ].setHighlighted( highlighted );
15259 changed = true;
15260 }
15261 }
15262 if ( changed ) {
15263 this.emit( 'highlight', item );
15264 }
15265
15266 return this;
15267 };
15268
15269 /**
15270 * Programmatically select an option by its data. If the `data` parameter is omitted,
15271 * or if the item does not exist, all options will be deselected.
15272 *
15273 * @param {Object|string} [data] Value of the item to select, omit to deselect all
15274 * @fires select
15275 * @chainable
15276 */
15277 OO.ui.SelectWidget.prototype.selectItemByData = function ( data ) {
15278 var itemFromData = this.getItemFromData( data );
15279 if ( data === undefined || !itemFromData ) {
15280 return this.selectItem();
15281 }
15282 return this.selectItem( itemFromData );
15283 };
15284
15285 /**
15286 * Programmatically select an option by its reference. If the `item` parameter is omitted,
15287 * all options will be deselected.
15288 *
15289 * @param {OO.ui.OptionWidget} [item] Item to select, omit to deselect all
15290 * @fires select
15291 * @chainable
15292 */
15293 OO.ui.SelectWidget.prototype.selectItem = function ( item ) {
15294 var i, len, selected,
15295 changed = false;
15296
15297 for ( i = 0, len = this.items.length; i < len; i++ ) {
15298 selected = this.items[ i ] === item;
15299 if ( this.items[ i ].isSelected() !== selected ) {
15300 this.items[ i ].setSelected( selected );
15301 changed = true;
15302 }
15303 }
15304 if ( changed ) {
15305 this.emit( 'select', item );
15306 }
15307
15308 return this;
15309 };
15310
15311 /**
15312 * Press an item.
15313 *
15314 * Press is a state that occurs when a user mouses down on an item, but has not
15315 * yet let go of the mouse. The item may appear selected, but it will not be selected until the user
15316 * releases the mouse.
15317 *
15318 * @param {OO.ui.OptionWidget} [item] Item to press, omit to depress all
15319 * @fires press
15320 * @chainable
15321 */
15322 OO.ui.SelectWidget.prototype.pressItem = function ( item ) {
15323 var i, len, pressed,
15324 changed = false;
15325
15326 for ( i = 0, len = this.items.length; i < len; i++ ) {
15327 pressed = this.items[ i ] === item;
15328 if ( this.items[ i ].isPressed() !== pressed ) {
15329 this.items[ i ].setPressed( pressed );
15330 changed = true;
15331 }
15332 }
15333 if ( changed ) {
15334 this.emit( 'press', item );
15335 }
15336
15337 return this;
15338 };
15339
15340 /**
15341 * Choose an item.
15342 *
15343 * Note that ‘choose’ should never be modified programmatically. A user can choose
15344 * an option with the keyboard or mouse and it becomes selected. To select an item programmatically,
15345 * use the #selectItem method.
15346 *
15347 * This method is identical to #selectItem, but may vary in subclasses that take additional action
15348 * when users choose an item with the keyboard or mouse.
15349 *
15350 * @param {OO.ui.OptionWidget} item Item to choose
15351 * @fires choose
15352 * @chainable
15353 */
15354 OO.ui.SelectWidget.prototype.chooseItem = function ( item ) {
15355 this.selectItem( item );
15356 this.emit( 'choose', item );
15357
15358 return this;
15359 };
15360
15361 /**
15362 * Get an option by its position relative to the specified item (or to the start of the option array,
15363 * if item is `null`). The direction in which to search through the option array is specified with a
15364 * number: -1 for reverse (the default) or 1 for forward. The method will return an option, or
15365 * `null` if there are no options in the array.
15366 *
15367 * @param {OO.ui.OptionWidget|null} item Item to describe the start position, or `null` to start at the beginning of the array.
15368 * @param {number} direction Direction to move in: -1 to move backward, 1 to move forward
15369 * @return {OO.ui.OptionWidget|null} Item at position, `null` if there are no items in the select
15370 */
15371 OO.ui.SelectWidget.prototype.getRelativeSelectableItem = function ( item, direction ) {
15372 var currentIndex, nextIndex, i,
15373 increase = direction > 0 ? 1 : -1,
15374 len = this.items.length;
15375
15376 if ( item instanceof OO.ui.OptionWidget ) {
15377 currentIndex = $.inArray( item, this.items );
15378 nextIndex = ( currentIndex + increase + len ) % len;
15379 } else {
15380 // If no item is selected and moving forward, start at the beginning.
15381 // If moving backward, start at the end.
15382 nextIndex = direction > 0 ? 0 : len - 1;
15383 }
15384
15385 for ( i = 0; i < len; i++ ) {
15386 item = this.items[ nextIndex ];
15387 if ( item instanceof OO.ui.OptionWidget && item.isSelectable() ) {
15388 return item;
15389 }
15390 nextIndex = ( nextIndex + increase + len ) % len;
15391 }
15392 return null;
15393 };
15394
15395 /**
15396 * Get the next selectable item or `null` if there are no selectable items.
15397 * Disabled options and menu-section markers and breaks are not selectable.
15398 *
15399 * @return {OO.ui.OptionWidget|null} Item, `null` if there aren't any selectable items
15400 */
15401 OO.ui.SelectWidget.prototype.getFirstSelectableItem = function () {
15402 var i, len, item;
15403
15404 for ( i = 0, len = this.items.length; i < len; i++ ) {
15405 item = this.items[ i ];
15406 if ( item instanceof OO.ui.OptionWidget && item.isSelectable() ) {
15407 return item;
15408 }
15409 }
15410
15411 return null;
15412 };
15413
15414 /**
15415 * Add an array of options to the select. Optionally, an index number can be used to
15416 * specify an insertion point.
15417 *
15418 * @param {OO.ui.OptionWidget[]} items Items to add
15419 * @param {number} [index] Index to insert items after
15420 * @fires add
15421 * @chainable
15422 */
15423 OO.ui.SelectWidget.prototype.addItems = function ( items, index ) {
15424 // Mixin method
15425 OO.ui.GroupWidget.prototype.addItems.call( this, items, index );
15426
15427 // Always provide an index, even if it was omitted
15428 this.emit( 'add', items, index === undefined ? this.items.length - items.length - 1 : index );
15429
15430 return this;
15431 };
15432
15433 /**
15434 * Remove the specified array of options from the select. Options will be detached
15435 * from the DOM, not removed, so they can be reused later. To remove all options from
15436 * the select, you may wish to use the #clearItems method instead.
15437 *
15438 * @param {OO.ui.OptionWidget[]} items Items to remove
15439 * @fires remove
15440 * @chainable
15441 */
15442 OO.ui.SelectWidget.prototype.removeItems = function ( items ) {
15443 var i, len, item;
15444
15445 // Deselect items being removed
15446 for ( i = 0, len = items.length; i < len; i++ ) {
15447 item = items[ i ];
15448 if ( item.isSelected() ) {
15449 this.selectItem( null );
15450 }
15451 }
15452
15453 // Mixin method
15454 OO.ui.GroupWidget.prototype.removeItems.call( this, items );
15455
15456 this.emit( 'remove', items );
15457
15458 return this;
15459 };
15460
15461 /**
15462 * Clear all options from the select. Options will be detached from the DOM, not removed,
15463 * so that they can be reused later. To remove a subset of options from the select, use
15464 * the #removeItems method.
15465 *
15466 * @fires remove
15467 * @chainable
15468 */
15469 OO.ui.SelectWidget.prototype.clearItems = function () {
15470 var items = this.items.slice();
15471
15472 // Mixin method
15473 OO.ui.GroupWidget.prototype.clearItems.call( this );
15474
15475 // Clear selection
15476 this.selectItem( null );
15477
15478 this.emit( 'remove', items );
15479
15480 return this;
15481 };
15482
15483 /**
15484 * ButtonSelectWidget is a {@link OO.ui.SelectWidget select widget} that contains
15485 * button options and is used together with
15486 * OO.ui.ButtonOptionWidget. The ButtonSelectWidget provides an interface for
15487 * highlighting, choosing, and selecting mutually exclusive options. Please see
15488 * the [OOjs UI documentation on MediaWiki] [1] for more information.
15489 *
15490 * @example
15491 * // Example: A ButtonSelectWidget that contains three ButtonOptionWidgets
15492 * var option1 = new OO.ui.ButtonOptionWidget( {
15493 * data: 1,
15494 * label: 'Option 1',
15495 * title: 'Button option 1'
15496 * } );
15497 *
15498 * var option2 = new OO.ui.ButtonOptionWidget( {
15499 * data: 2,
15500 * label: 'Option 2',
15501 * title: 'Button option 2'
15502 * } );
15503 *
15504 * var option3 = new OO.ui.ButtonOptionWidget( {
15505 * data: 3,
15506 * label: 'Option 3',
15507 * title: 'Button option 3'
15508 * } );
15509 *
15510 * var buttonSelect=new OO.ui.ButtonSelectWidget( {
15511 * items: [ option1, option2, option3 ]
15512 * } );
15513 * $( 'body' ).append( buttonSelect.$element );
15514 *
15515 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options
15516 *
15517 * @class
15518 * @extends OO.ui.SelectWidget
15519 * @mixins OO.ui.TabIndexedElement
15520 *
15521 * @constructor
15522 * @param {Object} [config] Configuration options
15523 */
15524 OO.ui.ButtonSelectWidget = function OoUiButtonSelectWidget( config ) {
15525 // Parent constructor
15526 OO.ui.ButtonSelectWidget.super.call( this, config );
15527
15528 // Mixin constructors
15529 OO.ui.TabIndexedElement.call( this, config );
15530
15531 // Events
15532 this.$element.on( {
15533 focus: this.bindKeyDownListener.bind( this ),
15534 blur: this.unbindKeyDownListener.bind( this )
15535 } );
15536
15537 // Initialization
15538 this.$element.addClass( 'oo-ui-buttonSelectWidget' );
15539 };
15540
15541 /* Setup */
15542
15543 OO.inheritClass( OO.ui.ButtonSelectWidget, OO.ui.SelectWidget );
15544 OO.mixinClass( OO.ui.ButtonSelectWidget, OO.ui.TabIndexedElement );
15545
15546 /**
15547 * RadioSelectWidget is a {@link OO.ui.SelectWidget select widget} that contains radio
15548 * options and is used together with OO.ui.RadioOptionWidget. The RadioSelectWidget provides
15549 * an interface for adding, removing and selecting options.
15550 * Please see the [OOjs UI documentation on MediaWiki][1] for more information.
15551 *
15552 * @example
15553 * // A RadioSelectWidget with RadioOptions.
15554 * var option1 = new OO.ui.RadioOptionWidget( {
15555 * data: 'a',
15556 * label: 'Selected radio option'
15557 * } );
15558 *
15559 * var option2 = new OO.ui.RadioOptionWidget( {
15560 * data: 'b',
15561 * label: 'Unselected radio option'
15562 * } );
15563 *
15564 * var radioSelect=new OO.ui.RadioSelectWidget( {
15565 * items: [ option1, option2 ]
15566 * } );
15567 *
15568 * // Select 'option 1' using the RadioSelectWidget's selectItem() method.
15569 * radioSelect.selectItem( option1 );
15570 *
15571 * $( 'body' ).append( radioSelect.$element );
15572 *
15573 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options
15574
15575 *
15576 * @class
15577 * @extends OO.ui.SelectWidget
15578 * @mixins OO.ui.TabIndexedElement
15579 *
15580 * @constructor
15581 * @param {Object} [config] Configuration options
15582 */
15583 OO.ui.RadioSelectWidget = function OoUiRadioSelectWidget( config ) {
15584 // Parent constructor
15585 OO.ui.RadioSelectWidget.super.call( this, config );
15586
15587 // Mixin constructors
15588 OO.ui.TabIndexedElement.call( this, config );
15589
15590 // Events
15591 this.$element.on( {
15592 focus: this.bindKeyDownListener.bind( this ),
15593 blur: this.unbindKeyDownListener.bind( this )
15594 } );
15595
15596 // Initialization
15597 this.$element.addClass( 'oo-ui-radioSelectWidget' );
15598 };
15599
15600 /* Setup */
15601
15602 OO.inheritClass( OO.ui.RadioSelectWidget, OO.ui.SelectWidget );
15603 OO.mixinClass( OO.ui.RadioSelectWidget, OO.ui.TabIndexedElement );
15604
15605 /**
15606 * MenuSelectWidget is a {@link OO.ui.SelectWidget select widget} that contains options and
15607 * is used together with OO.ui.MenuOptionWidget. It is designed be used as part of another widget.
15608 * See {@link OO.ui.DropdownWidget DropdownWidget}, {@link OO.ui.ComboBoxWidget ComboBoxWidget},
15609 * and {@link OO.ui.LookupElement LookupElement} for examples of widgets that contain menus.
15610 * MenuSelectWidgets themselves are not instantiated directly, rather subclassed
15611 * and customized to be opened, closed, and displayed as needed.
15612 *
15613 * By default, menus are clipped to the visible viewport and are not visible when a user presses the
15614 * mouse outside the menu.
15615 *
15616 * Menus also have support for keyboard interaction:
15617 *
15618 * - Enter/Return key: choose and select a menu option
15619 * - Up-arrow key: highlight the previous menu option
15620 * - Down-arrow key: highlight the next menu option
15621 * - Esc key: hide the menu
15622 *
15623 * Please see the [OOjs UI documentation on MediaWiki][1] for more information.
15624 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options
15625 *
15626 * @class
15627 * @extends OO.ui.SelectWidget
15628 * @mixins OO.ui.ClippableElement
15629 *
15630 * @constructor
15631 * @param {Object} [config] Configuration options
15632 * @cfg {OO.ui.TextInputWidget} [input] Text input used to implement option highlighting for menu items that match
15633 * the text the user types. This config is used by {@link OO.ui.ComboBoxWidget ComboBoxWidget}
15634 * and {@link OO.ui.LookupElement LookupElement}
15635 * @cfg {OO.ui.Widget} [widget] Widget associated with the menu’s active state. If the user clicks the mouse
15636 * anywhere on the page outside of this widget, the menu is hidden.
15637 * @cfg {boolean} [autoHide=true] Hide the menu when the mouse is pressed outside the menu.
15638 */
15639 OO.ui.MenuSelectWidget = function OoUiMenuSelectWidget( config ) {
15640 // Configuration initialization
15641 config = config || {};
15642
15643 // Parent constructor
15644 OO.ui.MenuSelectWidget.super.call( this, config );
15645
15646 // Mixin constructors
15647 OO.ui.ClippableElement.call( this, $.extend( {}, config, { $clippable: this.$group } ) );
15648
15649 // Properties
15650 this.newItems = null;
15651 this.autoHide = config.autoHide === undefined || !!config.autoHide;
15652 this.$input = config.input ? config.input.$input : null;
15653 this.$widget = config.widget ? config.widget.$element : null;
15654 this.onDocumentMouseDownHandler = this.onDocumentMouseDown.bind( this );
15655
15656 // Initialization
15657 this.$element
15658 .addClass( 'oo-ui-menuSelectWidget' )
15659 .attr( 'role', 'menu' );
15660
15661 // Initially hidden - using #toggle may cause errors if subclasses override toggle with methods
15662 // that reference properties not initialized at that time of parent class construction
15663 // TODO: Find a better way to handle post-constructor setup
15664 this.visible = false;
15665 this.$element.addClass( 'oo-ui-element-hidden' );
15666 };
15667
15668 /* Setup */
15669
15670 OO.inheritClass( OO.ui.MenuSelectWidget, OO.ui.SelectWidget );
15671 OO.mixinClass( OO.ui.MenuSelectWidget, OO.ui.ClippableElement );
15672
15673 /* Methods */
15674
15675 /**
15676 * Handles document mouse down events.
15677 *
15678 * @protected
15679 * @param {jQuery.Event} e Key down event
15680 */
15681 OO.ui.MenuSelectWidget.prototype.onDocumentMouseDown = function ( e ) {
15682 if (
15683 !OO.ui.contains( this.$element[ 0 ], e.target, true ) &&
15684 ( !this.$widget || !OO.ui.contains( this.$widget[ 0 ], e.target, true ) )
15685 ) {
15686 this.toggle( false );
15687 }
15688 };
15689
15690 /**
15691 * @inheritdoc
15692 */
15693 OO.ui.MenuSelectWidget.prototype.onKeyDown = function ( e ) {
15694 var currentItem = this.getHighlightedItem() || this.getSelectedItem();
15695
15696 if ( !this.isDisabled() && this.isVisible() ) {
15697 switch ( e.keyCode ) {
15698 case OO.ui.Keys.LEFT:
15699 case OO.ui.Keys.RIGHT:
15700 // Do nothing if a text field is associated, arrow keys will be handled natively
15701 if ( !this.$input ) {
15702 OO.ui.MenuSelectWidget.super.prototype.onKeyDown.call( this, e );
15703 }
15704 break;
15705 case OO.ui.Keys.ESCAPE:
15706 case OO.ui.Keys.TAB:
15707 if ( currentItem ) {
15708 currentItem.setHighlighted( false );
15709 }
15710 this.toggle( false );
15711 // Don't prevent tabbing away, prevent defocusing
15712 if ( e.keyCode === OO.ui.Keys.ESCAPE ) {
15713 e.preventDefault();
15714 e.stopPropagation();
15715 }
15716 break;
15717 default:
15718 OO.ui.MenuSelectWidget.super.prototype.onKeyDown.call( this, e );
15719 return;
15720 }
15721 }
15722 };
15723
15724 /**
15725 * @inheritdoc
15726 */
15727 OO.ui.MenuSelectWidget.prototype.bindKeyDownListener = function () {
15728 if ( this.$input ) {
15729 this.$input.on( 'keydown', this.onKeyDownHandler );
15730 } else {
15731 OO.ui.MenuSelectWidget.super.prototype.bindKeyDownListener.call( this );
15732 }
15733 };
15734
15735 /**
15736 * @inheritdoc
15737 */
15738 OO.ui.MenuSelectWidget.prototype.unbindKeyDownListener = function () {
15739 if ( this.$input ) {
15740 this.$input.off( 'keydown', this.onKeyDownHandler );
15741 } else {
15742 OO.ui.MenuSelectWidget.super.prototype.unbindKeyDownListener.call( this );
15743 }
15744 };
15745
15746 /**
15747 * Choose an item.
15748 *
15749 * When a user chooses an item, the menu is closed.
15750 *
15751 * Note that ‘choose’ should never be modified programmatically. A user can choose an option with the keyboard
15752 * or mouse and it becomes selected. To select an item programmatically, use the #selectItem method.
15753 * @param {OO.ui.OptionWidget} item Item to choose
15754 * @chainable
15755 */
15756 OO.ui.MenuSelectWidget.prototype.chooseItem = function ( item ) {
15757 OO.ui.MenuSelectWidget.super.prototype.chooseItem.call( this, item );
15758 this.toggle( false );
15759 return this;
15760 };
15761
15762 /**
15763 * @inheritdoc
15764 */
15765 OO.ui.MenuSelectWidget.prototype.addItems = function ( items, index ) {
15766 var i, len, item;
15767
15768 // Parent method
15769 OO.ui.MenuSelectWidget.super.prototype.addItems.call( this, items, index );
15770
15771 // Auto-initialize
15772 if ( !this.newItems ) {
15773 this.newItems = [];
15774 }
15775
15776 for ( i = 0, len = items.length; i < len; i++ ) {
15777 item = items[ i ];
15778 if ( this.isVisible() ) {
15779 // Defer fitting label until item has been attached
15780 item.fitLabel();
15781 } else {
15782 this.newItems.push( item );
15783 }
15784 }
15785
15786 // Reevaluate clipping
15787 this.clip();
15788
15789 return this;
15790 };
15791
15792 /**
15793 * @inheritdoc
15794 */
15795 OO.ui.MenuSelectWidget.prototype.removeItems = function ( items ) {
15796 // Parent method
15797 OO.ui.MenuSelectWidget.super.prototype.removeItems.call( this, items );
15798
15799 // Reevaluate clipping
15800 this.clip();
15801
15802 return this;
15803 };
15804
15805 /**
15806 * @inheritdoc
15807 */
15808 OO.ui.MenuSelectWidget.prototype.clearItems = function () {
15809 // Parent method
15810 OO.ui.MenuSelectWidget.super.prototype.clearItems.call( this );
15811
15812 // Reevaluate clipping
15813 this.clip();
15814
15815 return this;
15816 };
15817
15818 /**
15819 * @inheritdoc
15820 */
15821 OO.ui.MenuSelectWidget.prototype.toggle = function ( visible ) {
15822 visible = ( visible === undefined ? !this.visible : !!visible ) && !!this.items.length;
15823
15824 var i, len,
15825 change = visible !== this.isVisible();
15826
15827 // Parent method
15828 OO.ui.MenuSelectWidget.super.prototype.toggle.call( this, visible );
15829
15830 if ( change ) {
15831 if ( visible ) {
15832 this.bindKeyDownListener();
15833
15834 if ( this.newItems && this.newItems.length ) {
15835 for ( i = 0, len = this.newItems.length; i < len; i++ ) {
15836 this.newItems[ i ].fitLabel();
15837 }
15838 this.newItems = null;
15839 }
15840 this.toggleClipping( true );
15841
15842 // Auto-hide
15843 if ( this.autoHide ) {
15844 this.getElementDocument().addEventListener(
15845 'mousedown', this.onDocumentMouseDownHandler, true
15846 );
15847 }
15848 } else {
15849 this.unbindKeyDownListener();
15850 this.getElementDocument().removeEventListener(
15851 'mousedown', this.onDocumentMouseDownHandler, true
15852 );
15853 this.toggleClipping( false );
15854 }
15855 }
15856
15857 return this;
15858 };
15859
15860 /**
15861 * TextInputMenuSelectWidget is a menu that is specially designed to be positioned beneath
15862 * a {@link OO.ui.TextInputWidget text input} field. The menu's position is automatically
15863 * calculated and maintained when the menu is toggled or the window is resized.
15864 * See OO.ui.ComboBoxWidget for an example of a widget that uses this class.
15865 *
15866 * @class
15867 * @extends OO.ui.MenuSelectWidget
15868 *
15869 * @constructor
15870 * @param {OO.ui.TextInputWidget} inputWidget Text input widget to provide menu for
15871 * @param {Object} [config] Configuration options
15872 * @cfg {jQuery} [$container=input.$element] Element to render menu under
15873 */
15874 OO.ui.TextInputMenuSelectWidget = function OoUiTextInputMenuSelectWidget( inputWidget, config ) {
15875 // Allow passing positional parameters inside the config object
15876 if ( OO.isPlainObject( inputWidget ) && config === undefined ) {
15877 config = inputWidget;
15878 inputWidget = config.inputWidget;
15879 }
15880
15881 // Configuration initialization
15882 config = config || {};
15883
15884 // Parent constructor
15885 OO.ui.TextInputMenuSelectWidget.super.call( this, config );
15886
15887 // Properties
15888 this.inputWidget = inputWidget;
15889 this.$container = config.$container || this.inputWidget.$element;
15890 this.onWindowResizeHandler = this.onWindowResize.bind( this );
15891
15892 // Initialization
15893 this.$element.addClass( 'oo-ui-textInputMenuSelectWidget' );
15894 };
15895
15896 /* Setup */
15897
15898 OO.inheritClass( OO.ui.TextInputMenuSelectWidget, OO.ui.MenuSelectWidget );
15899
15900 /* Methods */
15901
15902 /**
15903 * Handle window resize event.
15904 *
15905 * @private
15906 * @param {jQuery.Event} e Window resize event
15907 */
15908 OO.ui.TextInputMenuSelectWidget.prototype.onWindowResize = function () {
15909 this.position();
15910 };
15911
15912 /**
15913 * @inheritdoc
15914 */
15915 OO.ui.TextInputMenuSelectWidget.prototype.toggle = function ( visible ) {
15916 visible = visible === undefined ? !this.isVisible() : !!visible;
15917
15918 var change = visible !== this.isVisible();
15919
15920 if ( change && visible ) {
15921 // Make sure the width is set before the parent method runs.
15922 // After this we have to call this.position(); again to actually
15923 // position ourselves correctly.
15924 this.position();
15925 }
15926
15927 // Parent method
15928 OO.ui.TextInputMenuSelectWidget.super.prototype.toggle.call( this, visible );
15929
15930 if ( change ) {
15931 if ( this.isVisible() ) {
15932 this.position();
15933 $( this.getElementWindow() ).on( 'resize', this.onWindowResizeHandler );
15934 } else {
15935 $( this.getElementWindow() ).off( 'resize', this.onWindowResizeHandler );
15936 }
15937 }
15938
15939 return this;
15940 };
15941
15942 /**
15943 * Position the menu.
15944 *
15945 * @private
15946 * @chainable
15947 */
15948 OO.ui.TextInputMenuSelectWidget.prototype.position = function () {
15949 var $container = this.$container,
15950 pos = OO.ui.Element.static.getRelativePosition( $container, this.$element.offsetParent() );
15951
15952 // Position under input
15953 pos.top += $container.height();
15954 this.$element.css( pos );
15955
15956 // Set width
15957 this.setIdealSize( $container.width() );
15958 // We updated the position, so re-evaluate the clipping state
15959 this.clip();
15960
15961 return this;
15962 };
15963
15964 /**
15965 * OutlineSelectWidget is a structured list that contains {@link OO.ui.OutlineOptionWidget outline options}
15966 * A set of controls can be provided with an {@link OO.ui.OutlineControlsWidget outline controls} widget.
15967 *
15968 * ####Currently, this class is only used by {@link OO.ui.BookletLayout booklet layouts}.####
15969 *
15970 * @class
15971 * @extends OO.ui.SelectWidget
15972 * @mixins OO.ui.TabIndexedElement
15973 *
15974 * @constructor
15975 * @param {Object} [config] Configuration options
15976 */
15977 OO.ui.OutlineSelectWidget = function OoUiOutlineSelectWidget( config ) {
15978 // Parent constructor
15979 OO.ui.OutlineSelectWidget.super.call( this, config );
15980
15981 // Mixin constructors
15982 OO.ui.TabIndexedElement.call( this, config );
15983
15984 // Events
15985 this.$element.on( {
15986 focus: this.bindKeyDownListener.bind( this ),
15987 blur: this.unbindKeyDownListener.bind( this )
15988 } );
15989
15990 // Initialization
15991 this.$element.addClass( 'oo-ui-outlineSelectWidget' );
15992 };
15993
15994 /* Setup */
15995
15996 OO.inheritClass( OO.ui.OutlineSelectWidget, OO.ui.SelectWidget );
15997 OO.mixinClass( OO.ui.OutlineSelectWidget, OO.ui.TabIndexedElement );
15998
15999 /**
16000 * TabSelectWidget is a list that contains {@link OO.ui.TabOptionWidget tab options}
16001 *
16002 * ####Currently, this class is only used by {@link OO.ui.IndexLayout index layouts}.####
16003 *
16004 * @class
16005 * @extends OO.ui.SelectWidget
16006 * @mixins OO.ui.TabIndexedElement
16007 *
16008 * @constructor
16009 * @param {Object} [config] Configuration options
16010 */
16011 OO.ui.TabSelectWidget = function OoUiTabSelectWidget( config ) {
16012 // Parent constructor
16013 OO.ui.TabSelectWidget.super.call( this, config );
16014
16015 // Mixin constructors
16016 OO.ui.TabIndexedElement.call( this, config );
16017
16018 // Events
16019 this.$element.on( {
16020 focus: this.bindKeyDownListener.bind( this ),
16021 blur: this.unbindKeyDownListener.bind( this )
16022 } );
16023
16024 // Initialization
16025 this.$element.addClass( 'oo-ui-tabSelectWidget' );
16026 };
16027
16028 /* Setup */
16029
16030 OO.inheritClass( OO.ui.TabSelectWidget, OO.ui.SelectWidget );
16031 OO.mixinClass( OO.ui.TabSelectWidget, OO.ui.TabIndexedElement );
16032
16033 /**
16034 * ToggleSwitches are switches that slide on and off. Their state is represented by a Boolean
16035 * value (`true` for ‘on’, and `false` otherwise, the default). The ‘off’ state is represented
16036 * visually by a slider in the leftmost position.
16037 *
16038 * @example
16039 * // Toggle switches in the 'off' and 'on' position.
16040 * var toggleSwitch1 = new OO.ui.ToggleSwitchWidget();
16041 * var toggleSwitch2 = new OO.ui.ToggleSwitchWidget( {
16042 * value: true
16043 * } );
16044 *
16045 * // Create a FieldsetLayout to layout and label switches
16046 * var fieldset = new OO.ui.FieldsetLayout( {
16047 * label: 'Toggle switches'
16048 * } );
16049 * fieldset.addItems( [
16050 * new OO.ui.FieldLayout( toggleSwitch1, { label: 'Off', align: 'top' } ),
16051 * new OO.ui.FieldLayout( toggleSwitch2, { label: 'On', align: 'top' } )
16052 * ] );
16053 * $( 'body' ).append( fieldset.$element );
16054 *
16055 * @class
16056 * @extends OO.ui.ToggleWidget
16057 * @mixins OO.ui.TabIndexedElement
16058 *
16059 * @constructor
16060 * @param {Object} [config] Configuration options
16061 * @cfg {boolean} [value=false] The toggle switch’s initial on/off state.
16062 * By default, the toggle switch is in the 'off' position.
16063 */
16064 OO.ui.ToggleSwitchWidget = function OoUiToggleSwitchWidget( config ) {
16065 // Parent constructor
16066 OO.ui.ToggleSwitchWidget.super.call( this, config );
16067
16068 // Mixin constructors
16069 OO.ui.TabIndexedElement.call( this, config );
16070
16071 // Properties
16072 this.dragging = false;
16073 this.dragStart = null;
16074 this.sliding = false;
16075 this.$glow = $( '<span>' );
16076 this.$grip = $( '<span>' );
16077
16078 // Events
16079 this.$element.on( {
16080 click: this.onClick.bind( this ),
16081 keypress: this.onKeyPress.bind( this )
16082 } );
16083
16084 // Initialization
16085 this.$glow.addClass( 'oo-ui-toggleSwitchWidget-glow' );
16086 this.$grip.addClass( 'oo-ui-toggleSwitchWidget-grip' );
16087 this.$element
16088 .addClass( 'oo-ui-toggleSwitchWidget' )
16089 .attr( 'role', 'checkbox' )
16090 .append( this.$glow, this.$grip );
16091 };
16092
16093 /* Setup */
16094
16095 OO.inheritClass( OO.ui.ToggleSwitchWidget, OO.ui.ToggleWidget );
16096 OO.mixinClass( OO.ui.ToggleSwitchWidget, OO.ui.TabIndexedElement );
16097
16098 /* Methods */
16099
16100 /**
16101 * Handle mouse click events.
16102 *
16103 * @private
16104 * @param {jQuery.Event} e Mouse click event
16105 */
16106 OO.ui.ToggleSwitchWidget.prototype.onClick = function ( e ) {
16107 if ( !this.isDisabled() && e.which === 1 ) {
16108 this.setValue( !this.value );
16109 }
16110 return false;
16111 };
16112
16113 /**
16114 * Handle key press events.
16115 *
16116 * @private
16117 * @param {jQuery.Event} e Key press event
16118 */
16119 OO.ui.ToggleSwitchWidget.prototype.onKeyPress = function ( e ) {
16120 if ( !this.isDisabled() && ( e.which === OO.ui.Keys.SPACE || e.which === OO.ui.Keys.ENTER ) ) {
16121 this.setValue( !this.value );
16122 return false;
16123 }
16124 };
16125
16126 }( OO ) );