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

181 lines
4.5 KiB
JavaScript
Raw Normal View History

/*!
* VisualEditor UserInterface MWParameterSearchWidget class.
*
* @copyright 2011-2014 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* Creates an ve.ui.MWParameterSearchWidget object.
*
* @class
* @extends OO.ui.SearchWidget
*
* @constructor
* @param {ve.dm.MWTemplateModel} template Template model
* @param {Object} [config] Configuration options
* @cfg {number|null} [limit=3] Limit on the number of initial options to show, null to show all
*/
ve.ui.MWParameterSearchWidget = function VeUiMWParameterSearchWidget( template, config ) {
// Configuration intialization
config = ve.extendObject( {
placeholder: ve.msg( 'visualeditor-parameter-input-placeholder' ),
limit: 3
}, config );
// Parent constructor
OO.ui.SearchWidget.call( this, config );
// Properties
this.template = template;
this.index = [];
this.showAll = false;
this.limit = config.limit || null;
// Events
this.template.connect( this, { add: 'buildIndex', remove: 'buildIndex' } );
// Initialization
this.$element.addClass( 've-ui-mwParameterSearchWidget' );
this.buildIndex();
};
/* Inheritance */
OO.inheritClass( ve.ui.MWParameterSearchWidget, OO.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
OO.ui.SearchWidget.prototype.onQueryChange.call( this );
// Populate
this.addResults();
};
/**
* Handle select widget select events.
*
* @method
* @param {OO.ui.OptionWidget} item Selected item
* @fires select
*/
ve.ui.MWParameterSearchWidget.prototype.onResultsSelect = function ( item ) {
if ( item instanceof ve.ui.MWParameterResultWidget ) {
this.emit( 'select', item.getData().name );
} else if ( item instanceof ve.ui.MWMoreParametersResultWidget ) {
this.showAll = true;
this.addResults();
}
};
/**
* 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( {
// Query information
text: [ label, description ].join( ' ' ).toLowerCase(),
names: [ name ].concat( aliases ).join( '|' ).toLowerCase(),
// Display information
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, textMatch, nameMatch, remainder,
exactMatch = false,
value = this.query.getValue().trim().replace( /[\|\{\}]/g, '' ),
query = value.toLowerCase(),
hasQuery = !!query.length,
items = [];
this.results.clearItems();
for ( i = 0, len = this.index.length; i < len; i++ ) {
item = this.index[i];
if ( hasQuery ) {
textMatch = item.text.indexOf( query ) >= 0;
nameMatch = item.names.indexOf( query ) >= 0;
}
if ( !hasQuery || textMatch || nameMatch ) {
items.push( new ve.ui.MWParameterResultWidget( item, { $: this.$ } ) );
if ( hasQuery && nameMatch ) {
exactMatch = true;
}
}
if ( !hasQuery && !this.showAll && items.length > this.limit ) {
remainder = len - i;
break;
}
}
if ( hasQuery && !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.MWNoParametersResultWidget(
{}, { $: this.$, disabled: true }
) );
} else if ( remainder ) {
items.push( new ve.ui.MWMoreParametersResultWidget(
{ remainder: remainder }, { $: this.$ }
) );
}
this.results.addItems( items );
if ( hasQuery ) {
Single-click insertion Objectives: * Reduce the number of clicks and mouse maneuvers required to insert media, references or template parameters * Make use of highlighting with mouse movement or arrow key presses, similar to menus, to suggest action when clicked * Improve the way media search results look and feel Changes: ve.ui.SelectWidget.js * Add mouseleave handler to un-highlight when the mouse exits the widget * Document highlight events (already being emitted) ve.ui.SearchWidget.js * Propagate both select and highlight events from results widget * Make arrow keys change highlight instead of selection * Get rid of enter event, make enter key select highlighted item instead * Provide direct access to results widget through getResults method ve.ui.MenuWidget.js * Use the selected item as a starting point if nothing is currently highlighted when adjusting the highlight position ve.ui.Dialog.js * Add footless option to hide the foot element and make the body extend all the way down to the bottom * Remove applyButton, which only some dialogs need, and should be creating themselves, along with other buttons as needed ve.ui.Widget.css * Change highlight and selected colors of option widgets to match other selection colors used elsewhere * Leave selected and highlighted widget looking selected ve.ui.Frame.css * Add background color to combat any color that might have been applied to the frame body in the imported CSS from the parent frame ve.ui.Dialog.css * Add rules for footless mode ve.ui.MWReferenceResultWidget.js, ve.ui.MWParameterResultWidget.js, ve.ui.MWMediaResultWidget.js * Allow highlighting ve.ui.MWParamterSearchWidget.js * Switch from selecting the first item when filtering to highlighting ve-mw/ve.ui.Widget.js * Adjust media result widget styling to better match other elements ve.ui.MWTransclusionDialog.js, ve.ui.MWReferenceListDialog.js, ve.ui.MWReferenceEditDialog.js, ve.ui.MWMetaDialog.js ve.ui.MWMediaEditDialog.js * Add apply button, as per it being removed from parent class ve.ui.MWTransclusionDialog.js, ve.ui.MWReferenceInsertDialog.js, ve.ui.MWMediaInsertDialog.js * Insert parameter/reference/media on select, instead of clicking an insert button * Use 'insert' instead of 'apply' as argument for close method Bug: 50774 Bug: 51143 Change-Id: Ia18e79f1f8df2540f465468edb01f5ce989bf843
2013-07-15 21:07:53 +00:00
this.results.highlightItem( this.results.getFirstSelectableItem() );
}
};