<!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>[45561] trunk/src/js/media/views/attachment/details.js: Docs: Improve JSDoc for `media/views/attachment/details.js`.</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 { white-space: pre-line; 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 { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { 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" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/45561">45561</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/45561","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>atimmer</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2019-06-22 13:01:22 +0000 (Sat, 22 Jun 2019)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Docs: Improve JSDoc for `media/views/attachment/details.js`.
Props maartenleenders, boblinthorst, dfangstrom.
Fixes <a href="https://core.trac.wordpress.org/ticket/47588">#47588</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcjsmediaviewsattachmentdetailsjs">trunk/src/js/media/views/attachment/details.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcjsmediaviewsattachmentdetailsjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/js/media/views/attachment/details.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/js/media/views/attachment/details.js 2019-06-22 11:12:58 UTC (rev 45560)
+++ trunk/src/js/media/views/attachment/details.js 2019-06-22 13:01:22 UTC (rev 45561)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3,17 +3,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $ = jQuery,
</span><span class="cx" style="display: block; padding: 0 10px"> Details;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-/**
- * wp.media.view.Attachment.Details
- *
- * @memberOf wp.media.view.Attachment
- *
- * @class
- * @augments wp.media.view.Attachment
- * @augments wp.media.View
- * @augments wp.Backbone.View
- * @augments Backbone.View
- */
</del><span class="cx" style="display: block; padding: 0 10px"> Details = Attachment.extend(/** @lends wp.media.view.Attachment.Details.prototype */{
</span><span class="cx" style="display: block; padding: 0 10px"> tagName: 'div',
</span><span class="cx" style="display: block; padding: 0 10px"> className: 'attachment-details',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -37,6 +26,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'keydown': 'toggleSelectionHandler'
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Shows the details of an attachment.
+ *
+ * @since 3.5.0
+ *
+ * @constructs wp.media.view.Attachment.Details
+ * @augments wp.media.view.Attachment
+ *
+ * @returns {void}
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> initialize: function() {
</span><span class="cx" style="display: block; padding: 0 10px"> this.options = _.defaults( this.options, {
</span><span class="cx" style="display: block; padding: 0 10px"> rerenderOnModelChange: false
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -98,7 +97,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param {Object} event
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Deletes an attachment.
+ *
+ * Deletes an attachment after asking for confirmation. After deletion,
+ * keeps focus in the modal.
+ *
+ * @since 3.5.0
+ *
+ * @param {MouseEvent} event A click event.
+ *
+ * @returns {void}
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> deleteAttachment: function( event ) {
</span><span class="cx" style="display: block; padding: 0 10px"> event.preventDefault();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -110,8 +118,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> this.moveFocus();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param {Object} event
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Sets the trash state on an attachment, or destroys the model itself.
+ *
+ * If the mediaTrash setting is set to true, trashes the attachment.
+ * Otherwise, the model itself is destroyed.
+ *
+ * @since 3.9.0
+ *
+ * @param {MouseEvent} event A click event.
+ *
+ * @returns {void}
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> trashAttachment: function( event ) {
</span><span class="cx" style="display: block; padding: 0 10px"> var library = this.controller.library,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -141,7 +159,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param {Object} event
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Untrashes an attachment.
+ *
+ * @since 4.0.0
+ *
+ * @param {MouseEvent} event A click event.
+ *
+ * @returns {void}
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> untrashAttachment: function( event ) {
</span><span class="cx" style="display: block; padding: 0 10px"> var library = this.controller.library;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -152,8 +176,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> library._requery( true );
</span><span class="cx" style="display: block; padding: 0 10px"> } );
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param {Object} event
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Opens the edit page for a specific attachment.
+ *
+ * @since 3.5.0
+ *
+ * @param {MouseEvent} event A click event.
+ *
+ * @returns {void}
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> editAttachment: function( event ) {
</span><span class="cx" style="display: block; padding: 0 10px"> var editState = this.controller.states.get( 'edit-image' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -166,11 +197,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> this.$el.addClass('needs-refresh');
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * When reverse tabbing (shift+tab) out of the right details panel,
- * move focus to the item that was being edited in the attachments list.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Triggers an event on the controller when reverse tabbing (shift+tab).
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param {Object} event
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * This event can be used to make sure to move the focus correctly.
+ *
+ * @since 4.0.0
+ *
+ * @fires wp.media.controller.MediaLibrary#attachment:details:shift-tab
+ * @fires wp.media.controller.MediaLibrary#attachment:keydown:arrow
+ *
+ * @param {KeyboardEvent} event A keyboard event.
+ *
+ * @returns {boolean|void} Returns false or undefined.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> toggleSelectionHandler: function( event ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'keydown' === event.type && 9 === event.keyCode && event.shiftKey && event.target === this.$( ':tabbable' ).get( 0 ) ) {
</span></span></pre>
</div>
</div>
</body>
</html>