third_party/WebKit/Source/devtools/front_end/components/DockController.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  * @extends {WebInspector.Object}
  34  * @param {boolean} canDock
  35  */
  36 WebInspector.DockController = function(canDock)
  37 {
  38     this._canDock = canDock;
  39
  40     this._closeButton = new WebInspector.ToolbarButton(WebInspector.UIString("Close"), "delete-toolbar-item");
  41     this._closeButton.addEventListener("click", InspectorFrontendHost.closeWindow.bind(InspectorFrontendHost));
  42
  43     if (!canDock) {
  44         this._dockSide = WebInspector.DockController.State.Undocked;
  45         this._updateUI();
  46         return;
  47     }
  48
  49     this._states = [WebInspector.DockController.State.DockedToRight, WebInspector.DockController.State.DockedToBottom, WebInspector.DockController.State.Undocked];
  50     this._currentDockStateSetting = WebInspector.settings.createSetting("currentDockState", "right");
  51     this._lastDockStateSetting = WebInspector.settings.createSetting("lastDockState", "bottom");
  52     if (this._states.indexOf(this._currentDockStateSetting.get()) === -1)
  53         this._currentDockStateSetting.set("right");
  54     if (this._states.indexOf(this._lastDockStateSetting.get()) === -1)
  55         this._currentDockStateSetting.set("bottom");
  56 }
  57
  58 WebInspector.DockController.State = {
  59     DockedToBottom: "bottom",
  60     DockedToRight: "right",
  61     Undocked: "undocked"
  62 }
  63
  64 // Use BeforeDockSideChanged to do something before all the UI bits are updated,
  65 // DockSideChanged to update UI, and AfterDockSideChanged to perform actions
  66 // after frontend is docked/undocked in the browser.
  67 WebInspector.DockController.Events = {
  68     BeforeDockSideChanged: "BeforeDockSideChanged",
  69     DockSideChanged: "DockSideChanged",
  70     AfterDockSideChanged: "AfterDockSideChanged"
  71 }
  72
  73 WebInspector.DockController.prototype = {
  74     initialize: function()
  75     {
  76         if (!this._canDock)
  77             return;
  78
  79         this._titles = [WebInspector.UIString("Dock to right"), WebInspector.UIString("Dock to bottom"), WebInspector.UIString("Undock into separate window")];
  80         this.setDockSide(this._currentDockStateSetting.get());
  81     },
  82
  83     /**
  84      * @return {string}
  85      */
  86     dockSide: function()
  87     {
  88         return this._dockSide;
  89     },
  90
  91     /**
  92      * @return {boolean}
  93      */
  94     canDock: function()
  95     {
  96         return this._canDock;
  97     },
  98
  99     /**
 100      * @return {boolean}
 101      */
 102     isVertical: function()
 103     {
 104         return this._dockSide === WebInspector.DockController.State.DockedToRight;
 105     },
 106
 107     /**
 108      * @param {string} dockSide
 109      */
 110     setDockSide: function(dockSide)
 111     {
 112         if (this._states.indexOf(dockSide) === -1)
 113             dockSide = this._states[0];
 114
 115         if (this._dockSide === dockSide)
 116             return;
 117
 118         if (this._dockSide)
 119             this._lastDockStateSetting.set(this._dockSide);
 120         this._currentDockStateSetting.set(dockSide);
 121         var eventData = { from: this._dockSide, to: dockSide };
 122         this.dispatchEventToListeners(WebInspector.DockController.Events.BeforeDockSideChanged, eventData);
 123         console.timeStamp("DockController.setIsDocked");
 124         InspectorFrontendHost.setIsDocked(dockSide !== WebInspector.DockController.State.Undocked, this._setIsDockedResponse.bind(this, eventData));
 125         this._dockSide = dockSide;
 126         this._updateUI();
 127         this.dispatchEventToListeners(WebInspector.DockController.Events.DockSideChanged, eventData);
 128     },
 129
 130     /**
 131      * @param {{from: string, to: string}} eventData
 132      */
 133     _setIsDockedResponse: function(eventData)
 134     {
 135         this.dispatchEventToListeners(WebInspector.DockController.Events.AfterDockSideChanged, eventData);
 136     },
 137
 138     /**
 139      * @suppressGlobalPropertiesCheck
 140      */
 141     _updateUI: function()
 142     {
 143         var body = document.body;  // Only for main window.
 144         switch (this._dockSide) {
 145         case WebInspector.DockController.State.DockedToBottom:
 146             body.classList.remove("undocked");
 147             body.classList.remove("dock-to-right");
 148             body.classList.add("dock-to-bottom");
 149             break;
 150         case WebInspector.DockController.State.DockedToRight:
 151             body.classList.remove("undocked");
 152             body.classList.add("dock-to-right");
 153             body.classList.remove("dock-to-bottom");
 154             break;
 155         case WebInspector.DockController.State.Undocked:
 156             body.classList.add("undocked");
 157             body.classList.remove("dock-to-right");
 158             body.classList.remove("dock-to-bottom");
 159             break;
 160         }
 161         this._closeButton.setVisible(this._dockSide !== WebInspector.DockController.State.Undocked);
 162     },
 163
 164     _toggleDockSide: function()
 165     {
 166         if (this._lastDockStateSetting.get() === this._currentDockStateSetting.get()) {
 167             var index = this._states.indexOf(this._currentDockStateSetting.get()) || 0;
 168             this._lastDockStateSetting.set(this._states[(index + 1) % this._states.length]);
 169         }
 170         this.setDockSide(this._lastDockStateSetting.get());
 171     },
 172
 173     __proto__: WebInspector.Object.prototype
 174 }
 175
 176 /**
 177  * @constructor
 178  * @implements {WebInspector.ActionDelegate}
 179  */
 180 WebInspector.DockController.ToggleDockActionDelegate = function()
 181 {
 182 }
 183
 184 WebInspector.DockController.ToggleDockActionDelegate.prototype = {
 185     /**
 186      * @override
 187      * @param {!WebInspector.Context} context
 188      * @param {string} actionId
 189      */
 190     handleAction: function(context, actionId)
 191     {
 192         WebInspector.dockController._toggleDockSide();
 193     }
 194 }
 195
 196 /**
 197  * @constructor
 198  * @implements {WebInspector.ToolbarItem.Provider}
 199  */
 200 WebInspector.DockController.CloseButtonProvider = function()
 201 {
 202 }
 203
 204 WebInspector.DockController.CloseButtonProvider.prototype = {
 205     /**
 206      * @override
 207      * @return {?WebInspector.ToolbarItem}
 208      */
 209     item: function()
 210     {
 211         return WebInspector.dockController._closeButton;
 212     }
 213 }
 214
 215 /**
 216  * @type {!WebInspector.DockController}
 217  */
 218 WebInspector.dockController;