enmi-conf.org: comparison wp/wp-admin/js/postbox.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/postbox.js

changeset 9	177826044cd9
parent 7	cf61fcea0001
child 16	a86126ab1dd4

equal deleted inserted replaced

-:c7c34916027a
+:177826044cd9
 /**
 * Contains the postboxes logic, opening and closing postboxes, reordering and saving
 * the state and ordering to the database.
 *
-* @summary Contains postboxes logic
-*
 * @since 2.5.0
 * @requires jQuery
+* @output wp-admin/js/postbox.js
 */
-/* global ajaxurl, postBoxL10n */
+/* global ajaxurl, postBoxL10n, postboxes */
-/**
-* This object contains all function to handle the behaviour of the post boxes. The post boxes are the boxes you see
-* around the content on the edit page.
-*
-* @since 2.7.0
-*
-* @namespace postboxes
-*
-* @type {Object}
-*/
-var postboxes;
 (function($) {
 	var $document = $( document );
-	postboxes = {
+	/**
+	 * This object contains all function to handle the behaviour of the post boxes. The post boxes are the boxes you see
-		/**
+	 * around the content on the edit page.
-		 * @summary Handles a click on either the postbox heading or the postbox open/close icon.
+	 *
+	 * @since 2.7.0
+	 *
+	 * @namespace postboxes
+	 *
+	 * @type {Object}
+	 */
+	window.postboxes = {
+		/**
+		 * Handles a click on either the postbox heading or the postbox open/close icon.
 		 *
 		 * Opens or closes the postbox. Expects `this` to equal the clicked element.
 		 * Calls postboxes.pbshow if the postbox has been opened, calls postboxes.pbhide
 		 * if the postbox has been closed.
 		 *
 					postboxes.pbhide( id );
 				}
 			}
 			/**
-			 * @summary Fires when a postbox has been opened or closed.
+			 * Fires when a postbox has been opened or closed.
 			 *
 			 * Contains a jQuery object with the relevant postbox element.
 			 *
 			 * @since 4.0.0
+			 * @ignore
+			 *
 			 * @event postboxes#postbox-toggled
 			 * @type {Object}
 			 */
 			$document.trigger( 'postbox-toggled', p );
 		},
 			$('.postbox .hndle a').click( function(e) {
 				e.stopPropagation();
 			});
 			/**
-			 * @summary Hides a postbox.
+			 * Hides a postbox.
 			 *
 			 * Event handler for the postbox dismiss button. After clicking the button
 			 * the postbox will be hidden.
 			 *
 			 * @since 3.2.0
 				e.preventDefault();
 				$( '#' + hide_id ).prop('checked', false).triggerHandler('click');
 			});
 			/**
-			 * @summary Hides the postbox element
+			 * Hides the postbox element
 			 *
 			 * Event handler for the screen options checkboxes. When a checkbox is
 			 * clicked this function will hide or show the relevant postboxes.
 			 *
 			 * @since 2.7.0
+			 * @ignore
+			 *
 			 * @fires postboxes#postbox-toggled
 			 *
 			 * @returns {void}
 			 */
 			$('.hide-postbox-tog').bind('click.postboxes', function() {
 				 */
 				$document.trigger( 'postbox-toggled', $postbox );
 			});
 			/**
-			 * @summary Changes the amount of columns based on the layout preferences.
+			 * Changes the amount of columns based on the layout preferences.
 			 *
 			 * @since 2.8.0
 			 *
 			 * @returns {void}
 			 */
 				}
 			});
 		},
 		/**
-		 * @summary Initializes all the postboxes, mainly their sortable behaviour.
+		 * Initializes all the postboxes, mainly their sortable behaviour.
 		 *
 		 * @since 2.7.0
 		 * @memberof postboxes
 		 *
 		 * @param {string} page The page we are currently on.
 				$el.attr( 'aria-expanded', ! $el.parent( '.postbox' ).hasClass( 'closed' ) );
 			});
 		},
 		/**
-		 * @summary Saves the state of the postboxes to the server.
+		 * Saves the state of the postboxes to the server.
 		 *
-		 * Saves the state of the postboxes to the server. It sends two lists, one with
+		 * It sends two lists, one with all the closed postboxes, one with all the
-		 * all the closed postboxes, one with all the hidden postboxes.
+		 * hidden postboxes.
 		 *
 		 * @since 2.7.0
 		 * @memberof postboxes
 		 *
 		 * @param {string} page The page we are currently on.
 				page: page
 			});
 		},
 		/**
-		 * @summary Saves the order of the postboxes to the server.
+		 * Saves the order of the postboxes to the server.
 		 *
-		 * Saves the order of the postboxes to the server. Sends a list of all postboxes
+		 * Sends a list of all postboxes inside a sortable area to the server.
-		 * inside a sortable area to the server.
 		 *
 		 * @since 2.8.0
 		 * @memberof postboxes
 		 *
 		 * @param {string} page The page we are currently on.
 			$.post( ajaxurl, postVars );
 		},
 		/**
-		 * @summary Marks empty postbox areas.
+		 * Marks empty postbox areas.
 		 *
 		 * Adds a message to empty sortable areas on the dashboard page. Also adds a
 		 * border around the side area on the post edit screen if there are no postboxes
 		 * present.
 		 *
 					side.addClass('empty-container');
 			}
 		},
 		/**
-		 * @summary Changes the amount of columns on the post edit page.
+		 * Changes the amount of columns on the post edit page.
 		 *
 		 * @since 3.3.0
 		 * @memberof postboxes
 		 * @fires postboxes#postboxes-columnchange
 		 * @access private
 			/**
 			 * Fires when the amount of columns on the post edit page has been changed.
 			 *
 			 * @since 4.0.0
+			 * @ignore
+			 *
 			 * @event postboxes#postboxes-columnchange
 			 */
 			$( document ).trigger( 'postboxes-columnchange' );
 		},
 		/**
-		 * @summary Changes the amount of columns the postboxes are in based on the
+		 * Changes the amount of columns the postboxes are in based on the current
-		 *          current orientation of the browser.
+		 * orientation of the browser.
 		 *
 		 * @since 3.3.0
 		 * @memberof postboxes
 		 * @access private
 		 *

enmi-conf.org