Class: MWTransclusionOutlineTemplateWidget, VisualEditor-MediaWiki, JSDoc

Extends

ve.ui.MWTransclusionOutlinePartWidget

Constructor

new ve.ui.MWTransclusionOutlineTemplateWidget(template, [replacesPlaceholder]) #

Hierarchy

OO.ui.Widget
- ve.ui.MWTransclusionOutlinePartWidget
  - ve.ui.MWTransclusionOutlineTemplateWidget

Container for a template as rendered in the template dialog sidebar. Contains search and visibility inputs, and a list of parameters when available.

Parameters:

Name	Type	Attributes	Default	Description
`template`	ve.dm.MWTemplateModel
`replacesPlaceholder`	boolean	optional	false

Properties:

Name	Type	Description
`templateModel`	ve.dm.MWTemplateModel
`parameterList`	ve.ui.MWTransclusionOutlineParameterSelectWidget

Source:

ve-mw/ui/widgets/ve.ui.MWTransclusionOutlineTemplateWidget.js, line 14

Container for a template as rendered in the template dialog sidebar.

Properties

searchableParameterCountstatic #

Minimum number of parameters required before search and filter options appear.

Properties:

Type	Description
number

Source:

ve-mw/ui/widgets/ve.ui.MWTransclusionOutlineTemplateWidget.js, line 84

Minimum number of parameters required before search and filter options appear.

Methods

createAllParameterCheckboxes()private #

Source:

ve-mw/ui/widgets/ve.ui.MWTransclusionOutlineTemplateWidget.js, line 117

createCheckbox(paramName) → {OO.ui.OptionWidget}private #

Parameters:

Name	Type	Description
`paramName`	string	Parameter name or alias as used in the model

Source:

ve-mw/ui/widgets/ve.ui.MWTransclusionOutlineTemplateWidget.js, line 167

Returns:

Type: OO.ui.OptionWidget

filterParameters(query)private #

Narrows the list of checkboxes down to parameters that match the user's input. We search the parameter's primary name, aliases, label, and description. But not e.g. the example value.

Parameters:

Name	Type	Description
`query`	string	user input

Source:

ve-mw/ui/widgets/ve.ui.MWTransclusionOutlineTemplateWidget.js, line 414

Fires:

ve.ui.MWTransclusionOutlineTemplateWidget#event:filterParametersById

Narrows the list of checkboxes down to parameters that match the user's input.

findCanonicalPosition(paramName) → {number}private #

Parameters:

Name	Type	Description
`paramName`	string

Source:

ve-mw/ui/widgets/ve.ui.MWTransclusionOutlineTemplateWidget.js, line 185

Returns:

Type: number

getRelevantTemplateParameters([filter]) → {Array.<string>}private #

Parameters:

Name	Type	Attributes	Default	Description
`filter`	string	optional	'all'	Either "used", "unused", or "all"

Source:

ve-mw/ui/widgets/ve.ui.MWTransclusionOutlineTemplateWidget.js, line 137

Returns:

Type: Array.<string>

initializeFilters()private #

Source:

ve-mw/ui/widgets/ve.ui.MWTransclusionOutlineTemplateWidget.js, line 372

initializeParameterList()private #

Source:

ve-mw/ui/widgets/ve.ui.MWTransclusionOutlineTemplateWidget.js, line 91

isSelected() → {boolean} #

Convenience method, modelled after {@see OO.ui.OptionWidget}, but this isn't one.

Inherited from:

ve.ui.MWTransclusionOutlinePartWidget#isSelected

Source:

ve-mw/ui/widgets/ve.ui.MWTransclusionOutlinePartWidget.js, line 112

Returns:

Type: boolean

Convenience method, modelled after {@see OO.ui.OptionWidget}, but this isn't one.

onHeaderKeyPressed(key)private #

Parameters:

Name	Type	Description
`key`	number

Inherited from:

ve.ui.MWTransclusionOutlinePartWidget#onHeaderKeyPressed

Source:

ve-mw/ui/widgets/ve.ui.MWTransclusionOutlinePartWidget.js, line 101

Fires:

ve.ui.MWTransclusionOutlinePartWidget#event:transclusionPartSoftSelected

onParameterAddedToTemplateModel(param)private #

Parameters:

Name	Type	Description
`param`	ve.dm.MWParameterModel

Source:

ve-mw/ui/widgets/ve.ui.MWTransclusionOutlineTemplateWidget.js, line 236

onParameterRemovedFromTemplateModel(param)private #

Parameters:

Name	Type	Description
`param`	ve.dm.MWParameterModel

Source:

ve-mw/ui/widgets/ve.ui.MWTransclusionOutlineTemplateWidget.js, line 280

onTemplateParameterChoose(item, selected)private #

Parameters:

Name	Type	Description
`item`	OO.ui.OptionWidget
`selected`	boolean

Source:

ve-mw/ui/widgets/ve.ui.MWTransclusionOutlineTemplateWidget.js, line 289

onTemplateParameterSpaceDown(item, selected)private #

Parameters:

Name	Type	Description
`item`	OO.ui.OptionWidget
`selected`	boolean

Source:

ve-mw/ui/widgets/ve.ui.MWTransclusionOutlineTemplateWidget.js, line 298

onToggleUnusedFields(visibility, [fromClick])private #

Parameters:

Name	Type	Attributes	Description
`visibility`	boolean
`fromClick`	boolean	optional

Source:

ve-mw/ui/widgets/ve.ui.MWTransclusionOutlineTemplateWidget.js, line 460

setParameter([paramName]) #

Parameters:

Name	Type	Attributes	Description
`paramName`	string	optional	Parameter name to set, e.g. "param1". Omit to remove setting.

Source:

ve-mw/ui/widgets/ve.ui.MWTransclusionOutlineTemplateWidget.js, line 202

setSelected(state) #

Convenience method, modelled after {@see OO.ui.OptionWidget}, but this isn't one.

Parameters:

Name	Type	Description
`state`	boolean

Overrides:

ve.ui.MWTransclusionOutlinePartWidget#setSelected

Source:

ve-mw/ui/widgets/ve.ui.MWTransclusionOutlinePartWidget.js, line 121

Convenience method, modelled after {@see OO.ui.OptionWidget}, but this isn't one.

shouldFiltersBeShown() → {boolean}private #

Source:

ve-mw/ui/widgets/ve.ui.MWTransclusionOutlineTemplateWidget.js, line 339

Returns:

Type: boolean

toggleFilters()private #

Source:

ve-mw/ui/widgets/ve.ui.MWTransclusionOutlineTemplateWidget.js, line 349

toggleHasValue(paramName, hasValue) #

Parameters:

Name	Type	Description
`paramName`	string
`hasValue`	boolean

Source:

ve-mw/ui/widgets/ve.ui.MWTransclusionOutlineTemplateWidget.js, line 212

toggleParameter(item, selected, soft)private #

Parameters:

Name	Type	Description
`item`	OO.ui.OptionWidget
`selected`	boolean
`soft`	boolean	If true, focus should stay in the sidebar.

Source:

ve-mw/ui/widgets/ve.ui.MWTransclusionOutlineTemplateWidget.js, line 309

Fires:

ve.ui.MWTransclusionOutlineTemplateWidget#event:transclusionOutlineItemSelected

updateButtonAriaDescription(state)private #

Parameters:

Name	Type	Description
`state`	boolean

Inherited from:

ve.ui.MWTransclusionOutlinePartWidget#updateButtonAriaDescription

Source:

ve-mw/ui/widgets/ve.ui.MWTransclusionOutlinePartWidget.js, line 134

updateUnusedParameterToggleState()private #

Source:

ve-mw/ui/widgets/ve.ui.MWTransclusionOutlineTemplateWidget.js, line 329

Events

filterParametersById(visibility) #

Triggered when the user uses the search widget at the top to filter the list of parameters.

Parameters:

Name	Type	Description
`visibility`	Object.<string, boolean>	Keyed by unique id of the parameter, e.g. something like "part_1/param1". Note this lists only parameters that are currently shown as a checkbox. The spec might contain more parameters (e.g. deprecated).