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-05-16T22:31:39Z
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 )
632 .addClass( 'oo-ui-tool' )
633 .addClass( 'oo-ui-tool-name-' + this.constructor.static.name
.replace( /^([^\/]+)\/([^\/]+).*$/, '$1-$2' ) )
634 .toggleClass( 'oo-ui-tool-with-label', this.constructor.static.displayBothIconAndLabel
)
635 .append( this.$link
);
636 this.setTitle( config
.title
|| this.constructor.static.title
);
641 OO
.inheritClass( OO
.ui
.Tool
, OO
.ui
.Widget
);
642 OO
.mixinClass( OO
.ui
.Tool
, OO
.ui
.mixin
.IconElement
);
643 OO
.mixinClass( OO
.ui
.Tool
, OO
.ui
.mixin
.FlaggedElement
);
644 OO
.mixinClass( OO
.ui
.Tool
, OO
.ui
.mixin
.TabIndexedElement
);
646 /* Static Properties */
652 OO
.ui
.Tool
.static.tagName
= 'span';
655 * Symbolic name of tool.
657 * The symbolic name is used internally to register the tool with a {@link OO.ui.ToolFactory ToolFactory}. It can
658 * also be used when adding tools to toolgroups.
665 OO
.ui
.Tool
.static.name
= '';
668 * Symbolic name of the group.
670 * The group name is used to associate tools with each other so that they can be selected later by
671 * a {@link OO.ui.ToolGroup toolgroup}.
678 OO
.ui
.Tool
.static.group
= '';
681 * 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.
686 * @property {string|Function}
688 OO
.ui
.Tool
.static.title
= '';
691 * Display both icon and label when the tool is used in a {@link OO.ui.BarToolGroup bar} toolgroup.
692 * Normally only the icon is displayed, or only the label if no icon is given.
696 * @property {boolean}
698 OO
.ui
.Tool
.static.displayBothIconAndLabel
= false;
701 * Add tool to catch-all groups automatically.
703 * A catch-all group, which contains all tools that do not currently belong to a toolgroup,
704 * can be included in a toolgroup using the wildcard selector, an asterisk (*).
708 * @property {boolean}
710 OO
.ui
.Tool
.static.autoAddToCatchall
= true;
713 * Add tool to named groups automatically.
715 * By default, tools that are configured with a static ‘group’ property are added
716 * to that group and will be selected when the symbolic name of the group is specified (e.g., when
717 * toolgroups include tools by group name).
720 * @property {boolean}
723 OO
.ui
.Tool
.static.autoAddToGroup
= true;
726 * Check if this tool is compatible with given data.
728 * This is a stub that can be overridden to provide support for filtering tools based on an
729 * arbitrary piece of information (e.g., where the cursor is in a document). The implementation
730 * must also call this method so that the compatibility check can be performed.
734 * @param {Mixed} data Data to check
735 * @return {boolean} Tool can be used with data
737 OO
.ui
.Tool
.static.isCompatibleWith = function () {
744 * Handle the toolbar state being updated. This method is called when the
745 * {@link OO.ui.Toolbar#event-updateState 'updateState' event} is emitted on the
746 * {@link OO.ui.Toolbar Toolbar} that uses this tool, and should set the state of this tool
747 * depending on application state (usually by calling #setDisabled to enable or disable the tool,
748 * or #setActive to mark is as currently in-use or not).
750 * This is an abstract method that must be overridden in a concrete subclass.
756 OO
.ui
.Tool
.prototype.onUpdateState
= null;
759 * Handle the tool being selected. This method is called when the user triggers this tool,
760 * usually by clicking on its label/icon.
762 * This is an abstract method that must be overridden in a concrete subclass.
768 OO
.ui
.Tool
.prototype.onSelect
= null;
771 * Check if the tool is active.
773 * Tools become active when their #onSelect or #onUpdateState handlers change them to appear pressed
774 * with the #setActive method. Additional CSS is applied to the tool to reflect the active state.
776 * @return {boolean} Tool is active
778 OO
.ui
.Tool
.prototype.isActive = function () {
783 * Make the tool appear active or inactive.
785 * This method should be called within #onSelect or #onUpdateState event handlers to make the tool
786 * appear pressed or not.
788 * @param {boolean} state Make tool appear active
790 OO
.ui
.Tool
.prototype.setActive = function ( state
) {
791 this.active
= !!state
;
793 this.$element
.addClass( 'oo-ui-tool-active' );
794 this.setFlags( { progressive
: true } );
796 this.$element
.removeClass( 'oo-ui-tool-active' );
797 this.setFlags( { progressive
: false } );
802 * Set the tool #title.
804 * @param {string|Function} title Title text or a function that returns text
807 OO
.ui
.Tool
.prototype.setTitle = function ( title
) {
808 this.title
= OO
.ui
.resolveMsg( title
);
814 * Get the tool #title.
816 * @return {string} Title text
818 OO
.ui
.Tool
.prototype.getTitle = function () {
823 * Get the tool's symbolic name.
825 * @return {string} Symbolic name of tool
827 OO
.ui
.Tool
.prototype.getName = function () {
828 return this.constructor.static.name
;
834 OO
.ui
.Tool
.prototype.updateTitle = function () {
835 var titleTooltips
= this.toolGroup
.constructor.static.titleTooltips
,
836 accelTooltips
= this.toolGroup
.constructor.static.accelTooltips
,
837 accel
= this.toolbar
.getToolAccelerator( this.constructor.static.name
),
840 this.$title
.text( this.title
);
841 this.$accel
.text( accel
);
843 if ( titleTooltips
&& typeof this.title
=== 'string' && this.title
.length
) {
844 tooltipParts
.push( this.title
);
846 if ( accelTooltips
&& typeof accel
=== 'string' && accel
.length
) {
847 tooltipParts
.push( accel
);
849 if ( tooltipParts
.length
) {
850 this.$link
.attr( 'title', tooltipParts
.join( ' ' ) );
852 this.$link
.removeAttr( 'title' );
859 * Destroying the tool removes all event handlers and the tool’s DOM elements.
860 * Call this method whenever you are done using a tool.
862 OO
.ui
.Tool
.prototype.destroy = function () {
863 this.toolbar
.disconnect( this );
864 this.$element
.remove();
868 * ToolGroups are collections of {@link OO.ui.Tool tools} that are used in a {@link OO.ui.Toolbar toolbar}.
869 * The type of toolgroup ({@link OO.ui.ListToolGroup list}, {@link OO.ui.BarToolGroup bar}, or {@link OO.ui.MenuToolGroup menu})
870 * to which a tool belongs determines how the tool is arranged and displayed in the toolbar. Toolgroups
871 * themselves are created on demand with a {@link OO.ui.ToolGroupFactory toolgroup factory}.
873 * Toolgroups can contain individual tools, groups of tools, or all available tools, as specified
874 * using the `include` config option. See OO.ui.ToolFactory#extract on documentation of the format.
875 * The options `exclude`, `promote`, and `demote` support the same formats.
877 * See {@link OO.ui.Toolbar toolbars} for a full example. For more information about toolbars in general,
878 * please see the [OOjs UI documentation on MediaWiki][1].
880 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Toolbars
884 * @extends OO.ui.Widget
885 * @mixins OO.ui.mixin.GroupElement
888 * @param {OO.ui.Toolbar} toolbar
889 * @param {Object} [config] Configuration options
890 * @cfg {Array|string} [include] List of tools to include in the toolgroup, see above.
891 * @cfg {Array|string} [exclude] List of tools to exclude from the toolgroup, see above.
892 * @cfg {Array|string} [promote] List of tools to promote to the beginning of the toolgroup, see above.
893 * @cfg {Array|string} [demote] List of tools to demote to the end of the toolgroup, see above.
894 * This setting is particularly useful when tools have been added to the toolgroup
895 * en masse (e.g., via the catch-all selector).
897 OO
.ui
.ToolGroup
= function OoUiToolGroup( toolbar
, config
) {
898 // Allow passing positional parameters inside the config object
899 if ( OO
.isPlainObject( toolbar
) && config
=== undefined ) {
901 toolbar
= config
.toolbar
;
904 // Configuration initialization
905 config
= config
|| {};
907 // Parent constructor
908 OO
.ui
.ToolGroup
.parent
.call( this, config
);
910 // Mixin constructors
911 OO
.ui
.mixin
.GroupElement
.call( this, config
);
914 this.toolbar
= toolbar
;
917 this.autoDisabled
= false;
918 this.include
= config
.include
|| [];
919 this.exclude
= config
.exclude
|| [];
920 this.promote
= config
.promote
|| [];
921 this.demote
= config
.demote
|| [];
922 this.onCapturedMouseKeyUpHandler
= this.onCapturedMouseKeyUp
.bind( this );
926 mousedown
: this.onMouseKeyDown
.bind( this ),
927 mouseup
: this.onMouseKeyUp
.bind( this ),
928 keydown
: this.onMouseKeyDown
.bind( this ),
929 keyup
: this.onMouseKeyUp
.bind( this ),
930 focus
: this.onMouseOverFocus
.bind( this ),
931 blur
: this.onMouseOutBlur
.bind( this ),
932 mouseover
: this.onMouseOverFocus
.bind( this ),
933 mouseout
: this.onMouseOutBlur
.bind( this )
935 this.toolbar
.getToolFactory().connect( this, { register
: 'onToolFactoryRegister' } );
936 this.aggregate( { disable
: 'itemDisable' } );
937 this.connect( this, { itemDisable
: 'updateDisabled' } );
940 this.$group
.addClass( 'oo-ui-toolGroup-tools' );
942 .addClass( 'oo-ui-toolGroup' )
943 .append( this.$group
);
949 OO
.inheritClass( OO
.ui
.ToolGroup
, OO
.ui
.Widget
);
950 OO
.mixinClass( OO
.ui
.ToolGroup
, OO
.ui
.mixin
.GroupElement
);
958 /* Static Properties */
961 * Show labels in tooltips.
965 * @property {boolean}
967 OO
.ui
.ToolGroup
.static.titleTooltips
= false;
970 * Show acceleration labels in tooltips.
972 * Note: The OOjs UI library does not include an accelerator system, but does contain
973 * a hook for one. To use an accelerator system, subclass the {@link OO.ui.Toolbar toolbar} and
974 * override the {@link OO.ui.Toolbar#getToolAccelerator getToolAccelerator} method, which is
975 * meant to return a label that describes the accelerator keys for a given tool (e.g., 'Ctrl + M').
979 * @property {boolean}
981 OO
.ui
.ToolGroup
.static.accelTooltips
= false;
984 * Automatically disable the toolgroup when all tools are disabled
988 * @property {boolean}
990 OO
.ui
.ToolGroup
.static.autoDisable
= true;
998 OO
.ui
.ToolGroup
.static.name
= null;
1005 OO
.ui
.ToolGroup
.prototype.isDisabled = function () {
1006 return this.autoDisabled
|| OO
.ui
.ToolGroup
.parent
.prototype.isDisabled
.apply( this, arguments
);
1012 OO
.ui
.ToolGroup
.prototype.updateDisabled = function () {
1013 var i
, item
, allDisabled
= true;
1015 if ( this.constructor.static.autoDisable
) {
1016 for ( i
= this.items
.length
- 1; i
>= 0; i
-- ) {
1017 item
= this.items
[ i
];
1018 if ( !item
.isDisabled() ) {
1019 allDisabled
= false;
1023 this.autoDisabled
= allDisabled
;
1025 OO
.ui
.ToolGroup
.parent
.prototype.updateDisabled
.apply( this, arguments
);
1029 * Handle mouse down and key down events.
1032 * @param {jQuery.Event} e Mouse down or key down event
1034 OO
.ui
.ToolGroup
.prototype.onMouseKeyDown = function ( e
) {
1036 !this.isDisabled() &&
1037 ( e
.which
=== OO
.ui
.MouseButtons
.LEFT
|| e
.which
=== OO
.ui
.Keys
.SPACE
|| e
.which
=== OO
.ui
.Keys
.ENTER
)
1039 this.pressed
= this.getTargetTool( e
);
1040 if ( this.pressed
) {
1041 this.pressed
.setActive( true );
1042 this.getElementDocument().addEventListener( 'mouseup', this.onCapturedMouseKeyUpHandler
, true );
1043 this.getElementDocument().addEventListener( 'keyup', this.onCapturedMouseKeyUpHandler
, true );
1050 * Handle captured mouse up and key up events.
1053 * @param {MouseEvent|KeyboardEvent} e Mouse up or key up event
1055 OO
.ui
.ToolGroup
.prototype.onCapturedMouseKeyUp = function ( e
) {
1056 this.getElementDocument().removeEventListener( 'mouseup', this.onCapturedMouseKeyUpHandler
, true );
1057 this.getElementDocument().removeEventListener( 'keyup', this.onCapturedMouseKeyUpHandler
, true );
1058 // onMouseKeyUp may be called a second time, depending on where the mouse is when the button is
1059 // released, but since `this.pressed` will no longer be true, the second call will be ignored.
1060 this.onMouseKeyUp( e
);
1064 * Handle mouse up and key up events.
1067 * @param {MouseEvent|KeyboardEvent} e Mouse up or key up event
1069 OO
.ui
.ToolGroup
.prototype.onMouseKeyUp = function ( e
) {
1070 var tool
= this.getTargetTool( e
);
1073 !this.isDisabled() && this.pressed
&& this.pressed
=== tool
&&
1074 ( e
.which
=== OO
.ui
.MouseButtons
.LEFT
|| e
.which
=== OO
.ui
.Keys
.SPACE
|| e
.which
=== OO
.ui
.Keys
.ENTER
)
1076 this.pressed
.onSelect();
1077 this.pressed
= null;
1079 e
.stopPropagation();
1082 this.pressed
= null;
1086 * Handle mouse over and focus events.
1089 * @param {jQuery.Event} e Mouse over or focus event
1091 OO
.ui
.ToolGroup
.prototype.onMouseOverFocus = function ( e
) {
1092 var tool
= this.getTargetTool( e
);
1094 if ( this.pressed
&& this.pressed
=== tool
) {
1095 this.pressed
.setActive( true );
1100 * Handle mouse out and blur events.
1103 * @param {jQuery.Event} e Mouse out or blur event
1105 OO
.ui
.ToolGroup
.prototype.onMouseOutBlur = function ( e
) {
1106 var tool
= this.getTargetTool( e
);
1108 if ( this.pressed
&& this.pressed
=== tool
) {
1109 this.pressed
.setActive( false );
1114 * Get the closest tool to a jQuery.Event.
1116 * Only tool links are considered, which prevents other elements in the tool such as popups from
1117 * triggering tool group interactions.
1120 * @param {jQuery.Event} e
1121 * @return {OO.ui.Tool|null} Tool, `null` if none was found
1123 OO
.ui
.ToolGroup
.prototype.getTargetTool = function ( e
) {
1125 $item
= $( e
.target
).closest( '.oo-ui-tool-link' );
1127 if ( $item
.length
) {
1128 tool
= $item
.parent().data( 'oo-ui-tool' );
1131 return tool
&& !tool
.isDisabled() ? tool
: null;
1135 * Handle tool registry register events.
1137 * If a tool is registered after the group is created, we must repopulate the list to account for:
1139 * - a tool being added that may be included
1140 * - a tool already included being overridden
1143 * @param {string} name Symbolic name of tool
1145 OO
.ui
.ToolGroup
.prototype.onToolFactoryRegister = function () {
1150 * Get the toolbar that contains the toolgroup.
1152 * @return {OO.ui.Toolbar} Toolbar that contains the toolgroup
1154 OO
.ui
.ToolGroup
.prototype.getToolbar = function () {
1155 return this.toolbar
;
1159 * Add and remove tools based on configuration.
1161 OO
.ui
.ToolGroup
.prototype.populate = function () {
1162 var i
, len
, name
, tool
,
1163 toolFactory
= this.toolbar
.getToolFactory(),
1167 list
= this.toolbar
.getToolFactory().getTools(
1168 this.include
, this.exclude
, this.promote
, this.demote
1171 // Build a list of needed tools
1172 for ( i
= 0, len
= list
.length
; i
< len
; i
++ ) {
1176 toolFactory
.lookup( name
) &&
1177 // Tool is available or is already in this group
1178 ( this.toolbar
.isToolAvailable( name
) || this.tools
[ name
] )
1180 // Hack to prevent infinite recursion via ToolGroupTool. We need to reserve the tool before
1181 // creating it, but we can't call reserveTool() yet because we haven't created the tool.
1182 this.toolbar
.tools
[ name
] = true;
1183 tool
= this.tools
[ name
];
1185 // Auto-initialize tools on first use
1186 this.tools
[ name
] = tool
= toolFactory
.create( name
, this );
1189 this.toolbar
.reserveTool( tool
);
1191 names
[ name
] = true;
1194 // Remove tools that are no longer needed
1195 for ( name
in this.tools
) {
1196 if ( !names
[ name
] ) {
1197 this.tools
[ name
].destroy();
1198 this.toolbar
.releaseTool( this.tools
[ name
] );
1199 remove
.push( this.tools
[ name
] );
1200 delete this.tools
[ name
];
1203 if ( remove
.length
) {
1204 this.removeItems( remove
);
1206 // Update emptiness state
1208 this.$element
.removeClass( 'oo-ui-toolGroup-empty' );
1210 this.$element
.addClass( 'oo-ui-toolGroup-empty' );
1212 // Re-add tools (moving existing ones to new locations)
1213 this.addItems( add
);
1214 // Disabled state may depend on items
1215 this.updateDisabled();
1219 * Destroy toolgroup.
1221 OO
.ui
.ToolGroup
.prototype.destroy = function () {
1225 this.toolbar
.getToolFactory().disconnect( this );
1226 for ( name
in this.tools
) {
1227 this.toolbar
.releaseTool( this.tools
[ name
] );
1228 this.tools
[ name
].disconnect( this ).destroy();
1229 delete this.tools
[ name
];
1231 this.$element
.remove();
1235 * A ToolFactory creates tools on demand. All tools ({@link OO.ui.Tool Tools}, {@link OO.ui.PopupTool PopupTools},
1236 * and {@link OO.ui.ToolGroupTool ToolGroupTools}) must be registered with a tool factory. Tools are
1237 * registered by their symbolic name. See {@link OO.ui.Toolbar toolbars} for an example.
1239 * For more information about toolbars in general, please see the [OOjs UI documentation on MediaWiki][1].
1241 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Toolbars
1244 * @extends OO.Factory
1247 OO
.ui
.ToolFactory
= function OoUiToolFactory() {
1248 // Parent constructor
1249 OO
.ui
.ToolFactory
.parent
.call( this );
1254 OO
.inheritClass( OO
.ui
.ToolFactory
, OO
.Factory
);
1259 * Get tools from the factory
1261 * @param {Array|string} [include] Included tools, see #extract for format
1262 * @param {Array|string} [exclude] Excluded tools, see #extract for format
1263 * @param {Array|string} [promote] Promoted tools, see #extract for format
1264 * @param {Array|string} [demote] Demoted tools, see #extract for format
1265 * @return {string[]} List of tools
1267 OO
.ui
.ToolFactory
.prototype.getTools = function ( include
, exclude
, promote
, demote
) {
1268 var i
, len
, included
, promoted
, demoted
,
1272 // Collect included and not excluded tools
1273 included
= OO
.simpleArrayDifference( this.extract( include
), this.extract( exclude
) );
1276 promoted
= this.extract( promote
, used
);
1277 demoted
= this.extract( demote
, used
);
1280 for ( i
= 0, len
= included
.length
; i
< len
; i
++ ) {
1281 if ( !used
[ included
[ i
] ] ) {
1282 auto
.push( included
[ i
] );
1286 return promoted
.concat( auto
).concat( demoted
);
1290 * Get a flat list of names from a list of names or groups.
1292 * Normally, `collection` is an array of tool specifications. Tools can be specified in the
1295 * - To include an individual tool, use the symbolic name: `{ name: 'tool-name' }` or `'tool-name'`.
1296 * - To include all tools in a group, use the group name: `{ group: 'group-name' }`. (To assign the
1297 * tool to a group, use OO.ui.Tool.static.group.)
1299 * Alternatively, to include all tools that are not yet assigned to any other toolgroup, use the
1300 * catch-all selector `'*'`.
1302 * If `used` is passed, tool names that appear as properties in this object will be considered
1303 * already assigned, and will not be returned even if specified otherwise. The tool names extracted
1304 * by this function call will be added as new properties in the object.
1307 * @param {Array|string} collection List of tools, see above
1308 * @param {Object} [used] Object containing information about used tools, see above
1309 * @return {string[]} List of extracted tool names
1311 OO
.ui
.ToolFactory
.prototype.extract = function ( collection
, used
) {
1312 var i
, len
, item
, name
, tool
,
1315 collection
= !Array
.isArray( collection
) ? [ collection
] : collection
;
1317 for ( i
= 0, len
= collection
.length
; i
< len
; i
++ ) {
1318 item
= collection
[ i
];
1319 if ( item
=== '*' ) {
1320 for ( name
in this.registry
) {
1321 tool
= this.registry
[ name
];
1323 // Only add tools by group name when auto-add is enabled
1324 tool
.static.autoAddToCatchall
&&
1325 // Exclude already used tools
1326 ( !used
|| !used
[ name
] )
1330 used
[ name
] = true;
1335 // Allow plain strings as shorthand for named tools
1336 if ( typeof item
=== 'string' ) {
1337 item
= { name
: item
};
1339 if ( OO
.isPlainObject( item
) ) {
1341 for ( name
in this.registry
) {
1342 tool
= this.registry
[ name
];
1344 // Include tools with matching group
1345 tool
.static.group
=== item
.group
&&
1346 // Only add tools by group name when auto-add is enabled
1347 tool
.static.autoAddToGroup
&&
1348 // Exclude already used tools
1349 ( !used
|| !used
[ name
] )
1353 used
[ name
] = true;
1357 // Include tools with matching name and exclude already used tools
1358 } else if ( item
.name
&& ( !used
|| !used
[ item
.name
] ) ) {
1359 names
.push( item
.name
);
1361 used
[ item
.name
] = true;
1371 * ToolGroupFactories create {@link OO.ui.ToolGroup toolgroups} on demand. The toolgroup classes must
1372 * specify a symbolic name and be registered with the factory. The following classes are registered by
1375 * - {@link OO.ui.BarToolGroup BarToolGroups} (‘bar’)
1376 * - {@link OO.ui.MenuToolGroup MenuToolGroups} (‘menu’)
1377 * - {@link OO.ui.ListToolGroup ListToolGroups} (‘list’)
1379 * See {@link OO.ui.Toolbar toolbars} for an example.
1381 * For more information about toolbars in general, please see the [OOjs UI documentation on MediaWiki][1].
1383 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Toolbars
1386 * @extends OO.Factory
1389 OO
.ui
.ToolGroupFactory
= function OoUiToolGroupFactory() {
1390 var i
, l
, defaultClasses
;
1391 // Parent constructor
1392 OO
.Factory
.call( this );
1394 defaultClasses
= this.constructor.static.getDefaultClasses();
1396 // Register default toolgroups
1397 for ( i
= 0, l
= defaultClasses
.length
; i
< l
; i
++ ) {
1398 this.register( defaultClasses
[ i
] );
1404 OO
.inheritClass( OO
.ui
.ToolGroupFactory
, OO
.Factory
);
1406 /* Static Methods */
1409 * Get a default set of classes to be registered on construction.
1411 * @return {Function[]} Default classes
1413 OO
.ui
.ToolGroupFactory
.static.getDefaultClasses = function () {
1416 OO
.ui
.ListToolGroup
,
1422 * Popup tools open a popup window when they are selected from the {@link OO.ui.Toolbar toolbar}. Each popup tool is configured
1423 * 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
1424 * an #onSelect or #onUpdateState method, as these methods have been implemented already.
1426 * // Example of a popup tool. When selected, a popup tool displays
1427 * // a popup window.
1428 * function HelpTool( toolGroup, config ) {
1429 * OO.ui.PopupTool.call( this, toolGroup, $.extend( { popup: {
1434 * this.popup.$body.append( '<p>I am helpful!</p>' );
1436 * OO.inheritClass( HelpTool, OO.ui.PopupTool );
1437 * HelpTool.static.name = 'help';
1438 * HelpTool.static.icon = 'help';
1439 * HelpTool.static.title = 'Help';
1440 * toolFactory.register( HelpTool );
1442 * For an example of a toolbar that contains a popup tool, see {@link OO.ui.Toolbar toolbars}. For more information about
1443 * toolbars in genreral, please see the [OOjs UI documentation on MediaWiki][1].
1445 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Toolbars
1449 * @extends OO.ui.Tool
1450 * @mixins OO.ui.mixin.PopupElement
1453 * @param {OO.ui.ToolGroup} toolGroup
1454 * @param {Object} [config] Configuration options
1456 OO
.ui
.PopupTool
= function OoUiPopupTool( toolGroup
, config
) {
1457 // Allow passing positional parameters inside the config object
1458 if ( OO
.isPlainObject( toolGroup
) && config
=== undefined ) {
1460 toolGroup
= config
.toolGroup
;
1463 // Parent constructor
1464 OO
.ui
.PopupTool
.parent
.call( this, toolGroup
, config
);
1466 // Mixin constructors
1467 OO
.ui
.mixin
.PopupElement
.call( this, config
);
1470 this.popup
.setPosition( toolGroup
.getToolbar().position
=== 'bottom' ? 'above' : 'below' );
1472 .addClass( 'oo-ui-popupTool' )
1473 .append( this.popup
.$element
);
1478 OO
.inheritClass( OO
.ui
.PopupTool
, OO
.ui
.Tool
);
1479 OO
.mixinClass( OO
.ui
.PopupTool
, OO
.ui
.mixin
.PopupElement
);
1484 * Handle the tool being selected.
1488 OO
.ui
.PopupTool
.prototype.onSelect = function () {
1489 if ( !this.isDisabled() ) {
1490 this.popup
.toggle();
1492 this.setActive( false );
1497 * Handle the toolbar state being updated.
1501 OO
.ui
.PopupTool
.prototype.onUpdateState = function () {
1502 this.setActive( false );
1506 * A ToolGroupTool is a special sort of tool that can contain other {@link OO.ui.Tool tools}
1507 * and {@link OO.ui.ToolGroup toolgroups}. The ToolGroupTool was specifically designed to be used
1508 * inside a {@link OO.ui.BarToolGroup bar} toolgroup to provide access to additional tools from
1509 * the bar item. Included tools will be displayed in a dropdown {@link OO.ui.ListToolGroup list}
1510 * when the ToolGroupTool is selected.
1512 * // Example: ToolGroupTool with two nested tools, 'setting1' and 'setting2', defined elsewhere.
1514 * function SettingsTool() {
1515 * SettingsTool.parent.apply( this, arguments );
1517 * OO.inheritClass( SettingsTool, OO.ui.ToolGroupTool );
1518 * SettingsTool.static.name = 'settings';
1519 * SettingsTool.static.title = 'Change settings';
1520 * SettingsTool.static.groupConfig = {
1522 * label: 'ToolGroupTool',
1523 * include: [ 'setting1', 'setting2' ]
1525 * toolFactory.register( SettingsTool );
1527 * For more information, please see the [OOjs UI documentation on MediaWiki][1].
1529 * Please note that this implementation is subject to change per [T74159] [2].
1531 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Toolbars#ToolGroupTool
1532 * [2]: https://phabricator.wikimedia.org/T74159
1536 * @extends OO.ui.Tool
1539 * @param {OO.ui.ToolGroup} toolGroup
1540 * @param {Object} [config] Configuration options
1542 OO
.ui
.ToolGroupTool
= function OoUiToolGroupTool( toolGroup
, config
) {
1543 // Allow passing positional parameters inside the config object
1544 if ( OO
.isPlainObject( toolGroup
) && config
=== undefined ) {
1546 toolGroup
= config
.toolGroup
;
1549 // Parent constructor
1550 OO
.ui
.ToolGroupTool
.parent
.call( this, toolGroup
, config
);
1553 this.innerToolGroup
= this.createGroup( this.constructor.static.groupConfig
);
1556 this.innerToolGroup
.connect( this, { disable
: 'onToolGroupDisable' } );
1559 this.$link
.remove();
1561 .addClass( 'oo-ui-toolGroupTool' )
1562 .append( this.innerToolGroup
.$element
);
1567 OO
.inheritClass( OO
.ui
.ToolGroupTool
, OO
.ui
.Tool
);
1569 /* Static Properties */
1572 * Toolgroup configuration.
1574 * The toolgroup configuration consists of the tools to include, as well as an icon and label
1575 * to use for the bar item. Tools can be included by symbolic name, group, or with the
1576 * wildcard selector. Please see {@link OO.ui.ToolGroup toolgroup} for more information.
1578 * @property {Object.<string,Array>}
1580 OO
.ui
.ToolGroupTool
.static.groupConfig
= {};
1585 * Handle the tool being selected.
1589 OO
.ui
.ToolGroupTool
.prototype.onSelect = function () {
1590 this.innerToolGroup
.setActive( !this.innerToolGroup
.active
);
1595 * Synchronize disabledness state of the tool with the inner toolgroup.
1598 * @param {boolean} disabled Element is disabled
1600 OO
.ui
.ToolGroupTool
.prototype.onToolGroupDisable = function ( disabled
) {
1601 this.setDisabled( disabled
);
1605 * Handle the toolbar state being updated.
1609 OO
.ui
.ToolGroupTool
.prototype.onUpdateState = function () {
1610 this.setActive( false );
1614 * Build a {@link OO.ui.ToolGroup toolgroup} from the specified configuration.
1616 * @param {Object.<string,Array>} group Toolgroup configuration. Please see {@link OO.ui.ToolGroup toolgroup} for
1618 * @return {OO.ui.ListToolGroup}
1620 OO
.ui
.ToolGroupTool
.prototype.createGroup = function ( group
) {
1621 if ( group
.include
=== '*' ) {
1622 // Apply defaults to catch-all groups
1623 if ( group
.label
=== undefined ) {
1624 group
.label
= OO
.ui
.msg( 'ooui-toolbar-more' );
1628 return this.toolbar
.getToolGroupFactory().create( 'list', this.toolbar
, group
);
1632 * BarToolGroups are one of three types of {@link OO.ui.ToolGroup toolgroups} that are used to
1633 * create {@link OO.ui.Toolbar toolbars} (the other types of groups are {@link OO.ui.MenuToolGroup MenuToolGroup}
1634 * and {@link OO.ui.ListToolGroup ListToolGroup}). The {@link OO.ui.Tool tools} in a BarToolGroup are
1635 * displayed by icon in a single row. The title of the tool is displayed when users move the mouse over
1638 * BarToolGroups are created by a {@link OO.ui.ToolGroupFactory tool group factory} when the toolbar is
1642 * // Example of a BarToolGroup with two tools
1643 * var toolFactory = new OO.ui.ToolFactory();
1644 * var toolGroupFactory = new OO.ui.ToolGroupFactory();
1645 * var toolbar = new OO.ui.Toolbar( toolFactory, toolGroupFactory );
1647 * // We will be placing status text in this element when tools are used
1648 * var $area = $( '<p>' ).text( 'Example of a BarToolGroup with two tools.' );
1650 * // Define the tools that we're going to place in our toolbar
1652 * // Create a class inheriting from OO.ui.Tool
1653 * function SearchTool() {
1654 * SearchTool.parent.apply( this, arguments );
1656 * OO.inheritClass( SearchTool, OO.ui.Tool );
1657 * // Each tool must have a 'name' (used as an internal identifier, see later) and at least one
1658 * // of 'icon' and 'title' (displayed icon and text).
1659 * SearchTool.static.name = 'search';
1660 * SearchTool.static.icon = 'search';
1661 * SearchTool.static.title = 'Search...';
1662 * // Defines the action that will happen when this tool is selected (clicked).
1663 * SearchTool.prototype.onSelect = function () {
1664 * $area.text( 'Search tool clicked!' );
1665 * // Never display this tool as "active" (selected).
1666 * this.setActive( false );
1668 * SearchTool.prototype.onUpdateState = function () {};
1669 * // Make this tool available in our toolFactory and thus our toolbar
1670 * toolFactory.register( SearchTool );
1672 * // This is a PopupTool. Rather than having a custom 'onSelect' action, it will display a
1673 * // little popup window (a PopupWidget).
1674 * function HelpTool( toolGroup, config ) {
1675 * OO.ui.PopupTool.call( this, toolGroup, $.extend( { popup: {
1680 * this.popup.$body.append( '<p>I am helpful!</p>' );
1682 * OO.inheritClass( HelpTool, OO.ui.PopupTool );
1683 * HelpTool.static.name = 'help';
1684 * HelpTool.static.icon = 'help';
1685 * HelpTool.static.title = 'Help';
1686 * toolFactory.register( HelpTool );
1688 * // Finally define which tools and in what order appear in the toolbar. Each tool may only be
1689 * // used once (but not all defined tools must be used).
1692 * // 'bar' tool groups display tools by icon only
1694 * include: [ 'search', 'help' ]
1698 * // Create some UI around the toolbar and place it in the document
1699 * var frame = new OO.ui.PanelLayout( {
1703 * var contentFrame = new OO.ui.PanelLayout( {
1707 * frame.$element.append(
1709 * contentFrame.$element.append( $area )
1711 * $( 'body' ).append( frame.$element );
1713 * // Here is where the toolbar is actually built. This must be done after inserting it into the
1715 * toolbar.initialize();
1717 * For more information about how to add tools to a bar tool group, please see {@link OO.ui.ToolGroup toolgroup}.
1718 * For more information about toolbars in general, please see the [OOjs UI documentation on MediaWiki][1].
1720 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Toolbars
1723 * @extends OO.ui.ToolGroup
1726 * @param {OO.ui.Toolbar} toolbar
1727 * @param {Object} [config] Configuration options
1729 OO
.ui
.BarToolGroup
= function OoUiBarToolGroup( toolbar
, config
) {
1730 // Allow passing positional parameters inside the config object
1731 if ( OO
.isPlainObject( toolbar
) && config
=== undefined ) {
1733 toolbar
= config
.toolbar
;
1736 // Parent constructor
1737 OO
.ui
.BarToolGroup
.parent
.call( this, toolbar
, config
);
1740 this.$element
.addClass( 'oo-ui-barToolGroup' );
1745 OO
.inheritClass( OO
.ui
.BarToolGroup
, OO
.ui
.ToolGroup
);
1747 /* Static Properties */
1753 OO
.ui
.BarToolGroup
.static.titleTooltips
= true;
1759 OO
.ui
.BarToolGroup
.static.accelTooltips
= true;
1765 OO
.ui
.BarToolGroup
.static.name
= 'bar';
1768 * PopupToolGroup is an abstract base class used by both {@link OO.ui.MenuToolGroup MenuToolGroup}
1769 * and {@link OO.ui.ListToolGroup ListToolGroup} to provide a popup--an overlaid menu or list of tools with an
1770 * optional icon and label. This class can be used for other base classes that also use this functionality.
1774 * @extends OO.ui.ToolGroup
1775 * @mixins OO.ui.mixin.IconElement
1776 * @mixins OO.ui.mixin.IndicatorElement
1777 * @mixins OO.ui.mixin.LabelElement
1778 * @mixins OO.ui.mixin.TitledElement
1779 * @mixins OO.ui.mixin.FlaggedElement
1780 * @mixins OO.ui.mixin.ClippableElement
1781 * @mixins OO.ui.mixin.TabIndexedElement
1784 * @param {OO.ui.Toolbar} toolbar
1785 * @param {Object} [config] Configuration options
1786 * @cfg {string} [header] Text to display at the top of the popup
1788 OO
.ui
.PopupToolGroup
= function OoUiPopupToolGroup( toolbar
, config
) {
1789 // Allow passing positional parameters inside the config object
1790 if ( OO
.isPlainObject( toolbar
) && config
=== undefined ) {
1792 toolbar
= config
.toolbar
;
1795 // Configuration initialization
1796 config
= $.extend( {
1797 indicator
: config
.indicator
=== undefined ? ( toolbar
.position
=== 'bottom' ? 'up' : 'down' ) : config
.indicator
1800 // Parent constructor
1801 OO
.ui
.PopupToolGroup
.parent
.call( this, toolbar
, config
);
1804 this.active
= false;
1805 this.dragging
= false;
1806 this.onBlurHandler
= this.onBlur
.bind( this );
1807 this.$handle
= $( '<span>' );
1809 // Mixin constructors
1810 OO
.ui
.mixin
.IconElement
.call( this, config
);
1811 OO
.ui
.mixin
.IndicatorElement
.call( this, config
);
1812 OO
.ui
.mixin
.LabelElement
.call( this, config
);
1813 OO
.ui
.mixin
.TitledElement
.call( this, config
);
1814 OO
.ui
.mixin
.FlaggedElement
.call( this, config
);
1815 OO
.ui
.mixin
.ClippableElement
.call( this, $.extend( {}, config
, { $clippable
: this.$group
} ) );
1816 OO
.ui
.mixin
.TabIndexedElement
.call( this, $.extend( {}, config
, { $tabIndexed
: this.$handle
} ) );
1820 keydown
: this.onHandleMouseKeyDown
.bind( this ),
1821 keyup
: this.onHandleMouseKeyUp
.bind( this ),
1822 mousedown
: this.onHandleMouseKeyDown
.bind( this ),
1823 mouseup
: this.onHandleMouseKeyUp
.bind( this )
1828 .addClass( 'oo-ui-popupToolGroup-handle' )
1829 .attr( 'role', 'button' )
1830 .append( this.$icon
, this.$label
, this.$indicator
);
1831 // If the pop-up should have a header, add it to the top of the toolGroup.
1832 // Note: If this feature is useful for other widgets, we could abstract it into an
1833 // OO.ui.HeaderedElement mixin constructor.
1834 if ( config
.header
!== undefined ) {
1836 .prepend( $( '<span>' )
1837 .addClass( 'oo-ui-popupToolGroup-header' )
1838 .text( config
.header
)
1842 .addClass( 'oo-ui-popupToolGroup' )
1843 .prepend( this.$handle
);
1848 OO
.inheritClass( OO
.ui
.PopupToolGroup
, OO
.ui
.ToolGroup
);
1849 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.mixin
.IconElement
);
1850 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.mixin
.IndicatorElement
);
1851 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.mixin
.LabelElement
);
1852 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.mixin
.TitledElement
);
1853 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.mixin
.FlaggedElement
);
1854 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.mixin
.ClippableElement
);
1855 OO
.mixinClass( OO
.ui
.PopupToolGroup
, OO
.ui
.mixin
.TabIndexedElement
);
1862 OO
.ui
.PopupToolGroup
.prototype.setDisabled = function () {
1864 OO
.ui
.PopupToolGroup
.parent
.prototype.setDisabled
.apply( this, arguments
);
1866 if ( this.isDisabled() && this.isElementAttached() ) {
1867 this.setActive( false );
1872 * Handle focus being lost.
1874 * The event is actually generated from a mouseup/keyup, so it is not a normal blur event object.
1877 * @param {MouseEvent|KeyboardEvent} e Mouse up or key up event
1879 OO
.ui
.PopupToolGroup
.prototype.onBlur = function ( e
) {
1880 // Only deactivate when clicking outside the dropdown element
1881 if ( $( e
.target
).closest( '.oo-ui-popupToolGroup' )[ 0 ] !== this.$element
[ 0 ] ) {
1882 this.setActive( false );
1889 OO
.ui
.PopupToolGroup
.prototype.onMouseKeyUp = function ( e
) {
1890 // Only close toolgroup when a tool was actually selected
1892 !this.isDisabled() && this.pressed
&& this.pressed
=== this.getTargetTool( e
) &&
1893 ( e
.which
=== OO
.ui
.MouseButtons
.LEFT
|| e
.which
=== OO
.ui
.Keys
.SPACE
|| e
.which
=== OO
.ui
.Keys
.ENTER
)
1895 this.setActive( false );
1897 return OO
.ui
.PopupToolGroup
.parent
.prototype.onMouseKeyUp
.call( this, e
);
1901 * Handle mouse up and key up events.
1904 * @param {jQuery.Event} e Mouse up or key up event
1906 OO
.ui
.PopupToolGroup
.prototype.onHandleMouseKeyUp = function ( e
) {
1908 !this.isDisabled() &&
1909 ( e
.which
=== OO
.ui
.MouseButtons
.LEFT
|| e
.which
=== OO
.ui
.Keys
.SPACE
|| e
.which
=== OO
.ui
.Keys
.ENTER
)
1916 * Handle mouse down and key down events.
1919 * @param {jQuery.Event} e Mouse down or key down event
1921 OO
.ui
.PopupToolGroup
.prototype.onHandleMouseKeyDown = function ( e
) {
1923 !this.isDisabled() &&
1924 ( e
.which
=== OO
.ui
.MouseButtons
.LEFT
|| e
.which
=== OO
.ui
.Keys
.SPACE
|| e
.which
=== OO
.ui
.Keys
.ENTER
)
1926 this.setActive( !this.active
);
1932 * Switch into 'active' mode.
1934 * When active, the popup is visible. A mouseup event anywhere in the document will trigger
1937 * @param {boolean} value The active state to set
1939 OO
.ui
.PopupToolGroup
.prototype.setActive = function ( value
) {
1940 var containerWidth
, containerLeft
;
1942 if ( this.active
!== value
) {
1943 this.active
= value
;
1945 this.getElementDocument().addEventListener( 'mouseup', this.onBlurHandler
, true );
1946 this.getElementDocument().addEventListener( 'keyup', this.onBlurHandler
, true );
1948 this.$clippable
.css( 'left', '' );
1949 // Try anchoring the popup to the left first
1950 this.$element
.addClass( 'oo-ui-popupToolGroup-active oo-ui-popupToolGroup-left' );
1951 this.toggleClipping( true );
1952 if ( this.isClippedHorizontally() ) {
1953 // Anchoring to the left caused the popup to clip, so anchor it to the right instead
1954 this.toggleClipping( false );
1956 .removeClass( 'oo-ui-popupToolGroup-left' )
1957 .addClass( 'oo-ui-popupToolGroup-right' );
1958 this.toggleClipping( true );
1960 if ( this.isClippedHorizontally() ) {
1961 // Anchoring to the right also caused the popup to clip, so just make it fill the container
1962 containerWidth
= this.$clippableScrollableContainer
.width();
1963 containerLeft
= this.$clippableScrollableContainer
.offset().left
;
1965 this.toggleClipping( false );
1966 this.$element
.removeClass( 'oo-ui-popupToolGroup-right' );
1968 this.$clippable
.css( {
1969 left
: -( this.$element
.offset().left
- containerLeft
),
1970 width
: containerWidth
1974 this.getElementDocument().removeEventListener( 'mouseup', this.onBlurHandler
, true );
1975 this.getElementDocument().removeEventListener( 'keyup', this.onBlurHandler
, true );
1976 this.$element
.removeClass(
1977 'oo-ui-popupToolGroup-active oo-ui-popupToolGroup-left oo-ui-popupToolGroup-right'
1979 this.toggleClipping( false );
1985 * ListToolGroups are one of three types of {@link OO.ui.ToolGroup toolgroups} that are used to
1986 * create {@link OO.ui.Toolbar toolbars} (the other types of groups are {@link OO.ui.MenuToolGroup MenuToolGroup}
1987 * and {@link OO.ui.BarToolGroup BarToolGroup}). The {@link OO.ui.Tool tools} in a ListToolGroup are displayed
1988 * by label in a dropdown menu. The title of the tool is used as the label text. The menu itself can be configured
1989 * with a label, icon, indicator, header, and title.
1991 * ListToolGroups can be configured to be expanded and collapsed. Collapsed lists will have a ‘More’ option that
1992 * users can select to see the full list of tools. If a collapsed toolgroup is expanded, a ‘Fewer’ option permits
1993 * users to collapse the list again.
1995 * ListToolGroups are created by a {@link OO.ui.ToolGroupFactory toolgroup factory} when the toolbar is set up. The factory
1996 * requires the ListToolGroup's symbolic name, 'list', which is specified along with the other configurations. For more
1997 * information about how to add tools to a ListToolGroup, please see {@link OO.ui.ToolGroup toolgroup}.
2000 * // Example of a ListToolGroup
2001 * var toolFactory = new OO.ui.ToolFactory();
2002 * var toolGroupFactory = new OO.ui.ToolGroupFactory();
2003 * var toolbar = new OO.ui.Toolbar( toolFactory, toolGroupFactory );
2005 * // Configure and register two tools
2006 * function SettingsTool() {
2007 * SettingsTool.parent.apply( this, arguments );
2009 * OO.inheritClass( SettingsTool, OO.ui.Tool );
2010 * SettingsTool.static.name = 'settings';
2011 * SettingsTool.static.icon = 'settings';
2012 * SettingsTool.static.title = 'Change settings';
2013 * SettingsTool.prototype.onSelect = function () {
2014 * this.setActive( false );
2016 * SettingsTool.prototype.onUpdateState = function () {};
2017 * toolFactory.register( SettingsTool );
2018 * // Register two more tools, nothing interesting here
2019 * function StuffTool() {
2020 * StuffTool.parent.apply( this, arguments );
2022 * OO.inheritClass( StuffTool, OO.ui.Tool );
2023 * StuffTool.static.name = 'stuff';
2024 * StuffTool.static.icon = 'search';
2025 * StuffTool.static.title = 'Change the world';
2026 * StuffTool.prototype.onSelect = function () {
2027 * this.setActive( false );
2029 * StuffTool.prototype.onUpdateState = function () {};
2030 * toolFactory.register( StuffTool );
2033 * // Configurations for list toolgroup.
2035 * label: 'ListToolGroup',
2037 * title: 'This is the title, displayed when user moves the mouse over the list toolgroup',
2038 * header: 'This is the header',
2039 * include: [ 'settings', 'stuff' ],
2040 * allowCollapse: ['stuff']
2044 * // Create some UI around the toolbar and place it in the document
2045 * var frame = new OO.ui.PanelLayout( {
2049 * frame.$element.append(
2052 * $( 'body' ).append( frame.$element );
2053 * // Build the toolbar. This must be done after the toolbar has been appended to the document.
2054 * toolbar.initialize();
2056 * For more information about toolbars in general, please see the [OOjs UI documentation on MediaWiki][1].
2058 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Toolbars
2061 * @extends OO.ui.PopupToolGroup
2064 * @param {OO.ui.Toolbar} toolbar
2065 * @param {Object} [config] Configuration options
2066 * @cfg {Array} [allowCollapse] Allow the specified tools to be collapsed. By default, collapsible tools
2067 * will only be displayed if users click the ‘More’ option displayed at the bottom of the list. If
2068 * the list is expanded, a ‘Fewer’ option permits users to collapse the list again. Any tools that
2069 * are included in the toolgroup, but are not designated as collapsible, will always be displayed.
2070 * To open a collapsible list in its expanded state, set #expanded to 'true'.
2071 * @cfg {Array} [forceExpand] Expand the specified tools. All other tools will be designated as collapsible.
2072 * Unless #expanded is set to true, the collapsible tools will be collapsed when the list is first opened.
2073 * @cfg {boolean} [expanded=false] Expand collapsible tools. This config is only relevant if tools have
2074 * been designated as collapsible. When expanded is set to true, all tools in the group will be displayed
2075 * when the list is first opened. Users can collapse the list with a ‘Fewer’ option at the bottom.
2077 OO
.ui
.ListToolGroup
= function OoUiListToolGroup( toolbar
, config
) {
2078 // Allow passing positional parameters inside the config object
2079 if ( OO
.isPlainObject( toolbar
) && config
=== undefined ) {
2081 toolbar
= config
.toolbar
;
2084 // Configuration initialization
2085 config
= config
|| {};
2087 // Properties (must be set before parent constructor, which calls #populate)
2088 this.allowCollapse
= config
.allowCollapse
;
2089 this.forceExpand
= config
.forceExpand
;
2090 this.expanded
= config
.expanded
!== undefined ? config
.expanded
: false;
2091 this.collapsibleTools
= [];
2093 // Parent constructor
2094 OO
.ui
.ListToolGroup
.parent
.call( this, toolbar
, config
);
2097 this.$element
.addClass( 'oo-ui-listToolGroup' );
2102 OO
.inheritClass( OO
.ui
.ListToolGroup
, OO
.ui
.PopupToolGroup
);
2104 /* Static Properties */
2110 OO
.ui
.ListToolGroup
.static.name
= 'list';
2117 OO
.ui
.ListToolGroup
.prototype.populate = function () {
2118 var i
, len
, allowCollapse
= [];
2120 OO
.ui
.ListToolGroup
.parent
.prototype.populate
.call( this );
2122 // Update the list of collapsible tools
2123 if ( this.allowCollapse
!== undefined ) {
2124 allowCollapse
= this.allowCollapse
;
2125 } else if ( this.forceExpand
!== undefined ) {
2126 allowCollapse
= OO
.simpleArrayDifference( Object
.keys( this.tools
), this.forceExpand
);
2129 this.collapsibleTools
= [];
2130 for ( i
= 0, len
= allowCollapse
.length
; i
< len
; i
++ ) {
2131 if ( this.tools
[ allowCollapse
[ i
] ] !== undefined ) {
2132 this.collapsibleTools
.push( this.tools
[ allowCollapse
[ i
] ] );
2136 // Keep at the end, even when tools are added
2137 this.$group
.append( this.getExpandCollapseTool().$element
);
2139 this.getExpandCollapseTool().toggle( this.collapsibleTools
.length
!== 0 );
2140 this.updateCollapsibleState();
2144 * Get the expand/collapse tool for this group
2146 * @return {OO.ui.Tool} Expand collapse tool
2148 OO
.ui
.ListToolGroup
.prototype.getExpandCollapseTool = function () {
2149 var ExpandCollapseTool
;
2150 if ( this.expandCollapseTool
=== undefined ) {
2151 ExpandCollapseTool = function () {
2152 ExpandCollapseTool
.parent
.apply( this, arguments
);
2155 OO
.inheritClass( ExpandCollapseTool
, OO
.ui
.Tool
);
2157 ExpandCollapseTool
.prototype.onSelect = function () {
2158 this.toolGroup
.expanded
= !this.toolGroup
.expanded
;
2159 this.toolGroup
.updateCollapsibleState();
2160 this.setActive( false );
2162 ExpandCollapseTool
.prototype.onUpdateState = function () {
2163 // Do nothing. Tool interface requires an implementation of this function.
2166 ExpandCollapseTool
.static.name
= 'more-fewer';
2168 this.expandCollapseTool
= new ExpandCollapseTool( this );
2170 return this.expandCollapseTool
;
2176 OO
.ui
.ListToolGroup
.prototype.onMouseKeyUp = function ( e
) {
2177 // Do not close the popup when the user wants to show more/fewer tools
2179 $( e
.target
).closest( '.oo-ui-tool-name-more-fewer' ).length
&&
2180 ( e
.which
=== OO
.ui
.MouseButtons
.LEFT
|| e
.which
=== OO
.ui
.Keys
.SPACE
|| e
.which
=== OO
.ui
.Keys
.ENTER
)
2182 // HACK: Prevent the popup list from being hidden. Skip the PopupToolGroup implementation (which
2183 // hides the popup list when a tool is selected) and call ToolGroup's implementation directly.
2184 return OO
.ui
.ListToolGroup
.parent
.parent
.prototype.onMouseKeyUp
.call( this, e
);
2186 return OO
.ui
.ListToolGroup
.parent
.prototype.onMouseKeyUp
.call( this, e
);
2190 OO
.ui
.ListToolGroup
.prototype.updateCollapsibleState = function () {
2193 this.getExpandCollapseTool()
2194 .setIcon( this.expanded
? 'collapse' : 'expand' )
2195 .setTitle( OO
.ui
.msg( this.expanded
? 'ooui-toolgroup-collapse' : 'ooui-toolgroup-expand' ) );
2197 for ( i
= 0, len
= this.collapsibleTools
.length
; i
< len
; i
++ ) {
2198 this.collapsibleTools
[ i
].toggle( this.expanded
);
2201 // Re-evaluate clipping, because our height has changed
2206 * MenuToolGroups are one of three types of {@link OO.ui.ToolGroup toolgroups} that are used to
2207 * create {@link OO.ui.Toolbar toolbars} (the other types of groups are {@link OO.ui.BarToolGroup BarToolGroup}
2208 * and {@link OO.ui.ListToolGroup ListToolGroup}). MenuToolGroups contain selectable {@link OO.ui.Tool tools},
2209 * which are displayed by label in a dropdown menu. The tool's title is used as the label text, and the
2210 * menu label is updated to reflect which tool or tools are currently selected. If no tools are selected,
2211 * the menu label is empty. The menu can be configured with an indicator, icon, title, and/or header.
2213 * MenuToolGroups are created by a {@link OO.ui.ToolGroupFactory tool group factory} when the toolbar
2217 * // Example of a MenuToolGroup
2218 * var toolFactory = new OO.ui.ToolFactory();
2219 * var toolGroupFactory = new OO.ui.ToolGroupFactory();
2220 * var toolbar = new OO.ui.Toolbar( toolFactory, toolGroupFactory );
2222 * // We will be placing status text in this element when tools are used
2223 * var $area = $( '<p>' ).text( 'An example of a MenuToolGroup. Select a tool from the dropdown menu.' );
2225 * // Define the tools that we're going to place in our toolbar
2227 * function SettingsTool() {
2228 * SettingsTool.parent.apply( this, arguments );
2229 * this.reallyActive = false;
2231 * OO.inheritClass( SettingsTool, OO.ui.Tool );
2232 * SettingsTool.static.name = 'settings';
2233 * SettingsTool.static.icon = 'settings';
2234 * SettingsTool.static.title = 'Change settings';
2235 * SettingsTool.prototype.onSelect = function () {
2236 * $area.text( 'Settings tool clicked!' );
2237 * // Toggle the active state on each click
2238 * this.reallyActive = !this.reallyActive;
2239 * this.setActive( this.reallyActive );
2240 * // To update the menu label
2241 * this.toolbar.emit( 'updateState' );
2243 * SettingsTool.prototype.onUpdateState = function () {};
2244 * toolFactory.register( SettingsTool );
2246 * function StuffTool() {
2247 * StuffTool.parent.apply( this, arguments );
2248 * this.reallyActive = false;
2250 * OO.inheritClass( StuffTool, OO.ui.Tool );
2251 * StuffTool.static.name = 'stuff';
2252 * StuffTool.static.icon = 'ellipsis';
2253 * StuffTool.static.title = 'More stuff';
2254 * StuffTool.prototype.onSelect = function () {
2255 * $area.text( 'More stuff tool clicked!' );
2256 * // Toggle the active state on each click
2257 * this.reallyActive = !this.reallyActive;
2258 * this.setActive( this.reallyActive );
2259 * // To update the menu label
2260 * this.toolbar.emit( 'updateState' );
2262 * StuffTool.prototype.onUpdateState = function () {};
2263 * toolFactory.register( StuffTool );
2265 * // Finally define which tools and in what order appear in the toolbar. Each tool may only be
2266 * // used once (but not all defined tools must be used).
2270 * header: 'This is the (optional) header',
2271 * title: 'This is the (optional) title',
2272 * include: [ 'settings', 'stuff' ]
2276 * // Create some UI around the toolbar and place it in the document
2277 * var frame = new OO.ui.PanelLayout( {
2281 * var contentFrame = new OO.ui.PanelLayout( {
2285 * frame.$element.append(
2287 * contentFrame.$element.append( $area )
2289 * $( 'body' ).append( frame.$element );
2291 * // Here is where the toolbar is actually built. This must be done after inserting it into the
2293 * toolbar.initialize();
2294 * toolbar.emit( 'updateState' );
2296 * For more information about how to add tools to a MenuToolGroup, please see {@link OO.ui.ToolGroup toolgroup}.
2297 * For more information about toolbars in general, please see the [OOjs UI documentation on MediaWiki] [1].
2299 * [1]: https://www.mediawiki.org/wiki/OOjs_UI/Toolbars
2302 * @extends OO.ui.PopupToolGroup
2305 * @param {OO.ui.Toolbar} toolbar
2306 * @param {Object} [config] Configuration options
2308 OO
.ui
.MenuToolGroup
= function OoUiMenuToolGroup( toolbar
, config
) {
2309 // Allow passing positional parameters inside the config object
2310 if ( OO
.isPlainObject( toolbar
) && config
=== undefined ) {
2312 toolbar
= config
.toolbar
;
2315 // Configuration initialization
2316 config
= config
|| {};
2318 // Parent constructor
2319 OO
.ui
.MenuToolGroup
.parent
.call( this, toolbar
, config
);
2322 this.toolbar
.connect( this, { updateState
: 'onUpdateState' } );
2325 this.$element
.addClass( 'oo-ui-menuToolGroup' );
2330 OO
.inheritClass( OO
.ui
.MenuToolGroup
, OO
.ui
.PopupToolGroup
);
2332 /* Static Properties */
2338 OO
.ui
.MenuToolGroup
.static.name
= 'menu';
2343 * Handle the toolbar state being updated.
2345 * When the state changes, the title of each active item in the menu will be joined together and
2346 * used as a label for the group. The label will be empty if none of the items are active.
2350 OO
.ui
.MenuToolGroup
.prototype.onUpdateState = function () {
2354 for ( name
in this.tools
) {
2355 if ( this.tools
[ name
].isActive() ) {
2356 labelTexts
.push( this.tools
[ name
].getTitle() );
2360 this.setLabel( labelTexts
.join( ', ' ) || ' ' );
2365 //# sourceMappingURL=oojs-ui-toolbars.js.map