<!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>[22681] trunk/wp-includes/js/media-views.js: Media: Add documentation to media.Views.</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/22681">22681</a></dd>
<dt>Author</dt> <dd>koopersmith</dd>
<dt>Date</dt> <dd>2012-11-19 10:40:49 +0000 (Mon, 19 Nov 2012)</dd>
</dl>
<h3>Log Message</h3>
<pre>Media: Add documentation to media.Views. 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 (22680 => 22681)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/js/media-views.js 2012-11-19 09:53:31 UTC (rev 22680)
+++ trunk/wp-includes/js/media-views.js 2012-11-19 10:40:49 UTC (rev 22681)
</span><span class="lines">@@ -574,15 +574,40 @@
</span><span class="cx"> media.Views.extend = Backbone.Model.extend;
</span><span class="cx">
</span><span class="cx"> _.extend( media.Views.prototype, {
</span><ins>+ // ### Fetch all of the subviews
+ //
+ // Returns an array of all subviews.
</ins><span class="cx"> all: function() {
</span><span class="cx"> return _.flatten( this._views );
</span><span class="cx"> },
</span><span class="cx">
</span><ins>+ // ### Get a selector's subviews
+ //
+ // Fetches all subviews that match a given `selector`.
+ //
+ // If no `selector` is provided, it will grab all subviews attached
+ // to the view's root.
</ins><span class="cx"> get: function( selector ) {
</span><span class="cx"> selector = selector || '';
</span><span class="cx"> return this._views[ selector ];
</span><span class="cx"> },
</span><span class="cx">
</span><ins>+ // ### Register subview(s)
+ //
+ // Registers any number of `views` to a `selector`.
+ //
+ // When no `selector` is provided, the root selector (the empty string)
+ // is used. `views` accepts a `Backbone.View` instance or an array of
+ // `Backbone.View` instances.
+ //
+ // Use `Views.add()` as a shortcut for setting `options.add` to `true`.
+ //
+ // Accepts an `options` object, which has a significant effect on the
+ // resulting behavior. By default, the provided `views` will replace
+ // any existing views associated with the selector. If `options.add`
+ // is set to `true`, the provided `views` will be added to the existing
+ // views. When adding, the `views` will added to the end of the array
+ // by default. To insert `views` at a specific index, use `options.at`.
</ins><span class="cx"> set: function( selector, views, options ) {
</span><span class="cx"> var $selector, els, existing, add, method;
</span><span class="cx">
</span><span class="lines">@@ -638,10 +663,30 @@
</span><span class="cx"> return this;
</span><span class="cx"> },
</span><span class="cx">
</span><ins>+ // ### Add subview(s) to existing subviews
+ //
+ // An alias to `Views.set()`, which defaults `options.add` to true.
+ //
+ // Adds any number of `views` to a `selector`.
+ //
+ // When no `selector` is provided, the root selector (the empty string)
+ // is used. `views` accepts a `Backbone.View` instance or an array of
+ // `Backbone.View` instances.
+ //
+ // Use `Views.set()` when setting `options.add` to `false`.
+ //
+ // Accepts an `options` object. By default, provided `views` will be
+ // inserted at the end of the array of existing views. To insert
+ // `views` at a specific index, use `options.at`. For more information
+ // on the `options` object, see `Views.set()`.
</ins><span class="cx"> add: function( selector, views, options ) {
</span><span class="cx"> return this.set( selector, views, _.extend({ add: true }, options ) );
</span><span class="cx"> },
</span><span class="cx">
</span><ins>+ // ### Stop tracking subviews
+ //
+ // Stops tracking `views` registered to a `selector`. If no `views` are
+ // set, then all of the `selector`'s subviews will be unregistered.
</ins><span class="cx"> unset: function( selector, views ) {
</span><span class="cx"> var existing;
</span><span class="cx">
</span><span class="lines">@@ -658,11 +703,20 @@
</span><span class="cx"> return this;
</span><span class="cx"> },
</span><span class="cx">
</span><ins>+ // ### Detach all subviews
+ //
+ // Detaches all subviews from the DOM.
+ //
+ // Helps to preserve all subview events when re-rendering the master
+ // view. Used in conjunction with `Views.render()`.
</ins><span class="cx"> detach: function() {
</span><span class="cx"> $( _.pluck( this.all(), 'el' ) ).detach();
</span><span class="cx"> return this;
</span><span class="cx"> },
</span><span class="cx">
</span><ins>+ // ### Render all subviews
+ //
+ // Renders all subviews. Used in conjunction with `Views.detach()`.
</ins><span class="cx"> render: function() {
</span><span class="cx"> var root = this._views[''];
</span><span class="cx">
</span><span class="lines">@@ -677,6 +731,10 @@
</span><span class="cx"> return this;
</span><span class="cx"> },
</span><span class="cx">
</span><ins>+ // ### Dispose all subviews
+ //
+ // Triggers the `dispose()` method on all subviews. Resets the
+ // internals of the views manager.
</ins><span class="cx"> dispose: function() {
</span><span class="cx"> delete this.parent;
</span><span class="cx"> delete this.selector;
</span><span class="lines">@@ -686,11 +744,23 @@
</span><span class="cx"> return this;
</span><span class="cx"> },
</span><span class="cx">
</span><ins>+ // ### Replace a selector's subviews
+ //
+ // By default, sets the `$target` selector's html to the subview `els`.
+ //
+ // Can be overridden in subclasses.
</ins><span class="cx"> replace: function( $target, els ) {
</span><span class="cx"> $target.html( els );
</span><span class="cx"> return this;
</span><span class="cx"> },
</span><span class="cx">
</span><ins>+ // ### Insert subviews into a selector
+ //
+ // By default, appends the subview `els` to the end of the `$target`
+ // selector. If `options.at` is set, inserts the subview `els` at the
+ // provided index.
+ //
+ // Can be overridden in subclasses.
</ins><span class="cx"> insert: function( $target, els, options ) {
</span><span class="cx"> var at = options && options.at,
</span><span class="cx"> $children;
</span></span></pre>
</div>
</div>
</body>
</html>