Expand all

abstract OO.ui.ToolGroup

Extends

Constructor

new OO.ui.ToolGroup(toolbar, [config])abstract #

ToolGroups are collections of tools that are used in a toolbar. The type of toolgroup (list, bar, or menu) to which a tool belongs determines how the tool is arranged and displayed in the toolbar. Toolgroups themselves are created on demand with a toolgroup factory.

Toolgroups can contain individual tools, groups of tools, or all available tools, as specified using the include config option. See OO.ui.ToolFactory#extract on documentation of the format. The options exclude, promote, and demote support the same formats.

See toolbars for a full example. For more information about toolbars in general, please see the OOUI documentation on MediaWiki.

Parameters:

Name Type Attributes Description
toolbar OO.ui.Toolbar
config Object optional

Configuration options

Properties:
Name Type Attributes Default Description
include Array | string optional
 []

List of tools to include in the toolgroup, see above.
exclude Array | string optional
 []

List of tools to exclude from the toolgroup, see above.
promote Array | string optional
 []

List of tools to promote to the beginning of the toolgroup, see above.
demote Array | string optional
 []

List of tools to demote to the end of the toolgroup, see above. This setting is particularly useful when tools have been added to the toolgroup en masse (e.g., via the catch-all selector).
align string optional
 'before'

Alignment within the toolbar, either 'before' or 'after'.
Mixes in:
Source:

ToolGroups are collections of tools that are used in a toolbar.

Properties

accelTooltipsstatic #

Show acceleration labels in tooltips.

Note: The OOUI library does not include an accelerator system, but does contain a hook for one. To use an accelerator system, subclass the toolbar and override the getToolAccelerator method, which is meant to return a label that describes the accelerator keys for a given tool (e.g., Control+M key combination).

Properties:

Type Description
boolean
Source:
Show acceleration labels in tooltips.

autoDisablestatic #

Automatically disable the toolgroup when all tools are disabled

Properties:

Type Description
boolean
Source:
Automatically disable the toolgroup when all tools are disabled

nameabstractstatic #

Properties:

Type Description
string
Source:

titleTooltipsstatic #

Show labels in tooltips.

Properties:

Type Description
boolean
Source:
Show labels in tooltips.

Methods

destroy() #

Destroy toolgroup.

Source:
Destroy toolgroup.

getClosestScrollableElementContainer() → {HTMLElement} #

Get closest scrollable container.

Inherited from:
Source:

Returns:

Closest scrollable container

Type
HTMLElement
Get closest scrollable container.

getData() → {any} #

Get element data.

Inherited from:
Source:

Returns:

Element data

Type
any
Get element data.

getElementDocument() → {HTMLDocument} #

Get the DOM document.

Inherited from:
Source:

Returns:

Document object

Type
HTMLDocument
Get the DOM document.

getElementGroup() → {OO.ui.mixin.GroupElement|null} #

Get group element is in.

Inherited from:
Source:

Returns:

Group element, null if none

Type
OO.ui.mixin.GroupElement | null
Get group element is in.

getElementId() → {string} #

Ensure that the element has an 'id' attribute, setting it to an unique value if it's missing, and return its value.

Inherited from:
Source:

Returns:

Type
string

Ensure that the element has an 'id' attribute, setting it to an unique value if it's missing, and return its value.

getElementWindow() → {Window} #

Get the DOM window.

Inherited from:
Source:

Returns:

Window object

Type
Window
Get the DOM window.

getInputId() → {string|null} #

Get an ID of a labelable node which is part of this widget, if any, to be used for <label for> value.

If this function returns null, the widget should have a meaningful #simulateLabelClick method instead.

Inherited from:
Source:

Returns:

The ID of the labelable element

Type
string | null

Get an ID of a labelable node which is part of this widget, if any, to be used for <label for> value.

getTagName() → {string} #

Get the HTML tag name.

Override this method to base the result on instance information.

Inherited from:
Source:

Returns:

HTML tag name

Type
string
Get the HTML tag name.

getToolbar() → {OO.ui.Toolbar} #

Get the toolbar that contains the toolgroup.

Source:

Returns:

Toolbar that contains the toolgroup

Type
OO.ui.Toolbar
Get the toolbar that contains the toolgroup.

isDisabled() → {boolean} #

Check if the widget is disabled.

Overrides:
Source:

Returns:

Widget is disabled

Type
boolean
Check if the widget is disabled.

isElementAttached() → {boolean} #

Check if the element is attached to the DOM

Inherited from:
Source:

Returns:

The element is attached to the DOM

Type
boolean
Check if the element is attached to the DOM

isVisible() → {boolean} #

Check if element is visible.

Inherited from:
Source:

Returns:

element is visible

Type
boolean
Check if element is visible.

onDisable(isDisabled)protected #

Handle disable events.

Parameters:

Name Type Description
isDisabled boolean
Source:
Handle disable events.

onDocumentMouseKeyUp(e)protected #

Handle document mouse up and key up events.

Parameters:

Name Type Description
e MouseEvent | KeyboardEvent

Mouse up or key up event
Source:
Handle document mouse up and key up events.

onMouseKeyDown(e) → {undefined|boolean}protected #

Handle mouse down and key down events.

Parameters:

Name Type Description
e jQuery.Event

Mouse down or key down event
Source:

Returns:

False to prevent default if event is handled

Type
undefined | boolean
Handle mouse down and key down events.

onMouseKeyUp(e)protected #

Handle mouse up and key up events.

Parameters:

Name Type Description
e MouseEvent | KeyboardEvent

Mouse up or key up event
Source:
Handle mouse up and key up events.

onMouseOutBlur(e)protected #

Handle mouse out and blur events.

Parameters:

Name Type Description
e jQuery.Event

Mouse out or blur event
Source:
Handle mouse out and blur events.

onMouseOverFocus(e)protected #

Handle mouse over and focus events.

Parameters:

Name Type Description
e jQuery.Event

Mouse over or focus event
Source:
Handle mouse over and focus events.

onToolFactoryRegister(name)protected #

Handle tool registry register events.

If a tool is registered after the group is created, we must repopulate the list to account for:

  • a tool being added that may be included
  • a tool already included being overridden

Parameters:

Name Type Description
name string

Symbolic name of tool
Source:
Handle tool registry register events.

populate() #

Add and remove tools based on configuration.

Source:
Add and remove tools based on configuration.

restorePreInfuseState(state)protected #

Restore the pre-infusion dynamic state for this widget.

This method is called after #$element has been inserted into DOM. The parameter is the return value of #gatherPreInfuseState.

Parameters:

Name Type Description
state Object
Inherited from:
Source:
Restore the pre-infusion dynamic state for this widget.

scrollElementIntoView([config]) → {jQuery.Promise} #

Scroll element into view.

Parameters:

Name Type Attributes Description
config Object optional

Configuration options
Inherited from:
Source:

Returns:

Promise which resolves when the scroll is complete

Type
jQuery.Promise
Scroll element into view.

setData(data) → {OO.ui.Element}chainable #

Set element data.

Parameters:

Name Type Description
data any

Element data
Inherited from:
Source:

Returns:

The element, for chaining

Type
OO.ui.Element
Set element data.

setDisabled([disabled]) → {OO.ui.Widget}chainable #

Set the 'disabled' state of the widget.

When a widget is disabled, it cannot be used and its appearance is updated to reflect this state.

Parameters:

Name Type Attributes Default Description
disabled boolean optional
 false

Disable widget
Inherited from:
Source:

Returns:

The widget, for chaining

Type
OO.ui.Widget
Set the 'disabled' state of the widget.

setElementGroup(group) → {OO.ui.Element}chainable #

Set group element is in.

Parameters:

Name Type Description
group OO.ui.mixin.GroupElement | null

Group element, null if none
Inherited from:
Source:

Returns:

The element, for chaining

Type
OO.ui.Element
Set group element is in.

setElementId(id) → {OO.ui.Element}chainable #

Set the element has an 'id' attribute.

Parameters:

Name Type Description
id string
Inherited from:
Source:

Returns:

The element, for chaining

Type
OO.ui.Element
Set the element has an 'id' attribute.

setLabelledBy(id) #

Set the element with the given ID as a label for this widget.

Parameters:

Name Type Description
id string | null
Inherited from:
Source:
Set the element with the given ID as a label for this widget.

simulateLabelClick() #

Simulate the behavior of clicking on a label (a HTML <label> element) bound to this input. HTML only allows <label> to act on specific "labelable" elements; complex widgets might need to override this method to provide intuitive, accessible behavior.

By default, this does nothing. OO.ui.mixin.TabIndexedElement overrides it for focusable widgets. Individual widgets may override it too.

This method is called by OO.ui.LabelWidget and OO.ui.FieldLayout. It should not be called directly.

Inherited from:
Source:
Simulate the behavior of clicking on a label (a HTML <label> element) bound to this input.

supports(methods) → {boolean} #

Check if element supports one or more methods.

Parameters:

Name Type Description
methods string | Array.<string>

Method or list of methods to check
Inherited from:
Source:

Returns:

All methods are supported

Type
boolean
Check if element supports one or more methods.

toggle([show]) → {OO.ui.Element}chainable #

Toggle visibility of an element.

Parameters:

Name Type Attributes Description
show boolean optional

Make element visible, omit to toggle visibility
Inherited from:
Source:

Fires:

Returns:

The element, for chaining

Type
OO.ui.Element
Toggle visibility of an element.

updateDisabled() → {OO.ui.Widget}chainable #

Update the disabled state, in case of changes in parent widget.

Overrides:
Source:

Returns:

The widget, for chaining

Type
OO.ui.Widget
Update the disabled state, in case of changes in parent widget.

updateThemeClasses() #

Update the theme-provided classes.

This is called in element mixins and widget classes any time state changes. Updating is debounced, minimizing overhead of changing multiple attributes and guaranteeing that theme updates do not occur within an element's constructor

Inherited from:
Source:
Update the theme-provided classes.

Events

active(The) #

An 'active' event is emitted when any popup is shown/hidden.

Parameters:

Name Type Description
The boolean

popup is visible
Source:
An 'active' event is emitted when any popup is shown/hidden.

disable(disabled) #

A 'disable' event is emitted when the disabled state of the widget changes (i.e. on disable and enable).

Parameters:

Name Type Description
disabled boolean

Widget is disabled
Inherited from:
Source:

A 'disable' event is emitted when the disabled state of the widget changes (i.e.

toggle(visible) #

A 'toggle' event is emitted when the visibility of the widget changes.

Parameters:

Name Type Description
visible boolean

Widget is visible
Inherited from:
Source:
A 'toggle' event is emitted when the visibility of the widget changes.

update() #

Source: