mediawiki-extensions-Visual.../modules/ve-mw/ui/pages/ve.ui.MWParameterPlaceholderPage.js
Thiemo Kreuz 2529d33f51 Better name for spec.isParameterKnown() method
This reflects much better how this method is meant to behave.

Note I will continue to remove documentation that doesn't
explain anything in addition to what the code already says.

Bug: T285483
Change-Id: I81fa8a5d9d0752f3aeac4015c9a27b50e054d4df
2021-06-24 18:05:14 +02:00

106 lines
3.2 KiB
JavaScript

/*!
* VisualEditor user interface MWParameterPlaceholderPage class.
*
* @copyright 2011-2020 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* MediaWiki transclusion dialog parameter placeholder page.
*
* @class
* @extends OO.ui.PageLayout
*
* @constructor
* @param {ve.dm.MWTemplateModel} parameter Template
* @param {string} name Unique symbolic name of page
* @param {Object} [config] Configuration options
* @cfg {jQuery} [$overlay] Overlay to render dropdowns in
*/
ve.ui.MWParameterPlaceholderPage = function VeUiMWParameterPlaceholderPage( parameter, name, config ) {
// Configuration initialization
config = ve.extendObject( {
scrollable: false
}, config );
// Parent constructor
ve.ui.MWParameterPlaceholderPage.super.call( this, name, config );
// Properties
// TODO: the unique `name` seems to be a relic of when BookletLayout held
// the parameters in separate pages rather than in a StackLayout.
this.name = name;
this.parameter = parameter;
this.template = this.parameter.getTemplate();
this.addParameterSearch = new ve.ui.MWParameterSearchWidget( this.template )
.connect( this, { choose: 'onParameterChoose' } );
this.removeButton = new OO.ui.ButtonWidget( {
framed: false,
icon: 'trash',
title: ve.msg( 'visualeditor-dialog-transclusion-remove-param' ),
flags: [ 'destructive' ],
classes: [ 've-ui-mwTransclusionDialog-removeButton' ]
} )
.connect( this, { click: 'onRemoveButtonClick' } );
this.addParameterFieldset = new OO.ui.FieldsetLayout( {
label: ve.msg( 'visualeditor-dialog-transclusion-add-param' ),
icon: 'parameter',
classes: [ 've-ui-mwTransclusionDialog-addParameterFieldset' ],
$content: this.addParameterSearch.$element
} );
this.addParameterFieldset.$element.attr( 'aria-label', ve.msg( 'visualeditor-dialog-transclusion-add-param' ) );
// Initialization
this.$element
.addClass( 've-ui-mwParameterPlaceholderPage' )
.append( this.addParameterFieldset.$element, this.removeButton.$element );
};
/* Inheritance */
OO.inheritClass( ve.ui.MWParameterPlaceholderPage, OO.ui.PageLayout );
/* Methods */
/**
* @inheritdoc
*/
ve.ui.MWParameterPlaceholderPage.prototype.setOutlineItem = function () {
// Parent method
ve.ui.MWParameterPlaceholderPage.super.prototype.setOutlineItem.apply( this, arguments );
if ( this.outlineItem ) {
this.outlineItem
.setIcon( 'parameter' )
.setMovable( false )
.setRemovable( true )
.setLevel( 1 )
.setFlags( [ 'placeholder' ] )
.setLabel( ve.msg( 'visualeditor-dialog-transclusion-add-param' ) );
}
};
ve.ui.MWParameterPlaceholderPage.prototype.onParameterChoose = function ( name ) {
if ( !name ) {
return;
}
// Note that every parameter is known after it is added
var knownBefore = this.template.getSpec().isKnownParameterOrAlias( name ),
param = new ve.dm.MWParameterModel( this.template, name );
this.addParameterSearch.query.setValue( '' );
this.template.addParameter( param );
ve.track( 'activity.transclusion', {
action: knownBefore ? 'add-known-parameter' : 'add-unknown-parameter'
} );
};
ve.ui.MWParameterPlaceholderPage.prototype.onRemoveButtonClick = function () {
this.parameter.remove();
};