Class: PopupToolGroup

(abstract) .ui.PopupToolGroup(toolbar, configopt)

(abstract) new PopupToolGroup(toolbar, configopt)

PopupToolGroup is an abstract base class used by both MenuToolGroup and ListToolGroup to provide a popup--an overlaid menu or list of tools with an optional icon and label. This class can be used for other base classes that also use this functionality.
Parameters:
Name Type Attributes Description
toolbar OO.ui.Toolbar
config Object <optional>
Configuration options
Properties
Name Type Attributes Description
header string <optional>
Text to display at the top of the popup
Mixes In:
Source:

Extends

Methods

destroy()

Destroy toolgroup.
Inherited From:
Source:

getClosestScrollableElementContainer() → {HTMLElement}

Get closest scrollable container.
Inherited From:
Source:
Returns:
Closest scrollable container
Type
HTMLElement

getData() → {Mixed}

Get element data.
Inherited From:
Source:
Returns:
Element data
Type
Mixed

getElementDocument() → {HTMLDocument}

Get the DOM document.
Inherited From:
Source:
Returns:
Document object
Type
HTMLDocument

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

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

getElementWindow() → {Window}

Get the DOM window.
Inherited From:
Source:
Returns:
Window object
Type
Window

getHorizontalAnchorEdge()

Source:

getInputId() → {string|null}

Get an ID of a labelable node which is part of this widget, if any, to be used for `
Inherited From:
Source:
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:
Source:
Returns:
HTML tag name
Type
string

getToolbar() → {OO.ui.Toolbar}

Get the toolbar that contains the toolgroup.
Inherited From:
Source:
Returns:
Toolbar that contains the toolgroup
Type
OO.ui.Toolbar

getVerticalAnchorEdge()

Source:

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

(protected) onBlur(e)

Handle focus being lost. The event is actually generated from a mouseup/keyup, so it is not a normal blur event object.
Parameters:
Name Type Description
e MouseEvent | KeyboardEvent Mouse up or key up event
Source:

(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:
Source:

(protected) onHandleMouseKeyDown(e)

Handle mouse down and key down events.
Parameters:
Name Type Description
e jQuery.Event Mouse down or key down event
Source:

(protected) onHandleMouseKeyUp(e)

Handle mouse up and key up events.
Parameters:
Name Type Description
e jQuery.Event Mouse up or key up event
Source:

(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:
Source:

(protected) onMouseKeyUp(e)

Handle mouse up and key up events.
Parameters:
Name Type Description
e MouseEvent | KeyboardEvent Mouse up or key up event
Overrides:
Source:

(protected) onMouseOutBlur(e)

Handle mouse out and blur events.
Parameters:
Name Type Description
e jQuery.Event Mouse out or blur event
Inherited From:
Source:

(protected) onMouseOverFocus(e)

Handle mouse over and focus events.
Parameters:
Name Type Description
e jQuery.Event Mouse over or focus event
Inherited From:
Source:

(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:
Source:

populate()

Add and remove tools based on configuration.
Inherited From:
Source:

(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:
Source:

scrollElementIntoView(configopt) → {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(value)

Switch into 'active' mode. When active, the popup is visible. A mouseup event anywhere in the document will trigger deactivation.
Parameters:
Name Type Description
value boolean The active state to set
Source:

setData(data)

Set element data.
Parameters:
Name Type Description
data Mixed Element data
Inherited From:
Source:

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
Overrides:
Source:

setElementGroup(group)

Set group element is in.
Parameters:
Name Type Description
group OO.ui.mixin.GroupElement | null Group element, null if none
Inherited From:
Source:

setElementId(id)

Set the element has an 'id' attribute.
Parameters:
Name Type Description
id string
Inherited From:
Source:

simulateLabelClick()

Simulate the behavior of clicking on a label (a HTML `
Inherited From:
Source:

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(showopt)

Toggle visibility of an element.
Parameters:
Name Type Attributes Description
show boolean <optional>
Make element visible, omit to toggle visibility
Inherited From:
Source:
Fires:
  • event:visible

updateDisabled()

Update the disabled state, in case of changes in parent widget.
Inherited From:
Source:

updateThemeClasses()

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