new CheckboxMultiselectWidget(configopt)
CheckboxMultiselectWidget is a multiselect widget that contains checkboxes and is used together with OO.ui.CheckboxMultioptionWidget. The CheckboxMultiselectWidget provides an interface for adding, removing and selecting options. Please see the [OOjs UI documentation on MediaWiki][1] for more information.
If you want to use this within an HTML form, such as a OO.ui.FormLayout, use OO.ui.CheckboxMultiselectInputWidget instead.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
config |
Object |
<optional> |
Configuration options |
Example
// A CheckboxMultiselectWidget with CheckboxMultioptions.
var option1 = new OO.ui.CheckboxMultioptionWidget( {
data: 'a',
selected: true,
label: 'Selected checkbox'
} );
var option2 = new OO.ui.CheckboxMultioptionWidget( {
data: 'b',
label: 'Unselected checkbox'
} );
var multiselect=new OO.ui.CheckboxMultiselectWidget( {
items: [ option1, option2 ]
} );
$( 'body' ).append( multiselect.$element );
[1]: https://www.mediawiki.org/wiki/OOjs_UI/Widgets/Selects_and_Options
Extends
Methods
findSelectedItems() → {Array.<OO.ui.MultioptionWidget>}
Find options that are selected.
- Inherited From:
- Source:
Returns:
Selected options
- Type
- Array.<OO.ui.MultioptionWidget>
findSelectedItemsData() → {Array.<Object>|Array.<string>}
Find the data of options that are selected.
- Inherited From:
- Source:
Returns:
Values of selected options
- Type
- Array.<Object> | Array.<string>
focus()
Focus the widget
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
getRelativeFocusableItem(item, direction) → {OO.ui.CheckboxMultioptionWidget|null}
Get an option by its position relative to the specified item (or to the start of the option array,
if item is null
). The direction in which to search through the option array is specified with a
number: -1 for reverse (the default) or 1 for forward. The method will return an option, or
null
if there are no options in the array.
Parameters:
Name | Type | Description |
---|---|---|
item |
OO.ui.CheckboxMultioptionWidget | null | Item to describe the start position, or |
direction |
number | Direction to move in: -1 to move backward, 1 to move forward |
Returns:
Item at position, null
if there are no items in the select
- Type
- OO.ui.CheckboxMultioptionWidget | null
getSelectedItems() → {Array.<OO.ui.MultioptionWidget>}
Get options that are selected.
- Inherited From:
- Deprecated:
- Since v0.25.0; use #findSelectedItems instead.
- Source:
Returns:
Selected options
- Type
- Array.<OO.ui.MultioptionWidget>
getSelectedItemsData() → {Array.<Object>|Array.<string>}
Get the data of options that are selected.
- Inherited From:
- Deprecated:
- Since v0.25.0; use #findSelectedItemsData instead.
- Source:
Returns:
Values of selected options
- Type
- Array.<Object> | Array.<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
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
onClick(e)
Handle click events on checkboxes.
Parameters:
Name | Type | Description |
---|---|---|
e |
jQuery.Event |
(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
selectItems(items)
Select options by reference. Options not mentioned in the items
array will be deselected.
Parameters:
Name | Type | Description |
---|---|---|
items |
Array.<OO.ui.MultioptionWidget> | Items to select |
- Inherited From:
- Source:
selectItemsByData(datas)
Select items by their data. Options not mentioned in the datas
array will be deselected.
Parameters:
Name | Type | Description |
---|---|---|
datas |
Array.<Object> | Array.<string> | Values of items to select |
- 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:
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.
- Overrides:
- 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: