resources/src/mediawiki.rcfilters/ui/mw.rcfilters.ui.TagItemWidget.js

   1 ( function ( mw, $ ) {
   2         /**
   3          * Extend OOUI's TagItemWidget to also display a popup on hover.
   4          *
   5          * @class
   6          * @extends OO.ui.TagItemWidget
   7          * @mixins OO.ui.mixin.PopupElement
   8          *
   9          * @constructor
  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
  16          */
  17         mw.rcfilters.ui.TagItemWidget = function MwRcfiltersUiTagItemWidget(
  18                 controller, filtersViewModel, invertModel, itemModel, config
  19         ) {
  20                 // Configuration initialization
  21                 config = config || {};
  22
  23                 this.controller = controller;
  24                 this.invertModel = invertModel;
  25                 this.filtersViewModel = filtersViewModel;
  26                 this.itemModel = itemModel;
  27                 this.selected = false;
  28
  29                 mw.rcfilters.ui.TagItemWidget.parent.call( this, $.extend( {
  30                         data: this.itemModel.getName()
  31                 }, config ) );
  32
  33                 this.$overlay = config.$overlay || this.$element;
  34                 this.popupLabel = new OO.ui.LabelWidget();
  35
  36                 // Mixin constructors
  37                 OO.ui.mixin.PopupElement.call( this, $.extend( {
  38                         popup: {
  39                                 padded: false,
  40                                 align: 'center',
  41                                 position: 'above',
  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' ]
  47                         }
  48                 }, config ) );
  49
  50                 this.popupTimeoutShow = null;
  51                 this.popupTimeoutHide = null;
  52
  53                 this.$highlight = $( '<div>' )
  54                         .addClass( 'mw-rcfilters-ui-tagItemWidget-highlight' );
  55
  56                 // Add title attribute with the item label to 'x' button
  57                 this.closeButton.setTitle( mw.msg( 'rcfilters-tag-remove', this.itemModel.getLabel() ) );
  58
  59                 // Events
  60                 this.filtersViewModel.connect( this, { highlightChange: 'updateUiBasedOnState' } );
  61                 this.invertModel.connect( this, { update: 'updateUiBasedOnState' } );
  62                 this.itemModel.connect( this, { update: 'updateUiBasedOnState' } );
  63
  64                 // Initialization
  65                 this.$overlay.append( this.popup.$element );
  66                 this.$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 ) );
  72
  73                 this.updateUiBasedOnState();
  74         };
  75
  76         /* Initialization */
  77
  78         OO.inheritClass( mw.rcfilters.ui.TagItemWidget, OO.ui.TagItemWidget );
  79         OO.mixinClass( mw.rcfilters.ui.TagItemWidget, OO.ui.mixin.PopupElement );
  80
  81         /* Methods */
  82
  83         /**
  84          * Respond to model update event
  85          */
  86         mw.rcfilters.ui.TagItemWidget.prototype.updateUiBasedOnState = function () {
  87                 this.setCurrentMuteState();
  88
  89                 // Update label if needed
  90                 this.setLabel( $( '<div>' ).html( this.itemModel.getPrefixedLabel( this.invertModel.isSelected() ) ).contents() );
  91
  92                 this.setHighlightColor();
  93         };
  94
  95         /**
  96          * Set the current highlight color for this item
  97          */
  98         mw.rcfilters.ui.TagItemWidget.prototype.setHighlightColor = function () {
  99                 var selectedColor = this.filtersViewModel.isHighlightEnabled() && this.itemModel.isHighlighted ?
 100                         this.itemModel.getHighlightColor() :
 101                         null;
 102
 103                 this.$highlight
 104                         .attr( 'data-color', selectedColor )
 105                         .toggleClass(
 106                                 'mw-rcfilters-ui-tagItemWidget-highlight-highlighted',
 107                                 !!selectedColor
 108                         );
 109         };
 110
 111         /**
 112          * Set the current mute state for this item
 113          */
 114         mw.rcfilters.ui.TagItemWidget.prototype.setCurrentMuteState = function () {};
 115
 116         /**
 117          * Respond to mouse enter event
 118          */
 119         mw.rcfilters.ui.TagItemWidget.prototype.onMouseEnter = function () {
 120                 var labelText = this.itemModel.getStateMessage();
 121
 122                 if ( labelText ) {
 123                         this.popupLabel.setLabel( labelText );
 124
 125                         // Set timeout for the popup to show
 126                         this.popupTimeoutShow = setTimeout( function () {
 127                                 this.popup.toggle( true );
 128                         }.bind( this ), 500 );
 129
 130                         // Cancel the hide timeout
 131                         clearTimeout( this.popupTimeoutHide );
 132                         this.popupTimeoutHide = null;
 133                 }
 134         };
 135
 136         /**
 137          * Respond to mouse leave event
 138          */
 139         mw.rcfilters.ui.TagItemWidget.prototype.onMouseLeave = function () {
 140                 this.popupTimeoutHide = setTimeout( function () {
 141                         this.popup.toggle( false );
 142                 }.bind( this ), 250 );
 143
 144                 // Clear the show timeout
 145                 clearTimeout( this.popupTimeoutShow );
 146                 this.popupTimeoutShow = null;
 147         };
 148
 149         /**
 150          * Set selected state on this widget
 151          *
 152          * @param {boolean} [isSelected] Widget is selected
 153          */
 154         mw.rcfilters.ui.TagItemWidget.prototype.toggleSelected = function ( isSelected ) {
 155                 isSelected = isSelected !== undefined ? isSelected : !this.selected;
 156
 157                 if ( this.selected !== isSelected ) {
 158                         this.selected = isSelected;
 159
 160                         this.$element.toggleClass( 'mw-rcfilters-ui-tagItemWidget-selected', this.selected );
 161                 }
 162         };
 163
 164         /**
 165          * Get the selected state of this widget
 166          *
 167          * @return {boolean} Tag is selected
 168          */
 169         mw.rcfilters.ui.TagItemWidget.prototype.isSelected = function () {
 170                 return this.selected;
 171         };
 172
 173         /**
 174          * Get item name
 175          *
 176          * @return {string} Filter name
 177          */
 178         mw.rcfilters.ui.TagItemWidget.prototype.getName = function () {
 179                 return this.itemModel.getName();
 180         };
 181
 182         /**
 183          * Get item model
 184          *
 185          * @return {string} Filter model
 186          */
 187         mw.rcfilters.ui.TagItemWidget.prototype.getModel = function () {
 188                 return this.itemModel;
 189         };
 190
 191         /**
 192          * Get item view
 193          *
 194          * @return {string} Filter view
 195          */
 196         mw.rcfilters.ui.TagItemWidget.prototype.getView = function () {
 197                 return this.itemModel.getGroupModel().getView();
 198         };
 199
 200         /**
 201          * Remove and destroy external elements of this widget
 202          */
 203         mw.rcfilters.ui.TagItemWidget.prototype.destroy = function () {
 204                 // Destroy the popup
 205                 this.popup.$element.detach();
 206
 207                 // Disconnect events
 208                 this.itemModel.disconnect( this );
 209                 this.closeButton.disconnect( this );
 210         };
 211 }( mediaWiki, jQuery ) );