Class: PopupTool

(abstract) .ui.PopupTool(toolGroup, configopt)

(abstract) new PopupTool(toolGroup, configopt)

Popup tools open a popup window when they are selected from the toolbar. Each popup tool is configured with a static name, title, and icon, as well with as any popup configurations. Unlike other tools, popup tools do not require that developers specify an #onSelect or #onUpdateState method, as these methods have been implemented already.

// Example of a popup tool. When selected, a popup tool displays
// a popup window.
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 );

For an example of a toolbar that contains a popup tool, see toolbars. For more information about toolbars in genreral, please see the OOjs UI documentation on MediaWiki.

Parameters:
Name Type Attributes Description
toolGroup OO.ui.ToolGroup
config Object <optional>

Configuration options
Mixes In:
Source:

Extends

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.

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

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

getName() → {string}

Get the tool's symbolic name.

Inherited From:
Source:
Returns:

Symbolic name of tool

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

Get the tool #title.

Inherited From:
Source:
Returns:

Title text

Type
string

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

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

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:

(protected) onUpdateState()

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:

(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(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 Description
state boolean

Make tool appear active
Inherited From:
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
Inherited From:
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:

setTitle(title)

Set the tool #title.

Parameters:
Name Type Description
title string | function

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

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:

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:

updateTitle()

Update the title.

Inherited From:
Source: