mediawiki-extensions-Visual.../modules/ve-mw/ui/pages/ve.ui.MWAdvancedSettingsPage.js
James D. Forrester 945242a55a build: Enable jscs jsDoc rule 'checkAnnotations' and make pass
Change-Id: I76abb1eb1f3e1a2e8a4c03f577a080f4889b3a6d
2015-08-19 11:09:34 -07:00

360 lines
11 KiB
JavaScript
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/*!
* VisualEditor user interface MWAdvancedSettingsPage class.
*
* @copyright 2011-2015 VisualEditor Team and others; see AUTHORS.txt
* @license The MIT License (MIT); see LICENSE.txt
*/
/**
* MediaWiki meta dialog advanced settings page.
*
* @class
* @extends OO.ui.PageLayout
*
* @constructor
* @param {string} name Unique symbolic name of page
* @param {Object} [config] Configuration options
*/
ve.ui.MWAdvancedSettingsPage = function VeUiMWAdvancedSettingsPage( name, config ) {
var advancedSettingsPage = this;
// Parent constructor
OO.ui.PageLayout.call( this, name, config );
// Properties
this.metaList = null;
this.indexingOptionTouched = false;
this.newSectionEditLinkOptionTouched = false;
this.advancedSettingsFieldset = new OO.ui.FieldsetLayout( {
label: ve.msg( 'visualeditor-dialog-meta-advancedsettings-label' ),
icon: 'advanced'
} );
// Initialization
// Indexing items
this.indexing = new OO.ui.FieldLayout(
new OO.ui.ButtonSelectWidget()
.addItems( [
new OO.ui.ButtonOptionWidget( {
data: 'mwIndexForce',
label: ve.msg( 'visualeditor-dialog-meta-settings-index-force' )
} ),
new OO.ui.ButtonOptionWidget( {
data: 'default',
label: ve.msg( 'visualeditor-dialog-meta-settings-index-default' )
} ),
new OO.ui.ButtonOptionWidget( {
data: 'mwIndexDisable',
label: ve.msg( 'visualeditor-dialog-meta-settings-index-disable' )
} )
] )
.connect( this, { select: 'onIndexingOptionChange' } ),
{
align: 'top',
label: ve.msg( 'visualeditor-dialog-meta-settings-index-label' ),
help: ve.msg( 'visualeditor-dialog-meta-settings-index-help' )
}
);
// New edit section link items
this.newEditSectionLink = new OO.ui.FieldLayout(
new OO.ui.ButtonSelectWidget()
.addItems( [
new OO.ui.ButtonOptionWidget( {
data: 'mwNewSectionEditForce',
label: ve.msg( 'visualeditor-dialog-meta-settings-newsectioneditlink-force' )
} ),
new OO.ui.ButtonOptionWidget( {
data: 'default',
label: ve.msg( 'visualeditor-dialog-meta-settings-newsectioneditlink-default' )
} ),
new OO.ui.ButtonOptionWidget( {
data: 'mwNewSectionEditDisable',
label: ve.msg( 'visualeditor-dialog-meta-settings-newsectioneditlink-disable' )
} )
] )
.connect( this, { select: 'onNewSectionEditLinkOptionChange' } ),
{
align: 'top',
label: ve.msg( 'visualeditor-dialog-meta-settings-newsectioneditlink-label' ),
help: ve.msg( 'visualeditor-dialog-meta-settings-newsectioneditlink-help', $( '#ca-edit' ).text() )
}
);
this.displayTitleTouched = false;
this.enableDisplayTitleCheckbox = new OO.ui.CheckboxInputWidget();
this.enableDisplayTitleCheckbox.connect( this, { change: 'onEnableDisplayTitleCheckboxChange' } );
this.enableDisplayTitleField = new OO.ui.FieldLayout(
this.enableDisplayTitleCheckbox,
{
align: 'inline',
label: ve.msg( 'visualeditor-dialog-meta-settings-displaytitle-enable' ),
help: ve.msg( 'visualeditor-dialog-meta-settings-displaytitle-help' )
}
);
this.displayTitleInput = new OO.ui.TextInputWidget( {
placeholder: ve.msg( 'visualeditor-dialog-meta-settings-displaytitle' )
} );
this.displayTitleInput.connect( this, { change: 'onDisplayTitleInputChange' } );
this.displayTitleField = new OO.ui.FieldLayout(
this.displayTitleInput,
{ align: 'inline' }
);
this.advancedSettingsFieldset.addItems( [ this.indexing, this.newEditSectionLink, this.enableDisplayTitleField, this.displayTitleField ] );
this.metaItemCheckboxes = [];
if ( mw.config.get( 'wgVariantArticlePath' ) ) {
this.metaItemCheckboxes.push(
{
metaName: 'mwNoContentConvert',
label: ve.msg( 'visualeditor-dialog-meta-settings-nocontentconvert-label' ),
help: ve.msg( 'visualeditor-dialog-meta-settings-nocontentconvert-help' )
},
{
metaName: 'mwNoTitleConvert',
label: ve.msg( 'visualeditor-dialog-meta-settings-notitleconvert-label' ),
help: ve.msg( 'visualeditor-dialog-meta-settings-notitleconvert-help' )
}
);
}
$.each( this.metaItemCheckboxes, function () {
this.fieldLayout = new OO.ui.FieldLayout(
new OO.ui.CheckboxInputWidget(),
{
align: 'inline',
label: this.label
}
);
advancedSettingsPage.advancedSettingsFieldset.addItems( [ this.fieldLayout ] );
} );
this.$element.append( this.advancedSettingsFieldset.$element );
};
/* Inheritance */
OO.inheritClass( ve.ui.MWAdvancedSettingsPage, OO.ui.PageLayout );
/* Methods */
/**
* Handle redirect state change events.
*
* @param {boolean} value Whether a redirect is to be set for this page
*/
ve.ui.MWAdvancedSettingsPage.prototype.onEnableDisplayTitleCheckboxChange = function ( value ) {
this.displayTitleInput.setDisabled( !value );
if ( !value ) {
this.displayTitleInput.setValue( '' );
this.enableDisplayTitleCheckbox.setSelected( false );
}
this.displayTitleTouched = true;
};
/**
* Handle redirect state change events.
*
* @param {boolean} value Whether a redirect is to be set for this page
*/
ve.ui.MWAdvancedSettingsPage.prototype.onDisplayTitleInputChange = function () {
this.displayTitleTouched = true;
};
/**
* @inheritdoc
*/
ve.ui.MWAdvancedSettingsPage.prototype.setOutlineItem = function ( outlineItem ) {
// Parent method
OO.ui.PageLayout.prototype.setOutlineItem.call( this, outlineItem );
if ( this.outlineItem ) {
this.outlineItem
.setIcon( 'advanced' )
.setLabel( ve.msg( 'visualeditor-dialog-meta-advancedsettings-section' ) );
}
};
/* Indexing option methods */
/**
* Handle indexing option state change events.
*/
ve.ui.MWAdvancedSettingsPage.prototype.onIndexingOptionChange = function () {
this.indexingOptionTouched = true;
};
/**
* Get the first meta item of a given name
*
* @param {string} name Name of the meta item
* @return {Object|null} Meta item, if any
*/
ve.ui.MWAdvancedSettingsPage.prototype.getMetaItem = function ( name ) {
return this.metaList.getItemsInGroup( name )[ 0 ] || null;
};
/* New edit section link option methods */
/**
* Handle new edit section link change events.
*/
ve.ui.MWAdvancedSettingsPage.prototype.onNewSectionEditLinkOptionChange = function () {
this.newSectionEditLinkOptionTouched = true;
};
/**
* Setup settings page.
*
* @param {ve.dm.MetaList} metaList Meta list
* @param {Object} [data] Dialog setup data
*/
ve.ui.MWAdvancedSettingsPage.prototype.setup = function ( metaList ) {
var indexingField, indexingOption, indexingType,
newSectionEditField, newSectionEditLinkOption, newSectionEditLinkType,
displayTitleItem, displayTitle,
advancedSettingsPage = this;
this.metaList = metaList;
// Indexing items
indexingField = this.indexing.getField();
indexingOption = this.getMetaItem( 'mwIndex' );
indexingType = indexingOption && indexingOption.element.type || 'default';
indexingField.selectItemByData( indexingType );
this.indexingOptionTouched = false;
// New section edit link items
newSectionEditField = this.newEditSectionLink.getField();
newSectionEditLinkOption = this.getMetaItem( 'mwNewSectionEdit' );
newSectionEditLinkType = newSectionEditLinkOption && newSectionEditLinkOption.element.type || 'default';
newSectionEditField.selectItemByData( newSectionEditLinkType );
this.newSectionEditLinkOptionTouched = false;
// Display title items
displayTitleItem = this.getMetaItem( 'mwDisplayTitle' );
displayTitle = displayTitleItem && displayTitleItem.getAttribute( 'content' ) || '';
this.enableDisplayTitleCheckbox.setSelected( !!displayTitleItem );
this.displayTitleInput.setValue( displayTitle );
this.displayTitleInput.setDisabled( !displayTitle );
this.displayTitleTouched = false;
// Simple checkbox items
$.each( this.metaItemCheckboxes, function () {
var isSelected = !!advancedSettingsPage.getMetaItem( this.metaName );
this.fieldLayout.getField().setSelected( isSelected );
} );
};
/**
* Tear down settings page.
*
* @param {Object} [data] Dialog tear down data
*/
ve.ui.MWAdvancedSettingsPage.prototype.teardown = function ( data ) {
var currentIndexingItem, newIndexingData,
currentNewSectionEditLinkItem, newNewSectionEditLinkOptionData,
currentDisplayTitleItem, newDisplayTitle, newDisplayTitleItemData,
advancedSettingsPage = this;
// Data initialization
data = data || {};
if ( data.action !== 'apply' ) {
return;
}
// Indexing items
currentIndexingItem = this.getMetaItem( 'mwIndex' );
newIndexingData = this.indexing.getField().getSelectedItem();
// Alter the indexing option flag iff it's been touched & is actually different
if ( this.indexingOptionTouched ) {
if ( newIndexingData.data === 'default' ) {
if ( currentIndexingItem ) {
currentIndexingItem.remove();
}
} else {
if ( !currentIndexingItem ) {
this.metaList.insertMeta( { type: newIndexingData.data } );
} else if ( currentIndexingItem.element.type !== newIndexingData.data ) {
currentIndexingItem.replaceWith(
ve.extendObject( true, {},
currentIndexingItem.getElement(),
{ type: newIndexingData.data }
)
);
}
}
}
// New section edit link items
currentNewSectionEditLinkItem = this.getMetaItem( 'mwNewSectionEdit' );
newNewSectionEditLinkOptionData = this.newEditSectionLink.getField().getSelectedItem();
// Alter the new section edit option flag iff it's been touched & is actually different
if ( this.newSectionEditLinkOptionTouched ) {
if ( newNewSectionEditLinkOptionData.data === 'default' ) {
if ( currentNewSectionEditLinkItem ) {
currentNewSectionEditLinkItem.remove();
}
} else {
if ( !currentNewSectionEditLinkItem ) {
this.metaList.insertMeta( { type: newNewSectionEditLinkOptionData.data } );
} else if ( currentNewSectionEditLinkItem.element.type !== newNewSectionEditLinkOptionData.data ) {
currentNewSectionEditLinkItem.replaceWith(
ve.extendObject( true, {},
currentNewSectionEditLinkItem.getElement(),
{ type: newNewSectionEditLinkOptionData.data }
)
);
}
}
}
// Display title items
currentDisplayTitleItem = this.getMetaItem( 'mwDisplayTitle' );
newDisplayTitle = this.displayTitleInput.getValue();
newDisplayTitleItemData = { type: 'mwDisplayTitle', attributes: { content: newDisplayTitle } };
// Alter the display title flag iff it's been touched & is actually different
if ( this.displayTitleTouched ) {
if ( currentDisplayTitleItem ) {
if ( newDisplayTitle ) {
if ( currentDisplayTitleItem.getAttribute( 'content' ) !== newDisplayTitle ) {
// There was a display title and is a new one, but they differ, so replace
currentDisplayTitleItem.replaceWith(
ve.extendObject( true, {},
currentDisplayTitleItem.getElement(),
newDisplayTitleItemData
) );
}
} else {
// There was a display title and is no new one, so remove
currentDisplayTitleItem.remove();
}
} else {
if ( newDisplayTitle ) {
// There's no existing display title but there is a new one, so create
// HACK: Putting this at index 0, offset 0 so that it works bug 61862
this.metaList.insertMeta( newDisplayTitleItemData, 0, 0 );
}
}
}
$.each( this.metaItemCheckboxes, function () {
var currentItem = advancedSettingsPage.getMetaItem( this.metaName ),
isSelected = this.fieldLayout.getField().isSelected();
if ( currentItem && !isSelected ) {
currentItem.remove();
} else if ( !currentItem && isSelected ) {
advancedSettingsPage.metaList.insertMeta( { type: this.metaName } );
}
} );
this.metaList = null;
};