resources/lib/oojs-ui/oojs-ui-toolbars.js

   1 /*!
   2  * OOjs UI v0.15.2
   3  * https://www.mediawiki.org/wiki/OOjs_UI
   4  *
   5  * Copyright 2011–2016 OOjs UI Team and other contributors.
   6  * Released under the MIT license
   7  * http://oojs.mit-license.org
   8  *
   9  * Date: 2016-02-02T22:07:00Z
  10  */
  11 ( function ( OO ) {
  12
  13 'use strict';
  14
  15 /**
  16  * Toolbars are complex interface components that permit users to easily access a variety
  17  * of {@link OO.ui.Tool tools} (e.g., formatting commands) and actions, which are additional commands that are
  18  * part of the toolbar, but not configured as tools.
  19  *
  20  * Individual tools are customized and then registered with a {@link OO.ui.ToolFactory tool factory}, which creates
  21  * the tools on demand. Each tool has a symbolic name (used when registering the tool), a title (e.g., ‘Insert
  22  * image’), and an icon.
  23  *
  24  * Individual tools are organized in {@link OO.ui.ToolGroup toolgroups}, which can be {@link OO.ui.MenuToolGroup menus}
  25  * of tools, {@link OO.ui.ListToolGroup lists} of tools, or a single {@link OO.ui.BarToolGroup bar} of tools.
  26  * The arrangement and order of the toolgroups is customized when the toolbar is set up. Tools can be presented in
  27  * any order, but each can only appear once in the toolbar.
  28  *
  29  * The toolbar can be synchronized with the state of the external "application", like a text
  30  * editor's editing area, marking tools as active/inactive (e.g. a 'bold' tool would be shown as
  31  * active when the text cursor was inside bolded text) or enabled/disabled (e.g. a table caption
  32  * tool would be disabled while the user is not editing a table). A state change is signalled by
  33  * emitting the {@link #event-updateState 'updateState' event}, which calls Tools'
  34  * {@link OO.ui.Tool#onUpdateState onUpdateState method}.
  35  *
  36  * The following is an example of a basic toolbar.
  37  *
  38  *     @example
  39  *     // Example of a toolbar
  40  *     // Create the toolbar
  41  *     var toolFactory = new OO.ui.ToolFactory();
  42  *     var toolGroupFactory = new OO.ui.ToolGroupFactory();
  43  *     var toolbar = new OO.ui.Toolbar( toolFactory, toolGroupFactory );
  44  *
  45  *     // We will be placing status text in this element when tools are used
  46  *     var $area = $( '<p>' ).text( 'Toolbar example' );
  47  *
  48  *     // Define the tools that we're going to place in our toolbar
  49  *
  50  *     // Create a class inheriting from OO.ui.Tool
  51  *     function SearchTool() {
  52  *         SearchTool.parent.apply( this, arguments );
  53  *     }
  54  *     OO.inheritClass( SearchTool, OO.ui.Tool );
  55  *     // Each tool must have a 'name' (used as an internal identifier, see later) and at least one
  56  *     // of 'icon' and 'title' (displayed icon and text).
  57  *     SearchTool.static.name = 'search';
  58  *     SearchTool.static.icon = 'search';
  59  *     SearchTool.static.title = 'Search...';
  60  *     // Defines the action that will happen when this tool is selected (clicked).
  61  *     SearchTool.prototype.onSelect = function () {
  62  *         $area.text( 'Search tool clicked!' );
  63  *         // Never display this tool as "active" (selected).
  64  *         this.setActive( false );
  65  *     };
  66  *     SearchTool.prototype.onUpdateState = function () {};
  67  *     // Make this tool available in our toolFactory and thus our toolbar
  68  *     toolFactory.register( SearchTool );
  69  *
  70  *     // Register two more tools, nothing interesting here
  71  *     function SettingsTool() {
  72  *         SettingsTool.parent.apply( this, arguments );
  73  *     }
  74  *     OO.inheritClass( SettingsTool, OO.ui.Tool );
  75  *     SettingsTool.static.name = 'settings';
  76  *     SettingsTool.static.icon = 'settings';
  77  *     SettingsTool.static.title = 'Change settings';
  78  *     SettingsTool.prototype.onSelect = function () {
  79  *         $area.text( 'Settings tool clicked!' );
  80  *         this.setActive( false );
  81  *     };
  82  *     SettingsTool.prototype.onUpdateState = function () {};
  83  *     toolFactory.register( SettingsTool );
  84  *
  85  *     // Register two more tools, nothing interesting here
  86  *     function StuffTool() {
  87  *         StuffTool.parent.apply( this, arguments );
  88  *     }
  89  *     OO.inheritClass( StuffTool, OO.ui.Tool );
  90  *     StuffTool.static.name = 'stuff';
  91  *     StuffTool.static.icon = 'ellipsis';
  92  *     StuffTool.static.title = 'More stuff';
  93  *     StuffTool.prototype.onSelect = function () {
  94  *         $area.text( 'More stuff tool clicked!' );
  95  *         this.setActive( false );
  96  *     };
  97  *     StuffTool.prototype.onUpdateState = function () {};
  98  *     toolFactory.register( StuffTool );
  99  *
 100  *     // This is a PopupTool. Rather than having a custom 'onSelect' action, it will display a
 101  *     // little popup window (a PopupWidget).
 102  *     function HelpTool( toolGroup, config ) {
 103  *         OO.ui.PopupTool.call( this, toolGroup, $.extend( { popup: {
 104  *             padded: true,
 105  *             label: 'Help',
 106  *             head: true
 107  *         } }, config ) );
 108  *         this.popup.$body.append( '<p>I am helpful!</p>' );
 109  *     }
 110  *     OO.inheritClass( HelpTool, OO.ui.PopupTool );
 111  *     HelpTool.static.name = 'help';
 112  *     HelpTool.static.icon = 'help';
 113  *     HelpTool.static.title = 'Help';
 114  *     toolFactory.register( HelpTool );
 115  *
 116  *     // Finally define which tools and in what order appear in the toolbar. Each tool may only be
 117  *     // used once (but not all defined tools must be used).
 118  *     toolbar.setup( [
 119  *         {
 120  *             // 'bar' tool groups display tools' icons only, side-by-side.
 121  *             type: 'bar',
 122  *             include: [ 'search', 'help' ]
 123  *         },
 124  *         {
 125  *             // 'list' tool groups display both the titles and icons, in a dropdown list.
 126  *             type: 'list',
 127  *             indicator: 'down',
 128  *             label: 'More',
 129  *             include: [ 'settings', 'stuff' ]
 130  *         }
 131  *         // Note how the tools themselves are toolgroup-agnostic - the same tool can be displayed
 132  *         // either in a 'list' or a 'bar'. There is a 'menu' tool group too, not showcased here,
 133  *         // since it's more complicated to use. (See the next example snippet on this page.)
 134  *     ] );
 135  *
 136  *     // Create some UI around the toolbar and place it in the document
 137  *     var frame = new OO.ui.PanelLayout( {
 138  *         expanded: false,
 139  *         framed: true
 140  *     } );
 141  *     var contentFrame = new OO.ui.PanelLayout( {
 142  *         expanded: false,
 143  *         padded: true
 144  *     } );
 145  *     frame.$element.append(
 146  *         toolbar.$element,
 147  *         contentFrame.$element.append( $area )
 148  *     );
 149  *     $( 'body' ).append( frame.$element );
 150  *
 151  *     // Here is where the toolbar is actually built. This must be done after inserting it into the
 152  *     // document.
 153  *     toolbar.initialize();
 154  *     toolbar.emit( 'updateState' );
 155  *
 156  * The following example extends the previous one to illustrate 'menu' toolgroups and the usage of
 157  * {@link #event-updateState 'updateState' event}.
 158  *
 159  *     @example
 160  *     // Create the toolbar
 161  *     var toolFactory = new OO.ui.ToolFactory();
 162  *     var toolGroupFactory = new OO.ui.ToolGroupFactory();
 163  *     var toolbar = new OO.ui.Toolbar( toolFactory, toolGroupFactory );
 164  *
 165  *     // We will be placing status text in this element when tools are used
 166  *     var $area = $( '<p>' ).text( 'Toolbar example' );
 167  *
 168  *     // Define the tools that we're going to place in our toolbar
 169  *
 170  *     // Create a class inheriting from OO.ui.Tool
 171  *     function SearchTool() {
 172  *         SearchTool.parent.apply( this, arguments );
 173  *     }
 174  *     OO.inheritClass( SearchTool, OO.ui.Tool );
 175  *     // Each tool must have a 'name' (used as an internal identifier, see later) and at least one
 176  *     // of 'icon' and 'title' (displayed icon and text).
 177  *     SearchTool.static.name = 'search';
 178  *     SearchTool.static.icon = 'search';
 179  *     SearchTool.static.title = 'Search...';
 180  *     // Defines the action that will happen when this tool is selected (clicked).
 181  *     SearchTool.prototype.onSelect = function () {
 182  *         $area.text( 'Search tool clicked!' );
 183  *         // Never display this tool as "active" (selected).
 184  *         this.setActive( false );
 185  *     };
 186  *     SearchTool.prototype.onUpdateState = function () {};
 187  *     // Make this tool available in our toolFactory and thus our toolbar
 188  *     toolFactory.register( SearchTool );
 189  *
 190  *     // Register two more tools, nothing interesting here
 191  *     function SettingsTool() {
 192  *         SettingsTool.parent.apply( this, arguments );
 193  *         this.reallyActive = false;
 194  *     }
 195  *     OO.inheritClass( SettingsTool, OO.ui.Tool );
 196  *     SettingsTool.static.name = 'settings';
 197  *     SettingsTool.static.icon = 'settings';
 198  *     SettingsTool.static.title = 'Change settings';
 199  *     SettingsTool.prototype.onSelect = function () {
 200  *         $area.text( 'Settings tool clicked!' );
 201  *         // Toggle the active state on each click
 202  *         this.reallyActive = !this.reallyActive;
 203  *         this.setActive( this.reallyActive );
 204  *         // To update the menu label
 205  *         this.toolbar.emit( 'updateState' );
 206  *     };
 207  *     SettingsTool.prototype.onUpdateState = function () {};
 208  *     toolFactory.register( SettingsTool );
 209  *
 210  *     // Register two more tools, nothing interesting here
 211  *     function StuffTool() {
 212  *         StuffTool.parent.apply( this, arguments );
 213  *         this.reallyActive = false;
 214  *     }
 215  *     OO.inheritClass( StuffTool, OO.ui.Tool );
 216  *     StuffTool.static.name = 'stuff';
 217  *     StuffTool.static.icon = 'ellipsis';
 218  *     StuffTool.static.title = 'More stuff';
 219  *     StuffTool.prototype.onSelect = function () {
 220  *         $area.text( 'More stuff tool clicked!' );
 221  *         // Toggle the active state on each click
 222  *         this.reallyActive = !this.reallyActive;
 223  *         this.setActive( this.reallyActive );
 224  *         // To update the menu label
 225  *         this.toolbar.emit( 'updateState' );
 226  *     };
 227  *     StuffTool.prototype.onUpdateState = function () {};
 228  *     toolFactory.register( StuffTool );
 229  *
 230  *     // This is a PopupTool. Rather than having a custom 'onSelect' action, it will display a
 231  *     // little popup window (a PopupWidget). 'onUpdateState' is also already implemented.
 232  *     function HelpTool( toolGroup, config ) {
 233  *         OO.ui.PopupTool.call( this, toolGroup, $.extend( { popup: {
 234  *             padded: true,
 235  *             label: 'Help',
 236  *             head: true
 237  *         } }, config ) );
 238  *         this.popup.$body.append( '<p>I am helpful!</p>' );
 239  *     }
 240  *     OO.inheritClass( HelpTool, OO.ui.PopupTool );
 241  *     HelpTool.static.name = 'help';
 242  *     HelpTool.static.icon = 'help';
 243  *     HelpTool.static.title = 'Help';
 244  *     toolFactory.register( HelpTool );
 245  *
 246  *     // Finally define which tools and in what order appear in the toolbar. Each tool may only be
 247  *     // used once (but not all defined tools must be used).
 248  *     toolbar.setup( [
 249  *         {
 250  *             // 'bar' tool groups display tools' icons only, side-by-side.
 251  *             type: 'bar',
 252  *             include: [ 'search', 'help' ]
 253  *         },
 254  *         {
 255  *             // 'menu' tool groups display both the titles and icons, in a dropdown menu.
 256  *             // Menu label indicates which items are selected.
 257  *             type: 'menu',
 258  *             indicator: 'down',
 259  *             include: [ 'settings', 'stuff' ]
 260  *         }
 261  *     ] );
 262  *
 263  *     // Create some UI around the toolbar and place it in the document
 264  *     var frame = new OO.ui.PanelLayout( {
 265  *         expanded: false,
 266  *         framed: true
 267  *     } );
 268  *     var contentFrame = new OO.ui.PanelLayout( {
 269  *         expanded: false,
 270  *         padded: true
 271  *     } );
 272  *     frame.$element.append(
 273  *         toolbar.$element,
 274  *         contentFrame.$element.append( $area )
 275  *     );
 276  *     $( 'body' ).append( frame.$element );
 277  *
 278  *     // Here is where the toolbar is actually built. This must be done after inserting it into the
 279  *     // document.
 280  *     toolbar.initialize();
 281  *     toolbar.emit( 'updateState' );
 282  *
 283  * @class
 284  * @extends OO.ui.Element
 285  * @mixins OO.EventEmitter
 286  * @mixins OO.ui.mixin.GroupElement
 287  *
 288  * @constructor
 289  * @param {OO.ui.ToolFactory} toolFactory Factory for creating tools
 290  * @param {OO.ui.ToolGroupFactory} toolGroupFactory Factory for creating toolgroups
 291  * @param {Object} [config] Configuration options
 292  * @cfg {boolean} [actions] Add an actions section to the toolbar. Actions are commands that are included
 293  *  in the toolbar, but are not configured as tools. By default, actions are displayed on the right side of
 294  *  the toolbar.
 295  * @cfg {boolean} [shadow] Add a shadow below the toolbar.
 296  */
 297 OO.ui.Toolbar = function OoUiToolbar( toolFactory, toolGroupFactory, config ) {
 298         // Allow passing positional parameters inside the config object
 299         if ( OO.isPlainObject( toolFactory ) && config === undefined ) {
 300                 config = toolFactory;
 301                 toolFactory = config.toolFactory;
 302                 toolGroupFactory = config.toolGroupFactory;
 303         }
 304
 305         // Configuration initialization
 306         config = config || {};
 307
 308         // Parent constructor
 309         OO.ui.Toolbar.parent.call( this, config );
 310
 311         // Mixin constructors
 312         OO.EventEmitter.call( this );
 313         OO.ui.mixin.GroupElement.call( this, config );
 314
 315         // Properties
 316         this.toolFactory = toolFactory;
 317         this.toolGroupFactory = toolGroupFactory;
 318         this.groups = [];
 319         this.tools = {};
 320         this.$bar = $( '<div>' );
 321         this.$actions = $( '<div>' );
 322         this.initialized = false;
 323         this.onWindowResizeHandler = this.onWindowResize.bind( this );
 324
 325         // Events
 326         this.$element
 327                 .add( this.$bar ).add( this.$group ).add( this.$actions )
 328                 .on( 'mousedown keydown', this.onPointerDown.bind( this ) );
 329
 330         // Initialization
 331         this.$group.addClass( 'oo-ui-toolbar-tools' );
 332         if ( config.actions ) {
 333                 this.$bar.append( this.$actions.addClass( 'oo-ui-toolbar-actions' ) );
 334         }
 335         this.$bar
 336                 .addClass( 'oo-ui-toolbar-bar' )
 337                 .append( this.$group, '<div style="clear:both"></div>' );
 338         if ( config.shadow ) {
 339                 this.$bar.append( '<div class="oo-ui-toolbar-shadow"></div>' );
 340         }
 341         this.$element.addClass( 'oo-ui-toolbar' ).append( this.$bar );
 342 };
 343
 344 /* Setup */
 345
 346 OO.inheritClass( OO.ui.Toolbar, OO.ui.Element );
 347 OO.mixinClass( OO.ui.Toolbar, OO.EventEmitter );
 348 OO.mixinClass( OO.ui.Toolbar, OO.ui.mixin.GroupElement );
 349
 350 /* Events */
 351
 352 /**
 353  * @event updateState
 354  *
 355  * An 'updateState' event must be emitted on the Toolbar (by calling `toolbar.emit( 'updateState' )`)
 356  * every time the state of the application using the toolbar changes, and an update to the state of
 357  * tools is required.
 358  *
 359  * @param {Mixed...} data Application-defined parameters
 360  */
 361
 362 /* Methods */
 363
 364 /**
 365  * Get the tool factory.
 366  *
 367  * @return {OO.ui.ToolFactory} Tool factory
 368  */
 369 OO.ui.Toolbar.prototype.getToolFactory = function () {
 370         return this.toolFactory;
 371 };
 372
 373 /**
 374  * Get the toolgroup factory.
 375  *
 376  * @return {OO.Factory} Toolgroup factory
 377  */
 378 OO.ui.Toolbar.prototype.getToolGroupFactory = function () {
 379         return this.toolGroupFactory;
 380 };
 381
 382 /**
 383  * Handles mouse down events.
 384  *
 385  * @private
 386  * @param {jQuery.Event} e Mouse down event
 387  */
 388 OO.ui.Toolbar.prototype.onPointerDown = function ( e ) {
 389         var $closestWidgetToEvent = $( e.target ).closest( '.oo-ui-widget' ),
 390                 $closestWidgetToToolbar = this.$element.closest( '.oo-ui-widget' );
 391         if ( !$closestWidgetToEvent.length || $closestWidgetToEvent[ 0 ] === $closestWidgetToToolbar[ 0 ] ) {
 392                 return false;
 393         }
 394 };
 395
 396 /**
 397  * Handle window resize event.
 398  *
 399  * @private
 400  * @param {jQuery.Event} e Window resize event
 401  */
 402 OO.ui.Toolbar.prototype.onWindowResize = function () {
 403         this.$element.toggleClass(
 404                 'oo-ui-toolbar-narrow',
 405                 this.$bar.width() <= this.narrowThreshold
 406         );
 407 };
 408
 409 /**
 410  * Sets up handles and preloads required information for the toolbar to work.
 411  * This must be called after it is attached to a visible document and before doing anything else.
 412  */
 413 OO.ui.Toolbar.prototype.initialize = function () {
 414         if ( !this.initialized ) {
 415                 this.initialized = true;
 416                 this.narrowThreshold = this.$group.width() + this.$actions.width();
 417                 $( this.getElementWindow() ).on( 'resize', this.onWindowResizeHandler );
 418                 this.onWindowResize();
 419         }
 420 };
 421
 422 /**
 423  * Set up the toolbar.
 424  *
 425  * The toolbar is set up with a list of toolgroup configurations that specify the type of
 426  * toolgroup ({@link OO.ui.BarToolGroup bar}, {@link OO.ui.MenuToolGroup menu}, or {@link OO.ui.ListToolGroup list})
 427  * to add and which tools to include, exclude, promote, or demote within that toolgroup. Please
 428  * see {@link OO.ui.ToolGroup toolgroups} for more information about including tools in toolgroups.
 429  *
 430  * @param {Object.<string,Array>} groups List of toolgroup configurations
 431  * @param {Array|string} [groups.include] Tools to include in the toolgroup
 432  * @param {Array|string} [groups.exclude] Tools to exclude from the toolgroup
 433  * @param {Array|string} [groups.promote] Tools to promote to the beginning of the toolgroup
 434  * @param {Array|string} [groups.demote] Tools to demote to the end of the toolgroup
 435  */
 436 OO.ui.Toolbar.prototype.setup = function ( groups ) {
 437         var i, len, type, group,
 438                 items = [],
 439                 defaultType = 'bar';
 440
 441         // Cleanup previous groups
 442         this.reset();
 443
 444         // Build out new groups
 445         for ( i = 0, len = groups.length; i < len; i++ ) {
 446                 group = groups[ i ];
 447                 if ( group.include === '*' ) {
 448                         // Apply defaults to catch-all groups
 449                         if ( group.type === undefined ) {
 450                                 group.type = 'list';
 451                         }
 452                         if ( group.label === undefined ) {
 453                                 group.label = OO.ui.msg( 'ooui-toolbar-more' );
 454                         }
 455                 }
 456                 // Check type has been registered
 457                 type = this.getToolGroupFactory().lookup( group.type ) ? group.type : defaultType;
 458                 items.push(
 459                         this.getToolGroupFactory().create( type, this, group )
 460                 );
 461         }
 462         this.addItems( items );
 463 };
 464
 465 /**
 466  * Remove all tools and toolgroups from the toolbar.
 467  */
 468 OO.ui.Toolbar.prototype.reset = function () {
 469         var i, len;
 470
 471         this.groups = [];
 472         this.tools = {};
 473         for ( i = 0, len = this.items.length; i < len; i++ ) {
 474                 this.items[ i ].destroy();
 475         }
 476         this.clearItems();
 477 };
 478
 479 /**
 480  * Destroy the toolbar.
 481  *
 482  * Destroying the toolbar removes all event handlers and DOM elements that constitute the toolbar. Call
 483  * this method whenever you are done using a toolbar.
 484  */
 485 OO.ui.Toolbar.prototype.destroy = function () {
 486         $( this.getElementWindow() ).off( 'resize', this.onWindowResizeHandler );
 487         this.reset();
 488         this.$element.remove();
 489 };
 490
 491 /**
 492  * Check if the tool is available.
 493  *
 494  * Available tools are ones that have not yet been added to the toolbar.
 495  *
 496  * @param {string} name Symbolic name of tool
 497  * @return {boolean} Tool is available
 498  */
 499 OO.ui.Toolbar.prototype.isToolAvailable = function ( name ) {
 500         return !this.tools[ name ];
 501 };
 502
 503 /**
 504  * Prevent tool from being used again.
 505  *
 506  * @param {OO.ui.Tool} tool Tool to reserve
 507  */
 508 OO.ui.Toolbar.prototype.reserveTool = function ( tool ) {
 509         this.tools[ tool.getName() ] = tool;
 510 };
 511
 512 /**
 513  * Allow tool to be used again.
 514  *
 515  * @param {OO.ui.Tool} tool Tool to release
 516  */
 517 OO.ui.Toolbar.prototype.releaseTool = function ( tool ) {
 518         delete this.tools[ tool.getName() ];
 519 };
 520
 521 /**
 522  * Get accelerator label for tool.
 523  *
 524  * The OOjs UI library does not contain an accelerator system, but this is the hook for one. To
 525  * use an accelerator system, subclass the toolbar and override this method, which is meant to return a label
 526  * that describes the accelerator keys for the tool passed (by symbolic name) to the method.
 527  *
 528  * @param {string} name Symbolic name of tool
 529  * @return {string|undefined} Tool accelerator label if available
 530  */
 531 OO.ui.Toolbar.prototype.getToolAccelerator = function () {
 532         return undefined;
 533 };
 534
 535 /**
 536  * Tools, together with {@link OO.ui.ToolGroup toolgroups}, constitute {@link OO.ui.Toolbar toolbars}.
 537  * Each tool is configured with a static name, title, and icon and is customized with the command to carry
 538  * out when the tool is selected. Tools must also be registered with a {@link OO.ui.ToolFactory tool factory},
 539  * which creates the tools on demand.
 540  *
 541  * Every Tool subclass must implement two methods:
 542  *
 543  * - {@link #onUpdateState}
 544  * - {@link #onSelect}
 545  *
 546  * Tools are added to toolgroups ({@link OO.ui.ListToolGroup ListToolGroup},
 547  * {@link OO.ui.BarToolGroup BarToolGroup}, or {@link OO.ui.MenuToolGroup MenuToolGroup}), which determine how
 548  * the tool is displayed in the toolbar. See {@link OO.ui.Toolbar toolbars} for an example.
 549  *
 550  * For more information, please see the [OOjs UI documentation on MediaWiki][1].
 551  * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Toolbars
 552  *
 553  * @abstract
 554  * @class
 555  * @extends OO.ui.Widget
 556  * @mixins OO.ui.mixin.IconElement
 557  * @mixins OO.ui.mixin.FlaggedElement
 558  * @mixins OO.ui.mixin.TabIndexedElement
 559  *
 560  * @constructor
 561  * @param {OO.ui.ToolGroup} toolGroup
 562  * @param {Object} [config] Configuration options
 563  * @cfg {string|Function} [title] Title text or a function that returns text. If this config is omitted, the value of
 564  *  the {@link #static-title static title} property is used.
 565  *
 566  *  The title is used in different ways depending on the type of toolgroup that contains the tool. The
 567  *  title is used as a tooltip if the tool is part of a {@link OO.ui.BarToolGroup bar} toolgroup, or as the label text if the tool is
 568  *  part of a {@link OO.ui.ListToolGroup list} or {@link OO.ui.MenuToolGroup menu} toolgroup.
 569  *
 570  *  For bar toolgroups, a description of the accelerator key is appended to the title if an accelerator key
 571  *  is associated with an action by the same name as the tool and accelerator functionality has been added to the application.
 572  *  To add accelerator key functionality, you must subclass OO.ui.Toolbar and override the {@link OO.ui.Toolbar#getToolAccelerator getToolAccelerator} method.
 573  */
 574 OO.ui.Tool = function OoUiTool( toolGroup, config ) {
 575         // Allow passing positional parameters inside the config object
 576         if ( OO.isPlainObject( toolGroup ) && config === undefined ) {
 577                 config = toolGroup;
 578                 toolGroup = config.toolGroup;
 579         }
 580
 581         // Configuration initialization
 582         config = config || {};
 583
 584         // Parent constructor
 585         OO.ui.Tool.parent.call( this, config );
 586
 587         // Properties
 588         this.toolGroup = toolGroup;
 589         this.toolbar = this.toolGroup.getToolbar();
 590         this.active = false;
 591         this.$title = $( '<span>' );
 592         this.$accel = $( '<span>' );
 593         this.$link = $( '<a>' );
 594         this.title = null;
 595
 596         // Mixin constructors
 597         OO.ui.mixin.IconElement.call( this, config );
 598         OO.ui.mixin.FlaggedElement.call( this, config );
 599         OO.ui.mixin.TabIndexedElement.call( this, $.extend( {}, config, { $tabIndexed: this.$link } ) );
 600
 601         // Events
 602         this.toolbar.connect( this, { updateState: 'onUpdateState' } );
 603
 604         // Initialization
 605         this.$title.addClass( 'oo-ui-tool-title' );
 606         this.$accel
 607                 .addClass( 'oo-ui-tool-accel' )
 608                 .prop( {
 609                         // This may need to be changed if the key names are ever localized,
 610                         // but for now they are essentially written in English
 611                         dir: 'ltr',
 612                         lang: 'en'
 613                 } );
 614         this.$link
 615                 .addClass( 'oo-ui-tool-link' )
 616                 .append( this.$icon, this.$title, this.$accel )
 617                 .attr( 'role', 'button' );
 618         this.$element
 619                 .data( 'oo-ui-tool', this )
 620                 .addClass(
 621                         'oo-ui-tool ' + 'oo-ui-tool-name-' +
 622                         this.constructor.static.name.replace( /^([^\/]+)\/([^\/]+).*$/, '$1-$2' )
 623                 )
 624                 .toggleClass( 'oo-ui-tool-with-label', this.constructor.static.displayBothIconAndLabel )
 625                 .append( this.$link );
 626         this.setTitle( config.title || this.constructor.static.title );
 627 };
 628
 629 /* Setup */
 630
 631 OO.inheritClass( OO.ui.Tool, OO.ui.Widget );
 632 OO.mixinClass( OO.ui.Tool, OO.ui.mixin.IconElement );
 633 OO.mixinClass( OO.ui.Tool, OO.ui.mixin.FlaggedElement );
 634 OO.mixinClass( OO.ui.Tool, OO.ui.mixin.TabIndexedElement );
 635
 636 /* Static Properties */
 637
 638 /**
 639  * @static
 640  * @inheritdoc
 641  */
 642 OO.ui.Tool.static.tagName = 'span';
 643
 644 /**
 645  * Symbolic name of tool.
 646  *
 647  * The symbolic name is used internally to register the tool with a {@link OO.ui.ToolFactory ToolFactory}. It can
 648  * also be used when adding tools to toolgroups.
 649  *
 650  * @abstract
 651  * @static
 652  * @inheritable
 653  * @property {string}
 654  */
 655 OO.ui.Tool.static.name = '';
 656
 657 /**
 658  * Symbolic name of the group.
 659  *
 660  * The group name is used to associate tools with each other so that they can be selected later by
 661  * a {@link OO.ui.ToolGroup toolgroup}.
 662  *
 663  * @abstract
 664  * @static
 665  * @inheritable
 666  * @property {string}
 667  */
 668 OO.ui.Tool.static.group = '';
 669
 670 /**
 671  * Tool title text or a function that returns title text. The value of the static property is overridden if the #title config option is used.
 672  *
 673  * @abstract
 674  * @static
 675  * @inheritable
 676  * @property {string|Function}
 677  */
 678 OO.ui.Tool.static.title = '';
 679
 680 /**
 681  * Display both icon and label when the tool is used in a {@link OO.ui.BarToolGroup bar} toolgroup.
 682  * Normally only the icon is displayed, or only the label if no icon is given.
 683  *
 684  * @static
 685  * @inheritable
 686  * @property {boolean}
 687  */
 688 OO.ui.Tool.static.displayBothIconAndLabel = false;
 689
 690 /**
 691  * Add tool to catch-all groups automatically.
 692  *
 693  * A catch-all group, which contains all tools that do not currently belong to a toolgroup,
 694  * can be included in a toolgroup using the wildcard selector, an asterisk (*).
 695  *
 696  * @static
 697  * @inheritable
 698  * @property {boolean}
 699  */
 700 OO.ui.Tool.static.autoAddToCatchall = true;
 701
 702 /**
 703  * Add tool to named groups automatically.
 704  *
 705  * By default, tools that are configured with a static ‘group’ property are added
 706  * to that group and will be selected when the symbolic name of the group is specified (e.g., when
 707  * toolgroups include tools by group name).
 708  *
 709  * @static
 710  * @property {boolean}
 711  * @inheritable
 712  */
 713 OO.ui.Tool.static.autoAddToGroup = true;
 714
 715 /**
 716  * Check if this tool is compatible with given data.
 717  *
 718  * This is a stub that can be overridden to provide support for filtering tools based on an
 719  * arbitrary piece of information  (e.g., where the cursor is in a document). The implementation
 720  * must also call this method so that the compatibility check can be performed.
 721  *
 722  * @static
 723  * @inheritable
 724  * @param {Mixed} data Data to check
 725  * @return {boolean} Tool can be used with data
 726  */
 727 OO.ui.Tool.static.isCompatibleWith = function () {
 728         return false;
 729 };
 730
 731 /* Methods */
 732
 733 /**
 734  * Handle the toolbar state being updated. This method is called when the
 735  * {@link OO.ui.Toolbar#event-updateState 'updateState' event} is emitted on the
 736  * {@link OO.ui.Toolbar Toolbar} that uses this tool, and should set the state of this tool
 737  * depending on application state (usually by calling #setDisabled to enable or disable the tool,
 738  * or #setActive to mark is as currently in-use or not).
 739  *
 740  * This is an abstract method that must be overridden in a concrete subclass.
 741  *
 742  * @method
 743  * @protected
 744  * @abstract
 745  */
 746 OO.ui.Tool.prototype.onUpdateState = null;
 747
 748 /**
 749  * Handle the tool being selected. This method is called when the user triggers this tool,
 750  * usually by clicking on its label/icon.
 751  *
 752  * This is an abstract method that must be overridden in a concrete subclass.
 753  *
 754  * @method
 755  * @protected
 756  * @abstract
 757  */
 758 OO.ui.Tool.prototype.onSelect = null;
 759
 760 /**
 761  * Check if the tool is active.
 762  *
 763  * Tools become active when their #onSelect or #onUpdateState handlers change them to appear pressed
 764  * with the #setActive method. Additional CSS is applied to the tool to reflect the active state.
 765  *
 766  * @return {boolean} Tool is active
 767  */
 768 OO.ui.Tool.prototype.isActive = function () {
 769         return this.active;
 770 };
 771
 772 /**
 773  * Make the tool appear active or inactive.
 774  *
 775  * This method should be called within #onSelect or #onUpdateState event handlers to make the tool
 776  * appear pressed or not.
 777  *
 778  * @param {boolean} state Make tool appear active
 779  */
 780 OO.ui.Tool.prototype.setActive = function ( state ) {
 781         this.active = !!state;
 782         if ( this.active ) {
 783                 this.$element.addClass( 'oo-ui-tool-active' );
 784         } else {
 785                 this.$element.removeClass( 'oo-ui-tool-active' );
 786         }
 787 };
 788
 789 /**
 790  * Set the tool #title.
 791  *
 792  * @param {string|Function} title Title text or a function that returns text
 793  * @chainable
 794  */
 795 OO.ui.Tool.prototype.setTitle = function ( title ) {
 796         this.title = OO.ui.resolveMsg( title );
 797         this.updateTitle();
 798         return this;
 799 };
 800
 801 /**
 802  * Get the tool #title.
 803  *
 804  * @return {string} Title text
 805  */
 806 OO.ui.Tool.prototype.getTitle = function () {
 807         return this.title;
 808 };
 809
 810 /**
 811  * Get the tool's symbolic name.
 812  *
 813  * @return {string} Symbolic name of tool
 814  */
 815 OO.ui.Tool.prototype.getName = function () {
 816         return this.constructor.static.name;
 817 };
 818
 819 /**
 820  * Update the title.
 821  */
 822 OO.ui.Tool.prototype.updateTitle = function () {
 823         var titleTooltips = this.toolGroup.constructor.static.titleTooltips,
 824                 accelTooltips = this.toolGroup.constructor.static.accelTooltips,
 825                 accel = this.toolbar.getToolAccelerator( this.constructor.static.name ),
 826                 tooltipParts = [];
 827
 828         this.$title.text( this.title );
 829         this.$accel.text( accel );
 830
 831         if ( titleTooltips && typeof this.title === 'string' && this.title.length ) {
 832                 tooltipParts.push( this.title );
 833         }
 834         if ( accelTooltips && typeof accel === 'string' && accel.length ) {
 835                 tooltipParts.push( accel );
 836         }
 837         if ( tooltipParts.length ) {
 838                 this.$link.attr( 'title', tooltipParts.join( ' ' ) );
 839         } else {
 840                 this.$link.removeAttr( 'title' );
 841         }
 842 };
 843
 844 /**
 845  * Destroy tool.
 846  *
 847  * Destroying the tool removes all event handlers and the tool’s DOM elements.
 848  * Call this method whenever you are done using a tool.
 849  */
 850 OO.ui.Tool.prototype.destroy = function () {
 851         this.toolbar.disconnect( this );
 852         this.$element.remove();
 853 };
 854
 855 /**
 856  * ToolGroups are collections of {@link OO.ui.Tool tools} that are used in a {@link OO.ui.Toolbar toolbar}.
 857  * The type of toolgroup ({@link OO.ui.ListToolGroup list}, {@link OO.ui.BarToolGroup bar}, or {@link OO.ui.MenuToolGroup menu})
 858  * to which a tool belongs determines how the tool is arranged and displayed in the toolbar. Toolgroups
 859  * themselves are created on demand with a {@link OO.ui.ToolGroupFactory toolgroup factory}.
 860  *
 861  * Toolgroups can contain individual tools, groups of tools, or all available tools, as specified
 862  * using the `include` config option. See OO.ui.ToolFactory#extract on documentation of the format.
 863  * The options `exclude`, `promote`, and `demote` support the same formats.
 864  *
 865  * See {@link OO.ui.Toolbar toolbars} for a full example. For more information about toolbars in general,
 866  * please see the [OOjs UI documentation on MediaWiki][1].
 867  *
 868  * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Toolbars
 869  *
 870  * @abstract
 871  * @class
 872  * @extends OO.ui.Widget
 873  * @mixins OO.ui.mixin.GroupElement
 874  *
 875  * @constructor
 876  * @param {OO.ui.Toolbar} toolbar
 877  * @param {Object} [config] Configuration options
 878  * @cfg {Array|string} [include] List of tools to include in the toolgroup, see above.
 879  * @cfg {Array|string} [exclude] List of tools to exclude from the toolgroup, see above.
 880  * @cfg {Array|string} [promote] List of tools to promote to the beginning of the toolgroup, see above.
 881  * @cfg {Array|string} [demote] List of tools to demote to the end of the toolgroup, see above.
 882  *  This setting is particularly useful when tools have been added to the toolgroup
 883  *  en masse (e.g., via the catch-all selector).
 884  */
 885 OO.ui.ToolGroup = function OoUiToolGroup( toolbar, config ) {
 886         // Allow passing positional parameters inside the config object
 887         if ( OO.isPlainObject( toolbar ) && config === undefined ) {
 888                 config = toolbar;
 889                 toolbar = config.toolbar;
 890         }
 891
 892         // Configuration initialization
 893         config = config || {};
 894
 895         // Parent constructor
 896         OO.ui.ToolGroup.parent.call( this, config );
 897
 898         // Mixin constructors
 899         OO.ui.mixin.GroupElement.call( this, config );
 900
 901         // Properties
 902         this.toolbar = toolbar;
 903         this.tools = {};
 904         this.pressed = null;
 905         this.autoDisabled = false;
 906         this.include = config.include || [];
 907         this.exclude = config.exclude || [];
 908         this.promote = config.promote || [];
 909         this.demote = config.demote || [];
 910         this.onCapturedMouseKeyUpHandler = this.onCapturedMouseKeyUp.bind( this );
 911
 912         // Events
 913         this.$element.on( {
 914                 mousedown: this.onMouseKeyDown.bind( this ),
 915                 mouseup: this.onMouseKeyUp.bind( this ),
 916                 keydown: this.onMouseKeyDown.bind( this ),
 917                 keyup: this.onMouseKeyUp.bind( this ),
 918                 focus: this.onMouseOverFocus.bind( this ),
 919                 blur: this.onMouseOutBlur.bind( this ),
 920                 mouseover: this.onMouseOverFocus.bind( this ),
 921                 mouseout: this.onMouseOutBlur.bind( this )
 922         } );
 923         this.toolbar.getToolFactory().connect( this, { register: 'onToolFactoryRegister' } );
 924         this.aggregate( { disable: 'itemDisable' } );
 925         this.connect( this, { itemDisable: 'updateDisabled' } );
 926
 927         // Initialization
 928         this.$group.addClass( 'oo-ui-toolGroup-tools' );
 929         this.$element
 930                 .addClass( 'oo-ui-toolGroup' )
 931                 .append( this.$group );
 932         this.populate();
 933 };
 934
 935 /* Setup */
 936
 937 OO.inheritClass( OO.ui.ToolGroup, OO.ui.Widget );
 938 OO.mixinClass( OO.ui.ToolGroup, OO.ui.mixin.GroupElement );
 939
 940 /* Events */
 941
 942 /**
 943  * @event update
 944  */
 945
 946 /* Static Properties */
 947
 948 /**
 949  * Show labels in tooltips.
 950  *
 951  * @static
 952  * @inheritable
 953  * @property {boolean}
 954  */
 955 OO.ui.ToolGroup.static.titleTooltips = false;
 956
 957 /**
 958  * Show acceleration labels in tooltips.
 959  *
 960  * Note: The OOjs UI library does not include an accelerator system, but does contain
 961  * a hook for one. To use an accelerator system, subclass the {@link OO.ui.Toolbar toolbar} and
 962  * override the {@link OO.ui.Toolbar#getToolAccelerator getToolAccelerator} method, which is
 963  * meant to return a label that describes the accelerator keys for a given tool (e.g., 'Ctrl + M').
 964  *
 965  * @static
 966  * @inheritable
 967  * @property {boolean}
 968  */
 969 OO.ui.ToolGroup.static.accelTooltips = false;
 970
 971 /**
 972  * Automatically disable the toolgroup when all tools are disabled
 973  *
 974  * @static
 975  * @inheritable
 976  * @property {boolean}
 977  */
 978 OO.ui.ToolGroup.static.autoDisable = true;
 979
 980 /* Methods */
 981
 982 /**
 983  * @inheritdoc
 984  */
 985 OO.ui.ToolGroup.prototype.isDisabled = function () {
 986         return this.autoDisabled || OO.ui.ToolGroup.parent.prototype.isDisabled.apply( this, arguments );
 987 };
 988
 989 /**
 990  * @inheritdoc
 991  */
 992 OO.ui.ToolGroup.prototype.updateDisabled = function () {
 993         var i, item, allDisabled = true;
 994
 995         if ( this.constructor.static.autoDisable ) {
 996                 for ( i = this.items.length - 1; i >= 0; i-- ) {
 997                         item = this.items[ i ];
 998                         if ( !item.isDisabled() ) {
 999                                 allDisabled = false;
1000                                 break;
1001                         }
1002                 }
1003                 this.autoDisabled = allDisabled;
1004         }
1005         OO.ui.ToolGroup.parent.prototype.updateDisabled.apply( this, arguments );
1006 };
1007
1008 /**
1009  * Handle mouse down and key down events.
1010  *
1011  * @protected
1012  * @param {jQuery.Event} e Mouse down or key down event
1013  */
1014 OO.ui.ToolGroup.prototype.onMouseKeyDown = function ( e ) {
1015         if (
1016                 !this.isDisabled() &&
1017                 ( e.which === OO.ui.MouseButtons.LEFT || e.which === OO.ui.Keys.SPACE || e.which === OO.ui.Keys.ENTER )
1018         ) {
1019                 this.pressed = this.getTargetTool( e );
1020                 if ( this.pressed ) {
1021                         this.pressed.setActive( true );
1022                         this.getElementDocument().addEventListener( 'mouseup', this.onCapturedMouseKeyUpHandler, true );
1023                         this.getElementDocument().addEventListener( 'keyup', this.onCapturedMouseKeyUpHandler, true );
1024                 }
1025                 return false;
1026         }
1027 };
1028
1029 /**
1030  * Handle captured mouse up and key up events.
1031  *
1032  * @protected
1033  * @param {Event} e Mouse up or key up event
1034  */
1035 OO.ui.ToolGroup.prototype.onCapturedMouseKeyUp = function ( e ) {
1036         this.getElementDocument().removeEventListener( 'mouseup', this.onCapturedMouseKeyUpHandler, true );
1037         this.getElementDocument().removeEventListener( 'keyup', this.onCapturedMouseKeyUpHandler, true );
1038         // onMouseKeyUp may be called a second time, depending on where the mouse is when the button is
1039         // released, but since `this.pressed` will no longer be true, the second call will be ignored.
1040         this.onMouseKeyUp( e );
1041 };
1042
1043 /**
1044  * Handle mouse up and key up events.
1045  *
1046  * @protected
1047  * @param {jQuery.Event} e Mouse up or key up event
1048  */
1049 OO.ui.ToolGroup.prototype.onMouseKeyUp = function ( e ) {
1050         var tool = this.getTargetTool( e );
1051
1052         if (
1053                 !this.isDisabled() && this.pressed && this.pressed === tool &&
1054                 ( e.which === OO.ui.MouseButtons.LEFT || e.which === OO.ui.Keys.SPACE || e.which === OO.ui.Keys.ENTER )
1055         ) {
1056                 this.pressed.onSelect();
1057                 this.pressed = null;
1058                 return false;
1059         }
1060
1061         this.pressed = null;
1062 };
1063
1064 /**
1065  * Handle mouse over and focus events.
1066  *
1067  * @protected
1068  * @param {jQuery.Event} e Mouse over or focus event
1069  */
1070 OO.ui.ToolGroup.prototype.onMouseOverFocus = function ( e ) {
1071         var tool = this.getTargetTool( e );
1072
1073         if ( this.pressed && this.pressed === tool ) {
1074                 this.pressed.setActive( true );
1075         }
1076 };
1077
1078 /**
1079  * Handle mouse out and blur events.
1080  *
1081  * @protected
1082  * @param {jQuery.Event} e Mouse out or blur event
1083  */
1084 OO.ui.ToolGroup.prototype.onMouseOutBlur = function ( e ) {
1085         var tool = this.getTargetTool( e );
1086
1087         if ( this.pressed && this.pressed === tool ) {
1088                 this.pressed.setActive( false );
1089         }
1090 };
1091
1092 /**
1093  * Get the closest tool to a jQuery.Event.
1094  *
1095  * Only tool links are considered, which prevents other elements in the tool such as popups from
1096  * triggering tool group interactions.
1097  *
1098  * @private
1099  * @param {jQuery.Event} e
1100  * @return {OO.ui.Tool|null} Tool, `null` if none was found
1101  */
1102 OO.ui.ToolGroup.prototype.getTargetTool = function ( e ) {
1103         var tool,
1104                 $item = $( e.target ).closest( '.oo-ui-tool-link' );
1105
1106         if ( $item.length ) {
1107                 tool = $item.parent().data( 'oo-ui-tool' );
1108         }
1109
1110         return tool && !tool.isDisabled() ? tool : null;
1111 };
1112
1113 /**
1114  * Handle tool registry register events.
1115  *
1116  * If a tool is registered after the group is created, we must repopulate the list to account for:
1117  *
1118  * - a tool being added that may be included
1119  * - a tool already included being overridden
1120  *
1121  * @protected
1122  * @param {string} name Symbolic name of tool
1123  */
1124 OO.ui.ToolGroup.prototype.onToolFactoryRegister = function () {
1125         this.populate();
1126 };
1127
1128 /**
1129  * Get the toolbar that contains the toolgroup.
1130  *
1131  * @return {OO.ui.Toolbar} Toolbar that contains the toolgroup
1132  */
1133 OO.ui.ToolGroup.prototype.getToolbar = function () {
1134         return this.toolbar;
1135 };
1136
1137 /**
1138  * Add and remove tools based on configuration.
1139  */
1140 OO.ui.ToolGroup.prototype.populate = function () {
1141         var i, len, name, tool,
1142                 toolFactory = this.toolbar.getToolFactory(),
1143                 names = {},
1144                 add = [],
1145                 remove = [],
1146                 list = this.toolbar.getToolFactory().getTools(
1147                         this.include, this.exclude, this.promote, this.demote
1148                 );
1149
1150         // Build a list of needed tools
1151         for ( i = 0, len = list.length; i < len; i++ ) {
1152                 name = list[ i ];
1153                 if (
1154                         // Tool exists
1155                         toolFactory.lookup( name ) &&
1156                         // Tool is available or is already in this group
1157                         ( this.toolbar.isToolAvailable( name ) || this.tools[ name ] )
1158                 ) {
1159                         // Hack to prevent infinite recursion via ToolGroupTool. We need to reserve the tool before
1160                         // creating it, but we can't call reserveTool() yet because we haven't created the tool.
1161                         this.toolbar.tools[ name ] = true;
1162                         tool = this.tools[ name ];
1163                         if ( !tool ) {
1164                                 // Auto-initialize tools on first use
1165                                 this.tools[ name ] = tool = toolFactory.create( name, this );
1166                                 tool.updateTitle();
1167                         }
1168                         this.toolbar.reserveTool( tool );
1169                         add.push( tool );
1170                         names[ name ] = true;
1171                 }
1172         }
1173         // Remove tools that are no longer needed
1174         for ( name in this.tools ) {
1175                 if ( !names[ name ] ) {
1176                         this.tools[ name ].destroy();
1177                         this.toolbar.releaseTool( this.tools[ name ] );
1178                         remove.push( this.tools[ name ] );
1179                         delete this.tools[ name ];
1180                 }
1181         }
1182         if ( remove.length ) {
1183                 this.removeItems( remove );
1184         }
1185         // Update emptiness state
1186         if ( add.length ) {
1187                 this.$element.removeClass( 'oo-ui-toolGroup-empty' );
1188         } else {
1189                 this.$element.addClass( 'oo-ui-toolGroup-empty' );
1190         }
1191         // Re-add tools (moving existing ones to new locations)
1192         this.addItems( add );
1193         // Disabled state may depend on items
1194         this.updateDisabled();
1195 };
1196
1197 /**
1198  * Destroy toolgroup.
1199  */
1200 OO.ui.ToolGroup.prototype.destroy = function () {
1201         var name;
1202
1203         this.clearItems();
1204         this.toolbar.getToolFactory().disconnect( this );
1205         for ( name in this.tools ) {
1206                 this.toolbar.releaseTool( this.tools[ name ] );
1207                 this.tools[ name ].disconnect( this ).destroy();
1208                 delete this.tools[ name ];
1209         }
1210         this.$element.remove();
1211 };
1212
1213 /**
1214  * A ToolFactory creates tools on demand. All tools ({@link OO.ui.Tool Tools}, {@link OO.ui.PopupTool PopupTools},
1215  * and {@link OO.ui.ToolGroupTool ToolGroupTools}) must be registered with a tool factory. Tools are
1216  * registered by their symbolic name. See {@link OO.ui.Toolbar toolbars} for an example.
1217  *
1218  * For more information about toolbars in general, please see the [OOjs UI documentation on MediaWiki][1].
1219  *
1220  * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Toolbars
1221  *
1222  * @class
1223  * @extends OO.Factory
1224  * @constructor
1225  */
1226 OO.ui.ToolFactory = function OoUiToolFactory() {
1227         // Parent constructor
1228         OO.ui.ToolFactory.parent.call( this );
1229 };
1230
1231 /* Setup */
1232
1233 OO.inheritClass( OO.ui.ToolFactory, OO.Factory );
1234
1235 /* Methods */
1236
1237 /**
1238  * Get tools from the factory
1239  *
1240  * @param {Array|string} [include] Included tools, see #extract for format
1241  * @param {Array|string} [exclude] Excluded tools, see #extract for format
1242  * @param {Array|string} [promote] Promoted tools, see #extract for format
1243  * @param {Array|string} [demote] Demoted tools, see #extract for format
1244  * @return {string[]} List of tools
1245  */
1246 OO.ui.ToolFactory.prototype.getTools = function ( include, exclude, promote, demote ) {
1247         var i, len, included, promoted, demoted,
1248                 auto = [],
1249                 used = {};
1250
1251         // Collect included and not excluded tools
1252         included = OO.simpleArrayDifference( this.extract( include ), this.extract( exclude ) );
1253
1254         // Promotion
1255         promoted = this.extract( promote, used );
1256         demoted = this.extract( demote, used );
1257
1258         // Auto
1259         for ( i = 0, len = included.length; i < len; i++ ) {
1260                 if ( !used[ included[ i ] ] ) {
1261                         auto.push( included[ i ] );
1262                 }
1263         }
1264
1265         return promoted.concat( auto ).concat( demoted );
1266 };
1267
1268 /**
1269  * Get a flat list of names from a list of names or groups.
1270  *
1271  * Normally, `collection` is an array of tool specifications. Tools can be specified in the
1272  * following ways:
1273  *
1274  * - To include an individual tool, use the symbolic name: `{ name: 'tool-name' }` or `'tool-name'`.
1275  * - To include all tools in a group, use the group name: `{ group: 'group-name' }`. (To assign the
1276  *   tool to a group, use OO.ui.Tool.static.group.)
1277  *
1278  * Alternatively, to include all tools that are not yet assigned to any other toolgroup, use the
1279  * catch-all selector `'*'`.
1280  *
1281  * If `used` is passed, tool names that appear as properties in this object will be considered
1282  * already assigned, and will not be returned even if specified otherwise. The tool names extracted
1283  * by this function call will be added as new properties in the object.
1284  *
1285  * @private
1286  * @param {Array|string} collection List of tools, see above
1287  * @param {Object} [used] Object containing information about used tools, see above
1288  * @return {string[]} List of extracted tool names
1289  */
1290 OO.ui.ToolFactory.prototype.extract = function ( collection, used ) {
1291         var i, len, item, name, tool,
1292                 names = [];
1293
1294         if ( collection === '*' ) {
1295                 for ( name in this.registry ) {
1296                         tool = this.registry[ name ];
1297                         if (
1298                                 // Only add tools by group name when auto-add is enabled
1299                                 tool.static.autoAddToCatchall &&
1300                                 // Exclude already used tools
1301                                 ( !used || !used[ name ] )
1302                         ) {
1303                                 names.push( name );
1304                                 if ( used ) {
1305                                         used[ name ] = true;
1306                                 }
1307                         }
1308                 }
1309         } else if ( Array.isArray( collection ) ) {
1310                 for ( i = 0, len = collection.length; i < len; i++ ) {
1311                         item = collection[ i ];
1312                         // Allow plain strings as shorthand for named tools
1313                         if ( typeof item === 'string' ) {
1314                                 item = { name: item };
1315                         }
1316                         if ( OO.isPlainObject( item ) ) {
1317                                 if ( item.group ) {
1318                                         for ( name in this.registry ) {
1319                                                 tool = this.registry[ name ];
1320                                                 if (
1321                                                         // Include tools with matching group
1322                                                         tool.static.group === item.group &&
1323                                                         // Only add tools by group name when auto-add is enabled
1324                                                         tool.static.autoAddToGroup &&
1325                                                         // Exclude already used tools
1326                                                         ( !used || !used[ name ] )
1327                                                 ) {
1328                                                         names.push( name );
1329                                                         if ( used ) {
1330                                                                 used[ name ] = true;
1331                                                         }
1332                                                 }
1333                                         }
1334                                 // Include tools with matching name and exclude already used tools
1335                                 } else if ( item.name && ( !used || !used[ item.name ] ) ) {
1336                                         names.push( item.name );
1337                                         if ( used ) {
1338                                                 used[ item.name ] = true;
1339                                         }
1340                                 }
1341                         }
1342                 }
1343         }
1344         return names;
1345 };
1346
1347 /**
1348  * ToolGroupFactories create {@link OO.ui.ToolGroup toolgroups} on demand. The toolgroup classes must
1349  * specify a symbolic name and be registered with the factory. The following classes are registered by
1350  * default:
1351  *
1352  * - {@link OO.ui.BarToolGroup BarToolGroups} (‘bar’)
1353  * - {@link OO.ui.MenuToolGroup MenuToolGroups} (‘menu’)
1354  * - {@link OO.ui.ListToolGroup ListToolGroups} (‘list’)
1355  *
1356  * See {@link OO.ui.Toolbar toolbars} for an example.
1357  *
1358  * For more information about toolbars in general, please see the [OOjs UI documentation on MediaWiki][1].
1359  *
1360  * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Toolbars
1361  * @class
1362  * @extends OO.Factory
1363  * @constructor
1364  */
1365 OO.ui.ToolGroupFactory = function OoUiToolGroupFactory() {
1366         var i, l, defaultClasses;
1367         // Parent constructor
1368         OO.Factory.call( this );
1369
1370         defaultClasses = this.constructor.static.getDefaultClasses();
1371
1372         // Register default toolgroups
1373         for ( i = 0, l = defaultClasses.length; i < l; i++ ) {
1374                 this.register( defaultClasses[ i ] );
1375         }
1376 };
1377
1378 /* Setup */
1379
1380 OO.inheritClass( OO.ui.ToolGroupFactory, OO.Factory );
1381
1382 /* Static Methods */
1383
1384 /**
1385  * Get a default set of classes to be registered on construction.
1386  *
1387  * @return {Function[]} Default classes
1388  */
1389 OO.ui.ToolGroupFactory.static.getDefaultClasses = function () {
1390         return [
1391                 OO.ui.BarToolGroup,
1392                 OO.ui.ListToolGroup,
1393                 OO.ui.MenuToolGroup
1394         ];
1395 };
1396
1397 /**
1398  * Popup tools open a popup window when they are selected from the {@link OO.ui.Toolbar toolbar}. Each popup tool is configured
1399  * with a static name, title, and icon, as well with as any popup configurations. Unlike other tools, popup tools do not require that developers specify
1400  * an #onSelect or #onUpdateState method, as these methods have been implemented already.
1401  *
1402  *     // Example of a popup tool. When selected, a popup tool displays
1403  *     // a popup window.
1404  *     function HelpTool( toolGroup, config ) {
1405  *        OO.ui.PopupTool.call( this, toolGroup, $.extend( { popup: {
1406  *            padded: true,
1407  *            label: 'Help',
1408  *            head: true
1409  *        } }, config ) );
1410  *        this.popup.$body.append( '<p>I am helpful!</p>' );
1411  *     };
1412  *     OO.inheritClass( HelpTool, OO.ui.PopupTool );
1413  *     HelpTool.static.name = 'help';
1414  *     HelpTool.static.icon = 'help';
1415  *     HelpTool.static.title = 'Help';
1416  *     toolFactory.register( HelpTool );
1417  *
1418  * For an example of a toolbar that contains a popup tool, see {@link OO.ui.Toolbar toolbars}. For more information about
1419  * toolbars in genreral, please see the [OOjs UI documentation on MediaWiki][1].
1420  *
1421  * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Toolbars
1422  *
1423  * @abstract
1424  * @class
1425  * @extends OO.ui.Tool
1426  * @mixins OO.ui.mixin.PopupElement
1427  *
1428  * @constructor
1429  * @param {OO.ui.ToolGroup} toolGroup
1430  * @param {Object} [config] Configuration options
1431  */
1432 OO.ui.PopupTool = function OoUiPopupTool( toolGroup, config ) {
1433         // Allow passing positional parameters inside the config object
1434         if ( OO.isPlainObject( toolGroup ) && config === undefined ) {
1435                 config = toolGroup;
1436                 toolGroup = config.toolGroup;
1437         }
1438
1439         // Parent constructor
1440         OO.ui.PopupTool.parent.call( this, toolGroup, config );
1441
1442         // Mixin constructors
1443         OO.ui.mixin.PopupElement.call( this, config );
1444
1445         // Initialization
1446         this.$element
1447                 .addClass( 'oo-ui-popupTool' )
1448                 .append( this.popup.$element );
1449 };
1450
1451 /* Setup */
1452
1453 OO.inheritClass( OO.ui.PopupTool, OO.ui.Tool );
1454 OO.mixinClass( OO.ui.PopupTool, OO.ui.mixin.PopupElement );
1455
1456 /* Methods */
1457
1458 /**
1459  * Handle the tool being selected.
1460  *
1461  * @inheritdoc
1462  */
1463 OO.ui.PopupTool.prototype.onSelect = function () {
1464         if ( !this.isDisabled() ) {
1465                 this.popup.toggle();
1466         }
1467         this.setActive( false );
1468         return false;
1469 };
1470
1471 /**
1472  * Handle the toolbar state being updated.
1473  *
1474  * @inheritdoc
1475  */
1476 OO.ui.PopupTool.prototype.onUpdateState = function () {
1477         this.setActive( false );
1478 };
1479
1480 /**
1481  * A ToolGroupTool is a special sort of tool that can contain other {@link OO.ui.Tool tools}
1482  * and {@link OO.ui.ToolGroup toolgroups}. The ToolGroupTool was specifically designed to be used
1483  * inside a {@link OO.ui.BarToolGroup bar} toolgroup to provide access to additional tools from
1484  * the bar item. Included tools will be displayed in a dropdown {@link OO.ui.ListToolGroup list}
1485  * when the ToolGroupTool is selected.
1486  *
1487  *     // Example: ToolGroupTool with two nested tools, 'setting1' and 'setting2', defined elsewhere.
1488  *
1489  *     function SettingsTool() {
1490  *         SettingsTool.parent.apply( this, arguments );
1491  *     };
1492  *     OO.inheritClass( SettingsTool, OO.ui.ToolGroupTool );
1493  *     SettingsTool.static.name = 'settings';
1494  *     SettingsTool.static.title = 'Change settings';
1495  *     SettingsTool.static.groupConfig = {
1496  *         icon: 'settings',
1497  *         label: 'ToolGroupTool',
1498  *         include: [  'setting1', 'setting2'  ]
1499  *     };
1500  *     toolFactory.register( SettingsTool );
1501  *
1502  * For more information, please see the [OOjs UI documentation on MediaWiki][1].
1503  *
1504  * Please note that this implementation is subject to change per [T74159] [2].
1505  *
1506  * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Toolbars#ToolGroupTool
1507  * [2]: https://phabricator.wikimedia.org/T74159
1508  *
1509  * @abstract
1510  * @class
1511  * @extends OO.ui.Tool
1512  *
1513  * @constructor
1514  * @param {OO.ui.ToolGroup} toolGroup
1515  * @param {Object} [config] Configuration options
1516  */
1517 OO.ui.ToolGroupTool = function OoUiToolGroupTool( toolGroup, config ) {
1518         // Allow passing positional parameters inside the config object
1519         if ( OO.isPlainObject( toolGroup ) && config === undefined ) {
1520                 config = toolGroup;
1521                 toolGroup = config.toolGroup;
1522         }
1523
1524         // Parent constructor
1525         OO.ui.ToolGroupTool.parent.call( this, toolGroup, config );
1526
1527         // Properties
1528         this.innerToolGroup = this.createGroup( this.constructor.static.groupConfig );
1529
1530         // Events
1531         this.innerToolGroup.connect( this, { disable: 'onToolGroupDisable' } );
1532
1533         // Initialization
1534         this.$link.remove();
1535         this.$element
1536                 .addClass( 'oo-ui-toolGroupTool' )
1537                 .append( this.innerToolGroup.$element );
1538 };
1539
1540 /* Setup */
1541
1542 OO.inheritClass( OO.ui.ToolGroupTool, OO.ui.Tool );
1543
1544 /* Static Properties */
1545
1546 /**
1547  * Toolgroup configuration.
1548  *
1549  * The toolgroup configuration consists of the tools to include, as well as an icon and label
1550  * to use for the bar item. Tools can be included by symbolic name, group, or with the
1551  * wildcard selector. Please see {@link OO.ui.ToolGroup toolgroup} for more information.
1552  *
1553  * @property {Object.<string,Array>}
1554  */
1555 OO.ui.ToolGroupTool.static.groupConfig = {};
1556
1557 /* Methods */
1558
1559 /**
1560  * Handle the tool being selected.
1561  *
1562  * @inheritdoc
1563  */
1564 OO.ui.ToolGroupTool.prototype.onSelect = function () {
1565         this.innerToolGroup.setActive( !this.innerToolGroup.active );
1566         return false;
1567 };
1568
1569 /**
1570  * Synchronize disabledness state of the tool with the inner toolgroup.
1571  *
1572  * @private
1573  * @param {boolean} disabled Element is disabled
1574  */
1575 OO.ui.ToolGroupTool.prototype.onToolGroupDisable = function ( disabled ) {
1576         this.setDisabled( disabled );
1577 };
1578
1579 /**
1580  * Handle the toolbar state being updated.
1581  *
1582  * @inheritdoc
1583  */
1584 OO.ui.ToolGroupTool.prototype.onUpdateState = function () {
1585         this.setActive( false );
1586 };
1587
1588 /**
1589  * Build a {@link OO.ui.ToolGroup toolgroup} from the specified configuration.
1590  *
1591  * @param {Object.<string,Array>} group Toolgroup configuration. Please see {@link OO.ui.ToolGroup toolgroup} for
1592  *  more information.
1593  * @return {OO.ui.ListToolGroup}
1594  */
1595 OO.ui.ToolGroupTool.prototype.createGroup = function ( group ) {
1596         if ( group.include === '*' ) {
1597                 // Apply defaults to catch-all groups
1598                 if ( group.label === undefined ) {
1599                         group.label = OO.ui.msg( 'ooui-toolbar-more' );
1600                 }
1601         }
1602
1603         return this.toolbar.getToolGroupFactory().create( 'list', this.toolbar, group );
1604 };
1605
1606 /**
1607  * BarToolGroups are one of three types of {@link OO.ui.ToolGroup toolgroups} that are used to
1608  * create {@link OO.ui.Toolbar toolbars} (the other types of groups are {@link OO.ui.MenuToolGroup MenuToolGroup}
1609  * and {@link OO.ui.ListToolGroup ListToolGroup}). The {@link OO.ui.Tool tools} in a BarToolGroup are
1610  * displayed by icon in a single row. The title of the tool is displayed when users move the mouse over
1611  * the tool.
1612  *
1613  * BarToolGroups are created by a {@link OO.ui.ToolGroupFactory tool group factory} when the toolbar is
1614  * set up.
1615  *
1616  *     @example
1617  *     // Example of a BarToolGroup with two tools
1618  *     var toolFactory = new OO.ui.ToolFactory();
1619  *     var toolGroupFactory = new OO.ui.ToolGroupFactory();
1620  *     var toolbar = new OO.ui.Toolbar( toolFactory, toolGroupFactory );
1621  *
1622  *     // We will be placing status text in this element when tools are used
1623  *     var $area = $( '<p>' ).text( 'Example of a BarToolGroup with two tools.' );
1624  *
1625  *     // Define the tools that we're going to place in our toolbar
1626  *
1627  *     // Create a class inheriting from OO.ui.Tool
1628  *     function SearchTool() {
1629  *         SearchTool.parent.apply( this, arguments );
1630  *     }
1631  *     OO.inheritClass( SearchTool, OO.ui.Tool );
1632  *     // Each tool must have a 'name' (used as an internal identifier, see later) and at least one
1633  *     // of 'icon' and 'title' (displayed icon and text).
1634  *     SearchTool.static.name = 'search';
1635  *     SearchTool.static.icon = 'search';
1636  *     SearchTool.static.title = 'Search...';
1637  *     // Defines the action that will happen when this tool is selected (clicked).
1638  *     SearchTool.prototype.onSelect = function () {
1639  *         $area.text( 'Search tool clicked!' );
1640  *         // Never display this tool as "active" (selected).
1641  *         this.setActive( false );
1642  *     };
1643  *     SearchTool.prototype.onUpdateState = function () {};
1644  *     // Make this tool available in our toolFactory and thus our toolbar
1645  *     toolFactory.register( SearchTool );
1646  *
1647  *     // This is a PopupTool. Rather than having a custom 'onSelect' action, it will display a
1648  *     // little popup window (a PopupWidget).
1649  *     function HelpTool( toolGroup, config ) {
1650  *         OO.ui.PopupTool.call( this, toolGroup, $.extend( { popup: {
1651  *             padded: true,
1652  *             label: 'Help',
1653  *             head: true
1654  *         } }, config ) );
1655  *         this.popup.$body.append( '<p>I am helpful!</p>' );
1656  *     }
1657  *     OO.inheritClass( HelpTool, OO.ui.PopupTool );
1658  *     HelpTool.static.name = 'help';
1659  *     HelpTool.static.icon = 'help';
1660  *     HelpTool.static.title = 'Help';
1661  *     toolFactory.register( HelpTool );
1662  *
1663  *     // Finally define which tools and in what order appear in the toolbar. Each tool may only be
1664  *     // used once (but not all defined tools must be used).
1665  *     toolbar.setup( [
1666  *         {
1667  *             // 'bar' tool groups display tools by icon only
1668  *             type: 'bar',
1669  *             include: [ 'search', 'help' ]
1670  *         }
1671  *     ] );
1672  *
1673  *     // Create some UI around the toolbar and place it in the document
1674  *     var frame = new OO.ui.PanelLayout( {
1675  *         expanded: false,
1676  *         framed: true
1677  *     } );
1678  *     var contentFrame = new OO.ui.PanelLayout( {
1679  *         expanded: false,
1680  *         padded: true
1681  *     } );
1682  *     frame.$element.append(
1683  *         toolbar.$element,
1684  *         contentFrame.$element.append( $area )
1685  *     );
1686  *     $( 'body' ).append( frame.$element );
1687  *
1688  *     // Here is where the toolbar is actually built. This must be done after inserting it into the
1689  *     // document.
1690  *     toolbar.initialize();
1691  *
1692  * For more information about how to add tools to a bar tool group, please see {@link OO.ui.ToolGroup toolgroup}.
1693  * For more information about toolbars in general, please see the [OOjs UI documentation on MediaWiki][1].
1694  *
1695  * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Toolbars
1696  *
1697  * @class
1698  * @extends OO.ui.ToolGroup
1699  *
1700  * @constructor
1701  * @param {OO.ui.Toolbar} toolbar
1702  * @param {Object} [config] Configuration options
1703  */
1704 OO.ui.BarToolGroup = function OoUiBarToolGroup( toolbar, config ) {
1705         // Allow passing positional parameters inside the config object
1706         if ( OO.isPlainObject( toolbar ) && config === undefined ) {
1707                 config = toolbar;
1708                 toolbar = config.toolbar;
1709         }
1710
1711         // Parent constructor
1712         OO.ui.BarToolGroup.parent.call( this, toolbar, config );
1713
1714         // Initialization
1715         this.$element.addClass( 'oo-ui-barToolGroup' );
1716 };
1717
1718 /* Setup */
1719
1720 OO.inheritClass( OO.ui.BarToolGroup, OO.ui.ToolGroup );
1721
1722 /* Static Properties */
1723
1724 OO.ui.BarToolGroup.static.titleTooltips = true;
1725
1726 OO.ui.BarToolGroup.static.accelTooltips = true;
1727
1728 OO.ui.BarToolGroup.static.name = 'bar';
1729
1730 /**
1731  * PopupToolGroup is an abstract base class used by both {@link OO.ui.MenuToolGroup MenuToolGroup}
1732  * and {@link OO.ui.ListToolGroup ListToolGroup} to provide a popup--an overlaid menu or list of tools with an
1733  * optional icon and label. This class can be used for other base classes that also use this functionality.
1734  *
1735  * @abstract
1736  * @class
1737  * @extends OO.ui.ToolGroup
1738  * @mixins OO.ui.mixin.IconElement
1739  * @mixins OO.ui.mixin.IndicatorElement
1740  * @mixins OO.ui.mixin.LabelElement
1741  * @mixins OO.ui.mixin.TitledElement
1742  * @mixins OO.ui.mixin.ClippableElement
1743  * @mixins OO.ui.mixin.TabIndexedElement
1744  *
1745  * @constructor
1746  * @param {OO.ui.Toolbar} toolbar
1747  * @param {Object} [config] Configuration options
1748  * @cfg {string} [header] Text to display at the top of the popup
1749  */
1750 OO.ui.PopupToolGroup = function OoUiPopupToolGroup( toolbar, config ) {
1751         // Allow passing positional parameters inside the config object
1752         if ( OO.isPlainObject( toolbar ) && config === undefined ) {
1753                 config = toolbar;
1754                 toolbar = config.toolbar;
1755         }
1756
1757         // Configuration initialization
1758         config = config || {};
1759
1760         // Parent constructor
1761         OO.ui.PopupToolGroup.parent.call( this, toolbar, config );
1762
1763         // Properties
1764         this.active = false;
1765         this.dragging = false;
1766         this.onBlurHandler = this.onBlur.bind( this );
1767         this.$handle = $( '<span>' );
1768
1769         // Mixin constructors
1770         OO.ui.mixin.IconElement.call( this, config );
1771         OO.ui.mixin.IndicatorElement.call( this, config );
1772         OO.ui.mixin.LabelElement.call( this, config );
1773         OO.ui.mixin.TitledElement.call( this, config );
1774         OO.ui.mixin.ClippableElement.call( this, $.extend( {}, config, { $clippable: this.$group } ) );
1775         OO.ui.mixin.TabIndexedElement.call( this, $.extend( {}, config, { $tabIndexed: this.$handle } ) );
1776
1777         // Events
1778         this.$handle.on( {
1779                 keydown: this.onHandleMouseKeyDown.bind( this ),
1780                 keyup: this.onHandleMouseKeyUp.bind( this ),
1781                 mousedown: this.onHandleMouseKeyDown.bind( this ),
1782                 mouseup: this.onHandleMouseKeyUp.bind( this )
1783         } );
1784
1785         // Initialization
1786         this.$handle
1787                 .addClass( 'oo-ui-popupToolGroup-handle' )
1788                 .append( this.$icon, this.$label, this.$indicator );
1789         // If the pop-up should have a header, add it to the top of the toolGroup.
1790         // Note: If this feature is useful for other widgets, we could abstract it into an
1791         // OO.ui.HeaderedElement mixin constructor.
1792         if ( config.header !== undefined ) {
1793                 this.$group
1794                         .prepend( $( '<span>' )
1795                                 .addClass( 'oo-ui-popupToolGroup-header' )
1796                                 .text( config.header )
1797                         );
1798         }
1799         this.$element
1800                 .addClass( 'oo-ui-popupToolGroup' )
1801                 .prepend( this.$handle );
1802 };
1803
1804 /* Setup */
1805
1806 OO.inheritClass( OO.ui.PopupToolGroup, OO.ui.ToolGroup );
1807 OO.mixinClass( OO.ui.PopupToolGroup, OO.ui.mixin.IconElement );
1808 OO.mixinClass( OO.ui.PopupToolGroup, OO.ui.mixin.IndicatorElement );
1809 OO.mixinClass( OO.ui.PopupToolGroup, OO.ui.mixin.LabelElement );
1810 OO.mixinClass( OO.ui.PopupToolGroup, OO.ui.mixin.TitledElement );
1811 OO.mixinClass( OO.ui.PopupToolGroup, OO.ui.mixin.ClippableElement );
1812 OO.mixinClass( OO.ui.PopupToolGroup, OO.ui.mixin.TabIndexedElement );
1813
1814 /* Methods */
1815
1816 /**
1817  * @inheritdoc
1818  */
1819 OO.ui.PopupToolGroup.prototype.setDisabled = function () {
1820         // Parent method
1821         OO.ui.PopupToolGroup.parent.prototype.setDisabled.apply( this, arguments );
1822
1823         if ( this.isDisabled() && this.isElementAttached() ) {
1824                 this.setActive( false );
1825         }
1826 };
1827
1828 /**
1829  * Handle focus being lost.
1830  *
1831  * The event is actually generated from a mouseup/keyup, so it is not a normal blur event object.
1832  *
1833  * @protected
1834  * @param {jQuery.Event} e Mouse up or key up event
1835  */
1836 OO.ui.PopupToolGroup.prototype.onBlur = function ( e ) {
1837         // Only deactivate when clicking outside the dropdown element
1838         if ( $( e.target ).closest( '.oo-ui-popupToolGroup' )[ 0 ] !== this.$element[ 0 ] ) {
1839                 this.setActive( false );
1840         }
1841 };
1842
1843 /**
1844  * @inheritdoc
1845  */
1846 OO.ui.PopupToolGroup.prototype.onMouseKeyUp = function ( e ) {
1847         // Only close toolgroup when a tool was actually selected
1848         if (
1849                 !this.isDisabled() && this.pressed && this.pressed === this.getTargetTool( e ) &&
1850                 ( e.which === OO.ui.MouseButtons.LEFT || e.which === OO.ui.Keys.SPACE || e.which === OO.ui.Keys.ENTER )
1851         ) {
1852                 this.setActive( false );
1853         }
1854         return OO.ui.PopupToolGroup.parent.prototype.onMouseKeyUp.call( this, e );
1855 };
1856
1857 /**
1858  * Handle mouse up and key up events.
1859  *
1860  * @protected
1861  * @param {jQuery.Event} e Mouse up or key up event
1862  */
1863 OO.ui.PopupToolGroup.prototype.onHandleMouseKeyUp = function ( e ) {
1864         if (
1865                 !this.isDisabled() &&
1866                 ( e.which === OO.ui.MouseButtons.LEFT || e.which === OO.ui.Keys.SPACE || e.which === OO.ui.Keys.ENTER )
1867         ) {
1868                 return false;
1869         }
1870 };
1871
1872 /**
1873  * Handle mouse down and key down events.
1874  *
1875  * @protected
1876  * @param {jQuery.Event} e Mouse down or key down event
1877  */
1878 OO.ui.PopupToolGroup.prototype.onHandleMouseKeyDown = function ( e ) {
1879         if (
1880                 !this.isDisabled() &&
1881                 ( e.which === OO.ui.MouseButtons.LEFT || e.which === OO.ui.Keys.SPACE || e.which === OO.ui.Keys.ENTER )
1882         ) {
1883                 this.setActive( !this.active );
1884                 return false;
1885         }
1886 };
1887
1888 /**
1889  * Switch into 'active' mode.
1890  *
1891  * When active, the popup is visible. A mouseup event anywhere in the document will trigger
1892  * deactivation.
1893  */
1894 OO.ui.PopupToolGroup.prototype.setActive = function ( value ) {
1895         var containerWidth, containerLeft;
1896         value = !!value;
1897         if ( this.active !== value ) {
1898                 this.active = value;
1899                 if ( value ) {
1900                         this.getElementDocument().addEventListener( 'mouseup', this.onBlurHandler, true );
1901                         this.getElementDocument().addEventListener( 'keyup', this.onBlurHandler, true );
1902
1903                         this.$clippable.css( 'left', '' );
1904                         // Try anchoring the popup to the left first
1905                         this.$element.addClass( 'oo-ui-popupToolGroup-active oo-ui-popupToolGroup-left' );
1906                         this.toggleClipping( true );
1907                         if ( this.isClippedHorizontally() ) {
1908                                 // Anchoring to the left caused the popup to clip, so anchor it to the right instead
1909                                 this.toggleClipping( false );
1910                                 this.$element
1911                                         .removeClass( 'oo-ui-popupToolGroup-left' )
1912                                         .addClass( 'oo-ui-popupToolGroup-right' );
1913                                 this.toggleClipping( true );
1914                         }
1915                         if ( this.isClippedHorizontally() ) {
1916                                 // Anchoring to the right also caused the popup to clip, so just make it fill the container
1917                                 containerWidth = this.$clippableScrollableContainer.width();
1918                                 containerLeft = this.$clippableScrollableContainer.offset().left;
1919
1920                                 this.toggleClipping( false );
1921                                 this.$element.removeClass( 'oo-ui-popupToolGroup-right' );
1922
1923                                 this.$clippable.css( {
1924                                         left: -( this.$element.offset().left - containerLeft ),
1925                                         width: containerWidth
1926                                 } );
1927                         }
1928                 } else {
1929                         this.getElementDocument().removeEventListener( 'mouseup', this.onBlurHandler, true );
1930                         this.getElementDocument().removeEventListener( 'keyup', this.onBlurHandler, true );
1931                         this.$element.removeClass(
1932                                 'oo-ui-popupToolGroup-active oo-ui-popupToolGroup-left  oo-ui-popupToolGroup-right'
1933                         );
1934                         this.toggleClipping( false );
1935                 }
1936         }
1937 };
1938
1939 /**
1940  * ListToolGroups are one of three types of {@link OO.ui.ToolGroup toolgroups} that are used to
1941  * create {@link OO.ui.Toolbar toolbars} (the other types of groups are {@link OO.ui.MenuToolGroup MenuToolGroup}
1942  * and {@link OO.ui.BarToolGroup BarToolGroup}). The {@link OO.ui.Tool tools} in a ListToolGroup are displayed
1943  * by label in a dropdown menu. The title of the tool is used as the label text. The menu itself can be configured
1944  * with a label, icon, indicator, header, and title.
1945  *
1946  * ListToolGroups can be configured to be expanded and collapsed. Collapsed lists will have a ‘More’ option that
1947  * users can select to see the full list of tools. If a collapsed toolgroup is expanded, a ‘Fewer’ option permits
1948  * users to collapse the list again.
1949  *
1950  * ListToolGroups are created by a {@link OO.ui.ToolGroupFactory toolgroup factory} when the toolbar is set up. The factory
1951  * requires the ListToolGroup's symbolic name, 'list', which is specified along with the other configurations. For more
1952  * information about how to add tools to a ListToolGroup, please see {@link OO.ui.ToolGroup toolgroup}.
1953  *
1954  *     @example
1955  *     // Example of a ListToolGroup
1956  *     var toolFactory = new OO.ui.ToolFactory();
1957  *     var toolGroupFactory = new OO.ui.ToolGroupFactory();
1958  *     var toolbar = new OO.ui.Toolbar( toolFactory, toolGroupFactory );
1959  *
1960  *     // Configure and register two tools
1961  *     function SettingsTool() {
1962  *         SettingsTool.parent.apply( this, arguments );
1963  *     }
1964  *     OO.inheritClass( SettingsTool, OO.ui.Tool );
1965  *     SettingsTool.static.name = 'settings';
1966  *     SettingsTool.static.icon = 'settings';
1967  *     SettingsTool.static.title = 'Change settings';
1968  *     SettingsTool.prototype.onSelect = function () {
1969  *         this.setActive( false );
1970  *     };
1971  *     SettingsTool.prototype.onUpdateState = function () {};
1972  *     toolFactory.register( SettingsTool );
1973  *     // Register two more tools, nothing interesting here
1974  *     function StuffTool() {
1975  *         StuffTool.parent.apply( this, arguments );
1976  *     }
1977  *     OO.inheritClass( StuffTool, OO.ui.Tool );
1978  *     StuffTool.static.name = 'stuff';
1979  *     StuffTool.static.icon = 'search';
1980  *     StuffTool.static.title = 'Change the world';
1981  *     StuffTool.prototype.onSelect = function () {
1982  *         this.setActive( false );
1983  *     };
1984  *     StuffTool.prototype.onUpdateState = function () {};
1985  *     toolFactory.register( StuffTool );
1986  *     toolbar.setup( [
1987  *         {
1988  *             // Configurations for list toolgroup.
1989  *             type: 'list',
1990  *             label: 'ListToolGroup',
1991  *             indicator: 'down',
1992  *             icon: 'ellipsis',
1993  *             title: 'This is the title, displayed when user moves the mouse over the list toolgroup',
1994  *             header: 'This is the header',
1995  *             include: [ 'settings', 'stuff' ],
1996  *             allowCollapse: ['stuff']
1997  *         }
1998  *     ] );
1999  *
2000  *     // Create some UI around the toolbar and place it in the document
2001  *     var frame = new OO.ui.PanelLayout( {
2002  *         expanded: false,
2003  *         framed: true
2004  *     } );
2005  *     frame.$element.append(
2006  *         toolbar.$element
2007  *     );
2008  *     $( 'body' ).append( frame.$element );
2009  *     // Build the toolbar. This must be done after the toolbar has been appended to the document.
2010  *     toolbar.initialize();
2011  *
2012  * For more information about toolbars in general, please see the [OOjs UI documentation on MediaWiki][1].
2013  *
2014  * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Toolbars
2015  *
2016  * @class
2017  * @extends OO.ui.PopupToolGroup
2018  *
2019  * @constructor
2020  * @param {OO.ui.Toolbar} toolbar
2021  * @param {Object} [config] Configuration options
2022  * @cfg {Array} [allowCollapse] Allow the specified tools to be collapsed. By default, collapsible tools
2023  *  will only be displayed if users click the ‘More’ option displayed at the bottom of the list. If
2024  *  the list is expanded, a ‘Fewer’ option permits users to collapse the list again. Any tools that
2025  *  are included in the toolgroup, but are not designated as collapsible, will always be displayed.
2026  *  To open a collapsible list in its expanded state, set #expanded to 'true'.
2027  * @cfg {Array} [forceExpand] Expand the specified tools. All other tools will be designated as collapsible.
2028  *  Unless #expanded is set to true, the collapsible tools will be collapsed when the list is first opened.
2029  * @cfg {boolean} [expanded=false] Expand collapsible tools. This config is only relevant if tools have
2030  *  been designated as collapsible. When expanded is set to true, all tools in the group will be displayed
2031  *  when the list is first opened. Users can collapse the list with a ‘Fewer’ option at the bottom.
2032  */
2033 OO.ui.ListToolGroup = function OoUiListToolGroup( toolbar, config ) {
2034         // Allow passing positional parameters inside the config object
2035         if ( OO.isPlainObject( toolbar ) && config === undefined ) {
2036                 config = toolbar;
2037                 toolbar = config.toolbar;
2038         }
2039
2040         // Configuration initialization
2041         config = config || {};
2042
2043         // Properties (must be set before parent constructor, which calls #populate)
2044         this.allowCollapse = config.allowCollapse;
2045         this.forceExpand = config.forceExpand;
2046         this.expanded = config.expanded !== undefined ? config.expanded : false;
2047         this.collapsibleTools = [];
2048
2049         // Parent constructor
2050         OO.ui.ListToolGroup.parent.call( this, toolbar, config );
2051
2052         // Initialization
2053         this.$element.addClass( 'oo-ui-listToolGroup' );
2054 };
2055
2056 /* Setup */
2057
2058 OO.inheritClass( OO.ui.ListToolGroup, OO.ui.PopupToolGroup );
2059
2060 /* Static Properties */
2061
2062 OO.ui.ListToolGroup.static.name = 'list';
2063
2064 /* Methods */
2065
2066 /**
2067  * @inheritdoc
2068  */
2069 OO.ui.ListToolGroup.prototype.populate = function () {
2070         var i, len, allowCollapse = [];
2071
2072         OO.ui.ListToolGroup.parent.prototype.populate.call( this );
2073
2074         // Update the list of collapsible tools
2075         if ( this.allowCollapse !== undefined ) {
2076                 allowCollapse = this.allowCollapse;
2077         } else if ( this.forceExpand !== undefined ) {
2078                 allowCollapse = OO.simpleArrayDifference( Object.keys( this.tools ), this.forceExpand );
2079         }
2080
2081         this.collapsibleTools = [];
2082         for ( i = 0, len = allowCollapse.length; i < len; i++ ) {
2083                 if ( this.tools[ allowCollapse[ i ] ] !== undefined ) {
2084                         this.collapsibleTools.push( this.tools[ allowCollapse[ i ] ] );
2085                 }
2086         }
2087
2088         // Keep at the end, even when tools are added
2089         this.$group.append( this.getExpandCollapseTool().$element );
2090
2091         this.getExpandCollapseTool().toggle( this.collapsibleTools.length !== 0 );
2092         this.updateCollapsibleState();
2093 };
2094
2095 OO.ui.ListToolGroup.prototype.getExpandCollapseTool = function () {
2096         var ExpandCollapseTool;
2097         if ( this.expandCollapseTool === undefined ) {
2098                 ExpandCollapseTool = function () {
2099                         ExpandCollapseTool.parent.apply( this, arguments );
2100                 };
2101
2102                 OO.inheritClass( ExpandCollapseTool, OO.ui.Tool );
2103
2104                 ExpandCollapseTool.prototype.onSelect = function () {
2105                         this.toolGroup.expanded = !this.toolGroup.expanded;
2106                         this.toolGroup.updateCollapsibleState();
2107                         this.setActive( false );
2108                 };
2109                 ExpandCollapseTool.prototype.onUpdateState = function () {
2110                         // Do nothing. Tool interface requires an implementation of this function.
2111                 };
2112
2113                 ExpandCollapseTool.static.name = 'more-fewer';
2114
2115                 this.expandCollapseTool = new ExpandCollapseTool( this );
2116         }
2117         return this.expandCollapseTool;
2118 };
2119
2120 /**
2121  * @inheritdoc
2122  */
2123 OO.ui.ListToolGroup.prototype.onMouseKeyUp = function ( e ) {
2124         // Do not close the popup when the user wants to show more/fewer tools
2125         if (
2126                 $( e.target ).closest( '.oo-ui-tool-name-more-fewer' ).length &&
2127                 ( e.which === OO.ui.MouseButtons.LEFT || e.which === OO.ui.Keys.SPACE || e.which === OO.ui.Keys.ENTER )
2128         ) {
2129                 // HACK: Prevent the popup list from being hidden. Skip the PopupToolGroup implementation (which
2130                 // hides the popup list when a tool is selected) and call ToolGroup's implementation directly.
2131                 return OO.ui.ListToolGroup.parent.parent.prototype.onMouseKeyUp.call( this, e );
2132         } else {
2133                 return OO.ui.ListToolGroup.parent.prototype.onMouseKeyUp.call( this, e );
2134         }
2135 };
2136
2137 OO.ui.ListToolGroup.prototype.updateCollapsibleState = function () {
2138         var i, len;
2139
2140         this.getExpandCollapseTool()
2141                 .setIcon( this.expanded ? 'collapse' : 'expand' )
2142                 .setTitle( OO.ui.msg( this.expanded ? 'ooui-toolgroup-collapse' : 'ooui-toolgroup-expand' ) );
2143
2144         for ( i = 0, len = this.collapsibleTools.length; i < len; i++ ) {
2145                 this.collapsibleTools[ i ].toggle( this.expanded );
2146         }
2147 };
2148
2149 /**
2150  * MenuToolGroups are one of three types of {@link OO.ui.ToolGroup toolgroups} that are used to
2151  * create {@link OO.ui.Toolbar toolbars} (the other types of groups are {@link OO.ui.BarToolGroup BarToolGroup}
2152  * and {@link OO.ui.ListToolGroup ListToolGroup}). MenuToolGroups contain selectable {@link OO.ui.Tool tools},
2153  * which are displayed by label in a dropdown menu. The tool's title is used as the label text, and the
2154  * menu label is updated to reflect which tool or tools are currently selected. If no tools are selected,
2155  * the menu label is empty. The menu can be configured with an indicator, icon, title, and/or header.
2156  *
2157  * MenuToolGroups are created by a {@link OO.ui.ToolGroupFactory tool group factory} when the toolbar
2158  * is set up.
2159  *
2160  *     @example
2161  *     // Example of a MenuToolGroup
2162  *     var toolFactory = new OO.ui.ToolFactory();
2163  *     var toolGroupFactory = new OO.ui.ToolGroupFactory();
2164  *     var toolbar = new OO.ui.Toolbar( toolFactory, toolGroupFactory );
2165  *
2166  *     // We will be placing status text in this element when tools are used
2167  *     var $area = $( '<p>' ).text( 'An example of a MenuToolGroup. Select a tool from the dropdown menu.' );
2168  *
2169  *     // Define the tools that we're going to place in our toolbar
2170  *
2171  *     function SettingsTool() {
2172  *         SettingsTool.parent.apply( this, arguments );
2173  *         this.reallyActive = false;
2174  *     }
2175  *     OO.inheritClass( SettingsTool, OO.ui.Tool );
2176  *     SettingsTool.static.name = 'settings';
2177  *     SettingsTool.static.icon = 'settings';
2178  *     SettingsTool.static.title = 'Change settings';
2179  *     SettingsTool.prototype.onSelect = function () {
2180  *         $area.text( 'Settings tool clicked!' );
2181  *         // Toggle the active state on each click
2182  *         this.reallyActive = !this.reallyActive;
2183  *         this.setActive( this.reallyActive );
2184  *         // To update the menu label
2185  *         this.toolbar.emit( 'updateState' );
2186  *     };
2187  *     SettingsTool.prototype.onUpdateState = function () {};
2188  *     toolFactory.register( SettingsTool );
2189  *
2190  *     function StuffTool() {
2191  *         StuffTool.parent.apply( this, arguments );
2192  *         this.reallyActive = false;
2193  *     }
2194  *     OO.inheritClass( StuffTool, OO.ui.Tool );
2195  *     StuffTool.static.name = 'stuff';
2196  *     StuffTool.static.icon = 'ellipsis';
2197  *     StuffTool.static.title = 'More stuff';
2198  *     StuffTool.prototype.onSelect = function () {
2199  *         $area.text( 'More stuff tool clicked!' );
2200  *         // Toggle the active state on each click
2201  *         this.reallyActive = !this.reallyActive;
2202  *         this.setActive( this.reallyActive );
2203  *         // To update the menu label
2204  *         this.toolbar.emit( 'updateState' );
2205  *     };
2206  *     StuffTool.prototype.onUpdateState = function () {};
2207  *     toolFactory.register( StuffTool );
2208  *
2209  *     // Finally define which tools and in what order appear in the toolbar. Each tool may only be
2210  *     // used once (but not all defined tools must be used).
2211  *     toolbar.setup( [
2212  *         {
2213  *             type: 'menu',
2214  *             header: 'This is the (optional) header',
2215  *             title: 'This is the (optional) title',
2216  *             indicator: 'down',
2217  *             include: [ 'settings', 'stuff' ]
2218  *         }
2219  *     ] );
2220  *
2221  *     // Create some UI around the toolbar and place it in the document
2222  *     var frame = new OO.ui.PanelLayout( {
2223  *         expanded: false,
2224  *         framed: true
2225  *     } );
2226  *     var contentFrame = new OO.ui.PanelLayout( {
2227  *         expanded: false,
2228  *         padded: true
2229  *     } );
2230  *     frame.$element.append(
2231  *         toolbar.$element,
2232  *         contentFrame.$element.append( $area )
2233  *     );
2234  *     $( 'body' ).append( frame.$element );
2235  *
2236  *     // Here is where the toolbar is actually built. This must be done after inserting it into the
2237  *     // document.
2238  *     toolbar.initialize();
2239  *     toolbar.emit( 'updateState' );
2240  *
2241  * For more information about how to add tools to a MenuToolGroup, please see {@link OO.ui.ToolGroup toolgroup}.
2242  * For more information about toolbars in general, please see the [OOjs UI documentation on MediaWiki] [1].
2243  *
2244  * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Toolbars
2245  *
2246  * @class
2247  * @extends OO.ui.PopupToolGroup
2248  *
2249  * @constructor
2250  * @param {OO.ui.Toolbar} toolbar
2251  * @param {Object} [config] Configuration options
2252  */
2253 OO.ui.MenuToolGroup = function OoUiMenuToolGroup( toolbar, config ) {
2254         // Allow passing positional parameters inside the config object
2255         if ( OO.isPlainObject( toolbar ) && config === undefined ) {
2256                 config = toolbar;
2257                 toolbar = config.toolbar;
2258         }
2259
2260         // Configuration initialization
2261         config = config || {};
2262
2263         // Parent constructor
2264         OO.ui.MenuToolGroup.parent.call( this, toolbar, config );
2265
2266         // Events
2267         this.toolbar.connect( this, { updateState: 'onUpdateState' } );
2268
2269         // Initialization
2270         this.$element.addClass( 'oo-ui-menuToolGroup' );
2271 };
2272
2273 /* Setup */
2274
2275 OO.inheritClass( OO.ui.MenuToolGroup, OO.ui.PopupToolGroup );
2276
2277 /* Static Properties */
2278
2279 OO.ui.MenuToolGroup.static.name = 'menu';
2280
2281 /* Methods */
2282
2283 /**
2284  * Handle the toolbar state being updated.
2285  *
2286  * When the state changes, the title of each active item in the menu will be joined together and
2287  * used as a label for the group. The label will be empty if none of the items are active.
2288  *
2289  * @private
2290  */
2291 OO.ui.MenuToolGroup.prototype.onUpdateState = function () {
2292         var name,
2293                 labelTexts = [];
2294
2295         for ( name in this.tools ) {
2296                 if ( this.tools[ name ].isActive() ) {
2297                         labelTexts.push( this.tools[ name ].getTitle() );
2298                 }
2299         }
2300
2301         this.setLabel( labelTexts.join( ', ' ) || ' ' );
2302 };
2303
2304 }( OO ) );