Added chrome.experimental.devtools.panels.setOpenResourceHandler()

BUG=none
TEST=none


Review URL: http://codereview.chromium.org/8038020

git-svn-id: svn://svn.chromium.org/chrome/trunk/src@102957 0039d316-1c4b-4281-b951-d872f2087c98

1 files changed, 240 insertions, 37 deletions

diff --git a/chrome/common/extensions/docs/experimental.devtools.panels.html b/chrome/common/extensions/docs/experimental.devtools.panels.html
index 777e410..2f0568d 100644
--- a/chrome/common/extensions/docs/experimental.devtools.panels.html
+++ b/chrome/common/extensions/docs/experimental.devtools.panels.html
@@ -287,6 +287,8 @@
                     <ol>
                       <li>
                         <a href="#method-create">create</a>
+                      </li><li>
+                        <a href="#method-setOpenResourceHandler">setOpenResourceHandler</a>
                       </li>
                     </ol>
                   </li>
@@ -328,7 +330,7 @@
 <p id="classSummary">
 Use the <code>chrome.experimental.devtools.panels</code> module to integrate
 your extension into Developer Tools window UI: create your own panels, access
-existing panels and add sidebars.
+existing panels, and add sidebars.
 </p><p>
 See <a href="experimental.devtools.html">DevTools APIs summary</a> for
 general introduction to using Developer Tools APIs.
@@ -344,8 +346,15 @@ modules in <code>chrome.experimental.devtools</code> API, as well as to
 available to the pages within Developer Tools window, but you may invoke them
 by sending a request to the background page of your extension, similarly to how
 it's done in the <a href="overview.html#contentScripts">content scripts</a>.
+</p><p>
+You can use the <code><a href="#method-setOpenResourceHandler">setOpenResourceHandler()</a></code> method to install a
+callback function that handles user requests to open a resource (typically,
+a click on a resource link in the Developer Tools window). At most one of the
+installed handlers gets called; users can specify (using the Developer Tools
+Settings dialog) either the default behavior or an extension to handle resource
+open requests. If an extension calls <code>setOpenResourceHandler()</code>
+multiple times, only the last handler is retained.
 </p>
-
 <h2 id="overview-examples">Examples</h2>
 <p>The following code adds a panel contained in <code>Panel.html</code>,
 represented by <code>FontPicker.png</code> on the Developer Tools toolbar
@@ -874,6 +883,200 @@ You can find examples that use this API in
                 </p>
               </div> <!-- /description -->
 
+            </div><div class="apiItem">
+              <a name="method-setOpenResourceHandler"></a> <!-- method-anchor -->
+              <h4>setOpenResourceHandler</h4>
+
+              <div class="summary"><span style="display: none; ">void</span>
+                  <!-- Note: intentionally longer 80 columns -->
+                  <span>chrome.experimental.devtools.panels.setOpenResourceHandler</span>(<span class="optional"><span style="display: none; ">, </span><span>function</span>
+                      <var><span>callback</span></var></span>)</div>
+
+              <div class="description">
+                <p class="todo" style="display: none; ">Undocumented.</p>
+                <p>Specifies the function to be called when the user clicks a resource link in the Developer Tools window. To unset the handler, either call the method with no parameters or pass null as the parameter.</p>
+
+                <!-- PARAMETERS -->
+                <h4>Parameters</h4>
+                <dl>
+                  <div>
+                    <div>
+          <dt>
+            <var>callback</var>
+              <em>
+
+                <!-- TYPE -->
+                <div style="display:inline">
+                  (
+                    <span class="optional">optional</span>
+                    <span class="enum" style="display: none; ">enumerated</span>
+                    <span id="typeTemplate">
+                      <span style="display: none; ">
+                        <a> Type</a>
+                      </span>
+                      <span>
+                        <span style="display: none; ">
+                          array of <span><span></span></span>
+                        </span>
+                        <span>function</span>
+                        <span style="display: none; "></span>
+                      </span>
+                    </span>
+                  )
+                </div>
+
+              </em>
+          </dt>
+          <dd class="todo" style="display: none; ">
+            Undocumented.
+          </dd>
+          <dd>A function that is called when the user clicks on a valid resource link in Developer Tools window. Note that if the user clicks an invalid URL or an XHR, this function is not called.</dd>
+          <dd style="display: none; ">
+            This parameter was added in version
+            <b><span></span></b>.
+            You must omit this parameter in earlier versions,
+            and you may omit it in any version.  If you require this
+            parameter, the manifest key
+            <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>
+            can ensure that your extension won't be run in an earlier browser version.
+          </dd>
+
+          <!-- OBJECT PROPERTIES -->
+          <dd style="display: none; ">
+            <dl>
+              <div>
+                <div>
+                </div>
+              </div>
+            </dl>
+          </dd>
+
+          <!-- OBJECT METHODS -->
+          <dd style="display: none; ">
+            <div></div>
+          </dd>
+
+          <!-- OBJECT EVENT FIELDS -->
+          <dd style="display: none; ">
+            <div></div>
+          </dd>
+
+          <!-- FUNCTION PARAMETERS -->
+          <dd style="display: none; ">
+            <div></div>
+          </dd>
+
+        </div>
+                  </div>
+                </dl>
+
+                <!-- RETURNS -->
+                <h4 style="display: none; ">Returns</h4>
+                <dl>
+                  <div style="display: none; ">
+                    <div>
+                    </div>
+                  </div>
+                </dl>
+
+                <!-- CALLBACK -->
+                <div>
+                  <div>
+                  <h4>Callback function</h4>
+                  <p style="display: none; ">
+                    The callback <em>parameter</em> should specify a function
+                    that looks like this:
+                  </p>
+                  <p>
+                    If you specify the <em>callback</em> parameter, it should
+                    specify a function that looks like this:
+                  </p>
+
+                  <!-- Note: intentionally longer 80 columns -->
+                  <pre>function(<span>object Resource</span>) <span class="subdued">{...}</span>;</pre>
+                  <dl>
+                    <div>
+                      <div>
+          <dt>
+            <var>Resource</var>
+              <em>
+
+                <!-- TYPE -->
+                <div style="display:inline">
+                  (
+                    <span class="optional" style="display: none; ">optional</span>
+                    <span class="enum" style="display: none; ">enumerated</span>
+                    <span id="typeTemplate">
+                      <span style="display: none; ">
+                        <a> Type</a>
+                      </span>
+                      <span>
+                        <span style="display: none; ">
+                          array of <span><span></span></span>
+                        </span>
+                        <span>object</span>
+                        <span style="display: none; "></span>
+                      </span>
+                    </span>
+                  )
+                </div>
+
+              </em>
+          </dt>
+          <dd class="todo" style="display: none; ">
+            Undocumented.
+          </dd>
+          <dd>A <a href="experimental.devtools.inspectedWindow.html#type-Resource">Resource</a> object for the resource that was clicked.</dd>
+          <dd style="display: none; ">
+            This parameter was added in version
+            <b><span></span></b>.
+            You must omit this parameter in earlier versions,
+            and you may omit it in any version.  If you require this
+            parameter, the manifest key
+            <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>
+            can ensure that your extension won't be run in an earlier browser version.
+          </dd>
+
+          <!-- OBJECT PROPERTIES -->
+          <dd style="display: none; ">
+            <dl>
+              <div>
+                <div>
+                </div>
+              </div>
+            </dl>
+          </dd>
+
+          <!-- OBJECT METHODS -->
+          <dd style="display: none; ">
+            <div></div>
+          </dd>
+
+          <!-- OBJECT EVENT FIELDS -->
+          <dd style="display: none; ">
+            <div></div>
+          </dd>
+
+          <!-- FUNCTION PARAMETERS -->
+          <dd style="display: none; ">
+            <div></div>
+          </dd>
+
+        </div>
+                    </div>
+                  </dl>
+                  </div>
+                </div>
+
+                <!-- MIN_VERSION -->
+                <p style="display: none; ">
+                  This function was added in version <b><span></span></b>.
+                  If you require this function, the manifest key
+                  <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>
+                  can ensure that your extension won't be run in an earlier browser version.
+                </p>
+              </div> <!-- /description -->
+
             </div>  <!-- /apiItem -->
 
           </div>  <!-- /apiGroup -->
@@ -2086,22 +2289,22 @@ You can find examples that use this API in
                 <div style="display: none; ">
                   <div>
                   <h4>Callback function</h4>
-                  <p>
+                  <p style="display: none; ">
                     The callback <em>parameter</em> should specify a function
                     that looks like this:
                   </p>
-                  <p style="display: none; ">
+                  <p>
                     If you specify the <em>callback</em> parameter, it should
                     specify a function that looks like this:
                   </p>
 
                   <!-- Note: intentionally longer 80 columns -->
-                  <pre>function(<span>ExtensionPanel panel</span>) <span class="subdued">{...}</span>;</pre>
+                  <pre>function(<span>object Resource</span>) <span class="subdued">{...}</span>;</pre>
                   <dl>
                     <div>
                       <div>
           <dt>
-            <var>panel</var>
+            <var>Resource</var>
               <em>
 
                 <!-- TYPE -->
@@ -2110,15 +2313,15 @@ You can find examples that use this API in
                     <span class="optional" style="display: none; ">optional</span>
                     <span class="enum" style="display: none; ">enumerated</span>
                     <span id="typeTemplate">
-                      <span>
-                        <a href="experimental.devtools.panels.html#type-ExtensionPanel">ExtensionPanel</a>
-                      </span>
                       <span style="display: none; ">
-                        <span>
+                        <a> Type</a>
+                      </span>
+                      <span>
+                        <span style="display: none; ">
                           array of <span><span></span></span>
                         </span>
-                        <span>paramType</span>
-                        <span></span>
+                        <span>object</span>
+                        <span style="display: none; "></span>
                       </span>
                     </span>
                   )
@@ -2129,7 +2332,7 @@ You can find examples that use this API in
           <dd class="todo" style="display: none; ">
             Undocumented.
           </dd>
-          <dd>An ExtensionPanel object representing the created panel.</dd>
+          <dd>A <a href="experimental.devtools.inspectedWindow.html#type-Resource">Resource</a> object for the resource that was clicked.</dd>
           <dd style="display: none; ">
             This parameter was added in version
             <b><span></span></b>.
@@ -2187,7 +2390,7 @@ You can find examples that use this API in
               <div class="summary"><span style="display: none; ">void</span>
                   <!-- Note: intentionally longer 80 columns -->
                   <span>extensionSidebarPane.setObject</span>(<span class="null"><span style="display: none; ">, </span><span>string</span>
-                      <var><span>jsonObject</span></var></span><span class="optional"><span>, </span><span>string</span>
+                      <var><span>jsonObject</span></var></span><span class="optional"><span style="">, </span><span>string</span>
                       <var><span>rootTitle</span></var></span>)</div>
 
               <div class="description">
@@ -2274,7 +2477,7 @@ You can find examples that use this API in
                 <!-- TYPE -->
                 <div style="display:inline">
                   (
-                    <span class="optional" style="">optional</span>
+                    <span class="optional">optional</span>
                     <span class="enum" style="display: none; ">enumerated</span>
                     <span id="typeTemplate">
                       <span style="display: none; ">
@@ -2349,22 +2552,22 @@ You can find examples that use this API in
                 <div style="display: none; ">
                   <div>
                   <h4>Callback function</h4>
-                  <p>
+                  <p style="display: none; ">
                     The callback <em>parameter</em> should specify a function
                     that looks like this:
                   </p>
-                  <p style="display: none; ">
+                  <p>
                     If you specify the <em>callback</em> parameter, it should
                     specify a function that looks like this:
                   </p>
 
                   <!-- Note: intentionally longer 80 columns -->
-                  <pre>function(<span>ExtensionPanel panel</span>) <span class="subdued">{...}</span>;</pre>
+                  <pre>function(<span>object Resource</span>) <span class="subdued">{...}</span>;</pre>
                   <dl>
                     <div>
                       <div>
           <dt>
-            <var>panel</var>
+            <var>Resource</var>
               <em>
 
                 <!-- TYPE -->
@@ -2373,15 +2576,15 @@ You can find examples that use this API in
                     <span class="optional" style="display: none; ">optional</span>
                     <span class="enum" style="display: none; ">enumerated</span>
                     <span id="typeTemplate">
-                      <span>
-                        <a href="experimental.devtools.panels.html#type-ExtensionPanel">ExtensionPanel</a>
-                      </span>
                       <span style="display: none; ">
-                        <span>
+                        <a> Type</a>
+                      </span>
+                      <span>
+                        <span style="display: none; ">
                           array of <span><span></span></span>
                         </span>
-                        <span>paramType</span>
-                        <span></span>
+                        <span>object</span>
+                        <span style="display: none; "></span>
                       </span>
                     </span>
                   )
@@ -2392,7 +2595,7 @@ You can find examples that use this API in
           <dd class="todo" style="display: none; ">
             Undocumented.
           </dd>
-          <dd>An ExtensionPanel object representing the created panel.</dd>
+          <dd>A <a href="experimental.devtools.inspectedWindow.html#type-Resource">Resource</a> object for the resource that was clicked.</dd>
           <dd style="display: none; ">
             This parameter was added in version
             <b><span></span></b>.
@@ -2543,22 +2746,22 @@ You can find examples that use this API in
                 <div style="display: none; ">
                   <div>
                   <h4>Callback function</h4>
-                  <p>
+                  <p style="display: none; ">
                     The callback <em>parameter</em> should specify a function
                     that looks like this:
                   </p>
-                  <p style="display: none; ">
+                  <p>
                     If you specify the <em>callback</em> parameter, it should
                     specify a function that looks like this:
                   </p>
 
                   <!-- Note: intentionally longer 80 columns -->
-                  <pre>function(<span>ExtensionPanel panel</span>) <span class="subdued">{...}</span>;</pre>
+                  <pre>function(<span>object Resource</span>) <span class="subdued">{...}</span>;</pre>
                   <dl>
                     <div>
                       <div>
           <dt>
-            <var>panel</var>
+            <var>Resource</var>
               <em>
 
                 <!-- TYPE -->
@@ -2567,15 +2770,15 @@ You can find examples that use this API in
                     <span class="optional" style="display: none; ">optional</span>
                     <span class="enum" style="display: none; ">enumerated</span>
                     <span id="typeTemplate">
-                      <span>
-                        <a href="experimental.devtools.panels.html#type-ExtensionPanel">ExtensionPanel</a>
-                      </span>
                       <span style="display: none; ">
-                        <span>
+                        <a> Type</a>
+                      </span>
+                      <span>
+                        <span style="display: none; ">
                           array of <span><span></span></span>
                         </span>
-                        <span>paramType</span>
-                        <span></span>
+                        <span>object</span>
+                        <span style="display: none; "></span>
                       </span>
                     </span>
                   )
@@ -2586,7 +2789,7 @@ You can find examples that use this API in
           <dd class="todo" style="display: none; ">
             Undocumented.
           </dd>
-          <dd>An ExtensionPanel object representing the created panel.</dd>
+          <dd>A <a href="experimental.devtools.inspectedWindow.html#type-Resource">Resource</a> object for the resource that was clicked.</dd>
           <dd style="display: none; ">
             This parameter was added in version
             <b><span></span></b>.