mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor
synced 2024-12-04 10:48:52 +00:00
30f1ed4c75
In various places in the UI code, certain properties of config objects were overridden and in some cases the configurations were documented as private as a strange hack to prevent them from being advertised in the docs. I, Trevor, have been convinced of the error of my ways, and gladly reverse this situation, allowing all configurations to always be overridden when desired, while still allowing default values. Change-Id: I242e3b1902dec8e09eeea38fa64381e69ee04215
159 lines
3.8 KiB
JavaScript
159 lines
3.8 KiB
JavaScript
/*!
|
|
* VisualEditor UserInterface MWParameterSearchWidget class.
|
|
*
|
|
* @copyright 2011-2013 VisualEditor Team and others; see AUTHORS.txt
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
*/
|
|
|
|
/**
|
|
* Creates an ve.ui.MWParameterSearchWidget object.
|
|
*
|
|
* @class
|
|
* @extends ve.ui.SearchWidget
|
|
*
|
|
* @constructor
|
|
* @param {Object} [config] Config options
|
|
*/
|
|
ve.ui.MWParameterSearchWidget = function VeUiMWParameterSearchWidget( template, config ) {
|
|
// Configuration intialization
|
|
config = ve.extendObject( {
|
|
'placeholder': ve.msg( 'visualeditor-parameter-input-placeholder' )
|
|
}, config );
|
|
|
|
// Parent constructor
|
|
ve.ui.SearchWidget.call( this, config );
|
|
|
|
// Properties
|
|
this.template = template;
|
|
this.index = [];
|
|
|
|
// Events
|
|
this.template.connect( this, { 'add': 'buildIndex', 'remove': 'buildIndex' } );
|
|
|
|
// Initialization
|
|
this.$.addClass( 've-ui-mwParameterSearchWidget' );
|
|
this.buildIndex();
|
|
};
|
|
|
|
/* Inheritance */
|
|
|
|
ve.inheritClass( ve.ui.MWParameterSearchWidget, ve.ui.SearchWidget );
|
|
|
|
/* Events */
|
|
|
|
/**
|
|
* @event select
|
|
* @param {string|null} name Parameter name or null if no item is selected
|
|
*/
|
|
|
|
/* Methods */
|
|
|
|
/**
|
|
* Handle select widget select events.
|
|
*
|
|
* @method
|
|
* @param {string} value New value
|
|
*/
|
|
ve.ui.MWParameterSearchWidget.prototype.onQueryChange = function () {
|
|
// Parent method
|
|
ve.ui.SearchWidget.prototype.onQueryChange.call( this );
|
|
|
|
// Populate
|
|
this.addResults();
|
|
};
|
|
|
|
/**
|
|
* Handle select widget select events.
|
|
*
|
|
* @method
|
|
* @param {ve.ui.OptionWidget} item Selected item
|
|
* @emits select
|
|
*/
|
|
ve.ui.MWParameterSearchWidget.prototype.onResultsSelect = function ( item ) {
|
|
this.emit( 'select', item && item.getData() ? item.getData().name : null );
|
|
};
|
|
|
|
/**
|
|
* Build a serchable index of parameters.
|
|
*
|
|
* @method
|
|
* @param {ve.dm.MWTemplateSpecModel} spec Template specification
|
|
*/
|
|
ve.ui.MWParameterSearchWidget.prototype.buildIndex = function () {
|
|
var i, len, name, label, aliases, description,
|
|
spec = this.template.getSpec(),
|
|
knownParams = spec.getParameterNames();
|
|
|
|
this.index.length = 0;
|
|
for ( i = 0, len = knownParams.length; i < len; i++ ) {
|
|
name = knownParams[i];
|
|
// Skip parameters already in use
|
|
if ( this.template.hasParameter( name ) ) {
|
|
continue;
|
|
}
|
|
label = spec.getParameterLabel( name );
|
|
aliases = spec.getParameterAliases( name );
|
|
description = spec.getParameterDescription( name );
|
|
|
|
this.index.push( {
|
|
'text': [ name, label, aliases.join( ' ' ), description ].join( ' ' ),
|
|
'name': name,
|
|
'label': label,
|
|
'aliases': aliases,
|
|
'description': description
|
|
} );
|
|
}
|
|
|
|
// Re-populate
|
|
this.onQueryChange();
|
|
};
|
|
|
|
/**
|
|
* Handle media query response events.
|
|
*
|
|
* @method
|
|
*/
|
|
ve.ui.MWParameterSearchWidget.prototype.addResults = function () {
|
|
var i, len, item,
|
|
exactMatch = false,
|
|
value = this.query.getValue().trim(),
|
|
query = value.toLowerCase(),
|
|
items = [];
|
|
|
|
for ( i = 0, len = this.index.length; i < len; i++ ) {
|
|
item = this.index[i];
|
|
if ( item.text.indexOf( query ) >= 0 ) {
|
|
items.push( new ve.ui.MWParameterResultWidget( item, { '$$': this.$$ } ) );
|
|
if ( item.name === value || ve.indexOf( value, item.aliases ) !== -1 ) {
|
|
exactMatch = true;
|
|
}
|
|
}
|
|
}
|
|
|
|
if ( !exactMatch && value.length && !this.template.hasParameter( value ) ) {
|
|
items.unshift( new ve.ui.MWParameterResultWidget( {
|
|
'name': value,
|
|
'label': value,
|
|
'aliases': [],
|
|
'description': ve.msg( 'visualeditor-parameter-search-unknown' )
|
|
}, { '$$': this.$$ } ) );
|
|
}
|
|
|
|
if ( !items.length ) {
|
|
items.push( new ve.ui.MWParameterResultWidget(
|
|
{
|
|
'name': null,
|
|
'label': '',
|
|
'aliases': [],
|
|
'description': ve.msg( 'visualeditor-parameter-search-no-unused' )
|
|
},
|
|
{ '$$': this.$$, 'disabled': true }
|
|
) );
|
|
}
|
|
|
|
this.results.addItems( items );
|
|
if ( query.length ) {
|
|
this.results.highlightItem( this.results.getFirstSelectableItem() );
|
|
}
|
|
};
|