3 * Extend OOUI's TagItemWidget to also display a popup on hover.
6 * @extends OO.ui.TagItemWidget
7 * @mixins OO.ui.mixin.PopupElement
10 * @param {mw.rcfilters.Controller} controller
11 * @param {mw.rcfilters.dm.FiltersViewModel} filtersViewModel
12 * @param {mw.rcfilters.dm.FilterItem} invertModel
13 * @param {mw.rcfilters.dm.FilterItem} itemModel Item model
14 * @param {Object} config Configuration object
15 * @cfg {jQuery} [$overlay] A jQuery object serving as overlay for popups
17 mw
.rcfilters
.ui
.TagItemWidget
= function MwRcfiltersUiTagItemWidget(
18 controller
, filtersViewModel
, invertModel
, itemModel
, config
20 // Configuration initialization
21 config
= config
|| {};
23 this.controller
= controller
;
24 this.invertModel
= invertModel
;
25 this.filtersViewModel
= filtersViewModel
;
26 this.itemModel
= itemModel
;
27 this.selected
= false;
29 mw
.rcfilters
.ui
.TagItemWidget
.parent
.call( this, $.extend( {
30 data
: this.itemModel
.getName()
33 this.$overlay
= config
.$overlay
|| this.$element
;
34 this.popupLabel
= new OO
.ui
.LabelWidget();
37 OO
.ui
.mixin
.PopupElement
.call( this, $.extend( {
42 $content
: $( '<div>' )
43 .addClass( 'mw-rcfilters-ui-tagItemWidget-popup-content' )
44 .append( this.popupLabel
.$element
),
45 $floatableContainer
: this.$element
,
46 classes
: [ 'mw-rcfilters-ui-tagItemWidget-popup' ]
50 this.popupTimeoutShow
= null;
51 this.popupTimeoutHide
= null;
53 this.$highlight
= $( '<div>' )
54 .addClass( 'mw-rcfilters-ui-tagItemWidget-highlight' );
56 // Add title attribute with the item label to 'x' button
57 this.closeButton
.setTitle( mw
.msg( 'rcfilters-tag-remove', this.itemModel
.getLabel() ) );
60 this.filtersViewModel
.connect( this, { highlightChange
: 'updateUiBasedOnState' } );
61 this.invertModel
.connect( this, { update
: 'updateUiBasedOnState' } );
62 this.itemModel
.connect( this, { update
: 'updateUiBasedOnState' } );
65 this.$overlay
.append( this.popup
.$element
);
67 .addClass( 'mw-rcfilters-ui-tagItemWidget' )
68 .prepend( this.$highlight
)
69 .attr( 'aria-haspopup', 'true' )
70 .on( 'mouseenter', this.onMouseEnter
.bind( this ) )
71 .on( 'mouseleave', this.onMouseLeave
.bind( this ) );
73 this.updateUiBasedOnState();
78 OO
.inheritClass( mw
.rcfilters
.ui
.TagItemWidget
, OO
.ui
.TagItemWidget
);
79 OO
.mixinClass( mw
.rcfilters
.ui
.TagItemWidget
, OO
.ui
.mixin
.PopupElement
);
84 * Respond to model update event
86 mw
.rcfilters
.ui
.TagItemWidget
.prototype.updateUiBasedOnState = function () {
87 // Update label if needed
88 var labelMsg
= this.itemModel
.getLabelMessageKey( this.invertModel
.isSelected() );
90 this.setLabel( $( '<div>' ).append(
92 mw
.message( labelMsg
, mw
.html
.escape( this.itemModel
.getLabel() ) ).parse()
98 this.itemModel
.getLabel()
103 this.setCurrentMuteState();
104 this.setHighlightColor();
108 * Set the current highlight color for this item
110 mw
.rcfilters
.ui
.TagItemWidget
.prototype.setHighlightColor = function () {
111 var selectedColor
= this.filtersViewModel
.isHighlightEnabled() && this.itemModel
.isHighlighted
?
112 this.itemModel
.getHighlightColor() :
116 .attr( 'data-color', selectedColor
)
118 'mw-rcfilters-ui-tagItemWidget-highlight-highlighted',
124 * Set the current mute state for this item
126 mw
.rcfilters
.ui
.TagItemWidget
.prototype.setCurrentMuteState = function () {};
129 * Respond to mouse enter event
131 mw
.rcfilters
.ui
.TagItemWidget
.prototype.onMouseEnter = function () {
132 var labelText
= this.itemModel
.getStateMessage();
135 this.popupLabel
.setLabel( labelText
);
137 // Set timeout for the popup to show
138 this.popupTimeoutShow
= setTimeout( function () {
139 this.popup
.toggle( true );
140 }.bind( this ), 500 );
142 // Cancel the hide timeout
143 clearTimeout( this.popupTimeoutHide
);
144 this.popupTimeoutHide
= null;
149 * Respond to mouse leave event
151 mw
.rcfilters
.ui
.TagItemWidget
.prototype.onMouseLeave = function () {
152 this.popupTimeoutHide
= setTimeout( function () {
153 this.popup
.toggle( false );
154 }.bind( this ), 250 );
156 // Clear the show timeout
157 clearTimeout( this.popupTimeoutShow
);
158 this.popupTimeoutShow
= null;
162 * Set selected state on this widget
164 * @param {boolean} [isSelected] Widget is selected
166 mw
.rcfilters
.ui
.TagItemWidget
.prototype.toggleSelected = function ( isSelected
) {
167 isSelected
= isSelected
!== undefined ? isSelected
: !this.selected
;
169 if ( this.selected
!== isSelected
) {
170 this.selected
= isSelected
;
172 this.$element
.toggleClass( 'mw-rcfilters-ui-tagItemWidget-selected', this.selected
);
177 * Get the selected state of this widget
179 * @return {boolean} Tag is selected
181 mw
.rcfilters
.ui
.TagItemWidget
.prototype.isSelected = function () {
182 return this.selected
;
188 * @return {string} Filter name
190 mw
.rcfilters
.ui
.TagItemWidget
.prototype.getName = function () {
191 return this.itemModel
.getName();
197 * @return {string} Filter model
199 mw
.rcfilters
.ui
.TagItemWidget
.prototype.getModel = function () {
200 return this.itemModel
;
206 * @return {string} Filter view
208 mw
.rcfilters
.ui
.TagItemWidget
.prototype.getView = function () {
209 return this.itemModel
.getGroupModel().getView();
213 * Remove and destroy external elements of this widget
215 mw
.rcfilters
.ui
.TagItemWidget
.prototype.destroy = function () {
217 this.popup
.$element
.detach();
220 this.itemModel
.disconnect( this );
221 this.closeButton
.disconnect( this );
223 }( mediaWiki
, jQuery
) );