Expand all

abstract OO.ui.ToolGroupTool

Extends

Constructor

new OO.ui.ToolGroupTool(toolGroup, [config])abstract #

A ToolGroupTool is a special sort of tool that can contain other tools and toolgroups. The ToolGroupTool was specifically designed to be used inside a bar toolgroup to provide access to additional tools from the bar item. Included tools will be displayed in a dropdown list when the ToolGroupTool is selected.

// Example: ToolGroupTool with two nested tools, 'setting1' and 'setting2',
// defined elsewhere.

function SettingsTool() {
    SettingsTool.super.apply( this, arguments );
};
OO.inheritClass( SettingsTool, OO.ui.ToolGroupTool );
SettingsTool.static.name = 'settings';
SettingsTool.static.title = 'Change settings';
SettingsTool.static.groupConfig = {
    icon: 'settings',
    label: 'ToolGroupTool',
    include: [  'setting1', 'setting2'  ]
};
toolFactory.register( SettingsTool );

For more information, please see the OOUI documentation on MediaWiki.

Please note that this implementation is subject to change per T74159">T74159.

Parameters:

Name Type Attributes Description
toolGroup OO.ui.ToolGroup
config Object optional

Configuration options
Source:

A ToolGroupTool is a special sort of tool that can contain other tools and toolgroups.

Properties

groupConfigstatic #

Toolgroup configuration.

The toolgroup configuration consists of the tools to include, as well as an icon and label to use for the bar item. Tools can be included by symbolic name, group, or with the wildcard selector. Please see toolgroup for more information.

Properties:

Type Description
Object.<string, Array>
Source:
Toolgroup configuration.

flags #

Initial value to pass to setFlags if no value is provided in config.

Properties:

Type Description
string | Array.<string> | Object.<string, boolean>
Inherited from:
Mixes in:
Source:
Initial value to pass to setFlags if no value is provided in config.

icon #

The symbolic name of the icon (e.g., ‘remove’ or ‘menu’), or a map of symbolic names. A map is used for i18n purposes and contains a default icon name and additional names keyed by language code. The default name is used when no icon is keyed by the user's language.

Example of an i18n map:

{ default: 'bold-a', en: 'bold-b', de: 'bold-f' }

Note: the static property will be overridden if the #icon configuration is used.

Properties:

Type Description
Object | string
Inherited from:
Mixes in:
Source:
The symbolic name of the icon (e.g., ‘remove’ or ‘menu’), or a map of symbolic names.

iconTitle #

The icon title, displayed when users move the mouse over the icon. The value can be text, a function that returns title text, or null for no title.

The static property will be overridden if the #iconTitle configuration is used.

Properties:

Type Description
string | function | null
Inherited from:
Mixes in:
Source:
The icon title, displayed when users move the mouse over the icon.

Methods

createGroup(group) → {OO.ui.ListToolGroup} #

Build a toolgroup from the specified configuration.

Parameters:

Name Type Description
group Object.<string, Array>

Toolgroup configuration. Please see toolgroup for more information.
Source:

Returns:

Type
OO.ui.ListToolGroup
Build a toolgroup from the specified configuration.

destroy() #

Destroy tool.

Destroying the tool removes all event handlers and the tool’s DOM elements. Call this method whenever you are done using a tool.

Inherited from:
Source:
Destroy tool.

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.

getName() → {string} #

Get the tool's symbolic name.

Inherited from:
Source:

Returns:

Symbolic name of tool

Type
string
Get the tool's symbolic name.

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.

getTitle() → {string} #

Get the tool #title.

Inherited from:
Source:

Returns:

Title text

Type
string
Get the tool #title.

isActive() → {boolean} #

Check if the tool is active.

Tools become active when their #onSelect or #onUpdateState handlers change them to appear pressed with the #setActive method. Additional CSS is applied to the tool to reflect the active state.

Inherited from:
Source:

Returns:

Tool is active

Type
boolean
Check if the tool is active.

isDisabled() → {boolean} #

Check if the widget is disabled.

Inherited from:
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.

onSelect()protected #

Handle the tool being selected. This method is called when the user triggers this tool, usually by clicking on its label/icon.

This is an abstract method that must be overridden in a concrete subclass.

Overrides:
Source:
Handle the tool being selected.

onToolbarResize() #

Handle resize events from the toolbar

Inherited from:
Source:
Handle resize events from the toolbar

onUpdateState()protected #

Handle the toolbar state being updated. This method is called when the 'updateState' event is emitted on the Toolbar that uses this tool, and should set the state of this tool depending on application state (usually by calling #setDisabled to enable or disable the tool, or #setActive to mark is as currently in-use or not).

This is an abstract method that must be overridden in a concrete subclass.

Overrides:
Source:
Handle the toolbar state being updated.

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.

setActive([state]) #

Make the tool appear active or inactive.

This method should be called within #onSelect or #onUpdateState event handlers to make the tool appear pressed or not.

Parameters:

Name Type Attributes Default Description
state boolean optional
 false

Make tool appear active
Inherited from:
Source:
Make the tool appear active or inactive.

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.

setDisplayBothIconAndLabel(displayBothIconAndLabel) → {OO.ui.Tool}chainable #

Set the tool's displayBothIconAndLabel state.

Update title classes if necessary

Parameters:

Name Type Description
displayBothIconAndLabel boolean
Inherited from:
Source:

Returns:

The tool, for chaining

Type
OO.ui.Tool
Set the tool's displayBothIconAndLabel state.

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.

setIcon() #

Inherited from:
Source:

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.

setTitle(title) → {OO.ui.Tool}chainable #

Set the tool #title.

Parameters:

Name Type Description
title string | function

Title text or a function that returns text
Inherited from:
Source:

Returns:

The tool, for chaining

Type
OO.ui.Tool
Set the tool #title.

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:

Returns:

The element, for chaining

Type
OO.ui.Element

Fires:

Toggle visibility of an element.

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

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

Inherited from:
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.

updateTitle() #

Update the title.

Inherited from:
Source:
Update the title.

Events

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.