856aa1e44953a418f3a6f6ec4f06ab0c8694743b
[WebKit-https.git] / Source / WebInspectorUI / UserInterface / Views / Sidebar.js
1 /*
2  * Copyright (C) 2013, 2015 Apple 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
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 WI.Sidebar = class Sidebar extends WI.View
27 {
28     constructor(element, side, sidebarPanels, role, label, hasNavigationBar)
29     {
30         super(element);
31
32         console.assert(!side || side === WI.Sidebar.Sides.Left || side === WI.Sidebar.Sides.Right);
33         this._side = side || WI.Sidebar.Sides.Left;
34         this._collapsed = true;
35
36         this.element.classList.add("sidebar", this._side, WI.Sidebar.CollapsedStyleClassName);
37
38         this.element.setAttribute("role", role || "group");
39         if (label)
40             this.element.setAttribute("aria-label", label);
41
42         if (hasNavigationBar) {
43             this.element.classList.add("has-navigation-bar");
44
45             this._navigationBar = new WI.SidebarNavigationBar(null, null, "tablist");
46             this._navigationBar.addEventListener(WI.NavigationBar.Event.NavigationItemSelected, this._navigationItemSelected, this);
47             this.addSubview(this._navigationBar);
48         }
49
50         this._resizer = new WI.Resizer(WI.Resizer.RuleOrientation.Vertical, this);
51         this.element.insertBefore(this._resizer.element, this.element.firstChild);
52
53         this._sidebarPanels = [];
54
55         if (sidebarPanels) {
56             for (let sidebarPanel of sidebarPanels)
57                 this.addSidebarPanel(sidebarPanel);
58         }
59     }
60
61     // Public
62
63     addSidebarPanel(sidebarPanel)
64     {
65         this.insertSidebarPanel(sidebarPanel, this._sidebarPanels.length);
66     }
67
68     insertSidebarPanel(sidebarPanel, index)
69     {
70         console.assert(sidebarPanel instanceof WI.SidebarPanel);
71         if (!(sidebarPanel instanceof WI.SidebarPanel))
72             return;
73
74         console.assert(!sidebarPanel.parentSidebar);
75         if (sidebarPanel.parentSidebar)
76             return;
77
78         console.assert(index >= 0 && index <= this._sidebarPanels.length);
79         this._sidebarPanels.splice(index, 0, sidebarPanel);
80
81         let referenceView = this._sidebarPanels[index + 1] || null;
82         this.insertSubviewBefore(sidebarPanel, referenceView);
83
84         if (this._navigationBar) {
85             console.assert(sidebarPanel.navigationItem);
86             this._navigationBar.insertNavigationItem(sidebarPanel.navigationItem, index);
87         }
88     }
89
90     removeSidebarPanel(sidebarPanelOrIdentifierOrIndex)
91     {
92         var sidebarPanel = this.findSidebarPanel(sidebarPanelOrIdentifierOrIndex);
93         if (!sidebarPanel)
94             return;
95
96         if (sidebarPanel.visible) {
97             sidebarPanel.hidden();
98             sidebarPanel.visibilityDidChange();
99         }
100
101         sidebarPanel.selected = false;
102
103         if (this._selectedSidebarPanel === sidebarPanel) {
104             var index = this._sidebarPanels.indexOf(sidebarPanel);
105             this.selectedSidebarPanel = this._sidebarPanels[index - 1] || this._sidebarPanels[index + 1] || null;
106         }
107
108         this._sidebarPanels.remove(sidebarPanel);
109         this.removeSubview(sidebarPanel);
110
111         if (this._navigationBar) {
112             console.assert(sidebarPanel.navigationItem);
113             this._navigationBar.removeNavigationItem(sidebarPanel.navigationItem);
114         }
115     }
116
117     get selectedSidebarPanel()
118     {
119         return this._selectedSidebarPanel || null;
120     }
121
122     set selectedSidebarPanel(sidebarPanelOrIdentifierOrIndex)
123     {
124         var sidebarPanel = this.findSidebarPanel(sidebarPanelOrIdentifierOrIndex);
125         if (this._selectedSidebarPanel === sidebarPanel)
126             return;
127
128         if (this._selectedSidebarPanel) {
129             if (this._selectedSidebarPanel.visible) {
130                 this._selectedSidebarPanel.hidden();
131                 this._selectedSidebarPanel.visibilityDidChange();
132             }
133
134             this._selectedSidebarPanel.selected = false;
135         }
136
137         this._selectedSidebarPanel = sidebarPanel || null;
138
139         if (this._navigationBar)
140             this._navigationBar.selectedNavigationItem = sidebarPanel ? sidebarPanel.navigationItem : null;
141
142         if (this._selectedSidebarPanel) {
143             this._selectedSidebarPanel.selected = true;
144
145             if (this._selectedSidebarPanel.visible) {
146                 this._selectedSidebarPanel.shown();
147                 this._selectedSidebarPanel.visibilityDidChange();
148             }
149         }
150
151         this.dispatchEventToListeners(WI.Sidebar.Event.SidebarPanelSelected);
152     }
153
154     get minimumWidth()
155     {
156         if (this._navigationBar)
157             return Math.max(WI.Sidebar.AbsoluteMinimumWidth, this._navigationBar.minimumWidth);
158         if (this._selectedSidebarPanel)
159             return Math.max(WI.Sidebar.AbsoluteMinimumWidth, this._selectedSidebarPanel.minimumWidth);
160         return WI.Sidebar.AbsoluteMinimumWidth;
161     }
162
163     get maximumWidth()
164     {
165         return WI.getMaximumSidebarWidth(this);
166     }
167
168     get width()
169     {
170         return this.element.offsetWidth;
171     }
172
173     set width(newWidth)
174     {
175         if (newWidth === this.width)
176             return;
177
178         this._recalculateWidth(newWidth);
179     }
180
181     get collapsed()
182     {
183         return this._collapsed;
184     }
185
186     set collapsed(flag)
187     {
188         if (flag === this._collapsed)
189             return;
190
191         this._collapsed = flag || false;
192         this.element.classList.toggle(WI.Sidebar.CollapsedStyleClassName);
193
194         if (!this._collapsed && this._navigationBar)
195             this._navigationBar.needsLayout();
196
197         if (this._selectedSidebarPanel) {
198             if (this._selectedSidebarPanel.visible)
199                 this._selectedSidebarPanel.shown();
200             else
201                 this._selectedSidebarPanel.hidden();
202
203             this._selectedSidebarPanel.visibilityDidChange();
204         }
205
206         this.dispatchEventToListeners(WI.Sidebar.Event.CollapsedStateDidChange);
207         this.dispatchEventToListeners(WI.Sidebar.Event.WidthDidChange);
208     }
209
210     get sidebarPanels()
211     {
212         return this._sidebarPanels;
213     }
214
215     get side()
216     {
217         return this._side;
218     }
219
220     findSidebarPanel(sidebarPanelOrIdentifierOrIndex)
221     {
222         var sidebarPanel = null;
223
224         if (sidebarPanelOrIdentifierOrIndex instanceof WI.SidebarPanel) {
225             if (this._sidebarPanels.includes(sidebarPanelOrIdentifierOrIndex))
226                 sidebarPanel = sidebarPanelOrIdentifierOrIndex;
227         } else if (typeof sidebarPanelOrIdentifierOrIndex === "number") {
228             sidebarPanel = this._sidebarPanels[sidebarPanelOrIdentifierOrIndex];
229         } else if (typeof sidebarPanelOrIdentifierOrIndex === "string") {
230             for (var i = 0; i < this._sidebarPanels.length; ++i) {
231                 if (this._sidebarPanels[i].identifier === sidebarPanelOrIdentifierOrIndex) {
232                     sidebarPanel = this._sidebarPanels[i];
233                     break;
234                 }
235             }
236         }
237
238         return sidebarPanel;
239     }
240
241     // Protected
242
243     resizerDragStarted(resizer)
244     {
245         this._widthBeforeResize = this.width;
246     }
247
248     resizerDragging(resizer, positionDelta)
249     {
250         if (this._side === WI.Sidebar.Sides.Left)
251             positionDelta *= -1;
252
253         if (WI.resolvedLayoutDirection() === WI.LayoutDirection.RTL)
254             positionDelta *= -1;
255
256         var newWidth = positionDelta + this._widthBeforeResize;
257         this.width = newWidth;
258         this.collapsed = newWidth < (this.minimumWidth / 2);
259     }
260
261     resizerDragEnded(resizer)
262     {
263         if (this._widthBeforeResize === this.width)
264             return;
265
266         if (!this.collapsed && this._navigationBar)
267             this._navigationBar.sizeDidChange();
268
269         if (!this.collapsed && this._selectedSidebarPanel)
270             this._selectedSidebarPanel.sizeDidChange();
271     }
272
273     // Private
274
275     _recalculateWidth(newWidth = this.width)
276     {
277         // Need to add 1 because of the 1px border-right.
278         newWidth = Math.ceil(Number.constrain(newWidth, this.minimumWidth + 1, this.maximumWidth));
279         this.element.style.width = `${newWidth}px`;
280
281         if (this.collapsed)
282             return;
283
284         if (this._navigationBar)
285             this._navigationBar.updateLayoutIfNeeded(WI.View.LayoutReason.Resize);
286
287         if (this._selectedSidebarPanel)
288             this._selectedSidebarPanel.updateLayoutIfNeeded(WI.View.LayoutReason.Resize);
289
290         this.dispatchEventToListeners(WI.Sidebar.Event.WidthDidChange, {newWidth});
291     }
292
293     _navigationItemSelected(event)
294     {
295         this.selectedSidebarPanel = event.target.selectedNavigationItem ? event.target.selectedNavigationItem.identifier : null;
296     }
297 };
298
299 WI.Sidebar.CollapsedStyleClassName = "collapsed";
300 WI.Sidebar.AbsoluteMinimumWidth = 200;
301
302 WI.Sidebar.Sides = {
303     Right: "right",
304     Left: "left"
305 };
306
307 WI.Sidebar.Event = {
308     SidebarPanelSelected: "sidebar-panel-selected",
309     CollapsedStateDidChange: "sidebar-collapsed-state-did-change",
310     WidthDidChange: "sidebar-width-did-change",
311 };