mediawiki-extensions-Visual.../modules/ve-mw/ui/pages/ve.ui.MWTemplateParameterPage.js
Trevor Parscal c8f7845def Display indicators for required parameters in template dialog
Update submodule for changes in OOUI (I1c047b55c7a0d5cf3e0aa0cc3f9a4da7d45c0304)

Change-Id: I8f84a9ae277e5093356f591f7a56e8cebf4a1893
2014-01-15 14:15:21 -08:00

86 lines
2.6 KiB
JavaScript

/*!
* VisualEditor user interface MWTemplateParameterPage class.
*
* @copyright 2011-2014 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* MediaWiki transclusion dialog template page.
*
* @class
* @extends OO.ui.PageLayout
*
* @constructor
* @param {ve.dm.MWTemplateParameterModel} parameter Template parameter
* @param {string} name Unique symbolic name of page
* @param {Object} [config] Configuration options
*/
ve.ui.MWTemplateParameterPage = function VeUiMWTemplateParameter( parameter, name, config ) {
// Configuration initialization
config = ve.extendObject(
parameter.isRequired() ? {
'indicator': 'required',
'indicatorLabel': ve.msg( 'visualeditor-dialog-transclusion-required-parameter' )
} : {},
{ 'icon': 'parameter', 'movable': false, 'level': 1 },
config
);
// Parent constructor
OO.ui.PageLayout.call( this, name, config );
// Properties
this.parameter = parameter;
this.spec = parameter.getTemplate().getSpec();
this.label = this.spec.getParameterLabel( this.parameter.getName() );
this.textInput = new OO.ui.TextInputWidget( {
'$': this.$,
'multiline': true,
'classes': [ 've-ui-mwTransclusionDialog-input' ]
} )
.setValue( this.parameter.getValue() )
.connect( this, { 'change': 'onTextInputChange' } );
this.inputLabel = new OO.ui.InputLabelWidget( {
'$': this.$,
'input': this.textInput,
'label': this.spec.getParameterDescription( this.parameter.getName() ) || ''
} );
this.removeButton = new OO.ui.IconButtonWidget( {
'$': this.$,
'icon': 'remove',
'title': ve.msg( 'visualeditor-dialog-transclusion-remove-param' ),
'flags': ['destructive'],
'classes': [ 've-ui-mwTransclusionDialog-removeButton' ]
} )
.connect( this, { 'click': 'onRemoveButtonClick' } );
this.valueFieldset = new OO.ui.FieldsetLayout( {
'$': this.$,
'label': this.spec.getParameterLabel( this.parameter.getName() ),
'icon': 'parameter',
'$content': this.inputLabel.$element.add( this.textInput.$element )
} );
// TODO: Use spec.required
// TODO: Use spec.deprecation
// TODO: Use spec.default
// TODO: Use spec.type
// Initialization
this.$element.append( this.valueFieldset.$element, this.removeButton.$element );
};
/* Inheritance */
OO.inheritClass( ve.ui.MWTemplateParameterPage, OO.ui.PageLayout );
/* Methods */
ve.ui.MWTemplateParameterPage.prototype.onTextInputChange = function () {
this.parameter.setValue( this.textInput.getValue() );
};
ve.ui.MWTemplateParameterPage.prototype.onRemoveButtonClick = function () {
this.parameter.remove();
};