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

   1 ( function ( mw, $ ) {
   2         /**
   3          * Menu header for the RCFilters filters menu
   4          *
   5          * @class
   6          * @extends OO.ui.Widget
   7          *
   8          * @constructor
   9          * @param {mw.rcfilters.Controller} controller Controller
  10          * @param {mw.rcfilters.dm.FiltersViewModel} model View model
  11          * @param {Object} config Configuration object
  12          * @cfg {jQuery} [$overlay] A jQuery object serving as overlay for popups
  13          */
  14         mw.rcfilters.ui.FilterMenuHeaderWidget = function MwRcfiltersUiFilterMenuHeaderWidget( controller, model, config ) {
  15                 config = config || {};
  16
  17                 this.controller = controller;
  18                 this.model = model;
  19                 this.$overlay = config.$overlay || this.$element;
  20
  21                 // Parent
  22                 mw.rcfilters.ui.FilterMenuHeaderWidget.parent.call( this, config );
  23                 OO.ui.mixin.LabelElement.call( this, $.extend( {
  24                         label: mw.msg( 'rcfilters-filterlist-title' ),
  25                         $label: $( '<div>' )
  26                                 .addClass( 'mw-rcfilters-ui-filterMenuHeaderWidget-title' )
  27                 }, config ) );
  28
  29                 // "Back" to default view button
  30                 this.backButton = new OO.ui.ButtonWidget( {
  31                         icon: 'previous',
  32                         framed: false,
  33                         title: mw.msg( 'rcfilters-view-return-to-default-tooltip' ),
  34                         classes: [ 'mw-rcfilters-ui-filterMenuHeaderWidget-backButton' ]
  35                 } );
  36                 this.backButton.toggle( this.model.getCurrentView() !== 'default' );
  37
  38                 // Help icon for Tagged edits
  39                 this.helpIcon = new OO.ui.ButtonWidget( {
  40                         icon: 'help',
  41                         framed: false,
  42                         title: mw.msg( 'rcfilters-view-tags-help-icon-tooltip' ),
  43                         classes: [ 'mw-rcfilters-ui-filterMenuHeaderWidget-helpIcon' ],
  44                         href: mw.util.getUrl( 'Special:Tags' ),
  45                         target: '_blank'
  46                 } );
  47                 this.helpIcon.toggle( this.model.getCurrentView() === 'tags' );
  48
  49                 // Highlight button
  50                 this.highlightButton = new OO.ui.ToggleButtonWidget( {
  51                         icon: 'highlight',
  52                         label: mw.message( 'rcfilters-highlightbutton-title' ).text(),
  53                         classes: [ 'mw-rcfilters-ui-filterMenuHeaderWidget-hightlightButton' ]
  54                 } );
  55
  56                 // Invert namespaces button
  57                 this.invertNamespacesButton = new OO.ui.ToggleButtonWidget( {
  58                         icon: '',
  59                         classes: [ 'mw-rcfilters-ui-filterMenuHeaderWidget-invertNamespacesButton' ]
  60                 } );
  61                 this.invertNamespacesButton.toggle( this.model.getCurrentView() === 'namespaces' );
  62
  63                 // Events
  64                 this.backButton.connect( this, { click: 'onBackButtonClick' } );
  65                 this.highlightButton
  66                         .connect( this, { click: 'onHighlightButtonClick' } );
  67                 this.invertNamespacesButton
  68                         .connect( this, { click: 'onInvertNamespacesButtonClick' } );
  69                 this.model.connect( this, {
  70                         highlightChange: 'onModelHighlightChange',
  71                         update: 'onModelUpdate',
  72                         initialize: 'onModelInitialize'
  73                 } );
  74
  75                 // Initialize
  76                 this.$element
  77                         .addClass( 'mw-rcfilters-ui-filterMenuHeaderWidget' )
  78                         .append(
  79                                 $( '<div>' )
  80                                         .addClass( 'mw-rcfilters-ui-table' )
  81                                         .addClass( 'mw-rcfilters-ui-filterMenuHeaderWidget-header' )
  82                                         .append(
  83                                                 $( '<div>' )
  84                                                         .addClass( 'mw-rcfilters-ui-row' )
  85                                                         .append(
  86                                                                 $( '<div>' )
  87                                                                         .addClass( 'mw-rcfilters-ui-cell' )
  88                                                                         .addClass( 'mw-rcfilters-ui-filterMenuHeaderWidget-header-back' )
  89                                                                         .append( this.backButton.$element ),
  90                                                                 $( '<div>' )
  91                                                                         .addClass( 'mw-rcfilters-ui-cell' )
  92                                                                         .addClass( 'mw-rcfilters-ui-filterMenuHeaderWidget-header-title' )
  93                                                                         .append( this.$label, this.helpIcon.$element ),
  94                                                                 $( '<div>' )
  95                                                                         .addClass( 'mw-rcfilters-ui-cell' )
  96                                                                         .addClass( 'mw-rcfilters-ui-filterMenuHeaderWidget-header-invert' )
  97                                                                         .append( this.invertNamespacesButton.$element ),
  98                                                                 $( '<div>' )
  99                                                                         .addClass( 'mw-rcfilters-ui-cell' )
 100                                                                         .addClass( 'mw-rcfilters-ui-filterMenuHeaderWidget-header-highlight' )
 101                                                                         .append( this.highlightButton.$element )
 102                                                         )
 103                                         )
 104                         );
 105         };
 106
 107         /* Initialization */
 108
 109         OO.inheritClass( mw.rcfilters.ui.FilterMenuHeaderWidget, OO.ui.Widget );
 110         OO.mixinClass( mw.rcfilters.ui.FilterMenuHeaderWidget, OO.ui.mixin.LabelElement );
 111
 112         /* Methods */
 113
 114         /**
 115          * Respond to model initialization event
 116          *
 117          * Note: need to wait for initialization before getting the invertModel
 118          * and registering its update event. Creating all the models before the UI
 119          * would help with that.
 120          */
 121         mw.rcfilters.ui.FilterMenuHeaderWidget.prototype.onModelInitialize = function () {
 122                 this.invertModel = this.model.getInvertModel();
 123                 this.updateInvertButton();
 124                 this.invertModel.connect( this, { update: 'updateInvertButton' } );
 125         };
 126
 127         /**
 128          * Respond to model update event
 129          */
 130         mw.rcfilters.ui.FilterMenuHeaderWidget.prototype.onModelUpdate = function () {
 131                 var currentView = this.model.getCurrentView();
 132
 133                 this.setLabel( this.model.getViewTitle( currentView ) );
 134
 135                 this.invertNamespacesButton.toggle( currentView === 'namespaces' );
 136                 this.backButton.toggle( currentView !== 'default' );
 137                 this.helpIcon.toggle( currentView === 'tags' );
 138         };
 139
 140         /**
 141          * Respond to model highlight change event
 142          *
 143          * @param {boolean} highlightEnabled Highlight is enabled
 144          */
 145         mw.rcfilters.ui.FilterMenuHeaderWidget.prototype.onModelHighlightChange = function ( highlightEnabled ) {
 146                 this.highlightButton.setActive( highlightEnabled );
 147         };
 148
 149         /**
 150          * Update the state of the invert button
 151          */
 152         mw.rcfilters.ui.FilterMenuHeaderWidget.prototype.updateInvertButton = function () {
 153                 this.invertNamespacesButton.setActive( this.invertModel.isSelected() );
 154                 this.invertNamespacesButton.setLabel(
 155                         this.invertModel.isSelected() ?
 156                                 mw.msg( 'rcfilters-exclude-button-on' ) :
 157                                 mw.msg( 'rcfilters-exclude-button-off' )
 158                 );
 159         };
 160
 161         mw.rcfilters.ui.FilterMenuHeaderWidget.prototype.onBackButtonClick = function () {
 162                 this.controller.switchView( 'default' );
 163         };
 164
 165         /**
 166          * Respond to highlight button click
 167          */
 168         mw.rcfilters.ui.FilterMenuHeaderWidget.prototype.onHighlightButtonClick = function () {
 169                 this.controller.toggleHighlight();
 170         };
 171
 172         /**
 173          * Respond to highlight button click
 174          */
 175         mw.rcfilters.ui.FilterMenuHeaderWidget.prototype.onInvertNamespacesButtonClick = function () {
 176                 this.controller.toggleInvertedNamespaces();
 177         };
 178 }( mediaWiki, jQuery ) );