Methods
isActive()
- Source:
setActive()
- Source:
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:
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:
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:
change
A change event is emitted when the set of items changes, or an item is selected or deselected.
- Source:
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:
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:
Parameters:
Name |
Type |
Description |
value |
string
|
|
- Source:
dragend
A dragend event is emitted when the user drags an item and releases the mouse,
thus terminating the drag operation.
- Source:
dragstart
A dragstart event is emitted when the user clicks and begins dragging an item.
Parameters:
- Source:
- Source:
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:
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:
add
An 'add' event is emitted when actions are added to the action set.
Parameters:
- Source:
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:
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:
change
A 'change' event is emitted when actions are added, cleared,
or removed from the action set or when the mode is changed.
- Source:
click
A 'click' event is emitted when an action is clicked.
Parameters:
- Source:
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:
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:
drag
An item has been dragged to a new position, but not yet dropped.
Parameters:
- Source:
draggable
Draggable state of this widget has changed.
Parameters:
Name |
Type |
Attributes |
Description |
draggable |
boolean
|
<optional>
|
Widget is draggable |
- Source:
enter
An `enter` event is emitted when the user presses 'enter' inside the text box.
- Source:
labelChange
Parameters:
Name |
Type |
Description |
value |
string
|
|
- Source:
move
Parameters:
Name |
Type |
Description |
places |
number
|
Number of places to move |
- Source:
navigate
Parameters:
Name |
Type |
Description |
direction |
string
|
Direction of the movement, forward or backwards
A navigate action was performed on the item |
- Source:
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:
remove
A 'remove' event is emitted when tab panels are cleared or
removed from the index.
Parameters:
- Source:
remove
A 'remove' event is emitted when pages are cleared or
removed from the booklet.
Parameters:
- Source:
remove
A 'remove' event is emitted when actions are removed
or cleared.
Parameters:
- Source:
remove
- Source:
reorder
An item has been dropped at a new position.
Parameters:
- Source:
resize
A 'resize' event is emitted when a window is resized.
Parameters:
Name |
Type |
Description |
win |
OO.ui.Window
|
Window that was resized |
- Source:
set
A 'set' event is emitted when a page is set to be displayed by the booklet layout.
Parameters:
- Source:
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:
set
A 'set' event is emitted when a tab panel is set to be displayed by the index layout.
Parameters:
- Source:
submit
A 'submit' event is emitted when the form is submitted.
- Source:
toggle
A 'toggle' event is emitted when the visibility of the widget changes.
Parameters:
Name |
Type |
Description |
visible |
boolean
|
Widget is visible |
- Source:
update
- Source:
valid
Parameters:
Name |
Type |
Description |
isValid |
boolean
|
Item is valid
Item validity has changed |
- Source:
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:
- Source:
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:
ready
The menu is ready: it is visible and has been positioned and clipped.
- Source:
ready
The popup is ready: it is visible and has been positioned and clipped.
- Source:
- Source:
- Source:
select
A select event is emitted when an item is selected or deselected.
- Source:
- Source:
Parameters:
Name |
Type |
Attributes |
Description |
data |
Mixed
|
<repeatable>
|
Application-defined parameters |
- Source: