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:
|
- Mixes in:
- Source:
Tools, together with toolgroups
, constitute
toolbars
.
Properties
autoAddToCatchallstatic
#
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 |
displayBothIconAndLabelstatic
#
bar
toolgroup.
groupabstractstatic
#
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 |
narrowConfigstatic
#
Config options to change when toolbar is in narrow mode
Supports displayBothIconAndLabel
, title
and icon
properties.
titleabstractstatic
#
flags
#
Initial value to pass to setFlags if no value is provided in config.
Properties:
- Mixes in:
- Source:
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:
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:
Methods
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
destroy()
#
getClosestScrollableElementContainer() → {HTMLElement}
#
Get closest scrollable container.
- Inherited from:
- Source:
Returns:
Closest scrollable container
- Type
- HTMLElement
getData() → {any}
#
Get element data.
- Inherited from:
- Source:
Returns:
Element data
- Type
- any
getElementDocument() → {HTMLDocument}
#
getElementGroup() → {OO.ui.mixin.GroupElement|null
}
#
null
}
#
Get group element is in.
- Inherited from:
- Source:
Returns:
Group element, null if none
- Type
-
OO.ui.mixin.GroupElement
|
null
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}
#
getInputId() → {string|null
}
#
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}
#
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
getTitle() → {string}
#
isActive() → {boolean}
#
isDisabled() → {boolean}
#
Check if the widget is disabled.
- Inherited from:
- Source:
Returns:
Widget is disabled
- Type
- boolean
isElementAttached() → {boolean}
#
Check if the element is attached to the DOM
- Inherited from:
- Source:
Returns:
The element is attached to the DOM
- Type
- boolean
isVisible() → {boolean}
#
Check if element is visible.
- Inherited from:
- Source:
Returns:
element is visible
- Type
- boolean
onSelect()abstractprotected
#
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.
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:
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
setActive([state])
#
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
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
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
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
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
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:
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
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:
<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
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:
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
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:
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: