new TabOptionWidget(configopt)
TabOptionWidget is an item in a TabSelectWidget.
Currently, this class is only used by index layouts, which contain tab panel layouts. See IndexLayout for an example.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
config |
Object |
<optional> |
Configuration options |
- Source:
Extends
Methods
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
getMatchText() → {string|boolean}
Get text to match search strings against.
The default implementation returns the label text, but subclasses can override this to provide more complex behavior.
- Inherited From:
- Source:
Returns:
String to match search string against
- Type
- string | 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
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
isHighlightable() → {boolean}
Check if the option can be highlighted. A highlight indicates that the option may be selected when a user presses enter or clicks. Disabled items cannot be highlighted.
- Inherited From:
- Source:
Returns:
Item is highlightable
- Type
- boolean
isHighlighted() → {boolean}
Check if the option is highlighted. A highlight indicates that the item may be selected when a user presses enter or clicks.
- Inherited From:
- Source:
Returns:
Item is highlighted
- Type
- boolean
isPressable() → {boolean}
Check if the option can be pressed. The pressed state occurs when a user mouses down on an item, but has not yet let go of the mouse.
- Inherited From:
- Source:
Returns:
Item is pressable
- Type
- boolean
isPressed() → {boolean}
Check if the option is pressed. The pressed state occurs when a user mouses down on an item, but has not yet let go of the mouse. The item may appear selected, but it will not be selected until the user releases the mouse.
- Inherited From:
- Source:
Returns:
Item is pressed
- Type
- boolean
isSelectable() → {boolean}
Check if the option can be selected.
- Inherited From:
- Source:
Returns:
Item is selectable
- Type
- boolean
isSelected() → {boolean}
Check if the option is selected.
- Inherited From:
- Source:
Returns:
Item is selected
- 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:
setHighlighted(stateopt)
Set the option’s highlighted state. In general, all programmatic modifications to the highlight should be handled by the SelectWidget’s highlightItem( [item] ) method instead of this method.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
state |
boolean |
<optional> |
false | Highlight option |
- Inherited From:
- Source:
setPressed(stateopt)
Set the option’s pressed state. In general, all programmatic modifications to the pressed state should be handled by the SelectWidget’s pressItem( [item] ) method instead of this method.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
state |
boolean |
<optional> |
false | Press option |
- Inherited From:
- Source:
setSelected(stateopt)
Set the option’s selected state. In general, all modifications to the selection should be handled by the SelectWidget’s selectItem( [item] ) method instead of this method.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
state |
boolean |
<optional> |
false | Select option |
- 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: