resources/lib/oojs-ui/oojs-ui-widgets.js

   1 /*!
   2  * OOjs UI v0.22.1
   3  * https://www.mediawiki.org/wiki/OOjs_UI
   4  *
   5  * Copyright 2011–2017 OOjs UI Team and other contributors.
   6  * Released under the MIT license
   7  * http://oojs.mit-license.org
   8  *
   9  * Date: 2017-05-31T19:07:36Z
  10  */
  11 ( function ( OO ) {
  12
  13 'use strict';
  14
  15 /**
  16  * DraggableElement is a mixin class used to create elements that can be clicked
  17  * and dragged by a mouse to a new position within a group. This class must be used
  18  * in conjunction with OO.ui.mixin.DraggableGroupElement, which provides a container for
  19  * the draggable elements.
  20  *
  21  * @abstract
  22  * @class
  23  *
  24  * @constructor
  25  * @param {Object} [config] Configuration options
  26  * @cfg {jQuery} [$handle] The part of the element which can be used for dragging, defaults to the whole element
  27  * @cfg {boolean} [draggable] The items are draggable. This can change with #toggleDraggable
  28  *  but the draggable state should be called from the DraggableGroupElement, which updates
  29  *  the whole group
  30  */
  31 OO.ui.mixin.DraggableElement = function OoUiMixinDraggableElement( config ) {
  32         config = config || {};
  33
  34         // Properties
  35         this.index = null;
  36         this.$handle = config.$handle || this.$element;
  37         this.wasHandleUsed = null;
  38         this.draggable = config.draggable === undefined ? true : !!config.draggable;
  39
  40         // Initialize and events
  41         this.$element.addClass( 'oo-ui-draggableElement' )
  42                 // We make the entire element draggable, not just the handle, so that
  43                 // the whole element appears to move. wasHandleUsed prevents drags from
  44                 // starting outside the handle
  45                 .attr( 'draggable', true )
  46                 .on( {
  47                         mousedown: this.onDragMouseDown.bind( this ),
  48                         dragstart: this.onDragStart.bind( this ),
  49                         dragover: this.onDragOver.bind( this ),
  50                         dragend: this.onDragEnd.bind( this ),
  51                         drop: this.onDrop.bind( this )
  52                 } );
  53         this.$handle.addClass( 'oo-ui-draggableElement-handle' );
  54 };
  55
  56 OO.initClass( OO.ui.mixin.DraggableElement );
  57
  58 /* Events */
  59
  60 /**
  61  * @event dragstart
  62  *
  63  * A dragstart event is emitted when the user clicks and begins dragging an item.
  64  * @param {OO.ui.mixin.DraggableElement} item The item the user has clicked and is dragging with the mouse.
  65  */
  66
  67 /**
  68  * @event dragend
  69  * A dragend event is emitted when the user drags an item and releases the mouse,
  70  * thus terminating the drag operation.
  71  */
  72
  73 /**
  74  * @event drop
  75  * A drop event is emitted when the user drags an item and then releases the mouse button
  76  * over a valid target.
  77  */
  78
  79 /* Static Properties */
  80
  81 /**
  82  * @inheritdoc OO.ui.mixin.ButtonElement
  83  */
  84 OO.ui.mixin.DraggableElement.static.cancelButtonMouseDownEvents = false;
  85
  86 /* Methods */
  87
  88 /**
  89  * Change the draggable state of this widget.
  90  * This allows users to temporarily halt the dragging operations.
  91  *
  92  * @param {boolean} isDraggable Widget supports draggable operations
  93  * @fires draggable
  94  */
  95 OO.ui.mixin.DraggableElement.prototype.toggleDraggable = function ( isDraggable ) {
  96         isDraggable = isDraggable !== undefined ? !!isDraggable : !this.draggable;
  97
  98         if ( this.draggable !== isDraggable ) {
  99                 this.draggable = isDraggable;
 100
 101                 this.$handle.toggleClass( 'oo-ui-draggableElement-undraggable', !this.draggable );
 102         }
 103 };
 104
 105 /**
 106  * Check the draggable state of this widget
 107  *
 108  * @return {boolean} Widget supports draggable operations
 109  */
 110 OO.ui.mixin.DraggableElement.prototype.isDraggable = function () {
 111         return this.draggable;
 112 };
 113
 114 /**
 115  * Respond to mousedown event.
 116  *
 117  * @private
 118  * @param {jQuery.Event} e Drag event
 119  */
 120 OO.ui.mixin.DraggableElement.prototype.onDragMouseDown = function ( e ) {
 121         if ( !this.isDraggable() ) {
 122                 return;
 123         }
 124
 125         this.wasHandleUsed =
 126                 // Optimization: if the handle is the whole element this is always true
 127                 this.$handle[ 0 ] === this.$element[ 0 ] ||
 128                 // Check the mousedown occurred inside the handle
 129                 OO.ui.contains( this.$handle[ 0 ], e.target, true );
 130 };
 131
 132 /**
 133  * Respond to dragstart event.
 134  *
 135  * @private
 136  * @param {jQuery.Event} e Drag event
 137  * @return {boolean} False if the event is cancelled
 138  * @fires dragstart
 139  */
 140 OO.ui.mixin.DraggableElement.prototype.onDragStart = function ( e ) {
 141         var element = this,
 142                 dataTransfer = e.originalEvent.dataTransfer;
 143
 144         if ( !this.wasHandleUsed || !this.isDraggable() ) {
 145                 return false;
 146         }
 147
 148         // Define drop effect
 149         dataTransfer.dropEffect = 'none';
 150         dataTransfer.effectAllowed = 'move';
 151         // Support: Firefox
 152         // We must set up a dataTransfer data property or Firefox seems to
 153         // ignore the fact the element is draggable.
 154         try {
 155                 dataTransfer.setData( 'application-x/OOjs-UI-draggable', this.getIndex() );
 156         } catch ( err ) {
 157                 // The above is only for Firefox. Move on if it fails.
 158         }
 159         // Briefly add a 'clone' class to style the browser's native drag image
 160         this.$element.addClass( 'oo-ui-draggableElement-clone' );
 161         // Add placeholder class after the browser has rendered the clone
 162         setTimeout( function () {
 163                 element.$element
 164                         .removeClass( 'oo-ui-draggableElement-clone' )
 165                         .addClass( 'oo-ui-draggableElement-placeholder' );
 166         } );
 167         // Emit event
 168         this.emit( 'dragstart', this );
 169         return true;
 170 };
 171
 172 /**
 173  * Respond to dragend event.
 174  *
 175  * @private
 176  * @fires dragend
 177  */
 178 OO.ui.mixin.DraggableElement.prototype.onDragEnd = function () {
 179         this.$element.removeClass( 'oo-ui-draggableElement-placeholder' );
 180         this.emit( 'dragend' );
 181 };
 182
 183 /**
 184  * Handle drop event.
 185  *
 186  * @private
 187  * @param {jQuery.Event} e Drop event
 188  * @fires drop
 189  */
 190 OO.ui.mixin.DraggableElement.prototype.onDrop = function ( e ) {
 191         e.preventDefault();
 192         this.emit( 'drop', e );
 193 };
 194
 195 /**
 196  * In order for drag/drop to work, the dragover event must
 197  * return false and stop propogation.
 198  *
 199  * @param {jQuery.Event} e Drag event
 200  * @private
 201  */
 202 OO.ui.mixin.DraggableElement.prototype.onDragOver = function ( e ) {
 203         e.preventDefault();
 204 };
 205
 206 /**
 207  * Set item index.
 208  * Store it in the DOM so we can access from the widget drag event
 209  *
 210  * @private
 211  * @param {number} index Item index
 212  */
 213 OO.ui.mixin.DraggableElement.prototype.setIndex = function ( index ) {
 214         if ( this.index !== index ) {
 215                 this.index = index;
 216                 this.$element.data( 'index', index );
 217         }
 218 };
 219
 220 /**
 221  * Get item index
 222  *
 223  * @private
 224  * @return {number} Item index
 225  */
 226 OO.ui.mixin.DraggableElement.prototype.getIndex = function () {
 227         return this.index;
 228 };
 229
 230 /**
 231  * DraggableGroupElement is a mixin class used to create a group element to
 232  * contain draggable elements, which are items that can be clicked and dragged by a mouse.
 233  * The class is used with OO.ui.mixin.DraggableElement.
 234  *
 235  * @abstract
 236  * @class
 237  * @mixins OO.ui.mixin.GroupElement
 238  *
 239  * @constructor
 240  * @param {Object} [config] Configuration options
 241  * @cfg {string} [orientation] Item orientation: 'horizontal' or 'vertical'. The orientation
 242  *  should match the layout of the items. Items displayed in a single row
 243  *  or in several rows should use horizontal orientation. The vertical orientation should only be
 244  *  used when the items are displayed in a single column. Defaults to 'vertical'
 245  * @cfg {boolean} [draggable] The items are draggable. This can change with #toggleDraggable
 246  */
 247 OO.ui.mixin.DraggableGroupElement = function OoUiMixinDraggableGroupElement( config ) {
 248         // Configuration initialization
 249         config = config || {};
 250
 251         // Parent constructor
 252         OO.ui.mixin.GroupElement.call( this, config );
 253
 254         // Properties
 255         this.orientation = config.orientation || 'vertical';
 256         this.dragItem = null;
 257         this.itemKeys = {};
 258         this.dir = null;
 259         this.itemsOrder = null;
 260         this.draggable = config.draggable === undefined ? true : !!config.draggable;
 261
 262         // Events
 263         this.aggregate( {
 264                 dragstart: 'itemDragStart',
 265                 dragend: 'itemDragEnd',
 266                 drop: 'itemDrop'
 267         } );
 268         this.connect( this, {
 269                 itemDragStart: 'onItemDragStart',
 270                 itemDrop: 'onItemDropOrDragEnd',
 271                 itemDragEnd: 'onItemDropOrDragEnd'
 272         } );
 273
 274         // Initialize
 275         if ( Array.isArray( config.items ) ) {
 276                 this.addItems( config.items );
 277         }
 278         this.$element
 279                 .addClass( 'oo-ui-draggableGroupElement' )
 280                 .attr( 'role', 'listbox' )
 281                 .append( this.$status )
 282                 .toggleClass( 'oo-ui-draggableGroupElement-horizontal', this.orientation === 'horizontal' );
 283 };
 284
 285 /* Setup */
 286 OO.mixinClass( OO.ui.mixin.DraggableGroupElement, OO.ui.mixin.GroupElement );
 287
 288 /* Events */
 289
 290 /**
 291  * An item has been dragged to a new position, but not yet dropped.
 292  *
 293  * @event drag
 294  * @param {OO.ui.mixin.DraggableElement} item Dragged item
 295  * @param {number} [newIndex] New index for the item
 296  */
 297
 298 /**
 299  * An item has been dropped at a new position.
 300  *
 301  * @event reorder
 302  * @param {OO.ui.mixin.DraggableElement} item Reordered item
 303  * @param {number} [newIndex] New index for the item
 304  */
 305
 306 /**
 307  * Draggable state of this widget has changed.
 308  *
 309  * @event draggable
 310  * @param {boolean} [draggable] Widget is draggable
 311  */
 312
 313 /* Methods */
 314
 315 /**
 316  * Change the draggable state of this widget.
 317  * This allows users to temporarily halt the dragging operations.
 318  *
 319  * @param {boolean} isDraggable Widget supports draggable operations
 320  * @fires draggable
 321  */
 322 OO.ui.mixin.DraggableGroupElement.prototype.toggleDraggable = function ( isDraggable ) {
 323         isDraggable = isDraggable !== undefined ? !!isDraggable : !this.draggable;
 324
 325         if ( this.draggable !== isDraggable ) {
 326                 this.draggable = isDraggable;
 327
 328                 // Tell the items their draggable state changed
 329                 this.getItems().forEach( function ( item ) {
 330                         item.toggleDraggable( this.draggable );
 331                 }.bind( this ) );
 332
 333                 // Emit event
 334                 this.emit( 'draggable', this.draggable );
 335         }
 336 };
 337
 338 /**
 339  * Check the draggable state of this widget
 340  *
 341  * @return {boolean} Widget supports draggable operations
 342  */
 343 OO.ui.mixin.DraggableGroupElement.prototype.isDraggable = function () {
 344         return this.draggable;
 345 };
 346
 347 /**
 348  * Respond to item drag start event
 349  *
 350  * @private
 351  * @param {OO.ui.mixin.DraggableElement} item Dragged item
 352  */
 353 OO.ui.mixin.DraggableGroupElement.prototype.onItemDragStart = function ( item ) {
 354         if ( !this.isDraggable() ) {
 355                 return;
 356         }
 357         // Make a shallow copy of this.items so we can re-order it during previews
 358         // without affecting the original array.
 359         this.itemsOrder = this.items.slice();
 360         this.updateIndexes();
 361         if ( this.orientation === 'horizontal' ) {
 362                 // Calculate and cache directionality on drag start - it's a little
 363                 // expensive and it shouldn't change while dragging.
 364                 this.dir = this.$element.css( 'direction' );
 365         }
 366         this.setDragItem( item );
 367 };
 368
 369 /**
 370  * Update the index properties of the items
 371  */
 372 OO.ui.mixin.DraggableGroupElement.prototype.updateIndexes = function () {
 373         var i, len;
 374
 375         // Map the index of each object
 376         for ( i = 0, len = this.itemsOrder.length; i < len; i++ ) {
 377                 this.itemsOrder[ i ].setIndex( i );
 378         }
 379 };
 380
 381 /**
 382  * Handle drop or dragend event and switch the order of the items accordingly
 383  *
 384  * @private
 385  * @param {OO.ui.mixin.DraggableElement} item Dropped item
 386  */
 387 OO.ui.mixin.DraggableGroupElement.prototype.onItemDropOrDragEnd = function () {
 388         var targetIndex, originalIndex,
 389                 item = this.getDragItem();
 390
 391         // TODO: Figure out a way to configure a list of legally droppable
 392         // elements even if they are not yet in the list
 393         if ( item ) {
 394                 originalIndex = this.items.indexOf( item );
 395                 // If the item has moved forward, add one to the index to account for the left shift
 396                 targetIndex = item.getIndex() + ( item.getIndex() > originalIndex ? 1 : 0 );
 397                 if ( targetIndex !== originalIndex ) {
 398                         this.reorder( this.getDragItem(), targetIndex );
 399                         this.emit( 'reorder', this.getDragItem(), targetIndex );
 400                 }
 401                 this.updateIndexes();
 402         }
 403         this.unsetDragItem();
 404         // Return false to prevent propogation
 405         return false;
 406 };
 407
 408 /**
 409  * Respond to dragover event
 410  *
 411  * @private
 412  * @param {jQuery.Event} e Dragover event
 413  * @fires reorder
 414  */
 415 OO.ui.mixin.DraggableGroupElement.prototype.onDragOver = function ( e ) {
 416         var overIndex, targetIndex,
 417                 item = this.getDragItem(),
 418                 dragItemIndex = item.getIndex();
 419
 420         // Get the OptionWidget item we are dragging over
 421         overIndex = $( e.target ).closest( '.oo-ui-draggableElement' ).data( 'index' );
 422
 423         if ( overIndex !== undefined && overIndex !== dragItemIndex ) {
 424                 targetIndex = overIndex + ( overIndex > dragItemIndex ? 1 : 0 );
 425
 426                 if ( targetIndex > 0 ) {
 427                         this.$group.children().eq( targetIndex - 1 ).after( item.$element );
 428                 } else {
 429                         this.$group.prepend( item.$element );
 430                 }
 431                 // Move item in itemsOrder array
 432                 this.itemsOrder.splice( overIndex, 0,
 433                         this.itemsOrder.splice( dragItemIndex, 1 )[ 0 ]
 434                 );
 435                 this.updateIndexes();
 436                 this.emit( 'drag', item, targetIndex );
 437         }
 438         // Prevent default
 439         e.preventDefault();
 440 };
 441
 442 /**
 443  * Reorder the items in the group
 444  *
 445  * @param {OO.ui.mixin.DraggableElement} item Reordered item
 446  * @param {number} newIndex New index
 447  */
 448 OO.ui.mixin.DraggableGroupElement.prototype.reorder = function ( item, newIndex ) {
 449         this.addItems( [ item ], newIndex );
 450 };
 451
 452 /**
 453  * Set a dragged item
 454  *
 455  * @param {OO.ui.mixin.DraggableElement} item Dragged item
 456  */
 457 OO.ui.mixin.DraggableGroupElement.prototype.setDragItem = function ( item ) {
 458         if ( this.dragItem !== item ) {
 459                 this.dragItem = item;
 460                 this.$element.on( 'dragover', this.onDragOver.bind( this ) );
 461                 this.$element.addClass( 'oo-ui-draggableGroupElement-dragging' );
 462         }
 463 };
 464
 465 /**
 466  * Unset the current dragged item
 467  */
 468 OO.ui.mixin.DraggableGroupElement.prototype.unsetDragItem = function () {
 469         if ( this.dragItem ) {
 470                 this.dragItem = null;
 471                 this.$element.off( 'dragover' );
 472                 this.$element.removeClass( 'oo-ui-draggableGroupElement-dragging' );
 473         }
 474 };
 475
 476 /**
 477  * Get the item that is currently being dragged.
 478  *
 479  * @return {OO.ui.mixin.DraggableElement|null} The currently dragged item, or `null` if no item is being dragged
 480  */
 481 OO.ui.mixin.DraggableGroupElement.prototype.getDragItem = function () {
 482         return this.dragItem;
 483 };
 484
 485 /**
 486  * RequestManager is a mixin that manages the lifecycle of a promise-backed request for a widget, such as
 487  * the {@link OO.ui.mixin.LookupElement}.
 488  *
 489  * @class
 490  * @abstract
 491  *
 492  * @constructor
 493  */
 494 OO.ui.mixin.RequestManager = function OoUiMixinRequestManager() {
 495         this.requestCache = {};
 496         this.requestQuery = null;
 497         this.requestRequest = null;
 498 };
 499
 500 /* Setup */
 501
 502 OO.initClass( OO.ui.mixin.RequestManager );
 503
 504 /**
 505  * Get request results for the current query.
 506  *
 507  * @return {jQuery.Promise} Promise object which will be passed response data as the first argument of
 508  *   the done event. If the request was aborted to make way for a subsequent request, this promise
 509  *   may not be rejected, depending on what jQuery feels like doing.
 510  */
 511 OO.ui.mixin.RequestManager.prototype.getRequestData = function () {
 512         var widget = this,
 513                 value = this.getRequestQuery(),
 514                 deferred = $.Deferred(),
 515                 ourRequest;
 516
 517         this.abortRequest();
 518         if ( Object.prototype.hasOwnProperty.call( this.requestCache, value ) ) {
 519                 deferred.resolve( this.requestCache[ value ] );
 520         } else {
 521                 if ( this.pushPending ) {
 522                         this.pushPending();
 523                 }
 524                 this.requestQuery = value;
 525                 ourRequest = this.requestRequest = this.getRequest();
 526                 ourRequest
 527                         .always( function () {
 528                                 // We need to pop pending even if this is an old request, otherwise
 529                                 // the widget will remain pending forever.
 530                                 // TODO: this assumes that an aborted request will fail or succeed soon after
 531                                 // being aborted, or at least eventually. It would be nice if we could popPending()
 532                                 // at abort time, but only if we knew that we hadn't already called popPending()
 533                                 // for that request.
 534                                 if ( widget.popPending ) {
 535                                         widget.popPending();
 536                                 }
 537                         } )
 538                         .done( function ( response ) {
 539                                 // If this is an old request (and aborting it somehow caused it to still succeed),
 540                                 // ignore its success completely
 541                                 if ( ourRequest === widget.requestRequest ) {
 542                                         widget.requestQuery = null;
 543                                         widget.requestRequest = null;
 544                                         widget.requestCache[ value ] = widget.getRequestCacheDataFromResponse( response );
 545                                         deferred.resolve( widget.requestCache[ value ] );
 546                                 }
 547                         } )
 548                         .fail( function () {
 549                                 // If this is an old request (or a request failing because it's being aborted),
 550                                 // ignore its failure completely
 551                                 if ( ourRequest === widget.requestRequest ) {
 552                                         widget.requestQuery = null;
 553                                         widget.requestRequest = null;
 554                                         deferred.reject();
 555                                 }
 556                         } );
 557         }
 558         return deferred.promise();
 559 };
 560
 561 /**
 562  * Abort the currently pending request, if any.
 563  *
 564  * @private
 565  */
 566 OO.ui.mixin.RequestManager.prototype.abortRequest = function () {
 567         var oldRequest = this.requestRequest;
 568         if ( oldRequest ) {
 569                 // First unset this.requestRequest to the fail handler will notice
 570                 // that the request is no longer current
 571                 this.requestRequest = null;
 572                 this.requestQuery = null;
 573                 oldRequest.abort();
 574         }
 575 };
 576
 577 /**
 578  * Get the query to be made.
 579  *
 580  * @protected
 581  * @method
 582  * @abstract
 583  * @return {string} query to be used
 584  */
 585 OO.ui.mixin.RequestManager.prototype.getRequestQuery = null;
 586
 587 /**
 588  * Get a new request object of the current query value.
 589  *
 590  * @protected
 591  * @method
 592  * @abstract
 593  * @return {jQuery.Promise} jQuery AJAX object, or promise object with an .abort() method
 594  */
 595 OO.ui.mixin.RequestManager.prototype.getRequest = null;
 596
 597 /**
 598  * Pre-process data returned by the request from #getRequest.
 599  *
 600  * The return value of this function will be cached, and any further queries for the given value
 601  * will use the cache rather than doing API requests.
 602  *
 603  * @protected
 604  * @method
 605  * @abstract
 606  * @param {Mixed} response Response from server
 607  * @return {Mixed} Cached result data
 608  */
 609 OO.ui.mixin.RequestManager.prototype.getRequestCacheDataFromResponse = null;
 610
 611 /**
 612  * LookupElement is a mixin that creates a {@link OO.ui.MenuSelectWidget menu} of suggested values for
 613  * a {@link OO.ui.TextInputWidget text input widget}. Suggested values are based on the characters the user types
 614  * into the text input field and, in general, the menu is only displayed when the user types. If a suggested value is chosen
 615  * from the lookup menu, that value becomes the value of the input field.
 616  *
 617  * Note that a new menu of suggested items is displayed when a value is chosen from the lookup menu. If this is
 618  * not the desired behavior, disable lookup menus with the #setLookupsDisabled method, then set the value, then
 619  * re-enable lookups.
 620  *
 621  * See the [OOjs UI demos][1] for an example.
 622  *
 623  * [1]: https://tools.wmflabs.org/oojs-ui/oojs-ui/demos/index.html#widgets-apex-vector-ltr
 624  *
 625  * @class
 626  * @abstract
 627  * @mixins OO.ui.mixin.RequestManager
 628  *
 629  * @constructor
 630  * @param {Object} [config] Configuration options
 631  * @cfg {jQuery} [$overlay] Overlay for the lookup menu; defaults to relative positioning.
 632  *  See <https://www.mediawiki.org/wiki/OOjs_UI/Concepts#Overlays>.
 633  * @cfg {jQuery} [$container=this.$element] The container element. The lookup menu is rendered beneath the specified element.
 634  * @cfg {boolean} [allowSuggestionsWhenEmpty=false] Request and display a lookup menu when the text input is empty.
 635  *  By default, the lookup menu is not generated and displayed until the user begins to type.
 636  * @cfg {boolean} [highlightFirst=true] Whether the first lookup result should be highlighted (so, that the user can
 637  *  take it over into the input with simply pressing return) automatically or not.
 638  */
 639 OO.ui.mixin.LookupElement = function OoUiMixinLookupElement( config ) {
 640         // Configuration initialization
 641         config = $.extend( { highlightFirst: true }, config );
 642
 643         // Mixin constructors
 644         OO.ui.mixin.RequestManager.call( this, config );
 645
 646         // Properties
 647         this.$overlay = config.$overlay || this.$element;
 648         this.lookupMenu = new OO.ui.MenuSelectWidget( {
 649                 widget: this,
 650                 input: this,
 651                 $floatableContainer: config.$container || this.$element
 652         } );
 653
 654         this.allowSuggestionsWhenEmpty = config.allowSuggestionsWhenEmpty || false;
 655
 656         this.lookupsDisabled = false;
 657         this.lookupInputFocused = false;
 658         this.lookupHighlightFirstItem = config.highlightFirst;
 659
 660         // Events
 661         this.$input.on( {
 662                 focus: this.onLookupInputFocus.bind( this ),
 663                 blur: this.onLookupInputBlur.bind( this ),
 664                 mousedown: this.onLookupInputMouseDown.bind( this )
 665         } );
 666         this.connect( this, { change: 'onLookupInputChange' } );
 667         this.lookupMenu.connect( this, {
 668                 toggle: 'onLookupMenuToggle',
 669                 choose: 'onLookupMenuItemChoose'
 670         } );
 671
 672         // Initialization
 673         this.$input.attr( {
 674                 role: 'combobox',
 675                 'aria-owns': this.lookupMenu.getElementId(),
 676                 'aria-autocomplete': 'list'
 677         } );
 678         this.$element.addClass( 'oo-ui-lookupElement' );
 679         this.lookupMenu.$element.addClass( 'oo-ui-lookupElement-menu' );
 680         this.$overlay.append( this.lookupMenu.$element );
 681 };
 682
 683 /* Setup */
 684
 685 OO.mixinClass( OO.ui.mixin.LookupElement, OO.ui.mixin.RequestManager );
 686
 687 /* Methods */
 688
 689 /**
 690  * Handle input focus event.
 691  *
 692  * @protected
 693  * @param {jQuery.Event} e Input focus event
 694  */
 695 OO.ui.mixin.LookupElement.prototype.onLookupInputFocus = function () {
 696         this.lookupInputFocused = true;
 697         this.populateLookupMenu();
 698 };
 699
 700 /**
 701  * Handle input blur event.
 702  *
 703  * @protected
 704  * @param {jQuery.Event} e Input blur event
 705  */
 706 OO.ui.mixin.LookupElement.prototype.onLookupInputBlur = function () {
 707         this.closeLookupMenu();
 708         this.lookupInputFocused = false;
 709 };
 710
 711 /**
 712  * Handle input mouse down event.
 713  *
 714  * @protected
 715  * @param {jQuery.Event} e Input mouse down event
 716  */
 717 OO.ui.mixin.LookupElement.prototype.onLookupInputMouseDown = function () {
 718         // Only open the menu if the input was already focused.
 719         // This way we allow the user to open the menu again after closing it with Esc
 720         // by clicking in the input. Opening (and populating) the menu when initially
 721         // clicking into the input is handled by the focus handler.
 722         if ( this.lookupInputFocused && !this.lookupMenu.isVisible() ) {
 723                 this.populateLookupMenu();
 724         }
 725 };
 726
 727 /**
 728  * Handle input change event.
 729  *
 730  * @protected
 731  * @param {string} value New input value
 732  */
 733 OO.ui.mixin.LookupElement.prototype.onLookupInputChange = function () {
 734         if ( this.lookupInputFocused ) {
 735                 this.populateLookupMenu();
 736         }
 737 };
 738
 739 /**
 740  * Handle the lookup menu being shown/hidden.
 741  *
 742  * @protected
 743  * @param {boolean} visible Whether the lookup menu is now visible.
 744  */
 745 OO.ui.mixin.LookupElement.prototype.onLookupMenuToggle = function ( visible ) {
 746         if ( !visible ) {
 747                 // When the menu is hidden, abort any active request and clear the menu.
 748                 // This has to be done here in addition to closeLookupMenu(), because
 749                 // MenuSelectWidget will close itself when the user presses Esc.
 750                 this.abortLookupRequest();
 751                 this.lookupMenu.clearItems();
 752         }
 753 };
 754
 755 /**
 756  * Handle menu item 'choose' event, updating the text input value to the value of the clicked item.
 757  *
 758  * @protected
 759  * @param {OO.ui.MenuOptionWidget} item Selected item
 760  */
 761 OO.ui.mixin.LookupElement.prototype.onLookupMenuItemChoose = function ( item ) {
 762         this.setValue( item.getData() );
 763 };
 764
 765 /**
 766  * Get lookup menu.
 767  *
 768  * @private
 769  * @return {OO.ui.MenuSelectWidget}
 770  */
 771 OO.ui.mixin.LookupElement.prototype.getLookupMenu = function () {
 772         return this.lookupMenu;
 773 };
 774
 775 /**
 776  * Disable or re-enable lookups.
 777  *
 778  * When lookups are disabled, calls to #populateLookupMenu will be ignored.
 779  *
 780  * @param {boolean} disabled Disable lookups
 781  */
 782 OO.ui.mixin.LookupElement.prototype.setLookupsDisabled = function ( disabled ) {
 783         this.lookupsDisabled = !!disabled;
 784 };
 785
 786 /**
 787  * Open the menu. If there are no entries in the menu, this does nothing.
 788  *
 789  * @private
 790  * @chainable
 791  */
 792 OO.ui.mixin.LookupElement.prototype.openLookupMenu = function () {
 793         if ( !this.lookupMenu.isEmpty() ) {
 794                 this.lookupMenu.toggle( true );
 795         }
 796         return this;
 797 };
 798
 799 /**
 800  * Close the menu, empty it, and abort any pending request.
 801  *
 802  * @private
 803  * @chainable
 804  */
 805 OO.ui.mixin.LookupElement.prototype.closeLookupMenu = function () {
 806         this.lookupMenu.toggle( false );
 807         this.abortLookupRequest();
 808         this.lookupMenu.clearItems();
 809         return this;
 810 };
 811
 812 /**
 813  * Request menu items based on the input's current value, and when they arrive,
 814  * populate the menu with these items and show the menu.
 815  *
 816  * If lookups have been disabled with #setLookupsDisabled, this function does nothing.
 817  *
 818  * @private
 819  * @chainable
 820  */
 821 OO.ui.mixin.LookupElement.prototype.populateLookupMenu = function () {
 822         var widget = this,
 823                 value = this.getValue();
 824
 825         if ( this.lookupsDisabled || this.isReadOnly() ) {
 826                 return;
 827         }
 828
 829         // If the input is empty, clear the menu, unless suggestions when empty are allowed.
 830         if ( !this.allowSuggestionsWhenEmpty && value === '' ) {
 831                 this.closeLookupMenu();
 832         // Skip population if there is already a request pending for the current value
 833         } else if ( value !== this.lookupQuery ) {
 834                 this.getLookupMenuItems()
 835                         .done( function ( items ) {
 836                                 widget.lookupMenu.clearItems();
 837                                 if ( items.length ) {
 838                                         widget.lookupMenu
 839                                                 .addItems( items )
 840                                                 .toggle( true );
 841                                         widget.initializeLookupMenuSelection();
 842                                 } else {
 843                                         widget.lookupMenu.toggle( false );
 844                                 }
 845                         } )
 846                         .fail( function () {
 847                                 widget.lookupMenu.clearItems();
 848                         } );
 849         }
 850
 851         return this;
 852 };
 853
 854 /**
 855  * Highlight the first selectable item in the menu, if configured.
 856  *
 857  * @private
 858  * @chainable
 859  */
 860 OO.ui.mixin.LookupElement.prototype.initializeLookupMenuSelection = function () {
 861         if ( this.lookupHighlightFirstItem && !this.lookupMenu.getSelectedItem() ) {
 862                 this.lookupMenu.highlightItem( this.lookupMenu.getFirstSelectableItem() );
 863         }
 864 };
 865
 866 /**
 867  * Get lookup menu items for the current query.
 868  *
 869  * @private
 870  * @return {jQuery.Promise} Promise object which will be passed menu items as the first argument of
 871  *   the done event. If the request was aborted to make way for a subsequent request, this promise
 872  *   will not be rejected: it will remain pending forever.
 873  */
 874 OO.ui.mixin.LookupElement.prototype.getLookupMenuItems = function () {
 875         return this.getRequestData().then( function ( data ) {
 876                 return this.getLookupMenuOptionsFromData( data );
 877         }.bind( this ) );
 878 };
 879
 880 /**
 881  * Abort the currently pending lookup request, if any.
 882  *
 883  * @private
 884  */
 885 OO.ui.mixin.LookupElement.prototype.abortLookupRequest = function () {
 886         this.abortRequest();
 887 };
 888
 889 /**
 890  * Get a new request object of the current lookup query value.
 891  *
 892  * @protected
 893  * @method
 894  * @abstract
 895  * @return {jQuery.Promise} jQuery AJAX object, or promise object with an .abort() method
 896  */
 897 OO.ui.mixin.LookupElement.prototype.getLookupRequest = null;
 898
 899 /**
 900  * Pre-process data returned by the request from #getLookupRequest.
 901  *
 902  * The return value of this function will be cached, and any further queries for the given value
 903  * will use the cache rather than doing API requests.
 904  *
 905  * @protected
 906  * @method
 907  * @abstract
 908  * @param {Mixed} response Response from server
 909  * @return {Mixed} Cached result data
 910  */
 911 OO.ui.mixin.LookupElement.prototype.getLookupCacheDataFromResponse = null;
 912
 913 /**
 914  * Get a list of menu option widgets from the (possibly cached) data returned by
 915  * #getLookupCacheDataFromResponse.
 916  *
 917  * @protected
 918  * @method
 919  * @abstract
 920  * @param {Mixed} data Cached result data, usually an array
 921  * @return {OO.ui.MenuOptionWidget[]} Menu items
 922  */
 923 OO.ui.mixin.LookupElement.prototype.getLookupMenuOptionsFromData = null;
 924
 925 /**
 926  * Set the read-only state of the widget.
 927  *
 928  * This will also disable/enable the lookups functionality.
 929  *
 930  * @param {boolean} readOnly Make input read-only
 931  * @chainable
 932  */
 933 OO.ui.mixin.LookupElement.prototype.setReadOnly = function ( readOnly ) {
 934         // Parent method
 935         // Note: Calling #setReadOnly this way assumes this is mixed into an OO.ui.TextInputWidget
 936         OO.ui.TextInputWidget.prototype.setReadOnly.call( this, readOnly );
 937
 938         // During construction, #setReadOnly is called before the OO.ui.mixin.LookupElement constructor
 939         if ( this.isReadOnly() && this.lookupMenu ) {
 940                 this.closeLookupMenu();
 941         }
 942
 943         return this;
 944 };
 945
 946 /**
 947  * @inheritdoc OO.ui.mixin.RequestManager
 948  */
 949 OO.ui.mixin.LookupElement.prototype.getRequestQuery = function () {
 950         return this.getValue();
 951 };
 952
 953 /**
 954  * @inheritdoc OO.ui.mixin.RequestManager
 955  */
 956 OO.ui.mixin.LookupElement.prototype.getRequest = function () {
 957         return this.getLookupRequest();
 958 };
 959
 960 /**
 961  * @inheritdoc OO.ui.mixin.RequestManager
 962  */
 963 OO.ui.mixin.LookupElement.prototype.getRequestCacheDataFromResponse = function ( response ) {
 964         return this.getLookupCacheDataFromResponse( response );
 965 };
 966
 967 /**
 968  * TabPanelLayouts are used within {@link OO.ui.IndexLayout index layouts} to create tab panels that
 969  * users can select and display from the index's optional {@link OO.ui.TabSelectWidget tab}
 970  * navigation. TabPanels are usually not instantiated directly, rather extended to include the
 971  * required content and functionality.
 972  *
 973  * Each tab panel must have a unique symbolic name, which is passed to the constructor. In addition,
 974  * the tab panel's tab item is customized (with a label) using the #setupTabItem method. See
 975  * {@link OO.ui.IndexLayout IndexLayout} for an example.
 976  *
 977  * @class
 978  * @extends OO.ui.PanelLayout
 979  *
 980  * @constructor
 981  * @param {string} name Unique symbolic name of tab panel
 982  * @param {Object} [config] Configuration options
 983  * @cfg {jQuery|string|Function|OO.ui.HtmlSnippet} [label] Label for tab panel's tab
 984  */
 985 OO.ui.TabPanelLayout = function OoUiTabPanelLayout( name, config ) {
 986         // Allow passing positional parameters inside the config object
 987         if ( OO.isPlainObject( name ) && config === undefined ) {
 988                 config = name;
 989                 name = config.name;
 990         }
 991
 992         // Configuration initialization
 993         config = $.extend( { scrollable: true }, config );
 994
 995         // Parent constructor
 996         OO.ui.TabPanelLayout.parent.call( this, config );
 997
 998         // Properties
 999         this.name = name;
1000         this.label = config.label;
1001         this.tabItem = null;
1002         this.active = false;
1003
1004         // Initialization
1005         this.$element.addClass( 'oo-ui-tabPanelLayout' );
1006 };
1007
1008 /* Setup */
1009
1010 OO.inheritClass( OO.ui.TabPanelLayout, OO.ui.PanelLayout );
1011
1012 /* Events */
1013
1014 /**
1015  * An 'active' event is emitted when the tab panel becomes active. Tab panels become active when they are
1016  * shown in a index layout that is configured to display only one tab panel at a time.
1017  *
1018  * @event active
1019  * @param {boolean} active Tab panel is active
1020  */
1021
1022 /* Methods */
1023
1024 /**
1025  * Get the symbolic name of the tab panel.
1026  *
1027  * @return {string} Symbolic name of tab panel
1028  */
1029 OO.ui.TabPanelLayout.prototype.getName = function () {
1030         return this.name;
1031 };
1032
1033 /**
1034  * Check if tab panel is active.
1035  *
1036  * Tab panels become active when they are shown in a {@link OO.ui.IndexLayout index layout} that is configured to
1037  * display only one tab panel at a time. Additional CSS is applied to the tab panel's tab item to reflect the
1038  * active state.
1039  *
1040  * @return {boolean} Tab panel is active
1041  */
1042 OO.ui.TabPanelLayout.prototype.isActive = function () {
1043         return this.active;
1044 };
1045
1046 /**
1047  * Get tab item.
1048  *
1049  * The tab item allows users to access the tab panel from the index's tab
1050  * navigation. The tab item itself can be customized (with a label, level, etc.) using the #setupTabItem method.
1051  *
1052  * @return {OO.ui.TabOptionWidget|null} Tab option widget
1053  */
1054 OO.ui.TabPanelLayout.prototype.getTabItem = function () {
1055         return this.tabItem;
1056 };
1057
1058 /**
1059  * Set or unset the tab item.
1060  *
1061  * Specify a {@link OO.ui.TabOptionWidget tab option} to set it,
1062  * or `null` to clear the tab item. To customize the tab item itself (e.g., to set a label or tab
1063  * level), use #setupTabItem instead of this method.
1064  *
1065  * @param {OO.ui.TabOptionWidget|null} tabItem Tab option widget, null to clear
1066  * @chainable
1067  */
1068 OO.ui.TabPanelLayout.prototype.setTabItem = function ( tabItem ) {
1069         this.tabItem = tabItem || null;
1070         if ( tabItem ) {
1071                 this.setupTabItem();
1072         }
1073         return this;
1074 };
1075
1076 /**
1077  * Set up the tab item.
1078  *
1079  * Use this method to customize the tab item (e.g., to add a label or tab level). To set or unset
1080  * the tab item itself (with a {@link OO.ui.TabOptionWidget tab option} or `null`), use
1081  * the #setTabItem method instead.
1082  *
1083  * @param {OO.ui.TabOptionWidget} tabItem Tab option widget to set up
1084  * @chainable
1085  */
1086 OO.ui.TabPanelLayout.prototype.setupTabItem = function () {
1087         if ( this.label ) {
1088                 this.tabItem.setLabel( this.label );
1089         }
1090         return this;
1091 };
1092
1093 /**
1094  * Set the tab panel to its 'active' state.
1095  *
1096  * Tab panels become active when they are shown in a index layout that is configured to display only
1097  * one tab panel at a time. Additional CSS is applied to the tab item to reflect the tab panel's
1098  * active state. Outside of the index context, setting the active state on a tab panel does nothing.
1099  *
1100  * @param {boolean} active Tab panel is active
1101  * @fires active
1102  */
1103 OO.ui.TabPanelLayout.prototype.setActive = function ( active ) {
1104         active = !!active;
1105
1106         if ( active !== this.active ) {
1107                 this.active = active;
1108                 this.$element.toggleClass( 'oo-ui-tabPanelLayout-active', this.active );
1109                 this.emit( 'active', this.active );
1110         }
1111 };
1112
1113 /**
1114  * The deprecated name for the TabPanelLayout, provided for backwards-compatibility.
1115  *
1116  * @class
1117  * @extends OO.ui.TabPanelLayout
1118  *
1119  * @constructor
1120  * @deprecated since v0.21.3
1121  */
1122 OO.ui.CardLayout = function OoUiCardLayout() {
1123         OO.ui.warnDeprecation( 'CardLayout has been renamed to TabPanel layout. Use that instead. See T155152' );
1124         // Parent constructor
1125         OO.ui.CardLayout.parent.apply( this, arguments );
1126 };
1127
1128 OO.inheritClass( OO.ui.CardLayout, OO.ui.TabPanelLayout );
1129
1130 /**
1131  * PageLayouts are used within {@link OO.ui.BookletLayout booklet layouts} to create pages that users can select and display
1132  * from the booklet's optional {@link OO.ui.OutlineSelectWidget outline} navigation. Pages are usually not instantiated directly,
1133  * rather extended to include the required content and functionality.
1134  *
1135  * Each page must have a unique symbolic name, which is passed to the constructor. In addition, the page's outline
1136  * item is customized (with a label, outline level, etc.) using the #setupOutlineItem method. See
1137  * {@link OO.ui.BookletLayout BookletLayout} for an example.
1138  *
1139  * @class
1140  * @extends OO.ui.PanelLayout
1141  *
1142  * @constructor
1143  * @param {string} name Unique symbolic name of page
1144  * @param {Object} [config] Configuration options
1145  */
1146 OO.ui.PageLayout = function OoUiPageLayout( name, config ) {
1147         // Allow passing positional parameters inside the config object
1148         if ( OO.isPlainObject( name ) && config === undefined ) {
1149                 config = name;
1150                 name = config.name;
1151         }
1152
1153         // Configuration initialization
1154         config = $.extend( { scrollable: true }, config );
1155
1156         // Parent constructor
1157         OO.ui.PageLayout.parent.call( this, config );
1158
1159         // Properties
1160         this.name = name;
1161         this.outlineItem = null;
1162         this.active = false;
1163
1164         // Initialization
1165         this.$element.addClass( 'oo-ui-pageLayout' );
1166 };
1167
1168 /* Setup */
1169
1170 OO.inheritClass( OO.ui.PageLayout, OO.ui.PanelLayout );
1171
1172 /* Events */
1173
1174 /**
1175  * An 'active' event is emitted when the page becomes active. Pages become active when they are
1176  * shown in a booklet layout that is configured to display only one page at a time.
1177  *
1178  * @event active
1179  * @param {boolean} active Page is active
1180  */
1181
1182 /* Methods */
1183
1184 /**
1185  * Get the symbolic name of the page.
1186  *
1187  * @return {string} Symbolic name of page
1188  */
1189 OO.ui.PageLayout.prototype.getName = function () {
1190         return this.name;
1191 };
1192
1193 /**
1194  * Check if page is active.
1195  *
1196  * Pages become active when they are shown in a {@link OO.ui.BookletLayout booklet layout} that is configured to display
1197  * only one page at a time. Additional CSS is applied to the page's outline item to reflect the active state.
1198  *
1199  * @return {boolean} Page is active
1200  */
1201 OO.ui.PageLayout.prototype.isActive = function () {
1202         return this.active;
1203 };
1204
1205 /**
1206  * Get outline item.
1207  *
1208  * The outline item allows users to access the page from the booklet's outline
1209  * navigation. The outline item itself can be customized (with a label, level, etc.) using the #setupOutlineItem method.
1210  *
1211  * @return {OO.ui.OutlineOptionWidget|null} Outline option widget
1212  */
1213 OO.ui.PageLayout.prototype.getOutlineItem = function () {
1214         return this.outlineItem;
1215 };
1216
1217 /**
1218  * Set or unset the outline item.
1219  *
1220  * Specify an {@link OO.ui.OutlineOptionWidget outline option} to set it,
1221  * or `null` to clear the outline item. To customize the outline item itself (e.g., to set a label or outline
1222  * level), use #setupOutlineItem instead of this method.
1223  *
1224  * @param {OO.ui.OutlineOptionWidget|null} outlineItem Outline option widget, null to clear
1225  * @chainable
1226  */
1227 OO.ui.PageLayout.prototype.setOutlineItem = function ( outlineItem ) {
1228         this.outlineItem = outlineItem || null;
1229         if ( outlineItem ) {
1230                 this.setupOutlineItem();
1231         }
1232         return this;
1233 };
1234
1235 /**
1236  * Set up the outline item.
1237  *
1238  * Use this method to customize the outline item (e.g., to add a label or outline level). To set or unset
1239  * the outline item itself (with an {@link OO.ui.OutlineOptionWidget outline option} or `null`), use
1240  * the #setOutlineItem method instead.
1241  *
1242  * @param {OO.ui.OutlineOptionWidget} outlineItem Outline option widget to set up
1243  * @chainable
1244  */
1245 OO.ui.PageLayout.prototype.setupOutlineItem = function () {
1246         return this;
1247 };
1248
1249 /**
1250  * Set the page to its 'active' state.
1251  *
1252  * Pages become active when they are shown in a booklet layout that is configured to display only one page at a time. Additional
1253  * CSS is applied to the outline item to reflect the page's active state. Outside of the booklet
1254  * context, setting the active state on a page does nothing.
1255  *
1256  * @param {boolean} active Page is active
1257  * @fires active
1258  */
1259 OO.ui.PageLayout.prototype.setActive = function ( active ) {
1260         active = !!active;
1261
1262         if ( active !== this.active ) {
1263                 this.active = active;
1264                 this.$element.toggleClass( 'oo-ui-pageLayout-active', active );
1265                 this.emit( 'active', this.active );
1266         }
1267 };
1268
1269 /**
1270  * StackLayouts contain a series of {@link OO.ui.PanelLayout panel layouts}. By default, only one panel is displayed
1271  * at a time, though the stack layout can also be configured to show all contained panels, one after another,
1272  * by setting the #continuous option to 'true'.
1273  *
1274  *     @example
1275  *     // A stack layout with two panels, configured to be displayed continously
1276  *     var myStack = new OO.ui.StackLayout( {
1277  *         items: [
1278  *             new OO.ui.PanelLayout( {
1279  *                 $content: $( '<p>Panel One</p>' ),
1280  *                 padded: true,
1281  *                 framed: true
1282  *             } ),
1283  *             new OO.ui.PanelLayout( {
1284  *                 $content: $( '<p>Panel Two</p>' ),
1285  *                 padded: true,
1286  *                 framed: true
1287  *             } )
1288  *         ],
1289  *         continuous: true
1290  *     } );
1291  *     $( 'body' ).append( myStack.$element );
1292  *
1293  * @class
1294  * @extends OO.ui.PanelLayout
1295  * @mixins OO.ui.mixin.GroupElement
1296  *
1297  * @constructor
1298  * @param {Object} [config] Configuration options
1299  * @cfg {boolean} [continuous=false] Show all panels, one after another. By default, only one panel is displayed at a time.
1300  * @cfg {OO.ui.Layout[]} [items] Panel layouts to add to the stack layout.
1301  */
1302 OO.ui.StackLayout = function OoUiStackLayout( config ) {
1303         // Configuration initialization
1304         config = $.extend( { scrollable: true }, config );
1305
1306         // Parent constructor
1307         OO.ui.StackLayout.parent.call( this, config );
1308
1309         // Mixin constructors
1310         OO.ui.mixin.GroupElement.call( this, $.extend( {}, config, { $group: this.$element } ) );
1311
1312         // Properties
1313         this.currentItem = null;
1314         this.continuous = !!config.continuous;
1315
1316         // Initialization
1317         this.$element.addClass( 'oo-ui-stackLayout' );
1318         if ( this.continuous ) {
1319                 this.$element.addClass( 'oo-ui-stackLayout-continuous' );
1320                 this.$element.on( 'scroll', OO.ui.debounce( this.onScroll.bind( this ), 250 ) );
1321         }
1322         if ( Array.isArray( config.items ) ) {
1323                 this.addItems( config.items );
1324         }
1325 };
1326
1327 /* Setup */
1328
1329 OO.inheritClass( OO.ui.StackLayout, OO.ui.PanelLayout );
1330 OO.mixinClass( OO.ui.StackLayout, OO.ui.mixin.GroupElement );
1331
1332 /* Events */
1333
1334 /**
1335  * A 'set' event is emitted when panels are {@link #addItems added}, {@link #removeItems removed},
1336  * {@link #clearItems cleared} or {@link #setItem displayed}.
1337  *
1338  * @event set
1339  * @param {OO.ui.Layout|null} item Current panel or `null` if no panel is shown
1340  */
1341
1342 /**
1343  * When used in continuous mode, this event is emitted when the user scrolls down
1344  * far enough such that currentItem is no longer visible.
1345  *
1346  * @event visibleItemChange
1347  * @param {OO.ui.PanelLayout} panel The next visible item in the layout
1348  */
1349
1350 /* Methods */
1351
1352 /**
1353  * Handle scroll events from the layout element
1354  *
1355  * @param {jQuery.Event} e
1356  * @fires visibleItemChange
1357  */
1358 OO.ui.StackLayout.prototype.onScroll = function () {
1359         var currentRect,
1360                 len = this.items.length,
1361                 currentIndex = this.items.indexOf( this.currentItem ),
1362                 newIndex = currentIndex,
1363                 containerRect = this.$element[ 0 ].getBoundingClientRect();
1364
1365         if ( !containerRect || ( !containerRect.top && !containerRect.bottom ) ) {
1366                 // Can't get bounding rect, possibly not attached.
1367                 return;
1368         }
1369
1370         function getRect( item ) {
1371                 return item.$element[ 0 ].getBoundingClientRect();
1372         }
1373
1374         function isVisible( item ) {
1375                 var rect = getRect( item );
1376                 return rect.bottom > containerRect.top && rect.top < containerRect.bottom;
1377         }
1378
1379         currentRect = getRect( this.currentItem );
1380
1381         if ( currentRect.bottom < containerRect.top ) {
1382                 // Scrolled down past current item
1383                 while ( ++newIndex < len ) {
1384                         if ( isVisible( this.items[ newIndex ] ) ) {
1385                                 break;
1386                         }
1387                 }
1388         } else if ( currentRect.top > containerRect.bottom ) {
1389                 // Scrolled up past current item
1390                 while ( --newIndex >= 0 ) {
1391                         if ( isVisible( this.items[ newIndex ] ) ) {
1392                                 break;
1393                         }
1394                 }
1395         }
1396
1397         if ( newIndex !== currentIndex ) {
1398                 this.emit( 'visibleItemChange', this.items[ newIndex ] );
1399         }
1400 };
1401
1402 /**
1403  * Get the current panel.
1404  *
1405  * @return {OO.ui.Layout|null}
1406  */
1407 OO.ui.StackLayout.prototype.getCurrentItem = function () {
1408         return this.currentItem;
1409 };
1410
1411 /**
1412  * Unset the current item.
1413  *
1414  * @private
1415  * @param {OO.ui.StackLayout} layout
1416  * @fires set
1417  */
1418 OO.ui.StackLayout.prototype.unsetCurrentItem = function () {
1419         var prevItem = this.currentItem;
1420         if ( prevItem === null ) {
1421                 return;
1422         }
1423
1424         this.currentItem = null;
1425         this.emit( 'set', null );
1426 };
1427
1428 /**
1429  * Add panel layouts to the stack layout.
1430  *
1431  * Panels will be added to the end of the stack layout array unless the optional index parameter specifies a different
1432  * insertion point. Adding a panel that is already in the stack will move it to the end of the array or the point specified
1433  * by the index.
1434  *
1435  * @param {OO.ui.Layout[]} items Panels to add
1436  * @param {number} [index] Index of the insertion point
1437  * @chainable
1438  */
1439 OO.ui.StackLayout.prototype.addItems = function ( items, index ) {
1440         // Update the visibility
1441         this.updateHiddenState( items, this.currentItem );
1442
1443         // Mixin method
1444         OO.ui.mixin.GroupElement.prototype.addItems.call( this, items, index );
1445
1446         if ( !this.currentItem && items.length ) {
1447                 this.setItem( items[ 0 ] );
1448         }
1449
1450         return this;
1451 };
1452
1453 /**
1454  * Remove the specified panels from the stack layout.
1455  *
1456  * Removed panels are detached from the DOM, not removed, so that they may be reused. To remove all panels,
1457  * you may wish to use the #clearItems method instead.
1458  *
1459  * @param {OO.ui.Layout[]} items Panels to remove
1460  * @chainable
1461  * @fires set
1462  */
1463 OO.ui.StackLayout.prototype.removeItems = function ( items ) {
1464         // Mixin method
1465         OO.ui.mixin.GroupElement.prototype.removeItems.call( this, items );
1466
1467         if ( items.indexOf( this.currentItem ) !== -1 ) {
1468                 if ( this.items.length ) {
1469                         this.setItem( this.items[ 0 ] );
1470                 } else {
1471                         this.unsetCurrentItem();
1472                 }
1473         }
1474
1475         return this;
1476 };
1477
1478 /**
1479  * Clear all panels from the stack layout.
1480  *
1481  * Cleared panels are detached from the DOM, not removed, so that they may be reused. To remove only
1482  * a subset of panels, use the #removeItems method.
1483  *
1484  * @chainable
1485  * @fires set
1486  */
1487 OO.ui.StackLayout.prototype.clearItems = function () {
1488         this.unsetCurrentItem();
1489         OO.ui.mixin.GroupElement.prototype.clearItems.call( this );
1490
1491         return this;
1492 };
1493
1494 /**
1495  * Show the specified panel.
1496  *
1497  * If another panel is currently displayed, it will be hidden.
1498  *
1499  * @param {OO.ui.Layout} item Panel to show
1500  * @chainable
1501  * @fires set
1502  */
1503 OO.ui.StackLayout.prototype.setItem = function ( item ) {
1504         if ( item !== this.currentItem ) {
1505                 this.updateHiddenState( this.items, item );
1506
1507                 if ( this.items.indexOf( item ) !== -1 ) {
1508                         this.currentItem = item;
1509                         this.emit( 'set', item );
1510                 } else {
1511                         this.unsetCurrentItem();
1512                 }
1513         }
1514
1515         return this;
1516 };
1517
1518 /**
1519  * Update the visibility of all items in case of non-continuous view.
1520  *
1521  * Ensure all items are hidden except for the selected one.
1522  * This method does nothing when the stack is continuous.
1523  *
1524  * @private
1525  * @param {OO.ui.Layout[]} items Item list iterate over
1526  * @param {OO.ui.Layout} [selectedItem] Selected item to show
1527  */
1528 OO.ui.StackLayout.prototype.updateHiddenState = function ( items, selectedItem ) {
1529         var i, len;
1530
1531         if ( !this.continuous ) {
1532                 for ( i = 0, len = items.length; i < len; i++ ) {
1533                         if ( !selectedItem || selectedItem !== items[ i ] ) {
1534                                 items[ i ].$element.addClass( 'oo-ui-element-hidden' );
1535                                 items[ i ].$element.attr( 'aria-hidden', 'true' );
1536                         }
1537                 }
1538                 if ( selectedItem ) {
1539                         selectedItem.$element.removeClass( 'oo-ui-element-hidden' );
1540                         selectedItem.$element.removeAttr( 'aria-hidden' );
1541                 }
1542         }
1543 };
1544
1545 /**
1546  * 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)
1547  * and its size is customized with the #menuSize config. The content area will fill all remaining space.
1548  *
1549  *     @example
1550  *     var menuLayout = new OO.ui.MenuLayout( {
1551  *         position: 'top'
1552  *     } ),
1553  *         menuPanel = new OO.ui.PanelLayout( { padded: true, expanded: true, scrollable: true } ),
1554  *         contentPanel = new OO.ui.PanelLayout( { padded: true, expanded: true, scrollable: true } ),
1555  *         select = new OO.ui.SelectWidget( {
1556  *             items: [
1557  *                 new OO.ui.OptionWidget( {
1558  *                     data: 'before',
1559  *                     label: 'Before',
1560  *                 } ),
1561  *                 new OO.ui.OptionWidget( {
1562  *                     data: 'after',
1563  *                     label: 'After',
1564  *                 } ),
1565  *                 new OO.ui.OptionWidget( {
1566  *                     data: 'top',
1567  *                     label: 'Top',
1568  *                 } ),
1569  *                 new OO.ui.OptionWidget( {
1570  *                     data: 'bottom',
1571  *                     label: 'Bottom',
1572  *                 } )
1573  *              ]
1574  *         } ).on( 'select', function ( item ) {
1575  *            menuLayout.setMenuPosition( item.getData() );
1576  *         } );
1577  *
1578  *     menuLayout.$menu.append(
1579  *         menuPanel.$element.append( '<b>Menu panel</b>', select.$element )
1580  *     );
1581  *     menuLayout.$content.append(
1582  *         contentPanel.$element.append( '<b>Content panel</b>', '<p>Note that the menu is positioned relative to the content panel: top, bottom, after, before.</p>')
1583  *     );
1584  *     $( 'body' ).append( menuLayout.$element );
1585  *
1586  * If menu size needs to be overridden, it can be accomplished using CSS similar to the snippet
1587  * below. MenuLayout's CSS will override the appropriate values with 'auto' or '0' to display the
1588  * menu correctly. If `menuPosition` is known beforehand, CSS rules corresponding to other positions
1589  * may be omitted.
1590  *
1591  *     .oo-ui-menuLayout-menu {
1592  *         height: 200px;
1593  *         width: 200px;
1594  *     }
1595  *     .oo-ui-menuLayout-content {
1596  *         top: 200px;
1597  *         left: 200px;
1598  *         right: 200px;
1599  *         bottom: 200px;
1600  *     }
1601  *
1602  * @class
1603  * @extends OO.ui.Layout
1604  *
1605  * @constructor
1606  * @param {Object} [config] Configuration options
1607  * @cfg {boolean} [showMenu=true] Show menu
1608  * @cfg {string} [menuPosition='before'] Position of menu: `top`, `after`, `bottom` or `before`
1609  */
1610 OO.ui.MenuLayout = function OoUiMenuLayout( config ) {
1611         // Configuration initialization
1612         config = $.extend( {
1613                 showMenu: true,
1614                 menuPosition: 'before'
1615         }, config );
1616
1617         // Parent constructor
1618         OO.ui.MenuLayout.parent.call( this, config );
1619
1620         /**
1621          * Menu DOM node
1622          *
1623          * @property {jQuery}
1624          */
1625         this.$menu = $( '<div>' );
1626         /**
1627          * Content DOM node
1628          *
1629          * @property {jQuery}
1630          */
1631         this.$content = $( '<div>' );
1632
1633         // Initialization
1634         this.$menu
1635                 .addClass( 'oo-ui-menuLayout-menu' );
1636         this.$content.addClass( 'oo-ui-menuLayout-content' );
1637         this.$element
1638                 .addClass( 'oo-ui-menuLayout' )
1639                 .append( this.$content, this.$menu );
1640         this.setMenuPosition( config.menuPosition );
1641         this.toggleMenu( config.showMenu );
1642 };
1643
1644 /* Setup */
1645
1646 OO.inheritClass( OO.ui.MenuLayout, OO.ui.Layout );
1647
1648 /* Methods */
1649
1650 /**
1651  * Toggle menu.
1652  *
1653  * @param {boolean} showMenu Show menu, omit to toggle
1654  * @chainable
1655  */
1656 OO.ui.MenuLayout.prototype.toggleMenu = function ( showMenu ) {
1657         showMenu = showMenu === undefined ? !this.showMenu : !!showMenu;
1658
1659         if ( this.showMenu !== showMenu ) {
1660                 this.showMenu = showMenu;
1661                 this.$element
1662                         .toggleClass( 'oo-ui-menuLayout-showMenu', this.showMenu )
1663                         .toggleClass( 'oo-ui-menuLayout-hideMenu', !this.showMenu );
1664                 this.$menu.attr( 'aria-hidden', this.showMenu ? 'false' : 'true' );
1665         }
1666
1667         return this;
1668 };
1669
1670 /**
1671  * Check if menu is visible
1672  *
1673  * @return {boolean} Menu is visible
1674  */
1675 OO.ui.MenuLayout.prototype.isMenuVisible = function () {
1676         return this.showMenu;
1677 };
1678
1679 /**
1680  * Set menu position.
1681  *
1682  * @param {string} position Position of menu, either `top`, `after`, `bottom` or `before`
1683  * @throws {Error} If position value is not supported
1684  * @chainable
1685  */
1686 OO.ui.MenuLayout.prototype.setMenuPosition = function ( position ) {
1687         this.$element.removeClass( 'oo-ui-menuLayout-' + this.menuPosition );
1688         this.menuPosition = position;
1689         this.$element.addClass( 'oo-ui-menuLayout-' + position );
1690
1691         return this;
1692 };
1693
1694 /**
1695  * Get menu position.
1696  *
1697  * @return {string} Menu position
1698  */
1699 OO.ui.MenuLayout.prototype.getMenuPosition = function () {
1700         return this.menuPosition;
1701 };
1702
1703 /**
1704  * BookletLayouts contain {@link OO.ui.PageLayout page layouts} as well as
1705  * an {@link OO.ui.OutlineSelectWidget outline} that allows users to easily navigate
1706  * through the pages and select which one to display. By default, only one page is
1707  * displayed at a time and the outline is hidden. When a user navigates to a new page,
1708  * the booklet layout automatically focuses on the first focusable element, unless the
1709  * default setting is changed. Optionally, booklets can be configured to show
1710  * {@link OO.ui.OutlineControlsWidget controls} for adding, moving, and removing items.
1711  *
1712  *     @example
1713  *     // Example of a BookletLayout that contains two PageLayouts.
1714  *
1715  *     function PageOneLayout( name, config ) {
1716  *         PageOneLayout.parent.call( this, name, config );
1717  *         this.$element.append( '<p>First page</p><p>(This booklet has an outline, displayed on the left)</p>' );
1718  *     }
1719  *     OO.inheritClass( PageOneLayout, OO.ui.PageLayout );
1720  *     PageOneLayout.prototype.setupOutlineItem = function () {
1721  *         this.outlineItem.setLabel( 'Page One' );
1722  *     };
1723  *
1724  *     function PageTwoLayout( name, config ) {
1725  *         PageTwoLayout.parent.call( this, name, config );
1726  *         this.$element.append( '<p>Second page</p>' );
1727  *     }
1728  *     OO.inheritClass( PageTwoLayout, OO.ui.PageLayout );
1729  *     PageTwoLayout.prototype.setupOutlineItem = function () {
1730  *         this.outlineItem.setLabel( 'Page Two' );
1731  *     };
1732  *
1733  *     var page1 = new PageOneLayout( 'one' ),
1734  *         page2 = new PageTwoLayout( 'two' );
1735  *
1736  *     var booklet = new OO.ui.BookletLayout( {
1737  *         outlined: true
1738  *     } );
1739  *
1740  *     booklet.addPages ( [ page1, page2 ] );
1741  *     $( 'body' ).append( booklet.$element );
1742  *
1743  * @class
1744  * @extends OO.ui.MenuLayout
1745  *
1746  * @constructor
1747  * @param {Object} [config] Configuration options
1748  * @cfg {boolean} [continuous=false] Show all pages, one after another
1749  * @cfg {boolean} [autoFocus=true] Focus on the first focusable element when a new page is displayed. Disabled on mobile.
1750  * @cfg {boolean} [outlined=false] Show the outline. The outline is used to navigate through the pages of the booklet.
1751  * @cfg {boolean} [editable=false] Show controls for adding, removing and reordering pages
1752  */
1753 OO.ui.BookletLayout = function OoUiBookletLayout( config ) {
1754         // Configuration initialization
1755         config = config || {};
1756
1757         // Parent constructor
1758         OO.ui.BookletLayout.parent.call( this, config );
1759
1760         // Properties
1761         this.currentPageName = null;
1762         this.pages = {};
1763         this.ignoreFocus = false;
1764         this.stackLayout = new OO.ui.StackLayout( { continuous: !!config.continuous } );
1765         this.$content.append( this.stackLayout.$element );
1766         this.autoFocus = config.autoFocus === undefined || !!config.autoFocus;
1767         this.outlineVisible = false;
1768         this.outlined = !!config.outlined;
1769         if ( this.outlined ) {
1770                 this.editable = !!config.editable;
1771                 this.outlineControlsWidget = null;
1772                 this.outlineSelectWidget = new OO.ui.OutlineSelectWidget();
1773                 this.outlinePanel = new OO.ui.PanelLayout( { scrollable: true } );
1774                 this.$menu.append( this.outlinePanel.$element );
1775                 this.outlineVisible = true;
1776                 if ( this.editable ) {
1777                         this.outlineControlsWidget = new OO.ui.OutlineControlsWidget(
1778                                 this.outlineSelectWidget
1779                         );
1780                 }
1781         }
1782         this.toggleMenu( this.outlined );
1783
1784         // Events
1785         this.stackLayout.connect( this, { set: 'onStackLayoutSet' } );
1786         if ( this.outlined ) {
1787                 this.outlineSelectWidget.connect( this, { select: 'onOutlineSelectWidgetSelect' } );
1788                 this.scrolling = false;
1789                 this.stackLayout.connect( this, { visibleItemChange: 'onStackLayoutVisibleItemChange' } );
1790         }
1791         if ( this.autoFocus ) {
1792                 // Event 'focus' does not bubble, but 'focusin' does
1793                 this.stackLayout.$element.on( 'focusin', this.onStackLayoutFocus.bind( this ) );
1794         }
1795
1796         // Initialization
1797         this.$element.addClass( 'oo-ui-bookletLayout' );
1798         this.stackLayout.$element.addClass( 'oo-ui-bookletLayout-stackLayout' );
1799         if ( this.outlined ) {
1800                 this.outlinePanel.$element
1801                         .addClass( 'oo-ui-bookletLayout-outlinePanel' )
1802                         .append( this.outlineSelectWidget.$element );
1803                 if ( this.editable ) {
1804                         this.outlinePanel.$element
1805                                 .addClass( 'oo-ui-bookletLayout-outlinePanel-editable' )
1806                                 .append( this.outlineControlsWidget.$element );
1807                 }
1808         }
1809 };
1810
1811 /* Setup */
1812
1813 OO.inheritClass( OO.ui.BookletLayout, OO.ui.MenuLayout );
1814
1815 /* Events */
1816
1817 /**
1818  * A 'set' event is emitted when a page is {@link #setPage set} to be displayed by the booklet layout.
1819  * @event set
1820  * @param {OO.ui.PageLayout} page Current page
1821  */
1822
1823 /**
1824  * An 'add' event is emitted when pages are {@link #addPages added} to the booklet layout.
1825  *
1826  * @event add
1827  * @param {OO.ui.PageLayout[]} page Added pages
1828  * @param {number} index Index pages were added at
1829  */
1830
1831 /**
1832  * A 'remove' event is emitted when pages are {@link #clearPages cleared} or
1833  * {@link #removePages removed} from the booklet.
1834  *
1835  * @event remove
1836  * @param {OO.ui.PageLayout[]} pages Removed pages
1837  */
1838
1839 /* Methods */
1840
1841 /**
1842  * Handle stack layout focus.
1843  *
1844  * @private
1845  * @param {jQuery.Event} e Focusin event
1846  */
1847 OO.ui.BookletLayout.prototype.onStackLayoutFocus = function ( e ) {
1848         var name, $target;
1849
1850         // Find the page that an element was focused within
1851         $target = $( e.target ).closest( '.oo-ui-pageLayout' );
1852         for ( name in this.pages ) {
1853                 // Check for page match, exclude current page to find only page changes
1854                 if ( this.pages[ name ].$element[ 0 ] === $target[ 0 ] && name !== this.currentPageName ) {
1855                         this.setPage( name );
1856                         break;
1857                 }
1858         }
1859 };
1860
1861 /**
1862  * Handle visibleItemChange events from the stackLayout
1863  *
1864  * The next visible page is set as the current page by selecting it
1865  * in the outline
1866  *
1867  * @param {OO.ui.PageLayout} page The next visible page in the layout
1868  */
1869 OO.ui.BookletLayout.prototype.onStackLayoutVisibleItemChange = function ( page ) {
1870         // Set a flag to so that the resulting call to #onStackLayoutSet doesn't
1871         // try and scroll the item into view again.
1872         this.scrolling = true;
1873         this.outlineSelectWidget.selectItemByData( page.getName() );
1874         this.scrolling = false;
1875 };
1876
1877 /**
1878  * Handle stack layout set events.
1879  *
1880  * @private
1881  * @param {OO.ui.PanelLayout|null} page The page panel that is now the current panel
1882  */
1883 OO.ui.BookletLayout.prototype.onStackLayoutSet = function ( page ) {
1884         var layout = this;
1885         if ( !this.scrolling && page ) {
1886                 page.scrollElementIntoView().done( function () {
1887                         if ( layout.autoFocus && !OO.ui.isMobile() ) {
1888                                 layout.focus();
1889                         }
1890                 } );
1891         }
1892 };
1893
1894 /**
1895  * Focus the first input in the current page.
1896  *
1897  * If no page is selected, the first selectable page will be selected.
1898  * If the focus is already in an element on the current page, nothing will happen.
1899  *
1900  * @param {number} [itemIndex] A specific item to focus on
1901  */
1902 OO.ui.BookletLayout.prototype.focus = function ( itemIndex ) {
1903         var page,
1904                 items = this.stackLayout.getItems();
1905
1906         if ( itemIndex !== undefined && items[ itemIndex ] ) {
1907                 page = items[ itemIndex ];
1908         } else {
1909                 page = this.stackLayout.getCurrentItem();
1910         }
1911
1912         if ( !page && this.outlined ) {
1913                 this.selectFirstSelectablePage();
1914                 page = this.stackLayout.getCurrentItem();
1915         }
1916         if ( !page ) {
1917                 return;
1918         }
1919         // Only change the focus if is not already in the current page
1920         if ( !OO.ui.contains( page.$element[ 0 ], this.getElementDocument().activeElement, true ) ) {
1921                 page.focus();
1922         }
1923 };
1924
1925 /**
1926  * Find the first focusable input in the booklet layout and focus
1927  * on it.
1928  */
1929 OO.ui.BookletLayout.prototype.focusFirstFocusable = function () {
1930         OO.ui.findFocusable( this.stackLayout.$element ).focus();
1931 };
1932
1933 /**
1934  * Handle outline widget select events.
1935  *
1936  * @private
1937  * @param {OO.ui.OptionWidget|null} item Selected item
1938  */
1939 OO.ui.BookletLayout.prototype.onOutlineSelectWidgetSelect = function ( item ) {
1940         if ( item ) {
1941                 this.setPage( item.getData() );
1942         }
1943 };
1944
1945 /**
1946  * Check if booklet has an outline.
1947  *
1948  * @return {boolean} Booklet has an outline
1949  */
1950 OO.ui.BookletLayout.prototype.isOutlined = function () {
1951         return this.outlined;
1952 };
1953
1954 /**
1955  * Check if booklet has editing controls.
1956  *
1957  * @return {boolean} Booklet is editable
1958  */
1959 OO.ui.BookletLayout.prototype.isEditable = function () {
1960         return this.editable;
1961 };
1962
1963 /**
1964  * Check if booklet has a visible outline.
1965  *
1966  * @return {boolean} Outline is visible
1967  */
1968 OO.ui.BookletLayout.prototype.isOutlineVisible = function () {
1969         return this.outlined && this.outlineVisible;
1970 };
1971
1972 /**
1973  * Hide or show the outline.
1974  *
1975  * @param {boolean} [show] Show outline, omit to invert current state
1976  * @chainable
1977  */
1978 OO.ui.BookletLayout.prototype.toggleOutline = function ( show ) {
1979         if ( this.outlined ) {
1980                 show = show === undefined ? !this.outlineVisible : !!show;
1981                 this.outlineVisible = show;
1982                 this.toggleMenu( show );
1983         }
1984
1985         return this;
1986 };
1987
1988 /**
1989  * Get the page closest to the specified page.
1990  *
1991  * @param {OO.ui.PageLayout} page Page to use as a reference point
1992  * @return {OO.ui.PageLayout|null} Page closest to the specified page
1993  */
1994 OO.ui.BookletLayout.prototype.getClosestPage = function ( page ) {
1995         var next, prev, level,
1996                 pages = this.stackLayout.getItems(),
1997                 index = pages.indexOf( page );
1998
1999         if ( index !== -1 ) {
2000                 next = pages[ index + 1 ];
2001                 prev = pages[ index - 1 ];
2002                 // Prefer adjacent pages at the same level
2003                 if ( this.outlined ) {
2004                         level = this.outlineSelectWidget.getItemFromData( page.getName() ).getLevel();
2005                         if (
2006                                 prev &&
2007                                 level === this.outlineSelectWidget.getItemFromData( prev.getName() ).getLevel()
2008                         ) {
2009                                 return prev;
2010                         }
2011                         if (
2012                                 next &&
2013                                 level === this.outlineSelectWidget.getItemFromData( next.getName() ).getLevel()
2014                         ) {
2015                                 return next;
2016                         }
2017                 }
2018         }
2019         return prev || next || null;
2020 };
2021
2022 /**
2023  * Get the outline widget.
2024  *
2025  * If the booklet is not outlined, the method will return `null`.
2026  *
2027  * @return {OO.ui.OutlineSelectWidget|null} Outline widget, or null if the booklet is not outlined
2028  */
2029 OO.ui.BookletLayout.prototype.getOutline = function () {
2030         return this.outlineSelectWidget;
2031 };
2032
2033 /**
2034  * Get the outline controls widget.
2035  *
2036  * If the outline is not editable, the method will return `null`.
2037  *
2038  * @return {OO.ui.OutlineControlsWidget|null} The outline controls widget.
2039  */
2040 OO.ui.BookletLayout.prototype.getOutlineControls = function () {
2041         return this.outlineControlsWidget;
2042 };
2043
2044 /**
2045  * Get a page by its symbolic name.
2046  *
2047  * @param {string} name Symbolic name of page
2048  * @return {OO.ui.PageLayout|undefined} Page, if found
2049  */
2050 OO.ui.BookletLayout.prototype.getPage = function ( name ) {
2051         return this.pages[ name ];
2052 };
2053
2054 /**
2055  * Get the current page.
2056  *
2057  * @return {OO.ui.PageLayout|undefined} Current page, if found
2058  */
2059 OO.ui.BookletLayout.prototype.getCurrentPage = function () {
2060         var name = this.getCurrentPageName();
2061         return name ? this.getPage( name ) : undefined;
2062 };
2063
2064 /**
2065  * Get the symbolic name of the current page.
2066  *
2067  * @return {string|null} Symbolic name of the current page
2068  */
2069 OO.ui.BookletLayout.prototype.getCurrentPageName = function () {
2070         return this.currentPageName;
2071 };
2072
2073 /**
2074  * Add pages to the booklet layout
2075  *
2076  * When pages are added with the same names as existing pages, the existing pages will be
2077  * automatically removed before the new pages are added.
2078  *
2079  * @param {OO.ui.PageLayout[]} pages Pages to add
2080  * @param {number} index Index of the insertion point
2081  * @fires add
2082  * @chainable
2083  */
2084 OO.ui.BookletLayout.prototype.addPages = function ( pages, index ) {
2085         var i, len, name, page, item, currentIndex,
2086                 stackLayoutPages = this.stackLayout.getItems(),
2087                 remove = [],
2088                 items = [];
2089
2090         // Remove pages with same names
2091         for ( i = 0, len = pages.length; i < len; i++ ) {
2092                 page = pages[ i ];
2093                 name = page.getName();
2094
2095                 if ( Object.prototype.hasOwnProperty.call( this.pages, name ) ) {
2096                         // Correct the insertion index
2097                         currentIndex = stackLayoutPages.indexOf( this.pages[ name ] );
2098                         if ( currentIndex !== -1 && currentIndex + 1 < index ) {
2099                                 index--;
2100                         }
2101                         remove.push( this.pages[ name ] );
2102                 }
2103         }
2104         if ( remove.length ) {
2105                 this.removePages( remove );
2106         }
2107
2108         // Add new pages
2109         for ( i = 0, len = pages.length; i < len; i++ ) {
2110                 page = pages[ i ];
2111                 name = page.getName();
2112                 this.pages[ page.getName() ] = page;
2113                 if ( this.outlined ) {
2114                         item = new OO.ui.OutlineOptionWidget( { data: name } );
2115                         page.setOutlineItem( item );
2116                         items.push( item );
2117                 }
2118         }
2119
2120         if ( this.outlined && items.length ) {
2121                 this.outlineSelectWidget.addItems( items, index );
2122                 this.selectFirstSelectablePage();
2123         }
2124         this.stackLayout.addItems( pages, index );
2125         this.emit( 'add', pages, index );
2126
2127         return this;
2128 };
2129
2130 /**
2131  * Remove the specified pages from the booklet layout.
2132  *
2133  * To remove all pages from the booklet, you may wish to use the #clearPages method instead.
2134  *
2135  * @param {OO.ui.PageLayout[]} pages An array of pages to remove
2136  * @fires remove
2137  * @chainable
2138  */
2139 OO.ui.BookletLayout.prototype.removePages = function ( pages ) {
2140         var i, len, name, page,
2141                 items = [];
2142
2143         for ( i = 0, len = pages.length; i < len; i++ ) {
2144                 page = pages[ i ];
2145                 name = page.getName();
2146                 delete this.pages[ name ];
2147                 if ( this.outlined ) {
2148                         items.push( this.outlineSelectWidget.getItemFromData( name ) );
2149                         page.setOutlineItem( null );
2150                 }
2151         }
2152         if ( this.outlined && items.length ) {
2153                 this.outlineSelectWidget.removeItems( items );
2154                 this.selectFirstSelectablePage();
2155         }
2156         this.stackLayout.removeItems( pages );
2157         this.emit( 'remove', pages );
2158
2159         return this;
2160 };
2161
2162 /**
2163  * Clear all pages from the booklet layout.
2164  *
2165  * To remove only a subset of pages from the booklet, use the #removePages method.
2166  *
2167  * @fires remove
2168  * @chainable
2169  */
2170 OO.ui.BookletLayout.prototype.clearPages = function () {
2171         var i, len,
2172                 pages = this.stackLayout.getItems();
2173
2174         this.pages = {};
2175         this.currentPageName = null;
2176         if ( this.outlined ) {
2177                 this.outlineSelectWidget.clearItems();
2178                 for ( i = 0, len = pages.length; i < len; i++ ) {
2179                         pages[ i ].setOutlineItem( null );
2180                 }
2181         }
2182         this.stackLayout.clearItems();
2183
2184         this.emit( 'remove', pages );
2185
2186         return this;
2187 };
2188
2189 /**
2190  * Set the current page by symbolic name.
2191  *
2192  * @fires set
2193  * @param {string} name Symbolic name of page
2194  */
2195 OO.ui.BookletLayout.prototype.setPage = function ( name ) {
2196         var selectedItem,
2197                 $focused,
2198                 page = this.pages[ name ],
2199                 previousPage = this.currentPageName && this.pages[ this.currentPageName ];
2200
2201         if ( name !== this.currentPageName ) {
2202                 if ( this.outlined ) {
2203                         selectedItem = this.outlineSelectWidget.getSelectedItem();
2204                         if ( selectedItem && selectedItem.getData() !== name ) {
2205                                 this.outlineSelectWidget.selectItemByData( name );
2206                         }
2207                 }
2208                 if ( page ) {
2209                         if ( previousPage ) {
2210                                 previousPage.setActive( false );
2211                                 // Blur anything focused if the next page doesn't have anything focusable.
2212                                 // This is not needed if the next page has something focusable (because once it is focused
2213                                 // this blur happens automatically). If the layout is non-continuous, this check is
2214                                 // meaningless because the next page is not visible yet and thus can't hold focus.
2215                                 if (
2216                                         this.autoFocus &&
2217                                         !OO.ui.isMobile() &&
2218                                         this.stackLayout.continuous &&
2219                                         OO.ui.findFocusable( page.$element ).length !== 0
2220                                 ) {
2221                                         $focused = previousPage.$element.find( ':focus' );
2222                                         if ( $focused.length ) {
2223                                                 $focused[ 0 ].blur();
2224                                         }
2225                                 }
2226                         }
2227                         this.currentPageName = name;
2228                         page.setActive( true );
2229                         this.stackLayout.setItem( page );
2230                         if ( !this.stackLayout.continuous && previousPage ) {
2231                                 // This should not be necessary, since any inputs on the previous page should have been
2232                                 // blurred when it was hidden, but browsers are not very consistent about this.
2233                                 $focused = previousPage.$element.find( ':focus' );
2234                                 if ( $focused.length ) {
2235                                         $focused[ 0 ].blur();
2236                                 }
2237                         }
2238                         this.emit( 'set', page );
2239                 }
2240         }
2241 };
2242
2243 /**
2244  * Select the first selectable page.
2245  *
2246  * @chainable
2247  */
2248 OO.ui.BookletLayout.prototype.selectFirstSelectablePage = function () {
2249         if ( !this.outlineSelectWidget.getSelectedItem() ) {
2250                 this.outlineSelectWidget.selectItem( this.outlineSelectWidget.getFirstSelectableItem() );
2251         }
2252
2253         return this;
2254 };
2255
2256 /**
2257  * IndexLayouts contain {@link OO.ui.TabPanelLayout tab panel layouts} as well as
2258  * {@link OO.ui.TabSelectWidget tabs} that allow users to easily navigate through the tab panels and
2259  * select which one to display. By default, only one tab panel is displayed at a time. When a user
2260  * navigates to a new tab panel, the index layout automatically focuses on the first focusable element,
2261  * unless the default setting is changed.
2262  *
2263  * TODO: This class is similar to BookletLayout, we may want to refactor to reduce duplication
2264  *
2265  *     @example
2266  *     // Example of a IndexLayout that contains two TabPanelLayouts.
2267  *
2268  *     function TabPanelOneLayout( name, config ) {
2269  *         TabPanelOneLayout.parent.call( this, name, config );
2270  *         this.$element.append( '<p>First tab panel</p>' );
2271  *     }
2272  *     OO.inheritClass( TabPanelOneLayout, OO.ui.TabPanelLayout );
2273  *     TabPanelOneLayout.prototype.setupTabItem = function () {
2274  *         this.tabItem.setLabel( 'Tab panel one' );
2275  *     };
2276  *
2277  *     var tabPanel1 = new TabPanelOneLayout( 'one' ),
2278  *         tabPanel2 = new OO.ui.TabPanelLayout( 'two', { label: 'Tab panel two' } );
2279  *
2280  *     tabPanel2.$element.append( '<p>Second tab panel</p>' );
2281  *
2282  *     var index = new OO.ui.IndexLayout();
2283  *
2284  *     index.addTabPanels ( [ tabPanel1, tabPanel2 ] );
2285  *     $( 'body' ).append( index.$element );
2286  *
2287  * @class
2288  * @extends OO.ui.MenuLayout
2289  *
2290  * @constructor
2291  * @param {Object} [config] Configuration options
2292  * @cfg {boolean} [continuous=false] Show all tab panels, one after another
2293  * @cfg {boolean} [expanded=true] Expand the content panel to fill the entire parent element.
2294  * @cfg {boolean} [autoFocus=true] Focus on the first focusable element when a new tab panel is displayed. Disabled on mobile.
2295  */
2296 OO.ui.IndexLayout = function OoUiIndexLayout( config ) {
2297         // Configuration initialization
2298         config = $.extend( {}, config, { menuPosition: 'top' } );
2299
2300         // Parent constructor
2301         OO.ui.IndexLayout.parent.call( this, config );
2302
2303         // Properties
2304         this.currentTabPanelName = null;
2305         this.tabPanels = {};
2306
2307         Object.defineProperty( this, 'currentCardName', {
2308                 // TODO: read documentation
2309                 configurable: true,
2310                 enumerable: true,
2311                 get: function () {
2312                         OO.ui.warnDeprecation( 'IndexLayout\'s currentCardName property is deprecated. Use currentTabPanelName instead. See T155152' );
2313                         return this.currentTabPanelName;
2314                 },
2315                 set: function ( value ) {
2316                         OO.ui.warnDeprecation( 'IndexLayout\'s currentCardName property is deprecated. Use currentTabPanelName instead. See T155152' );
2317                         this.currentTabPanelName = value;
2318                 }
2319         } );
2320
2321         Object.defineProperty( this, 'cards', {
2322                 // TODO: read documentation
2323                 configurable: true,
2324                 enumerable: true,
2325                 get: function () {
2326                         OO.ui.warnDeprecation( 'IndexLayout\'s cards property is deprecated. Use tabPanels instead. See T155152' );
2327                         return this.tabPanels;
2328                 },
2329                 set: function ( value ) {
2330                         OO.ui.warnDeprecation( 'IndexLayout\'s cards property is deprecated. Use tabPanels instead. See T155152' );
2331                         this.tabPanels = value;
2332                 }
2333         } );
2334
2335         this.ignoreFocus = false;
2336         this.stackLayout = new OO.ui.StackLayout( {
2337                 continuous: !!config.continuous,
2338                 expanded: config.expanded
2339         } );
2340         this.$content.append( this.stackLayout.$element );
2341         this.autoFocus = config.autoFocus === undefined || !!config.autoFocus;
2342
2343         this.tabSelectWidget = new OO.ui.TabSelectWidget();
2344         this.tabPanel = new OO.ui.PanelLayout();
2345         this.$menu.append( this.tabPanel.$element );
2346
2347         this.toggleMenu( true );
2348
2349         // Events
2350         this.stackLayout.connect( this, { set: 'onStackLayoutSet' } );
2351         this.tabSelectWidget.connect( this, { select: 'onTabSelectWidgetSelect' } );
2352         if ( this.autoFocus ) {
2353                 // Event 'focus' does not bubble, but 'focusin' does
2354                 this.stackLayout.$element.on( 'focusin', this.onStackLayoutFocus.bind( this ) );
2355         }
2356
2357         // Initialization
2358         this.$element.addClass( 'oo-ui-indexLayout' );
2359         this.stackLayout.$element.addClass( 'oo-ui-indexLayout-stackLayout' );
2360         this.tabPanel.$element
2361                 .addClass( 'oo-ui-indexLayout-tabPanel' )
2362                 .append( this.tabSelectWidget.$element );
2363 };
2364
2365 /* Setup */
2366
2367 OO.inheritClass( OO.ui.IndexLayout, OO.ui.MenuLayout );
2368
2369 /* Events */
2370
2371 /**
2372  * A 'set' event is emitted when a tab panel is {@link #setTabPanel set} to be displayed by the index layout.
2373  * @event set
2374  * @param {OO.ui.TabPanelLayout} tabPanel Current tab panel
2375  */
2376
2377 /**
2378  * An 'add' event is emitted when tab panels are {@link #addTabPanels added} to the index layout.
2379  *
2380  * @event add
2381  * @param {OO.ui.TabPanelLayout[]} tabPanel Added tab panels
2382  * @param {number} index Index tab panels were added at
2383  */
2384
2385 /**
2386  * A 'remove' event is emitted when tab panels are {@link #clearTabPanels cleared} or
2387  * {@link #removeTabPanels removed} from the index.
2388  *
2389  * @event remove
2390  * @param {OO.ui.TabPanelLayout[]} tabPanel Removed tab panels
2391  */
2392
2393 /* Methods */
2394
2395 /**
2396  * Handle stack layout focus.
2397  *
2398  * @private
2399  * @param {jQuery.Event} e Focusing event
2400  */
2401 OO.ui.IndexLayout.prototype.onStackLayoutFocus = function ( e ) {
2402         var name, $target;
2403
2404         // Find the tab panel that an element was focused within
2405         $target = $( e.target ).closest( '.oo-ui-tabPanelLayout' );
2406         for ( name in this.tabPanels ) {
2407                 // Check for tab panel match, exclude current tab panel to find only tab panel changes
2408                 if ( this.tabPanels[ name ].$element[ 0 ] === $target[ 0 ] && name !== this.currentTabPanelName ) {
2409                         this.setTabPanel( name );
2410                         break;
2411                 }
2412         }
2413 };
2414
2415 /**
2416  * Handle stack layout set events.
2417  *
2418  * @private
2419  * @param {OO.ui.PanelLayout|null} tabPanel The tab panel that is now the current panel
2420  */
2421 OO.ui.IndexLayout.prototype.onStackLayoutSet = function ( tabPanel ) {
2422         var layout = this;
2423         if ( tabPanel ) {
2424                 tabPanel.scrollElementIntoView().done( function () {
2425                         if ( layout.autoFocus && !OO.ui.isMobile() ) {
2426                                 layout.focus();
2427                         }
2428                 } );
2429         }
2430 };
2431
2432 /**
2433  * Focus the first input in the current tab panel.
2434  *
2435  * If no tab panel is selected, the first selectable tab panel will be selected.
2436  * If the focus is already in an element on the current tab panel, nothing will happen.
2437  *
2438  * @param {number} [itemIndex] A specific item to focus on
2439  */
2440 OO.ui.IndexLayout.prototype.focus = function ( itemIndex ) {
2441         var tabPanel,
2442                 items = this.stackLayout.getItems();
2443
2444         if ( itemIndex !== undefined && items[ itemIndex ] ) {
2445                 tabPanel = items[ itemIndex ];
2446         } else {
2447                 tabPanel = this.stackLayout.getCurrentItem();
2448         }
2449
2450         if ( !tabPanel ) {
2451                 this.selectFirstSelectableTabPanel();
2452                 tabPanel = this.stackLayout.getCurrentItem();
2453         }
2454         if ( !tabPanel ) {
2455                 return;
2456         }
2457         // Only change the focus if is not already in the current page
2458         if ( !OO.ui.contains( tabPanel.$element[ 0 ], this.getElementDocument().activeElement, true ) ) {
2459                 tabPanel.focus();
2460         }
2461 };
2462
2463 /**
2464  * Find the first focusable input in the index layout and focus
2465  * on it.
2466  */
2467 OO.ui.IndexLayout.prototype.focusFirstFocusable = function () {
2468         OO.ui.findFocusable( this.stackLayout.$element ).focus();
2469 };
2470
2471 /**
2472  * Handle tab widget select events.
2473  *
2474  * @private
2475  * @param {OO.ui.OptionWidget|null} item Selected item
2476  */
2477 OO.ui.IndexLayout.prototype.onTabSelectWidgetSelect = function ( item ) {
2478         if ( item ) {
2479                 this.setTabPanel( item.getData() );
2480         }
2481 };
2482
2483 /**
2484  * Get the tab panel closest to the specified tab panel.
2485  *
2486  * @param {OO.ui.TabPanelLayout} tabPanel Tab panel to use as a reference point
2487  * @return {OO.ui.TabPanelLayout|null} Tab panel closest to the specified
2488  */
2489 OO.ui.IndexLayout.prototype.getClosestTabPanel = function ( tabPanel ) {
2490         var next, prev, level,
2491                 tabPanels = this.stackLayout.getItems(),
2492                 index = tabPanels.indexOf( tabPanel );
2493
2494         if ( index !== -1 ) {
2495                 next = tabPanels[ index + 1 ];
2496                 prev = tabPanels[ index - 1 ];
2497                 // Prefer adjacent tab panels at the same level
2498                 level = this.tabSelectWidget.getItemFromData( tabPanel.getName() ).getLevel();
2499                 if (
2500                         prev &&
2501                         level === this.tabSelectWidget.getItemFromData( prev.getName() ).getLevel()
2502                 ) {
2503                         return prev;
2504                 }
2505                 if (
2506                         next &&
2507                         level === this.tabSelectWidget.getItemFromData( next.getName() ).getLevel()
2508                 ) {
2509                         return next;
2510                 }
2511         }
2512         return prev || next || null;
2513 };
2514
2515 /**
2516  * Get the tab panel closest to the specified tab panel.
2517  *
2518  * @param {OO.ui.TabPanelLayout} tabPanel Tab panel to use as a reference point
2519  * @return {OO.ui.TabPanelLayout|null} Tab panel closest to the specified
2520  * @deprecated since v0.21.3, use `getClosestTabPanel` instead
2521  */
2522 OO.ui.IndexLayout.prototype.getClosestCard = function ( tabPanel ) {
2523         OO.ui.warnDeprecation( 'IndexLayout\'s getClosestCard method is deprecated. Use getClosestTabPanel instead. See T155152' );
2524         return this.getClosestTabPanel( tabPanel );
2525 };
2526
2527 /**
2528  * Get the tabs widget.
2529  *
2530  * @return {OO.ui.TabSelectWidget} Tabs widget
2531  */
2532 OO.ui.IndexLayout.prototype.getTabs = function () {
2533         return this.tabSelectWidget;
2534 };
2535
2536 /**
2537  * Get a tab panel by its symbolic name.
2538  *
2539  * @param {string} name Symbolic name of tab panel
2540  * @return {OO.ui.TabPanelLayout|undefined} Tab panel, if found
2541  */
2542 OO.ui.IndexLayout.prototype.getTabPanel = function ( name ) {
2543         return this.tabPanels[ name ];
2544 };
2545
2546 /**
2547  * Get a tab panel by its symbolic name.
2548  *
2549  * @param {string} name Symbolic name of tab panel
2550  * @return {OO.ui.TabPanelLayout|undefined} Tab panel, if found
2551  * @deprecated since v0.21.3, use `getTabPanel` instead
2552  */
2553 OO.ui.IndexLayout.prototype.getCard = function ( name ) {
2554         OO.ui.warnDeprecation( 'IndexLayout\'s getCard method is deprecated. Use getTabPanel instead. See T155152' );
2555         return this.getTabPanel( name );
2556 };
2557
2558 /**
2559  * Get the current tab panel.
2560  *
2561  * @return {OO.ui.TabPanelLayout|undefined} Current tab panel, if found
2562  */
2563 OO.ui.IndexLayout.prototype.getCurrentTabPanel = function () {
2564         var name = this.getCurrentTabPanelName();
2565         return name ? this.getTabPanel( name ) : undefined;
2566 };
2567
2568 /**
2569  * Get the current tab panel.
2570  *
2571  * @return {OO.ui.TabPanelLayout|undefined} Current tab panel, if found
2572  * @deprecated since v0.21.3, use `getCurrentTabPanel` instead
2573  */
2574 OO.ui.IndexLayout.prototype.getCurrentCard = function () {
2575         OO.ui.warnDeprecation( 'IndexLayout\'s getCurrentCard method is deprecated. Use getCurrentTabPanel instead. See T155152' );
2576         return this.getCurrentTabPanel();
2577 };
2578
2579 /**
2580  * Get the symbolic name of the current tab panel.
2581  *
2582  * @return {string|null} Symbolic name of the current tab panel
2583  */
2584 OO.ui.IndexLayout.prototype.getCurrentTabPanelName = function () {
2585         return this.currentTabPanelName;
2586 };
2587
2588 /**
2589  * Get the symbolic name of the current tab panel.
2590  *
2591  * @return {string|null} Symbolic name of the current tab panel
2592  * @deprecated since v0.21.3, use `getCurrentTabPanelName` instead
2593  */
2594 OO.ui.IndexLayout.prototype.getCurrentCardName = function () {
2595         OO.ui.warnDeprecation( 'IndexLayout\'s getCurrentCardName method is deprecated. Use getCurrentTabPanelName instead. See T155152' );
2596         return this.getCurrentTabPanelName();
2597 };
2598
2599 /**
2600  * Add tab panels to the index layout
2601  *
2602  * When tab panels are added with the same names as existing tab panels, the existing tab panels
2603  * will be automatically removed before the new tab panels are added.
2604  *
2605  * @param {OO.ui.TabPanelLayout[]} tabPanels Tab panels to add
2606  * @param {number} index Index of the insertion point
2607  * @fires add
2608  * @chainable
2609  */
2610 OO.ui.IndexLayout.prototype.addTabPanels = function ( tabPanels, index ) {
2611         var i, len, name, tabPanel, item, currentIndex,
2612                 stackLayoutTabPanels = this.stackLayout.getItems(),
2613                 remove = [],
2614                 items = [];
2615
2616         // Remove tab panels with same names
2617         for ( i = 0, len = tabPanels.length; i < len; i++ ) {
2618                 tabPanel = tabPanels[ i ];
2619                 name = tabPanel.getName();
2620
2621                 if ( Object.prototype.hasOwnProperty.call( this.tabPanels, name ) ) {
2622                         // Correct the insertion index
2623                         currentIndex = stackLayoutTabPanels.indexOf( this.tabPanels[ name ] );
2624                         if ( currentIndex !== -1 && currentIndex + 1 < index ) {
2625                                 index--;
2626                         }
2627                         remove.push( this.tabPanels[ name ] );
2628                 }
2629         }
2630         if ( remove.length ) {
2631                 this.removeTabPanels( remove );
2632         }
2633
2634         // Add new tab panels
2635         for ( i = 0, len = tabPanels.length; i < len; i++ ) {
2636                 tabPanel = tabPanels[ i ];
2637                 name = tabPanel.getName();
2638                 this.tabPanels[ tabPanel.getName() ] = tabPanel;
2639                 item = new OO.ui.TabOptionWidget( { data: name } );
2640                 tabPanel.setTabItem( item );
2641                 items.push( item );
2642         }
2643
2644         if ( items.length ) {
2645                 this.tabSelectWidget.addItems( items, index );
2646                 this.selectFirstSelectableTabPanel();
2647         }
2648         this.stackLayout.addItems( tabPanels, index );
2649         this.emit( 'add', tabPanels, index );
2650
2651         return this;
2652 };
2653
2654 /**
2655  * Add tab panels to the index layout
2656  *
2657  * When tab panels are added with the same names as existing tab panels, the existing tab panels
2658  * will be automatically removed before the new tab panels are added.
2659  *
2660  * @param {OO.ui.TabPanelLayout[]} tabPanels Tab panels to add
2661  * @param {number} index Index of the insertion point
2662  * @fires add
2663  * @chainable
2664  * @deprecated since v0.21.3, use `addTabPanels` instead
2665  */
2666 OO.ui.IndexLayout.prototype.addCards = function ( tabPanels, index ) {
2667         OO.ui.warnDeprecation( 'IndexLayout\'s addCards method is deprecated. Use addTabPanels instead. See T155152' );
2668         return this.addTabPanels( tabPanels, index );
2669 };
2670
2671 /**
2672  * Remove the specified tab panels from the index layout.
2673  *
2674  * To remove all tab panels from the index, you may wish to use the #clearTabPanels method instead.
2675  *
2676  * @param {OO.ui.TabPanelLayout[]} tabPanels An array of tab panels to remove
2677  * @fires remove
2678  * @chainable
2679  */
2680 OO.ui.IndexLayout.prototype.removeTabPanels = function ( tabPanels ) {
2681         var i, len, name, tabPanel,
2682                 items = [];
2683
2684         for ( i = 0, len = tabPanels.length; i < len; i++ ) {
2685                 tabPanel = tabPanels[ i ];
2686                 name = tabPanel.getName();
2687                 delete this.tabPanels[ name ];
2688                 items.push( this.tabSelectWidget.getItemFromData( name ) );
2689                 tabPanel.setTabItem( null );
2690         }
2691         if ( items.length ) {
2692                 this.tabSelectWidget.removeItems( items );
2693                 this.selectFirstSelectableTabPanel();
2694         }
2695         this.stackLayout.removeItems( tabPanels );
2696         this.emit( 'remove', tabPanels );
2697
2698         return this;
2699 };
2700
2701 /**
2702  * Remove the specified tab panels from the index layout.
2703  *
2704  * To remove all tab panels from the index, you may wish to use the #clearTabPanels method instead.
2705  *
2706  * @param {OO.ui.TabPanelLayout[]} tabPanels An array of tab panels to remove
2707  * @fires remove
2708  * @chainable
2709  * @deprecated since v0.21.3, use `removeTabPanels` instead
2710  */
2711 OO.ui.IndexLayout.prototype.removeCards = function ( tabPanels ) {
2712         OO.ui.warnDeprecation( 'IndexLayout\'s removeCards method is deprecated. Use removeTabPanels instead. See T155152.' );
2713         return this.removeTabPanels( tabPanels );
2714 };
2715
2716 /**
2717  * Clear all tab panels from the index layout.
2718  *
2719  * To remove only a subset of tab panels from the index, use the #removeTabPanels method.
2720  *
2721  * @fires remove
2722  * @chainable
2723  */
2724 OO.ui.IndexLayout.prototype.clearTabPanels = function () {
2725         var i, len,
2726                 tabPanels = this.stackLayout.getItems();
2727
2728         this.tabPanels = {};
2729         this.currentTabPanelName = null;
2730         this.tabSelectWidget.clearItems();
2731         for ( i = 0, len = tabPanels.length; i < len; i++ ) {
2732                 tabPanels[ i ].setTabItem( null );
2733         }
2734         this.stackLayout.clearItems();
2735
2736         this.emit( 'remove', tabPanels );
2737
2738         return this;
2739 };
2740
2741 /**
2742  * Clear all tab panels from the index layout.
2743  *
2744  * To remove only a subset of tab panels from the index, use the #removeTabPanels method.
2745  *
2746  * @fires remove
2747  * @chainable
2748  * @deprecated since v0.21.3, use `clearTabPanels` instead
2749  */
2750 OO.ui.IndexLayout.prototype.clearCards = function () {
2751         OO.ui.warnDeprecation( 'IndexLayout\'s clearCards method is deprecated. Use clearTabPanels instead. See T155152.' );
2752         return this.clearTabPanels();
2753 };
2754
2755 /**
2756  * Set the current tab panel by symbolic name.
2757  *
2758  * @fires set
2759  * @param {string} name Symbolic name of tab panel
2760  */
2761 OO.ui.IndexLayout.prototype.setTabPanel = function ( name ) {
2762         var selectedItem,
2763                 $focused,
2764                 tabPanel = this.tabPanels[ name ],
2765                 previousTabPanel = this.currentTabPanelName && this.tabPanels[ this.currentTabPanelName ];
2766
2767         if ( name !== this.currentTabPanelName ) {
2768                 selectedItem = this.tabSelectWidget.getSelectedItem();
2769                 if ( selectedItem && selectedItem.getData() !== name ) {
2770                         this.tabSelectWidget.selectItemByData( name );
2771                 }
2772                 if ( tabPanel ) {
2773                         if ( previousTabPanel ) {
2774                                 previousTabPanel.setActive( false );
2775                                 // Blur anything focused if the next tab panel doesn't have anything focusable.
2776                                 // This is not needed if the next tab panel has something focusable (because once it is focused
2777                                 // this blur happens automatically). If the layout is non-continuous, this check is
2778                                 // meaningless because the next tab panel is not visible yet and thus can't hold focus.
2779                                 if (
2780                                         this.autoFocus &&
2781                                         !OO.ui.isMobile() &&
2782                                         this.stackLayout.continuous &&
2783                                         OO.ui.findFocusable( tabPanel.$element ).length !== 0
2784                                 ) {
2785                                         $focused = previousTabPanel.$element.find( ':focus' );
2786                                         if ( $focused.length ) {
2787                                                 $focused[ 0 ].blur();
2788                                         }
2789                                 }
2790                         }
2791                         this.currentTabPanelName = name;
2792                         tabPanel.setActive( true );
2793                         this.stackLayout.setItem( tabPanel );
2794                         if ( !this.stackLayout.continuous && previousTabPanel ) {
2795                                 // This should not be necessary, since any inputs on the previous tab panel should have been
2796                                 // blurred when it was hidden, but browsers are not very consistent about this.
2797                                 $focused = previousTabPanel.$element.find( ':focus' );
2798                                 if ( $focused.length ) {
2799                                         $focused[ 0 ].blur();
2800                                 }
2801                         }
2802                         this.emit( 'set', tabPanel );
2803                 }
2804         }
2805 };
2806
2807 /**
2808  * Set the current tab panel by symbolic name.
2809  *
2810  * @fires set
2811  * @param {string} name Symbolic name of tab panel
2812  * @deprecated since v0.21.3, use `setTabPanel` instead
2813  */
2814 OO.ui.IndexLayout.prototype.setCard = function ( name ) {
2815         OO.ui.warnDeprecation( 'IndexLayout\'s setCard method is deprecated. Use setTabPanel instead. See T155152.' );
2816         return this.setTabPanel( name );
2817 };
2818
2819 /**
2820  * Select the first selectable tab panel.
2821  *
2822  * @chainable
2823  */
2824 OO.ui.IndexLayout.prototype.selectFirstSelectableTabPanel = function () {
2825         if ( !this.tabSelectWidget.getSelectedItem() ) {
2826                 this.tabSelectWidget.selectItem( this.tabSelectWidget.getFirstSelectableItem() );
2827         }
2828
2829         return this;
2830 };
2831
2832 /**
2833  * Select the first selectable tab panel.
2834  *
2835  * @chainable
2836  * @deprecated since v0.21.3, use `selectFirstSelectableTabPanel` instead
2837  */
2838 OO.ui.IndexLayout.prototype.selectFirstSelectableCard = function () {
2839         OO.ui.warnDeprecation( 'IndexLayout\'s selectFirstSelectableCard method is deprecated. Use selectFirestSelectableTabPanel instead. See T155152.' );
2840         return this.selectFirstSelectableTabPanel();
2841 };
2842
2843 /**
2844  * ToggleWidget implements basic behavior of widgets with an on/off state.
2845  * Please see OO.ui.ToggleButtonWidget and OO.ui.ToggleSwitchWidget for examples.
2846  *
2847  * @abstract
2848  * @class
2849  * @extends OO.ui.Widget
2850  *
2851  * @constructor
2852  * @param {Object} [config] Configuration options
2853  * @cfg {boolean} [value=false] The toggle’s initial on/off state.
2854  *  By default, the toggle is in the 'off' state.
2855  */
2856 OO.ui.ToggleWidget = function OoUiToggleWidget( config ) {
2857         // Configuration initialization
2858         config = config || {};
2859
2860         // Parent constructor
2861         OO.ui.ToggleWidget.parent.call( this, config );
2862
2863         // Properties
2864         this.value = null;
2865
2866         // Initialization
2867         this.$element.addClass( 'oo-ui-toggleWidget' );
2868         this.setValue( !!config.value );
2869 };
2870
2871 /* Setup */
2872
2873 OO.inheritClass( OO.ui.ToggleWidget, OO.ui.Widget );
2874
2875 /* Events */
2876
2877 /**
2878  * @event change
2879  *
2880  * A change event is emitted when the on/off state of the toggle changes.
2881  *
2882  * @param {boolean} value Value representing the new state of the toggle
2883  */
2884
2885 /* Methods */
2886
2887 /**
2888  * Get the value representing the toggle’s state.
2889  *
2890  * @return {boolean} The on/off state of the toggle
2891  */
2892 OO.ui.ToggleWidget.prototype.getValue = function () {
2893         return this.value;
2894 };
2895
2896 /**
2897  * Set the state of the toggle: `true` for 'on', `false` for 'off'.
2898  *
2899  * @param {boolean} value The state of the toggle
2900  * @fires change
2901  * @chainable
2902  */
2903 OO.ui.ToggleWidget.prototype.setValue = function ( value ) {
2904         value = !!value;
2905         if ( this.value !== value ) {
2906                 this.value = value;
2907                 this.emit( 'change', value );
2908                 this.$element.toggleClass( 'oo-ui-toggleWidget-on', value );
2909                 this.$element.toggleClass( 'oo-ui-toggleWidget-off', !value );
2910         }
2911         return this;
2912 };
2913
2914 /**
2915  * ToggleButtons are buttons that have a state (‘on’ or ‘off’) that is represented by a
2916  * Boolean value. Like other {@link OO.ui.ButtonWidget buttons}, toggle buttons can be
2917  * configured with {@link OO.ui.mixin.IconElement icons}, {@link OO.ui.mixin.IndicatorElement indicators},
2918  * {@link OO.ui.mixin.TitledElement titles}, {@link OO.ui.mixin.FlaggedElement styling flags},
2919  * and {@link OO.ui.mixin.LabelElement labels}. Please see
2920  * the [OOjs UI documentation][1] on MediaWiki for more information.
2921  *
2922  *     @example
2923  *     // Toggle buttons in the 'off' and 'on' state.
2924  *     var toggleButton1 = new OO.ui.ToggleButtonWidget( {
2925  *         label: 'Toggle Button off'
2926  *     } );
2927  *     var toggleButton2 = new OO.ui.ToggleButtonWidget( {
2928  *         label: 'Toggle Button on',
2929  *         value: true
2930  *     } );
2931  *     // Append the buttons to the DOM.
2932  *     $( 'body' ).append( toggleButton1.$element, toggleButton2.$element );
2933  *
2934  * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Buttons_and_Switches#Toggle_buttons
2935  *
2936  * @class
2937  * @extends OO.ui.ToggleWidget
2938  * @mixins OO.ui.mixin.ButtonElement
2939  * @mixins OO.ui.mixin.IconElement
2940  * @mixins OO.ui.mixin.IndicatorElement
2941  * @mixins OO.ui.mixin.LabelElement
2942  * @mixins OO.ui.mixin.TitledElement
2943  * @mixins OO.ui.mixin.FlaggedElement
2944  * @mixins OO.ui.mixin.TabIndexedElement
2945  *
2946  * @constructor
2947  * @param {Object} [config] Configuration options
2948  * @cfg {boolean} [value=false] The toggle button’s initial on/off
2949  *  state. By default, the button is in the 'off' state.
2950  */
2951 OO.ui.ToggleButtonWidget = function OoUiToggleButtonWidget( config ) {
2952         // Configuration initialization
2953         config = config || {};
2954
2955         // Parent constructor
2956         OO.ui.ToggleButtonWidget.parent.call( this, config );
2957
2958         // Mixin constructors
2959         OO.ui.mixin.ButtonElement.call( this, $.extend( {}, config, { active: this.active } ) );
2960         OO.ui.mixin.IconElement.call( this, config );
2961         OO.ui.mixin.IndicatorElement.call( this, config );
2962         OO.ui.mixin.LabelElement.call( this, config );
2963         OO.ui.mixin.TitledElement.call( this, $.extend( {}, config, { $titled: this.$button } ) );
2964         OO.ui.mixin.FlaggedElement.call( this, config );
2965         OO.ui.mixin.TabIndexedElement.call( this, $.extend( {}, config, { $tabIndexed: this.$button } ) );
2966
2967         // Events
2968         this.connect( this, { click: 'onAction' } );
2969
2970         // Initialization
2971         this.$button.append( this.$icon, this.$label, this.$indicator );
2972         this.$element
2973                 .addClass( 'oo-ui-toggleButtonWidget' )
2974                 .append( this.$button );
2975 };
2976
2977 /* Setup */
2978
2979 OO.inheritClass( OO.ui.ToggleButtonWidget, OO.ui.ToggleWidget );
2980 OO.mixinClass( OO.ui.ToggleButtonWidget, OO.ui.mixin.ButtonElement );
2981 OO.mixinClass( OO.ui.ToggleButtonWidget, OO.ui.mixin.IconElement );
2982 OO.mixinClass( OO.ui.ToggleButtonWidget, OO.ui.mixin.IndicatorElement );
2983 OO.mixinClass( OO.ui.ToggleButtonWidget, OO.ui.mixin.LabelElement );
2984 OO.mixinClass( OO.ui.ToggleButtonWidget, OO.ui.mixin.TitledElement );
2985 OO.mixinClass( OO.ui.ToggleButtonWidget, OO.ui.mixin.FlaggedElement );
2986 OO.mixinClass( OO.ui.ToggleButtonWidget, OO.ui.mixin.TabIndexedElement );
2987
2988 /* Static Properties */
2989
2990 /**
2991  * @static
2992  * @inheritdoc
2993  */
2994 OO.ui.ToggleButtonWidget.static.tagName = 'span';
2995
2996 /* Methods */
2997
2998 /**
2999  * Handle the button action being triggered.
3000  *
3001  * @private
3002  */
3003 OO.ui.ToggleButtonWidget.prototype.onAction = function () {
3004         this.setValue( !this.value );
3005 };
3006
3007 /**
3008  * @inheritdoc
3009  */
3010 OO.ui.ToggleButtonWidget.prototype.setValue = function ( value ) {
3011         value = !!value;
3012         if ( value !== this.value ) {
3013                 // Might be called from parent constructor before ButtonElement constructor
3014                 if ( this.$button ) {
3015                         this.$button.attr( 'aria-pressed', value.toString() );
3016                 }
3017                 this.setActive( value );
3018         }
3019
3020         // Parent method
3021         OO.ui.ToggleButtonWidget.parent.prototype.setValue.call( this, value );
3022
3023         return this;
3024 };
3025
3026 /**
3027  * @inheritdoc
3028  */
3029 OO.ui.ToggleButtonWidget.prototype.setButtonElement = function ( $button ) {
3030         if ( this.$button ) {
3031                 this.$button.removeAttr( 'aria-pressed' );
3032         }
3033         OO.ui.mixin.ButtonElement.prototype.setButtonElement.call( this, $button );
3034         this.$button.attr( 'aria-pressed', this.value.toString() );
3035 };
3036
3037 /**
3038  * ToggleSwitches are switches that slide on and off. Their state is represented by a Boolean
3039  * value (`true` for ‘on’, and `false` otherwise, the default). The ‘off’ state is represented
3040  * visually by a slider in the leftmost position.
3041  *
3042  *     @example
3043  *     // Toggle switches in the 'off' and 'on' position.
3044  *     var toggleSwitch1 = new OO.ui.ToggleSwitchWidget();
3045  *     var toggleSwitch2 = new OO.ui.ToggleSwitchWidget( {
3046  *         value: true
3047  *     } );
3048  *
3049  *     // Create a FieldsetLayout to layout and label switches
3050  *     var fieldset = new OO.ui.FieldsetLayout( {
3051  *        label: 'Toggle switches'
3052  *     } );
3053  *     fieldset.addItems( [
3054  *         new OO.ui.FieldLayout( toggleSwitch1, { label: 'Off', align: 'top' } ),
3055  *         new OO.ui.FieldLayout( toggleSwitch2, { label: 'On', align: 'top' } )
3056  *     ] );
3057  *     $( 'body' ).append( fieldset.$element );
3058  *
3059  * @class
3060  * @extends OO.ui.ToggleWidget
3061  * @mixins OO.ui.mixin.TabIndexedElement
3062  *
3063  * @constructor
3064  * @param {Object} [config] Configuration options
3065  * @cfg {boolean} [value=false] The toggle switch’s initial on/off state.
3066  *  By default, the toggle switch is in the 'off' position.
3067  */
3068 OO.ui.ToggleSwitchWidget = function OoUiToggleSwitchWidget( config ) {
3069         // Parent constructor
3070         OO.ui.ToggleSwitchWidget.parent.call( this, config );
3071
3072         // Mixin constructors
3073         OO.ui.mixin.TabIndexedElement.call( this, config );
3074
3075         // Properties
3076         this.dragging = false;
3077         this.dragStart = null;
3078         this.sliding = false;
3079         this.$glow = $( '<span>' );
3080         this.$grip = $( '<span>' );
3081
3082         // Events
3083         this.$element.on( {
3084                 click: this.onClick.bind( this ),
3085                 keypress: this.onKeyPress.bind( this )
3086         } );
3087
3088         // Initialization
3089         this.$glow.addClass( 'oo-ui-toggleSwitchWidget-glow' );
3090         this.$grip.addClass( 'oo-ui-toggleSwitchWidget-grip' );
3091         this.$element
3092                 .addClass( 'oo-ui-toggleSwitchWidget' )
3093                 .attr( 'role', 'checkbox' )
3094                 .append( this.$glow, this.$grip );
3095 };
3096
3097 /* Setup */
3098
3099 OO.inheritClass( OO.ui.ToggleSwitchWidget, OO.ui.ToggleWidget );
3100 OO.mixinClass( OO.ui.ToggleSwitchWidget, OO.ui.mixin.TabIndexedElement );
3101
3102 /* Methods */
3103
3104 /**
3105  * Handle mouse click events.
3106  *
3107  * @private
3108  * @param {jQuery.Event} e Mouse click event
3109  */
3110 OO.ui.ToggleSwitchWidget.prototype.onClick = function ( e ) {
3111         if ( !this.isDisabled() && e.which === OO.ui.MouseButtons.LEFT ) {
3112                 this.setValue( !this.value );
3113         }
3114         return false;
3115 };
3116
3117 /**
3118  * Handle key press events.
3119  *
3120  * @private
3121  * @param {jQuery.Event} e Key press event
3122  */
3123 OO.ui.ToggleSwitchWidget.prototype.onKeyPress = function ( e ) {
3124         if ( !this.isDisabled() && ( e.which === OO.ui.Keys.SPACE || e.which === OO.ui.Keys.ENTER ) ) {
3125                 this.setValue( !this.value );
3126                 return false;
3127         }
3128 };
3129
3130 /**
3131  * @inheritdoc
3132  */
3133 OO.ui.ToggleSwitchWidget.prototype.setValue = function ( value ) {
3134         OO.ui.ToggleSwitchWidget.parent.prototype.setValue.call( this, value );
3135         this.$element.attr( 'aria-checked', this.value.toString() );
3136         return this;
3137 };
3138
3139 /**
3140  * @inheritdoc
3141  */
3142 OO.ui.ToggleSwitchWidget.prototype.simulateLabelClick = function () {
3143         if ( !this.isDisabled() ) {
3144                 this.setValue( !this.value );
3145         }
3146         this.focus();
3147 };
3148
3149 /**
3150  * OutlineControlsWidget is a set of controls for an {@link OO.ui.OutlineSelectWidget outline select widget}.
3151  * Controls include moving items up and down, removing items, and adding different kinds of items.
3152  *
3153  * **Currently, this class is only used by {@link OO.ui.BookletLayout booklet layouts}.**
3154  *
3155  * @class
3156  * @extends OO.ui.Widget
3157  * @mixins OO.ui.mixin.GroupElement
3158  * @mixins OO.ui.mixin.IconElement
3159  *
3160  * @constructor
3161  * @param {OO.ui.OutlineSelectWidget} outline Outline to control
3162  * @param {Object} [config] Configuration options
3163  * @cfg {Object} [abilities] List of abilties
3164  * @cfg {boolean} [abilities.move=true] Allow moving movable items
3165  * @cfg {boolean} [abilities.remove=true] Allow removing removable items
3166  */
3167 OO.ui.OutlineControlsWidget = function OoUiOutlineControlsWidget( outline, config ) {
3168         // Allow passing positional parameters inside the config object
3169         if ( OO.isPlainObject( outline ) && config === undefined ) {
3170                 config = outline;
3171                 outline = config.outline;
3172         }
3173
3174         // Configuration initialization
3175         config = $.extend( { icon: 'add' }, config );
3176
3177         // Parent constructor
3178         OO.ui.OutlineControlsWidget.parent.call( this, config );
3179
3180         // Mixin constructors
3181         OO.ui.mixin.GroupElement.call( this, config );
3182         OO.ui.mixin.IconElement.call( this, config );
3183
3184         // Properties
3185         this.outline = outline;
3186         this.$movers = $( '<div>' );
3187         this.upButton = new OO.ui.ButtonWidget( {
3188                 framed: false,
3189                 icon: 'collapse',
3190                 title: OO.ui.msg( 'ooui-outline-control-move-up' )
3191         } );
3192         this.downButton = new OO.ui.ButtonWidget( {
3193                 framed: false,
3194                 icon: 'expand',
3195                 title: OO.ui.msg( 'ooui-outline-control-move-down' )
3196         } );
3197         this.removeButton = new OO.ui.ButtonWidget( {
3198                 framed: false,
3199                 icon: 'remove',
3200                 title: OO.ui.msg( 'ooui-outline-control-remove' )
3201         } );
3202         this.abilities = { move: true, remove: true };
3203
3204         // Events
3205         outline.connect( this, {
3206                 select: 'onOutlineChange',
3207                 add: 'onOutlineChange',
3208                 remove: 'onOutlineChange'
3209         } );
3210         this.upButton.connect( this, { click: [ 'emit', 'move', -1 ] } );
3211         this.downButton.connect( this, { click: [ 'emit', 'move', 1 ] } );
3212         this.removeButton.connect( this, { click: [ 'emit', 'remove' ] } );
3213
3214         // Initialization
3215         this.$element.addClass( 'oo-ui-outlineControlsWidget' );
3216         this.$group.addClass( 'oo-ui-outlineControlsWidget-items' );
3217         this.$movers
3218                 .addClass( 'oo-ui-outlineControlsWidget-movers' )
3219                 .append( this.removeButton.$element, this.upButton.$element, this.downButton.$element );
3220         this.$element.append( this.$icon, this.$group, this.$movers );
3221         this.setAbilities( config.abilities || {} );
3222 };
3223
3224 /* Setup */
3225
3226 OO.inheritClass( OO.ui.OutlineControlsWidget, OO.ui.Widget );
3227 OO.mixinClass( OO.ui.OutlineControlsWidget, OO.ui.mixin.GroupElement );
3228 OO.mixinClass( OO.ui.OutlineControlsWidget, OO.ui.mixin.IconElement );
3229
3230 /* Events */
3231
3232 /**
3233  * @event move
3234  * @param {number} places Number of places to move
3235  */
3236
3237 /**
3238  * @event remove
3239  */
3240
3241 /* Methods */
3242
3243 /**
3244  * Set abilities.
3245  *
3246  * @param {Object} abilities List of abilties
3247  * @param {boolean} [abilities.move] Allow moving movable items
3248  * @param {boolean} [abilities.remove] Allow removing removable items
3249  */
3250 OO.ui.OutlineControlsWidget.prototype.setAbilities = function ( abilities ) {
3251         var ability;
3252
3253         for ( ability in this.abilities ) {
3254                 if ( abilities[ ability ] !== undefined ) {
3255                         this.abilities[ ability ] = !!abilities[ ability ];
3256                 }
3257         }
3258
3259         this.onOutlineChange();
3260 };
3261
3262 /**
3263  * Handle outline change events.
3264  *
3265  * @private
3266  */
3267 OO.ui.OutlineControlsWidget.prototype.onOutlineChange = function () {
3268         var i, len, firstMovable, lastMovable,
3269                 items = this.outline.getItems(),
3270                 selectedItem = this.outline.getSelectedItem(),
3271                 movable = this.abilities.move && selectedItem && selectedItem.isMovable(),
3272                 removable = this.abilities.remove && selectedItem && selectedItem.isRemovable();
3273
3274         if ( movable ) {
3275                 i = -1;
3276                 len = items.length;
3277                 while ( ++i < len ) {
3278                         if ( items[ i ].isMovable() ) {
3279                                 firstMovable = items[ i ];
3280                                 break;
3281                         }
3282                 }
3283                 i = len;
3284                 while ( i-- ) {
3285                         if ( items[ i ].isMovable() ) {
3286                                 lastMovable = items[ i ];
3287                                 break;
3288                         }
3289                 }
3290         }
3291         this.upButton.setDisabled( !movable || selectedItem === firstMovable );
3292         this.downButton.setDisabled( !movable || selectedItem === lastMovable );
3293         this.removeButton.setDisabled( !removable );
3294 };
3295
3296 /**
3297  * OutlineOptionWidget is an item in an {@link OO.ui.OutlineSelectWidget OutlineSelectWidget}.
3298  *
3299  * Currently, this class is only used by {@link OO.ui.BookletLayout booklet layouts}, which contain
3300  * {@link OO.ui.PageLayout page layouts}. See {@link OO.ui.BookletLayout BookletLayout}
3301  * for an example.
3302  *
3303  * @class
3304  * @extends OO.ui.DecoratedOptionWidget
3305  *
3306  * @constructor
3307  * @param {Object} [config] Configuration options
3308  * @cfg {number} [level] Indentation level
3309  * @cfg {boolean} [movable] Allow modification from {@link OO.ui.OutlineControlsWidget outline controls}.
3310  */
3311 OO.ui.OutlineOptionWidget = function OoUiOutlineOptionWidget( config ) {
3312         // Configuration initialization
3313         config = config || {};
3314
3315         // Parent constructor
3316         OO.ui.OutlineOptionWidget.parent.call( this, config );
3317
3318         // Properties
3319         this.level = 0;
3320         this.movable = !!config.movable;
3321         this.removable = !!config.removable;
3322
3323         // Initialization
3324         this.$element.addClass( 'oo-ui-outlineOptionWidget' );
3325         this.setLevel( config.level );
3326 };
3327
3328 /* Setup */
3329
3330 OO.inheritClass( OO.ui.OutlineOptionWidget, OO.ui.DecoratedOptionWidget );
3331
3332 /* Static Properties */
3333
3334 /**
3335  * @static
3336  * @inheritdoc
3337  */
3338 OO.ui.OutlineOptionWidget.static.highlightable = true;
3339
3340 /**
3341  * @static
3342  * @inheritdoc
3343  */
3344 OO.ui.OutlineOptionWidget.static.scrollIntoViewOnSelect = true;
3345
3346 /**
3347  * @static
3348  * @inheritable
3349  * @property {string}
3350  */
3351 OO.ui.OutlineOptionWidget.static.levelClass = 'oo-ui-outlineOptionWidget-level-';
3352
3353 /**
3354  * @static
3355  * @inheritable
3356  * @property {number}
3357  */
3358 OO.ui.OutlineOptionWidget.static.levels = 3;
3359
3360 /* Methods */
3361
3362 /**
3363  * Check if item is movable.
3364  *
3365  * Movability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
3366  *
3367  * @return {boolean} Item is movable
3368  */
3369 OO.ui.OutlineOptionWidget.prototype.isMovable = function () {
3370         return this.movable;
3371 };
3372
3373 /**
3374  * Check if item is removable.
3375  *
3376  * Removability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
3377  *
3378  * @return {boolean} Item is removable
3379  */
3380 OO.ui.OutlineOptionWidget.prototype.isRemovable = function () {
3381         return this.removable;
3382 };
3383
3384 /**
3385  * Get indentation level.
3386  *
3387  * @return {number} Indentation level
3388  */
3389 OO.ui.OutlineOptionWidget.prototype.getLevel = function () {
3390         return this.level;
3391 };
3392
3393 /**
3394  * @inheritdoc
3395  */
3396 OO.ui.OutlineOptionWidget.prototype.setPressed = function ( state ) {
3397         OO.ui.OutlineOptionWidget.parent.prototype.setPressed.call( this, state );
3398         if ( this.pressed ) {
3399                 this.setFlags( { progressive: true } );
3400         } else if ( !this.selected ) {
3401                 this.setFlags( { progressive: false } );
3402         }
3403         return this;
3404 };
3405
3406 /**
3407  * Set movability.
3408  *
3409  * Movability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
3410  *
3411  * @param {boolean} movable Item is movable
3412  * @chainable
3413  */
3414 OO.ui.OutlineOptionWidget.prototype.setMovable = function ( movable ) {
3415         this.movable = !!movable;
3416         this.updateThemeClasses();
3417         return this;
3418 };
3419
3420 /**
3421  * Set removability.
3422  *
3423  * Removability is used by {@link OO.ui.OutlineControlsWidget outline controls}.
3424  *
3425  * @param {boolean} removable Item is removable
3426  * @chainable
3427  */
3428 OO.ui.OutlineOptionWidget.prototype.setRemovable = function ( removable ) {
3429         this.removable = !!removable;
3430         this.updateThemeClasses();
3431         return this;
3432 };
3433
3434 /**
3435  * @inheritdoc
3436  */
3437 OO.ui.OutlineOptionWidget.prototype.setSelected = function ( state ) {
3438         OO.ui.OutlineOptionWidget.parent.prototype.setSelected.call( this, state );
3439         if ( this.selected ) {
3440                 this.setFlags( { progressive: true } );
3441         } else {
3442                 this.setFlags( { progressive: false } );
3443         }
3444         return this;
3445 };
3446
3447 /**
3448  * Set indentation level.
3449  *
3450  * @param {number} [level=0] Indentation level, in the range of [0,#maxLevel]
3451  * @chainable
3452  */
3453 OO.ui.OutlineOptionWidget.prototype.setLevel = function ( level ) {
3454         var levels = this.constructor.static.levels,
3455                 levelClass = this.constructor.static.levelClass,
3456                 i = levels;
3457
3458         this.level = level ? Math.max( 0, Math.min( levels - 1, level ) ) : 0;
3459         while ( i-- ) {
3460                 if ( this.level === i ) {
3461                         this.$element.addClass( levelClass + i );
3462                 } else {
3463                         this.$element.removeClass( levelClass + i );
3464                 }
3465         }
3466         this.updateThemeClasses();
3467
3468         return this;
3469 };
3470
3471 /**
3472  * OutlineSelectWidget is a structured list that contains {@link OO.ui.OutlineOptionWidget outline options}
3473  * A set of controls can be provided with an {@link OO.ui.OutlineControlsWidget outline controls} widget.
3474  *
3475  * **Currently, this class is only used by {@link OO.ui.BookletLayout booklet layouts}.**
3476  *
3477  * @class
3478  * @extends OO.ui.SelectWidget
3479  * @mixins OO.ui.mixin.TabIndexedElement
3480  *
3481  * @constructor
3482  * @param {Object} [config] Configuration options
3483  */
3484 OO.ui.OutlineSelectWidget = function OoUiOutlineSelectWidget( config ) {
3485         // Parent constructor
3486         OO.ui.OutlineSelectWidget.parent.call( this, config );
3487
3488         // Mixin constructors
3489         OO.ui.mixin.TabIndexedElement.call( this, config );
3490
3491         // Events
3492         this.$element.on( {
3493                 focus: this.bindKeyDownListener.bind( this ),
3494                 blur: this.unbindKeyDownListener.bind( this )
3495         } );
3496
3497         // Initialization
3498         this.$element.addClass( 'oo-ui-outlineSelectWidget' );
3499 };
3500
3501 /* Setup */
3502
3503 OO.inheritClass( OO.ui.OutlineSelectWidget, OO.ui.SelectWidget );
3504 OO.mixinClass( OO.ui.OutlineSelectWidget, OO.ui.mixin.TabIndexedElement );
3505
3506 /**
3507  * ButtonOptionWidget is a special type of {@link OO.ui.mixin.ButtonElement button element} that
3508  * can be selected and configured with data. The class is
3509  * used with OO.ui.ButtonSelectWidget to create a selection of button options. Please see the
3510  * [OOjs UI documentation on MediaWiki] [1] for more information.
3511  *
3512  * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options#Button_selects_and_options
3513  *
3514  * @class
3515  * @extends OO.ui.OptionWidget
3516  * @mixins OO.ui.mixin.ButtonElement
3517  * @mixins OO.ui.mixin.IconElement
3518  * @mixins OO.ui.mixin.IndicatorElement
3519  * @mixins OO.ui.mixin.TitledElement
3520  *
3521  * @constructor
3522  * @param {Object} [config] Configuration options
3523  */
3524 OO.ui.ButtonOptionWidget = function OoUiButtonOptionWidget( config ) {
3525         // Configuration initialization
3526         config = config || {};
3527
3528         // Parent constructor
3529         OO.ui.ButtonOptionWidget.parent.call( this, config );
3530
3531         // Mixin constructors
3532         OO.ui.mixin.ButtonElement.call( this, config );
3533         OO.ui.mixin.IconElement.call( this, config );
3534         OO.ui.mixin.IndicatorElement.call( this, config );
3535         OO.ui.mixin.TitledElement.call( this, $.extend( {}, config, { $titled: this.$button } ) );
3536
3537         // Initialization
3538         this.$element.addClass( 'oo-ui-buttonOptionWidget' );
3539         this.$button.append( this.$icon, this.$label, this.$indicator );
3540         this.$element.append( this.$button );
3541 };
3542
3543 /* Setup */
3544
3545 OO.inheritClass( OO.ui.ButtonOptionWidget, OO.ui.OptionWidget );
3546 OO.mixinClass( OO.ui.ButtonOptionWidget, OO.ui.mixin.ButtonElement );
3547 OO.mixinClass( OO.ui.ButtonOptionWidget, OO.ui.mixin.IconElement );
3548 OO.mixinClass( OO.ui.ButtonOptionWidget, OO.ui.mixin.IndicatorElement );
3549 OO.mixinClass( OO.ui.ButtonOptionWidget, OO.ui.mixin.TitledElement );
3550
3551 /* Static Properties */
3552
3553 /**
3554  * Allow button mouse down events to pass through so they can be handled by the parent select widget
3555  *
3556  * @static
3557  * @inheritdoc
3558  */
3559 OO.ui.ButtonOptionWidget.static.cancelButtonMouseDownEvents = false;
3560
3561 /**
3562  * @static
3563  * @inheritdoc
3564  */
3565 OO.ui.ButtonOptionWidget.static.highlightable = false;
3566
3567 /* Methods */
3568
3569 /**
3570  * @inheritdoc
3571  */
3572 OO.ui.ButtonOptionWidget.prototype.setSelected = function ( state ) {
3573         OO.ui.ButtonOptionWidget.parent.prototype.setSelected.call( this, state );
3574
3575         if ( this.constructor.static.selectable ) {
3576                 this.setActive( state );
3577         }
3578
3579         return this;
3580 };
3581
3582 /**
3583  * ButtonSelectWidget is a {@link OO.ui.SelectWidget select widget} that contains
3584  * button options and is used together with
3585  * OO.ui.ButtonOptionWidget. The ButtonSelectWidget provides an interface for
3586  * highlighting, choosing, and selecting mutually exclusive options. Please see
3587  * the [OOjs UI documentation on MediaWiki] [1] for more information.
3588  *
3589  *     @example
3590  *     // Example: A ButtonSelectWidget that contains three ButtonOptionWidgets
3591  *     var option1 = new OO.ui.ButtonOptionWidget( {
3592  *         data: 1,
3593  *         label: 'Option 1',
3594  *         title: 'Button option 1'
3595  *     } );
3596  *
3597  *     var option2 = new OO.ui.ButtonOptionWidget( {
3598  *         data: 2,
3599  *         label: 'Option 2',
3600  *         title: 'Button option 2'
3601  *     } );
3602  *
3603  *     var option3 = new OO.ui.ButtonOptionWidget( {
3604  *         data: 3,
3605  *         label: 'Option 3',
3606  *         title: 'Button option 3'
3607  *     } );
3608  *
3609  *     var buttonSelect=new OO.ui.ButtonSelectWidget( {
3610  *         items: [ option1, option2, option3 ]
3611  *     } );
3612  *     $( 'body' ).append( buttonSelect.$element );
3613  *
3614  * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options
3615  *
3616  * @class
3617  * @extends OO.ui.SelectWidget
3618  * @mixins OO.ui.mixin.TabIndexedElement
3619  *
3620  * @constructor
3621  * @param {Object} [config] Configuration options
3622  */
3623 OO.ui.ButtonSelectWidget = function OoUiButtonSelectWidget( config ) {
3624         // Parent constructor
3625         OO.ui.ButtonSelectWidget.parent.call( this, config );
3626
3627         // Mixin constructors
3628         OO.ui.mixin.TabIndexedElement.call( this, config );
3629
3630         // Events
3631         this.$element.on( {
3632                 focus: this.bindKeyDownListener.bind( this ),
3633                 blur: this.unbindKeyDownListener.bind( this )
3634         } );
3635
3636         // Initialization
3637         this.$element.addClass( 'oo-ui-buttonSelectWidget' );
3638 };
3639
3640 /* Setup */
3641
3642 OO.inheritClass( OO.ui.ButtonSelectWidget, OO.ui.SelectWidget );
3643 OO.mixinClass( OO.ui.ButtonSelectWidget, OO.ui.mixin.TabIndexedElement );
3644
3645 /**
3646  * TabOptionWidget is an item in a {@link OO.ui.TabSelectWidget TabSelectWidget}.
3647  *
3648  * Currently, this class is only used by {@link OO.ui.IndexLayout index layouts}, which contain
3649  * {@link OO.ui.TabPanelLayout tab panel layouts}. See {@link OO.ui.IndexLayout IndexLayout}
3650  * for an example.
3651  *
3652  * @class
3653  * @extends OO.ui.OptionWidget
3654  *
3655  * @constructor
3656  * @param {Object} [config] Configuration options
3657  */
3658 OO.ui.TabOptionWidget = function OoUiTabOptionWidget( config ) {
3659         // Configuration initialization
3660         config = config || {};
3661
3662         // Parent constructor
3663         OO.ui.TabOptionWidget.parent.call( this, config );
3664
3665         // Initialization
3666         this.$element.addClass( 'oo-ui-tabOptionWidget' );
3667 };
3668
3669 /* Setup */
3670
3671 OO.inheritClass( OO.ui.TabOptionWidget, OO.ui.OptionWidget );
3672
3673 /* Static Properties */
3674
3675 /**
3676  * @static
3677  * @inheritdoc
3678  */
3679 OO.ui.TabOptionWidget.static.highlightable = false;
3680
3681 /**
3682  * TabSelectWidget is a list that contains {@link OO.ui.TabOptionWidget tab options}
3683  *
3684  * **Currently, this class is only used by {@link OO.ui.IndexLayout index layouts}.**
3685  *
3686  * @class
3687  * @extends OO.ui.SelectWidget
3688  * @mixins OO.ui.mixin.TabIndexedElement
3689  *
3690  * @constructor
3691  * @param {Object} [config] Configuration options
3692  */
3693 OO.ui.TabSelectWidget = function OoUiTabSelectWidget( config ) {
3694         // Parent constructor
3695         OO.ui.TabSelectWidget.parent.call( this, config );
3696
3697         // Mixin constructors
3698         OO.ui.mixin.TabIndexedElement.call( this, config );
3699
3700         // Events
3701         this.$element.on( {
3702                 focus: this.bindKeyDownListener.bind( this ),
3703                 blur: this.unbindKeyDownListener.bind( this )
3704         } );
3705
3706         // Initialization
3707         this.$element.addClass( 'oo-ui-tabSelectWidget' );
3708 };
3709
3710 /* Setup */
3711
3712 OO.inheritClass( OO.ui.TabSelectWidget, OO.ui.SelectWidget );
3713 OO.mixinClass( OO.ui.TabSelectWidget, OO.ui.mixin.TabIndexedElement );
3714
3715 /**
3716  * CapsuleItemWidgets are used within a {@link OO.ui.CapsuleMultiselectWidget
3717  * CapsuleMultiselectWidget} to display the selected items.
3718  *
3719  * @class
3720  * @extends OO.ui.Widget
3721  * @mixins OO.ui.mixin.ItemWidget
3722  * @mixins OO.ui.mixin.LabelElement
3723  * @mixins OO.ui.mixin.FlaggedElement
3724  * @mixins OO.ui.mixin.TabIndexedElement
3725  *
3726  * @constructor
3727  * @param {Object} [config] Configuration options
3728  */
3729 OO.ui.CapsuleItemWidget = function OoUiCapsuleItemWidget( config ) {
3730         // Configuration initialization
3731         config = config || {};
3732
3733         // Parent constructor
3734         OO.ui.CapsuleItemWidget.parent.call( this, config );
3735
3736         // Mixin constructors
3737         OO.ui.mixin.ItemWidget.call( this );
3738         OO.ui.mixin.LabelElement.call( this, config );
3739         OO.ui.mixin.FlaggedElement.call( this, config );
3740         OO.ui.mixin.TabIndexedElement.call( this, config );
3741
3742         // Events
3743         this.closeButton = new OO.ui.ButtonWidget( {
3744                 framed: false,
3745                 indicator: 'clear',
3746                 tabIndex: -1
3747         } ).on( 'click', this.onCloseClick.bind( this ) );
3748
3749         this.on( 'disable', function ( disabled ) {
3750                 this.closeButton.setDisabled( disabled );
3751         }.bind( this ) );
3752
3753         // Initialization
3754         this.$element
3755                 .on( {
3756                         click: this.onClick.bind( this ),
3757                         keydown: this.onKeyDown.bind( this )
3758                 } )
3759                 .addClass( 'oo-ui-capsuleItemWidget' )
3760                 .append( this.$label, this.closeButton.$element );
3761 };
3762
3763 /* Setup */
3764
3765 OO.inheritClass( OO.ui.CapsuleItemWidget, OO.ui.Widget );
3766 OO.mixinClass( OO.ui.CapsuleItemWidget, OO.ui.mixin.ItemWidget );
3767 OO.mixinClass( OO.ui.CapsuleItemWidget, OO.ui.mixin.LabelElement );
3768 OO.mixinClass( OO.ui.CapsuleItemWidget, OO.ui.mixin.FlaggedElement );
3769 OO.mixinClass( OO.ui.CapsuleItemWidget, OO.ui.mixin.TabIndexedElement );
3770
3771 /* Methods */
3772
3773 /**
3774  * Handle close icon clicks
3775  */
3776 OO.ui.CapsuleItemWidget.prototype.onCloseClick = function () {
3777         var element = this.getElementGroup();
3778
3779         if ( element && $.isFunction( element.removeItems ) ) {
3780                 element.removeItems( [ this ] );
3781                 element.focus();
3782         }
3783 };
3784
3785 /**
3786  * Handle click event for the entire capsule
3787  */
3788 OO.ui.CapsuleItemWidget.prototype.onClick = function () {
3789         var element = this.getElementGroup();
3790
3791         if ( !this.isDisabled() && element && $.isFunction( element.editItem ) ) {
3792                 element.editItem( this );
3793         }
3794 };
3795
3796 /**
3797  * Handle keyDown event for the entire capsule
3798  *
3799  * @param {jQuery.Event} e Key down event
3800  */
3801 OO.ui.CapsuleItemWidget.prototype.onKeyDown = function ( e ) {
3802         var element = this.getElementGroup();
3803
3804         if ( e.keyCode === OO.ui.Keys.BACKSPACE || e.keyCode === OO.ui.Keys.DELETE ) {
3805                 element.removeItems( [ this ] );
3806                 element.focus();
3807                 return false;
3808         } else if ( e.keyCode === OO.ui.Keys.ENTER ) {
3809                 element.editItem( this );
3810                 return false;
3811         } else if ( e.keyCode === OO.ui.Keys.LEFT ) {
3812                 element.getPreviousItem( this ).focus();
3813         } else if ( e.keyCode === OO.ui.Keys.RIGHT ) {
3814                 element.getNextItem( this ).focus();
3815         }
3816 };
3817
3818 /**
3819  * CapsuleMultiselectWidgets are something like a {@link OO.ui.ComboBoxInputWidget combo box widget}
3820  * that allows for selecting multiple values.
3821  *
3822  * For more information about menus and options, please see the [OOjs UI documentation on MediaWiki][1].
3823  *
3824  *     @example
3825  *     // Example: A CapsuleMultiselectWidget.
3826  *     var capsule = new OO.ui.CapsuleMultiselectWidget( {
3827  *         label: 'CapsuleMultiselectWidget',
3828  *         selected: [ 'Option 1', 'Option 3' ],
3829  *         menu: {
3830  *             items: [
3831  *                 new OO.ui.MenuOptionWidget( {
3832  *                     data: 'Option 1',
3833  *                     label: 'Option One'
3834  *                 } ),
3835  *                 new OO.ui.MenuOptionWidget( {
3836  *                     data: 'Option 2',
3837  *                     label: 'Option Two'
3838  *                 } ),
3839  *                 new OO.ui.MenuOptionWidget( {
3840  *                     data: 'Option 3',
3841  *                     label: 'Option Three'
3842  *                 } ),
3843  *                 new OO.ui.MenuOptionWidget( {
3844  *                     data: 'Option 4',
3845  *                     label: 'Option Four'
3846  *                 } ),
3847  *                 new OO.ui.MenuOptionWidget( {
3848  *                     data: 'Option 5',
3849  *                     label: 'Option Five'
3850  *                 } )
3851  *             ]
3852  *         }
3853  *     } );
3854  *     $( 'body' ).append( capsule.$element );
3855  *
3856  * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options#Menu_selects_and_options
3857  *
3858  * @class
3859  * @extends OO.ui.Widget
3860  * @mixins OO.ui.mixin.GroupElement
3861  * @mixins OO.ui.mixin.PopupElement
3862  * @mixins OO.ui.mixin.TabIndexedElement
3863  * @mixins OO.ui.mixin.IndicatorElement
3864  * @mixins OO.ui.mixin.IconElement
3865  * @uses OO.ui.CapsuleItemWidget
3866  * @uses OO.ui.MenuSelectWidget
3867  *
3868  * @constructor
3869  * @param {Object} [config] Configuration options
3870  * @cfg {string} [placeholder] Placeholder text
3871  * @cfg {boolean} [allowArbitrary=false] Allow data items to be added even if not present in the menu.
3872  * @cfg {boolean} [allowDuplicates=false] Allow duplicate items to be added.
3873  * @cfg {Object} [menu] (required) Configuration options to pass to the
3874  *  {@link OO.ui.MenuSelectWidget menu select widget}.
3875  * @cfg {Object} [popup] Configuration options to pass to the {@link OO.ui.PopupWidget popup widget}.
3876  *  If specified, this popup will be shown instead of the menu (but the menu
3877  *  will still be used for item labels and allowArbitrary=false). The widgets
3878  *  in the popup should use {@link #addItemsFromData} or {@link #addItems} as necessary.
3879  * @cfg {jQuery} [$overlay=this.$element] Render the menu or popup into a separate layer.
3880  *  This configuration is useful in cases where the expanded menu is larger than
3881  *  its containing `<div>`. The specified overlay layer is usually on top of
3882  *  the containing `<div>` and has a larger area. By default, the menu uses
3883  *  relative positioning.
3884  *  See <https://www.mediawiki.org/wiki/OOjs_UI/Concepts#Overlays>.
3885  */
3886 OO.ui.CapsuleMultiselectWidget = function OoUiCapsuleMultiselectWidget( config ) {
3887         var $tabFocus;
3888
3889         // Parent constructor
3890         OO.ui.CapsuleMultiselectWidget.parent.call( this, config );
3891
3892         // Configuration initialization
3893         config = $.extend( {
3894                 allowArbitrary: false,
3895                 allowDuplicates: false,
3896                 $overlay: this.$element
3897         }, config );
3898
3899         // Properties (must be set before mixin constructor calls)
3900         this.$handle = $( '<div>' );
3901         this.$input = config.popup ? null : $( '<input>' );
3902         if ( config.placeholder !== undefined && config.placeholder !== '' ) {
3903                 this.$input.attr( 'placeholder', config.placeholder );
3904         }
3905
3906         // Mixin constructors
3907         OO.ui.mixin.GroupElement.call( this, config );
3908         if ( config.popup ) {
3909                 config.popup = $.extend( {}, config.popup, {
3910                         align: 'forwards',
3911                         anchor: false
3912                 } );
3913                 OO.ui.mixin.PopupElement.call( this, config );
3914                 $tabFocus = $( '<span>' );
3915                 OO.ui.mixin.TabIndexedElement.call( this, $.extend( {}, config, { $tabIndexed: $tabFocus } ) );
3916         } else {
3917                 this.popup = null;
3918                 $tabFocus = null;
3919                 OO.ui.mixin.TabIndexedElement.call( this, $.extend( {}, config, { $tabIndexed: this.$input } ) );
3920         }
3921         OO.ui.mixin.IndicatorElement.call( this, config );
3922         OO.ui.mixin.IconElement.call( this, config );
3923
3924         // Properties
3925         this.$content = $( '<div>' );
3926         this.allowArbitrary = config.allowArbitrary;
3927         this.allowDuplicates = config.allowDuplicates;
3928         this.$overlay = config.$overlay;
3929         this.menu = new OO.ui.MenuSelectWidget( $.extend(
3930                 {
3931                         widget: this,
3932                         $input: this.$input,
3933                         $floatableContainer: this.$element,
3934                         filterFromInput: true,
3935                         disabled: this.isDisabled()
3936                 },
3937                 config.menu
3938         ) );
3939
3940         // Events
3941         if ( this.popup ) {
3942                 $tabFocus.on( {
3943                         focus: this.focus.bind( this )
3944                 } );
3945                 this.popup.$element.on( 'focusout', this.onPopupFocusOut.bind( this ) );
3946                 if ( this.popup.$autoCloseIgnore ) {
3947                         this.popup.$autoCloseIgnore.on( 'focusout', this.onPopupFocusOut.bind( this ) );
3948                 }
3949                 this.popup.connect( this, {
3950                         toggle: function ( visible ) {
3951                                 $tabFocus.toggle( !visible );
3952                         }
3953                 } );
3954         } else {
3955                 this.$input.on( {
3956                         focus: this.onInputFocus.bind( this ),
3957                         blur: this.onInputBlur.bind( this ),
3958                         'propertychange change click mouseup keydown keyup input cut paste select focus':
3959                                 OO.ui.debounce( this.updateInputSize.bind( this ) ),
3960                         keydown: this.onKeyDown.bind( this ),
3961                         keypress: this.onKeyPress.bind( this )
3962                 } );
3963         }
3964         this.menu.connect( this, {
3965                 choose: 'onMenuChoose',
3966                 toggle: 'onMenuToggle',
3967                 add: 'onMenuItemsChange',
3968                 remove: 'onMenuItemsChange'
3969         } );
3970         this.$handle.on( {
3971                 mousedown: this.onMouseDown.bind( this )
3972         } );
3973
3974         // Initialization
3975         if ( this.$input ) {
3976                 this.$input.prop( 'disabled', this.isDisabled() );
3977                 this.$input.attr( {
3978                         role: 'combobox',
3979                         'aria-owns': this.menu.getElementId(),
3980                         'aria-autocomplete': 'list'
3981                 } );
3982         }
3983         if ( config.data ) {
3984                 this.setItemsFromData( config.data );
3985         }
3986         this.$content.addClass( 'oo-ui-capsuleMultiselectWidget-content' )
3987                 .append( this.$group );
3988         this.$group.addClass( 'oo-ui-capsuleMultiselectWidget-group' );
3989         this.$handle.addClass( 'oo-ui-capsuleMultiselectWidget-handle' )
3990                 .append( this.$indicator, this.$icon, this.$content );
3991         this.$element.addClass( 'oo-ui-capsuleMultiselectWidget' )
3992                 .append( this.$handle );
3993         if ( this.popup ) {
3994                 this.popup.$element.addClass( 'oo-ui-capsuleMultiselectWidget-popup' );
3995                 this.$content.append( $tabFocus );
3996                 this.$overlay.append( this.popup.$element );
3997         } else {
3998                 this.$content.append( this.$input );
3999                 this.$overlay.append( this.menu.$element );
4000         }
4001         if ( $tabFocus ) {
4002                 $tabFocus.addClass( 'oo-ui-capsuleMultiselectWidget-focusTrap' );
4003         }
4004
4005         // Input size needs to be calculated after everything else is rendered
4006         setTimeout( function () {
4007                 if ( this.$input ) {
4008                         this.updateInputSize();
4009                 }
4010         }.bind( this ) );
4011
4012         this.onMenuItemsChange();
4013 };
4014
4015 /* Setup */
4016
4017 OO.inheritClass( OO.ui.CapsuleMultiselectWidget, OO.ui.Widget );
4018 OO.mixinClass( OO.ui.CapsuleMultiselectWidget, OO.ui.mixin.GroupElement );
4019 OO.mixinClass( OO.ui.CapsuleMultiselectWidget, OO.ui.mixin.PopupElement );
4020 OO.mixinClass( OO.ui.CapsuleMultiselectWidget, OO.ui.mixin.TabIndexedElement );
4021 OO.mixinClass( OO.ui.CapsuleMultiselectWidget, OO.ui.mixin.IndicatorElement );
4022 OO.mixinClass( OO.ui.CapsuleMultiselectWidget, OO.ui.mixin.IconElement );
4023
4024 /* Events */
4025
4026 /**
4027  * @event change
4028  *
4029  * A change event is emitted when the set of selected items changes.
4030  *
4031  * @param {Mixed[]} datas Data of the now-selected items
4032  */
4033
4034 /**
4035  * @event resize
4036  *
4037  * A resize event is emitted when the widget's dimensions change to accomodate newly added items or
4038  * current user input.
4039  */
4040
4041 /* Methods */
4042
4043 /**
4044  * Construct a OO.ui.CapsuleItemWidget (or a subclass thereof) from given label and data.
4045  * May return `null` if the given label and data are not valid.
4046  *
4047  * @protected
4048  * @param {Mixed} data Custom data of any type.
4049  * @param {string} label The label text.
4050  * @return {OO.ui.CapsuleItemWidget|null}
4051  */
4052 OO.ui.CapsuleMultiselectWidget.prototype.createItemWidget = function ( data, label ) {
4053         if ( label === '' ) {
4054                 return null;
4055         }
4056         return new OO.ui.CapsuleItemWidget( { data: data, label: label } );
4057 };
4058
4059 /**
4060  * @inheritdoc
4061  */
4062 OO.ui.CapsuleMultiselectWidget.prototype.getInputId = function () {
4063         if ( !this.$input ) {
4064                 return null;
4065         }
4066         return OO.ui.mixin.TabIndexedElement.prototype.getInputId.call( this );
4067 };
4068
4069 /**
4070  * Get the data of the items in the capsule
4071  *
4072  * @return {Mixed[]}
4073  */
4074 OO.ui.CapsuleMultiselectWidget.prototype.getItemsData = function () {
4075         return this.getItems().map( function ( item ) {
4076                 return item.data;
4077         } );
4078 };
4079
4080 /**
4081  * Set the items in the capsule by providing data
4082  *
4083  * @chainable
4084  * @param {Mixed[]} datas
4085  * @return {OO.ui.CapsuleMultiselectWidget}
4086  */
4087 OO.ui.CapsuleMultiselectWidget.prototype.setItemsFromData = function ( datas ) {
4088         var widget = this,
4089                 menu = this.menu,
4090                 items = this.getItems();
4091
4092         $.each( datas, function ( i, data ) {
4093                 var j, label,
4094                         item = menu.getItemFromData( data );
4095
4096                 if ( item ) {
4097                         label = item.label;
4098                 } else if ( widget.allowArbitrary ) {
4099                         label = String( data );
4100                 } else {
4101                         return;
4102                 }
4103
4104                 item = null;
4105                 for ( j = 0; j < items.length; j++ ) {
4106                         if ( items[ j ].data === data && items[ j ].label === label ) {
4107                                 item = items[ j ];
4108                                 items.splice( j, 1 );
4109                                 break;
4110                         }
4111                 }
4112                 if ( !item ) {
4113                         item = widget.createItemWidget( data, label );
4114                 }
4115                 if ( item ) {
4116                         widget.addItems( [ item ], i );
4117                 }
4118         } );
4119
4120         if ( items.length ) {
4121                 widget.removeItems( items );
4122         }
4123
4124         return this;
4125 };
4126
4127 /**
4128  * Add items to the capsule by providing their data
4129  *
4130  * @chainable
4131  * @param {Mixed[]} datas
4132  * @return {OO.ui.CapsuleMultiselectWidget}
4133  */
4134 OO.ui.CapsuleMultiselectWidget.prototype.addItemsFromData = function ( datas ) {
4135         var widget = this,
4136                 menu = this.menu,
4137                 items = [];
4138
4139         $.each( datas, function ( i, data ) {
4140                 var item;
4141
4142                 if ( !widget.getItemFromData( data ) || widget.allowDuplicates ) {
4143                         item = menu.getItemFromData( data );
4144                         if ( item ) {
4145                                 item = widget.createItemWidget( data, item.label );
4146                         } else if ( widget.allowArbitrary ) {
4147                                 item = widget.createItemWidget( data, String( data ) );
4148                         }
4149                         if ( item ) {
4150                                 items.push( item );
4151                         }
4152                 }
4153         } );
4154
4155         if ( items.length ) {
4156                 this.addItems( items );
4157         }
4158
4159         return this;
4160 };
4161
4162 /**
4163  * Add items to the capsule by providing a label
4164  *
4165  * @param {string} label
4166  * @return {boolean} Whether the item was added or not
4167  */
4168 OO.ui.CapsuleMultiselectWidget.prototype.addItemFromLabel = function ( label ) {
4169         var item, items;
4170         item = this.menu.getItemFromLabel( label, true );
4171         if ( item ) {
4172                 this.addItemsFromData( [ item.data ] );
4173                 return true;
4174         } else if ( this.allowArbitrary ) {
4175                 items = this.getItems();
4176                 this.addItemsFromData( [ label ] );
4177                 return !OO.compare( this.getItems(), items );
4178         }
4179         return false;
4180 };
4181
4182 /**
4183  * Remove items by data
4184  *
4185  * @chainable
4186  * @param {Mixed[]} datas
4187  * @return {OO.ui.CapsuleMultiselectWidget}
4188  */
4189 OO.ui.CapsuleMultiselectWidget.prototype.removeItemsFromData = function ( datas ) {
4190         var widget = this,
4191                 items = [];
4192
4193         $.each( datas, function ( i, data ) {
4194                 var item = widget.getItemFromData( data );
4195                 if ( item ) {
4196                         items.push( item );
4197                 }
4198         } );
4199
4200         if ( items.length ) {
4201                 this.removeItems( items );
4202         }
4203
4204         return this;
4205 };
4206
4207 /**
4208  * @inheritdoc
4209  */
4210 OO.ui.CapsuleMultiselectWidget.prototype.addItems = function ( items ) {
4211         var same, i, l,
4212                 oldItems = this.items.slice();
4213
4214         OO.ui.mixin.GroupElement.prototype.addItems.call( this, items );
4215
4216         if ( this.items.length !== oldItems.length ) {
4217                 same = false;
4218         } else {
4219                 same = true;
4220                 for ( i = 0, l = oldItems.length; same && i < l; i++ ) {
4221                         same = same && this.items[ i ] === oldItems[ i ];
4222                 }
4223         }
4224         if ( !same ) {
4225                 this.emit( 'change', this.getItemsData() );
4226                 this.updateInputSize();
4227         }
4228
4229         return this;
4230 };
4231
4232 /**
4233  * Removes the item from the list and copies its label to `this.$input`.
4234  *
4235  * @param {Object} item
4236  */
4237 OO.ui.CapsuleMultiselectWidget.prototype.editItem = function ( item ) {
4238         this.addItemFromLabel( this.$input.val() );
4239         this.clearInput();
4240         this.$input.val( item.label );
4241         this.updateInputSize();
4242         this.focus();
4243         this.menu.updateItemVisibility(); // Hack, we shouldn't be calling this method directly
4244         this.removeItems( [ item ] );
4245 };
4246
4247 /**
4248  * @inheritdoc
4249  */
4250 OO.ui.CapsuleMultiselectWidget.prototype.removeItems = function ( items ) {
4251         var same, i, l,
4252                 oldItems = this.items.slice();
4253
4254         OO.ui.mixin.GroupElement.prototype.removeItems.call( this, items );
4255
4256         if ( this.items.length !== oldItems.length ) {
4257                 same = false;
4258         } else {
4259                 same = true;
4260                 for ( i = 0, l = oldItems.length; same && i < l; i++ ) {
4261                         same = same && this.items[ i ] === oldItems[ i ];
4262                 }
4263         }
4264         if ( !same ) {
4265                 this.emit( 'change', this.getItemsData() );
4266                 this.updateInputSize();
4267         }
4268
4269         return this;
4270 };
4271
4272 /**
4273  * @inheritdoc
4274  */
4275 OO.ui.CapsuleMultiselectWidget.prototype.clearItems = function () {
4276         if ( this.items.length ) {
4277                 OO.ui.mixin.GroupElement.prototype.clearItems.call( this );
4278                 this.emit( 'change', this.getItemsData() );
4279                 this.updateInputSize();
4280         }
4281         return this;
4282 };
4283
4284 /**
4285  * Given an item, returns the item after it. If its the last item,
4286  * returns `this.$input`. If no item is passed, returns the very first
4287  * item.
4288  *
4289  * @param {OO.ui.CapsuleItemWidget} [item]
4290  * @return {OO.ui.CapsuleItemWidget|jQuery|boolean}
4291  */
4292 OO.ui.CapsuleMultiselectWidget.prototype.getNextItem = function ( item ) {
4293         var itemIndex;
4294
4295         if ( item === undefined ) {
4296                 return this.items[ 0 ];
4297         }
4298
4299         itemIndex = this.items.indexOf( item );
4300         if ( itemIndex < 0 ) { // Item not in list
4301                 return false;
4302         } else if ( itemIndex === this.items.length - 1 ) { // Last item
4303                 return this.$input;
4304         } else {
4305                 return this.items[ itemIndex + 1 ];
4306         }
4307 };
4308
4309 /**
4310  * Given an item, returns the item before it. If its the first item,
4311  * returns `this.$input`. If no item is passed, returns the very last
4312  * item.
4313  *
4314  * @param {OO.ui.CapsuleItemWidget} [item]
4315  * @return {OO.ui.CapsuleItemWidget|jQuery|boolean}
4316  */
4317 OO.ui.CapsuleMultiselectWidget.prototype.getPreviousItem = function ( item ) {
4318         var itemIndex;
4319
4320         if ( item === undefined ) {
4321                 return this.items[ this.items.length - 1 ];
4322         }
4323
4324         itemIndex = this.items.indexOf( item );
4325         if ( itemIndex < 0 ) { // Item not in list
4326                 return false;
4327         } else if ( itemIndex === 0 ) { // First item
4328                 return this.$input;
4329         } else {
4330                 return this.items[ itemIndex - 1 ];
4331         }
4332 };
4333
4334 /**
4335  * Get the capsule widget's menu.
4336  *
4337  * @return {OO.ui.MenuSelectWidget} Menu widget
4338  */
4339 OO.ui.CapsuleMultiselectWidget.prototype.getMenu = function () {
4340         return this.menu;
4341 };
4342
4343 /**
4344  * Handle focus events
4345  *
4346  * @private
4347  * @param {jQuery.Event} event
4348  */
4349 OO.ui.CapsuleMultiselectWidget.prototype.onInputFocus = function () {
4350         if ( !this.isDisabled() ) {
4351                 this.updateInputSize();
4352                 this.menu.toggle( true );
4353         }
4354 };
4355
4356 /**
4357  * Handle blur events
4358  *
4359  * @private
4360  * @param {jQuery.Event} event
4361  */
4362 OO.ui.CapsuleMultiselectWidget.prototype.onInputBlur = function () {
4363         this.addItemFromLabel( this.$input.val() );
4364         this.clearInput();
4365 };
4366
4367 /**
4368  * Handles popup focus out events.
4369  *
4370  * @private
4371  * @param {jQuery.Event} e Focus out event
4372  */
4373 OO.ui.CapsuleMultiselectWidget.prototype.onPopupFocusOut = function () {
4374         var widget = this.popup;
4375
4376         setTimeout( function () {
4377                 if (
4378                         widget.isVisible() &&
4379                         !OO.ui.contains( widget.$element.add( widget.$autoCloseIgnore ).get(), document.activeElement, true )
4380                 ) {
4381                         widget.toggle( false );
4382                 }
4383         } );
4384 };
4385
4386 /**
4387  * Handle mouse down events.
4388  *
4389  * @private
4390  * @param {jQuery.Event} e Mouse down event
4391  */
4392 OO.ui.CapsuleMultiselectWidget.prototype.onMouseDown = function ( e ) {
4393         if ( e.which === OO.ui.MouseButtons.LEFT ) {
4394                 this.focus();
4395                 return false;
4396         } else {
4397                 this.updateInputSize();
4398         }
4399 };
4400
4401 /**
4402  * Handle key press events.
4403  *
4404  * @private
4405  * @param {jQuery.Event} e Key press event
4406  */
4407 OO.ui.CapsuleMultiselectWidget.prototype.onKeyPress = function ( e ) {
4408         if ( !this.isDisabled() ) {
4409                 if ( e.which === OO.ui.Keys.ESCAPE ) {
4410                         this.clearInput();
4411                         return false;
4412                 }
4413
4414                 if ( !this.popup ) {
4415                         this.menu.toggle( true );
4416                         if ( e.which === OO.ui.Keys.ENTER ) {
4417                                 if ( this.addItemFromLabel( this.$input.val() ) ) {
4418                                         this.clearInput();
4419                                 }
4420                                 return false;
4421                         }
4422
4423                         // Make sure the input gets resized.
4424                         setTimeout( this.updateInputSize.bind( this ), 0 );
4425                 }
4426         }
4427 };
4428
4429 /**
4430  * Handle key down events.
4431  *
4432  * @private
4433  * @param {jQuery.Event} e Key down event
4434  */
4435 OO.ui.CapsuleMultiselectWidget.prototype.onKeyDown = function ( e ) {
4436         if (
4437                 !this.isDisabled() &&
4438                 this.$input.val() === '' &&
4439                 this.items.length
4440         ) {
4441                 // 'keypress' event is not triggered for Backspace
4442                 if ( e.keyCode === OO.ui.Keys.BACKSPACE ) {
4443                         if ( e.metaKey || e.ctrlKey ) {
4444                                 this.removeItems( this.items.slice( -1 ) );
4445                         } else {
4446                                 this.editItem( this.items[ this.items.length - 1 ] );
4447                         }
4448                         return false;
4449                 } else if ( e.keyCode === OO.ui.Keys.LEFT ) {
4450                         this.getPreviousItem().focus();
4451                 } else if ( e.keyCode === OO.ui.Keys.RIGHT ) {
4452                         this.getNextItem().focus();
4453                 }
4454         }
4455 };
4456
4457 /**
4458  * Update the dimensions of the text input field to encompass all available area.
4459  *
4460  * @private
4461  * @param {jQuery.Event} e Event of some sort
4462  */
4463 OO.ui.CapsuleMultiselectWidget.prototype.updateInputSize = function () {
4464         var $lastItem, direction, contentWidth, currentWidth, bestWidth;
4465         if ( this.$input && !this.isDisabled() ) {
4466                 this.$input.css( 'width', '1em' );
4467                 $lastItem = this.$group.children().last();
4468                 direction = OO.ui.Element.static.getDir( this.$handle );
4469
4470                 // Get the width of the input with the placeholder text as
4471                 // the value and save it so that we don't keep recalculating
4472                 if (
4473                         this.contentWidthWithPlaceholder === undefined &&
4474                         this.$input.val() === '' &&
4475                         this.$input.attr( 'placeholder' ) !== undefined
4476                 ) {
4477                         this.$input.val( this.$input.attr( 'placeholder' ) );
4478                         this.contentWidthWithPlaceholder = this.$input[ 0 ].scrollWidth;
4479                         this.$input.val( '' );
4480
4481                 }
4482
4483                 // Always keep the input wide enough for the placeholder text
4484                 contentWidth = Math.max(
4485                         this.$input[ 0 ].scrollWidth,
4486                         // undefined arguments in Math.max lead to NaN
4487                         ( this.contentWidthWithPlaceholder === undefined ) ?
4488                                 0 : this.contentWidthWithPlaceholder
4489                 );
4490                 currentWidth = this.$input.width();
4491
4492                 if ( contentWidth < currentWidth ) {
4493                         this.updateIfHeightChanged();
4494                         // All is fine, don't perform expensive calculations
4495                         return;
4496                 }
4497
4498                 if ( $lastItem.length === 0 ) {
4499                         bestWidth = this.$content.innerWidth();
4500                 } else {
4501                         bestWidth = direction === 'ltr' ?
4502                                 this.$content.innerWidth() - $lastItem.position().left - $lastItem.outerWidth() :
4503                                 $lastItem.position().left;
4504                 }
4505
4506                 // Some safety margin for sanity, because I *really* don't feel like finding out where the few
4507                 // pixels this is off by are coming from.
4508                 bestWidth -= 10;
4509                 if ( contentWidth > bestWidth ) {
4510                         // This will result in the input getting shifted to the next line
4511                         bestWidth = this.$content.innerWidth() - 10;
4512                 }
4513                 this.$input.width( Math.floor( bestWidth ) );
4514                 this.updateIfHeightChanged();
4515         } else {
4516                 this.updateIfHeightChanged();
4517         }
4518 };
4519
4520 /**
4521  * Determine if widget height changed, and if so, update menu position and emit 'resize' event.
4522  *
4523  * @private
4524  */
4525 OO.ui.CapsuleMultiselectWidget.prototype.updateIfHeightChanged = function () {
4526         var height = this.$element.height();
4527         if ( height !== this.height ) {
4528                 this.height = height;
4529                 this.menu.position();
4530                 if ( this.popup ) {
4531                         this.popup.updateDimensions();
4532                 }
4533                 this.emit( 'resize' );
4534         }
4535 };
4536
4537 /**
4538  * Handle menu choose events.
4539  *
4540  * @private
4541  * @param {OO.ui.OptionWidget} item Chosen item
4542  */
4543 OO.ui.CapsuleMultiselectWidget.prototype.onMenuChoose = function ( item ) {
4544         if ( item && item.isVisible() ) {
4545                 this.addItemsFromData( [ item.getData() ] );
4546                 this.clearInput();
4547         }
4548 };
4549
4550 /**
4551  * Handle menu toggle events.
4552  *
4553  * @private
4554  * @param {boolean} isVisible Menu toggle event
4555  */
4556 OO.ui.CapsuleMultiselectWidget.prototype.onMenuToggle = function ( isVisible ) {
4557         this.$element.toggleClass( 'oo-ui-capsuleMultiselectWidget-open', isVisible );
4558 };
4559
4560 /**
4561  * Handle menu item change events.
4562  *
4563  * @private
4564  */
4565 OO.ui.CapsuleMultiselectWidget.prototype.onMenuItemsChange = function () {
4566         this.setItemsFromData( this.getItemsData() );
4567         this.$element.toggleClass( 'oo-ui-capsuleMultiselectWidget-empty', this.menu.isEmpty() );
4568 };
4569
4570 /**
4571  * Clear the input field
4572  *
4573  * @private
4574  */
4575 OO.ui.CapsuleMultiselectWidget.prototype.clearInput = function () {
4576         if ( this.$input ) {
4577                 this.$input.val( '' );
4578                 this.updateInputSize();
4579         }
4580         if ( this.popup ) {
4581                 this.popup.toggle( false );
4582         }
4583         this.menu.toggle( false );
4584         this.menu.selectItem();
4585         this.menu.highlightItem();
4586 };
4587
4588 /**
4589  * @inheritdoc
4590  */
4591 OO.ui.CapsuleMultiselectWidget.prototype.setDisabled = function ( disabled ) {
4592         var i, len;
4593
4594         // Parent method
4595         OO.ui.CapsuleMultiselectWidget.parent.prototype.setDisabled.call( this, disabled );
4596
4597         if ( this.$input ) {
4598                 this.$input.prop( 'disabled', this.isDisabled() );
4599         }
4600         if ( this.menu ) {
4601                 this.menu.setDisabled( this.isDisabled() );
4602         }
4603         if ( this.popup ) {
4604                 this.popup.setDisabled( this.isDisabled() );
4605         }
4606
4607         if ( this.items ) {
4608                 for ( i = 0, len = this.items.length; i < len; i++ ) {
4609                         this.items[ i ].updateDisabled();
4610                 }
4611         }
4612
4613         return this;
4614 };
4615
4616 /**
4617  * Focus the widget
4618  *
4619  * @chainable
4620  */
4621 OO.ui.CapsuleMultiselectWidget.prototype.focus = function () {
4622         if ( !this.isDisabled() ) {
4623                 if ( this.popup ) {
4624                         this.popup.setSize( this.$handle.outerWidth() );
4625                         this.popup.toggle( true );
4626                         OO.ui.findFocusable( this.popup.$element ).focus();
4627                 } else {
4628                         OO.ui.mixin.TabIndexedElement.prototype.focus.call( this );
4629                 }
4630         }
4631         return this;
4632 };
4633
4634 /**
4635  * TagItemWidgets are used within a {@link OO.ui.TagMultiselectWidget
4636  * TagMultiselectWidget} to display the selected items.
4637  *
4638  * @class
4639  * @extends OO.ui.Widget
4640  * @mixins OO.ui.mixin.ItemWidget
4641  * @mixins OO.ui.mixin.LabelElement
4642  * @mixins OO.ui.mixin.FlaggedElement
4643  * @mixins OO.ui.mixin.TabIndexedElement
4644  * @mixins OO.ui.mixin.DraggableElement
4645  *
4646  * @constructor
4647  * @param {Object} [config] Configuration object
4648  * @cfg {boolean} [valid=true] Item is valid
4649  */
4650 OO.ui.TagItemWidget = function OoUiTagItemWidget( config ) {
4651         config = config || {};
4652
4653         // Parent constructor
4654         OO.ui.TagItemWidget.parent.call( this, config );
4655
4656         // Mixin constructors
4657         OO.ui.mixin.ItemWidget.call( this );
4658         OO.ui.mixin.LabelElement.call( this, config );
4659         OO.ui.mixin.FlaggedElement.call( this, config );
4660         OO.ui.mixin.TabIndexedElement.call( this, config );
4661         OO.ui.mixin.DraggableElement.call( this, config );
4662
4663         this.valid = config.valid === undefined ? true : !!config.valid;
4664
4665         this.closeButton = new OO.ui.ButtonWidget( {
4666                 framed: false,
4667                 indicator: 'clear',
4668                 tabIndex: -1
4669         } );
4670         this.closeButton.setDisabled( this.isDisabled() );
4671
4672         // Events
4673         this.closeButton
4674                 .connect( this, { click: 'remove' } );
4675         this.$element
4676                 .on( 'click', this.select.bind( this ) )
4677                 .on( 'keydown', this.onKeyDown.bind( this ) )
4678                 // Prevent propagation of mousedown; the tag item "lives" in the
4679                 // clickable area of the TagMultiselectWidget, which listens to
4680                 // mousedown to open the menu or popup. We want to prevent that
4681                 // for clicks specifically on the tag itself, so the actions taken
4682                 // are more deliberate. When the tag is clicked, it will emit the
4683                 // selection event (similar to how #OO.ui.MultioptionWidget emits 'change')
4684                 // and can be handled separately.
4685                 .on( 'mousedown', function ( e ) { e.stopPropagation(); } );
4686
4687         // Initialization
4688         this.$element
4689                 .addClass( 'oo-ui-tagItemWidget' )
4690                 .append( this.$label, this.closeButton.$element );
4691 };
4692
4693 /* Initialization */
4694
4695 OO.inheritClass( OO.ui.TagItemWidget, OO.ui.Widget );
4696 OO.mixinClass( OO.ui.TagItemWidget, OO.ui.mixin.ItemWidget );
4697 OO.mixinClass( OO.ui.TagItemWidget, OO.ui.mixin.LabelElement );
4698 OO.mixinClass( OO.ui.TagItemWidget, OO.ui.mixin.FlaggedElement );
4699 OO.mixinClass( OO.ui.TagItemWidget, OO.ui.mixin.TabIndexedElement );
4700 OO.mixinClass( OO.ui.TagItemWidget, OO.ui.mixin.DraggableElement );
4701
4702 /* Events */
4703
4704 /**
4705  * @event remove
4706  *
4707  * A remove action was performed on the item
4708  */
4709
4710 /**
4711  * @event navigate
4712  * @param {string} direction Direction of the movement, forward or backwards
4713  *
4714  * A navigate action was performed on the item
4715  */
4716
4717 /**
4718  * @event select
4719  *
4720  * The tag widget was selected. This can occur when the widget
4721  * is either clicked or enter was pressed on it.
4722  */
4723
4724 /**
4725  * @event valid
4726  * @param {boolean} isValid Item is valid
4727  *
4728  * Item validity has changed
4729  */
4730
4731 /* Methods */
4732
4733 /**
4734  * @inheritdoc
4735  */
4736 OO.ui.TagItemWidget.prototype.setDisabled = function ( state ) {
4737         // Parent method
4738         OO.ui.TagItemWidget.parent.prototype.setDisabled.call( this, state );
4739
4740         if ( this.closeButton ) {
4741                 this.closeButton.setDisabled( state );
4742         }
4743         return this;
4744 };
4745
4746 /**
4747  * Handle removal of the item
4748  *
4749  * This is mainly for extensibility concerns, so other children
4750  * of this class can change the behavior if they need to. This
4751  * is called by both clicking the 'remove' button but also
4752  * on keypress, which is harder to override if needed.
4753  *
4754  * @fires remove
4755  */
4756 OO.ui.TagItemWidget.prototype.remove = function () {
4757         if ( !this.isDisabled() ) {
4758                 this.emit( 'remove' );
4759         }
4760 };
4761
4762 /**
4763  * Handle a keydown event on the widget
4764  *
4765  * @fires navigate
4766  * @fires remove
4767  * @param {jQuery.Event} e Key down event
4768  * @return {boolean|undefined} false to stop the operation
4769  */
4770 OO.ui.TagItemWidget.prototype.onKeyDown = function ( e ) {
4771         var movement;
4772
4773         if ( e.keyCode === OO.ui.Keys.BACKSPACE || e.keyCode === OO.ui.Keys.DELETE ) {
4774                 this.remove();
4775                 return false;
4776         } else if ( e.keyCode === OO.ui.Keys.ENTER ) {
4777                 this.select();
4778                 return false;
4779         } else if (
4780                 e.keyCode === OO.ui.Keys.LEFT ||
4781                 e.keyCode === OO.ui.Keys.RIGHT
4782         ) {
4783                 if ( OO.ui.Element.static.getDir( this.$element ) === 'rtl' ) {
4784                         movement = {
4785                                 left: 'forwards',
4786                                 right: 'backwards'
4787                         };
4788                 } else {
4789                         movement = {
4790                                 left: 'backwards',
4791                                 right: 'forwards'
4792                         };
4793                 }
4794
4795                 this.emit(
4796                         'navigate',
4797                         e.keyCode === OO.ui.Keys.LEFT ?
4798                                 movement.left : movement.right
4799                 );
4800         }
4801 };
4802
4803 /**
4804  * Select this item
4805  *
4806  * @fires select
4807  */
4808 OO.ui.TagItemWidget.prototype.select = function () {
4809         if ( !this.isDisabled() ) {
4810                 this.emit( 'select' );
4811         }
4812 };
4813
4814 /**
4815  * Set the valid state of this item
4816  *
4817  * @param {boolean} [valid] Item is valid
4818  * @fires valid
4819  */
4820 OO.ui.TagItemWidget.prototype.toggleValid = function ( valid ) {
4821         valid = valid === undefined ? !this.valid : !!valid;
4822
4823         if ( this.valid !== valid ) {
4824                 this.valid = valid;
4825
4826                 this.setFlags( { invalid: !this.valid } );
4827
4828                 this.emit( 'valid', this.valid );
4829         }
4830 };
4831
4832 /**
4833  * Check whether the item is valid
4834  *
4835  * @return {boolean} Item is valid
4836  */
4837 OO.ui.TagItemWidget.prototype.isValid = function () {
4838         return this.valid;
4839 };
4840
4841 /**
4842  * A basic tag multiselect widget, similar in concept to {@link OO.ui.ComboBoxInputWidget combo box widget}
4843  * that allows the user to add multiple values that are displayed in a tag area.
4844  *
4845  * For more information about menus and options, please see the [OOjs UI documentation on MediaWiki][1].
4846  *
4847  * This widget is a base widget; see {@link OO.ui.MenuTagMultiselectWidget MenuTagMultiselectWidget} and
4848  * {@link OO.ui.PopupTagMultiselectWidget PopupTagMultiselectWidget} for the implementations that use
4849  * a menu and a popup respectively.
4850  *
4851  *     @example
4852  *     // Example: A basic TagMultiselectWidget.
4853  *     var widget = new OO.ui.TagMultiselectWidget( {
4854  *         inputPosition: 'outline',
4855  *         allowedValues: [ 'Option 1', 'Option 2', 'Option 3' ],
4856  *         selected: [ 'Option 1' ]
4857  *     } );
4858  *     $( 'body' ).append( widget.$element );
4859  *
4860  * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options#Menu_selects_and_options
4861  *
4862  * @class
4863  * @extends OO.ui.Widget
4864  * @mixins OO.ui.mixin.GroupWidget
4865  * @mixins OO.ui.mixin.DraggableGroupElement
4866  * @mixins OO.ui.mixin.IndicatorElement
4867  * @mixins OO.ui.mixin.IconElement
4868  * @mixins OO.ui.mixin.TabIndexedElement
4869  * @mixins OO.ui.mixin.FlaggedElement
4870  *
4871  * @constructor
4872  * @param {Object} config Configuration object
4873  * @cfg {Object} [input] Configuration options for the input widget
4874  * @cfg {OO.ui.InputWidget} [inputWidget] An optional input widget. If given, it will
4875  *  replace the input widget used in the TagMultiselectWidget. If not given,
4876  *  TagMultiselectWidget creates its own.
4877  * @cfg {boolean} [inputPosition='inline'] Position of the input. Options are:
4878  *      - inline: The input is invisible, but exists inside the tag list, so
4879  *              the user types into the tag groups to add tags.
4880  *      - outline: The input is underneath the tag area.
4881  *      - none: No input supplied
4882  * @cfg {boolean} [allowEditTags=true] Allow editing of the tags by clicking them
4883  * @cfg {boolean} [allowArbitrary=false] Allow data items to be added even if
4884  *  not present in the menu.
4885  * @cfg {Object[]} [allowedValues] An array representing the allowed items
4886  *  by their datas.
4887  * @cfg {boolean} [allowDuplicates=false] Allow duplicate items to be added
4888  * @cfg {boolean} [allowDisplayInvalidTags=false] Allow the display of
4889  *  invalid tags. These tags will display with an invalid state, and
4890  *  the widget as a whole will have an invalid state if any invalid tags
4891  *  are present.
4892  * @cfg {boolean} [allowReordering=true] Allow reordering of the items
4893  * @cfg {Object[]|String[]} [selected] A set of selected tags. If given,
4894  *  these will appear in the tag list on initialization, as long as they
4895  *  pass the validity tests.
4896  */
4897 OO.ui.TagMultiselectWidget = function OoUiTagMultiselectWidget( config ) {
4898         var inputEvents,
4899                 rAF = window.requestAnimationFrame || setTimeout,
4900                 widget = this,
4901                 $tabFocus = $( '<span>' )
4902                         .addClass( 'oo-ui-tagMultiselectWidget-focusTrap' );
4903
4904         config = config || {};
4905
4906         // Parent constructor
4907         OO.ui.TagMultiselectWidget.parent.call( this, config );
4908
4909         // Mixin constructors
4910         OO.ui.mixin.GroupWidget.call( this, config );
4911         OO.ui.mixin.IndicatorElement.call( this, config );
4912         OO.ui.mixin.IconElement.call( this, config );
4913         OO.ui.mixin.TabIndexedElement.call( this, config );
4914         OO.ui.mixin.FlaggedElement.call( this, config );
4915         OO.ui.mixin.DraggableGroupElement.call( this, config );
4916
4917         this.toggleDraggable(
4918                 config.allowReordering === undefined ?
4919                         true : !!config.allowReordering
4920         );
4921
4922         this.inputPosition = this.constructor.static.allowedInputPositions.indexOf( config.inputPosition ) > -1 ?
4923                         config.inputPosition : 'inline';
4924         this.allowEditTags = config.allowEditTags === undefined ? true : !!config.allowEditTags;
4925         this.allowArbitrary = !!config.allowArbitrary;
4926         this.allowDuplicates = !!config.allowDuplicates;
4927         this.allowedValues = config.allowedValues || [];
4928         this.allowDisplayInvalidTags = config.allowDisplayInvalidTags;
4929         this.hasInput = this.inputPosition !== 'none';
4930         this.height = null;
4931         this.valid = true;
4932
4933         this.$content = $( '<div>' )
4934                 .addClass( 'oo-ui-tagMultiselectWidget-content' );
4935         this.$handle = $( '<div>' )
4936                 .addClass( 'oo-ui-tagMultiselectWidget-handle' )
4937                 .append(
4938                         this.$indicator,
4939                         this.$icon,
4940                         this.$content
4941                                 .append(
4942                                         this.$group
4943                                                 .addClass( 'oo-ui-tagMultiselectWidget-group' )
4944                                 )
4945                 );
4946
4947         // Events
4948         this.aggregate( {
4949                 remove: 'itemRemove',
4950                 navigate: 'itemNavigate',
4951                 select: 'itemSelect'
4952         } );
4953         this.connect( this, {
4954                 itemRemove: 'onTagRemove',
4955                 itemSelect: 'onTagSelect',
4956                 itemNavigate: 'onTagNavigate',
4957                 change: 'onChangeTags'
4958         } );
4959         this.$handle.on( {
4960                 mousedown: this.onMouseDown.bind( this )
4961         } );
4962
4963         // Initialize
4964         this.$element
4965                 .addClass( 'oo-ui-tagMultiselectWidget' )
4966                 .append( this.$handle );
4967
4968         if ( this.hasInput ) {
4969                 if ( config.inputWidget ) {
4970                         this.input = config.inputWidget;
4971                 } else {
4972                         this.input = new OO.ui.TextInputWidget( $.extend( {
4973                                 placeholder: config.placeholder,
4974                                 classes: [ 'oo-ui-tagMultiselectWidget-input' ]
4975                         }, config.input ) );
4976                 }
4977                 this.input.setDisabled( this.isDisabled() );
4978
4979                 inputEvents = {
4980                         focus: this.onInputFocus.bind( this ),
4981                         blur: this.onInputBlur.bind( this ),
4982                         'propertychange change click mouseup keydown keyup input cut paste select focus':
4983                                 OO.ui.debounce( this.updateInputSize.bind( this ) ),
4984                         keydown: this.onInputKeyDown.bind( this ),
4985                         keypress: this.onInputKeyPress.bind( this )
4986                 };
4987
4988                 this.input.$input.on( inputEvents );
4989
4990                 if ( this.inputPosition === 'outline' ) {
4991                         // Override max-height for the input widget
4992                         // in the case the widget is outline so it can
4993                         // stretch all the way if the widet is wide
4994                         this.input.$element.css( 'max-width', 'inherit' );
4995                         this.$element
4996                                 .addClass( 'oo-ui-tagMultiselectWidget-outlined' )
4997                                 .append( this.input.$element );
4998                 } else {
4999                         this.$element.addClass( 'oo-ui-tagMultiselectWidget-inlined' );
5000                         // HACK: When the widget is using 'inline' input, the
5001                         // behavior needs to only use the $input itself
5002                         // so we style and size it accordingly (otherwise
5003                         // the styling and sizing can get very convoluted
5004                         // when the wrapping divs and other elements)
5005                         // We are taking advantage of still being able to
5006                         // call the widget itself for operations like
5007                         // .getValue() and setDisabled() and .focus() but
5008                         // having only the $input attached to the DOM
5009                         this.$content.append( this.input.$input );
5010                 }
5011         } else {
5012                 this.$content.append( $tabFocus );
5013         }
5014
5015         this.setTabIndexedElement(
5016                 this.hasInput ?
5017                         this.input.$input :
5018                         $tabFocus
5019         );
5020
5021         if ( config.selected ) {
5022                 this.setValue( config.selected );
5023         }
5024
5025         // HACK: Input size needs to be calculated after everything
5026         // else is rendered
5027         rAF( function () {
5028                 if ( widget.hasInput ) {
5029                         widget.updateInputSize();
5030                 }
5031         } );
5032 };
5033
5034 /* Initialization */
5035
5036 OO.inheritClass( OO.ui.TagMultiselectWidget, OO.ui.Widget );
5037 OO.mixinClass( OO.ui.TagMultiselectWidget, OO.ui.mixin.GroupWidget );
5038 OO.mixinClass( OO.ui.TagMultiselectWidget, OO.ui.mixin.DraggableGroupElement );
5039 OO.mixinClass( OO.ui.TagMultiselectWidget, OO.ui.mixin.IndicatorElement );
5040 OO.mixinClass( OO.ui.TagMultiselectWidget, OO.ui.mixin.IconElement );
5041 OO.mixinClass( OO.ui.TagMultiselectWidget, OO.ui.mixin.TabIndexedElement );
5042 OO.mixinClass( OO.ui.TagMultiselectWidget, OO.ui.mixin.FlaggedElement );
5043
5044 /* Static properties */
5045
5046 /**
5047  * Allowed input positions.
5048  * - inline: The input is inside the tag list
5049  * - outline: The input is under the tag list
5050  * - none: There is no input
5051  *
5052  * @property {Array}
5053  */
5054 OO.ui.TagMultiselectWidget.static.allowedInputPositions = [ 'inline', 'outline', 'none' ];
5055
5056 /* Methods */
5057
5058 /**
5059  * Handle mouse down events.
5060  *
5061  * @private
5062  * @param {jQuery.Event} e Mouse down event
5063  * @return {boolean} False to prevent defaults
5064  */
5065 OO.ui.TagMultiselectWidget.prototype.onMouseDown = function ( e ) {
5066         if ( !this.isDisabled() && e.which === OO.ui.MouseButtons.LEFT ) {
5067                 this.focus();
5068                 return false;
5069         }
5070 };
5071
5072 /**
5073  * Handle key press events.
5074  *
5075  * @private
5076  * @param {jQuery.Event} e Key press event
5077  * @return {boolean} Whether to prevent defaults
5078  */
5079 OO.ui.TagMultiselectWidget.prototype.onInputKeyPress = function ( e ) {
5080         var stopOrContinue,
5081                 withMetaKey = e.metaKey || e.ctrlKey;
5082
5083         if ( !this.isDisabled() ) {
5084                 if ( e.which === OO.ui.Keys.ENTER ) {
5085                         stopOrContinue = this.doInputEnter( e, withMetaKey );
5086                 }
5087
5088                 // Make sure the input gets resized.
5089                 setTimeout( this.updateInputSize.bind( this ), 0 );
5090                 return stopOrContinue;
5091         }
5092 };
5093
5094 /**
5095  * Handle key down events.
5096  *
5097  * @private
5098  * @param {jQuery.Event} e Key down event
5099  * @return {boolean}
5100  */
5101 OO.ui.TagMultiselectWidget.prototype.onInputKeyDown = function ( e ) {
5102         var movement, direction,
5103                 withMetaKey = e.metaKey || e.ctrlKey;
5104
5105         if ( !this.isDisabled() ) {
5106                 // 'keypress' event is not triggered for Backspace
5107                 if ( e.keyCode === OO.ui.Keys.BACKSPACE ) {
5108                         return this.doInputBackspace( e, withMetaKey );
5109                 } else if ( e.keyCode === OO.ui.Keys.ESCAPE ) {
5110                         return this.doInputEscape( e );
5111                 } else if (
5112                         e.keyCode === OO.ui.Keys.LEFT ||
5113                         e.keyCode === OO.ui.Keys.RIGHT
5114                 ) {
5115                         if ( OO.ui.Element.static.getDir( this.$element ) === 'rtl' ) {
5116                                 movement = {
5117                                         left: 'forwards',
5118                                         right: 'backwards'
5119                                 };
5120                         } else {
5121                                 movement = {
5122                                         left: 'backwards',
5123                                         right: 'forwards'
5124                                 };
5125                         }
5126                         direction = e.keyCode === OO.ui.Keys.LEFT ?
5127                                 movement.left : movement.right;
5128
5129                         return this.doInputArrow( e, direction, withMetaKey );
5130                 }
5131         }
5132 };
5133
5134 /**
5135  * Respond to input focus event
5136  */
5137 OO.ui.TagMultiselectWidget.prototype.onInputFocus = function () {
5138         this.$element.addClass( 'oo-ui-tagMultiselectWidget-focus' );
5139 };
5140
5141 /**
5142  * Respond to input blur event
5143  */
5144 OO.ui.TagMultiselectWidget.prototype.onInputBlur = function () {
5145         this.$element.removeClass( 'oo-ui-tagMultiselectWidget-focus' );
5146 };
5147
5148 /**
5149  * Perform an action after the enter key on the input
5150  *
5151  * @param {jQuery.Event} e Event data
5152  * @param {boolean} [withMetaKey] Whether this key was pressed with
5153  * a meta key like 'ctrl'
5154  * @return {boolean} Whether to prevent defaults
5155  */
5156 OO.ui.TagMultiselectWidget.prototype.doInputEnter = function () {
5157         this.addTagFromInput();
5158         return false;
5159 };
5160
5161 /**
5162  * Perform an action responding to the enter key on the input
5163  *
5164  * @param {jQuery.Event} e Event data
5165  * @param {boolean} [withMetaKey] Whether this key was pressed with
5166  * a meta key like 'ctrl'
5167  * @return {boolean} Whether to prevent defaults
5168  */
5169 OO.ui.TagMultiselectWidget.prototype.doInputBackspace = function ( e, withMetaKey ) {
5170         var items, item;
5171
5172         if (
5173                 this.inputPosition === 'inline' &&
5174                 this.input.getValue() === '' &&
5175                 !this.isEmpty()
5176         ) {
5177                 // Delete the last item
5178                 items = this.getItems();
5179                 item = items[ items.length - 1 ];
5180                 this.removeItems( [ item ] );
5181                 // If Ctrl/Cmd was pressed, delete item entirely.
5182                 // Otherwise put it into the text field for editing.
5183                 if ( !withMetaKey ) {
5184                         this.input.setValue( item.getData() );
5185                 }
5186
5187                 return false;
5188         }
5189 };
5190
5191 /**
5192  * Perform an action after the escape key on the input
5193  *
5194  * @param {jQuery.Event} e Event data
5195  */
5196 OO.ui.TagMultiselectWidget.prototype.doInputEscape = function () {
5197         this.clearInput();
5198 };
5199
5200 /**
5201  * Perform an action after the arrow key on the input, select the previous
5202  * or next item from the input.
5203  * See #getPreviousItem and #getNextItem
5204  *
5205  * @param {jQuery.Event} e Event data
5206  * @param {string} direction Direction of the movement; forwards or backwards
5207  * @param {boolean} [withMetaKey] Whether this key was pressed with
5208  *  a meta key like 'ctrl'
5209  */
5210 OO.ui.TagMultiselectWidget.prototype.doInputArrow = function ( e, direction ) {
5211         if (
5212                 this.inputPosition === 'inline' &&
5213                 !this.isEmpty()
5214         ) {
5215                 if ( direction === 'backwards' ) {
5216                         // Get previous item
5217                         this.getPreviousItem().focus();
5218                 } else {
5219                         // Get next item
5220                         this.getNextItem().focus();
5221                 }
5222         }
5223 };
5224
5225 /**
5226  * Respond to item select event
5227  *
5228  * @param {OO.ui.TagItemWidget} item Selected item
5229  */
5230 OO.ui.TagMultiselectWidget.prototype.onTagSelect = function ( item ) {
5231         if ( this.hasInput && this.allowEditTags ) {
5232                 if ( this.input.getValue() ) {
5233                         this.addTagFromInput();
5234                 }
5235                 // 1. Get the label of the tag into the input
5236                 this.input.setValue( item.getData() );
5237                 // 2. Remove the tag
5238                 this.removeItems( [ item ] );
5239                 // 3. Focus the input
5240                 this.focus();
5241         }
5242 };
5243
5244 /**
5245  * Respond to change event, where items were added, removed, or cleared.
5246  */
5247 OO.ui.TagMultiselectWidget.prototype.onChangeTags = function () {
5248         this.toggleValid( this.checkValidity() );
5249         if ( this.hasInput ) {
5250                 this.updateInputSize();
5251         }
5252         this.updateIfHeightChanged();
5253 };
5254
5255 /**
5256  * @inheritdoc
5257  */
5258 OO.ui.TagMultiselectWidget.prototype.setDisabled = function ( isDisabled ) {
5259         // Parent method
5260         OO.ui.TagMultiselectWidget.parent.prototype.setDisabled.call( this, isDisabled );
5261
5262         if ( this.hasInput && this.input ) {
5263                 this.input.setDisabled( !!isDisabled );
5264         }
5265
5266         if ( this.items ) {
5267                 this.getItems().forEach( function ( item ) {
5268                         item.setDisabled( !!isDisabled );
5269                 } );
5270         }
5271 };
5272
5273 /**
5274  * Respond to tag remove event
5275  * @param {OO.ui.TagItemWidget} item Removed tag
5276  */
5277 OO.ui.TagMultiselectWidget.prototype.onTagRemove = function ( item ) {
5278         this.removeTagByData( item.getData() );
5279 };
5280
5281 /**
5282  * Respond to navigate event on the tag
5283  *
5284  * @param {OO.ui.TagItemWidget} item Removed tag
5285  * @param {string} direction Direction of movement; 'forwards' or 'backwards'
5286  */
5287 OO.ui.TagMultiselectWidget.prototype.onTagNavigate = function ( item, direction ) {
5288         if ( direction === 'forwards' ) {
5289                 this.getNextItem( item ).focus();
5290         } else {
5291                 this.getPreviousItem( item ).focus();
5292         }
5293 };
5294
5295 /**
5296  * Add tag from input value
5297  */
5298 OO.ui.TagMultiselectWidget.prototype.addTagFromInput = function () {
5299         var val = this.input.getValue(),
5300                 isValid = this.isAllowedData( val );
5301
5302         if ( !val ) {
5303                 return;
5304         }
5305
5306         if ( isValid || this.allowDisplayInvalidTags ) {
5307                 this.addTag( val );
5308                 this.clearInput();
5309                 this.focus();
5310         }
5311 };
5312
5313 /**
5314  * Clear the input
5315  */
5316 OO.ui.TagMultiselectWidget.prototype.clearInput = function () {
5317         this.input.setValue( '' );
5318 };
5319
5320 /**
5321  * Check whether the given value is a duplicate of an existing
5322  * tag already in the list.
5323  *
5324  * @param {string|Object} data Requested value
5325  * @return {boolean} Value is duplicate
5326  */
5327 OO.ui.TagMultiselectWidget.prototype.isDuplicateData = function ( data ) {
5328         return !!this.getItemFromData( data );
5329 };
5330
5331 /**
5332  * Check whether a given value is allowed to be added
5333  *
5334  * @param {string|Object} data Requested value
5335  * @return {boolean} Value is allowed
5336  */
5337 OO.ui.TagMultiselectWidget.prototype.isAllowedData = function ( data ) {
5338         if (
5339                 !this.allowDuplicates &&
5340                 this.isDuplicateData( data )
5341         ) {
5342                 return false;
5343         }
5344
5345         if ( this.allowArbitrary ) {
5346                 return true;
5347         }
5348
5349         // Check with allowed values
5350         if (
5351                 this.getAllowedValues().some( function ( value ) {
5352                         return data === value;
5353                 } )
5354         ) {
5355                 return true;
5356         }
5357
5358         return false;
5359 };
5360
5361 /**
5362  * Get the allowed values list
5363  *
5364  * @return {string[]} Allowed data values
5365  */
5366 OO.ui.TagMultiselectWidget.prototype.getAllowedValues = function () {
5367         return this.allowedValues;
5368 };
5369
5370 /**
5371  * Add a value to the allowed values list
5372  *
5373  * @param {string} value Allowed data value
5374  */
5375 OO.ui.TagMultiselectWidget.prototype.addAllowedValue = function ( value ) {
5376         if ( this.allowedValues.indexOf( value ) === -1 ) {
5377                 this.allowedValues.push( value );
5378         }
5379 };
5380
5381 /**
5382  * Get the datas of the currently selected items
5383  *
5384  * @return {string[]|Object[]} Datas of currently selected items
5385  */
5386 OO.ui.TagMultiselectWidget.prototype.getValue = function () {
5387         return this.getItems()
5388                 .filter( function ( item ) {
5389                         return item.isValid();
5390                 } )
5391                 .map( function ( item ) {
5392                         return item.getData();
5393                 } );
5394 };
5395
5396 /**
5397  * Set the value of this widget by datas.
5398  *
5399  * @param {string|string[]|Object|Object[]} valueObject An object representing the data
5400  *  and label of the value. If the widget allows arbitrary values,
5401  *  the items will be added as-is. Otherwise, the data value will
5402  *  be checked against allowedValues.
5403  *  This object must contain at least a data key. Example:
5404  *  { data: 'foo', label: 'Foo item' }
5405  *  For multiple items, use an array of objects. For example:
5406  *   [
5407  *      { data: 'foo', label: 'Foo item' },
5408  *      { data: 'bar', label: 'Bar item' }
5409  *       ]
5410  *  Value can also be added with plaintext array, for example:
5411  *  [ 'foo', 'bar', 'bla' ] or a single string, like 'foo'
5412  */
5413 OO.ui.TagMultiselectWidget.prototype.setValue = function ( valueObject ) {
5414         valueObject = Array.isArray( valueObject ) ? valueObject : [ valueObject ];
5415
5416         this.clearItems();
5417         valueObject.forEach( function ( obj ) {
5418                 if ( typeof obj === 'string' ) {
5419                         this.addTag( obj );
5420                 } else {
5421                         this.addTag( obj.data, obj.label );
5422                 }
5423         }.bind( this ) );
5424 };
5425
5426 /**
5427  * Add tag to the display area
5428  *
5429  * @param {string|Object} data Tag data
5430  * @param {string} [label] Tag label. If no label is provided, the
5431  *  stringified version of the data will be used instead.
5432  * @return {boolean} Item was added successfully
5433  */
5434 OO.ui.TagMultiselectWidget.prototype.addTag = function ( data, label ) {
5435         var newItemWidget,
5436                 isValid = this.isAllowedData( data );
5437
5438         if ( isValid || this.allowDisplayInvalidTags ) {
5439                 newItemWidget = this.createTagItemWidget( data, label );
5440                 newItemWidget.toggleValid( isValid );
5441                 this.addItems( [ newItemWidget ] );
5442                 return true;
5443         }
5444         return false;
5445 };
5446
5447 /**
5448  * Remove tag by its data property.
5449  *
5450  * @param {string|Object} data Tag data
5451  */
5452 OO.ui.TagMultiselectWidget.prototype.removeTagByData = function ( data ) {
5453         var item = this.getItemFromData( data );
5454
5455         this.removeItems( [ item ] );
5456 };
5457
5458 /**
5459  * Construct a OO.ui.TagItemWidget (or a subclass thereof) from given label and data.
5460  *
5461  * @protected
5462  * @param {string} data Item data
5463  * @param {string} label The label text.
5464  * @return {OO.ui.TagItemWidget}
5465  */
5466 OO.ui.TagMultiselectWidget.prototype.createTagItemWidget = function ( data, label ) {
5467         label = label || data;
5468
5469         return new OO.ui.TagItemWidget( { data: data, label: label } );
5470 };
5471
5472 /**
5473  * Given an item, returns the item after it. If the item is already the
5474  * last item, return `this.input`. If no item is passed, returns the
5475  * very first item.
5476  *
5477  * @protected
5478  * @param {OO.ui.TagItemWidget} [item] Tag item
5479  * @return {OO.ui.Widget} The next widget available.
5480  */
5481 OO.ui.TagMultiselectWidget.prototype.getNextItem = function ( item ) {
5482         var itemIndex = this.items.indexOf( item );
5483
5484         if ( item === undefined || itemIndex === -1 ) {
5485                 return this.items[ 0 ];
5486         }
5487
5488         if ( itemIndex === this.items.length - 1 ) { // Last item
5489                 if ( this.hasInput ) {
5490                         return this.input;
5491                 } else {
5492                         // Return first item
5493                         return this.items[ 0 ];
5494                 }
5495         } else {
5496                 return this.items[ itemIndex + 1 ];
5497         }
5498 };
5499
5500 /**
5501  * Given an item, returns the item before it. If the item is already the
5502  * first item, return `this.input`. If no item is passed, returns the
5503  * very last item.
5504  *
5505  * @protected
5506  * @param {OO.ui.TagItemWidget} [item] Tag item
5507  * @return {OO.ui.Widget} The previous widget available.
5508  */
5509 OO.ui.TagMultiselectWidget.prototype.getPreviousItem = function ( item ) {
5510         var itemIndex = this.items.indexOf( item );
5511
5512         if ( item === undefined || itemIndex === -1 ) {
5513                 return this.items[ this.items.length - 1 ];
5514         }
5515
5516         if ( itemIndex === 0 ) {
5517                 if ( this.hasInput ) {
5518                         return this.input;
5519                 } else {
5520                         // Return the last item
5521                         return this.items[ this.items.length - 1 ];
5522                 }
5523         } else {
5524                 return this.items[ itemIndex - 1 ];
5525         }
5526 };
5527
5528 /**
5529  * Update the dimensions of the text input field to encompass all available area.
5530  * This is especially relevant for when the input is at the edge of a line
5531  * and should get smaller. The usual operation (as an inline-block with min-width)
5532  * does not work in that case, pushing the input downwards to the next line.
5533  *
5534  * @private
5535  */
5536 OO.ui.TagMultiselectWidget.prototype.updateInputSize = function () {
5537         var $lastItem, direction, contentWidth, currentWidth, bestWidth;
5538         if ( this.inputPosition === 'inline' && !this.isDisabled() ) {
5539                 this.input.$input.css( 'width', '1em' );
5540                 $lastItem = this.$group.children().last();
5541                 direction = OO.ui.Element.static.getDir( this.$handle );
5542
5543                 // Get the width of the input with the placeholder text as
5544                 // the value and save it so that we don't keep recalculating
5545                 if (
5546                         this.contentWidthWithPlaceholder === undefined &&
5547                         this.input.getValue() === '' &&
5548                         this.input.$input.attr( 'placeholder' ) !== undefined
5549                 ) {
5550                         this.input.setValue( this.input.$input.attr( 'placeholder' ) );
5551                         this.contentWidthWithPlaceholder = this.input.$input[ 0 ].scrollWidth;
5552                         this.input.setValue( '' );
5553
5554                 }
5555
5556                 // Always keep the input wide enough for the placeholder text
5557                 contentWidth = Math.max(
5558                         this.input.$input[ 0 ].scrollWidth,
5559                         // undefined arguments in Math.max lead to NaN
5560                         ( this.contentWidthWithPlaceholder === undefined ) ?
5561                                 0 : this.contentWidthWithPlaceholder
5562                 );
5563                 currentWidth = this.input.$input.width();
5564
5565                 if ( contentWidth < currentWidth ) {
5566                         this.updateIfHeightChanged();
5567                         // All is fine, don't perform expensive calculations
5568                         return;
5569                 }
5570
5571                 if ( $lastItem.length === 0 ) {
5572                         bestWidth = this.$content.innerWidth();
5573                 } else {
5574                         bestWidth = direction === 'ltr' ?
5575                                 this.$content.innerWidth() - $lastItem.position().left - $lastItem.outerWidth() :
5576                                 $lastItem.position().left;
5577                 }
5578
5579                 // Some safety margin for sanity, because I *really* don't feel like finding out where the few
5580                 // pixels this is off by are coming from.
5581                 bestWidth -= 10;
5582                 if ( contentWidth > bestWidth ) {
5583                         // This will result in the input getting shifted to the next line
5584                         bestWidth = this.$content.innerWidth() - 10;
5585                 }
5586                 this.input.$input.width( Math.floor( bestWidth ) );
5587                 this.updateIfHeightChanged();
5588         } else {
5589                 this.updateIfHeightChanged();
5590         }
5591 };
5592
5593 /**
5594  * Determine if widget height changed, and if so,
5595  * emit the resize event. This is useful for when there are either
5596  * menus or popups attached to the bottom of the widget, to allow
5597  * them to change their positioning in case the widget moved down
5598  * or up.
5599  *
5600  * @private
5601  */
5602 OO.ui.TagMultiselectWidget.prototype.updateIfHeightChanged = function () {
5603         var height = this.$element.height();
5604         if ( height !== this.height ) {
5605                 this.height = height;
5606                 this.emit( 'resize' );
5607         }
5608 };
5609
5610 /**
5611  * Check whether all items in the widget are valid
5612  *
5613  * @return {boolean} Widget is valid
5614  */
5615 OO.ui.TagMultiselectWidget.prototype.checkValidity = function () {
5616         return this.getItems().every( function ( item ) {
5617                 return item.isValid();
5618         } );
5619 };
5620
5621 /**
5622  * Set the valid state of this item
5623  *
5624  * @param {boolean} [valid] Item is valid
5625  * @fires valid
5626  */
5627 OO.ui.TagMultiselectWidget.prototype.toggleValid = function ( valid ) {
5628         valid = valid === undefined ? !this.valid : !!valid;
5629
5630         if ( this.valid !== valid ) {
5631                 this.valid = valid;
5632
5633                 this.setFlags( { invalid: !this.valid } );
5634
5635                 this.emit( 'valid', this.valid );
5636         }
5637 };
5638
5639 /**
5640  * Get the current valid state of the widget
5641  *
5642  * @return {boolean} Widget is valid
5643  */
5644 OO.ui.TagMultiselectWidget.prototype.isValid = function () {
5645         return this.valid;
5646 };
5647
5648 /**
5649  * PopupTagMultiselectWidget is a {@link OO.ui.TagMultiselectWidget OO.ui.TagMultiselectWidget} intended
5650  * to use a popup. The popup can be configured to have a default input to insert values into the widget.
5651  *
5652  * For more information about menus and options, please see the [OOjs UI documentation on MediaWiki][1].
5653  *
5654  *     @example
5655  *     // Example: A basic PopupTagMultiselectWidget.
5656  *     var widget = new OO.ui.PopupTagMultiselectWidget();
5657  *     $( 'body' ).append( widget.$element );
5658  *
5659  *     // Example: A PopupTagMultiselectWidget with an external popup.
5660  *     var popupInput = new OO.ui.TextInputWidget(),
5661  *         widget = new OO.ui.PopupTagMultiselectWidget( {
5662  *            popupInput: popupInput,
5663  *            popup: {
5664  *               $content: popupInput.$element
5665  *            }
5666  *         } );
5667  *     $( 'body' ).append( widget.$element );
5668  *
5669  * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options#Menu_selects_and_options
5670  *
5671  * @class
5672  * @extends OO.ui.TagMultiselectWidget
5673  * @mixins OO.ui.mixin.PopupElement
5674  *
5675  * @param {Object} config Configuration object
5676  * @cfg {jQuery} [$overlay] An overlay for the popup.
5677  *  See <https://www.mediawiki.org/wiki/OOjs_UI/Concepts#Overlays>.
5678  * @cfg {Object} [popup] Configuration options for the popup
5679  * @cfg {OO.ui.InputWidget} [popupInput] An input widget inside the popup that will be
5680  *  focused when the popup is opened and will be used as replacement for the
5681  *  general input in the widget.
5682  */
5683 OO.ui.PopupTagMultiselectWidget = function OoUiPopupTagMultiselectWidget( config ) {
5684         var defaultInput,
5685                 defaultConfig = { popup: {} };
5686
5687         config = config || {};
5688
5689         // Parent constructor
5690         OO.ui.PopupTagMultiselectWidget.parent.call( this, $.extend( { inputPosition: 'none' }, config ) );
5691
5692         this.$overlay = config.$overlay || this.$element;
5693
5694         if ( !config.popup ) {
5695                 // For the default base implementation, we give a popup
5696                 // with an input widget inside it. For any other use cases
5697                 // the popup needs to be populated externally and the
5698                 // event handled to add tags separately and manually
5699                 defaultInput = new OO.ui.TextInputWidget();
5700
5701                 defaultConfig.popupInput = defaultInput;
5702                 defaultConfig.popup.$content = defaultInput.$element;
5703
5704                 this.$element.addClass( 'oo-ui-popupTagMultiselectWidget-defaultPopup' );
5705         }
5706
5707         // Add overlay, and add that to the autoCloseIgnore
5708         defaultConfig.popup.$overlay = this.$overlay;
5709         defaultConfig.popup.$autoCloseIgnore = this.hasInput ?
5710                 this.input.$element.add( this.$overlay ) : this.$overlay;
5711
5712         // Allow extending any of the above
5713         config = $.extend( defaultConfig, config );
5714
5715         // Mixin constructors
5716         OO.ui.mixin.PopupElement.call( this, config );
5717
5718         if ( this.hasInput ) {
5719                 this.input.$input.on( 'focus', this.popup.toggle.bind( this.popup, true ) );
5720         }
5721
5722         // Configuration options
5723         this.popupInput = config.popupInput;
5724         if ( this.popupInput ) {
5725                 this.popupInput.connect( this, {
5726                         enter: 'onPopupInputEnter'
5727                 } );
5728         }
5729
5730         // Events
5731         this.on( 'resize', this.popup.updateDimensions.bind( this.popup ) );
5732         this.popup.connect( this, { toggle: 'onPopupToggle' } );
5733         this.$tabIndexed
5734                 .on( 'focus', this.onFocus.bind( this ) );
5735
5736         // Initialize
5737         this.$element
5738                 .append( this.popup.$element )
5739                 .addClass( 'oo-ui-popupTagMultiselectWidget' );
5740 };
5741
5742 /* Initialization */
5743
5744 OO.inheritClass( OO.ui.PopupTagMultiselectWidget, OO.ui.TagMultiselectWidget );
5745 OO.mixinClass( OO.ui.PopupTagMultiselectWidget, OO.ui.mixin.PopupElement );
5746
5747 /* Methods */
5748
5749 /**
5750  * Focus event handler.
5751  *
5752  * @private
5753  */
5754 OO.ui.PopupTagMultiselectWidget.prototype.onFocus = function () {
5755         this.popup.toggle( true );
5756 };
5757
5758 /**
5759  * Respond to popup toggle event
5760  *
5761  * @param {boolean} isVisible Popup is visible
5762  */
5763 OO.ui.PopupTagMultiselectWidget.prototype.onPopupToggle = function ( isVisible ) {
5764         if ( isVisible && this.popupInput ) {
5765                 this.popupInput.focus();
5766         }
5767 };
5768
5769 /**
5770  * Respond to popup input enter event
5771  */
5772 OO.ui.PopupTagMultiselectWidget.prototype.onPopupInputEnter = function () {
5773         if ( this.popupInput ) {
5774                 this.addTagByPopupValue( this.popupInput.getValue() );
5775                 this.popupInput.setValue( '' );
5776         }
5777 };
5778
5779 /**
5780  * @inheritdoc
5781  */
5782 OO.ui.PopupTagMultiselectWidget.prototype.onTagSelect = function ( item ) {
5783         if ( this.popupInput && this.allowEditTags ) {
5784                 this.popupInput.setValue( item.getData() );
5785                 this.removeItems( [ item ] );
5786
5787                 this.popup.toggle( true );
5788                 this.popupInput.focus();
5789         } else {
5790                 // Parent
5791                 OO.ui.PopupTagMultiselectWidget.parent.prototype.onTagSelect.call( this, item );
5792         }
5793 };
5794
5795 /**
5796  * Add a tag by the popup value.
5797  * Whatever is responsible for setting the value in the popup should call
5798  * this method to add a tag, or use the regular methods like #addTag or
5799  * #setValue directly.
5800  *
5801  * @param {string} data The value of item
5802  * @param {string} [label] The label of the tag. If not given, the data is used.
5803  */
5804 OO.ui.PopupTagMultiselectWidget.prototype.addTagByPopupValue = function ( data, label ) {
5805         this.addTag( data, label );
5806 };
5807
5808 /**
5809  * MenuTagMultiselectWidget is a {@link OO.ui.TagMultiselectWidget OO.ui.TagMultiselectWidget} intended
5810  * to use a menu of selectable options.
5811  *
5812  * For more information about menus and options, please see the [OOjs UI documentation on MediaWiki][1].
5813  *
5814  *     @example
5815  *     // Example: A basic MenuTagMultiselectWidget.
5816  *     var widget = new OO.ui.MenuTagMultiselectWidget( {
5817  *         inputPosition: 'outline',
5818  *         options: [
5819  *            { data: 'option1', label: 'Option 1' },
5820  *            { data: 'option2', label: 'Option 2' },
5821  *            { data: 'option3', label: 'Option 3' },
5822  *         ],
5823  *         selected: [ 'option1', 'option2' ]
5824  *     } );
5825  *     $( 'body' ).append( widget.$element );
5826  *
5827  * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options#Menu_selects_and_options
5828  *
5829  * @class
5830  * @extends OO.ui.TagMultiselectWidget
5831  *
5832  * @constructor
5833  * @param {Object} [config] Configuration object
5834  * @cfg {Object} [menu] Configuration object for the menu widget
5835  * @cfg {jQuery} [$overlay] An overlay for the menu.
5836  *  See <https://www.mediawiki.org/wiki/OOjs_UI/Concepts#Overlays>.
5837  * @cfg {Object[]} [options=[]] Array of menu options in the format `{ data: …, label: … }`
5838  */
5839 OO.ui.MenuTagMultiselectWidget = function OoUiMenuTagMultiselectWidget( config ) {
5840         config = config || {};
5841
5842         // Parent constructor
5843         OO.ui.MenuTagMultiselectWidget.parent.call( this, config );
5844
5845         this.$overlay = config.$overlay || this.$element;
5846
5847         this.menu = this.createMenuWidget( $.extend( {
5848                 widget: this,
5849                 input: this.hasInput ? this.input : null,
5850                 $input: this.hasInput ? this.input.$input : null,
5851                 filterFromInput: !!this.hasInput,
5852                 $autoCloseIgnore: this.hasInput ?
5853                         this.input.$element.add( this.$overlay ) : this.$overlay,
5854                 $floatableContainer: this.hasInput && this.inputPosition === 'outline' ?
5855                         this.input.$element : this.$element,
5856                 $overlay: this.$overlay,
5857                 disabled: this.isDisabled()
5858         }, config.menu ) );
5859         this.addOptions( config.options || [] );
5860
5861         // Events
5862         this.menu.connect( this, {
5863                 choose: 'onMenuChoose',
5864                 toggle: 'onMenuToggle'
5865         } );
5866         if ( this.hasInput ) {
5867                 this.input.connect( this, { change: 'onInputChange' } );
5868         }
5869         this.connect( this, { resize: 'onResize' } );
5870
5871         // Initialization
5872         this.$overlay
5873                 .append( this.menu.$element );
5874         this.$element
5875                 .addClass( 'oo-ui-menuTagMultiselectWidget' );
5876         // TagMultiselectWidget already does this, but it doesn't work right because this.menu is not yet
5877         // set up while the parent constructor runs, and #getAllowedValues rejects everything.
5878         if ( config.selected ) {
5879                 this.setValue( config.selected );
5880         }
5881 };
5882
5883 /* Initialization */
5884
5885 OO.inheritClass( OO.ui.MenuTagMultiselectWidget, OO.ui.TagMultiselectWidget );
5886
5887 /* Methods */
5888
5889 /**
5890  * Respond to resize event
5891  */
5892 OO.ui.MenuTagMultiselectWidget.prototype.onResize = function () {
5893         // Reposition the menu
5894         this.menu.position();
5895 };
5896
5897 /**
5898  * @inheritdoc
5899  */
5900 OO.ui.MenuTagMultiselectWidget.prototype.onInputFocus = function () {
5901         // Parent method
5902         OO.ui.MenuTagMultiselectWidget.parent.prototype.onInputFocus.call( this );
5903
5904         this.menu.toggle( true );
5905 };
5906
5907 /**
5908  * Respond to input change event
5909  */
5910 OO.ui.MenuTagMultiselectWidget.prototype.onInputChange = function () {
5911         this.menu.toggle( true );
5912 };
5913
5914 /**
5915  * Respond to menu choose event
5916  *
5917  * @param {OO.ui.OptionWidget} menuItem Chosen menu item
5918  */
5919 OO.ui.MenuTagMultiselectWidget.prototype.onMenuChoose = function ( menuItem ) {
5920         // Add tag
5921         this.addTag( menuItem.getData(), menuItem.getLabel() );
5922 };
5923
5924 /**
5925  * Respond to menu toggle event. Reset item highlights on hide.
5926  *
5927  * @param {boolean} isVisible The menu is visible
5928  */
5929 OO.ui.MenuTagMultiselectWidget.prototype.onMenuToggle = function ( isVisible ) {
5930         if ( !isVisible ) {
5931                 this.menu.selectItem( null );
5932                 this.menu.highlightItem( null );
5933         }
5934 };
5935
5936 /**
5937  * @inheritdoc
5938  */
5939 OO.ui.MenuTagMultiselectWidget.prototype.onTagSelect = function ( tagItem ) {
5940         var menuItem = this.menu.getItemFromData( tagItem.getData() );
5941         // Override the base behavior from TagMultiselectWidget; the base behavior
5942         // in TagMultiselectWidget is to remove the tag to edit it in the input,
5943         // but in our case, we want to utilize the menu selection behavior, and
5944         // definitely not remove the item.
5945
5946         // Select the menu item
5947         this.menu.selectItem( menuItem );
5948
5949         this.focus();
5950 };
5951
5952 /**
5953  * @inheritdoc
5954  */
5955 OO.ui.MenuTagMultiselectWidget.prototype.addTagFromInput = function () {
5956         var inputValue = this.input.getValue(),
5957                 validated = false,
5958                 highlightedItem = this.menu.getHighlightedItem(),
5959                 item = this.menu.getItemFromData( inputValue );
5960
5961         // Override the parent method so we add from the menu
5962         // rather than directly from the input
5963
5964         // Look for a highlighted item first
5965         if ( highlightedItem ) {
5966                 validated = this.addTag( highlightedItem.getData(), highlightedItem.getLabel() );
5967         } else if ( item ) {
5968                 // Look for the element that fits the data
5969                 validated = this.addTag( item.getData(), item.getLabel() );
5970         } else {
5971                 // Otherwise, add the tag - the method will only add if the
5972                 // tag is valid or if invalid tags are allowed
5973                 validated = this.addTag( inputValue );
5974         }
5975
5976         if ( validated ) {
5977                 this.clearInput();
5978                 this.focus();
5979         }
5980 };
5981
5982 /**
5983  * Return the visible items in the menu. This is mainly used for when
5984  * the menu is filtering results.
5985  *
5986  * @return {OO.ui.MenuOptionWidget[]} Visible results
5987  */
5988 OO.ui.MenuTagMultiselectWidget.prototype.getMenuVisibleItems = function () {
5989         return this.menu.getItems().filter( function ( menuItem ) {
5990                 return menuItem.isVisible();
5991         } );
5992 };
5993
5994 /**
5995  * Create the menu for this widget. This is in a separate method so that
5996  * child classes can override this without polluting the constructor with
5997  * unnecessary extra objects that will be overidden.
5998  *
5999  * @param {Object} menuConfig Configuration options
6000  * @return {OO.ui.MenuSelectWidget} Menu widget
6001  */
6002 OO.ui.MenuTagMultiselectWidget.prototype.createMenuWidget = function ( menuConfig ) {
6003         return new OO.ui.MenuSelectWidget( menuConfig );
6004 };
6005
6006 /**
6007  * Add options to the menu
6008  *
6009  * @param {Object[]} menuOptions Object defining options
6010  */
6011 OO.ui.MenuTagMultiselectWidget.prototype.addOptions = function ( menuOptions ) {
6012         var widget = this,
6013                 items = menuOptions.map( function ( obj ) {
6014                         return widget.createMenuOptionWidget( obj.data, obj.label );
6015                 } );
6016
6017         this.menu.addItems( items );
6018 };
6019
6020 /**
6021  * Create a menu option widget.
6022  *
6023  * @param {string} data Item data
6024  * @param {string} [label] Item label
6025  * @return {OO.ui.OptionWidget} Option widget
6026  */
6027 OO.ui.MenuTagMultiselectWidget.prototype.createMenuOptionWidget = function ( data, label ) {
6028         return new OO.ui.MenuOptionWidget( {
6029                 data: data,
6030                 label: label || data
6031         } );
6032 };
6033
6034 /**
6035  * Get the menu
6036  *
6037  * @return {OO.ui.MenuSelectWidget} Menu
6038  */
6039 OO.ui.MenuTagMultiselectWidget.prototype.getMenu = function () {
6040         return this.menu;
6041 };
6042
6043 /**
6044  * Get the allowed values list
6045  *
6046  * @return {string[]} Allowed data values
6047  */
6048 OO.ui.MenuTagMultiselectWidget.prototype.getAllowedValues = function () {
6049         var menuDatas = [];
6050         if ( this.menu ) {
6051                 // If the parent constructor is calling us, we're not ready yet, this.menu is not set up.
6052                 menuDatas = this.menu.getItems().map( function ( menuItem ) {
6053                         return menuItem.getData();
6054                 } );
6055         }
6056         return this.allowedValues.concat( menuDatas );
6057 };
6058
6059 /**
6060  * SelectFileWidgets allow for selecting files, using the HTML5 File API. These
6061  * widgets can be configured with {@link OO.ui.mixin.IconElement icons} and {@link
6062  * OO.ui.mixin.IndicatorElement indicators}.
6063  * Please see the [OOjs UI documentation on MediaWiki] [1] for more information and examples.
6064  *
6065  *     @example
6066  *     // Example of a file select widget
6067  *     var selectFile = new OO.ui.SelectFileWidget();
6068  *     $( 'body' ).append( selectFile.$element );
6069  *
6070  * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets
6071  *
6072  * @class
6073  * @extends OO.ui.Widget
6074  * @mixins OO.ui.mixin.IconElement
6075  * @mixins OO.ui.mixin.IndicatorElement
6076  * @mixins OO.ui.mixin.PendingElement
6077  * @mixins OO.ui.mixin.LabelElement
6078  *
6079  * @constructor
6080  * @param {Object} [config] Configuration options
6081  * @cfg {string[]|null} [accept=null] MIME types to accept. null accepts all types.
6082  * @cfg {string} [placeholder] Text to display when no file is selected.
6083  * @cfg {string} [notsupported] Text to display when file support is missing in the browser.
6084  * @cfg {boolean} [droppable=true] Whether to accept files by drag and drop.
6085  * @cfg {boolean} [showDropTarget=false] Whether to show a drop target. Requires droppable to be true.
6086  * @cfg {number} [thumbnailSizeLimit=20] File size limit in MiB above which to not try and show a
6087  *  preview (for performance)
6088  */
6089 OO.ui.SelectFileWidget = function OoUiSelectFileWidget( config ) {
6090         var dragHandler;
6091
6092         // Configuration initialization
6093         config = $.extend( {
6094                 accept: null,
6095                 placeholder: OO.ui.msg( 'ooui-selectfile-placeholder' ),
6096                 notsupported: OO.ui.msg( 'ooui-selectfile-not-supported' ),
6097                 droppable: true,
6098                 showDropTarget: false,
6099                 thumbnailSizeLimit: 20
6100         }, config );
6101
6102         // Parent constructor
6103         OO.ui.SelectFileWidget.parent.call( this, config );
6104
6105         // Mixin constructors
6106         OO.ui.mixin.IconElement.call( this, config );
6107         OO.ui.mixin.IndicatorElement.call( this, config );
6108         OO.ui.mixin.PendingElement.call( this, $.extend( {}, config, { $pending: this.$info } ) );
6109         OO.ui.mixin.LabelElement.call( this, config );
6110
6111         // Properties
6112         this.$info = $( '<span>' );
6113         this.showDropTarget = config.showDropTarget;
6114         this.thumbnailSizeLimit = config.thumbnailSizeLimit;
6115         this.isSupported = this.constructor.static.isSupported();
6116         this.currentFile = null;
6117         if ( Array.isArray( config.accept ) ) {
6118                 this.accept = config.accept;
6119         } else {
6120                 this.accept = null;
6121         }
6122         this.placeholder = config.placeholder;
6123         this.notsupported = config.notsupported;
6124         this.onFileSelectedHandler = this.onFileSelected.bind( this );
6125
6126         this.selectButton = new OO.ui.ButtonWidget( {
6127                 classes: [ 'oo-ui-selectFileWidget-selectButton' ],
6128                 label: OO.ui.msg( 'ooui-selectfile-button-select' ),
6129                 disabled: this.disabled || !this.isSupported
6130         } );
6131
6132         this.clearButton = new OO.ui.ButtonWidget( {
6133                 classes: [ 'oo-ui-selectFileWidget-clearButton' ],
6134                 framed: false,
6135                 icon: 'close',
6136                 disabled: this.disabled
6137         } );
6138
6139         // Events
6140         this.selectButton.$button.on( {
6141                 keypress: this.onKeyPress.bind( this )
6142         } );
6143         this.clearButton.connect( this, {
6144                 click: 'onClearClick'
6145         } );
6146         if ( config.droppable ) {
6147                 dragHandler = this.onDragEnterOrOver.bind( this );
6148                 this.$element.on( {
6149                         dragenter: dragHandler,
6150                         dragover: dragHandler,
6151                         dragleave: this.onDragLeave.bind( this ),
6152                         drop: this.onDrop.bind( this )
6153                 } );
6154         }
6155
6156         // Initialization
6157         this.addInput();
6158         this.$label.addClass( 'oo-ui-selectFileWidget-label' );
6159         this.$info
6160                 .addClass( 'oo-ui-selectFileWidget-info' )
6161                 .append( this.$icon, this.$label, this.clearButton.$element, this.$indicator );
6162
6163         if ( config.droppable && config.showDropTarget ) {
6164                 this.selectButton.setIcon( 'upload' );
6165                 this.$thumbnail = $( '<div>' ).addClass( 'oo-ui-selectFileWidget-thumbnail' );
6166                 this.setPendingElement( this.$thumbnail );
6167                 this.$element
6168                         .addClass( 'oo-ui-selectFileWidget-dropTarget oo-ui-selectFileWidget' )
6169                         .on( {
6170                                 click: this.onDropTargetClick.bind( this )
6171                         } )
6172                         .append(
6173                                 this.$thumbnail,
6174                                 this.$info,
6175                                 this.selectButton.$element,
6176                                 $( '<span>' )
6177                                         .addClass( 'oo-ui-selectFileWidget-dropLabel' )
6178                                         .text( OO.ui.msg( 'ooui-selectfile-dragdrop-placeholder' ) )
6179                         );
6180         } else {
6181                 this.$element
6182                         .addClass( 'oo-ui-selectFileWidget' )
6183                         .append( this.$info, this.selectButton.$element );
6184         }
6185         this.updateUI();
6186 };
6187
6188 /* Setup */
6189
6190 OO.inheritClass( OO.ui.SelectFileWidget, OO.ui.Widget );
6191 OO.mixinClass( OO.ui.SelectFileWidget, OO.ui.mixin.IconElement );
6192 OO.mixinClass( OO.ui.SelectFileWidget, OO.ui.mixin.IndicatorElement );
6193 OO.mixinClass( OO.ui.SelectFileWidget, OO.ui.mixin.PendingElement );
6194 OO.mixinClass( OO.ui.SelectFileWidget, OO.ui.mixin.LabelElement );
6195
6196 /* Static Properties */
6197
6198 /**
6199  * Check if this widget is supported
6200  *
6201  * @static
6202  * @return {boolean}
6203  */
6204 OO.ui.SelectFileWidget.static.isSupported = function () {
6205         var $input;
6206         if ( OO.ui.SelectFileWidget.static.isSupportedCache === null ) {
6207                 $input = $( '<input>' ).attr( 'type', 'file' );
6208                 OO.ui.SelectFileWidget.static.isSupportedCache = $input[ 0 ].files !== undefined;
6209         }
6210         return OO.ui.SelectFileWidget.static.isSupportedCache;
6211 };
6212
6213 OO.ui.SelectFileWidget.static.isSupportedCache = null;
6214
6215 /* Events */
6216
6217 /**
6218  * @event change
6219  *
6220  * A change event is emitted when the on/off state of the toggle changes.
6221  *
6222  * @param {File|null} value New value
6223  */
6224
6225 /* Methods */
6226
6227 /**
6228  * Get the current value of the field
6229  *
6230  * @return {File|null}
6231  */
6232 OO.ui.SelectFileWidget.prototype.getValue = function () {
6233         return this.currentFile;
6234 };
6235
6236 /**
6237  * Set the current value of the field
6238  *
6239  * @param {File|null} file File to select
6240  */
6241 OO.ui.SelectFileWidget.prototype.setValue = function ( file ) {
6242         if ( this.currentFile !== file ) {
6243                 this.currentFile = file;
6244                 this.updateUI();
6245                 this.emit( 'change', this.currentFile );
6246         }
6247 };
6248
6249 /**
6250  * Focus the widget.
6251  *
6252  * Focusses the select file button.
6253  *
6254  * @chainable
6255  */
6256 OO.ui.SelectFileWidget.prototype.focus = function () {
6257         this.selectButton.focus();
6258         return this;
6259 };
6260
6261 /**
6262  * Blur the widget.
6263  *
6264  * @chainable
6265  */
6266 OO.ui.SelectFileWidget.prototype.blur = function () {
6267         this.selectButton.blur();
6268         return this;
6269 };
6270
6271 /**
6272  * @inheritdoc
6273  */
6274 OO.ui.SelectFileWidget.prototype.simulateLabelClick = function () {
6275         this.focus();
6276 };
6277
6278 /**
6279  * Update the user interface when a file is selected or unselected
6280  *
6281  * @protected
6282  */
6283 OO.ui.SelectFileWidget.prototype.updateUI = function () {
6284         var $label;
6285         if ( !this.isSupported ) {
6286                 this.$element.addClass( 'oo-ui-selectFileWidget-notsupported' );
6287                 this.$element.removeClass( 'oo-ui-selectFileWidget-empty' );
6288                 this.setLabel( this.notsupported );
6289         } else {
6290                 this.$element.addClass( 'oo-ui-selectFileWidget-supported' );
6291                 if ( this.currentFile ) {
6292                         this.$element.removeClass( 'oo-ui-selectFileWidget-empty' );
6293                         $label = $( [] );
6294                         $label = $label.add(
6295                                 $( '<span>' )
6296                                         .addClass( 'oo-ui-selectFileWidget-fileName' )
6297                                         .text( this.currentFile.name )
6298                         );
6299                         this.setLabel( $label );
6300
6301                         if ( this.showDropTarget ) {
6302                                 this.pushPending();
6303                                 this.loadAndGetImageUrl().done( function ( url ) {
6304                                         this.$thumbnail.css( 'background-image', 'url( ' + url + ' )' );
6305                                 }.bind( this ) ).fail( function () {
6306                                         this.$thumbnail.append(
6307                                                 new OO.ui.IconWidget( {
6308                                                         icon: 'attachment',
6309                                                         classes: [ 'oo-ui-selectFileWidget-noThumbnail-icon' ]
6310                                                 } ).$element
6311                                         );
6312                                 }.bind( this ) ).always( function () {
6313                                         this.popPending();
6314                                 }.bind( this ) );
6315                                 this.$element.off( 'click' );
6316                         }
6317                 } else {
6318                         if ( this.showDropTarget ) {
6319                                 this.$element.off( 'click' );
6320                                 this.$element.on( {
6321                                         click: this.onDropTargetClick.bind( this )
6322                                 } );
6323                                 this.$thumbnail
6324                                         .empty()
6325                                         .css( 'background-image', '' );
6326                         }
6327                         this.$element.addClass( 'oo-ui-selectFileWidget-empty' );
6328                         this.setLabel( this.placeholder );
6329                 }
6330         }
6331 };
6332
6333 /**
6334  * If the selected file is an image, get its URL and load it.
6335  *
6336  * @return {jQuery.Promise} Promise resolves with the image URL after it has loaded
6337  */
6338 OO.ui.SelectFileWidget.prototype.loadAndGetImageUrl = function () {
6339         var deferred = $.Deferred(),
6340                 file = this.currentFile,
6341                 reader = new FileReader();
6342
6343         if (
6344                 file &&
6345                 ( OO.getProp( file, 'type' ) || '' ).indexOf( 'image/' ) === 0 &&
6346                 file.size < this.thumbnailSizeLimit * 1024 * 1024
6347         ) {
6348                 reader.onload = function ( event ) {
6349                         var img = document.createElement( 'img' );
6350                         img.addEventListener( 'load', function () {
6351                                 if (
6352                                         img.naturalWidth === 0 ||
6353                                         img.naturalHeight === 0 ||
6354                                         img.complete === false
6355                                 ) {
6356                                         deferred.reject();
6357                                 } else {
6358                                         deferred.resolve( event.target.result );
6359                                 }
6360                         } );
6361                         img.src = event.target.result;
6362                 };
6363                 reader.readAsDataURL( file );
6364         } else {
6365                 deferred.reject();
6366         }
6367
6368         return deferred.promise();
6369 };
6370
6371 /**
6372  * Add the input to the widget
6373  *
6374  * @private
6375  */
6376 OO.ui.SelectFileWidget.prototype.addInput = function () {
6377         if ( this.$input ) {
6378                 this.$input.remove();
6379         }
6380
6381         if ( !this.isSupported ) {
6382                 this.$input = null;
6383                 return;
6384         }
6385
6386         this.$input = $( '<input>' ).attr( 'type', 'file' );
6387         this.$input.on( 'change', this.onFileSelectedHandler );
6388         this.$input.on( 'click', function ( e ) {
6389                 // Prevents dropTarget to get clicked which calls
6390                 // a click on this input
6391                 e.stopPropagation();
6392         } );
6393         this.$input.attr( {
6394                 tabindex: -1
6395         } );
6396         if ( this.accept ) {
6397                 this.$input.attr( 'accept', this.accept.join( ', ' ) );
6398         }
6399         this.selectButton.$button.append( this.$input );
6400 };
6401
6402 /**
6403  * Determine if we should accept this file
6404  *
6405  * @private
6406  * @param {string} mimeType File MIME type
6407  * @return {boolean}
6408  */
6409 OO.ui.SelectFileWidget.prototype.isAllowedType = function ( mimeType ) {
6410         var i, mimeTest;
6411
6412         if ( !this.accept || !mimeType ) {
6413                 return true;
6414         }
6415
6416         for ( i = 0; i < this.accept.length; i++ ) {
6417                 mimeTest = this.accept[ i ];
6418                 if ( mimeTest === mimeType ) {
6419                         return true;
6420                 } else if ( mimeTest.substr( -2 ) === '/*' ) {
6421                         mimeTest = mimeTest.substr( 0, mimeTest.length - 1 );
6422                         if ( mimeType.substr( 0, mimeTest.length ) === mimeTest ) {
6423                                 return true;
6424                         }
6425                 }
6426         }
6427
6428         return false;
6429 };
6430
6431 /**
6432  * Handle file selection from the input
6433  *
6434  * @private
6435  * @param {jQuery.Event} e
6436  */
6437 OO.ui.SelectFileWidget.prototype.onFileSelected = function ( e ) {
6438         var file = OO.getProp( e.target, 'files', 0 ) || null;
6439
6440         if ( file && !this.isAllowedType( file.type ) ) {
6441                 file = null;
6442         }
6443
6444         this.setValue( file );
6445         this.addInput();
6446 };
6447
6448 /**
6449  * Handle clear button click events.
6450  *
6451  * @private
6452  */
6453 OO.ui.SelectFileWidget.prototype.onClearClick = function () {
6454         this.setValue( null );
6455         return false;
6456 };
6457
6458 /**
6459  * Handle key press events.
6460  *
6461  * @private
6462  * @param {jQuery.Event} e Key press event
6463  */
6464 OO.ui.SelectFileWidget.prototype.onKeyPress = function ( e ) {
6465         if ( this.isSupported && !this.isDisabled() && this.$input &&
6466                 ( e.which === OO.ui.Keys.SPACE || e.which === OO.ui.Keys.ENTER )
6467         ) {
6468                 this.$input.click();
6469                 return false;
6470         }
6471 };
6472
6473 /**
6474  * Handle drop target click events.
6475  *
6476  * @private
6477  * @param {jQuery.Event} e Key press event
6478  */
6479 OO.ui.SelectFileWidget.prototype.onDropTargetClick = function () {
6480         if ( this.isSupported && !this.isDisabled() && this.$input ) {
6481                 this.$input.click();
6482                 return false;
6483         }
6484 };
6485
6486 /**
6487  * Handle drag enter and over events
6488  *
6489  * @private
6490  * @param {jQuery.Event} e Drag event
6491  */
6492 OO.ui.SelectFileWidget.prototype.onDragEnterOrOver = function ( e ) {
6493         var itemOrFile,
6494                 droppableFile = false,
6495                 dt = e.originalEvent.dataTransfer;
6496
6497         e.preventDefault();
6498         e.stopPropagation();
6499
6500         if ( this.isDisabled() || !this.isSupported ) {
6501                 this.$element.removeClass( 'oo-ui-selectFileWidget-canDrop' );
6502                 dt.dropEffect = 'none';
6503                 return false;
6504         }
6505
6506         // DataTransferItem and File both have a type property, but in Chrome files
6507         // have no information at this point.
6508         itemOrFile = OO.getProp( dt, 'items', 0 ) || OO.getProp( dt, 'files', 0 );
6509         if ( itemOrFile ) {
6510                 if ( this.isAllowedType( itemOrFile.type ) ) {
6511                         droppableFile = true;
6512                 }
6513         // dt.types is Array-like, but not an Array
6514         } else if ( Array.prototype.indexOf.call( OO.getProp( dt, 'types' ) || [], 'Files' ) !== -1 ) {
6515                 // File information is not available at this point for security so just assume
6516                 // it is acceptable for now.
6517                 // https://bugzilla.mozilla.org/show_bug.cgi?id=640534
6518                 droppableFile = true;
6519         }
6520
6521         this.$element.toggleClass( 'oo-ui-selectFileWidget-canDrop', droppableFile );
6522         if ( !droppableFile ) {
6523                 dt.dropEffect = 'none';
6524         }
6525
6526         return false;
6527 };
6528
6529 /**
6530  * Handle drag leave events
6531  *
6532  * @private
6533  * @param {jQuery.Event} e Drag event
6534  */
6535 OO.ui.SelectFileWidget.prototype.onDragLeave = function () {
6536         this.$element.removeClass( 'oo-ui-selectFileWidget-canDrop' );
6537 };
6538
6539 /**
6540  * Handle drop events
6541  *
6542  * @private
6543  * @param {jQuery.Event} e Drop event
6544  */
6545 OO.ui.SelectFileWidget.prototype.onDrop = function ( e ) {
6546         var file = null,
6547                 dt = e.originalEvent.dataTransfer;
6548
6549         e.preventDefault();
6550         e.stopPropagation();
6551         this.$element.removeClass( 'oo-ui-selectFileWidget-canDrop' );
6552
6553         if ( this.isDisabled() || !this.isSupported ) {
6554                 return false;
6555         }
6556
6557         file = OO.getProp( dt, 'files', 0 );
6558         if ( file && !this.isAllowedType( file.type ) ) {
6559                 file = null;
6560         }
6561         if ( file ) {
6562                 this.setValue( file );
6563         }
6564
6565         return false;
6566 };
6567
6568 /**
6569  * @inheritdoc
6570  */
6571 OO.ui.SelectFileWidget.prototype.setDisabled = function ( disabled ) {
6572         OO.ui.SelectFileWidget.parent.prototype.setDisabled.call( this, disabled );
6573         if ( this.selectButton ) {
6574                 this.selectButton.setDisabled( disabled );
6575         }
6576         if ( this.clearButton ) {
6577                 this.clearButton.setDisabled( disabled );
6578         }
6579         return this;
6580 };
6581
6582 /**
6583  * SearchWidgets combine a {@link OO.ui.TextInputWidget text input field}, where users can type a search query,
6584  * and a menu of search results, which is displayed beneath the query
6585  * field. Unlike {@link OO.ui.mixin.LookupElement lookup menus}, search result menus are always visible to the user.
6586  * Users can choose an item from the menu or type a query into the text field to search for a matching result item.
6587  * In general, search widgets are used inside a separate {@link OO.ui.Dialog dialog} window.
6588  *
6589  * Each time the query is changed, the search result menu is cleared and repopulated. Please see
6590  * the [OOjs UI demos][1] for an example.
6591  *
6592  * [1]: https://tools.wmflabs.org/oojs-ui/oojs-ui/demos/#dialogs-mediawiki-vector-ltr
6593  *
6594  * @class
6595  * @extends OO.ui.Widget
6596  *
6597  * @constructor
6598  * @param {Object} [config] Configuration options
6599  * @cfg {string|jQuery} [placeholder] Placeholder text for query input
6600  * @cfg {string} [value] Initial query value
6601  */
6602 OO.ui.SearchWidget = function OoUiSearchWidget( config ) {
6603         // Configuration initialization
6604         config = config || {};
6605
6606         // Parent constructor
6607         OO.ui.SearchWidget.parent.call( this, config );
6608
6609         // Properties
6610         this.query = new OO.ui.TextInputWidget( {
6611                 icon: 'search',
6612                 placeholder: config.placeholder,
6613                 value: config.value
6614         } );
6615         this.results = new OO.ui.SelectWidget();
6616         this.$query = $( '<div>' );
6617         this.$results = $( '<div>' );
6618
6619         // Events
6620         this.query.connect( this, {
6621                 change: 'onQueryChange',
6622                 enter: 'onQueryEnter'
6623         } );
6624         this.query.$input.on( 'keydown', this.onQueryKeydown.bind( this ) );
6625
6626         // Initialization
6627         this.$query
6628                 .addClass( 'oo-ui-searchWidget-query' )
6629                 .append( this.query.$element );
6630         this.$results
6631                 .addClass( 'oo-ui-searchWidget-results' )
6632                 .append( this.results.$element );
6633         this.$element
6634                 .addClass( 'oo-ui-searchWidget' )
6635                 .append( this.$results, this.$query );
6636 };
6637
6638 /* Setup */
6639
6640 OO.inheritClass( OO.ui.SearchWidget, OO.ui.Widget );
6641
6642 /* Methods */
6643
6644 /**
6645  * Handle query key down events.
6646  *
6647  * @private
6648  * @param {jQuery.Event} e Key down event
6649  */
6650 OO.ui.SearchWidget.prototype.onQueryKeydown = function ( e ) {
6651         var highlightedItem, nextItem,
6652                 dir = e.which === OO.ui.Keys.DOWN ? 1 : ( e.which === OO.ui.Keys.UP ? -1 : 0 );
6653
6654         if ( dir ) {
6655                 highlightedItem = this.results.getHighlightedItem();
6656                 if ( !highlightedItem ) {
6657                         highlightedItem = this.results.getSelectedItem();
6658                 }
6659                 nextItem = this.results.getRelativeSelectableItem( highlightedItem, dir );
6660                 this.results.highlightItem( nextItem );
6661                 nextItem.scrollElementIntoView();
6662         }
6663 };
6664
6665 /**
6666  * Handle select widget select events.
6667  *
6668  * Clears existing results. Subclasses should repopulate items according to new query.
6669  *
6670  * @private
6671  * @param {string} value New value
6672  */
6673 OO.ui.SearchWidget.prototype.onQueryChange = function () {
6674         // Reset
6675         this.results.clearItems();
6676 };
6677
6678 /**
6679  * Handle select widget enter key events.
6680  *
6681  * Chooses highlighted item.
6682  *
6683  * @private
6684  * @param {string} value New value
6685  */
6686 OO.ui.SearchWidget.prototype.onQueryEnter = function () {
6687         var highlightedItem = this.results.getHighlightedItem();
6688         if ( highlightedItem ) {
6689                 this.results.chooseItem( highlightedItem );
6690         }
6691 };
6692
6693 /**
6694  * Get the query input.
6695  *
6696  * @return {OO.ui.TextInputWidget} Query input
6697  */
6698 OO.ui.SearchWidget.prototype.getQuery = function () {
6699         return this.query;
6700 };
6701
6702 /**
6703  * Get the search results menu.
6704  *
6705  * @return {OO.ui.SelectWidget} Menu of search results
6706  */
6707 OO.ui.SearchWidget.prototype.getResults = function () {
6708         return this.results;
6709 };
6710
6711 /**
6712  * NumberInputWidgets combine a {@link OO.ui.TextInputWidget text input} (where a value
6713  * can be entered manually) and two {@link OO.ui.ButtonWidget button widgets}
6714  * (to adjust the value in increments) to allow the user to enter a number.
6715  *
6716  *     @example
6717  *     // Example: A NumberInputWidget.
6718  *     var numberInput = new OO.ui.NumberInputWidget( {
6719  *         label: 'NumberInputWidget',
6720  *         input: { value: 5 },
6721  *         min: 1,
6722  *         max: 10
6723  *     } );
6724  *     $( 'body' ).append( numberInput.$element );
6725  *
6726  * @class
6727  * @extends OO.ui.TextInputWidget
6728  *
6729  * @constructor
6730  * @param {Object} [config] Configuration options
6731  * @cfg {Object} [minusButton] Configuration options to pass to the {@link OO.ui.ButtonWidget decrementing button widget}.
6732  * @cfg {Object} [plusButton] Configuration options to pass to the {@link OO.ui.ButtonWidget incrementing button widget}.
6733  * @cfg {boolean} [allowInteger=false] Whether the field accepts only integer values.
6734  * @cfg {number} [min=-Infinity] Minimum allowed value
6735  * @cfg {number} [max=Infinity] Maximum allowed value
6736  * @cfg {number} [step=1] Delta when using the buttons or up/down arrow keys
6737  * @cfg {number|null} [pageStep] Delta when using the page-up/page-down keys. Defaults to 10 times #step.
6738  * @cfg {boolean} [showButtons=true] Whether to show the plus and minus buttons.
6739  */
6740 OO.ui.NumberInputWidget = function OoUiNumberInputWidget( config ) {
6741         var $field = $( '<div>' )
6742                 .addClass( 'oo-ui-numberInputWidget-field' );
6743
6744         // Configuration initialization
6745         config = $.extend( {
6746                 allowInteger: false,
6747                 min: -Infinity,
6748                 max: Infinity,
6749                 step: 1,
6750                 pageStep: null,
6751                 showButtons: true
6752         }, config );
6753
6754         // For backward compatibility
6755         $.extend( config, config.input );
6756         this.input = this;
6757
6758         // Parent constructor
6759         OO.ui.NumberInputWidget.parent.call( this, $.extend( config, {
6760                 type: 'number'
6761         } ) );
6762
6763         if ( config.showButtons ) {
6764                 this.minusButton = new OO.ui.ButtonWidget( $.extend(
6765                         {
6766                                 disabled: this.isDisabled(),
6767                                 tabIndex: -1,
6768                                 classes: [ 'oo-ui-numberInputWidget-minusButton' ],
6769                                 icon: 'subtract'
6770                         },
6771                         config.minusButton
6772                 ) );
6773                 this.plusButton = new OO.ui.ButtonWidget( $.extend(
6774                         {
6775                                 disabled: this.isDisabled(),
6776                                 tabIndex: -1,
6777                                 classes: [ 'oo-ui-numberInputWidget-plusButton' ],
6778                                 icon: 'add'
6779                         },
6780                         config.plusButton
6781                 ) );
6782         }
6783
6784         // Events
6785         this.$input.on( {
6786                 keydown: this.onKeyDown.bind( this ),
6787                 'wheel mousewheel DOMMouseScroll': this.onWheel.bind( this )
6788         } );
6789         if ( config.showButtons ) {
6790                 this.plusButton.connect( this, {
6791                         click: [ 'onButtonClick', +1 ]
6792                 } );
6793                 this.minusButton.connect( this, {
6794                         click: [ 'onButtonClick', -1 ]
6795                 } );
6796         }
6797
6798         // Build the field
6799         $field.append( this.$input );
6800         if ( config.showButtons ) {
6801                 $field
6802                         .prepend( this.minusButton.$element )
6803                         .append( this.plusButton.$element );
6804         }
6805
6806         // Initialization
6807         this.setAllowInteger( config.allowInteger || config.isInteger );
6808         this.setRange( config.min, config.max );
6809         this.setStep( config.step, config.pageStep );
6810         // Set the validation method after we set allowInteger and range
6811         // so that it doesn't immediately call setValidityFlag
6812         this.setValidation( this.validateNumber.bind( this ) );
6813
6814         this.$element
6815                 .addClass( 'oo-ui-numberInputWidget' )
6816                 .toggleClass( 'oo-ui-numberInputWidget-buttoned', config.showButtons )
6817                 .append( $field );
6818 };
6819
6820 /* Setup */
6821
6822 OO.inheritClass( OO.ui.NumberInputWidget, OO.ui.TextInputWidget );
6823
6824 /* Methods */
6825
6826 /**
6827  * Set whether only integers are allowed
6828  *
6829  * @param {boolean} flag
6830  */
6831 OO.ui.NumberInputWidget.prototype.setAllowInteger = function ( flag ) {
6832         this.allowInteger = !!flag;
6833         this.setValidityFlag();
6834 };
6835 // Backward compatibility
6836 OO.ui.NumberInputWidget.prototype.setIsInteger = OO.ui.NumberInputWidget.prototype.setAllowInteger;
6837
6838 /**
6839  * Get whether only integers are allowed
6840  *
6841  * @return {boolean} Flag value
6842  */
6843 OO.ui.NumberInputWidget.prototype.getAllowInteger = function () {
6844         return this.allowInteger;
6845 };
6846 // Backward compatibility
6847 OO.ui.NumberInputWidget.prototype.getIsInteger = OO.ui.NumberInputWidget.prototype.getAllowInteger;
6848
6849 /**
6850  * Set the range of allowed values
6851  *
6852  * @param {number} min Minimum allowed value
6853  * @param {number} max Maximum allowed value
6854  */
6855 OO.ui.NumberInputWidget.prototype.setRange = function ( min, max ) {
6856         if ( min > max ) {
6857                 throw new Error( 'Minimum (' + min + ') must not be greater than maximum (' + max + ')' );
6858         }
6859         this.min = min;
6860         this.max = max;
6861         this.setValidityFlag();
6862 };
6863
6864 /**
6865  * Get the current range
6866  *
6867  * @return {number[]} Minimum and maximum values
6868  */
6869 OO.ui.NumberInputWidget.prototype.getRange = function () {
6870         return [ this.min, this.max ];
6871 };
6872
6873 /**
6874  * Set the stepping deltas
6875  *
6876  * @param {number} step Normal step
6877  * @param {number|null} pageStep Page step. If null, 10 * step will be used.
6878  */
6879 OO.ui.NumberInputWidget.prototype.setStep = function ( step, pageStep ) {
6880         if ( step <= 0 ) {
6881                 throw new Error( 'Step value must be positive' );
6882         }
6883         if ( pageStep === null ) {
6884                 pageStep = step * 10;
6885         } else if ( pageStep <= 0 ) {
6886                 throw new Error( 'Page step value must be positive' );
6887         }
6888         this.step = step;
6889         this.pageStep = pageStep;
6890 };
6891
6892 /**
6893  * Get the current stepping values
6894  *
6895  * @return {number[]} Step and page step
6896  */
6897 OO.ui.NumberInputWidget.prototype.getStep = function () {
6898         return [ this.step, this.pageStep ];
6899 };
6900
6901 /**
6902  * Get the current value of the widget as a number
6903  *
6904  * @return {number} May be NaN, or an invalid number
6905  */
6906 OO.ui.NumberInputWidget.prototype.getNumericValue = function () {
6907         return +this.getValue();
6908 };
6909
6910 /**
6911  * Adjust the value of the widget
6912  *
6913  * @param {number} delta Adjustment amount
6914  */
6915 OO.ui.NumberInputWidget.prototype.adjustValue = function ( delta ) {
6916         var n, v = this.getNumericValue();
6917
6918         delta = +delta;
6919         if ( isNaN( delta ) || !isFinite( delta ) ) {
6920                 throw new Error( 'Delta must be a finite number' );
6921         }
6922
6923         if ( isNaN( v ) ) {
6924                 n = 0;
6925         } else {
6926                 n = v + delta;
6927                 n = Math.max( Math.min( n, this.max ), this.min );
6928                 if ( this.allowInteger ) {
6929                         n = Math.round( n );
6930                 }
6931         }
6932
6933         if ( n !== v ) {
6934                 this.setValue( n );
6935         }
6936 };
6937 /**
6938  * Validate input
6939  *
6940  * @private
6941  * @param {string} value Field value
6942  * @return {boolean}
6943  */
6944 OO.ui.NumberInputWidget.prototype.validateNumber = function ( value ) {
6945         var n = +value;
6946         if ( value === '' ) {
6947                 return !this.isRequired();
6948         }
6949
6950         if ( isNaN( n ) || !isFinite( n ) ) {
6951                 return false;
6952         }
6953
6954         if ( this.allowInteger && Math.floor( n ) !== n ) {
6955                 return false;
6956         }
6957
6958         if ( n < this.min || n > this.max ) {
6959                 return false;
6960         }
6961
6962         return true;
6963 };
6964
6965 /**
6966  * Handle mouse click events.
6967  *
6968  * @private
6969  * @param {number} dir +1 or -1
6970  */
6971 OO.ui.NumberInputWidget.prototype.onButtonClick = function ( dir ) {
6972         this.adjustValue( dir * this.step );
6973 };
6974
6975 /**
6976  * Handle mouse wheel events.
6977  *
6978  * @private
6979  * @param {jQuery.Event} event
6980  */
6981 OO.ui.NumberInputWidget.prototype.onWheel = function ( event ) {
6982         var delta = 0;
6983
6984         if ( !this.isDisabled() && this.$input.is( ':focus' ) ) {
6985                 // Standard 'wheel' event
6986                 if ( event.originalEvent.deltaMode !== undefined ) {
6987                         this.sawWheelEvent = true;
6988                 }
6989                 if ( event.originalEvent.deltaY ) {
6990                         delta = -event.originalEvent.deltaY;
6991                 } else if ( event.originalEvent.deltaX ) {
6992                         delta = event.originalEvent.deltaX;
6993                 }
6994
6995                 // Non-standard events
6996                 if ( !this.sawWheelEvent ) {
6997                         if ( event.originalEvent.wheelDeltaX ) {
6998                                 delta = -event.originalEvent.wheelDeltaX;
6999                         } else if ( event.originalEvent.wheelDeltaY ) {
7000                                 delta = event.originalEvent.wheelDeltaY;
7001                         } else if ( event.originalEvent.wheelDelta ) {
7002                                 delta = event.originalEvent.wheelDelta;
7003                         } else if ( event.originalEvent.detail ) {
7004                                 delta = -event.originalEvent.detail;
7005                         }
7006                 }
7007
7008                 if ( delta ) {
7009                         delta = delta < 0 ? -1 : 1;
7010                         this.adjustValue( delta * this.step );
7011                 }
7012
7013                 return false;
7014         }
7015 };
7016
7017 /**
7018  * Handle key down events.
7019  *
7020  * @private
7021  * @param {jQuery.Event} e Key down event
7022  */
7023 OO.ui.NumberInputWidget.prototype.onKeyDown = function ( e ) {
7024         if ( !this.isDisabled() ) {
7025                 switch ( e.which ) {
7026                         case OO.ui.Keys.UP:
7027                                 this.adjustValue( this.step );
7028                                 return false;
7029                         case OO.ui.Keys.DOWN:
7030                                 this.adjustValue( -this.step );
7031                                 return false;
7032                         case OO.ui.Keys.PAGEUP:
7033                                 this.adjustValue( this.pageStep );
7034                                 return false;
7035                         case OO.ui.Keys.PAGEDOWN:
7036                                 this.adjustValue( -this.pageStep );
7037                                 return false;
7038                 }
7039         }
7040 };
7041
7042 /**
7043  * @inheritdoc
7044  */
7045 OO.ui.NumberInputWidget.prototype.setDisabled = function ( disabled ) {
7046         // Parent method
7047         OO.ui.NumberInputWidget.parent.prototype.setDisabled.call( this, disabled );
7048
7049         if ( this.minusButton ) {
7050                 this.minusButton.setDisabled( this.isDisabled() );
7051         }
7052         if ( this.plusButton ) {
7053                 this.plusButton.setDisabled( this.isDisabled() );
7054         }
7055
7056         return this;
7057 };
7058
7059 }( OO ) );
7060
7061 //# sourceMappingURL=oojs-ui-widgets.js.map