3 * A widget representing a single toggle filter
5 * @extends OO.ui.MenuOptionWidget
8 * @param {mw.rcfilters.Controller} controller RCFilters controller
9 * @param {mw.rcfilters.dm.FilterItem} model Filter item model
10 * @param {Object} config Configuration object
12 mw
.rcfilters
.ui
.FilterMenuOptionWidget
= function MwRcfiltersUiFilterMenuOptionWidget( controller
, model
, config
) {
15 .addClass( 'mw-rcfilters-ui-filterMenuOptionWidget-label' );
17 config
= config
|| {};
19 this.controller
= controller
;
23 mw
.rcfilters
.ui
.FilterMenuOptionWidget
.parent
.call( this, $.extend( {
24 // Override the 'check' icon that OOUI defines
26 data
: this.model
.getName(),
27 label
: this.model
.getLabel()
30 this.checkboxWidget
= new mw
.rcfilters
.ui
.CheckboxInputWidget( {
31 value
: this.model
.getName(),
32 selected
: this.model
.isSelected()
37 .addClass( 'mw-rcfilters-ui-filterMenuOptionWidget-label-title' )
38 .append( this.$label
)
40 if ( this.model
.getDescription() ) {
43 .addClass( 'mw-rcfilters-ui-filterMenuOptionWidget-label-desc' )
44 .text( this.model
.getDescription() )
48 this.highlightButton
= new mw
.rcfilters
.ui
.FilterItemHighlightButton(
52 $overlay
: config
.$overlay
|| this.$element
,
53 title
: mw
.msg( 'rcfilters-highlightmenu-help' )
56 this.highlightButton
.toggle( this.model
.isHighlightEnabled() );
58 layout
= new OO
.ui
.FieldLayout( this.checkboxWidget
, {
64 this.model
.connect( this, { update
: 'onModelUpdate' } );
65 this.model
.getGroupModel().connect( this, { update
: 'onGroupModelUpdate' } );
68 .addClass( 'mw-rcfilters-ui-filterMenuOptionWidget' )
71 .addClass( 'mw-rcfilters-ui-table' )
74 .addClass( 'mw-rcfilters-ui-row' )
77 .addClass( 'mw-rcfilters-ui-cell mw-rcfilters-ui-filterMenuOptionWidget-filterCheckbox' )
78 .append( layout
.$element
),
80 .addClass( 'mw-rcfilters-ui-cell mw-rcfilters-ui-filterMenuOptionWidget-highlightButton' )
81 .append( this.highlightButton
.$element
)
89 OO
.inheritClass( mw
.rcfilters
.ui
.FilterMenuOptionWidget
, OO
.ui
.MenuOptionWidget
);
91 /* Static properties */
93 // We do our own scrolling to top
94 mw
.rcfilters
.ui
.FilterMenuOptionWidget
.static.scrollIntoViewOnSelect
= false;
99 * Respond to item model update event
101 mw
.rcfilters
.ui
.FilterMenuOptionWidget
.prototype.onModelUpdate = function () {
102 this.checkboxWidget
.setSelected( this.model
.isSelected() );
104 this.setCurrentMuteState();
108 * Respond to item group model update event
110 mw
.rcfilters
.ui
.FilterMenuOptionWidget
.prototype.onGroupModelUpdate = function () {
111 this.setCurrentMuteState();
115 * Set the current mute state for this item
117 mw
.rcfilters
.ui
.FilterMenuOptionWidget
.prototype.setCurrentMuteState = function () {
118 this.$element
.toggleClass(
119 'mw-rcfilters-ui-filterMenuOptionWidget-muted',
120 this.model
.isConflicted() ||
122 // Item is also muted when any of the items in its group is active
123 this.model
.getGroupModel().isActive() &&
124 // But it isn't selected
125 !this.model
.isSelected() &&
126 // And also not included
127 !this.model
.isIncluded()
131 this.highlightButton
.toggle( this.model
.isHighlightEnabled() );
135 * Get the name of this filter
137 * @return {string} Filter name
139 mw
.rcfilters
.ui
.FilterMenuOptionWidget
.prototype.getName = function () {
140 return this.model
.getName();
143 mw
.rcfilters
.ui
.FilterMenuOptionWidget
.prototype.getModel = function () {