Extends
Constructor
new ve.ui.MWTransclusionOutlineParameterSelectWidget(config)
#
List of template parameters, each of which can be added or removed using a checkbox.
This is modelled after {@see OO.ui.OutlineSelectWidget}. Currently we use the SelectWidget in multi-select mode, and selection maps to checked checkboxes.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
config |
Object |
Properties:
|
Properties:
| Name | Type | Description |
|---|---|---|
activeParameter |
string
|
null
|
Name of the currently selected parameter |
stickyHeaderHeight |
number |
List of template parameters, each of which can be added or removed using a checkbox.
Methods
addItems(items, [index]) → {ve.ui.MWTransclusionOutlineParameterSelectWidget}
#
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
items |
Array.<ve.ui.MWTransclusionOutlineParameterWidget> | ||
index |
number |
optional |
Returns:
highlightItem()
#
markParameterAsUnused(paramName)
#
Parameters:
| Name | Type | Description |
|---|---|---|
paramName |
string |
onCheckboxChange(item, value)private
#
Parameters:
| Name | Type | Description |
|---|---|---|
item |
ve.ui.MWTransclusionOutlineParameterWidget | |
value |
boolean |
onDocumentKeyDown(e)
#
onFocus()
#
onMouseDown(e)
#
setActiveParameter([paramName])
#
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
paramName |
string
|
null
|
optional |
Parameter name to set, e.g. "param1". Omit to remove setting. |
createItem(config) → {ve.ui.MWTransclusionOutlineParameterWidget}static
#
Parameters:
| Name | Type | Description | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
config |
Object |
Properties:
|
Returns:
Events
templateParameterSpaceDown(item, selected)
#
This is fired instead of the "choose" event from the {@see OO.ui.SelectWidget} base class when pressing space on a parameter to toggle it or scroll it into view, without losing the focus.
Parameters:
| Name | Type | Description |
|---|---|---|
item |
ve.ui.MWTransclusionOutlineParameterWidget | |
selected |
boolean |
This is fired instead of the "choose" event from the {@see OO.ui.SelectWidget} base class when pressing space on a parameter to toggle it or scroll it into view, without losing the focus.