JSDoc: Global

Methods

isActive()

Source:

widgets/ButtonWidget.js, line 220

setActive()

Source:

widgets/ButtonWidget.js, line 216

Events

change A change event is emitted when the on/off state of the toggle changes.

Parameters:

Name	Type	Description
`value`	File \| null	New value

Source:

widgets/SelectFileWidget.js, line 159

change A change event is emitted when the on/off state of the toggle changes.

Parameters:

Name	Type	Description
`value`	boolean	Value representing the new state of the toggle

Source:

widgets/ToggleWidget.js, line 35

change A change event is emitted when the selected state of the option changes.

Parameters:

Name	Type	Description
`selected`	boolean	Whether the option is now selected

Source:

widgets/MultioptionWidget.js, line 47

change A change event is emitted when the set of items changes, or an item is selected or deselected.

Source:

widgets/MultiselectWidget.js, line 49

change A change event is emitted when the set of selected items changes.

Parameters:

Name	Type	Description
`datas`	Array.<Mixed>	Data of the now-selected items

Source:

widgets/CapsuleMultiselectWidget.js, line 208

change A change event is emitted when the set of selected items changes.

Parameters:

Name	Type	Description
`items`	Array.<OO.ui.Element>	Items currently in the group

Source:

mixins/GroupElement.js, line 36

change A change event is emitted when the value of the input changes.

Parameters:

Name	Type	Description
`value`	string

Source:

widgets/InputWidget.js, line 100

dragend A dragend event is emitted when the user drags an item and releases the mouse, thus terminating the drag operation.

Source:

mixins/DraggableElement.js, line 48

dragstart A dragstart event is emitted when the user clicks and begins dragging an item.

Parameters:

Name	Type	Description
`item`	OO.ui.mixin.DraggableElement	The item the user has clicked and is dragging with the mouse.

Source:

mixins/DraggableElement.js, line 41

drop A drop event is emitted when the user drags an item and then releases the mouse button over a valid target.

Source:

mixins/DraggableElement.js, line 54

active

An 'active' event is emitted when the page becomes active. Pages become active when they are shown in a booklet layout that is configured to display only one page at a time.

Parameters:

Name	Type	Description
`active`	boolean	Page is active

Source:

layouts/PageLayout.js, line 45

active

An 'active' event is emitted when the tab panel becomes active. Tab panels become active when they are shown in a index layout that is configured to display only one tab panel at a time.

Parameters:

Name	Type	Description
`active`	boolean	Tab panel is active

Source:

layouts/TabPanelLayout.js, line 48

add

An 'add' event is emitted when actions are added to the action set.

Parameters:

Name	Type	Description
`added`	Array.<OO.ui.ActionWidget>	Actions added

Source:

ActionSet.js, line 134

add

An 'add' event is emitted when pages are added to the booklet layout.

Parameters:

Name	Type	Description
`page`	Array.<OO.ui.PageLayout>	Added pages
`index`	number	Index pages were added at

Source:

layouts/BookletLayout.js, line 127

add

An 'add' event is emitted when tab panels are added to the index layout.

Parameters:

Name	Type	Description
`tabPanel`	Array.<OO.ui.TabPanelLayout>	Added tab panels
`index`	number	Index tab panels were added at

Source:

layouts/IndexLayout.js, line 95

change

A 'change' event is emitted when actions are added, cleared, or removed from the action set or when the mode is changed.

Source:

ActionSet.js, line 149

click

A 'click' event is emitted when an action is clicked.

Parameters:

Name	Type	Description
`action`	OO.ui.ActionWidget	Action that was clicked

Source:

ActionSet.js, line 127

closing

A 'closing' event is emitted when the window begins to be closed.

Parameters:

Name	Type	Description
`win`	OO.ui.Window	Window that's being closed
`closed`	jQuery.Promise	A promise resolved with a value when the window is closed successfully. This promise also emits `hold` and `teardown` notifications. When this promise is resolved, the first argument of its value is the closing data.
`data`	Object	Window closing data

Source:

WindowManager.js, line 107

disable

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

Source:

Widget.js, line 42

drag

An item has been dragged to a new position, but not yet dropped.

Parameters:

Name	Type	Attributes	Description
`item`	OO.ui.mixin.DraggableElement		Dragged item
`newIndex`	number	<optional>	New index for the item

Source:

mixins/DraggableGroupElement.js, line 57

draggable

Draggable state of this widget has changed.

Parameters:

Name	Type	Attributes	Description
`draggable`	boolean	<optional>	Widget is draggable

Source:

mixins/DraggableGroupElement.js, line 73

enter

An enter event is emitted when the user presses 'enter' inside the text box.

Source:

widgets/TextInputWidget.js, line 157

labelChange

Parameters:

Name	Type	Description
`value`	string

Source:

mixins/LabelElement.js, line 37

move

Parameters:

Name	Type	Description
`places`	number	Number of places to move

Source:

widgets/OutlineControlsWidget.js, line 84

navigate

Parameters:

Name Type Description

Name	Type	Description
`direction`	string	Direction of the movement, forward or backwards A navigate action was performed on the item

direction

string

Direction of the movement, forward or backwards

A navigate action was performed on the item

Source:

widgets/TagItemWidget.js, line 78

opening

An 'opening' event is emitted when the window begins to be opened.

Parameters:

Name	Type	Description
`win`	OO.ui.Window	Window that's being opened
`opened`	jQuery.Promise	A promise resolved with a value when the window is opened successfully. This promise also emits `setup` and `ready` notifications. When this promise is resolved, the first argument of the value is an 'closed' promise, the second argument is the opening data.
`data`	Object	Window opening data

Source:

WindowManager.js, line 96

remove

A 'remove' event is emitted when tab panels are cleared or removed from the index.

Parameters:

Name	Type	Description
`tabPanel`	Array.<OO.ui.TabPanelLayout>	Removed tab panels

Source:

layouts/IndexLayout.js, line 103

remove

A 'remove' event is emitted when pages are cleared or removed from the booklet.

Parameters:

Name	Type	Description
`pages`	Array.<OO.ui.PageLayout>	Removed pages

Source:

layouts/BookletLayout.js, line 135

remove

A 'remove' event is emitted when actions are removed or cleared.

Parameters:

Name	Type	Description
`added`	Array.<OO.ui.ActionWidget>	Actions removed

Source:

ActionSet.js, line 141

remove

Source:

widgets/OutlineControlsWidget.js, line 89

reorder

An item has been dropped at a new position.

Parameters:

Name	Type	Attributes	Description
`item`	OO.ui.mixin.DraggableElement		Reordered item
`newIndex`	number	<optional>	New index for the item

Source:

mixins/DraggableGroupElement.js, line 65

resize

A 'resize' event is emitted when a window is resized.

Parameters:

Name	Type	Description
`win`	OO.ui.Window	Window that was resized

Source:

WindowManager.js, line 118

set

A 'set' event is emitted when a page is set to be displayed by the booklet layout.

Parameters:

Name	Type	Description
`page`	OO.ui.PageLayout	Current page

Source:

layouts/BookletLayout.js, line 121

set

A 'set' event is emitted when panels are added, removed, cleared or displayed.

Parameters:

Name	Type	Description
`item`	OO.ui.Layout \| null	Current panel or `null` if no panel is shown

Source:

layouts/StackLayout.js, line 66

set

A 'set' event is emitted when a tab panel is set to be displayed by the index layout.

Parameters:

Name	Type	Description
`tabPanel`	OO.ui.TabPanelLayout	Current tab panel

Source:

layouts/IndexLayout.js, line 89

submit

A 'submit' event is emitted when the form is submitted.

Source:

layouts/FormLayout.js, line 104

toggle

A 'toggle' event is emitted when the visibility of the widget changes.

Parameters:

Name	Type	Description
`visible`	boolean	Widget is visible

Source:

Widget.js, line 51

update

Source:

ToolGroup.js, line 88

valid

Parameters:

Name Type Description

Name	Type	Description
`isValid`	boolean	Item is valid Item validity has changed

isValid

boolean

Item is valid

Item validity has changed

Source:

widgets/TagItemWidget.js, line 92

visibleItemChange

When used in continuous mode, this event is emitted when the user scrolls down far enough such that currentItem is no longer visible.

Parameters:

Name	Type	Description
`panel`	OO.ui.PanelLayout	The next visible item in the layout

Source:

layouts/StackLayout.js, line 74

flag A flag event is emitted when the #clearFlags or #setFlags methods are used. The `changes` parameter contains the name of each modified flag and indicates whether it was added or removed.

Parameters:

Name	Type	Description
`changes`	Object.<string, boolean>	Object keyed by flag name. A Boolean `true` indicates that the flag was added, `false` that the flag was removed.

Source:

mixins/FlaggedElement.js, line 57

ready The menu is ready: it is visible and has been positioned and clipped.

Source:

widgets/MenuSelectWidget.js, line 91

ready The popup is ready: it is visible and has been positioned and clipped.

Source:

widgets/PopupWidget.js, line 159

remove A remove action was performed on the item

Source:

widgets/TagItemWidget.js, line 72

resize A resize event is emitted when the widget's dimensions change to accomodate newly added items or current user input.

Source:

widgets/CapsuleMultiselectWidget.js, line 216

select A select event is emitted when an item is selected or deselected.

Source:

widgets/MultiselectWidget.js, line 55

select The tag widget was selected. This can occur when the widget is either clicked or enter was pressed on it.

Source:

widgets/TagItemWidget.js, line 85

updateState An 'updateState' event must be emitted on the Toolbar (by calling `toolbar.emit( 'updateState' )`) every time the state of the application using the toolbar changes, and an update to the state of tools is required.

Parameters:

Name	Type	Attributes	Description
`data`	Mixed	<repeatable>	Application-defined parameters

Source:

Toolbar.js, line 338