Web Inspector: Network Tab - Set column initial widths to try allow waterfall column...
[WebKit-https.git] / Source / WebInspectorUI / UserInterface / Views / TableColumn.js
1 /*
2  * Copyright (C) 2017 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.TableColumn = class TableColumn extends WI.Object
27 {
28     constructor(identifier, name, {initialWidth, minWidth, maxWidth, hidden, sortable, hideable, align, resizeType} = {})
29     {
30         super();
31
32         console.assert(identifier);
33         console.assert(name);
34         console.assert(!initialWidth || initialWidth > 0);
35         console.assert(!minWidth || minWidth >= 0);
36         console.assert(!maxWidth || maxWidth >= 0);
37
38         this._identifier = identifier;
39         this._name = name;
40
41         this._width = initialWidth || NaN;
42         this._minWidth = minWidth || 50;
43         this._maxWidth = maxWidth || 0;
44         this._initialWidth = initialWidth || NaN;
45         this._hidden = hidden || false;
46         this._defaultHidden = hidden || false;
47         this._sortable = typeof sortable === "boolean" ? sortable : true;
48         this._hideable = typeof hideable === "boolean" ? hideable : true;
49         this._align = align || null;
50         this._resizeType = resizeType || TableColumn.ResizeType.Auto;
51
52         console.assert(!this._minWidth || !this._maxWidth || this._minWidth <= this._maxWidth, "Invalid min/max", this._minWidth, this._maxWidth);
53         console.assert(isNaN(this._width) || !this._minWidth || (this._width >= this._minWidth), "Initial width is less than min", this._width, this._minWidth);
54         console.assert(isNaN(this._width) || !this._maxWidth || (this._width <= this._maxWidth), "Initial width is greater than max", this._width, this._maxWidth);
55         console.assert(!this.locked || this.width, "A locked column should aways have an initial width");
56         console.assert(!this.locked || !this.hidden, "A locked column should never be hidden");
57     }
58
59     get identifier() { return this._identifier; }
60     get name() { return this._name; }
61     get minWidth() { return this._minWidth; }
62     get maxWidth() { return this._maxWidth; }
63     get preferredInitialWidth() { return this._initialWidth; }
64     get defaultHidden() { return this._defaultHidden; }
65     get sortable() { return this._sortable; }
66     get hideable() { return this._hideable; }
67     get align() { return this._align; }
68
69     get locked() { return this._resizeType === TableColumn.ResizeType.Locked; }
70     get flexible() { return this._resizeType === TableColumn.ResizeType.Auto; }
71
72     get width()
73     {
74         return this._width;
75     }
76
77     set width(width)
78     {
79         // NOTE: We can't assert this because we resize past the minimum and maximum sizes.
80         // If we support horizontal scrolling in the Table then we could assert these.
81         // console.assert(isNaN(width) || !this._minWidth || width >= this._minWidth, "New width was less than midWidth.", width, this._minWidth);
82         // console.assert(isNaN(width) || !this._maxWidth || width <= this._maxWidth, "New width was greater than maxWidth.", width, this._maxWidth);
83
84         if (this._width === width)
85             return;
86
87         this._width = width;
88
89         this.dispatchEventToListeners(WI.TableColumn.Event.WidthDidChange);
90     }
91
92     get hidden()
93     {
94         return this._hidden;
95     }
96
97     set hidden(x)
98     {
99         console.assert(!this.locked && this._hideable, "Should not be able to hide a non-hideable column.");
100         this._hidden = x;
101     }
102 };
103
104 WI.TableColumn.ResizeType = {
105     Auto: "auto",
106     Locked: "locked",
107 };
108
109 WI.TableColumn.Event = {
110     WidthDidChange: "table-column-width-did-change",
111 };