/*! * VisualEditor user interface MWSettingsPage class. * * @copyright 2011-2014 VisualEditor Team and others; see AUTHORS.txt * @license The MIT License (MIT); see LICENSE.txt */ /** * MediaWiki meta dialog settings page. * * @class * @extends OO.ui.PageLayout * * @constructor * @param {ve.ui.Surface} surface Surface being worked on * @param {string} name Unique symbolic name of page * @param {Object} [config] Configuration options */ ve.ui.MWSettingsPage = function VeUiMWSettingsPage( surface, name, config ) { // Configuration initialization config = ve.extendObject( config, { 'icon': 'settings' } ); // Parent constructor OO.ui.PageLayout.call( this, name, config ); // Properties this.metaList = surface.getModel().metaList; this.tocOptionTouched = false; this.label = ve.msg( 'visualeditor-dialog-meta-settings-section' ); this.settingsFieldset = new OO.ui.FieldsetLayout( { '$': this.$, 'label': ve.msg( 'visualeditor-dialog-meta-settings-label' ), 'icon': 'settings' } ); // Initialization // Table of Contents items this.tocOptionSelector = new OO.ui.SelectWidget( { '$': this.$ } ); this.tocOptionWidgets = { 'default': new OO.ui.OptionWidget( 'default', { 'label': ve.msg( 'visualeditor-dialog-meta-settings-toc-default' ) } ), 'mwTOCForce': new OO.ui.OptionWidget( 'mwTOCForce', { 'label': ve.msg( 'visualeditor-dialog-meta-settings-toc-force' ) } ), 'mwTOCDisable': new OO.ui.OptionWidget( 'mwTOCDisable', { 'label': ve.msg( 'visualeditor-dialog-meta-settings-toc-disable' ) } ) }; this.tocOptionSelector.addItems( ve.getObjectValues( this.tocOptionWidgets ) ); this.settingsFieldset.$element.append( this.$( '' ) .text( ve.msg( 'visualeditor-dialog-meta-settings-toc-label' ) ), this.tocOptionSelector.$element ); this.tocOptionSelector.connect( this, { 'select': 'onTOCOptionChange' } ); // Disable section edit links items this.disableSectionEditLinksInput = new OO.ui.CheckboxWidget( { '$': this.$, 'label': ve.msg( 'visualeditor-dialog-meta-settings-noeditsection-label' ) } ); this.settingsFieldset.$element.append( this.disableSectionEditLinksInput.$element ); this.$element.append( this.settingsFieldset.$element ); }; /* Inheritance */ OO.inheritClass( ve.ui.MWSettingsPage, OO.ui.PageLayout ); /* Methods */ /** * Handle Table Of Contents display change events. * * @method */ ve.ui.MWSettingsPage.prototype.onTOCOptionChange = function () { this.tocOptionTouched = true; }; /** * Get Table Of Contents option * * @returns {ve.dm.MetaItem|null} TOC option, if any */ ve.ui.MWSettingsPage.prototype.getTOCOptionItem = function () { return this.metaList.getItemsInGroup( 'mwTOC' )[0] || null; }; /** * Get the section edit link disabling item * * @returns {Object|null} Section edit link disabling meta item, if any */ ve.ui.MWSettingsPage.prototype.getDisableSectionEditLinksItem = function () { return this.metaList.getItemsInGroup( 'mwNoEditSection' )[0] || null; }; /** * Setup settings page. * * @param {Object} [data] Dialog setup data */ ve.ui.MWSettingsPage.prototype.setup = function () { var tocOption = this.getTOCOptionItem(), tocType = tocOption && tocOption.element.type || 'default'; // Table of Contents items this.tocOptionSelector.selectItem( this.tocOptionWidgets[tocType] ); this.tocOptionTouched = false; // Disable section edit links items this.disableSectionEditLinksInput.setValue( !!this.getDisableSectionEditLinksItem() ); }; /** * Tear down settings page. * * @param {Object} [data] Dialog tear down data */ ve.ui.MWSettingsPage.prototype.teardown = function ( data ) { // Data initialisation data = data || {}; var // Table of Contents items currentTOCItem = this.getTOCOptionItem(), newTOCData = this.tocOptionSelector.getSelectedItem(), // Disable section edit links items currentDisableSectionEditLinksItem = this.getDisableSectionEditLinksItem(), newDisableSectionEditState = this.disableSectionEditLinksInput.getValue(); // Alter the TOC option flag iff it's been touched & is actually different if ( this.tocOptionTouched ) { if ( newTOCData.data === 'default' ) { if ( currentTOCItem ) { currentTOCItem.remove(); } } else { if ( !currentTOCItem ) { this.metaList.insertMeta( { 'type': newTOCData.data } ); } else if ( currentTOCItem.getType() !== newTOCData.data ) { currentTOCItem.replaceWith( ve.extendObject( true, {}, currentTOCItem.getElement(), { 'type': newTOCData.data } ) ); } } } // Disable section edit links items if ( currentDisableSectionEditLinksItem && !newDisableSectionEditState ) { currentDisableSectionEditLinksItem.remove(); } if ( !currentDisableSectionEditLinksItem && newDisableSectionEditState ) { this.metaList.insertMeta( { 'type': 'mwNoEditSection' } ); } };