<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[22692] trunk/wp-includes/js/media-views.js: Media: Detect when views are added to the DOM and fire a ready event.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg > ul, #logmsg > ol { margin-left: 0; margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://core.trac.wordpress.org/changeset/22692">22692</a></dd>
<dt>Author</dt> <dd>koopersmith</dd>
<dt>Date</dt> <dd>2012-11-20 00:53:02 +0000 (Tue, 20 Nov 2012)</dd>
</dl>
<h3>Log Message</h3>
<pre>Media: Detect when views are added to the DOM and fire a ready event. see <a href="http://core.trac.wordpress.org/ticket/21390">#21390</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkwpincludesjsmediaviewsjs">trunk/wp-includes/js/media-views.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwpincludesjsmediaviewsjs"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/js/media-views.js (22691 => 22692)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/js/media-views.js 2012-11-19 22:58:31 UTC (rev 22691)
+++ trunk/wp-includes/js/media-views.js 2012-11-20 00:53:02 UTC (rev 22692)
</span><span class="lines">@@ -632,7 +632,7 @@
</span><span class="cx"> // > When adding, to insert `views` at a specific index, use
</span><span class="cx"> // `options.at`. By default, `views` are added to the end of the array.
</span><span class="cx"> set: function( selector, views, options ) {
</span><del>- var $selector, els, existing, method;
</del><ins>+ var existing, next;
</ins><span class="cx">
</span><span class="cx"> if ( ! _.isString( selector ) ) {
</span><span class="cx"> options = views;
</span><span class="lines">@@ -644,7 +644,6 @@
</span><span class="cx"> views = _.isArray( views ) ? views : [ views ];
</span><span class="cx"> existing = this.get( selector );
</span><span class="cx"> next = views;
</span><del>- method = options.add ? 'insert' : 'replace';
</del><span class="cx">
</span><span class="cx"> if ( existing ) {
</span><span class="cx"> if ( options.add ) {
</span><span class="lines">@@ -672,9 +671,6 @@
</span><span class="cx">
</span><span class="cx"> this._views[ selector ] = next;
</span><span class="cx">
</span><del>- $selector = selector ? this.view.$( selector ) : this.view.$el;
- els = _.pluck( views, 'el' );
-
</del><span class="cx"> _.each( views, function( subview ) {
</span><span class="cx"> var constructor = subview.Views || media.Views,
</span><span class="cx"> subviews = subview.views = subview.views || new constructor( subview );
</span><span class="lines">@@ -682,10 +678,8 @@
</span><span class="cx"> subviews.selector = selector;
</span><span class="cx"> }, this );
</span><span class="cx">
</span><del>- if ( ! options.silent ) {
- _.each( views, this._maybeRender, this );
- this[ method ]( $selector, els, options );
- }
</del><ins>+ if ( ! options.silent )
+ this._attach( selector, views, _.extend({ ready: this._isReady() }, options ) );
</ins><span class="cx">
</span><span class="cx"> return this;
</span><span class="cx"> },
</span><span class="lines">@@ -755,16 +749,12 @@
</span><span class="cx"> //
</span><span class="cx"> // Renders all subviews. Used in conjunction with `Views.detach()`.
</span><span class="cx"> render: function() {
</span><del>- var root = this._views[''];
</del><ins>+ var options = {
+ ready: this._isReady()
+ };
</ins><span class="cx">
</span><del>- _.each( this.all(), this._maybeRender, this );
-
- if ( root )
- this.replace( this.view.$el, _.pluck( root, 'el' ) );
-
</del><span class="cx"> _.each( this._views, function( views, selector ) {
</span><del>- if ( selector )
- this.replace( this.view.$( selector ), _.pluck( views, 'el' ) );
</del><ins>+ this._attach( selector, views, options );
</ins><span class="cx"> }, this );
</span><span class="cx">
</span><span class="cx"> this.rendered = true;
</span><span class="lines">@@ -820,14 +810,71 @@
</span><span class="cx"> return this;
</span><span class="cx"> },
</span><span class="cx">
</span><ins>+ // ### Trigger the ready event
+ //
+ // **Only use this method if you know what you're doing.**
+ // For performance reasons, this method does not check if the view is
+ // actually attached to the DOM. It's taking your word for it.
+ //
+ // Fires the ready event on the current view and all attached subviews.
+ ready: function() {
+ this.view.trigger('ready');
</ins><span class="cx">
</span><del>- // #### Internal. Maybe render a view.
- _maybeRender: function( view ) {
- if ( ! view.views || view.views.rendered )
- return;
</del><ins>+ // Find all attached subviews, and call ready on them.
+ _.chain( this.all() ).map( function( view ) {
+ return view.views;
+ }).flatten().where({ attached: true }).invoke('ready');
+ },
</ins><span class="cx">
</span><del>- view.render();
- view.views.rendered = true;
</del><ins>+ // #### Internal. Attaches a series of views to a selector.
+ //
+ // Checks to see if a matching selector exists, renders the views,
+ // performs the proper DOM operation, and then checks if the view is
+ // attached to the document.
+ _attach: function( selector, views, options ) {
+ var $selector = selector ? this.view.$( selector ) : this.view.$el,
+ managers;
+
+ // Check if we found a location to attach the views.
+ if ( ! $selector.length )
+ return this;
+
+ managers = _.chain( views ).pluck('views').flatten().value();
+
+ // Render the views if necessary.
+ _.each( managers, function( manager ) {
+ if ( manager.rendered )
+ return;
+
+ manager.view.render();
+ manager.rendered = true;
+ }, this );
+
+ // Insert or replace the views.
+ this[ options.add ? 'insert' : 'replace' ]( $selector, _.pluck( views, 'el' ), options );
+
+ // Set attached and trigger ready if the current view is already
+ // attached to the DOM.
+ _.each( managers, function( manager ) {
+ manager.attached = true;
+
+ if ( options.ready )
+ manager.ready();
+ }, this );
+
+ return this;
+ },
+
+ // #### Internal. Checks if the current view is in the DOM.
+ _isReady: function() {
+ var node = this.view.el;
+ while ( node ) {
+ if ( node === document.body )
+ return true;
+ node = node.parentNode;
+ }
+
+ return false;
</ins><span class="cx"> }
</span><span class="cx"> });
</span><span class="cx">
</span><span class="lines">@@ -841,6 +888,7 @@
</span><span class="cx">
</span><span class="cx"> constructor: function() {
</span><span class="cx"> this.views = new this.Views( this, this.views );
</span><ins>+ this.on( 'ready', this.ready, this );
</ins><span class="cx"> Backbone.View.apply( this, arguments );
</span><span class="cx"> },
</span><span class="cx">
</span><span class="lines">@@ -885,7 +933,9 @@
</span><span class="cx">
</span><span class="cx"> prepare: function() {
</span><span class="cx"> return this.options;
</span><del>- }
</del><ins>+ },
+
+ ready: function() {}
</ins><span class="cx"> });
</span><span class="cx">
</span><span class="cx"> /**
</span><span class="lines">@@ -967,6 +1017,8 @@
</span><span class="cx"> }
</span><span class="cx"> });
</span><span class="cx"> }
</span><ins>+
+ this.on( 'attach', _.bind( this.views.ready, this.views ), this );
</ins><span class="cx"> },
</span><span class="cx">
</span><span class="cx"> render: function() {
</span><span class="lines">@@ -1060,9 +1112,9 @@
</span><span class="cx"> // Map some of the modal's methods to the frame.
</span><span class="cx"> _.each(['open','close','attach','detach'], function( method ) {
</span><span class="cx"> media.view.MediaFrame.prototype[ method ] = function( view ) {
</span><del>- this.trigger( method );
</del><span class="cx"> if ( this.modal )
</span><span class="cx"> this.modal[ method ].apply( this.modal, arguments );
</span><ins>+ this.trigger( method );
</ins><span class="cx"> return this;
</span><span class="cx"> };
</span><span class="cx"> });
</span><span class="lines">@@ -1592,25 +1644,25 @@
</span><span class="cx">
</span><span class="cx"> attach: function() {
</span><span class="cx"> this.$el.appendTo( this.options.container );
</span><del>- this.controller.trigger( 'attach', this.controller );
</del><ins>+ this.trigger('attach');
</ins><span class="cx"> return this;
</span><span class="cx"> },
</span><span class="cx">
</span><span class="cx"> detach: function() {
</span><span class="cx"> this.$el.detach();
</span><del>- this.controller.trigger( 'detach', this.controller );
</del><ins>+ this.trigger('detach');
</ins><span class="cx"> return this;
</span><span class="cx"> },
</span><span class="cx">
</span><span class="cx"> open: function() {
</span><span class="cx"> this.$el.show();
</span><del>- this.controller.trigger( 'open', this.controller );
</del><ins>+ this.trigger('open');
</ins><span class="cx"> return this;
</span><span class="cx"> },
</span><span class="cx">
</span><span class="cx"> close: function() {
</span><span class="cx"> this.$el.hide();
</span><del>- this.controller.trigger( 'close', this.controller );
</del><ins>+ this.trigger('close');
</ins><span class="cx"> return this;
</span><span class="cx"> },
</span><span class="cx">
</span></span></pre>
</div>
</div>
</body>
</html>