3 * List displaying all filter groups
5 * @extends OO.ui.MenuTagMultiselectWidget
6 * @mixins OO.ui.mixin.PendingElement
9 * @param {mw.rcfilters.Controller} controller Controller
10 * @param {mw.rcfilters.dm.FiltersViewModel} model View model
11 * @param {mw.rcfilters.dm.SavedQueriesModel} savedQueriesModel Saved queries model
12 * @param {Object} config Configuration object
13 * @cfg {jQuery} [$overlay] A jQuery object serving as overlay for popups
15 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
= function MwRcfiltersUiFilterTagMultiselectWidget( controller
, model
, savedQueriesModel
, config
) {
17 areSavedQueriesEnabled
= mw
.config
.get( 'wgStructuredChangeFiltersEnableSaving' ),
18 title
= new OO
.ui
.LabelWidget( {
19 label
: mw
.msg( 'rcfilters-activefilters' ),
20 classes
: [ 'mw-rcfilters-ui-filterTagMultiselectWidget-wrapper-content-title' ]
22 $contentWrapper
= $( '<div>' )
23 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-wrapper' );
25 config
= config
|| {};
27 this.controller
= controller
;
29 this.queriesModel
= savedQueriesModel
;
30 this.$overlay
= config
.$overlay
|| this.$element
;
31 this.matchingQuery
= null;
32 this.areSavedQueriesEnabled
= areSavedQueriesEnabled
;
35 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.parent
.call( this, $.extend( true, {
36 label
: mw
.msg( 'rcfilters-filterlist-title' ),
37 placeholder
: mw
.msg( 'rcfilters-empty-filter' ),
38 inputPosition
: 'outline',
39 allowArbitrary
: false,
40 allowDisplayInvalidTags
: false,
41 allowReordering
: false,
42 $overlay
: this.$overlay
,
44 hideWhenOutOfView
: false,
51 // View select menu, appears on default view only
52 $element
: $( '<div>' )
53 .append( new mw
.rcfilters
.ui
.ViewSwitchWidget( this.controller
, this.model
).$element
),
58 // Feedback footer, appears on all views
59 $element
: $( '<div>' )
61 new OO
.ui
.ButtonWidget( {
64 flags
: [ 'progressive' ],
65 label
: mw
.msg( 'rcfilters-filterlist-feedbacklink' ),
66 href
: 'https://www.mediawiki.org/wiki/Help_talk:New_filters_for_edit_review'
74 placeholder
: mw
.msg( 'rcfilters-search-placeholder' )
78 this.savedQueryTitle
= new OO
.ui
.LabelWidget( {
80 classes
: [ 'mw-rcfilters-ui-filterTagMultiselectWidget-wrapper-content-savedQueryTitle' ]
83 this.resetButton
= new OO
.ui
.ButtonWidget( {
85 classes
: [ 'mw-rcfilters-ui-filterTagMultiselectWidget-resetButton' ]
88 if ( areSavedQueriesEnabled
) {
89 this.saveQueryButton
= new mw
.rcfilters
.ui
.SaveFiltersPopupButtonWidget(
94 this.saveQueryButton
.$element
.on( 'mousedown', function ( e
) { e
.stopPropagation(); } );
96 this.saveQueryButton
.connect( this, {
97 click
: 'onSaveQueryButtonClick',
98 saveCurrent
: 'setSavedQueryVisibility'
102 this.emptyFilterMessage
= new OO
.ui
.LabelWidget( {
103 label
: mw
.msg( 'rcfilters-empty-filter' ),
104 classes
: [ 'mw-rcfilters-ui-filterTagMultiselectWidget-emptyFilters' ]
106 this.$content
.append( this.emptyFilterMessage
.$element
);
109 this.resetButton
.connect( this, { click
: 'onResetButtonClick' } );
110 // Stop propagation for mousedown, so that the widget doesn't
111 // trigger the focus on the input and scrolls up when we click the reset button
112 this.resetButton
.$element
.on( 'mousedown', function ( e
) { e
.stopPropagation(); } );
113 this.model
.connect( this, {
114 initialize
: 'onModelInitialize',
115 update
: 'onModelUpdate',
116 itemUpdate
: 'onModelItemUpdate',
117 highlightChange
: 'onModelHighlightChange'
119 this.input
.connect( this, { change
: 'onInputChange' } );
120 this.queriesModel
.connect( this, { itemUpdate
: 'onSavedQueriesItemUpdate' } );
122 // The filter list and button should appear side by side regardless of how
123 // wide the button is; the button also changes its width depending
124 // on language and its state, so the safest way to present both side
125 // by side is with a table layout
126 rcFiltersRow
= $( '<div>' )
127 .addClass( 'mw-rcfilters-ui-row' )
130 .addClass( 'mw-rcfilters-ui-cell' )
131 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-cell-filters' )
134 if ( areSavedQueriesEnabled
) {
137 .addClass( 'mw-rcfilters-ui-cell' )
138 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-cell-save' )
139 .append( this.saveQueryButton
.$element
)
143 if ( mw
.config
.get( 'wgStructuredChangeFiltersEnableExperimentalViews' ) ) {
144 // Add a selector at the right of the input
145 this.viewsSelectWidget
= new OO
.ui
.ButtonSelectWidget( {
146 classes
: [ 'mw-rcfilters-ui-filterTagMultiselectWidget-views-select-widget' ],
148 new OO
.ui
.ButtonOptionWidget( {
151 title
: mw
.msg( 'namespaces' )
153 new OO
.ui
.ButtonOptionWidget( {
156 title
: mw
.msg( 'rcfilters-view-tags' )
161 // Rearrange the UI so the select widget is at the right of the input
162 this.$element
.append(
164 .addClass( 'mw-rcfilters-ui-table' )
167 .addClass( 'mw-rcfilters-ui-row' )
170 .addClass( 'mw-rcfilters-ui-cell' )
171 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-views-input' )
172 .append( this.input
.$element
),
174 .addClass( 'mw-rcfilters-ui-cell' )
175 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-views-select' )
176 .append( this.viewsSelectWidget
.$element
)
182 this.viewsSelectWidget
.connect( this, { choose
: 'onViewsSelectWidgetChoose' } );
187 .addClass( 'mw-rcfilters-ui-cell' )
188 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget-cell-reset' )
189 .append( this.resetButton
.$element
)
193 $contentWrapper
.append(
195 this.savedQueryTitle
.$element
,
197 .addClass( 'mw-rcfilters-ui-table' )
204 this.$handle
.append( $contentWrapper
);
205 this.emptyFilterMessage
.toggle( this.isEmpty() );
206 this.savedQueryTitle
.toggle( false );
209 .addClass( 'mw-rcfilters-ui-filterTagMultiselectWidget' );
211 this.reevaluateResetRestoreState();
216 OO
.inheritClass( mw
.rcfilters
.ui
.FilterTagMultiselectWidget
, OO
.ui
.MenuTagMultiselectWidget
);
221 * Respond to view select widget choose event
223 * @param {OO.ui.ButtonOptionWidget} buttonOptionWidget Chosen widget
225 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onViewsSelectWidgetChoose = function ( buttonOptionWidget
) {
226 this.controller
.switchView( buttonOptionWidget
.getData() );
227 this.viewsSelectWidget
.selectItem( null );
232 * Respond to input change event
234 * @param {string} value Value of the input
236 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onInputChange = function ( value
) {
237 var view
= this.model
.getViewByTrigger( value
.substr( 0, 1 ) );
239 this.controller
.switchView( view
);
242 * Respond to query button click
244 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onSaveQueryButtonClick = function () {
245 this.getMenu().toggle( false );
249 * Respond to save query item change. Mainly this is done to update the label in case
250 * a query item has been edited
252 * @param {mw.rcfilters.dm.SavedQueryItemModel} item Saved query item
254 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onSavedQueriesItemUpdate = function ( item
) {
255 if ( this.matchingQuery
=== item
) {
256 // This means we just edited the item that is currently matched
257 this.savedQueryTitle
.setLabel( item
.getLabel() );
262 * Respond to menu toggle
264 * @param {boolean} isVisible Menu is visible
266 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onMenuToggle = function ( isVisible
) {
268 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.parent
.prototype.onMenuToggle
.call( this );
271 mw
.hook( 'RcFilters.popup.open' ).fire();
273 if ( !this.getMenu().getSelectedItem() ) {
274 // If there are no selected items, scroll menu to top
275 // This has to be in a setTimeout so the menu has time
276 // to be positioned and fixed
277 setTimeout( function () { this.getMenu().scrollToTop(); }.bind( this ), 0 );
281 this.selectTag( null );
283 // Clear input if the only thing in the input is the prefix
285 this.input
.getValue() === this.model
.getViewTrigger( this.model
.getCurrentView() )
288 this.input
.setValue( '' );
292 this.input
.setIcon( isVisible
? 'search' : 'menu' );
298 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onInputFocus = function () {
300 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.parent
.prototype.onInputFocus
.call( this );
303 this.scrollToTop( this.$element
);
309 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.doInputEscape = function () {
311 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.parent
.prototype.doInputEscape
.call( this );
314 this.input
.$input
.blur();
320 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onChangeTags = function () {
322 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.parent
.prototype.onChangeTags
.call( this );
324 this.emptyFilterMessage
.toggle( this.isEmpty() );
328 * Respond to model initialize event
330 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onModelInitialize = function () {
331 this.setSavedQueryVisibility();
335 * Respond to model update event
337 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onModelUpdate = function () {
338 this.updateElementsForView();
342 * Update the elements in the widget to the current view
344 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.updateElementsForView = function () {
345 var view
= this.model
.getCurrentView(),
346 inputValue
= this.input
.getValue(),
347 inputView
= this.model
.getViewByTrigger( inputValue
.substr( 0, 1 ) );
349 if ( inputView
!== 'default' ) {
350 // We have a prefix already, remove it
351 inputValue
= inputValue
.substr( 1 );
354 if ( inputView
!== view
) {
355 // Add the correct prefix
356 inputValue
= this.model
.getViewTrigger( view
) + inputValue
;
360 this.input
.setValue( inputValue
);
364 * Set the visibility of the saved query button
366 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.setSavedQueryVisibility = function () {
367 if ( this.areSavedQueriesEnabled
) {
368 this.matchingQuery
= this.controller
.findQueryMatchingCurrentState();
370 this.savedQueryTitle
.setLabel(
371 this.matchingQuery
? this.matchingQuery
.getLabel() : ''
373 this.savedQueryTitle
.toggle( !!this.matchingQuery
);
374 this.saveQueryButton
.toggle(
382 * Respond to model itemUpdate event
384 * @param {mw.rcfilters.dm.FilterItem} item Filter item model
386 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onModelItemUpdate = function ( item
) {
390 this.model
.isHighlightEnabled() &&
391 item
.isHighlightSupported() &&
392 item
.getHighlightColor()
395 this.addTag( item
.getName(), item
.getLabel() );
397 this.removeTagByData( item
.getName() );
400 this.setSavedQueryVisibility();
402 // Re-evaluate reset state
403 this.reevaluateResetRestoreState();
409 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.isAllowedData = function ( data
) {
411 this.model
.getItemByName( data
) &&
412 !this.isDuplicateData( data
)
419 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onMenuChoose = function ( item
) {
420 this.controller
.toggleFilterSelect( item
.model
.getName() );
422 // Select the tag if it exists, or reset selection otherwise
423 this.selectTag( this.getItemFromData( item
.model
.getName() ) );
429 * Respond to highlightChange event
431 * @param {boolean} isHighlightEnabled Highlight is enabled
433 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onModelHighlightChange = function ( isHighlightEnabled
) {
434 var highlightedItems
= this.model
.getHighlightedItems();
436 if ( isHighlightEnabled
) {
437 // Add capsule widgets
438 highlightedItems
.forEach( function ( filterItem
) {
439 this.addTag( filterItem
.getName(), filterItem
.getLabel() );
442 // Remove capsule widgets if they're not selected
443 highlightedItems
.forEach( function ( filterItem
) {
444 if ( !filterItem
.isSelected() ) {
445 this.removeTagByData( filterItem
.getName() );
454 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onTagSelect = function ( tagItem
) {
456 menuOption
= this.menu
.getItemFromModel( tagItem
.getModel() ),
457 oldInputValue
= this.input
.getValue();
459 this.menu
.setUserSelecting( true );
462 this.input
.setValue( '' );
465 this.controller
.switchView( tagItem
.getView() );
468 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.parent
.prototype.onTagSelect
.call( this, tagItem
);
470 this.menu
.selectItem( menuOption
);
471 this.selectTag( tagItem
);
473 // Scroll to the item
474 if ( this.model
.removeViewTriggers( oldInputValue
) ) {
475 // We're binding a 'once' to the itemVisibilityChange event
476 // so this happens when the menu is ready after the items
477 // are visible again, in case this is done right after the
478 // user filtered the results
480 'itemVisibilityChange',
482 widget
.scrollToTop( menuOption
.$element
);
483 widget
.menu
.setUserSelecting( false );
487 this.scrollToTop( menuOption
.$element
);
488 this.menu
.setUserSelecting( false );
494 * Select a tag by reference. This is what OO.ui.SelectWidget is doing.
495 * If no items are given, reset selection from all.
497 * @param {mw.rcfilters.ui.FilterTagItemWidget} [item] Tag to select,
498 * omit to deselect all
500 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.selectTag = function ( item
) {
501 var i
, len
, selected
;
503 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
504 selected
= this.items
[ i
] === item
;
505 if ( this.items
[ i
].isSelected() !== selected
) {
506 this.items
[ i
].toggleSelected( selected
);
513 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onTagRemove = function ( tagItem
) {
515 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.parent
.prototype.onTagRemove
.call( this, tagItem
);
517 this.controller
.clearFilter( tagItem
.getName() );
523 * Respond to click event on the reset button
525 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.onResetButtonClick = function () {
526 if ( this.model
.areCurrentFiltersEmpty() ) {
527 // Reset to default filters
528 this.controller
.resetToDefaults();
530 // Reset to have no filters
531 this.controller
.emptyFilters();
536 * Reevaluate the restore state for the widget between setting to defaults and clearing all filters
538 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.reevaluateResetRestoreState = function () {
539 var defaultsAreEmpty
= this.model
.areDefaultFiltersEmpty(),
540 currFiltersAreEmpty
= this.model
.areCurrentFiltersEmpty(),
541 hideResetButton
= currFiltersAreEmpty
&& defaultsAreEmpty
;
543 this.resetButton
.setIcon(
544 currFiltersAreEmpty
? 'history' : 'trash'
547 this.resetButton
.setLabel(
548 currFiltersAreEmpty
? mw
.msg( 'rcfilters-restore-default-filters' ) : ''
550 this.resetButton
.setTitle(
551 currFiltersAreEmpty
? null : mw
.msg( 'rcfilters-clear-all-filters' )
554 this.resetButton
.toggle( !hideResetButton
);
555 this.emptyFilterMessage
.toggle( currFiltersAreEmpty
);
561 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.createMenuWidget = function ( menuConfig
) {
562 return new mw
.rcfilters
.ui
.MenuSelectWidget(
566 filterFromInput
: true
574 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.createTagItemWidget = function ( data
) {
575 var filterItem
= this.model
.getItemByName( data
);
578 return new mw
.rcfilters
.ui
.FilterTagItemWidget(
582 $overlay
: this.$overlay
589 * Scroll the element to top within its container
592 * @param {jQuery} $element Element to position
593 * @param {number} [marginFromTop] When scrolling the entire widget to the top, leave this
594 * much space (in pixels) above the widget.
596 mw
.rcfilters
.ui
.FilterTagMultiselectWidget
.prototype.scrollToTop = function ( $element
, marginFromTop
) {
597 var container
= OO
.ui
.Element
.static.getClosestScrollableContainer( $element
[ 0 ], 'y' ),
598 pos
= OO
.ui
.Element
.static.getRelativePosition( $element
, $( container
) ),
599 containerScrollTop
= $( container
).is( 'body, html' ) ? 0 : $( container
).scrollTop();
602 $( container
).animate( {
603 scrollTop
: containerScrollTop
+ pos
.top
- ( marginFromTop
|| 0 )