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                 // Update label if needed
  88                 var labelMsg = this.itemModel.getLabelMessageKey( this.invertModel.isSelected() );
  89                 if ( labelMsg ) {
  90                         this.setLabel( $( '<div>' ).html(
  91                                 mw.message( labelMsg, mw.html.escape( this.itemModel.getLabel() ) ).parse()
  92                         ).contents() );
  93                 } else {
  94                         this.setLabel( this.itemModel.getLabel() );
  95                 }
  96
  97                 this.setCurrentMuteState();
  98                 this.setHighlightColor();
  99         };
 100
 101         /**
 102          * Set the current highlight color for this item
 103          */
 104         mw.rcfilters.ui.TagItemWidget.prototype.setHighlightColor = function () {
 105                 var selectedColor = this.filtersViewModel.isHighlightEnabled() && this.itemModel.isHighlighted ?
 106                         this.itemModel.getHighlightColor() :
 107                         null;
 108
 109                 this.$highlight
 110                         .attr( 'data-color', selectedColor )
 111                         .toggleClass(
 112                                 'mw-rcfilters-ui-tagItemWidget-highlight-highlighted',
 113                                 !!selectedColor
 114                         );
 115         };
 116
 117         /**
 118          * Set the current mute state for this item
 119          */
 120         mw.rcfilters.ui.TagItemWidget.prototype.setCurrentMuteState = function () {};
 121
 122         /**
 123          * Respond to mouse enter event
 124          */
 125         mw.rcfilters.ui.TagItemWidget.prototype.onMouseEnter = function () {
 126                 var labelText = this.itemModel.getStateMessage();
 127
 128                 if ( labelText ) {
 129                         this.popupLabel.setLabel( labelText );
 130
 131                         // Set timeout for the popup to show
 132                         this.popupTimeoutShow = setTimeout( function () {
 133                                 this.popup.toggle( true );
 134                         }.bind( this ), 500 );
 135
 136                         // Cancel the hide timeout
 137                         clearTimeout( this.popupTimeoutHide );
 138                         this.popupTimeoutHide = null;
 139                 }
 140         };
 141
 142         /**
 143          * Respond to mouse leave event
 144          */
 145         mw.rcfilters.ui.TagItemWidget.prototype.onMouseLeave = function () {
 146                 this.popupTimeoutHide = setTimeout( function () {
 147                         this.popup.toggle( false );
 148                 }.bind( this ), 250 );
 149
 150                 // Clear the show timeout
 151                 clearTimeout( this.popupTimeoutShow );
 152                 this.popupTimeoutShow = null;
 153         };
 154
 155         /**
 156          * Set selected state on this widget
 157          *
 158          * @param {boolean} [isSelected] Widget is selected
 159          */
 160         mw.rcfilters.ui.TagItemWidget.prototype.toggleSelected = function ( isSelected ) {
 161                 isSelected = isSelected !== undefined ? isSelected : !this.selected;
 162
 163                 if ( this.selected !== isSelected ) {
 164                         this.selected = isSelected;
 165
 166                         this.$element.toggleClass( 'mw-rcfilters-ui-tagItemWidget-selected', this.selected );
 167                 }
 168         };
 169
 170         /**
 171          * Get the selected state of this widget
 172          *
 173          * @return {boolean} Tag is selected
 174          */
 175         mw.rcfilters.ui.TagItemWidget.prototype.isSelected = function () {
 176                 return this.selected;
 177         };
 178
 179         /**
 180          * Get item name
 181          *
 182          * @return {string} Filter name
 183          */
 184         mw.rcfilters.ui.TagItemWidget.prototype.getName = function () {
 185                 return this.itemModel.getName();
 186         };
 187
 188         /**
 189          * Get item model
 190          *
 191          * @return {string} Filter model
 192          */
 193         mw.rcfilters.ui.TagItemWidget.prototype.getModel = function () {
 194                 return this.itemModel;
 195         };
 196
 197         /**
 198          * Get item view
 199          *
 200          * @return {string} Filter view
 201          */
 202         mw.rcfilters.ui.TagItemWidget.prototype.getView = function () {
 203                 return this.itemModel.getGroupModel().getView();
 204         };
 205
 206         /**
 207          * Remove and destroy external elements of this widget
 208          */
 209         mw.rcfilters.ui.TagItemWidget.prototype.destroy = function () {
 210                 // Destroy the popup
 211                 this.popup.$element.detach();
 212
 213                 // Disconnect events
 214                 this.itemModel.disconnect( this );
 215                 this.closeButton.disconnect( this );
 216         };
 217 }( mediaWiki, jQuery ) );