3 * Filter-specific CapsuleMultiselectWidget
6 * @extends OO.ui.CapsuleMultiselectWidget
9 * @param {mw.rcfilters.Controller} controller RCFilters controller
10 * @param {mw.rcfilters.dm.FiltersViewModel} model RCFilters view model
11 * @param {OO.ui.InputWidget} filterInput A filter input that focuses the capsule widget
12 * @param {Object} config Configuration object
13 * @cfg {jQuery} [$overlay] A jQuery object serving as overlay for popups
15 mw
.rcfilters
.ui
.FilterCapsuleMultiselectWidget
= function MwRcfiltersUiFilterCapsuleMultiselectWidget( controller
, model
, filterInput
, config
) {
16 var title
= new OO
.ui
.LabelWidget( {
17 label
: mw
.msg( 'rcfilters-activefilters' ),
18 classes
: [ 'mw-rcfilters-ui-filterCapsuleMultiselectWidget-wrapper-content-title' ]
20 $contentWrapper
= $( '<div>' )
21 .addClass( 'mw-rcfilters-ui-filterCapsuleMultiselectWidget-wrapper' );
23 this.$overlay
= config
.$overlay
|| this.$element
;
26 mw
.rcfilters
.ui
.FilterCapsuleMultiselectWidget
.parent
.call( this, $.extend( true, {
27 popup
: { $autoCloseIgnore
: filterInput
.$element
.add( this.$overlay
) }
30 this.controller
= controller
;
32 this.filterInput
= filterInput
;
33 this.isSelecting
= false;
35 this.resetButton
= new OO
.ui
.ButtonWidget( {
38 title
: mw
.msg( 'rcfilters-clear-all-filters' ),
39 classes
: [ 'mw-rcfilters-ui-filterCapsuleMultiselectWidget-resetButton' ]
42 this.emptyFilterMessage
= new OO
.ui
.LabelWidget( {
43 label
: mw
.msg( 'rcfilters-empty-filter' ),
44 classes
: [ 'mw-rcfilters-ui-filterCapsuleMultiselectWidget-emptyFilters' ]
46 this.$content
.append( this.emptyFilterMessage
.$element
);
49 this.resetButton
.connect( this, { click
: 'onResetButtonClick' } );
50 this.model
.connect( this, {
51 itemUpdate
: 'onModelItemUpdate',
52 highlightChange
: 'onModelHighlightChange'
54 this.aggregate( { click
: 'capsuleItemClick' } );
56 // Add the filterInput as trigger
57 this.filterInput
.$input
58 .on( 'focus', this.focus
.bind( this ) );
61 $contentWrapper
.append(
64 .addClass( 'mw-rcfilters-ui-table' )
66 // The filter list and button should appear side by side regardless of how
67 // wide the button is; the button also changes its width depending
68 // on language and its state, so the safest way to present both side
69 // by side is with a table layout
71 .addClass( 'mw-rcfilters-ui-row' )
74 .addClass( 'mw-rcfilters-ui-cell' )
75 .addClass( 'mw-rcfilters-ui-filterCapsuleMultiselectWidget-cell-filters' ),
77 .addClass( 'mw-rcfilters-ui-cell' )
78 .addClass( 'mw-rcfilters-ui-filterCapsuleMultiselectWidget-cell-reset' )
79 .append( this.resetButton
.$element
)
85 this.$handle
.append( $contentWrapper
);
88 .addClass( 'mw-rcfilters-ui-filterCapsuleMultiselectWidget' );
90 this.reevaluateResetRestoreState();
95 OO
.inheritClass( mw
.rcfilters
.ui
.FilterCapsuleMultiselectWidget
, OO
.ui
.CapsuleMultiselectWidget
);
101 * @param {string[]} filters Array of names of removed filters
103 * Filters were removed
109 * Respond to model itemUpdate event
111 * @param {mw.rcfilters.dm.FilterItem} item Filter item model
113 mw
.rcfilters
.ui
.FilterCapsuleMultiselectWidget
.prototype.onModelItemUpdate = function ( item
) {
117 this.model
.isHighlightEnabled() &&
118 item
.isHighlightSupported() &&
119 item
.getHighlightColor()
122 this.addItemByName( item
.getName() );
124 this.removeItemByName( item
.getName() );
127 // Re-evaluate reset state
128 this.reevaluateResetRestoreState();
132 * Respond to highlightChange event
134 * @param {boolean} isHighlightEnabled Highlight is enabled
136 mw
.rcfilters
.ui
.FilterCapsuleMultiselectWidget
.prototype.onModelHighlightChange = function ( isHighlightEnabled
) {
137 var highlightedItems
= this.model
.getHighlightedItems();
139 if ( isHighlightEnabled
) {
140 // Add capsule widgets
141 highlightedItems
.forEach( function ( filterItem
) {
142 this.addItemByName( filterItem
.getName() );
145 // Remove capsule widgets if they're not selected
146 highlightedItems
.forEach( function ( filterItem
) {
147 if ( !filterItem
.isSelected() ) {
148 this.removeItemByName( filterItem
.getName() );
155 * Respond to click event on the reset button
157 mw
.rcfilters
.ui
.FilterCapsuleMultiselectWidget
.prototype.onResetButtonClick = function () {
158 if ( this.model
.areCurrentFiltersEmpty() ) {
159 // Reset to default filters
160 this.controller
.resetToDefaults();
162 // Reset to have no filters
163 this.controller
.emptyFilters();
168 * Reevaluate the restore state for the widget between setting to defaults and clearing all filters
170 mw
.rcfilters
.ui
.FilterCapsuleMultiselectWidget
.prototype.reevaluateResetRestoreState = function () {
171 var defaultsAreEmpty
= this.model
.areDefaultFiltersEmpty(),
172 currFiltersAreEmpty
= this.model
.areCurrentFiltersEmpty(),
173 hideResetButton
= currFiltersAreEmpty
&& defaultsAreEmpty
;
175 this.resetButton
.setIcon(
176 currFiltersAreEmpty
? 'history' : 'trash'
179 this.resetButton
.setLabel(
180 currFiltersAreEmpty
? mw
.msg( 'rcfilters-restore-default-filters' ) : ''
183 this.resetButton
.toggle( !hideResetButton
);
184 this.emptyFilterMessage
.toggle( currFiltersAreEmpty
);
190 mw
.rcfilters
.ui
.FilterCapsuleMultiselectWidget
.prototype.createItemWidget = function ( data
) {
191 var item
= this.model
.getItemByName( data
);
197 return new mw
.rcfilters
.ui
.CapsuleItemWidget(
200 { $overlay
: this.$overlay
}
205 * Add items by their filter name
207 * @param {string} name Filter name
209 mw
.rcfilters
.ui
.FilterCapsuleMultiselectWidget
.prototype.addItemByName = function ( name
) {
210 var item
= this.model
.getItemByName( name
);
216 // Check that the item isn't already added
217 if ( !this.getItemFromData( name
) ) {
218 this.addItems( [ this.createItemWidget( name
) ] );
223 * Remove items by their filter name
225 * @param {string} name Filter name
227 mw
.rcfilters
.ui
.FilterCapsuleMultiselectWidget
.prototype.removeItemByName = function ( name
) {
228 this.removeItemsFromData( [ name
] );
234 mw
.rcfilters
.ui
.FilterCapsuleMultiselectWidget
.prototype.focus = function () {
235 // Override this method; we don't want to focus on the popup, and we
236 // don't want to bind the size to the handle.
237 if ( !this.isDisabled() ) {
238 this.popup
.toggle( true );
239 this.filterInput
.$input
.get( 0 ).focus();
247 mw
.rcfilters
.ui
.FilterCapsuleMultiselectWidget
.prototype.onFocusForPopup = function () {
248 // HACK can be removed once I21b8cff4048 is merged in oojs-ui
255 mw
.rcfilters
.ui
.FilterCapsuleMultiselectWidget
.prototype.onKeyDown = function () {};
260 mw
.rcfilters
.ui
.FilterCapsuleMultiselectWidget
.prototype.onPopupFocusOut = function () {};
265 mw
.rcfilters
.ui
.FilterCapsuleMultiselectWidget
.prototype.clearInput = function () {
266 if ( this.filterInput
) {
267 this.filterInput
.setValue( '' );
269 this.menu
.toggle( false );
270 this.menu
.selectItem();
271 this.menu
.highlightItem();
277 mw
.rcfilters
.ui
.FilterCapsuleMultiselectWidget
.prototype.removeItems = function ( items
) {
279 mw
.rcfilters
.ui
.FilterCapsuleMultiselectWidget
.parent
.prototype.removeItems
.call( this, items
);
281 // Destroy the item widget when it is removed
282 // This is done because we re-add items by recreating them, rather than hiding them
283 // and items include popups, that will just continue to be created and appended
285 items
.forEach( function ( widget
) {
291 * Override 'editItem' since it tries to use $input which does
292 * not exist when a popup is available.
294 mw
.rcfilters
.ui
.FilterCapsuleMultiselectWidget
.prototype.editItem = function () {};
295 }( mediaWiki
, jQuery
) );