third_party/WebKit/Source/devtools/front_end/extensions/ExtensionPanel.js

   1 /*
   2  * Copyright (C) 2012 Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are
   6  * met:
   7  *
   8  *     * Redistributions of source code must retain the above copyright
   9  * notice, this list of conditions and the following disclaimer.
  10  *     * Redistributions in binary form must reproduce the above
  11  * copyright notice, this list of conditions and the following disclaimer
  12  * in the documentation and/or other materials provided with the
  13  * distribution.
  14  *     * Neither the name of Google Inc. nor the names of its
  15  * contributors may be used to endorse or promote products derived from
  16  * this software without specific prior written permission.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 /**
  32  * @constructor
  33  * @implements {WebInspector.Searchable}
  34  * @extends {WebInspector.Panel}
  35  * @param {!WebInspector.ExtensionServer} server
  36  * @param {string} panelName
  37  * @param {string} id
  38  * @param {string} pageURL
  39  */
  40 WebInspector.ExtensionPanel = function(server, panelName, id, pageURL)
  41 {
  42     WebInspector.Panel.call(this, panelName);
  43     this._server = server;
  44     this._id = id;
  45     this.setHideOnDetach();
  46     this._panelToolbar = new WebInspector.Toolbar(this.element);
  47     this._panelToolbar.element.classList.add("hidden");
  48
  49     this._searchableView = new WebInspector.SearchableView(this);
  50     this._searchableView.show(this.element);
  51
  52     var extensionView = new WebInspector.ExtensionView(server, this._id, pageURL, "extension");
  53     extensionView.show(this._searchableView.element);
  54     this.setDefaultFocusedElement(extensionView.defaultFocusedElement());
  55 }
  56
  57 WebInspector.ExtensionPanel.prototype = {
  58     /**
  59      * @override
  60      * @return {!Element}
  61      */
  62     defaultFocusedElement: function()
  63     {
  64         return WebInspector.Widget.prototype.defaultFocusedElement.call(this);
  65     },
  66
  67     /**
  68      * @param {!WebInspector.ToolbarItem} item
  69      */
  70     addToolbarItem: function(item)
  71     {
  72         this._panelToolbar.element.classList.remove("hidden");
  73         this._panelToolbar.appendToolbarItem(item);
  74     },
  75
  76     /**
  77      * @override
  78      */
  79     searchCanceled: function()
  80     {
  81         this._server.notifySearchAction(this._id, WebInspector.extensionAPI.panels.SearchAction.CancelSearch);
  82         this._searchableView.updateSearchMatchesCount(0);
  83     },
  84
  85     /**
  86      * @override
  87      * @return {!WebInspector.SearchableView}
  88      */
  89     searchableView: function()
  90     {
  91         return this._searchableView;
  92     },
  93
  94     /**
  95      * @override
  96      * @param {!WebInspector.SearchableView.SearchConfig} searchConfig
  97      * @param {boolean} shouldJump
  98      * @param {boolean=} jumpBackwards
  99      */
 100     performSearch: function(searchConfig, shouldJump, jumpBackwards)
 101     {
 102         var query = searchConfig.query;
 103         this._server.notifySearchAction(this._id, WebInspector.extensionAPI.panels.SearchAction.PerformSearch, query);
 104     },
 105
 106     /**
 107      * @override
 108      */
 109     jumpToNextSearchResult: function()
 110     {
 111         this._server.notifySearchAction(this._id, WebInspector.extensionAPI.panels.SearchAction.NextSearchResult);
 112     },
 113
 114     /**
 115      * @override
 116      */
 117     jumpToPreviousSearchResult: function()
 118     {
 119         this._server.notifySearchAction(this._id, WebInspector.extensionAPI.panels.SearchAction.PreviousSearchResult);
 120     },
 121
 122     /**
 123      * @override
 124      * @return {boolean}
 125      */
 126     supportsCaseSensitiveSearch: function()
 127     {
 128         return false;
 129     },
 130
 131     /**
 132      * @override
 133      * @return {boolean}
 134      */
 135     supportsRegexSearch: function()
 136     {
 137         return false;
 138     },
 139
 140     __proto__: WebInspector.Panel.prototype
 141 }
 142
 143 /**
 144  * @constructor
 145  * @param {!WebInspector.ExtensionServer} server
 146  * @param {string} id
 147  * @param {string} iconURL
 148  * @param {string=} tooltip
 149  * @param {boolean=} disabled
 150  */
 151 WebInspector.ExtensionButton = function(server, id, iconURL, tooltip, disabled)
 152 {
 153     this._id = id;
 154
 155     this._toolbarButton = new WebInspector.ToolbarButton("", "extension");
 156     this._toolbarButton.addEventListener("click", server.notifyButtonClicked.bind(server, this._id));
 157     this.update(iconURL, tooltip, disabled);
 158 }
 159
 160 WebInspector.ExtensionButton.prototype = {
 161     /**
 162      * @param {string} iconURL
 163      * @param {string=} tooltip
 164      * @param {boolean=} disabled
 165      */
 166     update: function(iconURL, tooltip, disabled)
 167     {
 168         if (typeof iconURL === "string")
 169             this._toolbarButton.setBackgroundImage(iconURL);
 170         if (typeof tooltip === "string")
 171             this._toolbarButton.setTitle(tooltip);
 172         if (typeof disabled === "boolean")
 173             this._toolbarButton.setEnabled(!disabled);
 174     },
 175
 176     /**
 177      * @return {!WebInspector.ToolbarButton}
 178      */
 179     toolbarButton: function()
 180     {
 181         return this._toolbarButton;
 182     }
 183 }
 184
 185 /**
 186  * @constructor
 187  * @extends {WebInspector.SidebarPane}
 188  * @param {!WebInspector.ExtensionServer} server
 189  * @param {string} panelName
 190  * @param {string} title
 191  * @param {string} id
 192  */
 193 WebInspector.ExtensionSidebarPane = function(server, panelName, title, id)
 194 {
 195     WebInspector.SidebarPane.call(this, title);
 196     this._panelName = panelName;
 197     this._server = server;
 198     this._id = id;
 199 }
 200
 201 WebInspector.ExtensionSidebarPane.prototype = {
 202     /**
 203      * @return {string}
 204      */
 205     id: function()
 206     {
 207         return this._id;
 208     },
 209
 210     /**
 211      * @return {string}
 212      */
 213     panelName: function()
 214     {
 215         return this._panelName;
 216     },
 217
 218     /**
 219      * @param {!Object} object
 220      * @param {string} title
 221      * @param {function(?string=)} callback
 222      */
 223     setObject: function(object, title, callback)
 224     {
 225         this._createObjectPropertiesView();
 226         this._setObject(WebInspector.RemoteObject.fromLocalObject(object), title, callback);
 227     },
 228
 229     /**
 230      * @param {string} expression
 231      * @param {string} title
 232      * @param {!Object} evaluateOptions
 233      * @param {string} securityOrigin
 234      * @param {function(?string=)} callback
 235      */
 236     setExpression: function(expression, title, evaluateOptions, securityOrigin, callback)
 237     {
 238         this._createObjectPropertiesView();
 239         this._server.evaluate(expression, true, false, evaluateOptions, securityOrigin, this._onEvaluate.bind(this, title, callback));
 240     },
 241
 242     /**
 243      * @param {string} url
 244      */
 245     setPage: function(url)
 246     {
 247         if (this._objectPropertiesView) {
 248             this._objectPropertiesView.detach();
 249             delete this._objectPropertiesView;
 250         }
 251         if (this._extensionView)
 252             this._extensionView.detach(true);
 253
 254         this._extensionView = new WebInspector.ExtensionView(this._server, this._id, url, "extension fill");
 255         this._extensionView.show(this.element);
 256
 257         if (!this.element.style.height)
 258             this.setHeight("150px");
 259     },
 260
 261     /**
 262      * @param {string} height
 263      */
 264     setHeight: function(height)
 265     {
 266         this.element.style.height = height;
 267     },
 268
 269     /**
 270      * @param {string} title
 271      * @param {function(?string=)} callback
 272      * @param {?Protocol.Error} error
 273      * @param {?WebInspector.RemoteObject} result
 274      * @param {boolean=} wasThrown
 275      */
 276     _onEvaluate: function(title, callback, error, result, wasThrown)
 277     {
 278         if (error)
 279             callback(error.toString());
 280         else
 281             this._setObject(/** @type {!WebInspector.RemoteObject} */ (result), title, callback);
 282     },
 283
 284     _createObjectPropertiesView: function()
 285     {
 286         if (this._objectPropertiesView)
 287             return;
 288         if (this._extensionView) {
 289             this._extensionView.detach(true);
 290             delete this._extensionView;
 291         }
 292         this._objectPropertiesView = new WebInspector.ExtensionNotifierView(this._server, this._id);
 293         this._objectPropertiesView.show(this.element);
 294     },
 295
 296     /**
 297      * @param {!WebInspector.RemoteObject} object
 298      * @param {string} title
 299      * @param {function(?string=)} callback
 300      */
 301     _setObject: function(object, title, callback)
 302     {
 303         // This may only happen if setPage() was called while we were evaluating the expression.
 304         if (!this._objectPropertiesView) {
 305             callback("operation cancelled");
 306             return;
 307         }
 308         this._objectPropertiesView.element.removeChildren();
 309         var section = new WebInspector.ObjectPropertiesSection(object, title);
 310         if (!title)
 311             section.titleLessMode();
 312         section.expand();
 313         section.editable = false;
 314         this._objectPropertiesView.element.appendChild(section.element);
 315         callback();
 316     },
 317
 318     __proto__: WebInspector.SidebarPane.prototype
 319 }