JSDoc: Class: BarToolGroup

new BarToolGroup(toolbar, configopt)

BarToolGroups are one of three types of toolgroups that are used to create toolbars (the other types of groups are MenuToolGroup and ListToolGroup). The tools in a BarToolGroup are displayed by icon in a single row. The title of the tool is displayed when users move the mouse over the tool.

BarToolGroups are created by a tool group factory when the toolbar is set up.

Parameters:

Name	Type	Attributes	Description
`toolbar`	OO.ui.Toolbar
`config`	Object	<optional>	Configuration options

Source:

toolgroups/BarToolGroup.js, line 99

Example

// Example of a BarToolGroup with two tools
    var toolFactory = new OO.ui.ToolFactory();
    var toolGroupFactory = new OO.ui.ToolGroupFactory();
    var toolbar = new OO.ui.Toolbar( toolFactory, toolGroupFactory );

    // We will be placing status text in this element when tools are used
    var $area = $( '<p>' ).text( 'Example of a BarToolGroup with two tools.' );

    // Define the tools that we're going to place in our toolbar

    // Create a class inheriting from OO.ui.Tool
    function SearchTool() {
        SearchTool.parent.apply( this, arguments );
    }
    OO.inheritClass( SearchTool, OO.ui.Tool );
    // Each tool must have a 'name' (used as an internal identifier, see later) and at least one
    // of 'icon' and 'title' (displayed icon and text).
    SearchTool.static.name = 'search';
    SearchTool.static.icon = 'search';
    SearchTool.static.title = 'Search...';
    // Defines the action that will happen when this tool is selected (clicked).
    SearchTool.prototype.onSelect = function () {
        $area.text( 'Search tool clicked!' );
        // Never display this tool as "active" (selected).
        this.setActive( false );
    };
    SearchTool.prototype.onUpdateState = function () {};
    // Make this tool available in our toolFactory and thus our toolbar
    toolFactory.register( SearchTool );

    // This is a PopupTool. Rather than having a custom 'onSelect' action, it will display a
    // little popup window (a PopupWidget).
    function HelpTool( toolGroup, config ) {
        OO.ui.PopupTool.call( this, toolGroup, $.extend( { popup: {
            padded: true,
            label: 'Help',
            head: true
        } }, config ) );
        this.popup.$body.append( '<p>I am helpful!</p>' );
    }
    OO.inheritClass( HelpTool, OO.ui.PopupTool );
    HelpTool.static.name = 'help';
    HelpTool.static.icon = 'help';
    HelpTool.static.title = 'Help';
    toolFactory.register( HelpTool );

    // Finally define which tools and in what order appear in the toolbar. Each tool may only be
    // used once (but not all defined tools must be used).
    toolbar.setup( [
        {
            // 'bar' tool groups display tools by icon only
            type: 'bar',
            include: [ 'search', 'help' ]
        }
    ] );

    // Create some UI around the toolbar and place it in the document
    var frame = new OO.ui.PanelLayout( {
        expanded: false,
        framed: true
    } );
    var contentFrame = new OO.ui.PanelLayout( {
        expanded: false,
        padded: true
    } );
    frame.$element.append(
        toolbar.$element,
        contentFrame.$element.append( $area )
    );
    $( 'body' ).append( frame.$element );

    // Here is where the toolbar is actually built. This must be done after inserting it into the
    // document.
    toolbar.initialize();

For more information about how to add tools to a bar tool group, please see toolgroup.
For more information about toolbars in general, please see the [OOjs UI documentation on MediaWiki][1].

[1]: https://www.mediawiki.org/wiki/OOjs_UI/Toolbars

Extends

OO.ui.ToolGroup

Methods

destroy()

Destroy toolgroup.

Inherited From:

OO.ui.ToolGroup#destroy

Source:

ToolGroup.js, line 355

getClosestScrollableElementContainer() → {HTMLElement}

Get closest scrollable container.

Inherited From:

OO.ui.Element#getClosestScrollableElementContainer

Source:

Element.js, line 930

Returns:

Closest scrollable container

Type: HTMLElement

getData() → {Mixed}

Get element data.

Inherited From:

OO.ui.Element#getData

Source:

Element.js, line 815

Returns:

Element data

Type: Mixed

getElementDocument() → {HTMLDocument}

Get the DOM document.

Inherited From:

OO.ui.Element#getElementDocument

Source:

Element.js, line 911

Returns:

Document object

Type: HTMLDocument

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

Get group element is in.

Inherited From:

OO.ui.Element#getElementGroup

Source:

Element.js, line 939

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:

OO.ui.Element#getElementId

Source:

Element.js, line 848

Returns:

Type: string

getElementWindow() → {Window}

Get the DOM window.

Inherited From:

OO.ui.Element#getElementWindow

Source:

Element.js, line 921

Returns:

Window object

Type: 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:

OO.ui.Widget#getInputId

Source:

Widget.js, line 113

Returns:

The ID of the labelable element

Type: string | null

getTagName() → {string}

Get the HTML tag name.

Override this method to base the result on instance information.

Inherited From:

OO.ui.Element#getTagName

Source:

Element.js, line 893

Returns:

HTML tag name

Type: string

getToolbar() → {OO.ui.Toolbar}

Get the toolbar that contains the toolgroup.

Inherited From:

OO.ui.ToolGroup#getToolbar

Source:

ToolGroup.js, line 288

Returns:

Toolbar that contains the toolgroup

Type: OO.ui.Toolbar

isDisabled() → {boolean}

Check if the widget is disabled.

Inherited From:

OO.ui.Widget#isDisabled

Source:

Widget.js, line 65

Returns:

Widget is disabled

Type: boolean

isElementAttached() → {boolean}

Check if the element is attached to the DOM

Inherited From:

OO.ui.Element#isElementAttached

Source:

Element.js, line 902

Returns:

The element is attached to the DOM

Type: boolean

isVisible() → {boolean}

Check if element is visible.

Inherited From:

OO.ui.Element#isVisible

Source:

Element.js, line 806

Returns:

element is visible

Type: boolean

(protected) onCapturedMouseKeyUp(e)

Handle captured mouse up and key up events.

Parameters:

Name	Type	Description
`e`	MouseEvent \| KeyboardEvent	Mouse up or key up event

Inherited From:

OO.ui.ToolGroup#onCapturedMouseKeyUp

Source:

ToolGroup.js, line 189

(protected) onMouseKeyDown(e)

Handle mouse down and key down events.

Parameters:

Name	Type	Description
`e`	jQuery.Event	Mouse down or key down event

Inherited From:

OO.ui.ToolGroup#onMouseKeyDown

Source:

ToolGroup.js, line 168

(protected) onMouseKeyUp(e)

Handle mouse up and key up events.

Parameters:

Name	Type	Description
`e`	MouseEvent \| KeyboardEvent	Mouse up or key up event

Inherited From:

OO.ui.ToolGroup#onMouseKeyUp

Source:

ToolGroup.js, line 203

(protected) onMouseOutBlur(e)

Handle mouse out and blur events.

Parameters:

Name	Type	Description
`e`	jQuery.Event	Mouse out or blur event

Inherited From:

OO.ui.ToolGroup#onMouseOutBlur

Source:

ToolGroup.js, line 239

(protected) onMouseOverFocus(e)

Handle mouse over and focus events.

Parameters:

Name	Type	Description
`e`	jQuery.Event	Mouse over or focus event

Inherited From:

OO.ui.ToolGroup#onMouseOverFocus

Source:

ToolGroup.js, line 225

(protected) onToolFactoryRegister(name)

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

Inherited From:

OO.ui.ToolGroup#onToolFactoryRegister

Source:

ToolGroup.js, line 279

populate()

Add and remove tools based on configuration.

Inherited From:

OO.ui.ToolGroup#populate

Source:

ToolGroup.js, line 295

(protected) restorePreInfuseState(state)

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:

OO.ui.Element#restorePreInfuseState

Source:

Element.js, line 980

scrollElementIntoView(configopt) → {jQuery.Promise}

Scroll element into view.

Parameters:

Name	Type	Attributes	Description
`config`	Object	<optional>	Configuration options

Inherited From:

OO.ui.Element#scrollElementIntoView

Source:

Element.js, line 960

Returns:

Promise which resolves when the scroll is complete

Type: jQuery.Promise

setData(data)

Set element data.

Parameters:

Name	Type	Description
`data`	Mixed	Element data

Inherited From:

OO.ui.Element#setData

Source:

Element.js, line 825

setDisabled(disabled)

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	Description
`disabled`	boolean	Disable widget

Inherited From:

OO.ui.Widget#setDisabled

Source:

Widget.js, line 77

setElementGroup(group)

Set group element is in.

Parameters:

Name	Type	Description
`group`	OO.ui.mixin.GroupElement \| null	Group element, null if none

Inherited From:

OO.ui.Element#setElementGroup

Source:

Element.js, line 949

setElementId(id)

Set the element has an 'id' attribute.

Parameters:

Name	Type	Description
`id`	string

Inherited From:

OO.ui.Element#setElementId

Source:

Element.js, line 836

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: