Class: ActionWidget

.ui.ActionWidget(configopt)

new ActionWidget(configopt)

An ActionWidget is a button widget that executes an action. Action widgets are used with OO.ui.ActionSet, which manages the behavior and availability of the actions. Both actions and action sets are primarily used with Dialogs. Please see the [OOUI documentation on MediaWiki] [1] for more information and examples. [1]: https://www.mediawiki.org/wiki/OOUI/Windows/Process_Dialogs#Action_sets
Parameters:
Name Type Attributes Description
config Object <optional>
Configuration options
Properties
Name Type Attributes Default Description
action string <optional>
Symbolic name of the action (e.g., ‘continue’ or ‘cancel’).
modes Array.<string> <optional>
Symbolic names of the modes (e.g., ‘edit’ or ‘read’) in which the action should be made available. See the action set's setMode method for more information about setting modes.
framed boolean <optional>
false Render the action button with a frame
Mixes In:
Source:

Extends

Methods

getAction() → {string}

Get the symbolic name of the action (e.g., ‘continue’ or ‘cancel’).
Source:
Returns:
Type
string

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

getHref() → {string}

Get hyperlink location.
Inherited From:
Source:
Returns:
Hyperlink location
Type
string

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

getModes() → {Array.<string>}

Get the symbolic name of the mode or modes for which the action is configured to be available. The current mode is set with the action set's setMode method. Only actions that are configured to be avaiable in the current mode will be visible. All other actions are hidden.
Source:
Returns:
Type
Array.<string>

getNoFollow() → {boolean}

Get search engine traversal hint.
Inherited From:
Source:
Returns:
Whether search engines should avoid traversing this hyperlink
Type
boolean

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

getTarget() → {string}

Get hyperlink target.
Inherited From:
Source:
Returns:
Hyperlink target
Type
string

hasMode(mode) → {boolean}

Check if the action is configured to be available in the specified `mode`.
Parameters:
Name Type Description
mode string Name of mode
Source:
Returns:
The action is configured with the mode
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) 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

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:

setHref(href)

Set hyperlink location.
Parameters:
Name Type Description
href string | null Hyperlink location, null to remove
Inherited From:
Source:

setNoFollow(noFollow)

Set search engine traversal hint.
Parameters:
Name Type Description
noFollow boolean True if search engines should avoid traversing this hyperlink
Inherited From:
Source:

setTarget(target)

Set hyperlink target.
Parameters:
Name Type Description
target string | null Hyperlink target, null to remove
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: