3 * Extend OOUI's CapsuleItemWidget to also display a popup on hover.
6 * @extends OO.ui.CapsuleItemWidget
7 * @mixins OO.ui.mixin.PopupElement
10 * @param {mw.rcfilters.Controller} controller
11 * @param {mw.rcfilters.dm.FilterItem} model Item model
12 * @param {Object} config Configuration object
13 * @cfg {jQuery} [$overlay] A jQuery object serving as overlay for popups
15 mw
.rcfilters
.ui
.CapsuleItemWidget
= function MwRcfiltersUiCapsuleItemWidget( controller
, model
, config
) {
16 var $popupContent
= $( '<div>' )
17 .addClass( 'mw-rcfilters-ui-capsuleItemWidget-popup' ),
18 descLabelWidget
= new OO
.ui
.LabelWidget();
20 // Configuration initialization
21 config
= config
|| {};
23 this.controller
= controller
;
25 this.$overlay
= config
.$overlay
|| this.$element
;
26 this.positioned
= false;
29 mw
.rcfilters
.ui
.CapsuleItemWidget
.parent
.call( this, $.extend( {
30 data
: this.model
.getName(),
31 label
: this.model
.getLabel()
35 OO
.ui
.mixin
.PopupElement
.call( this, $.extend( {
39 $content
: $popupContent
40 .append( descLabelWidget
.$element
),
41 $floatableContainer
: this.$element
45 // Set initial text for the popup - the description
46 descLabelWidget
.setLabel( this.model
.getDescription() );
48 this.$highlight
= $( '<div>' )
49 .addClass( 'mw-rcfilters-ui-capsuleItemWidget-highlight' );
52 this.model
.connect( this, { update
: 'onModelUpdate' } );
54 this.closeButton
.$element
.on( 'mousedown', this.onCloseButtonMouseDown
.bind( this ) );
57 this.$overlay
.append( this.popup
.$element
);
59 .prepend( this.$highlight
)
60 .attr( 'aria-haspopup', 'true' )
61 .addClass( 'mw-rcfilters-ui-capsuleItemWidget' )
62 .on( 'mouseover', this.onHover
.bind( this, true ) )
63 .on( 'mouseout', this.onHover
.bind( this, false ) );
65 this.setCurrentMuteState();
66 this.setHighlightColor();
69 OO
.inheritClass( mw
.rcfilters
.ui
.CapsuleItemWidget
, OO
.ui
.CapsuleItemWidget
);
70 OO
.mixinClass( mw
.rcfilters
.ui
.CapsuleItemWidget
, OO
.ui
.mixin
.PopupElement
);
73 * Respond to model update event
75 mw
.rcfilters
.ui
.CapsuleItemWidget
.prototype.onModelUpdate = function () {
76 this.setCurrentMuteState();
78 this.setHighlightColor();
82 * Override mousedown event to prevent its propagation to the parent,
83 * since the parent (the multiselect widget) focuses the popup when its
84 * mousedown event is fired.
86 * @param {jQuery.Event} e Event
88 mw
.rcfilters
.ui
.CapsuleItemWidget
.prototype.onCloseButtonMouseDown = function ( e
) {
93 * Override the event listening to the item close button click
95 mw
.rcfilters
.ui
.CapsuleItemWidget
.prototype.onCloseClick = function () {
96 var element
= this.getElementGroup();
98 if ( element
&& $.isFunction( element
.removeItems
) ) {
99 element
.removeItems( [ this ] );
102 // Respond to user removing the filter
103 this.controller
.updateFilter( this.model
.getName(), false );
104 this.controller
.clearHighlightColor( this.model
.getName() );
107 mw
.rcfilters
.ui
.CapsuleItemWidget
.prototype.setHighlightColor = function () {
108 var selectedColor
= this.model
.isHighlightEnabled() ? this.model
.getHighlightColor() : null;
111 .attr( 'data-color', selectedColor
)
113 'mw-rcfilters-ui-capsuleItemWidget-highlight-highlighted',
119 * Set the current mute state for this item
121 mw
.rcfilters
.ui
.CapsuleItemWidget
.prototype.setCurrentMuteState = function () {
124 'mw-rcfilters-ui-capsuleItemWidget-muted',
125 !this.model
.isSelected() ||
126 this.model
.isIncluded() ||
127 this.model
.isConflicted() ||
128 this.model
.isFullyCovered()
133 * Respond to hover event on the capsule item.
135 * @param {boolean} isHovering Mouse is hovering on the item
137 mw
.rcfilters
.ui
.CapsuleItemWidget
.prototype.onHover = function ( isHovering
) {
138 if ( this.model
.getDescription() ) {
139 this.popup
.toggle( isHovering
);
141 if ( isHovering
&& !this.positioned
) {
142 // Recalculate position to be center of the capsule item
143 this.popup
.$element
.css( 'margin-left', ( this.$element
.width() / 2 ) );
144 this.positioned
= true;
150 * Remove and destroy external elements of this widget
152 mw
.rcfilters
.ui
.CapsuleItemWidget
.prototype.destroy = function () {
154 this.popup
.$element
.detach();
157 this.model
.disconnect( this );
158 this.closeButton
.disconnect( this );
160 }( mediaWiki
, jQuery
) );