mediawiki-extensions-Visual.../modules/ve-mw/ui/widgets/ve.ui.MWMoreParametersResultWidget.js

/*!
 * VisualEditor UserInterface MWMoreParametersResultWidget class.
 *
 * @copyright 2011-2020 VisualEditor Team and others; see AUTHORS.txt
 * @license The MIT License (MIT); see LICENSE.txt
 */

/**
 * Creates an ve.ui.MWMoreParametersResultWidget object.
 *
 * @class
 * @extends OO.ui.DecoratedOptionWidget
 *
 * @constructor
 * @param {Object} config
 * @cfg {Object} data
 * @cfg {number} data.remainder Number of remaining items currently not shown
 */
ve.ui.MWMoreParametersResultWidget = function VeUiMWMoreParametersResultWidget( config ) {
	// Configuration initialization
	config = ve.extendObject( { icon: 'parameter-set' }, config );

	// Parent constructor
	ve.ui.MWMoreParametersResultWidget.super.call( this, config );

	// Initialization
	this.$element.addClass( 've-ui-mwMoreParametersResultWidget' );
	this.setLabel( this.buildLabel() );
};

/* Inheritance */

OO.inheritClass( ve.ui.MWMoreParametersResultWidget, OO.ui.DecoratedOptionWidget );

/* Methods */

/**
 * Build the label element
 *
 * @private
 * @return {jQuery}
 */
ve.ui.MWMoreParametersResultWidget.prototype.buildLabel = function () {
	return $( '<div>' )
		.addClass( 've-ui-mwMoreParametersResultWidget-label' )
		.text( ve.msg( 'visualeditor-parameter-search-more', this.data.remainder ) );
};
Limit the number of initially visible parameters in the parameter search widget * Truncate beyond 3 parameters * Add a special option class that, when clicked, shows the remaining parameters * Use a special option class for the no parameters item instead of hacking the normal one * Simplify the design of the no parameters item: no icon, centered text Change-Id: Ia8259e91b42a59c2b08019df36217d485208ad99 2014-04-08 19:15:15 +00:00			`/*!`
			`* VisualEditor UserInterface MWMoreParametersResultWidget class.`
			`*`
doc: Bump copyright year for 2020 Change-Id: I30539877543dc2a57bd1428a00d10ac46d8fc294 2020-01-08 17:13:04 +00:00			`* @copyright 2011-2020 VisualEditor Team and others; see AUTHORS.txt`
Limit the number of initially visible parameters in the parameter search widget * Truncate beyond 3 parameters * Add a special option class that, when clicked, shows the remaining parameters * Use a special option class for the no parameters item instead of hacking the normal one * Simplify the design of the no parameters item: no icon, centered text Change-Id: Ia8259e91b42a59c2b08019df36217d485208ad99 2014-04-08 19:15:15 +00:00			`* @license The MIT License (MIT); see LICENSE.txt`
			`*/`

			`/**`
			`* Creates an ve.ui.MWMoreParametersResultWidget object.`
			`*`
			`* @class`
Put icons back in template parameter search These disappeared when DecoratedOptionWidget was split out of OptionWidget in I508c1555 in oojs-ui back in July, and apparently no one noticed. Make MWParameterResultWidget and MWMoreParameterResultWidget inherit DecoratedOptionWidget instead of OptionWidget so the icon config parameter is recognized again. Change-Id: I08d8a0466c211a29eb62043131725073dece4eb5 2014-10-28 00:46:32 +00:00			`* @extends OO.ui.DecoratedOptionWidget`
Limit the number of initially visible parameters in the parameter search widget * Truncate beyond 3 parameters * Add a special option class that, when clicked, shows the remaining parameters * Use a special option class for the no parameters item instead of hacking the normal one * Simplify the design of the no parameters item: no icon, centered text Change-Id: Ia8259e91b42a59c2b08019df36217d485208ad99 2014-04-08 19:15:15 +00:00			`*`
			`* @constructor`
Update and fix all `@param config` and `@cfg` documentation I tried to review all of them. Some of the changes I did: * Make sure the `config` parameter is not marked as optional when it is not. * Make sure default values are mentioned. * List individual `@cfg` options when it makes sense. Note I don't list all options a class could accept (e.g. via all its parent classes and mixins). That's too much. Instead I checked how a class is actually used and list only these options. Even then I don't list everything, e.g. unspecific options like "classes" that can be used pretty much everywhere. Change-Id: Idf4fbe1dc3608ace277df9e385f2f140df3a2f50 2021-09-11 08:05:31 +00:00			`* @param {Object} config`
			`* @cfg {Object} data`
			`* @cfg {number} data.remainder Number of remaining items currently not shown`
Limit the number of initially visible parameters in the parameter search widget * Truncate beyond 3 parameters * Add a special option class that, when clicked, shows the remaining parameters * Use a special option class for the no parameters item instead of hacking the normal one * Simplify the design of the no parameters item: no icon, centered text Change-Id: Ia8259e91b42a59c2b08019df36217d485208ad99 2014-04-08 19:15:15 +00:00			`*/`
Update VE core submodule to master (c8201dd) New changes: ff237d4 Fix z-indexes in core e88d43e Localisation updates from https://translatewiki.net. cf61803 Consistently use ve.ui.WindowManager everywhere f9dfdb8 Update OOjs UI to v0.1.0-pre (23565e7519) f79f7e3 Update OOjs UI to v0.1.0-pre (8f8896196f) c8201dd Update OOjs UI to v0.1.0-pre (9ed4cf2557) Local changes for the breaking change to OptionWidget and sub-classes. Change-Id: Ife6abd312d4dc97be67cb84eea4cb9c6a0a31b1d 2014-11-22 01:40:00 +00:00			`ve.ui.MWMoreParametersResultWidget = function VeUiMWMoreParametersResultWidget( config ) {`
Limit the number of initially visible parameters in the parameter search widget * Truncate beyond 3 parameters * Add a special option class that, when clicked, shows the remaining parameters * Use a special option class for the no parameters item instead of hacking the normal one * Simplify the design of the no parameters item: no icon, centered text Change-Id: Ia8259e91b42a59c2b08019df36217d485208ad99 2014-04-08 19:15:15 +00:00			`// Configuration initialization`
Switch 'disallowQuotedKeysInObjects' jscs rule on and fix up Change-Id: I75ac4b378ef485feead9d0eff34ed7877b94b5d0 2014-08-22 20:50:48 +00:00			`config = ve.extendObject( { icon: 'parameter-set' }, config );`
Limit the number of initially visible parameters in the parameter search widget * Truncate beyond 3 parameters * Add a special option class that, when clicked, shows the remaining parameters * Use a special option class for the no parameters item instead of hacking the normal one * Simplify the design of the no parameters item: no icon, centered text Change-Id: Ia8259e91b42a59c2b08019df36217d485208ad99 2014-04-08 19:15:15 +00:00
			`// Parent constructor`
Use super property to call parent methods Change-Id: I76982b844cf2871d7583463def4393e5bdc33aa2 2016-08-22 21:44:59 +00:00			`ve.ui.MWMoreParametersResultWidget.super.call( this, config );`
Limit the number of initially visible parameters in the parameter search widget * Truncate beyond 3 parameters * Add a special option class that, when clicked, shows the remaining parameters * Use a special option class for the no parameters item instead of hacking the normal one * Simplify the design of the no parameters item: no icon, centered text Change-Id: Ia8259e91b42a59c2b08019df36217d485208ad99 2014-04-08 19:15:15 +00:00
			`// Initialization`
			`this.$element.addClass( 've-ui-mwMoreParametersResultWidget' );`
			`this.setLabel( this.buildLabel() );`
			`};`

			`/* Inheritance */`

Put icons back in template parameter search These disappeared when DecoratedOptionWidget was split out of OptionWidget in I508c1555 in oojs-ui back in July, and apparently no one noticed. Make MWParameterResultWidget and MWMoreParameterResultWidget inherit DecoratedOptionWidget instead of OptionWidget so the icon config parameter is recognized again. Change-Id: I08d8a0466c211a29eb62043131725073dece4eb5 2014-10-28 00:46:32 +00:00			`OO.inheritClass( ve.ui.MWMoreParametersResultWidget, OO.ui.DecoratedOptionWidget );`
Limit the number of initially visible parameters in the parameter search widget * Truncate beyond 3 parameters * Add a special option class that, when clicked, shows the remaining parameters * Use a special option class for the no parameters item instead of hacking the normal one * Simplify the design of the no parameters item: no icon, centered text Change-Id: Ia8259e91b42a59c2b08019df36217d485208ad99 2014-04-08 19:15:15 +00:00
			`/* Methods */`

eslint: Enable valid-jsdoc Change-Id: Ia0d1e57246a1c567d73022ceca9b8c02850f9bc8 2019-04-16 15:17:29 +00:00			`/**`
			`* Build the label element`
			`*`
Add @private tags to template dialog related methods … obviously only to methods that are meant to be private, i.e. only called from within the class (and possibly tests). Change-Id: I581558078dc7210abac5f5724f71316ac45745e6 2021-09-17 09:29:50 +00:00			`* @private`
eslint: Enable valid-jsdoc Change-Id: Ia0d1e57246a1c567d73022ceca9b8c02850f9bc8 2019-04-16 15:17:29 +00:00			`* @return {jQuery}`
			`*/`
Limit the number of initially visible parameters in the parameter search widget * Truncate beyond 3 parameters * Add a special option class that, when clicked, shows the remaining parameters * Use a special option class for the no parameters item instead of hacking the normal one * Simplify the design of the no parameters item: no icon, centered text Change-Id: Ia8259e91b42a59c2b08019df36217d485208ad99 2014-04-08 19:15:15 +00:00			`ve.ui.MWMoreParametersResultWidget.prototype.buildLabel = function () {`
Stop using this.$ Has been a backwards-compatibility alias since OOjs UI 0.7.0. Change-Id: I17d7c03e9d1b9fa991d88444d22abfd403269ee0 2015-04-09 23:47:15 +00:00			`return $( '<div>' )`
Limit the number of initially visible parameters in the parameter search widget * Truncate beyond 3 parameters * Add a special option class that, when clicked, shows the remaining parameters * Use a special option class for the no parameters item instead of hacking the normal one * Simplify the design of the no parameters item: no icon, centered text Change-Id: Ia8259e91b42a59c2b08019df36217d485208ad99 2014-04-08 19:15:15 +00:00			`.addClass( 've-ui-mwMoreParametersResultWidget-label' )`
			`.text( ve.msg( 'visualeditor-parameter-search-more', this.data.remainder ) );`
			`};`