Expand all

abstract OO.ui.Tool

Extends

Constructor

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

Tools, together with toolgroups, constitute toolbars. Each tool is configured with a static name, title, and icon and is customized with the command to carry out when the tool is selected. Tools must also be registered with a tool factory, which creates the tools on demand.

Every Tool subclass must implement two methods:

Tools are added to toolgroups (ListToolGroup, BarToolGroup, or MenuToolGroup), which determine how the tool is displayed in the toolbar. See toolbars for an example.

For more information, please see the [OOUI documentation on MediaWiki][1]. [1]: https://www.mediawiki.org/wiki/OOUI/Toolbars

Parameters:

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

Configuration options

Properties:
Name Type Attributes Description
title string | function optional

Title text or a function that returns text. If this config is omitted, the value of the static title property is used.
displayBothIconAndLabel boolean optional

See static.displayBothIconAndLabel
narrowConfig Object optional

See static.narrowConfig

The title is used in different ways depending on the type of toolgroup that contains the tool. The title is used as a tooltip if the tool is part of a bar toolgroup, or as the label text if the tool is part of a list or menu toolgroup.

For bar toolgroups, a description of the accelerator key is appended to the title if an accelerator key is associated with an action by the same name as the tool and accelerator functionality has been added to the application. To add accelerator key functionality, you must subclass OO.ui.Toolbar and override the getToolAccelerator method.
Mixes in:
Source:

Tools, together with toolgroups, constitute toolbars.

Properties

flags #

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

Properties:

Type Description
string | Array.<string> | Object.<string, boolean>
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
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
Mixes in:
Source:
The icon title, displayed when users move the mouse over the icon.

autoAddToCatchallstatic #

Add tool to catch-all groups automatically.

A catch-all group, which contains all tools that do not currently belong to a toolgroup, can be included in a toolgroup using the wildcard selector, an asterisk (*).

Properties:

Type Description
boolean
Source:
Add tool to catch-all groups automatically.

autoAddToGroupstatic #

Add tool to named groups automatically.

By default, tools that are configured with a static ‘group’ property are added to that group and will be selected when the symbolic name of the group is specified (e.g., when toolgroups include tools by group name).

Properties:

Type Description
boolean
Source:
Add tool to named groups automatically.

displayBothIconAndLabelstatic #

Display both icon and label when the tool is used in a bar toolgroup. Normally only the icon is displayed, or only the label if no icon is given.

Properties:

Type Description
boolean
Source:
Display both icon and label when the tool is used in a bar toolgroup.

groupabstractstatic #

Symbolic name of the group.

The group name is used to associate tools with each other so that they can be selected later by a toolgroup.

Properties:

Type Description
string
Source:
Symbolic name of the group.

nameabstractstatic #

Symbolic name of tool.

The symbolic name is used internally to register the tool with a ToolFactory. It can also be used when adding tools to toolgroups.

Properties:

Type Description
string
Source:
Symbolic name of tool.

narrowConfigstatic #

Config options to change when toolbar is in narrow mode

Supports displayBothIconAndLabel, title and icon properties.

Properties:

Type Description
Object | null
Source:

Config options to change when toolbar is in narrow mode

Supports displayBothIconAndLabel, title and icon properties.

tagNamestatic #

Source:

titleabstractstatic #

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.

Properties:

Type Description
string | function
Source:
Tool title text or a function that returns title text.

Methods

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.

Source:
Destroy tool.

getClosestScrollableElementContainer() → {HTMLElement} #

Get closest scrollable container.

Returns:

Closest scrollable container

Type
HTMLElement
Inherited from:
Source:
Get closest scrollable container.

getData() → {any} #

Get element data.

Returns:

Element data

Type
any
Inherited from:
Source:
Get element data.

getElementDocument() → {HTMLDocument} #

Get the DOM document.

Returns:

Document object

Type
HTMLDocument
Inherited from:
Source:
Get the DOM document.

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

Get group element is in.

Returns:

Group element, null if none

Type
OO.ui.mixin.GroupElement | null
Inherited from:
Source:
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.

Returns:

Type
string
Inherited from:
Source:

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.

Returns:

Window object

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

Returns:

The ID of the labelable element

Type
string | null
Inherited from:
Source:

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.

Returns:

Symbolic name of tool

Type
string
Source:
Get the tool's symbolic name.

getTagName() → {string} #

Get the HTML tag name.

Override this method to base the result on instance information.

Returns:

HTML tag name

Type
string
Inherited from:
Source:
Get the HTML tag name.

getTitle() → {string} #

Get the tool #title.

Returns:

Title text

Type
string
Source:
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.

Returns:

Tool is active

Type
boolean
Source:
Check if the tool is active.

isDisabled() → {boolean} #

Check if the widget is disabled.

Returns:

Widget is disabled

Type
boolean
Inherited from:
Source:
Check if the widget is disabled.

isElementAttached() → {boolean} #

Check if the element is attached to the DOM

Returns:

The element is attached to the DOM

Type
boolean
Inherited from:
Source:
Check if the element is attached to the DOM

isVisible() → {boolean} #

Check if element is visible.

Returns:

element is visible

Type
boolean
Inherited from:
Source:
Check if element is visible.

onSelect()abstractprotected #

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.

Source:
Handle the tool being selected.

onToolbarResize() #

Handle resize events from the toolbar

Source:
Handle resize events from the toolbar

onUpdateState()abstractprotected #

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.

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

Returns:

Promise which resolves when the scroll is complete

Type
jQuery.Promise
Inherited from:
Source:
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
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

Returns:

The element, for chaining

Type
OO.ui.Element
Inherited from:
Source:
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

Returns:

The widget, for chaining

Type
OO.ui.Widget
Inherited from:
Source:
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

Returns:

The tool, for chaining

Type
OO.ui.Tool
Source:
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

Returns:

The element, for chaining

Type
OO.ui.Element
Inherited from:
Source:
Set group element is in.

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

Set the element has an 'id' attribute.

Parameters:

Name Type Description
id string

Returns:

The element, for chaining

Type
OO.ui.Element
Inherited from:
Source:
Set the element has an 'id' attribute.

setIcon() #

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

Returns:

The tool, for chaining

Type
OO.ui.Tool
Source:
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

Returns:

All methods are supported

Type
boolean
Inherited from:
Source:
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

Returns:

The element, for chaining

Type
OO.ui.Element

Fires:

Inherited from:
Source:
Toggle visibility of an element.

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

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

Returns:

The widget, for chaining

Type
OO.ui.Widget
Inherited from:
Source:
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.

Source:
Update the title.

isCompatibleWith(data) → {boolean}static #

Check if this tool is compatible with given data.

This is a stub that can be overridden to provide support for filtering tools based on an arbitrary piece of information (e.g., where the cursor is in a document). The implementation must also call this method so that the compatibility check can be performed.

Parameters:

Name Type Description
data any

Data to check

Returns:

Tool can be used with data

Type
boolean
Source:
Check if this tool is compatible with given data.

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.