3 * https://www.mediawiki.org/wiki/OOjs_UI
5 * Copyright 2011–2017 OOjs UI Team and other contributors.
6 * Released under the MIT license
7 * http://oojs.mit-license.org
9 * Date: 2017-04-18T23:32:49Z
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.
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.
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.
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}.
36 * The following is an example of a basic toolbar.
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 );
45 * // We will be placing status text in this element when tools are used
46 * var $area = $( '<p>' ).text( 'Toolbar example' );
48 * // Define the tools that we're going to place in our toolbar
50 * // Create a class inheriting from OO.ui.Tool
51 * function SearchTool() {
52 * SearchTool.parent.apply( this, arguments );
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 );
66 * SearchTool.prototype.onUpdateState = function () {};
67 * // Make this tool available in our toolFactory and thus our toolbar
68 * toolFactory.register( SearchTool );
70 * // Register two more tools, nothing interesting here
71 * function SettingsTool() {
72 * SettingsTool.parent.apply( this, arguments );
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 );
82 * SettingsTool.prototype.onUpdateState = function () {};
83 * toolFactory.register( SettingsTool );
85 * // Register two more tools, nothing interesting here
86 * function StuffTool() {
87 * StuffTool.parent.apply( this, arguments );
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 );
97 * StuffTool.prototype.onUpdateState = function () {};
98 * toolFactory.register( StuffTool );
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: {
108 * this.popup.$body.append( '<p>I am helpful!</p>' );
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 );
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).
120 * // 'bar' tool groups display tools' icons only, side-by-side.
122 * include: [ 'search', 'help' ]
125 * // 'list' tool groups display both the titles and icons, in a dropdown list.
129 * include: [ 'settings', 'stuff' ]
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.)
136 * // Create some UI around the toolbar and place it in the document
137 * var frame = new OO.ui.PanelLayout( {
141 * var contentFrame = new OO.ui.PanelLayout( {
145 * frame.$element.append(
147 * contentFrame.$element.append( $area )
149 * $( 'body' ).append( frame.$element );
151 * // Here is where the toolbar is actually built. This must be done after inserting it into the
153 * toolbar.initialize();
154 * toolbar.emit( 'updateState' );
156 * The following example extends the previous one to illustrate 'menu' toolgroups and the usage of
157 * {@link #event-updateState 'updateState' event}.
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 );
165 * // We will be placing status text in this element when tools are used
166 * var $area = $( '<p>' ).text( 'Toolbar example' );
168 * // Define the tools that we're going to place in our toolbar
170 * // Create a class inheriting from OO.ui.Tool
171 * function SearchTool() {
172 * SearchTool.parent.apply( this, arguments );
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 );
186 * SearchTool.prototype.onUpdateState = function () {};
187 * // Make this tool available in our toolFactory and thus our toolbar
188 * toolFactory.register( SearchTool );
190 * // Register two more tools, nothing interesting here
191 * function SettingsTool() {
192 * SettingsTool.parent.apply( this, arguments );
193 * this.reallyActive = false;
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' );
207 * SettingsTool.prototype.onUpdateState = function () {};
208 * toolFactory.register( SettingsTool );
210 * // Register two more tools, nothing interesting here
211 * function StuffTool() {
212 * StuffTool.parent.apply( this, arguments );
213 * this.reallyActive = false;
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' );
227 * StuffTool.prototype.onUpdateState = function () {};
228 * toolFactory.register( StuffTool );
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: {
238 * this.popup.$body.append( '<p>I am helpful!</p>' );
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 );
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).
250 * // 'bar' tool groups display tools' icons only, side-by-side.
252 * include: [ 'search', 'help' ]
255 * // 'menu' tool groups display both the titles and icons, in a dropdown menu.
256 * // Menu label indicates which items are selected.
259 * include: [ 'settings', 'stuff' ]
263 * // Create some UI around the toolbar and place it in the document
264 * var frame = new OO.ui.PanelLayout( {
268 * var contentFrame = new OO.ui.PanelLayout( {
272 * frame.$element.append(
274 * contentFrame.$element.append( $area )
276 * $( 'body' ).append( frame.$element );
278 * // Here is where the toolbar is actually built. This must be done after inserting it into the
280 * toolbar.initialize();
281 * toolbar.emit( 'updateState' );
284 * @extends OO.ui.Element
285 * @mixins OO.EventEmitter
286 * @mixins OO.ui.mixin.GroupElement
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
295 * @cfg {string} [position='top'] Whether the toolbar is positioned above ('top') or below ('bottom') content.
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
;
305 // Configuration initialization
306 config
= config
|| {};
308 // Parent constructor
309 OO
.ui
.Toolbar
.parent
.call( this, config
);
311 // Mixin constructors
312 OO
.EventEmitter
.call( this );
313 OO
.ui
.mixin
.GroupElement
.call( this, config
);
316 this.toolFactory
= toolFactory
;
317 this.toolGroupFactory
= toolGroupFactory
;
320 this.position
= config
.position
|| 'top';
321 this.$bar
= $( '<div>' );
322 this.$actions
= $( '<div>' );
323 this.initialized
= false;
324 this.narrowThreshold
= null;
325 this.onWindowResizeHandler
= this.onWindowResize
.bind( this );
329 .add( this.$bar
).add( this.$group
).add( this.$actions
)
330 .on( 'mousedown keydown', this.onPointerDown
.bind( this ) );
333 this.$group
.addClass( 'oo-ui-toolbar-tools' );
334 if ( config
.actions
) {
335 this.$bar
.append( this.$actions
.addClass( 'oo-ui-toolbar-actions' ) );
338 .addClass( 'oo-ui-toolbar-bar' )
339 .append( this.$group
, '<div style="clear:both"></div>' );
340 this.$element
.addClass( 'oo-ui-toolbar oo-ui-toolbar-position-' + this.position
).append( this.$bar
);
345 OO
.inheritClass( OO
.ui
.Toolbar
, OO
.ui
.Element
);
346 OO
.mixinClass( OO
.ui
.Toolbar
, OO
.EventEmitter
);
347 OO
.mixinClass( OO
.ui
.Toolbar
, OO
.ui
.mixin
.GroupElement
);
354 * An 'updateState' event must be emitted on the Toolbar (by calling `toolbar.emit( 'updateState' )`)
355 * every time the state of the application using the toolbar changes, and an update to the state of
358 * @param {...Mixed} data Application-defined parameters
364 * Get the tool factory.
366 * @return {OO.ui.ToolFactory} Tool factory
368 OO
.ui
.Toolbar
.prototype.getToolFactory = function () {
369 return this.toolFactory
;
373 * Get the toolgroup factory.
375 * @return {OO.Factory} Toolgroup factory
377 OO
.ui
.Toolbar
.prototype.getToolGroupFactory = function () {
378 return this.toolGroupFactory
;
382 * Handles mouse down events.
385 * @param {jQuery.Event} e Mouse down event
387 OO
.ui
.Toolbar
.prototype.onPointerDown = function ( e
) {
388 var $closestWidgetToEvent
= $( e
.target
).closest( '.oo-ui-widget' ),
389 $closestWidgetToToolbar
= this.$element
.closest( '.oo-ui-widget' );
390 if ( !$closestWidgetToEvent
.length
|| $closestWidgetToEvent
[ 0 ] === $closestWidgetToToolbar
[ 0 ] ) {
396 * Handle window resize event.
399 * @param {jQuery.Event} e Window resize event
401 OO
.ui
.Toolbar
.prototype.onWindowResize = function () {
402 this.$element
.toggleClass(
403 'oo-ui-toolbar-narrow',
404 this.$bar
.width() <= this.getNarrowThreshold()
409 * Get the (lazily-computed) width threshold for applying the oo-ui-toolbar-narrow
413 * @return {number} Width threshold in pixels
415 OO
.ui
.Toolbar
.prototype.getNarrowThreshold = function () {
416 if ( this.narrowThreshold
=== null ) {
417 this.narrowThreshold
= this.$group
.width() + this.$actions
.width();
419 return this.narrowThreshold
;
423 * Sets up handles and preloads required information for the toolbar to work.
424 * This must be called after it is attached to a visible document and before doing anything else.
426 OO
.ui
.Toolbar
.prototype.initialize = function () {
427 if ( !this.initialized
) {
428 this.initialized
= true;
429 $( this.getElementWindow() ).on( 'resize', this.onWindowResizeHandler
);
430 this.onWindowResize();
435 * Set up the toolbar.
437 * The toolbar is set up with a list of toolgroup configurations that specify the type of
438 * toolgroup ({@link OO.ui.BarToolGroup bar}, {@link OO.ui.MenuToolGroup menu}, or {@link OO.ui.ListToolGroup list})
439 * to add and which tools to include, exclude, promote, or demote within that toolgroup. Please
440 * see {@link OO.ui.ToolGroup toolgroups} for more information about including tools in toolgroups.
442 * @param {Object.<string,Array>} groups List of toolgroup configurations
443 * @param {Array|string} [groups.include] Tools to include in the toolgroup
444 * @param {Array|string} [groups.exclude] Tools to exclude from the toolgroup
445 * @param {Array|string} [groups.promote] Tools to promote to the beginning of the toolgroup
446 * @param {Array|string} [groups.demote] Tools to demote to the end of the toolgroup
448 OO
.ui
.Toolbar
.prototype.setup = function ( groups
) {
449 var i
, len
, type
, group
,
453 // Cleanup previous groups
456 // Build out new groups
457 for ( i
= 0, len
= groups
.length
; i
< len
; i
++ ) {
459 if ( group
.include
=== '*' ) {
460 // Apply defaults to catch-all groups
461 if ( group
.type
=== undefined ) {
464 if ( group
.label
=== undefined ) {
465 group
.label
= OO
.ui
.msg( 'ooui-toolbar-more' );
468 // Check type has been registered
469 type
= this.getToolGroupFactory().lookup( group
.type
) ? group
.type
: defaultType
;
471 this.getToolGroupFactory().create( type
, this, group
)
474 this.addItems( items
);
478 * Remove all tools and toolgroups from the toolbar.
480 OO
.ui
.Toolbar
.prototype.reset = function () {
485 for ( i
= 0, len
= this.items
.length
; i
< len
; i
++ ) {
486 this.items
[ i
].destroy();
492 * Destroy the toolbar.
494 * Destroying the toolbar removes all event handlers and DOM elements that constitute the toolbar. Call
495 * this method whenever you are done using a toolbar.
497 OO
.ui
.Toolbar
.prototype.destroy = function () {
498 $( this.getElementWindow() ).off( 'resize', this.onWindowResizeHandler
);
500 this.$element
.remove();
504 * Check if the tool is available.
506 * Available tools are ones that have not yet been added to the toolbar.
508 * @param {string} name Symbolic name of tool
509 * @return {boolean} Tool is available
511 OO
.ui
.Toolbar
.prototype.isToolAvailable = function ( name
) {
512 return !this.tools
[ name
];
516 * Prevent tool from being used again.
518 * @param {OO.ui.Tool} tool Tool to reserve
520 OO
.ui
.Toolbar
.prototype.reserveTool = function ( tool
) {
521 this.tools
[ tool
.getName() ] = tool
;
525 * Allow tool to be used again.
527 * @param {OO.ui.Tool} tool Tool to release
529 OO
.ui
.Toolbar
.prototype.releaseTool = function ( tool
) {
530 delete this.tools
[ tool
.getName() ];
534 * Get accelerator label for tool.
536 * The OOjs UI library does not contain an accelerator system, but this is the hook for one. To
537 * use an accelerator system, subclass the toolbar and override this method, which is meant to return a label
538 * that describes the accelerator keys for the tool passed (by symbolic name) to the method.
540 * @param {string} name Symbolic name of tool
541 * @return {string|undefined} Tool accelerator label if available
543 OO
.ui
.Toolbar
.prototype.getToolAccelerator = function () {
548 * Tools, together with {@link OO.ui.ToolGroup toolgroups}, constitute {@link OO.ui.Toolbar toolbars}.
549 * Each tool is configured with a static name, title, and icon and is customized with the command to carry
550 * out when the tool is selected. Tools must also be registered with a {@link OO.ui.ToolFactory tool factory},
551 * which creates the tools on demand.
553 * Every Tool subclass must implement two methods:
555 * - {@link #onUpdateState}
556 * - {@link #onSelect}
558 * Tools are added to toolgroups ({@link OO.ui.ListToolGroup ListToolGroup},
559 * {@link OO.ui.BarToolGroup BarToolGroup}, or {@link OO.ui.MenuToolGroup MenuToolGroup}), which determine how
560 * the tool is displayed in the toolbar. See {@link OO.ui.Toolbar toolbars} for an example.
562 * For more information, please see the [OOjs UI documentation on MediaWiki][1].
563 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Toolbars
567 * @extends OO.ui.Widget
568 * @mixins OO.ui.mixin.IconElement
569 * @mixins OO.ui.mixin.FlaggedElement
570 * @mixins OO.ui.mixin.TabIndexedElement
573 * @param {OO.ui.ToolGroup} toolGroup
574 * @param {Object} [config] Configuration options
575 * @cfg {string|Function} [title] Title text or a function that returns text. If this config is omitted, the value of
576 * the {@link #static-title static title} property is used.
578 * The title is used in different ways depending on the type of toolgroup that contains the tool. The
579 * 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
580 * part of a {@link OO.ui.ListToolGroup list} or {@link OO.ui.MenuToolGroup menu} toolgroup.
582 * For bar toolgroups, a description of the accelerator key is appended to the title if an accelerator key
583 * is associated with an action by the same name as the tool and accelerator functionality has been added to the application.
584 * To add accelerator key functionality, you must subclass OO.ui.Toolbar and override the {@link OO.ui.Toolbar#getToolAccelerator getToolAccelerator} method.
586 OO
.ui
.Tool
= function OoUiTool( toolGroup
, config
) {
587 // Allow passing positional parameters inside the config object
588 if ( OO
.isPlainObject( toolGroup
) && config
=== undefined ) {
590 toolGroup
= config
.toolGroup
;
593 // Configuration initialization
594 config
= config
|| {};
596 // Parent constructor
597 OO
.ui
.Tool
.parent
.call( this, config
);
600 this.toolGroup
= toolGroup
;
601 this.toolbar
= this.toolGroup
.getToolbar();
603 this.$title
= $( '<span>' );
604 this.$accel
= $( '<span>' );
605 this.$link
= $( '<a>' );
608 // Mixin constructors
609 OO
.ui
.mixin
.IconElement
.call( this, config
);
610 OO
.ui
.mixin
.FlaggedElement
.call( this, config
);
611 OO
.ui
.mixin
.TabIndexedElement
.call( this, $.extend( {}, config
, { $tabIndexed
: this.$link
} ) );
614 this.toolbar
.connect( this, { updateState
: 'onUpdateState' } );
617 this.$title
.addClass( 'oo-ui-tool-title' );
619 .addClass( 'oo-ui-tool-accel' )
621 // This may need to be changed if the key names are ever localized,
622 // but for now they are essentially written in English
627 .addClass( 'oo-ui-tool-link' )
628 .append( this.$icon
, this.$title
, this.$accel
)
629 .attr( 'role', 'button' );
631 .data( 'oo-ui-tool', this )
633 'oo-ui-tool ' + 'oo-ui-tool-name-' +
634 this.constructor.static.name
.replace( /^([^\/]+)\/([^\/]+).*$/, '$1-$2' )
636 .toggleClass( 'oo-ui-tool-with-label', this.constructor.static.displayBothIconAndLabel
)
637 .append( this.$link
);
638 this.setTitle( config
.title
|| this.constructor.static.title
);
643 OO
.inheritClass( OO
.ui
.Tool
, OO
.ui
.Widget
);
644 OO
.mixinClass( OO
.ui
.Tool
, OO
.ui
.mixin
.IconElement
);
645 OO
.mixinClass( OO
.ui
.Tool
, OO
.ui
.mixin
.FlaggedElement
);
646 OO
.mixinClass( OO
.ui
.Tool
, OO
.ui
.mixin
.TabIndexedElement
);
648 /* Static Properties */
654 OO
.ui
.Tool
.static.tagName
= 'span';
657 * Symbolic name of tool.
659 * The symbolic name is used internally to register the tool with a {@link OO.ui.ToolFactory ToolFactory}. It can
660 * also be used when adding tools to toolgroups.
667 OO
.ui
.Tool
.static.name
= '';
670 * Symbolic name of the group.
672 * The group name is used to associate tools with each other so that they can be selected later by
673 * a {@link OO.ui.ToolGroup toolgroup}.
680 OO
.ui
.Tool
.static.group
= '';
683 * 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.
688 * @property {string|Function}
690 OO
.ui
.Tool
.static.title
= '';
693 * Display both icon and label when the tool is used in a {@link OO.ui.BarToolGroup bar} toolgroup.
694 * Normally only the icon is displayed, or only the label if no icon is given.
698 * @property {boolean}
700 OO
.ui
.Tool
.static.displayBothIconAndLabel
= false;
703 * Add tool to catch-all groups automatically.
705 * A catch-all group, which contains all tools that do not currently belong to a toolgroup,
706 * can be included in a toolgroup using the wildcard selector, an asterisk (*).
710 * @property {boolean}
712 OO
.ui
.Tool
.static.autoAddToCatchall
= true;
715 * Add tool to named groups automatically.
717 * By default, tools that are configured with a static ‘group’ property are added
718 * to that group and will be selected when the symbolic name of the group is specified (e.g., when
719 * toolgroups include tools by group name).
722 * @property {boolean}
725 OO
.ui
.Tool
.static.autoAddToGroup
= true;
728 * Check if this tool is compatible with given data.
730 * This is a stub that can be overridden to provide support for filtering tools based on an
731 * arbitrary piece of information (e.g., where the cursor is in a document). The implementation
732 * must also call this method so that the compatibility check can be performed.
736 * @param {Mixed} data Data to check
737 * @return {boolean} Tool can be used with data
739 OO
.ui
.Tool
.static.isCompatibleWith = function () {
746 * Handle the toolbar state being updated. This method is called when the
747 * {@link OO.ui.Toolbar#event-updateState 'updateState' event} is emitted on the
748 * {@link OO.ui.Toolbar Toolbar} that uses this tool, and should set the state of this tool
749 * depending on application state (usually by calling #setDisabled to enable or disable the tool,
750 * or #setActive to mark is as currently in-use or not).
752 * This is an abstract method that must be overridden in a concrete subclass.
758 OO
.ui
.Tool
.prototype.onUpdateState
= null;
761 * Handle the tool being selected. This method is called when the user triggers this tool,
762 * usually by clicking on its label/icon.
764 * This is an abstract method that must be overridden in a concrete subclass.
770 OO
.ui
.Tool
.prototype.onSelect
= null;
773 * Check if the tool is active.
775 * Tools become active when their #onSelect or #onUpdateState handlers change them to appear pressed
776 * with the #setActive method. Additional CSS is applied to the tool to reflect the active state.
778 * @return {boolean} Tool is active
780 OO
.ui
.Tool
.prototype.isActive = function () {
785 * Make the tool appear active or inactive.
787 * This method should be called within #onSelect or #onUpdateState event handlers to make the tool
788 * appear pressed or not.
790 * @param {boolean} state Make tool appear active
792 OO
.ui
.Tool
.prototype.setActive = function ( state
) {
793 this.active
= !!state
;
795 this.$element
.addClass( 'oo-ui-tool-active' );
796 this.setFlags( { progressive
: true } );
798 this.$element
.removeClass( 'oo-ui-tool-active' );
799 this.setFlags( { progressive
: false } );
804 * Set the tool #title.
806 * @param {string|Function} title Title text or a function that returns text
809 OO
.ui
.Tool
.prototype.setTitle = function ( title
) {
810 this.title
= OO
.ui
.resolveMsg( title
);
816 * Get the tool #title.
818 * @return {string} Title text
820 OO
.ui
.Tool
.prototype.getTitle = function () {
825 * Get the tool's symbolic name.
827 * @return {string} Symbolic name of tool
829 OO
.ui
.Tool
.prototype.getName = function () {
830 return this.constructor.static.name
;
836 OO
.ui
.Tool
.prototype.updateTitle = function () {
837 var titleTooltips
= this.toolGroup
.constructor.static.titleTooltips
,
838 accelTooltips
= this.toolGroup
.constructor.static.accelTooltips
,
839 accel
= this.toolbar
.getToolAccelerator( this.constructor.static.name
),
842 this.$title
.text( this.title
);
843 this.$accel
.text( accel
);
845 if ( titleTooltips
&& typeof this.title
=== 'string' && this.title
.length
) {
846 tooltipParts
.push( this.title
);
848 if ( accelTooltips
&& typeof accel
=== 'string' && accel
.length
) {
849 tooltipParts
.push( accel
);
851 if ( tooltipParts
.length
) {
852 this.$link
.attr( 'title', tooltipParts
.join( ' ' ) );
854 this.$link
.removeAttr( 'title' );
861 * Destroying the tool removes all event handlers and the tool’s DOM elements.
862 * Call this method whenever you are done using a tool.
864 OO
.ui
.Tool
.prototype.destroy = function () {
865 this.toolbar
.disconnect( this );
866 this.$element
.remove();
870 * ToolGroups are collections of {@link OO.ui.Tool tools} that are used in a {@link OO.ui.Toolbar toolbar}.
871 * The type of toolgroup ({@link OO.ui.ListToolGroup list}, {@link OO.ui.BarToolGroup bar}, or {@link OO.ui.MenuToolGroup menu})
872 * to which a tool belongs determines how the tool is arranged and displayed in the toolbar. Toolgroups
873 * themselves are created on demand with a {@link OO.ui.ToolGroupFactory toolgroup factory}.
875 * Toolgroups can contain individual tools, groups of tools, or all available tools, as specified
876 * using the `include` config option. See OO.ui.ToolFactory#extract on documentation of the format.
877 * The options `exclude`, `promote`, and `demote` support the same formats.
879 * See {@link OO.ui.Toolbar toolbars} for a full example. For more information about toolbars in general,
880 * please see the [OOjs UI documentation on MediaWiki][1].
882 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Toolbars
886 * @extends OO.ui.Widget
887 * @mixins OO.ui.mixin.GroupElement
890 * @param {OO.ui.Toolbar} toolbar
891 * @param {Object} [config] Configuration options
892 * @cfg {Array|string} [include] List of tools to include in the toolgroup, see above.
893 * @cfg {Array|string} [exclude] List of tools to exclude from the toolgroup, see above.
894 * @cfg {Array|string} [promote] List of tools to promote to the beginning of the toolgroup, see above.
895 * @cfg {Array|string} [demote] List of tools to demote to the end of the toolgroup, see above.
896 * This setting is particularly useful when tools have been added to the toolgroup
897 * en masse (e.g., via the catch-all selector).
899 OO
.ui
.ToolGroup
= function OoUiToolGroup( toolbar
, config
) {
900 // Allow passing positional parameters inside the config object
901 if ( OO
.isPlainObject( toolbar
) && config
=== undefined ) {
903 toolbar
= config
.toolbar
;
906 // Configuration initialization
907 config
= config
|| {};
909 // Parent constructor
910 OO
.ui
.ToolGroup
.parent
.call( this, config
);
912 // Mixin constructors
913 OO
.ui
.mixin
.GroupElement
.call( this, config
);
916 this.toolbar
= toolbar
;
919 this.autoDisabled
= false;
920 this.include
= config
.include
|| [];
921 this.exclude
= config
.exclude
|| [];
922 this.promote
= config
.promote
|| [];
923 this.demote
= config
.demote
|| [];
924 this.onCapturedMouseKeyUpHandler
= this.onCapturedMouseKeyUp
.bind( this );
928 mousedown
: this.onMouseKeyDown
.bind( this ),
929 mouseup
: this.onMouseKeyUp
.bind( this ),
930 keydown
: this.onMouseKeyDown
.bind( this ),
931 keyup
: this.onMouseKeyUp
.bind( this ),
932 focus
: this.onMouseOverFocus
.bind( this ),
933 blur
: this.onMouseOutBlur
.bind( this ),
934 mouseover
: this.onMouseOverFocus
.bind( this ),
935 mouseout
: this.onMouseOutBlur
.bind( this )
937 this.toolbar
.getToolFactory().connect( this, { register
: 'onToolFactoryRegister' } );
938 this.aggregate( { disable
: 'itemDisable' } );
939 this.connect( this, { itemDisable
: 'updateDisabled' } );
942 this.$group
.addClass( 'oo-ui-toolGroup-tools' );
944 .addClass( 'oo-ui-toolGroup' )
945 .append( this.$group
);
951 OO
.inheritClass( OO
.ui
.ToolGroup
, OO
.ui
.Widget
);
952 OO
.mixinClass( OO
.ui
.ToolGroup
, OO
.ui
.mixin
.GroupElement
);
960 /* Static Properties */
963 * Show labels in tooltips.
967 * @property {boolean}
969 OO
.ui
.ToolGroup
.static.titleTooltips
= false;
972 * Show acceleration labels in tooltips.
974 * Note: The OOjs UI library does not include an accelerator system, but does contain
975 * a hook for one. To use an accelerator system, subclass the {@link OO.ui.Toolbar toolbar} and
976 * override the {@link OO.ui.Toolbar#getToolAccelerator getToolAccelerator} method, which is
977 * meant to return a label that describes the accelerator keys for a given tool (e.g., 'Ctrl + M').
981 * @property {boolean}
983 OO
.ui
.ToolGroup
.static.accelTooltips
= false;
986 * Automatically disable the toolgroup when all tools are disabled
990 * @property {boolean}
992 OO
.ui
.ToolGroup
.static.autoDisable
= true;
1000 OO
.ui
.ToolGroup
.static.name
= null;
1007 OO
.ui
.ToolGroup
.prototype.isDisabled = function () {
1008 return this.autoDisabled
|| OO
.ui
.ToolGroup
.parent
.prototype.isDisabled
.apply( this, arguments
);
1014 OO
.ui
.ToolGroup
.prototype.updateDisabled = function () {
1015 var i
, item
, allDisabled
= true;
1017 if ( this.constructor.static.autoDisable
) {
1018 for ( i
= this.items
.length
- 1; i
>= 0; i
-- ) {
1019 item
= this.items
[ i
];
1020 if ( !item
.isDisabled() ) {
1021 allDisabled
= false;
1025 this.autoDisabled
= allDisabled
;
1027 OO
.ui
.ToolGroup
.parent
.prototype.updateDisabled
.apply( this, arguments
);
1031 * Handle mouse down and key down events.
1034 * @param {jQuery.Event} e Mouse down or key down event
1036 OO
.ui
.ToolGroup
.prototype.onMouseKeyDown = function ( e
) {
1038 !this.isDisabled() &&
1039 ( e
.which
=== OO
.ui
.MouseButtons
.LEFT
|| e
.which
=== OO
.ui
.Keys
.SPACE
|| e
.which
=== OO
.ui
.Keys
.ENTER
)
1041 this.pressed
= this.getTargetTool( e
);
1042 if ( this.pressed
) {
1043 this.pressed
.setActive( true );
1044 this.getElementDocument().addEventListener( 'mouseup', this.onCapturedMouseKeyUpHandler
, true );
1045 this.getElementDocument().addEventListener( 'keyup', this.onCapturedMouseKeyUpHandler
, true );
1052 * Handle captured mouse up and key up events.
1055 * @param {MouseEvent|KeyboardEvent} e Mouse up or key up event
1057 OO
.ui
.ToolGroup
.prototype.onCapturedMouseKeyUp = function ( e
) {
1058 this.getElementDocument().removeEventListener( 'mouseup', this.onCapturedMouseKeyUpHandler
, true );
1059 this.getElementDocument().removeEventListener( 'keyup', this.onCapturedMouseKeyUpHandler
, true );
1060 // onMouseKeyUp may be called a second time, depending on where the mouse is when the button is
1061 // released, but since `this.pressed` will no longer be true, the second call will be ignored.
1062 this.onMouseKeyUp( e
);
1066 * Handle mouse up and key up events.
1069 * @param {MouseEvent|KeyboardEvent} e Mouse up or key up event
1071 OO
.ui
.ToolGroup
.prototype.onMouseKeyUp = function ( e
) {
1072 var tool
= this.getTargetTool( e
);
1075 !this.isDisabled() && this.pressed
&& this.pressed
=== tool
&&
1076 ( e
.which
=== OO
.ui
.MouseButtons
.LEFT
|| e
.which
=== OO
.ui
.Keys
.SPACE
|| e
.which
=== OO
.ui
.Keys
.ENTER
)
1078 this.pressed
.onSelect();
1079 this.pressed
= null;
1081 e
.stopPropagation();
1084 this.pressed
= null;
1088 * Handle mouse over and focus events.
1091 * @param {jQuery.Event} e Mouse over or focus event
1093 OO
.ui
.ToolGroup
.prototype.onMouseOverFocus = function ( e
) {
1094 var tool
= this.getTargetTool( e
);
1096 if ( this.pressed
&& this.pressed
=== tool
) {
1097 this.pressed
.setActive( true );
1102 * Handle mouse out and blur events.
1105 * @param {jQuery.Event} e Mouse out or blur event
1107 OO
.ui
.ToolGroup
.prototype.onMouseOutBlur = function ( e
) {
1108 var tool
= this.getTargetTool( e
);
1110 if ( this.pressed
&& this.pressed
=== tool
) {
1111 this.pressed
.setActive( false );
1116 * Get the closest tool to a jQuery.Event.
1118 * Only tool links are considered, which prevents other elements in the tool such as popups from
1119 * triggering tool group interactions.
1122 * @param {jQuery.Event} e
1123 * @return {OO.ui.Tool|null} Tool, `null` if none was found
1125 OO
.ui
.ToolGroup
.prototype.getTargetTool = function ( e
) {
1127 $item
= $( e
.target
).closest( '.oo-ui-tool-link' );
1129 if ( $item
.length
) {
1130 tool
= $item
.parent().data( 'oo-ui-tool' );
1133 return tool
&& !tool
.isDisabled() ? tool
: null;
1137 * Handle tool registry register events.
1139 * If a tool is registered after the group is created, we must repopulate the list to account for:
1141 * - a tool being added that may be included
1142 * - a tool already included being overridden
1145 * @param {string} name Symbolic name of tool
1147 OO
.ui
.ToolGroup
.prototype.onToolFactoryRegister = function () {
1152 * Get the toolbar that contains the toolgroup.
1154 * @return {OO.ui.Toolbar} Toolbar that contains the toolgroup
1156 OO
.ui
.ToolGroup
.prototype.getToolbar = function () {
1157 return this.toolbar
;
1161 * Add and remove tools based on configuration.
1163 OO
.ui
.ToolGroup
.prototype.populate = function () {
1164 var i
, len
, name
, tool
,
1165 toolFactory
= this.toolbar
.getToolFactory(),
1169 list
= this.toolbar
.getToolFactory().getTools(
1170 this.include
, this.exclude
, this.promote
, this.demote
1173 // Build a list of needed tools
1174 for ( i
= 0, len
= list
.length
; i
< len
; i
++ ) {
1178 toolFactory
.lookup( name
) &&
1179 // Tool is available or is already in this group
1180 ( this.toolbar
.isToolAvailable( name
) || this.tools
[ name
] )
1182 // Hack to prevent infinite recursion via ToolGroupTool. We need to reserve the tool before
1183 // creating it, but we can't call reserveTool() yet because we haven't created the tool.
1184 this.toolbar
.tools
[ name
] = true;
1185 tool
= this.tools
[ name
];
1187 // Auto-initialize tools on first use
1188 this.tools
[ name
] = tool
= toolFactory
.create( name
, this );
1191 this.toolbar
.reserveTool( tool
);
1193 names
[ name
] = true;
1196 // Remove tools that are no longer needed
1197 for ( name
in this.tools
) {
1198 if ( !names
[ name
] ) {
1199 this.tools
[ name
].destroy();
1200 this.toolbar
.releaseTool( this.tools
[ name
] );
1201 remove
.push( this.tools
[ name
] );
1202 delete this.tools
[ name
];
1205 if ( remove
.length
) {
1206 this.removeItems( remove
);
1208 // Update emptiness state
1210 this.$element
.removeClass( 'oo-ui-toolGroup-empty' );
1212 this.$element
.addClass( 'oo-ui-toolGroup-empty' );
1214 // Re-add tools (moving existing ones to new locations)
1215 this.addItems( add
);
1216 // Disabled state may depend on items
1217 this.updateDisabled();
1221 * Destroy toolgroup.
1223 OO
.ui
.ToolGroup
.prototype.destroy = function () {
1227 this.toolbar
.getToolFactory().disconnect( this );
1228 for ( name
in this.tools
) {
1229 this.toolbar
.releaseTool( this.tools
[ name
] );
1230 this.tools
[ name
].disconnect( this ).destroy();
1231 delete this.tools
[ name
];
1233 this.$element
.remove();
1237 * A ToolFactory creates tools on demand. All tools ({@link OO.ui.Tool Tools}, {@link OO.ui.PopupTool PopupTools},
1238 * and {@link OO.ui.ToolGroupTool ToolGroupTools}) must be registered with a tool factory. Tools are
1239 * registered by their symbolic name. See {@link OO.ui.Toolbar toolbars} for an example.
1241 * For more information about toolbars in general, please see the [OOjs UI documentation on MediaWiki][1].
1243 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Toolbars
1246 * @extends OO.Factory
1249 OO
.ui
.ToolFactory
= function OoUiToolFactory() {
1250 // Parent constructor
1251 OO
.ui
.ToolFactory
.parent
.call( this );
1256 OO
.inheritClass( OO
.ui
.ToolFactory
, OO
.Factory
);
1261 * Get tools from the factory
1263 * @param {Array|string} [include] Included tools, see #extract for format
1264 * @param {Array|string} [exclude] Excluded tools, see #extract for format
1265 * @param {Array|string} [promote] Promoted tools, see #extract for format
1266 * @param {Array|string} [demote] Demoted tools, see #extract for format
1267 * @return {string[]} List of tools
1269 OO
.ui
.ToolFactory
.prototype.getTools = function ( include
, exclude
, promote
, demote
) {
1270 var i
, len
, included
, promoted
, demoted
,
1274 // Collect included and not excluded tools
1275 included
= OO
.simpleArrayDifference( this.extract( include
), this.extract( exclude
) );
1278 promoted
= this.extract( promote
, used
);
1279 demoted
= this.extract( demote
, used
);
1282 for ( i
= 0, len
= included
.length
; i
< len
; i
++ ) {
1283 if ( !used
[ included
[ i
] ] ) {
1284 auto
.push( included
[ i
] );
1288 return promoted
.concat( auto
).concat( demoted
);
1292 * Get a flat list of names from a list of names or groups.
1294 * Normally, `collection` is an array of tool specifications. Tools can be specified in the
1297 * - To include an individual tool, use the symbolic name: `{ name: 'tool-name' }` or `'tool-name'`.
1298 * - To include all tools in a group, use the group name: `{ group: 'group-name' }`. (To assign the
1299 * tool to a group, use OO.ui.Tool.static.group.)
1301 * Alternatively, to include all tools that are not yet assigned to any other toolgroup, use the
1302 * catch-all selector `'*'`.
1304 * If `used` is passed, tool names that appear as properties in this object will be considered
1305 * already assigned, and will not be returned even if specified otherwise. The tool names extracted
1306 * by this function call will be added as new properties in the object.
1309 * @param {Array|string} collection List of tools, see above
1310 * @param {Object} [used] Object containing information about used tools, see above
1311 * @return {string[]} List of extracted tool names
1313 OO
.ui
.ToolFactory
.prototype.extract = function ( collection
, used
) {
1314 var i
, len
, item
, name
, tool
,
1317 collection
= !Array
.isArray( collection
) ? [ collection
] : collection
;
1319 for ( i
= 0, len
= collection
.length
; i
< len
; i
++ ) {
1320 item
= collection
[ i
];
1321 if ( item
=== '*' ) {
1322 for ( name
in this.registry
) {
1323 tool
= this.registry
[ name
];
1325 // Only add tools by group name when auto-add is enabled
1326 tool
.static.autoAddToCatchall
&&
1327 // Exclude already used tools
1328 ( !used
|| !used
[ name
] )
1332 used
[ name
] = true;
1337 // Allow plain strings as shorthand for named tools
1338 if ( typeof item
=== 'string' ) {
1339 item
= { name
: item
};
1341 if ( OO
.isPlainObject( item
) ) {
1343 for ( name
in this.registry
) {
1344 tool
= this.registry
[ name
];
1346 // Include tools with matching group
1347 tool
.static.group
=== item
.group
&&
1348 // Only add tools by group name when auto-add is enabled
1349 tool
.static.autoAddToGroup
&&
1350 // Exclude already used tools
1351 ( !used
|| !used
[ name
] )
1355 used
[ name
] = true;
1359 // Include tools with matching name and exclude already used tools
1360 } else if ( item
.name
&& ( !used
|| !used
[ item
.name
] ) ) {
1361 names
.push( item
.name
);
1363 used
[ item
.name
] = true;
1373 * ToolGroupFactories create {@link OO.ui.ToolGroup toolgroups} on demand. The toolgroup classes must
1374 * specify a symbolic name and be registered with the factory. The following classes are registered by
1377 * - {@link OO.ui.BarToolGroup BarToolGroups} (‘bar’)
1378 * - {@link OO.ui.MenuToolGroup MenuToolGroups} (‘menu’)
1379 * - {@link OO.ui.ListToolGroup ListToolGroups} (‘list’)
1381 * See {@link OO.ui.Toolbar toolbars} for an example.
1383 * For more information about toolbars in general, please see the [OOjs UI documentation on MediaWiki][1].
1385 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Toolbars
1388 * @extends OO.Factory
1391 OO
.ui
.ToolGroupFactory
= function OoUiToolGroupFactory() {
1392 var i
, l
, defaultClasses
;
1393 // Parent constructor
1394 OO
.Factory
.call( this );
1396 defaultClasses
= this.constructor.static.getDefaultClasses();
1398 // Register default toolgroups
1399 for ( i
= 0, l
= defaultClasses
.length
; i
< l
; i
++ ) {
1400 this.register( defaultClasses
[ i
] );
1406 OO
.inheritClass( OO
.ui
.ToolGroupFactory
, OO
.Factory
);
1408 /* Static Methods */
1411 * Get a default set of classes to be registered on construction.
1413 * @return {Function[]} Default classes
1415 OO
.ui
.ToolGroupFactory
.static.getDefaultClasses = function () {
1418 OO
.ui
.ListToolGroup
,
1424 * Popup tools open a popup window when they are selected from the {@link OO.ui.Toolbar toolbar}. Each popup tool is configured
1425 * 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
1426 * an #onSelect or #onUpdateState method, as these methods have been implemented already.
1428 * // Example of a popup tool. When selected, a popup tool displays
1429 * // a popup window.
1430 * function HelpTool( toolGroup, config ) {
1431 * OO.ui.PopupTool.call( this, toolGroup, $.extend( { popup: {
1436 * this.popup.$body.append( '<p>I am helpful!</p>' );
1438 * OO.inheritClass( HelpTool, OO.ui.PopupTool );
1439 * HelpTool.static.name = 'help';
1440 * HelpTool.static.icon = 'help';
1441 * HelpTool.static.title = 'Help';
1442 * toolFactory.register( HelpTool );
1444 * For an example of a toolbar that contains a popup tool, see {@link OO.ui.Toolbar toolbars}. For more information about
1445 * toolbars in genreral, please see the [OOjs UI documentation on MediaWiki][1].
1447 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Toolbars
1451 * @extends OO.ui.Tool
1452 * @mixins OO.ui.mixin.PopupElement
1455 * @param {OO.ui.ToolGroup} toolGroup
1456 * @param {Object} [config] Configuration options
1458 OO
.ui
.PopupTool
= function OoUiPopupTool( toolGroup
, config
) {
1459 // Allow passing positional parameters inside the config object
1460 if ( OO
.isPlainObject( toolGroup
) && config
=== undefined ) {
1462 toolGroup
= config
.toolGroup
;
1465 // Parent constructor
1466 OO
.ui
.PopupTool
.parent
.call( this, toolGroup
, config
);
1468 // Mixin constructors
1469 OO
.ui
.mixin
.PopupElement
.call( this, config
);
1472 this.popup
.setPosition( toolGroup
.getToolbar().position
=== 'bottom' ? 'above' : 'below' );
1474 .addClass( 'oo-ui-popupTool' )
1475 .append( this.popup
.$element
);
1480 OO
.inheritClass( OO
.ui
.PopupTool
, OO
.ui
.Tool
);
1481 OO
.mixinClass( OO
.ui
.PopupTool
, OO
.ui
.mixin
.PopupElement
);
1486 * Handle the tool being selected.
1490 OO
.ui
.PopupTool
.prototype.onSelect = function () {
1491 if ( !this.isDisabled() ) {
1492 this.popup
.toggle();
1494 this.setActive( false );
1499 * Handle the toolbar state being updated.
1503 OO
.ui
.PopupTool
.prototype.onUpdateState = function () {
1504 this.setActive( false );
1508 * A ToolGroupTool is a special sort of tool that can contain other {@link OO.ui.Tool tools}
1509 * and {@link OO.ui.ToolGroup toolgroups}. The ToolGroupTool was specifically designed to be used
1510 * inside a {@link OO.ui.BarToolGroup bar} toolgroup to provide access to additional tools from
1511 * the bar item. Included tools will be displayed in a dropdown {@link OO.ui.ListToolGroup list}
1512 * when the ToolGroupTool is selected.
1514 * // Example: ToolGroupTool with two nested tools, 'setting1' and 'setting2', defined elsewhere.
1516 * function SettingsTool() {
1517 * SettingsTool.parent.apply( this, arguments );
1519 * OO.inheritClass( SettingsTool, OO.ui.ToolGroupTool );
1520 * SettingsTool.static.name = 'settings';
1521 * SettingsTool.static.title = 'Change settings';
1522 * SettingsTool.static.groupConfig = {
1524 * label: 'ToolGroupTool',
1525 * include: [ 'setting1', 'setting2' ]
1527 * toolFactory.register( SettingsTool );
1529 * For more information, please see the [OOjs UI documentation on MediaWiki][1].
1531 * Please note that this implementation is subject to change per [T74159] [2].
1533 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Toolbars#ToolGroupTool
1534 * [2]: https://phabricator.wikimedia.org/T74159
1538 * @extends OO.ui.Tool
1541 * @param {OO.ui.ToolGroup} toolGroup
1542 * @param {Object} [config] Configuration options
1544 OO
.ui
.ToolGroupTool
= function OoUiToolGroupTool( toolGroup
, config
) {
1545 // Allow passing positional parameters inside the config object
1546 if ( OO
.isPlainObject( toolGroup
) && config
=== undefined ) {
1548 toolGroup
= config
.toolGroup
;
1551 // Parent constructor
1552 OO
.ui
.ToolGroupTool
.parent
.call( this, toolGroup
, config
);
1555 this.innerToolGroup
= this.createGroup( this.constructor.static.groupConfig
);
1558 this.innerToolGroup
.connect( this, { disable
: 'onToolGroupDisable' } );
1561 this.$link
.remove();
1563 .addClass( 'oo-ui-toolGroupTool' )
1564 .append( this.innerToolGroup
.$element
);
1569 OO
.inheritClass( OO
.ui
.ToolGroupTool
, OO
.ui
.Tool
);
1571 /* Static Properties */
1574 * Toolgroup configuration.
1576 * The toolgroup configuration consists of the tools to include, as well as an icon and label
1577 * to use for the bar item. Tools can be included by symbolic name, group, or with the
1578 * wildcard selector. Please see {@link OO.ui.ToolGroup toolgroup} for more information.
1580 * @property {Object.<string,Array>}
1582 OO
.ui
.ToolGroupTool
.static.groupConfig
= {};
1587 * Handle the tool being selected.
1591 OO
.ui
.ToolGroupTool
.prototype.onSelect = function () {
1592 this.innerToolGroup
.setActive( !this.innerToolGroup
.active
);
1597 * Synchronize disabledness state of the tool with the inner toolgroup.
1600 * @param {boolean} disabled Element is disabled
1602 OO
.ui
.ToolGroupTool
.prototype.onToolGroupDisable = function ( disabled
) {
1603 this.setDisabled( disabled
);
1607 * Handle the toolbar state being updated.
1611 OO
.ui
.ToolGroupTool
.prototype.onUpdateState = function () {
1612 this.setActive( false );
1616 * Build a {@link OO.ui.ToolGroup toolgroup} from the specified configuration.
1618 * @param {Object.<string,Array>} group Toolgroup configuration. Please see {@link OO.ui.ToolGroup toolgroup} for
1620 * @return {OO.ui.ListToolGroup}
1622 OO
.ui
.ToolGroupTool
.prototype.createGroup = function ( group
) {
1623 if ( group
.include
=== '*' ) {
1624 // Apply defaults to catch-all groups
1625 if ( group
.label
=== undefined ) {
1626 group
.label
= OO
.ui
.msg( 'ooui-toolbar-more' );
1630 return this.toolbar
.getToolGroupFactory().create( 'list', this.toolbar
, group
);
1634 * BarToolGroups are one of three types of {@link OO.ui.ToolGroup toolgroups} that are used to
1635 * create {@link OO.ui.Toolbar toolbars} (the other types of groups are {@link OO.ui.MenuToolGroup MenuToolGroup}
1636 * and {@link OO.ui.ListToolGroup ListToolGroup}). The {@link OO.ui.Tool tools} in a BarToolGroup are
1637 * displayed by icon in a single row. The title of the tool is displayed when users move the mouse over
1640 * BarToolGroups are created by a {@link OO.ui.ToolGroupFactory tool group factory} when the toolbar is
1644 * // Example of a BarToolGroup with two tools
1645 * var toolFactory = new OO.ui.ToolFactory();
1646 * var toolGroupFactory = new OO.ui.ToolGroupFactory();
1647 * var toolbar = new OO.ui.Toolbar( toolFactory, toolGroupFactory );
1649 * // We will be placing status text in this element when tools are used
1650 * var $area = $( '<p>' ).text( 'Example of a BarToolGroup with two tools.' );
1652 * // Define the tools that we're going to place in our toolbar
1654 * // Create a class inheriting from OO.ui.Tool
1655 * function SearchTool() {
1656 * SearchTool.parent.apply( this, arguments );
1658 * OO.inheritClass( SearchTool, OO.ui.Tool );
1659 * // Each tool must have a 'name' (used as an internal identifier, see later) and at least one
1660 * // of 'icon' and 'title' (displayed icon and text).
1661 * SearchTool.static.name = 'search';
1662 * SearchTool.static.icon = 'search';
1663 * SearchTool.static.title = 'Search...';
1664 * // Defines the action that will happen when this tool is selected (clicked).
1665 * SearchTool.prototype.onSelect = function () {
1666 * $area.text( 'Search tool clicked!' );
1667 * // Never display this tool as "active" (selected).
1668 * this.setActive( false );
1670 * SearchTool.prototype.onUpdateState = function () {};
1671 * // Make this tool available in our toolFactory and thus our toolbar
1672 * toolFactory.register( SearchTool );
1674 * // This is a PopupTool. Rather than having a custom 'onSelect' action, it will display a
1675 * // little popup window (a PopupWidget).
1676 * function HelpTool( toolGroup, config ) {
1677 * OO.ui.PopupTool.call( this, toolGroup, $.extend( { popup: {
1682 * this.popup.$body.append( '<p>I am helpful!</p>' );
1684 * OO.inheritClass( HelpTool, OO.ui.PopupTool );
1685 * HelpTool.static.name = 'help';
1686 * HelpTool.static.icon = 'help';
1687 * HelpTool.static.title = 'Help';
1688 * toolFactory.register( HelpTool );
1690 * // Finally define which tools and in what order appear in the toolbar. Each tool may only be
1691 * // used once (but not all defined tools must be used).
1694 * // 'bar' tool groups display tools by icon only
1696 * include: [ 'search', 'help' ]
1700 * // Create some UI around the toolbar and place it in the document
1701 * var frame = new OO.ui.PanelLayout( {
1705 * var contentFrame = new OO.ui.PanelLayout( {
1709 * frame.$element.append(
1711 * contentFrame.$element.append( $area )
1713 * $( 'body' ).append( frame.$element );
1715 * // Here is where the toolbar is actually built. This must be done after inserting it into the
1717 * toolbar.initialize();
1719 * For more information about how to add tools to a bar tool group, please see {@link OO.ui.ToolGroup toolgroup}.
1720 * For more information about toolbars in general, please see the [OOjs UI documentation on MediaWiki][1].
1722 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Toolbars
1725 * @extends OO.ui.ToolGroup
1728 * @param {OO.ui.Toolbar} toolbar
1729 * @param {Object} [config] Configuration options
1731 OO
.ui
.BarToolGroup
= function OoUiBarToolGroup( toolbar
, config
) {
1732 // Allow passing positional parameters inside the config object
1733 if ( OO
.isPlainObject( toolbar
) && config
=== undefined ) {
1735 toolbar
= config
.toolbar
;
1738 // Parent constructor
1739 OO
.ui
.BarToolGroup
.parent
.call( this, toolbar
, config
);
1742 this.$element
.addClass( 'oo-ui-barToolGroup' );
1747 OO
.inheritClass( OO
.ui
.BarToolGroup
, OO
.ui
.ToolGroup
);
1749 /* Static Properties */
1755 OO
.ui
.BarToolGroup
.static.titleTooltips
= true;
1761 OO
.ui
.BarToolGroup
.static.accelTooltips
= true;
1767 OO
.ui
.BarToolGroup
.static.name
= 'bar';
1770 * PopupToolGroup is an abstract base class used by both {@link OO.ui.MenuToolGroup MenuToolGroup}
1771 * and {@link OO.ui.ListToolGroup ListToolGroup} to provide a popup--an overlaid menu or list of tools with an
1772 * optional icon and label. This class can be used for other base classes that also use this functionality.
1776 * @extends OO.ui.ToolGroup
1777 * @mixins OO.ui.mixin.IconElement
1778 * @mixins OO.ui.mixin.IndicatorElement
1779 * @mixins OO.ui.mixin.LabelElement
1780 * @mixins OO.ui.mixin.TitledElement
1781 * @mixins OO.ui.mixin.FlaggedElement
1782 * @mixins OO.ui.mixin.ClippableElement
1783 * @mixins OO.ui.mixin.TabIndexedElement
1786 * @param {OO.ui.Toolbar} toolbar
1787 * @param {Object} [config] Configuration options
1788 * @cfg {string} [header] Text to display at the top of the popup
1790 OO
.ui
.PopupToolGroup
= function OoUiPopupToolGroup( toolbar
, config
) {
1791 // Allow passing positional parameters inside the config object
1792 if ( OO
.isPlainObject( toolbar
) && config
=== undefined ) {
1794 toolbar
= config
.toolbar
;
1797 // Configuration initialization
1798 config
= $.extend( {
1799 indicator
: config
.indicator
=== undefined ? ( toolbar
.position
=== 'bottom' ? 'up' : 'down' ) : config
.indicator
1802 // Parent constructor
1803 OO
.ui
.PopupToolGroup
.parent
.call( this, toolbar
, config
);
1806 this.active
= false;
1807 this.dragging
= false;
1808 this.onBlurHandler
= this.onBlur
.bind( this );
1809 this.$handle
= $( '<span>' );
1811 // Mixin constructors
1812 OO
.ui
.mixin
.IconElement
.call( this, config
);
1813 OO
.ui
.mixin
.IndicatorElement
.call( this, config
);
1814 OO
.ui
.mixin
.LabelElement
.call( this, config
);
1815 OO
.ui
.mixin
.TitledElement
.call( this, config
);
1816 OO
.ui
.mixin
.FlaggedElement
.call( this, config
);
1817 OO
.ui
.mixin
.ClippableElement
.call( this, $.extend( {}, config
, { $clippable
: this.$group
} ) );
1818 OO
.ui
.mixin
.TabIndexedElement
.call( this, $.extend( {}, config
, { $tabIndexed
: this.$handle
} ) );
1822 keydown
: this.onHandleMouseKeyDown
.bind( this ),
1823 keyup
: this.onHandleMouseKeyUp
.bind( this ),
1824 mousedown
: this.onHandleMouseKeyDown
.bind( this ),
1825 mouseup
: this.onHandleMouseKeyUp
.bind( this )
1830 .addClass( 'oo-ui-popupToolGroup-handle' )
1831 .attr( 'role', 'button' )
1832 .append( this.$icon
, this.$label
, this.$indicator
);
1833 // If the pop-up should have a header, add it to the top of the toolGroup.
1834 // Note: If this feature is useful for other widgets, we could abstract it into an
1835 // OO.ui.HeaderedElement mixin constructor.
1836 if ( config
.header
!== undefined ) {
1838 .prepend( $( '<span>' )
1839 .addClass( 'oo-ui-popupToolGroup-header' )
1840 .text( config
.header
)
1844 .addClass( 'oo-ui-popupToolGroup' )
1845 .prepend( this.$handle
);
1850 OO
.inheritClass( OO
.ui
.PopupToolGroup
, OO
.ui
.ToolGroup
);
1851 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.mixin
.IconElement
);
1852 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.mixin
.IndicatorElement
);
1853 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.mixin
.LabelElement
);
1854 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.mixin
.TitledElement
);
1855 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.mixin
.FlaggedElement
);
1856 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.mixin
.ClippableElement
);
1857 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.mixin
.TabIndexedElement
);
1864 OO
.ui
.PopupToolGroup
.prototype.setDisabled = function () {
1866 OO
.ui
.PopupToolGroup
.parent
.prototype.setDisabled
.apply( this, arguments
);
1868 if ( this.isDisabled() && this.isElementAttached() ) {
1869 this.setActive( false );
1874 * Handle focus being lost.
1876 * The event is actually generated from a mouseup/keyup, so it is not a normal blur event object.
1879 * @param {MouseEvent|KeyboardEvent} e Mouse up or key up event
1881 OO
.ui
.PopupToolGroup
.prototype.onBlur = function ( e
) {
1882 // Only deactivate when clicking outside the dropdown element
1883 if ( $( e
.target
).closest( '.oo-ui-popupToolGroup' )[ 0 ] !== this.$element
[ 0 ] ) {
1884 this.setActive( false );
1891 OO
.ui
.PopupToolGroup
.prototype.onMouseKeyUp = function ( e
) {
1892 // Only close toolgroup when a tool was actually selected
1894 !this.isDisabled() && this.pressed
&& this.pressed
=== this.getTargetTool( e
) &&
1895 ( e
.which
=== OO
.ui
.MouseButtons
.LEFT
|| e
.which
=== OO
.ui
.Keys
.SPACE
|| e
.which
=== OO
.ui
.Keys
.ENTER
)
1897 this.setActive( false );
1899 return OO
.ui
.PopupToolGroup
.parent
.prototype.onMouseKeyUp
.call( this, e
);
1903 * Handle mouse up and key up events.
1906 * @param {jQuery.Event} e Mouse up or key up event
1908 OO
.ui
.PopupToolGroup
.prototype.onHandleMouseKeyUp = function ( e
) {
1910 !this.isDisabled() &&
1911 ( e
.which
=== OO
.ui
.MouseButtons
.LEFT
|| e
.which
=== OO
.ui
.Keys
.SPACE
|| e
.which
=== OO
.ui
.Keys
.ENTER
)
1918 * Handle mouse down and key down events.
1921 * @param {jQuery.Event} e Mouse down or key down event
1923 OO
.ui
.PopupToolGroup
.prototype.onHandleMouseKeyDown = function ( e
) {
1925 !this.isDisabled() &&
1926 ( e
.which
=== OO
.ui
.MouseButtons
.LEFT
|| e
.which
=== OO
.ui
.Keys
.SPACE
|| e
.which
=== OO
.ui
.Keys
.ENTER
)
1928 this.setActive( !this.active
);
1934 * Switch into 'active' mode.
1936 * When active, the popup is visible. A mouseup event anywhere in the document will trigger
1939 * @param {boolean} value The active state to set
1941 OO
.ui
.PopupToolGroup
.prototype.setActive = function ( value
) {
1942 var containerWidth
, containerLeft
;
1944 if ( this.active
!== value
) {
1945 this.active
= value
;
1947 this.getElementDocument().addEventListener( 'mouseup', this.onBlurHandler
, true );
1948 this.getElementDocument().addEventListener( 'keyup', this.onBlurHandler
, true );
1950 this.$clippable
.css( 'left', '' );
1951 // Try anchoring the popup to the left first
1952 this.$element
.addClass( 'oo-ui-popupToolGroup-active oo-ui-popupToolGroup-left' );
1953 this.toggleClipping( true );
1954 if ( this.isClippedHorizontally() ) {
1955 // Anchoring to the left caused the popup to clip, so anchor it to the right instead
1956 this.toggleClipping( false );
1958 .removeClass( 'oo-ui-popupToolGroup-left' )
1959 .addClass( 'oo-ui-popupToolGroup-right' );
1960 this.toggleClipping( true );
1962 if ( this.isClippedHorizontally() ) {
1963 // Anchoring to the right also caused the popup to clip, so just make it fill the container
1964 containerWidth
= this.$clippableScrollableContainer
.width();
1965 containerLeft
= this.$clippableScrollableContainer
.offset().left
;
1967 this.toggleClipping( false );
1968 this.$element
.removeClass( 'oo-ui-popupToolGroup-right' );
1970 this.$clippable
.css( {
1971 left
: -( this.$element
.offset().left
- containerLeft
),
1972 width
: containerWidth
1976 this.getElementDocument().removeEventListener( 'mouseup', this.onBlurHandler
, true );
1977 this.getElementDocument().removeEventListener( 'keyup', this.onBlurHandler
, true );
1978 this.$element
.removeClass(
1979 'oo-ui-popupToolGroup-active oo-ui-popupToolGroup-left oo-ui-popupToolGroup-right'
1981 this.toggleClipping( false );
1987 * ListToolGroups are one of three types of {@link OO.ui.ToolGroup toolgroups} that are used to
1988 * create {@link OO.ui.Toolbar toolbars} (the other types of groups are {@link OO.ui.MenuToolGroup MenuToolGroup}
1989 * and {@link OO.ui.BarToolGroup BarToolGroup}). The {@link OO.ui.Tool tools} in a ListToolGroup are displayed
1990 * by label in a dropdown menu. The title of the tool is used as the label text. The menu itself can be configured
1991 * with a label, icon, indicator, header, and title.
1993 * ListToolGroups can be configured to be expanded and collapsed. Collapsed lists will have a ‘More’ option that
1994 * users can select to see the full list of tools. If a collapsed toolgroup is expanded, a ‘Fewer’ option permits
1995 * users to collapse the list again.
1997 * ListToolGroups are created by a {@link OO.ui.ToolGroupFactory toolgroup factory} when the toolbar is set up. The factory
1998 * requires the ListToolGroup's symbolic name, 'list', which is specified along with the other configurations. For more
1999 * information about how to add tools to a ListToolGroup, please see {@link OO.ui.ToolGroup toolgroup}.
2002 * // Example of a ListToolGroup
2003 * var toolFactory = new OO.ui.ToolFactory();
2004 * var toolGroupFactory = new OO.ui.ToolGroupFactory();
2005 * var toolbar = new OO.ui.Toolbar( toolFactory, toolGroupFactory );
2007 * // Configure and register two tools
2008 * function SettingsTool() {
2009 * SettingsTool.parent.apply( this, arguments );
2011 * OO.inheritClass( SettingsTool, OO.ui.Tool );
2012 * SettingsTool.static.name = 'settings';
2013 * SettingsTool.static.icon = 'settings';
2014 * SettingsTool.static.title = 'Change settings';
2015 * SettingsTool.prototype.onSelect = function () {
2016 * this.setActive( false );
2018 * SettingsTool.prototype.onUpdateState = function () {};
2019 * toolFactory.register( SettingsTool );
2020 * // Register two more tools, nothing interesting here
2021 * function StuffTool() {
2022 * StuffTool.parent.apply( this, arguments );
2024 * OO.inheritClass( StuffTool, OO.ui.Tool );
2025 * StuffTool.static.name = 'stuff';
2026 * StuffTool.static.icon = 'search';
2027 * StuffTool.static.title = 'Change the world';
2028 * StuffTool.prototype.onSelect = function () {
2029 * this.setActive( false );
2031 * StuffTool.prototype.onUpdateState = function () {};
2032 * toolFactory.register( StuffTool );
2035 * // Configurations for list toolgroup.
2037 * label: 'ListToolGroup',
2039 * title: 'This is the title, displayed when user moves the mouse over the list toolgroup',
2040 * header: 'This is the header',
2041 * include: [ 'settings', 'stuff' ],
2042 * allowCollapse: ['stuff']
2046 * // Create some UI around the toolbar and place it in the document
2047 * var frame = new OO.ui.PanelLayout( {
2051 * frame.$element.append(
2054 * $( 'body' ).append( frame.$element );
2055 * // Build the toolbar. This must be done after the toolbar has been appended to the document.
2056 * toolbar.initialize();
2058 * For more information about toolbars in general, please see the [OOjs UI documentation on MediaWiki][1].
2060 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Toolbars
2063 * @extends OO.ui.PopupToolGroup
2066 * @param {OO.ui.Toolbar} toolbar
2067 * @param {Object} [config] Configuration options
2068 * @cfg {Array} [allowCollapse] Allow the specified tools to be collapsed. By default, collapsible tools
2069 * will only be displayed if users click the ‘More’ option displayed at the bottom of the list. If
2070 * the list is expanded, a ‘Fewer’ option permits users to collapse the list again. Any tools that
2071 * are included in the toolgroup, but are not designated as collapsible, will always be displayed.
2072 * To open a collapsible list in its expanded state, set #expanded to 'true'.
2073 * @cfg {Array} [forceExpand] Expand the specified tools. All other tools will be designated as collapsible.
2074 * Unless #expanded is set to true, the collapsible tools will be collapsed when the list is first opened.
2075 * @cfg {boolean} [expanded=false] Expand collapsible tools. This config is only relevant if tools have
2076 * been designated as collapsible. When expanded is set to true, all tools in the group will be displayed
2077 * when the list is first opened. Users can collapse the list with a ‘Fewer’ option at the bottom.
2079 OO
.ui
.ListToolGroup
= function OoUiListToolGroup( toolbar
, config
) {
2080 // Allow passing positional parameters inside the config object
2081 if ( OO
.isPlainObject( toolbar
) && config
=== undefined ) {
2083 toolbar
= config
.toolbar
;
2086 // Configuration initialization
2087 config
= config
|| {};
2089 // Properties (must be set before parent constructor, which calls #populate)
2090 this.allowCollapse
= config
.allowCollapse
;
2091 this.forceExpand
= config
.forceExpand
;
2092 this.expanded
= config
.expanded
!== undefined ? config
.expanded
: false;
2093 this.collapsibleTools
= [];
2095 // Parent constructor
2096 OO
.ui
.ListToolGroup
.parent
.call( this, toolbar
, config
);
2099 this.$element
.addClass( 'oo-ui-listToolGroup' );
2104 OO
.inheritClass( OO
.ui
.ListToolGroup
, OO
.ui
.PopupToolGroup
);
2106 /* Static Properties */
2112 OO
.ui
.ListToolGroup
.static.name
= 'list';
2119 OO
.ui
.ListToolGroup
.prototype.populate = function () {
2120 var i
, len
, allowCollapse
= [];
2122 OO
.ui
.ListToolGroup
.parent
.prototype.populate
.call( this );
2124 // Update the list of collapsible tools
2125 if ( this.allowCollapse
!== undefined ) {
2126 allowCollapse
= this.allowCollapse
;
2127 } else if ( this.forceExpand
!== undefined ) {
2128 allowCollapse
= OO
.simpleArrayDifference( Object
.keys( this.tools
), this.forceExpand
);
2131 this.collapsibleTools
= [];
2132 for ( i
= 0, len
= allowCollapse
.length
; i
< len
; i
++ ) {
2133 if ( this.tools
[ allowCollapse
[ i
] ] !== undefined ) {
2134 this.collapsibleTools
.push( this.tools
[ allowCollapse
[ i
] ] );
2138 // Keep at the end, even when tools are added
2139 this.$group
.append( this.getExpandCollapseTool().$element
);
2141 this.getExpandCollapseTool().toggle( this.collapsibleTools
.length
!== 0 );
2142 this.updateCollapsibleState();
2146 * Get the expand/collapse tool for this group
2148 * @return {OO.ui.Tool} Expand collapse tool
2150 OO
.ui
.ListToolGroup
.prototype.getExpandCollapseTool = function () {
2151 var ExpandCollapseTool
;
2152 if ( this.expandCollapseTool
=== undefined ) {
2153 ExpandCollapseTool = function () {
2154 ExpandCollapseTool
.parent
.apply( this, arguments
);
2157 OO
.inheritClass( ExpandCollapseTool
, OO
.ui
.Tool
);
2159 ExpandCollapseTool
.prototype.onSelect = function () {
2160 this.toolGroup
.expanded
= !this.toolGroup
.expanded
;
2161 this.toolGroup
.updateCollapsibleState();
2162 this.setActive( false );
2164 ExpandCollapseTool
.prototype.onUpdateState = function () {
2165 // Do nothing. Tool interface requires an implementation of this function.
2168 ExpandCollapseTool
.static.name
= 'more-fewer';
2170 this.expandCollapseTool
= new ExpandCollapseTool( this );
2172 return this.expandCollapseTool
;
2178 OO
.ui
.ListToolGroup
.prototype.onMouseKeyUp = function ( e
) {
2179 // Do not close the popup when the user wants to show more/fewer tools
2181 $( e
.target
).closest( '.oo-ui-tool-name-more-fewer' ).length
&&
2182 ( e
.which
=== OO
.ui
.MouseButtons
.LEFT
|| e
.which
=== OO
.ui
.Keys
.SPACE
|| e
.which
=== OO
.ui
.Keys
.ENTER
)
2184 // HACK: Prevent the popup list from being hidden. Skip the PopupToolGroup implementation (which
2185 // hides the popup list when a tool is selected) and call ToolGroup's implementation directly.
2186 return OO
.ui
.ListToolGroup
.parent
.parent
.prototype.onMouseKeyUp
.call( this, e
);
2188 return OO
.ui
.ListToolGroup
.parent
.prototype.onMouseKeyUp
.call( this, e
);
2192 OO
.ui
.ListToolGroup
.prototype.updateCollapsibleState = function () {
2195 this.getExpandCollapseTool()
2196 .setIcon( this.expanded
? 'collapse' : 'expand' )
2197 .setTitle( OO
.ui
.msg( this.expanded
? 'ooui-toolgroup-collapse' : 'ooui-toolgroup-expand' ) );
2199 for ( i
= 0, len
= this.collapsibleTools
.length
; i
< len
; i
++ ) {
2200 this.collapsibleTools
[ i
].toggle( this.expanded
);
2203 // Re-evaluate clipping, because our height has changed
2208 * MenuToolGroups are one of three types of {@link OO.ui.ToolGroup toolgroups} that are used to
2209 * create {@link OO.ui.Toolbar toolbars} (the other types of groups are {@link OO.ui.BarToolGroup BarToolGroup}
2210 * and {@link OO.ui.ListToolGroup ListToolGroup}). MenuToolGroups contain selectable {@link OO.ui.Tool tools},
2211 * which are displayed by label in a dropdown menu. The tool's title is used as the label text, and the
2212 * menu label is updated to reflect which tool or tools are currently selected. If no tools are selected,
2213 * the menu label is empty. The menu can be configured with an indicator, icon, title, and/or header.
2215 * MenuToolGroups are created by a {@link OO.ui.ToolGroupFactory tool group factory} when the toolbar
2219 * // Example of a MenuToolGroup
2220 * var toolFactory = new OO.ui.ToolFactory();
2221 * var toolGroupFactory = new OO.ui.ToolGroupFactory();
2222 * var toolbar = new OO.ui.Toolbar( toolFactory, toolGroupFactory );
2224 * // We will be placing status text in this element when tools are used
2225 * var $area = $( '<p>' ).text( 'An example of a MenuToolGroup. Select a tool from the dropdown menu.' );
2227 * // Define the tools that we're going to place in our toolbar
2229 * function SettingsTool() {
2230 * SettingsTool.parent.apply( this, arguments );
2231 * this.reallyActive = false;
2233 * OO.inheritClass( SettingsTool, OO.ui.Tool );
2234 * SettingsTool.static.name = 'settings';
2235 * SettingsTool.static.icon = 'settings';
2236 * SettingsTool.static.title = 'Change settings';
2237 * SettingsTool.prototype.onSelect = function () {
2238 * $area.text( 'Settings tool clicked!' );
2239 * // Toggle the active state on each click
2240 * this.reallyActive = !this.reallyActive;
2241 * this.setActive( this.reallyActive );
2242 * // To update the menu label
2243 * this.toolbar.emit( 'updateState' );
2245 * SettingsTool.prototype.onUpdateState = function () {};
2246 * toolFactory.register( SettingsTool );
2248 * function StuffTool() {
2249 * StuffTool.parent.apply( this, arguments );
2250 * this.reallyActive = false;
2252 * OO.inheritClass( StuffTool, OO.ui.Tool );
2253 * StuffTool.static.name = 'stuff';
2254 * StuffTool.static.icon = 'ellipsis';
2255 * StuffTool.static.title = 'More stuff';
2256 * StuffTool.prototype.onSelect = function () {
2257 * $area.text( 'More stuff tool clicked!' );
2258 * // Toggle the active state on each click
2259 * this.reallyActive = !this.reallyActive;
2260 * this.setActive( this.reallyActive );
2261 * // To update the menu label
2262 * this.toolbar.emit( 'updateState' );
2264 * StuffTool.prototype.onUpdateState = function () {};
2265 * toolFactory.register( StuffTool );
2267 * // Finally define which tools and in what order appear in the toolbar. Each tool may only be
2268 * // used once (but not all defined tools must be used).
2272 * header: 'This is the (optional) header',
2273 * title: 'This is the (optional) title',
2274 * include: [ 'settings', 'stuff' ]
2278 * // Create some UI around the toolbar and place it in the document
2279 * var frame = new OO.ui.PanelLayout( {
2283 * var contentFrame = new OO.ui.PanelLayout( {
2287 * frame.$element.append(
2289 * contentFrame.$element.append( $area )
2291 * $( 'body' ).append( frame.$element );
2293 * // Here is where the toolbar is actually built. This must be done after inserting it into the
2295 * toolbar.initialize();
2296 * toolbar.emit( 'updateState' );
2298 * For more information about how to add tools to a MenuToolGroup, please see {@link OO.ui.ToolGroup toolgroup}.
2299 * For more information about toolbars in general, please see the [OOjs UI documentation on MediaWiki] [1].
2301 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Toolbars
2304 * @extends OO.ui.PopupToolGroup
2307 * @param {OO.ui.Toolbar} toolbar
2308 * @param {Object} [config] Configuration options
2310 OO
.ui
.MenuToolGroup
= function OoUiMenuToolGroup( toolbar
, config
) {
2311 // Allow passing positional parameters inside the config object
2312 if ( OO
.isPlainObject( toolbar
) && config
=== undefined ) {
2314 toolbar
= config
.toolbar
;
2317 // Configuration initialization
2318 config
= config
|| {};
2320 // Parent constructor
2321 OO
.ui
.MenuToolGroup
.parent
.call( this, toolbar
, config
);
2324 this.toolbar
.connect( this, { updateState
: 'onUpdateState' } );
2327 this.$element
.addClass( 'oo-ui-menuToolGroup' );
2332 OO
.inheritClass( OO
.ui
.MenuToolGroup
, OO
.ui
.PopupToolGroup
);
2334 /* Static Properties */
2340 OO
.ui
.MenuToolGroup
.static.name
= 'menu';
2345 * Handle the toolbar state being updated.
2347 * When the state changes, the title of each active item in the menu will be joined together and
2348 * used as a label for the group. The label will be empty if none of the items are active.
2352 OO
.ui
.MenuToolGroup
.prototype.onUpdateState = function () {
2356 for ( name
in this.tools
) {
2357 if ( this.tools
[ name
].isActive() ) {
2358 labelTexts
.push( this.tools
[ name
].getTitle() );
2362 this.setLabel( labelTexts
.join( ', ' ) || ' ' );