<!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>[21962] trunk/wp-includes/js/mce-view.js: Improve documentation for wp.mce.view.add().</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/21962">21962</a></dd>
<dt>Author</dt> <dd>koopersmith</dd>
<dt>Date</dt> <dd>2012-09-24 02:18:15 +0000 (Mon, 24 Sep 2012)</dd>
</dl>
<h3>Log Message</h3>
<pre>Improve documentation for wp.mce.view.add(). Store view id in view options. see <a href="http://core.trac.wordpress.org/ticket/21812">#21812</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkwpincludesjsmceviewjs">trunk/wp-includes/js/mce-view.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwpincludesjsmceviewjs"></a>
<div class="modfile"><h4>Modified: trunk/wp-includes/js/mce-view.js (21961 => 21962)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-includes/js/mce-view.js 2012-09-24 00:13:18 UTC (rev 21961)
+++ trunk/wp-includes/js/mce-view.js 2012-09-24 02:18:15 UTC (rev 21962)
</span><span class="lines">@@ -20,12 +20,25 @@
</span><span class="cx"> //
</span><span class="cx"> // Accepts a unique `id` and an `options` object.
</span><span class="cx"> //
</span><del>- // `options`
- // If `view` is an object, it will automatically be passed to
- // `wp.mce.View.extend( view, properties )` to create a new view class.
</del><ins>+ // `options` accepts the following properties:
</ins><span class="cx"> //
</span><del>- // If the `view` provided is already a constructor, the `properties`
- // variable is ignored.
</del><ins>+ // `pattern` is the regular expression used to scan the content and
+ // detect matching views.
+ //
+ // `view` is a `Backbone.View` constructor. If a plain object is
+ // provided, it will automatically extend the parent constructor
+ // (usually `Backbone.View`). Views are instantiated when the `pattern`
+ // is successfully matched. The instance's `options` object is provided
+ // with the `original` matched value, the match `results` including
+ // capture groups, and the `viewType`, which is the constructor's `id`.
+ //
+ // `extend` an existing view by passing in its `id`. The current
+ // view will inherit all properties from the parent view, and if
+ // `view` is set to a plain object, it will extend the parent `view`
+ // constructor.
+ //
+ // `text` is a method that accepts an instance of the `view`
+ // constructor and transforms it into a text representation.
</ins><span class="cx"> add: function( id, options ) {
</span><span class="cx"> var parent;
</span><span class="cx">
</span><span class="lines">@@ -34,6 +47,7 @@
</span><span class="cx">
</span><span class="cx"> // Extend the `options` object with the parent's properties.
</span><span class="cx"> _.defaults( options, parent );
</span><ins>+ options.id = id;
</ins><span class="cx">
</span><span class="cx"> // If the `view` provided was an object, automatically create
</span><span class="cx"> // a new `Backbone.View` constructor, using the parent's `view`
</span></span></pre>
</div>
</div>
</body>
</html>