enmi-conf.org: comparison wp/wp-admin/js/widgets/media-widgets.js

Mercurial Mercurial > enmi-conf.org / comparison

summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help

wp/wp-admin/js/widgets/media-widgets.js

changeset 16	a86126ab1dd4
parent 9	177826044cd9
child 18	be944660c56a

equal deleted inserted replaced

-:3d4e9c994f10
+:a86126ab1dd4
 		 * @constructs wp.mediaWidgets.PersistentDisplaySettingsLibrary
 		 * @augments   wp.media.controller.Library
 		 *
 		 * @param {Object} options - Options.
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		initialize: function initialize( options ) {
 			_.bindAll( this, 'handleDisplaySettingChange' );
 			wp.media.controller.Library.prototype.initialize.call( this, options );
 		},
 		/**
 		 * Sync changes to the current display settings back into the current customized.
 		 *
 		 * @param {Backbone.Model} displaySettings - Modified display settings.
-		 * @returns {void}
+		 * @return {void}
 		 */
 		handleDisplaySettingChange: function handleDisplaySettingChange( displaySettings ) {
 			this.get( 'selectedDisplaySettings' ).set( displaySettings.attributes );
 		},
 		 * and an event listener is added so that changes made to the settings
 		 * will sync back into the model storing the session's customized display
 		 * settings.
 		 *
 		 * @param {Backbone.Model} model - Display settings model.
-		 * @returns {Backbone.Model} Display settings model.
+		 * @return {Backbone.Model} Display settings model.
 		 */
 		display: function getDisplaySettingsModel( model ) {
 			var display, selectedDisplaySettings = this.get( 'selectedDisplaySettings' );
 			display = wp.media.controller.Library.prototype.display.call( this, model );
 		/**
 		 * Initialize.
 		 *
 		 * @since 4.9.0
 		 *
-		 * @param {object} options - Options.
+		 * @param {Object} options - Options.
-		 * @returns {void}
+		 * @return {void}
 		 */
 		initialize: function( options ) {
 			var view = this, embedController; // eslint-disable-line consistent-this
 			wp.media.view.Embed.prototype.initialize.call( view, options );
 			if ( 'image' !== view.controller.options.mimeType ) {
 		/**
 		 * Refresh embed view.
 		 *
 		 * Forked override of {wp.media.view.Embed#refresh()} to suppress irrelevant "link text" field.
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		refresh: function refresh() {
 			/**
 			 * @class wp.mediaWidgets~Constructor
 			 */
 					/**
 					 * Set the disabled state on the Add to Widget button.
 					 *
 					 * @param {boolean} disabled - Disabled.
-					 * @returns {void}
+					 * @return {void}
 					 */
 					setAddToWidgetButtonDisabled: function setAddToWidgetButtonDisabled( disabled ) {
 						this.views.parent.views.parent.views.get( '.media-frame-toolbar' )[0].$el.find( '.media-button-select' ).prop( 'disabled', disabled );
 					},
 					/**
 					 * Set or clear an error notice.
 					 *
 					 * @param {string} notice - Notice.
-					 * @returns {void}
+					 * @return {void}
 					 */
 					setErrorNotice: function setErrorNotice( notice ) {
 						var embedLinkView = this, noticeContainer; // eslint-disable-line consistent-this
 						noticeContainer = embedLinkView.views.parent.$el.find( '> .notice:first-child' );
 					/**
 					 * Update oEmbed.
 					 *
 					 * @since 4.9.0
 					 *
-					 * @returns {void}
+					 * @return {void}
 					 */
 					updateoEmbed: function() {
 						var embedLinkView = this, url; // eslint-disable-line consistent-this
 						url = embedLinkView.model.get( 'url' );
 					},
 					/**
 					 * Fetch media.
 					 *
-					 * @returns {void}
+					 * @return {void}
 					 */
 					fetch: function() {
 						var embedLinkView = this, fetchSuccess, matches, fileExt, urlParser, url, re, youTubeEmbedMatch; // eslint-disable-line consistent-this
 						url = embedLinkView.model.get( 'url' );
 					 *
 					 * Overrides the {EmbedLink#renderFail()} method to prevent showing the "Link Text" field.
 					 * The element is getting display:none in the stylesheet, but the underlying method uses
 					 * uses {jQuery.fn.show()} which adds an inline style. This avoids the need for !important.
 					 *
-					 * @returns {void}
+					 * @return {void}
 					 */
 					renderFail: function renderFail() {
 						var embedLinkView = this; // eslint-disable-line consistent-this
 						embedLinkView.controller.$el.find( '#embed-url-field' ).addClass( 'invalid' );
 						embedLinkView.setErrorNotice( embedLinkView.controller.options.invalidEmbedTypeError || 'ERROR' );
 	component.MediaFrameSelect = wp.media.view.MediaFrame.Post.extend(/** @lends wp.mediaWidgets.MediaFrameSelect.prototype */{
 		/**
 		 * Create the default states.
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		createStates: function createStates() {
 			var mime = this.options.mimeType, specificMimes = [];
 			_.each( wp.media.view.settings.embedMimes, function( embedMime ) {
 				if ( 0 === embedMime.indexOf( mime ) ) {
 		 *
 		 * Forked override of {wp.media.view.MediaFrame.Post#mainInsertToolbar()} to override text.
 		 *
 		 * @param {wp.Backbone.View} view - Toolbar view.
 		 * @this {wp.media.controller.Library}
-		 * @returns {void}
+		 * @return {void}
 		 */
 		mainInsertToolbar: function mainInsertToolbar( view ) {
 			var controller = this; // eslint-disable-line consistent-this
 			view.set( 'insert', {
 				style:    'primary',
 				 * Handle click.
 				 *
 				 * @ignore
 				 *
 				 * @fires wp.media.controller.State#insert()
-				 * @returns {void}
+				 * @return {void}
 				 */
 				click: function onClick() {
 					var state = controller.state(),
 						selection = state.get( 'selection' );
 		 *
 		 * Forked override of {wp.media.view.MediaFrame.Post#mainEmbedToolbar()} to override text.
 		 *
 		 * @param {wp.Backbone.View} toolbar - Toolbar view.
 		 * @this {wp.media.controller.Library}
-		 * @returns {void}
+		 * @return {void}
 		 */
 		mainEmbedToolbar: function mainEmbedToolbar( toolbar ) {
 			toolbar.view = new wp.media.view.Toolbar.Embed({
 				controller: this,
 				text: this.options.text,
 		/**
 		 * Embed content.
 		 *
 		 * Forked override of {wp.media.view.MediaFrame.Post#embedContent()} to suppress irrelevant "link text" field.
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		embedContent: function embedContent() {
 			var view = new component.MediaEmbedView({
 				controller: this,
 				model:      this.state()
 			}).render();
 			this.content.set( view );
-			if ( ! wp.media.isTouchDevice ) {
-				view.url.focus();
-			}
 		}
 	});
 	component.MediaWidgetControl = Backbone.View.extend(/** @lends wp.mediaWidgets.MediaWidgetControl.prototype */{
 		 * @param {Object}         options - Options.
 		 * @param {Backbone.Model} options.model - Model.
 		 * @param {jQuery}         options.el - Control field container element.
 		 * @param {jQuery}         options.syncContainer - Container element where fields are synced for the server.
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		initialize: function initialize( options ) {
 			var control = this;
 			Backbone.View.prototype.initialize.call( control, options );
 		},
 		/**
 		 * Update the selected attachment if necessary.
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		updateSelectedAttachment: function updateSelectedAttachment() {
 			var control = this, attachment;
 			if ( 0 === control.model.get( 'attachment_id' ) ) {
 		},
 		/**
 		 * Sync the model attributes to the hidden inputs, and update previewTemplateProps.
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		syncModelToPreviewProps: function syncModelToPreviewProps() {
 			var control = this;
 			control.previewTemplateProps.set( control.mapModelToPreviewTemplateProps() );
 		},
 		/**
 		 * Sync the model attributes to the hidden inputs, and update previewTemplateProps.
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		syncModelToInputs: function syncModelToInputs() {
 			var control = this;
 			control.syncContainer.find( '.media-widget-instance-property' ).each( function() {
 				var input = $( this ), value, propertyName;
 		},
 		/**
 		 * Get template.
 		 *
-		 * @returns {Function} Template.
+		 * @return {Function} Template.
 		 */
 		template: function template() {
 			var control = this;
 			if ( ! $( '#tmpl-widget-media-' + control.id_base + '-control' ).length ) {
 				throw new Error( 'Missing widget control template for ' + control.id_base );
 		},
 		/**
 		 * Render template.
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		render: function render() {
 			var control = this, titleInput;
 			if ( ! control.templateRendered ) {
 		/**
 		 * Render media preview.
 		 *
 		 * @abstract
-		 * @returns {void}
+		 * @return {void}
 		 */
 		renderPreview: function renderPreview() {
 			throw new Error( 'renderPreview must be implemented' );
 		},
 		/**
 		 * Whether a media item is selected.
 		 *
-		 * @returns {boolean} Whether selected and no error.
+		 * @return {boolean} Whether selected and no error.
 		 */
 		isSelected: function isSelected() {
 			var control = this;
 			if ( control.model.get( 'error' ) ) {
 		/**
 		 * Handle click on link to Media Library to open modal, such as the link that appears when in the missing attachment error notice.
 		 *
 		 * @param {jQuery.Event} event - Event.
-		 * @returns {void}
+		 * @return {void}
 		 */
 		handleMediaLibraryLinkClick: function handleMediaLibraryLinkClick( event ) {
 			var control = this;
 			event.preventDefault();
 			control.selectMedia();
 		},
 		/**
 		 * Open the media select frame to chose an item.
 		 *
-		 * @returns {void}
+		 * @return {void}
 		 */
 		selectMedia: function selectMedia() {
 			var control = this, selection, mediaFrame, defaultSync, mediaFrameProps, selectionModels = [];
 			if ( control.isSelected() && 0 !== control.model.get( 'attachment_id' ) ) {
 		/**
 		 * Get the instance props from the media selection frame.
 		 *
 		 * @param {wp.media.view.MediaFrame.Select} mediaFrame - Select frame.
-		 * @returns {Object} Props.
+		 * @return {Object} Props.
 		 */
 		getModelPropsFromMediaFrame: function getModelPropsFromMediaFrame( mediaFrame ) {
 			var control = this, state, mediaFrameProps, modelProps;
 			state = mediaFrame.state();
 		/**
 		 * Map media frame props to model props.
 		 *
 		 * @param {Object} mediaFrameProps - Media frame props.
-		 * @returns {Object} Model props.
+		 * @return {Object} Model props.
 		 */
 		mapMediaToModelProps: function mapMediaToModelProps( mediaFrameProps ) {
 			var control = this, mediaFramePropToModelPropMap = {}, modelProps = {}, extension;
 			_.each( control.model.schema, function( fieldSchema, modelProp ) {
 		/**
 		 * Map model props to media frame props.
 		 *
 		 * @param {Object} modelProps - Model props.
-		 * @returns {Object} Media frame props.
+		 * @return {Object} Media frame props.
 		 */
 		mapModelToMediaFrameProps: function mapModelToMediaFrameProps( modelProps ) {
 			var control = this, mediaFrameProps = {};
 			_.each( modelProps, function( value, modelProp ) {
 		},
 		/**
 		 * Map model props to previewTemplateProps.
 		 *
-		 * @returns {Object} Preview Template Props.
+		 * @return {Object} Preview Template Props.
 		 */
 		mapModelToPreviewTemplateProps: function mapModelToPreviewTemplateProps() {
 			var control = this, previewTemplateProps = {};
 			_.each( control.model.schema, function( value, prop ) {
 				if ( ! value.hasOwnProperty( 'should_preview_update' ) || value.should_preview_update ) {
 		/**
 		 * Open the media frame to modify the selected item.
 		 *
 		 * @abstract
-		 * @returns {void}
+		 * @return {void}
 		 */
 		editMedia: function editMedia() {
 			throw new Error( 'editMedia not implemented' );
 		}
 	});
 		},
 		/**
 		 * Get default attribute values.
 		 *
-		 * @returns {Object} Mapping of property names to their default values.
+		 * @return {Object} Mapping of property names to their default values.
 		 */
 		defaults: function() {
 			var defaults = {};
 			_.each( this.schema, function( fieldSchema, field ) {
 				defaults[ field ] = fieldSchema['default'];
 		 * the appropriate data types (integers or booleans).
 		 *
 		 * @param {string|Object} key - Attribute name or attribute pairs.
 		 * @param {mixed|Object}  [val] - Attribute value or options object.
 		 * @param {Object}        [options] - Options when attribute name and value are passed separately.
-		 * @returns {wp.mediaWidgets.MediaWidgetModel} This model.
+		 * @return {wp.mediaWidgets.MediaWidgetModel} This model.
 		 */
 		set: function set( key, val, options ) {
 			var model = this, attrs, opts, castedAttrs; // eslint-disable-line consistent-this
 			if ( null === key ) {
 				return model;
 		},
 		/**
 		 * Get props which are merged on top of the model when an embed is chosen (as opposed to an attachment).
 		 *
-		 * @returns {Object} Reset/override props.
+		 * @return {Object} Reset/override props.
 		 */
 		getEmbedResetProps: function getEmbedResetProps() {
 			return {
 				id: 0
 			};
 	 * @memberOf wp.mediaWidgets
 	 *
 	 * @param {jQuery.Event} event - Event.
 	 * @param {jQuery}       widgetContainer - Widget container element.
 	 *
-	 * @returns {void}
+	 * @return {void}
 	 */
 	component.handleWidgetAdded = function handleWidgetAdded( event, widgetContainer ) {
 		var fieldContainer, syncContainer, widgetForm, idBase, ControlConstructor, ModelConstructor, modelAttributes, widgetControl, widgetModel, widgetId, animatedCheckDelay = 50, renderWhenAnimationDone;
 		widgetForm = widgetContainer.find( '> .widget-inside > .form, > .widget-inside > form' ); // Note: '.form' appears in the customizer, whereas 'form' on the widgets admin screen.
 		idBase = widgetForm.find( '> .id_base' ).val();
 	/**
 	 * Setup widget in accessibility mode.
 	 *
 	 * @memberOf wp.mediaWidgets
 	 *
-	 * @returns {void}
+	 * @return {void}
 	 */
 	component.setupAccessibleMode = function setupAccessibleMode() {
 		var widgetForm, widgetId, idBase, widgetControl, ControlConstructor, ModelConstructor, modelAttributes, fieldContainer, syncContainer;
 		widgetForm = $( '.editwidget > form' );
 		if ( 0 === widgetForm.length ) {
 	 * @memberOf wp.mediaWidgets
 	 *
 	 * @param {jQuery.Event} event - Event.
 	 * @param {jQuery}       widgetContainer - Widget container element.
 	 *
-	 * @returns {void}
+	 * @return {void}
 	 */
 	component.handleWidgetUpdated = function handleWidgetUpdated( event, widgetContainer ) {
 		var widgetForm, widgetContent, widgetId, widgetControl, attributes = {};
 		widgetForm = widgetContainer.find( '> .widget-inside > .form, > .widget-inside > form' );
 		widgetId = widgetForm.find( '> .widget-id' ).val();
 	 * When WordPress enqueues this script, it should have an inline script
 	 * attached which calls wp.mediaWidgets.init().
 	 *
 	 * @memberOf wp.mediaWidgets
 	 *
-	 * @returns {void}
+	 * @return {void}
 	 */
 	component.init = function init() {
 		var $document = $( document );
 		$document.on( 'widget-added', component.handleWidgetAdded );
 		$document.on( 'widget-synced widget-updated', component.handleWidgetUpdated );

enmi-conf.org