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 9	177826044cd9
parent 7	cf61fcea0001
child 16	a86126ab1dd4

equal deleted inserted replaced

-:c7c34916027a
+:177826044cd9
+/**
+* @output wp-admin/js/widgets/media-widgets.js
+*/
 /* eslint consistent-this: [ "error", "control" ] */
+/**
+* @namespace wp.mediaWidgets
+* @memberOf  wp
+*/
 wp.mediaWidgets = ( function( $ ) {
 	'use strict';
 	var component = {};
 	/**
 	 * Widget control (view) constructors, mapping widget id_base to subclass of MediaWidgetControl.
 	 *
 	 * Media widgets register themselves by assigning subclasses of MediaWidgetControl onto this object by widget ID base.
+	 *
+	 * @memberOf wp.mediaWidgets
 	 *
 	 * @type {Object.<string, wp.mediaWidgets.MediaWidgetModel>}
 	 */
 	component.controlConstructors = {};
 	/**
 	 * Widget model constructors, mapping widget id_base to subclass of MediaWidgetModel.
 	 *
 	 * Media widgets register themselves by assigning subclasses of MediaWidgetControl onto this object by widget ID base.
 	 *
+	 * @memberOf wp.mediaWidgets
+	 *
 	 * @type {Object.<string, wp.mediaWidgets.MediaWidgetModel>}
 	 */
 	component.modelConstructors = {};
-	/**
+	component.PersistentDisplaySettingsLibrary = wp.media.controller.Library.extend(/** @lends wp.mediaWidgets.PersistentDisplaySettingsLibrary.prototype */{
-	 * Library which persists the customized display settings across selections.
-	 *
+		/**
-	 * @class PersistentDisplaySettingsLibrary
+		 * Library which persists the customized display settings across selections.
-	 * @constructor
+		 *
-	 */
+		 * @constructs wp.mediaWidgets.PersistentDisplaySettingsLibrary
-	component.PersistentDisplaySettingsLibrary = wp.media.controller.Library.extend({
+		 * @augments   wp.media.controller.Library
-		/**
-		 * Initialize.
 		 *
 		 * @param {Object} options - Options.
+		 *
 		 * @returns {void}
 		 */
 		initialize: function initialize( options ) {
 			_.bindAll( this, 'handleDisplaySettingChange' );
 			wp.media.controller.Library.prototype.initialize.call( this, options );
 	});
 	/**
 	 * Extended view for managing the embed UI.
 	 *
-	 * @class MediaEmbedView
+	 * @class    wp.mediaWidgets.MediaEmbedView
-	 * @constructor
+	 * @augments wp.media.view.Embed
 	 */
-	component.MediaEmbedView = wp.media.view.Embed.extend({
+	component.MediaEmbedView = wp.media.view.Embed.extend(/** @lends wp.mediaWidgets.MediaEmbedView.prototype */{
 		/**
 		 * Initialize.
 		 *
 		 * @since 4.9.0
 		 * Forked override of {wp.media.view.Embed#refresh()} to suppress irrelevant "link text" field.
 		 *
 		 * @returns {void}
 		 */
 		refresh: function refresh() {
+			/**
+			 * @class wp.mediaWidgets~Constructor
+			 */
 			var Constructor;
 			if ( 'image' === this.controller.options.mimeType ) {
 				Constructor = wp.media.view.EmbedImage;
 			} else {
 				// This should be eliminated once #40450 lands of when this is merged into core.
-				Constructor = wp.media.view.EmbedLink.extend({
+				Constructor = wp.media.view.EmbedLink.extend(/** @lends wp.mediaWidgets~Constructor.prototype */{
 					/**
 					 * Set the disabled state on the Add to Widget button.
 					 *
 					 * @param {boolean} disabled - Disabled.
 	});
 	/**
 	 * Custom media frame for selecting uploaded media or providing media by URL.
 	 *
-	 * @class MediaFrameSelect
+	 * @class    wp.mediaWidgets.MediaFrameSelect
-	 * @constructor
+	 * @augments wp.media.view.MediaFrame.Post
 	 */
-	component.MediaFrameSelect = wp.media.view.MediaFrame.Post.extend({
+	component.MediaFrameSelect = wp.media.view.MediaFrame.Post.extend(/** @lends wp.mediaWidgets.MediaFrameSelect.prototype */{
 		/**
 		 * Create the default states.
 		 *
 		 * @returns {void}
 				requires: { selection: true },
 				/**
 				 * Handle click.
 				 *
+				 * @ignore
+				 *
 				 * @fires wp.media.controller.State#insert()
 				 * @returns {void}
 				 */
 				click: function onClick() {
 					var state = controller.state(),
 				view.url.focus();
 			}
 		}
 	});
-	/**
+	component.MediaWidgetControl = Backbone.View.extend(/** @lends wp.mediaWidgets.MediaWidgetControl.prototype */{
-	 * Media widget control.
-	 *
-	 * @class MediaWidgetControl
-	 * @constructor
-	 * @abstract
-	 */
-	component.MediaWidgetControl = Backbone.View.extend({
 		/**
 		 * Translation strings.
 		 *
 		 * The mapping of translation strings is handled by media widget subclasses,
 		 * @type {boolean}
 		 */
 		showDisplaySettings: true,
 		/**
-		 * Initialize.
+		 * Media Widget Control.
+		 *
+		 * @constructs wp.mediaWidgets.MediaWidgetControl
+		 * @augments   Backbone.View
+		 * @abstract
 		 *
 		 * @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}
 		 */
 		initialize: function initialize( options ) {
 			var control = this;
 	});
 	/**
 	 * Media widget model.
 	 *
-	 * @class MediaWidgetModel
+	 * @class    wp.mediaWidgets.MediaWidgetModel
-	 * @constructor
+	 * @augments Backbone.Model
 	 */
-	component.MediaWidgetModel = Backbone.Model.extend({
+	component.MediaWidgetModel = Backbone.Model.extend(/** @lends wp.mediaWidgets.MediaWidgetModel.prototype */{
 		/**
 		 * Id attribute.
 		 *
 		 * @type {string}
 	});
 	/**
 	 * Collection of all widget model instances.
 	 *
+	 * @memberOf wp.mediaWidgets
+	 *
 	 * @type {Backbone.Collection}
 	 */
-	component.modelCollection = new ( Backbone.Collection.extend({
+	component.modelCollection = new ( Backbone.Collection.extend( {
 		model: component.MediaWidgetModel
 	}) )();
 	/**
 	 * Mapping of widget ID to instances of MediaWidgetControl subclasses.
+	 *
+	 * @memberOf wp.mediaWidgets
 	 *
 	 * @type {Object.<string, wp.mediaWidgets.MediaWidgetControl>}
 	 */
 	component.widgetControls = {};
 	/**
 	 * Handle widget being added or initialized for the first time at the widget-added event.
 	 *
+	 * @memberOf wp.mediaWidgets
+	 *
 	 * @param {jQuery.Event} event - Event.
 	 * @param {jQuery}       widgetContainer - Widget container element.
+	 *
 	 * @returns {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.
 	};
 	/**
 	 * Setup widget in accessibility mode.
 	 *
+	 * @memberOf wp.mediaWidgets
+	 *
 	 * @returns {void}
 	 */
 	component.setupAccessibleMode = function setupAccessibleMode() {
 		var widgetForm, widgetId, idBase, widgetControl, ControlConstructor, ModelConstructor, modelAttributes, fieldContainer, syncContainer;
 		widgetForm = $( '.editwidget > form' );
 	 *
 	 * This gets called via the 'widget-updated' event when saving a widget from
 	 * the widgets admin screen and also via the 'widget-synced' event when making
 	 * a change to a widget in the customizer.
 	 *
+	 * @memberOf wp.mediaWidgets
+	 *
 	 * @param {jQuery.Event} event - Event.
 	 * @param {jQuery}       widgetContainer - Widget container element.
+	 *
 	 * @returns {void}
 	 */
 	component.handleWidgetUpdated = function handleWidgetUpdated( event, widgetContainer ) {
 		var widgetForm, widgetContent, widgetId, widgetControl, attributes = {};
 		widgetForm = widgetContainer.find( '> .widget-inside > .form, > .widget-inside > form' );
 	 * Initialize functionality.
 	 *
 	 * This function exists to prevent the JS file from having to boot itself.
 	 * When WordPress enqueues this script, it should have an inline script
 	 * attached which calls wp.mediaWidgets.init().
+	 *
+	 * @memberOf wp.mediaWidgets
 	 *
 	 * @returns {void}
 	 */
 	component.init = function init() {
 		var $document = $( document );

enmi-conf.org