resources/src/mediawiki.rcfilters/ui/FilterTagMultiselectWidget.js

   1 var ViewSwitchWidget = require( './ViewSwitchWidget.js' ),
   2         SaveFiltersPopupButtonWidget = require( './SaveFiltersPopupButtonWidget.js' ),
   3         MenuSelectWidget = require( './MenuSelectWidget.js' ),
   4         FilterTagItemWidget = require( './FilterTagItemWidget.js' ),
   5         FilterTagMultiselectWidget;
   6
   7 /**
   8  * List displaying all filter groups
   9  *
  10  * @class mw.rcfilters.ui.FilterTagMultiselectWidget
  11  * @extends OO.ui.MenuTagMultiselectWidget
  12  * @mixins OO.ui.mixin.PendingElement
  13  *
  14  * @constructor
  15  * @param {mw.rcfilters.Controller} controller Controller
  16  * @param {mw.rcfilters.dm.FiltersViewModel} model View model
  17  * @param {mw.rcfilters.dm.SavedQueriesModel} savedQueriesModel Saved queries model
  18  * @param {Object} config Configuration object
  19  * @cfg {jQuery} [$overlay] A jQuery object serving as overlay for popups
  20  * @cfg {jQuery} [$wrapper] A jQuery object for the wrapper of the general
  21  *  system. If not given, falls back to this widget's $element
  22  * @cfg {boolean} [collapsed] Filter area is collapsed
  23  */
  24 FilterTagMultiselectWidget = function MwRcfiltersUiFilterTagMultiselectWidget( controller, model, savedQueriesModel, config ) {
  25         var rcFiltersRow,
  26                 title = new OO.ui.LabelWidget( {
  27                         label: mw.msg( 'rcfilters-activefilters' ),
  28                         classes: [ 'mw-rcfilters-ui-filterTagMultiselectWidget-wrapper-content-title' ]
  29                 } ),
  30                 $contentWrapper = $( '<div>' )
  31                         .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-wrapper' );
  32
  33         config = config || {};
  34
  35         this.controller = controller;
  36         this.model = model;
  37         this.queriesModel = savedQueriesModel;
  38         this.$overlay = config.$overlay || this.$element;
  39         this.$wrapper = config.$wrapper || this.$element;
  40         this.matchingQuery = null;
  41         this.currentView = this.model.getCurrentView();
  42         this.collapsed = false;
  43
  44         // Parent
  45         FilterTagMultiselectWidget.parent.call( this, $.extend( true, {
  46                 label: mw.msg( 'rcfilters-filterlist-title' ),
  47                 placeholder: mw.msg( 'rcfilters-empty-filter' ),
  48                 inputPosition: 'outline',
  49                 allowArbitrary: false,
  50                 allowDisplayInvalidTags: false,
  51                 allowReordering: false,
  52                 $overlay: this.$overlay,
  53                 menu: {
  54                         // Our filtering is done through the model
  55                         filterFromInput: false,
  56                         hideWhenOutOfView: false,
  57                         hideOnChoose: false,
  58                         width: 650,
  59                         footers: [
  60                                 {
  61                                         name: 'viewSelect',
  62                                         sticky: false,
  63                                         // View select menu, appears on default view only
  64                                         $element: $( '<div>' )
  65                                                 .append( new ViewSwitchWidget( this.controller, this.model ).$element ),
  66                                         views: [ 'default' ]
  67                                 },
  68                                 {
  69                                         name: 'feedback',
  70                                         // Feedback footer, appears on all views
  71                                         $element: $( '<div>' )
  72                                                 .append(
  73                                                         new OO.ui.ButtonWidget( {
  74                                                                 framed: false,
  75                                                                 icon: 'feedback',
  76                                                                 flags: [ 'progressive' ],
  77                                                                 label: mw.msg( 'rcfilters-filterlist-feedbacklink' ),
  78                                                                 href: 'https://www.mediawiki.org/wiki/Help_talk:New_filters_for_edit_review'
  79                                                         } ).$element
  80                                                 )
  81                                 }
  82                         ]
  83                 },
  84                 input: {
  85                         icon: 'menu',
  86                         placeholder: mw.msg( 'rcfilters-search-placeholder' )
  87                 }
  88         }, config ) );
  89
  90         this.savedQueryTitle = new OO.ui.LabelWidget( {
  91                 label: '',
  92                 classes: [ 'mw-rcfilters-ui-filterTagMultiselectWidget-wrapper-content-savedQueryTitle' ]
  93         } );
  94
  95         this.resetButton = new OO.ui.ButtonWidget( {
  96                 framed: false,
  97                 classes: [ 'mw-rcfilters-ui-filterTagMultiselectWidget-resetButton' ]
  98         } );
  99
 100         this.hideShowButton = new OO.ui.ButtonWidget( {
 101                 framed: false,
 102                 flags: [ 'progressive' ],
 103                 classes: [ 'mw-rcfilters-ui-filterTagMultiselectWidget-hideshowButton' ]
 104         } );
 105         this.toggleCollapsed( !!config.collapsed );
 106
 107         if ( !mw.user.isAnon() ) {
 108                 this.saveQueryButton = new SaveFiltersPopupButtonWidget(
 109                         this.controller,
 110                         this.queriesModel,
 111                         {
 112                                 $overlay: this.$overlay
 113                         }
 114                 );
 115
 116                 this.saveQueryButton.$element.on( 'mousedown', function ( e ) {
 117                         e.stopPropagation();
 118                 } );
 119
 120                 this.saveQueryButton.connect( this, {
 121                         click: 'onSaveQueryButtonClick',
 122                         saveCurrent: 'setSavedQueryVisibility'
 123                 } );
 124                 this.queriesModel.connect( this, {
 125                         itemUpdate: 'onSavedQueriesItemUpdate',
 126                         initialize: 'onSavedQueriesInitialize',
 127                         default: 'reevaluateResetRestoreState'
 128                 } );
 129         }
 130
 131         this.emptyFilterMessage = new OO.ui.LabelWidget( {
 132                 label: mw.msg( 'rcfilters-empty-filter' ),
 133                 classes: [ 'mw-rcfilters-ui-filterTagMultiselectWidget-emptyFilters' ]
 134         } );
 135         this.$content.append( this.emptyFilterMessage.$element );
 136
 137         // Events
 138         this.resetButton.connect( this, { click: 'onResetButtonClick' } );
 139         this.hideShowButton.connect( this, { click: 'onHideShowButtonClick' } );
 140         // Stop propagation for mousedown, so that the widget doesn't
 141         // trigger the focus on the input and scrolls up when we click the reset button
 142         this.resetButton.$element.on( 'mousedown', function ( e ) {
 143                 e.stopPropagation();
 144         } );
 145         this.hideShowButton.$element.on( 'mousedown', function ( e ) {
 146                 e.stopPropagation();
 147         } );
 148         this.model.connect( this, {
 149                 initialize: 'onModelInitialize',
 150                 update: 'onModelUpdate',
 151                 searchChange: 'onModelSearchChange',
 152                 itemUpdate: 'onModelItemUpdate',
 153                 highlightChange: 'onModelHighlightChange'
 154         } );
 155         this.input.connect( this, { change: 'onInputChange' } );
 156
 157         // The filter list and button should appear side by side regardless of how
 158         // wide the button is; the button also changes its width depending
 159         // on language and its state, so the safest way to present both side
 160         // by side is with a table layout
 161         rcFiltersRow = $( '<div>' )
 162                 .addClass( 'mw-rcfilters-ui-row' )
 163                 .append(
 164                         this.$content
 165                                 .addClass( 'mw-rcfilters-ui-cell' )
 166                                 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-cell-filters' )
 167                 );
 168
 169         if ( !mw.user.isAnon() ) {
 170                 rcFiltersRow.append(
 171                         $( '<div>' )
 172                                 .addClass( 'mw-rcfilters-ui-cell' )
 173                                 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-cell-save' )
 174                                 .append( this.saveQueryButton.$element )
 175                 );
 176         }
 177
 178         // Add a selector at the right of the input
 179         this.viewsSelectWidget = new OO.ui.ButtonSelectWidget( {
 180                 classes: [ 'mw-rcfilters-ui-filterTagMultiselectWidget-views-select-widget' ],
 181                 items: [
 182                         new OO.ui.ButtonOptionWidget( {
 183                                 framed: false,
 184                                 data: 'namespaces',
 185                                 icon: 'article',
 186                                 label: mw.msg( 'namespaces' ),
 187                                 title: mw.msg( 'rcfilters-view-namespaces-tooltip' )
 188                         } ),
 189                         new OO.ui.ButtonOptionWidget( {
 190                                 framed: false,
 191                                 data: 'tags',
 192                                 icon: 'tag',
 193                                 label: mw.msg( 'tags-title' ),
 194                                 title: mw.msg( 'rcfilters-view-tags-tooltip' )
 195                         } )
 196                 ]
 197         } );
 198
 199         // Rearrange the UI so the select widget is at the right of the input
 200         this.$element.append(
 201                 $( '<div>' )
 202                         .addClass( 'mw-rcfilters-ui-table' )
 203                         .append(
 204                                 $( '<div>' )
 205                                         .addClass( 'mw-rcfilters-ui-row' )
 206                                         .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-views' )
 207                                         .append(
 208                                                 $( '<div>' )
 209                                                         .addClass( 'mw-rcfilters-ui-cell' )
 210                                                         .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-views-input' )
 211                                                         .append( this.input.$element ),
 212                                                 $( '<div>' )
 213                                                         .addClass( 'mw-rcfilters-ui-cell' )
 214                                                         .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-views-select' )
 215                                                         .append( this.viewsSelectWidget.$element )
 216                                         )
 217                         )
 218         );
 219
 220         // Event
 221         this.viewsSelectWidget.connect( this, { choose: 'onViewsSelectWidgetChoose' } );
 222
 223         rcFiltersRow.append(
 224                 $( '<div>' )
 225                         .addClass( 'mw-rcfilters-ui-cell' )
 226                         .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-cell-reset' )
 227                         .append( this.resetButton.$element )
 228         );
 229
 230         // Build the content
 231         $contentWrapper.append(
 232                 $( '<div>' )
 233                         .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-wrapper-top' )
 234                         .append(
 235                                 $( '<div>' )
 236                                         .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-wrapper-top-title' )
 237                                         .append( title.$element ),
 238                                 $( '<div>' )
 239                                         .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-wrapper-top-queryName' )
 240                                         .append( this.savedQueryTitle.$element ),
 241                                 $( '<div>' )
 242                                         .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-wrapper-top-hideshow' )
 243                                         .append(
 244                                                 this.hideShowButton.$element
 245                                         )
 246                         ),
 247                 $( '<div>' )
 248                         .addClass( 'mw-rcfilters-ui-table' )
 249                         .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-wrapper-filters' )
 250                         .append( rcFiltersRow )
 251         );
 252
 253         // Initialize
 254         this.$handle.append( $contentWrapper );
 255         this.emptyFilterMessage.toggle( this.isEmpty() );
 256         this.savedQueryTitle.toggle( false );
 257
 258         this.$element
 259                 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget' );
 260
 261         this.reevaluateResetRestoreState();
 262 };
 263
 264 /* Initialization */
 265
 266 OO.inheritClass( FilterTagMultiselectWidget, OO.ui.MenuTagMultiselectWidget );
 267
 268 /* Methods */
 269
 270 /**
 271  * Respond to view select widget choose event
 272  *
 273  * @param {OO.ui.ButtonOptionWidget} buttonOptionWidget Chosen widget
 274  */
 275 FilterTagMultiselectWidget.prototype.onViewsSelectWidgetChoose = function ( buttonOptionWidget ) {
 276         this.controller.switchView( buttonOptionWidget.getData() );
 277         this.viewsSelectWidget.selectItem( null );
 278         this.focus();
 279 };
 280
 281 /**
 282  * Respond to model search change event
 283  *
 284  * @param {string} value Search value
 285  */
 286 FilterTagMultiselectWidget.prototype.onModelSearchChange = function ( value ) {
 287         this.input.setValue( value );
 288 };
 289
 290 /**
 291  * Respond to input change event
 292  *
 293  * @param {string} value Value of the input
 294  */
 295 FilterTagMultiselectWidget.prototype.onInputChange = function ( value ) {
 296         this.controller.setSearch( value );
 297 };
 298
 299 /**
 300  * Respond to query button click
 301  */
 302 FilterTagMultiselectWidget.prototype.onSaveQueryButtonClick = function () {
 303         this.getMenu().toggle( false );
 304 };
 305
 306 /**
 307  * Respond to save query model initialization
 308  */
 309 FilterTagMultiselectWidget.prototype.onSavedQueriesInitialize = function () {
 310         this.setSavedQueryVisibility();
 311 };
 312
 313 /**
 314  * Respond to save query item change. Mainly this is done to update the label in case
 315  * a query item has been edited
 316  *
 317  * @param {mw.rcfilters.dm.SavedQueryItemModel} item Saved query item
 318  */
 319 FilterTagMultiselectWidget.prototype.onSavedQueriesItemUpdate = function ( item ) {
 320         if ( this.matchingQuery === item ) {
 321                 // This means we just edited the item that is currently matched
 322                 this.savedQueryTitle.setLabel( item.getLabel() );
 323         }
 324 };
 325
 326 /**
 327  * Respond to menu toggle
 328  *
 329  * @param {boolean} isVisible Menu is visible
 330  */
 331 FilterTagMultiselectWidget.prototype.onMenuToggle = function ( isVisible ) {
 332         // Parent
 333         FilterTagMultiselectWidget.parent.prototype.onMenuToggle.call( this );
 334
 335         if ( isVisible ) {
 336                 this.focus();
 337
 338                 mw.hook( 'RcFilters.popup.open' ).fire();
 339
 340                 if ( !this.getMenu().findSelectedItem() ) {
 341                         // If there are no selected items, scroll menu to top
 342                         // This has to be in a setTimeout so the menu has time
 343                         // to be positioned and fixed
 344                         setTimeout(
 345                                 function () {
 346                                         this.getMenu().scrollToTop();
 347                                 }.bind( this )
 348                         );
 349                 }
 350         } else {
 351                 // Clear selection
 352                 this.selectTag( null );
 353
 354                 // Clear the search
 355                 this.controller.setSearch( '' );
 356
 357                 // Log filter grouping
 358                 this.controller.trackFilterGroupings( 'filtermenu' );
 359
 360                 this.blur();
 361         }
 362
 363         this.input.setIcon( isVisible ? 'search' : 'menu' );
 364 };
 365
 366 /**
 367  * @inheritdoc
 368  */
 369 FilterTagMultiselectWidget.prototype.onInputFocus = function () {
 370         // Parent
 371         FilterTagMultiselectWidget.parent.prototype.onInputFocus.call( this );
 372
 373         // Only scroll to top of the viewport if:
 374         // - The widget is more than 20px from the top
 375         // - The widget is not above the top of the viewport (do not scroll downwards)
 376         //   (This isn't represented because >20 is, anyways and always, bigger than 0)
 377         this.scrollToTop( this.$element, 0, { min: 20, max: Infinity } );
 378 };
 379
 380 /**
 381  * @inheritdoc
 382  */
 383 FilterTagMultiselectWidget.prototype.doInputEscape = function () {
 384         // Parent
 385         FilterTagMultiselectWidget.parent.prototype.doInputEscape.call( this );
 386
 387         // Blur the input
 388         this.input.$input.trigger( 'blur' );
 389 };
 390
 391 /**
 392  * @inheritdoc
 393  */
 394 FilterTagMultiselectWidget.prototype.onMouseDown = function ( e ) {
 395         if ( !this.collapsed && !this.isDisabled() && e.which === OO.ui.MouseButtons.LEFT ) {
 396                 this.menu.toggle();
 397
 398                 return false;
 399         }
 400 };
 401
 402 /**
 403  * @inheritdoc
 404  */
 405 FilterTagMultiselectWidget.prototype.onChangeTags = function () {
 406         // If initialized, call parent method.
 407         if ( this.controller.isInitialized() ) {
 408                 FilterTagMultiselectWidget.parent.prototype.onChangeTags.call( this );
 409         }
 410
 411         this.emptyFilterMessage.toggle( this.isEmpty() );
 412 };
 413
 414 /**
 415  * Respond to model initialize event
 416  */
 417 FilterTagMultiselectWidget.prototype.onModelInitialize = function () {
 418         this.setSavedQueryVisibility();
 419 };
 420
 421 /**
 422  * Respond to model update event
 423  */
 424 FilterTagMultiselectWidget.prototype.onModelUpdate = function () {
 425         this.updateElementsForView();
 426 };
 427
 428 /**
 429  * Update the elements in the widget to the current view
 430  */
 431 FilterTagMultiselectWidget.prototype.updateElementsForView = function () {
 432         var view = this.model.getCurrentView(),
 433                 inputValue = this.input.getValue().trim(),
 434                 inputView = this.model.getViewByTrigger( inputValue.substr( 0, 1 ) );
 435
 436         if ( inputView !== 'default' ) {
 437                 // We have a prefix already, remove it
 438                 inputValue = inputValue.substr( 1 );
 439         }
 440
 441         if ( inputView !== view ) {
 442                 // Add the correct prefix
 443                 inputValue = this.model.getViewTrigger( view ) + inputValue;
 444         }
 445
 446         // Update input
 447         this.input.setValue( inputValue );
 448
 449         if ( this.currentView !== view ) {
 450                 this.scrollToTop( this.$element );
 451                 this.currentView = view;
 452         }
 453 };
 454
 455 /**
 456  * Set the visibility of the saved query button
 457  */
 458 FilterTagMultiselectWidget.prototype.setSavedQueryVisibility = function () {
 459         if ( mw.user.isAnon() ) {
 460                 return;
 461         }
 462
 463         this.matchingQuery = this.controller.findQueryMatchingCurrentState();
 464
 465         this.savedQueryTitle.setLabel(
 466                 this.matchingQuery ? this.matchingQuery.getLabel() : ''
 467         );
 468         this.savedQueryTitle.toggle( !!this.matchingQuery );
 469         this.saveQueryButton.setDisabled( !!this.matchingQuery );
 470         this.saveQueryButton.setTitle( !this.matchingQuery ?
 471                 mw.msg( 'rcfilters-savedqueries-add-new-title' ) :
 472                 mw.msg( 'rcfilters-savedqueries-already-saved' ) );
 473
 474         if ( this.matchingQuery ) {
 475                 this.emphasize();
 476         }
 477 };
 478
 479 /**
 480  * Respond to model itemUpdate event
 481  * fixme: when a new state is applied to the model this function is called 60+ times in a row
 482  *
 483  * @param {mw.rcfilters.dm.FilterItem} item Filter item model
 484  */
 485 FilterTagMultiselectWidget.prototype.onModelItemUpdate = function ( item ) {
 486         if ( !item.getGroupModel().isHidden() ) {
 487                 if (
 488                         item.isSelected() ||
 489                         (
 490                                 this.model.isHighlightEnabled() &&
 491                                 item.getHighlightColor()
 492                         )
 493                 ) {
 494                         this.addTag( item.getName(), item.getLabel() );
 495                 } else {
 496                         // Only attempt to remove the tag if we can find an item for it (T198140, T198231)
 497                         if ( this.findItemFromData( item.getName() ) !== null ) {
 498                                 this.removeTagByData( item.getName() );
 499                         }
 500                 }
 501         }
 502
 503         this.setSavedQueryVisibility();
 504
 505         // Re-evaluate reset state
 506         this.reevaluateResetRestoreState();
 507 };
 508
 509 /**
 510  * @inheritdoc
 511  */
 512 FilterTagMultiselectWidget.prototype.isAllowedData = function ( data ) {
 513         return (
 514                 this.model.getItemByName( data ) &&
 515                 !this.isDuplicateData( data )
 516         );
 517 };
 518
 519 /**
 520  * @inheritdoc
 521  */
 522 FilterTagMultiselectWidget.prototype.onMenuChoose = function ( item ) {
 523         this.controller.toggleFilterSelect( item.model.getName() );
 524
 525         // Select the tag if it exists, or reset selection otherwise
 526         this.selectTag( this.findItemFromData( item.model.getName() ) );
 527
 528         this.focus();
 529 };
 530
 531 /**
 532  * Respond to highlightChange event
 533  *
 534  * @param {boolean} isHighlightEnabled Highlight is enabled
 535  */
 536 FilterTagMultiselectWidget.prototype.onModelHighlightChange = function ( isHighlightEnabled ) {
 537         var highlightedItems = this.model.getHighlightedItems();
 538
 539         if ( isHighlightEnabled ) {
 540                 // Add capsule widgets
 541                 highlightedItems.forEach( function ( filterItem ) {
 542                         this.addTag( filterItem.getName(), filterItem.getLabel() );
 543                 }.bind( this ) );
 544         } else {
 545                 // Remove capsule widgets if they're not selected
 546                 highlightedItems.forEach( function ( filterItem ) {
 547                         if ( !filterItem.isSelected() ) {
 548                                 // Only attempt to remove the tag if we can find an item for it (T198140, T198231)
 549                                 if ( this.findItemFromData( filterItem.getName() ) !== null ) {
 550                                         this.removeTagByData( filterItem.getName() );
 551                                 }
 552                         }
 553                 }.bind( this ) );
 554         }
 555
 556         this.setSavedQueryVisibility();
 557 };
 558
 559 /**
 560  * @inheritdoc
 561  */
 562 FilterTagMultiselectWidget.prototype.onTagSelect = function ( tagItem ) {
 563         var menuOption = this.menu.getItemFromModel( tagItem.getModel() );
 564
 565         this.menu.setUserSelecting( true );
 566         // Parent method
 567         FilterTagMultiselectWidget.parent.prototype.onTagSelect.call( this, tagItem );
 568
 569         // Switch view
 570         this.controller.resetSearchForView( tagItem.getView() );
 571
 572         this.selectTag( tagItem );
 573         this.scrollToTop( menuOption.$element );
 574
 575         this.menu.setUserSelecting( false );
 576 };
 577
 578 /**
 579  * Select a tag by reference. This is what OO.ui.SelectWidget is doing.
 580  * If no items are given, reset selection from all.
 581  *
 582  * @param {mw.rcfilters.ui.FilterTagItemWidget} [item] Tag to select,
 583  *  omit to deselect all
 584  */
 585 FilterTagMultiselectWidget.prototype.selectTag = function ( item ) {
 586         var i, len, selected;
 587
 588         for ( i = 0, len = this.items.length; i < len; i++ ) {
 589                 selected = this.items[ i ] === item;
 590                 if ( this.items[ i ].isSelected() !== selected ) {
 591                         this.items[ i ].toggleSelected( selected );
 592                 }
 593         }
 594 };
 595 /**
 596  * @inheritdoc
 597  */
 598 FilterTagMultiselectWidget.prototype.onTagRemove = function ( tagItem ) {
 599         // Parent method
 600         FilterTagMultiselectWidget.parent.prototype.onTagRemove.call( this, tagItem );
 601
 602         this.controller.clearFilter( tagItem.getName() );
 603
 604         tagItem.destroy();
 605 };
 606
 607 /**
 608  * Respond to click event on the reset button
 609  */
 610 FilterTagMultiselectWidget.prototype.onResetButtonClick = function () {
 611         if ( this.model.areVisibleFiltersEmpty() ) {
 612                 // Reset to default filters
 613                 this.controller.resetToDefaults();
 614         } else {
 615                 // Reset to have no filters
 616                 this.controller.emptyFilters();
 617         }
 618 };
 619
 620 /**
 621  * Respond to hide/show button click
 622  */
 623 FilterTagMultiselectWidget.prototype.onHideShowButtonClick = function () {
 624         this.toggleCollapsed();
 625 };
 626
 627 /**
 628  * Toggle the collapsed state of the filters widget
 629  *
 630  * @param {boolean} isCollapsed Widget is collapsed
 631  */
 632 FilterTagMultiselectWidget.prototype.toggleCollapsed = function ( isCollapsed ) {
 633         isCollapsed = isCollapsed === undefined ? !this.collapsed : !!isCollapsed;
 634
 635         this.collapsed = isCollapsed;
 636
 637         if ( isCollapsed ) {
 638                 // If we are collapsing, close the menu, in case it was open
 639                 // We should make sure the menu closes before the rest of the elements
 640                 // are hidden, otherwise there is an unknown error in jQuery as ooui
 641                 // sets and unsets properties on the input (which is hidden at that point)
 642                 this.menu.toggle( false );
 643         }
 644         this.input.setDisabled( isCollapsed );
 645         this.hideShowButton.setLabel( mw.msg(
 646                 isCollapsed ? 'rcfilters-activefilters-show' : 'rcfilters-activefilters-hide'
 647         ) );
 648         this.hideShowButton.setTitle( mw.msg(
 649                 isCollapsed ? 'rcfilters-activefilters-show-tooltip' : 'rcfilters-activefilters-hide-tooltip'
 650         ) );
 651
 652         // Toggle the wrapper class, so we have min height values correctly throughout
 653         this.$wrapper.toggleClass( 'mw-rcfilters-collapsed', isCollapsed );
 654
 655         // Save the state
 656         this.controller.updateCollapsedState( isCollapsed );
 657 };
 658
 659 /**
 660  * Reevaluate the restore state for the widget between setting to defaults and clearing all filters
 661  */
 662 FilterTagMultiselectWidget.prototype.reevaluateResetRestoreState = function () {
 663         var defaultsAreEmpty = this.controller.areDefaultsEmpty(),
 664                 currFiltersAreEmpty = this.model.areVisibleFiltersEmpty(),
 665                 hideResetButton = currFiltersAreEmpty && defaultsAreEmpty;
 666
 667         this.resetButton.setIcon(
 668                 currFiltersAreEmpty ? 'history' : 'trash'
 669         );
 670
 671         this.resetButton.setLabel(
 672                 currFiltersAreEmpty ? mw.msg( 'rcfilters-restore-default-filters' ) : ''
 673         );
 674         this.resetButton.setTitle(
 675                 currFiltersAreEmpty ? null : mw.msg( 'rcfilters-clear-all-filters' )
 676         );
 677
 678         this.resetButton.toggle( !hideResetButton );
 679         this.emptyFilterMessage.toggle( currFiltersAreEmpty );
 680 };
 681
 682 /**
 683  * @inheritdoc
 684  */
 685 FilterTagMultiselectWidget.prototype.createMenuWidget = function ( menuConfig ) {
 686         return new MenuSelectWidget(
 687                 this.controller,
 688                 this.model,
 689                 menuConfig
 690         );
 691 };
 692
 693 /**
 694  * @inheritdoc
 695  */
 696 FilterTagMultiselectWidget.prototype.createTagItemWidget = function ( data ) {
 697         var filterItem = this.model.getItemByName( data );
 698
 699         if ( filterItem ) {
 700                 return new FilterTagItemWidget(
 701                         this.controller,
 702                         this.model,
 703                         this.model.getInvertModel(),
 704                         filterItem,
 705                         {
 706                                 $overlay: this.$overlay
 707                         }
 708                 );
 709         }
 710 };
 711
 712 FilterTagMultiselectWidget.prototype.emphasize = function () {
 713         if (
 714                 // eslint-disable-next-line no-jquery/no-class-state
 715                 !this.$handle.hasClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-animate' )
 716         ) {
 717                 this.$handle
 718                         .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-emphasize' )
 719                         .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-animate' );
 720
 721                 setTimeout( function () {
 722                         this.$handle
 723                                 .removeClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-emphasize' );
 724
 725                         setTimeout( function () {
 726                                 this.$handle
 727                                         .removeClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-animate' );
 728                         }.bind( this ), 1000 );
 729                 }.bind( this ), 500 );
 730
 731         }
 732 };
 733 /**
 734  * Scroll the element to top within its container
 735  *
 736  * @private
 737  * @param {jQuery} $element Element to position
 738  * @param {number} [marginFromTop=0] When scrolling the entire widget to the top, leave this
 739  *  much space (in pixels) above the widget.
 740  * @param {Object} [threshold] Minimum distance from the top of the element to scroll at all
 741  * @param {number} [threshold.min] Minimum distance above the element
 742  * @param {number} [threshold.max] Minimum distance below the element
 743  */
 744 FilterTagMultiselectWidget.prototype.scrollToTop = function ( $element, marginFromTop, threshold ) {
 745         var container = OO.ui.Element.static.getClosestScrollableContainer( $element[ 0 ], 'y' ),
 746                 pos = OO.ui.Element.static.getRelativePosition( $element, $( container ) ),
 747                 containerScrollTop = $( container ).scrollTop(),
 748                 effectiveScrollTop = $( container ).is( 'body, html' ) ? 0 : containerScrollTop,
 749                 newScrollTop = effectiveScrollTop + pos.top - ( marginFromTop || 0 );
 750
 751         // Scroll to item
 752         if (
 753                 threshold === undefined ||
 754                 (
 755                         (
 756                                 threshold.min === undefined ||
 757                                 newScrollTop - containerScrollTop >= threshold.min
 758                         ) &&
 759                         (
 760                                 threshold.max === undefined ||
 761                                 newScrollTop - containerScrollTop <= threshold.max
 762                         )
 763                 )
 764         ) {
 765                 $( container ).animate( {
 766                         scrollTop: newScrollTop
 767                 } );
 768         }
 769 };
 770
 771 module.exports = FilterTagMultiselectWidget;