@theia/preferences 1.34.1 → 1.34.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (128) hide show
  1. package/LICENSE +641 -641
  2. package/README.md +81 -81
  3. package/lib/browser/abstract-resource-preference-provider.d.ts +46 -46
  4. package/lib/browser/abstract-resource-preference-provider.js +237 -237
  5. package/lib/browser/abstract-resource-preference-provider.spec.d.ts +1 -1
  6. package/lib/browser/abstract-resource-preference-provider.spec.js +83 -83
  7. package/lib/browser/folder-preference-provider.d.ts +20 -20
  8. package/lib/browser/folder-preference-provider.js +59 -59
  9. package/lib/browser/folders-preferences-provider.d.ts +25 -25
  10. package/lib/browser/folders-preferences-provider.js +239 -239
  11. package/lib/browser/index.d.ts +7 -7
  12. package/lib/browser/index.js +34 -34
  13. package/lib/browser/monaco-jsonc-editor.d.ts +9 -9
  14. package/lib/browser/monaco-jsonc-editor.js +80 -80
  15. package/lib/browser/package.spec.js +25 -25
  16. package/lib/browser/preference-bindings.d.ts +4 -4
  17. package/lib/browser/preference-bindings.js +63 -63
  18. package/lib/browser/preference-frontend-module.d.ts +6 -6
  19. package/lib/browser/preference-frontend-module.js +52 -52
  20. package/lib/browser/preference-open-handler.d.ts +9 -9
  21. package/lib/browser/preference-open-handler.js +64 -64
  22. package/lib/browser/preference-transaction-manager.d.ts +98 -98
  23. package/lib/browser/preference-transaction-manager.js +295 -295
  24. package/lib/browser/preference-tree-model.d.ts +59 -59
  25. package/lib/browser/preference-tree-model.js +240 -240
  26. package/lib/browser/preferences-contribution.d.ts +37 -37
  27. package/lib/browser/preferences-contribution.js +279 -279
  28. package/lib/browser/preferences-json-schema-contribution.d.ts +17 -17
  29. package/lib/browser/preferences-json-schema-contribution.js +91 -91
  30. package/lib/browser/preferences-monaco-contribution.d.ts +1 -1
  31. package/lib/browser/preferences-monaco-contribution.js +30 -30
  32. package/lib/browser/section-preference-provider.d.ts +21 -21
  33. package/lib/browser/section-preference-provider.js +96 -96
  34. package/lib/browser/user-configs-preference-provider.d.ts +21 -21
  35. package/lib/browser/user-configs-preference-provider.js +134 -134
  36. package/lib/browser/user-preference-provider.d.ts +13 -13
  37. package/lib/browser/user-preference-provider.js +41 -41
  38. package/lib/browser/util/preference-scope-command-manager.d.ts +17 -17
  39. package/lib/browser/util/preference-scope-command-manager.js +87 -87
  40. package/lib/browser/util/preference-tree-generator.d.ts +30 -30
  41. package/lib/browser/util/preference-tree-generator.js +234 -234
  42. package/lib/browser/util/preference-tree-label-provider.d.ts +11 -11
  43. package/lib/browser/util/preference-tree-label-provider.js +77 -77
  44. package/lib/browser/util/preference-tree-label-provider.spec.d.ts +1 -1
  45. package/lib/browser/util/preference-tree-label-provider.spec.js +87 -87
  46. package/lib/browser/util/preference-types.d.ts +62 -62
  47. package/lib/browser/util/preference-types.js +128 -128
  48. package/lib/browser/views/components/preference-array-input.d.ts +28 -28
  49. package/lib/browser/views/components/preference-array-input.js +180 -180
  50. package/lib/browser/views/components/preference-boolean-input.d.ts +17 -17
  51. package/lib/browser/views/components/preference-boolean-input.js +79 -79
  52. package/lib/browser/views/components/preference-file-input.d.ts +29 -29
  53. package/lib/browser/views/components/preference-file-input.js +110 -110
  54. package/lib/browser/views/components/preference-json-input.d.ts +19 -19
  55. package/lib/browser/views/components/preference-json-input.js +93 -93
  56. package/lib/browser/views/components/preference-node-renderer-creator.d.ts +48 -48
  57. package/lib/browser/views/components/preference-node-renderer-creator.js +132 -132
  58. package/lib/browser/views/components/preference-node-renderer.d.ts +111 -111
  59. package/lib/browser/views/components/preference-node-renderer.js +460 -460
  60. package/lib/browser/views/components/preference-number-input.d.ts +34 -34
  61. package/lib/browser/views/components/preference-number-input.js +142 -142
  62. package/lib/browser/views/components/preference-select-input.d.ts +27 -27
  63. package/lib/browser/views/components/preference-select-input.js +135 -135
  64. package/lib/browser/views/components/preference-string-input.d.ts +17 -17
  65. package/lib/browser/views/components/preference-string-input.js +89 -89
  66. package/lib/browser/views/preference-editor-widget.d.ts +67 -67
  67. package/lib/browser/views/preference-editor-widget.js +376 -376
  68. package/lib/browser/views/preference-scope-tabbar-widget.d.ts +54 -54
  69. package/lib/browser/views/preference-scope-tabbar-widget.js +343 -343
  70. package/lib/browser/views/preference-searchbar-widget.d.ts +53 -53
  71. package/lib/browser/views/preference-searchbar-widget.js +173 -173
  72. package/lib/browser/views/preference-tree-widget.d.ts +17 -17
  73. package/lib/browser/views/preference-tree-widget.js +104 -104
  74. package/lib/browser/views/preference-widget-bindings.d.ts +3 -3
  75. package/lib/browser/views/preference-widget-bindings.js +85 -85
  76. package/lib/browser/views/preference-widget.d.ts +35 -35
  77. package/lib/browser/views/preference-widget.js +123 -123
  78. package/lib/browser/workspace-file-preference-provider.d.ts +23 -23
  79. package/lib/browser/workspace-file-preference-provider.js +110 -110
  80. package/lib/browser/workspace-preference-provider.d.ts +28 -28
  81. package/lib/browser/workspace-preference-provider.js +142 -142
  82. package/package.json +9 -9
  83. package/src/browser/abstract-resource-preference-provider.spec.ts +95 -95
  84. package/src/browser/abstract-resource-preference-provider.ts +228 -228
  85. package/src/browser/folder-preference-provider.ts +58 -58
  86. package/src/browser/folders-preferences-provider.ts +236 -236
  87. package/src/browser/index.ts +23 -23
  88. package/src/browser/monaco-jsonc-editor.ts +67 -67
  89. package/src/browser/package.spec.ts +28 -28
  90. package/src/browser/preference-bindings.ts +65 -65
  91. package/src/browser/preference-frontend-module.ts +57 -57
  92. package/src/browser/preference-open-handler.ts +53 -53
  93. package/src/browser/preference-transaction-manager.ts +283 -283
  94. package/src/browser/preference-tree-model.ts +246 -246
  95. package/src/browser/preferences-contribution.ts +263 -263
  96. package/src/browser/preferences-json-schema-contribution.ts +86 -86
  97. package/src/browser/preferences-monaco-contribution.ts +30 -30
  98. package/src/browser/section-preference-provider.ts +83 -83
  99. package/src/browser/style/index.css +456 -456
  100. package/src/browser/style/preference-array.css +90 -90
  101. package/src/browser/style/preference-context-menu.css +74 -74
  102. package/src/browser/style/preference-file.css +32 -32
  103. package/src/browser/style/preference-object.css +49 -49
  104. package/src/browser/style/search-input.css +66 -66
  105. package/src/browser/user-configs-preference-provider.ts +123 -123
  106. package/src/browser/user-preference-provider.ts +35 -35
  107. package/src/browser/util/preference-scope-command-manager.ts +75 -75
  108. package/src/browser/util/preference-tree-generator.ts +222 -222
  109. package/src/browser/util/preference-tree-label-provider.spec.ts +108 -108
  110. package/src/browser/util/preference-tree-label-provider.ts +64 -64
  111. package/src/browser/util/preference-types.ts +169 -169
  112. package/src/browser/views/components/preference-array-input.ts +174 -174
  113. package/src/browser/views/components/preference-boolean-input.ts +69 -69
  114. package/src/browser/views/components/preference-file-input.ts +104 -104
  115. package/src/browser/views/components/preference-json-input.ts +78 -78
  116. package/src/browser/views/components/preference-node-renderer-creator.ts +141 -141
  117. package/src/browser/views/components/preference-node-renderer.ts +499 -499
  118. package/src/browser/views/components/preference-number-input.ts +147 -147
  119. package/src/browser/views/components/preference-select-input.ts +127 -127
  120. package/src/browser/views/components/preference-string-input.ts +76 -76
  121. package/src/browser/views/preference-editor-widget.ts +361 -361
  122. package/src/browser/views/preference-scope-tabbar-widget.tsx +344 -344
  123. package/src/browser/views/preference-searchbar-widget.tsx +183 -183
  124. package/src/browser/views/preference-tree-widget.tsx +93 -93
  125. package/src/browser/views/preference-widget-bindings.ts +99 -99
  126. package/src/browser/views/preference-widget.tsx +113 -113
  127. package/src/browser/workspace-file-preference-provider.ts +100 -100
  128. package/src/browser/workspace-preference-provider.ts +134 -134
@@ -1,377 +1,377 @@
1
- "use strict";
2
- // *****************************************************************************
3
- // Copyright (C) 2020 Ericsson and others.
4
- //
5
- // This program and the accompanying materials are made available under the
6
- // terms of the Eclipse Public License v. 2.0 which is available at
7
- // http://www.eclipse.org/legal/epl-2.0.
8
- //
9
- // This Source Code may also be made available under the following Secondary
10
- // Licenses when the conditions for such availability set forth in the Eclipse
11
- // Public License v. 2.0 are satisfied: GNU General Public License, version 2
12
- // with the GNU Classpath Exception which is available at
13
- // https://www.gnu.org/software/classpath/license.html.
14
- //
15
- // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
16
- // *****************************************************************************
17
- var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
18
- var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
19
- if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
20
- else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
21
- return c > 3 && r && Object.defineProperty(target, key, r), r;
22
- };
23
- var __metadata = (this && this.__metadata) || function (k, v) {
24
- if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
25
- };
26
- var PreferencesEditorWidget_1;
27
- Object.defineProperty(exports, "__esModule", { value: true });
28
- exports.PreferencesEditorWidget = void 0;
29
- /* eslint-disable @typescript-eslint/no-explicit-any */
30
- const inversify_1 = require("@theia/core/shared/inversify");
31
- const throttle = require("@theia/core/shared/lodash.throttle");
32
- const browser_1 = require("@theia/core/lib/browser");
33
- const common_1 = require("@theia/core/lib/common");
34
- const widget_1 = require("@theia/core/lib/browser/widgets/widget");
35
- const preference_tree_model_1 = require("../preference-tree-model");
36
- const preference_node_renderer_1 = require("./components/preference-node-renderer");
37
- const preference_types_1 = require("../util/preference-types");
38
- const preference_tree_generator_1 = require("../util/preference-tree-generator");
39
- const preference_scope_tabbar_widget_1 = require("./preference-scope-tabbar-widget");
40
- const preference_node_renderer_creator_1 = require("./components/preference-node-renderer-creator");
41
- const stableJsonStringify = require("fast-json-stable-stringify");
42
- let PreferencesEditorWidget = PreferencesEditorWidget_1 = class PreferencesEditorWidget extends widget_1.BaseWidget {
43
- constructor() {
44
- super(...arguments);
45
- this.scrollOptions = widget_1.DEFAULT_SCROLL_OPTIONS;
46
- /**
47
- * Guards against scroll events and selection events looping into each other. Set before this widget initiates a selection.
48
- */
49
- this.currentModelSelectionId = '';
50
- /**
51
- * Permits the user to expand multiple nodes without each one being collapsed on a new selection.
52
- */
53
- this.lastUserSelection = '';
54
- this.isAtScrollTop = true;
55
- this.firstVisibleChildID = '';
56
- this.renderers = new Map();
57
- this.preferenceDataKeys = new Map();
58
- // The commonly used section will duplicate preference ID's, so we'll keep a separate list of them.
59
- this.commonlyUsedRenderers = new Map();
60
- this.onScroll = throttle(this.doOnScroll.bind(this), 50);
61
- }
62
- async init() {
63
- this.id = PreferencesEditorWidget_1.ID;
64
- this.title.label = PreferencesEditorWidget_1.LABEL;
65
- this.addClass('settings-main');
66
- this.toDispose.pushAll([
67
- this.preferenceService.onPreferencesChanged(e => this.handlePreferenceChanges(e)),
68
- this.model.onFilterChanged(e => this.handleDisplayChange(e)),
69
- this.model.onSelectionChanged(e => this.handleSelectionChange(e)),
70
- ]);
71
- this.createContainers();
72
- await this.preferenceService.ready;
73
- this.handleDisplayChange({ source: preference_tree_model_1.PreferenceFilterChangeSource.Schema });
74
- this.rendererRegistry.onDidChange(() => this.handleRegistryChange());
75
- }
76
- createContainers() {
77
- const innerWrapper = document.createElement('div');
78
- innerWrapper.classList.add('settings-main-scroll-container');
79
- this.scrollContainer = innerWrapper;
80
- innerWrapper.addEventListener('scroll', this.onScroll, { passive: true });
81
- this.node.appendChild(innerWrapper);
82
- const noLeavesMessage = document.createElement('div');
83
- noLeavesMessage.classList.add('settings-no-results-announcement');
84
- noLeavesMessage.textContent = 'That search query has returned no results.';
85
- this.node.appendChild(noLeavesMessage);
86
- }
87
- handleDisplayChange(e) {
88
- const { isFiltered } = this.model;
89
- const currentFirstVisible = this.firstVisibleChildID;
90
- const leavesAreVisible = this.areLeavesVisible();
91
- if (e.source === preference_tree_model_1.PreferenceFilterChangeSource.Search) {
92
- this.handleSearchChange(isFiltered, leavesAreVisible);
93
- }
94
- else if (e.source === preference_tree_model_1.PreferenceFilterChangeSource.Scope) {
95
- this.handleScopeChange(isFiltered);
96
- }
97
- else if (e.source === preference_tree_model_1.PreferenceFilterChangeSource.Schema) {
98
- this.handleSchemaChange(isFiltered);
99
- }
100
- else {
101
- (0, common_1.unreachable)(e.source, 'Not all PreferenceFilterChangeSource enum variants handled.');
102
- }
103
- this.resetScroll(currentFirstVisible, e.source === preference_tree_model_1.PreferenceFilterChangeSource.Search && !isFiltered);
104
- }
105
- handleRegistryChange() {
106
- for (const [id, renderer, collection] of this.allRenderers()) {
107
- renderer.dispose();
108
- collection.delete(id);
109
- }
110
- this.handleDisplayChange({ source: preference_tree_model_1.PreferenceFilterChangeSource.Schema });
111
- }
112
- handleSchemaChange(isFiltered) {
113
- var _a;
114
- for (const [id, renderer, collection] of this.allRenderers()) {
115
- const node = this.model.getNode(renderer.nodeId);
116
- if (!node || (preference_types_1.Preference.LeafNode.is(node) && this.hasSchemaChanged(node))) {
117
- renderer.dispose();
118
- collection.delete(id);
119
- }
120
- }
121
- if (this.model.root) {
122
- const nodeIterator = Array.from(this.scrollContainer.children)[Symbol.iterator]();
123
- let nextNode = nodeIterator.next().value;
124
- for (const node of new browser_1.TopDownTreeIterator(this.model.root)) {
125
- if (preference_types_1.Preference.TreeNode.is(node)) {
126
- const { collection, id } = this.analyzeIDAndGetRendererGroup(node.id);
127
- const renderer = (_a = collection.get(id)) !== null && _a !== void 0 ? _a : this.rendererFactory(node);
128
- if (!renderer.node.parentElement) { // If it hasn't been attached yet, it hasn't been checked for the current search.
129
- this.hideIfFailsFilters(renderer, isFiltered);
130
- collection.set(id, renderer);
131
- }
132
- if (!this.preferenceDataKeys.has(node.id) && preference_types_1.Preference.LeafNode.is(node)) {
133
- this.setSchemaPropertyKey(node);
134
- }
135
- if (nextNode !== renderer.node) {
136
- if (nextNode) {
137
- renderer.insertBefore(nextNode);
138
- }
139
- else {
140
- renderer.appendTo(this.scrollContainer);
141
- }
142
- }
143
- else {
144
- nextNode = nodeIterator.next().value;
145
- }
146
- }
147
- }
148
- }
149
- }
150
- handleScopeChange(isFiltered = this.model.isFiltered) {
151
- var _a;
152
- for (const [, renderer] of this.allRenderers()) {
153
- const isHidden = this.hideIfFailsFilters(renderer, isFiltered);
154
- if (isFiltered || !isHidden) {
155
- (_a = renderer.handleScopeChange) === null || _a === void 0 ? void 0 : _a.call(renderer, isFiltered);
156
- }
157
- }
158
- }
159
- hasSchemaChanged(leafNode) {
160
- const oldKey = this.preferenceDataKeys.get(leafNode.id);
161
- const newKey = this.setSchemaPropertyKey(leafNode);
162
- return oldKey !== newKey;
163
- }
164
- setSchemaPropertyKey(leafNode) {
165
- const schemaProperty = this.schemaProvider.getSchemaProperty(leafNode.preferenceId);
166
- if (schemaProperty) {
167
- const key = stableJsonStringify(schemaProperty);
168
- this.preferenceDataKeys.set(leafNode.id, key);
169
- return key;
170
- }
171
- else {
172
- return undefined;
173
- }
174
- }
175
- handleSearchChange(isFiltered, leavesAreVisible) {
176
- var _a;
177
- if (leavesAreVisible) {
178
- for (const [, renderer] of this.allRenderers()) {
179
- const isHidden = this.hideIfFailsFilters(renderer, isFiltered);
180
- if (!isHidden) {
181
- (_a = renderer.handleSearchChange) === null || _a === void 0 ? void 0 : _a.call(renderer, isFiltered);
182
- }
183
- }
184
- }
185
- }
186
- areLeavesVisible() {
187
- const leavesAreVisible = this.model.totalVisibleLeaves > 0;
188
- this.node.classList.toggle('no-results', !leavesAreVisible);
189
- this.scrollContainer.classList.toggle('hidden', !leavesAreVisible);
190
- return leavesAreVisible;
191
- }
192
- *allRenderers() {
193
- for (const [id, renderer] of this.commonlyUsedRenderers.entries()) {
194
- yield [id, renderer, this.commonlyUsedRenderers];
195
- }
196
- for (const [id, renderer] of this.renderers.entries()) {
197
- yield [id, renderer, this.renderers];
198
- }
199
- }
200
- handlePreferenceChanges(e) {
201
- var _a, _b, _c, _d;
202
- for (const id of Object.keys(e)) {
203
- (_b = (_a = this.commonlyUsedRenderers.get(id)) === null || _a === void 0 ? void 0 : _a.handleValueChange) === null || _b === void 0 ? void 0 : _b.call(_a);
204
- (_d = (_c = this.renderers.get(id)) === null || _c === void 0 ? void 0 : _c.handleValueChange) === null || _d === void 0 ? void 0 : _d.call(_c);
205
- }
206
- }
207
- /**
208
- * @returns true if the renderer is hidden, false otherwise.
209
- */
210
- hideIfFailsFilters(renderer, isFiltered) {
211
- const row = this.model.currentRows.get(renderer.nodeId);
212
- if (!row || (browser_1.CompositeTreeNode.is(row.node) && (isFiltered || row.visibleChildren === 0))) {
213
- renderer.hide();
214
- return true;
215
- }
216
- else {
217
- renderer.show();
218
- return false;
219
- }
220
- }
221
- resetScroll(nodeIDToScrollTo, filterWasCleared = false) {
222
- if (this.scrollBar) { // Absent on widget creation
223
- this.doResetScroll(nodeIDToScrollTo, filterWasCleared);
224
- }
225
- else {
226
- const interval = setInterval(() => {
227
- if (this.scrollBar) {
228
- clearInterval(interval);
229
- this.doResetScroll(nodeIDToScrollTo, filterWasCleared);
230
- }
231
- }, 500);
232
- }
233
- }
234
- doResetScroll(nodeIDToScrollTo, filterWasCleared = false) {
235
- requestAnimationFrame(() => {
236
- var _a;
237
- (_a = this.scrollBar) === null || _a === void 0 ? void 0 : _a.update();
238
- if (!filterWasCleared && nodeIDToScrollTo) {
239
- const { id, collection } = this.analyzeIDAndGetRendererGroup(nodeIDToScrollTo);
240
- const renderer = collection.get(id);
241
- if (renderer === null || renderer === void 0 ? void 0 : renderer.visible) {
242
- renderer.node.scrollIntoView();
243
- return;
244
- }
245
- }
246
- this.scrollContainer.scrollTop = 0;
247
- });
248
- }
249
- ;
250
- doOnScroll() {
251
- const { scrollContainer } = this;
252
- const firstVisibleChildID = this.findFirstVisibleChildID();
253
- this.setFirstVisibleChildID(firstVisibleChildID);
254
- if (this.isAtScrollTop && scrollContainer.scrollTop !== 0) {
255
- this.isAtScrollTop = false;
256
- this.tabbar.toggleShadow(true);
257
- }
258
- else if (!this.isAtScrollTop && scrollContainer.scrollTop === 0) {
259
- this.isAtScrollTop = true;
260
- this.tabbar.toggleShadow(false);
261
- }
262
- }
263
- ;
264
- findFirstVisibleChildID() {
265
- const { scrollTop } = this.scrollContainer;
266
- for (const [, renderer] of this.allRenderers()) {
267
- const { offsetTop, offsetHeight } = renderer.node;
268
- if (Math.abs(offsetTop - scrollTop) <= offsetHeight / 2) {
269
- return renderer.nodeId;
270
- }
271
- }
272
- }
273
- setFirstVisibleChildID(id) {
274
- if (id && id !== this.firstVisibleChildID) {
275
- this.firstVisibleChildID = id;
276
- let currentNode = this.model.getNode(id);
277
- let expansionAncestor;
278
- let selectionAncestor;
279
- while (currentNode && (!expansionAncestor || !selectionAncestor)) {
280
- if (!selectionAncestor && browser_1.SelectableTreeNode.is(currentNode)) {
281
- selectionAncestor = currentNode;
282
- }
283
- if (!expansionAncestor && browser_1.ExpandableTreeNode.is(currentNode)) {
284
- expansionAncestor = currentNode;
285
- }
286
- currentNode = currentNode.parent;
287
- }
288
- if (selectionAncestor) {
289
- this.currentModelSelectionId = selectionAncestor.id;
290
- expansionAncestor = expansionAncestor !== null && expansionAncestor !== void 0 ? expansionAncestor : selectionAncestor;
291
- this.model.selectIfNotSelected(selectionAncestor);
292
- if (!this.model.isFiltered && id !== this.lastUserSelection) {
293
- this.lastUserSelection = '';
294
- this.model.collapseAllExcept(expansionAncestor);
295
- }
296
- }
297
- }
298
- }
299
- handleSelectionChange(selectionEvent) {
300
- const node = selectionEvent[0];
301
- if (node && node.id !== this.currentModelSelectionId) {
302
- this.currentModelSelectionId = node.id;
303
- this.lastUserSelection = node.id;
304
- if (this.model.isFiltered && browser_1.CompositeTreeNode.is(node)) {
305
- for (const candidate of new browser_1.TopDownTreeIterator(node, { pruneSiblings: true })) {
306
- const { id, collection } = this.analyzeIDAndGetRendererGroup(candidate.id);
307
- const renderer = collection.get(id);
308
- if (renderer === null || renderer === void 0 ? void 0 : renderer.visible) {
309
- // When filtered, treat the first visible child as the selected node, since it will be the one scrolled to.
310
- this.lastUserSelection = renderer.nodeId;
311
- renderer.node.scrollIntoView();
312
- return;
313
- }
314
- }
315
- }
316
- else {
317
- const { id, collection } = this.analyzeIDAndGetRendererGroup(node.id);
318
- const renderer = collection.get(id);
319
- renderer === null || renderer === void 0 ? void 0 : renderer.node.scrollIntoView();
320
- }
321
- }
322
- }
323
- analyzeIDAndGetRendererGroup(nodeID) {
324
- const { id, group } = preference_types_1.Preference.TreeNode.getGroupAndIdFromNodeId(nodeID);
325
- const collection = group === preference_tree_generator_1.COMMONLY_USED_SECTION_PREFIX ? this.commonlyUsedRenderers : this.renderers;
326
- return { id, group, collection };
327
- }
328
- getScrollContainer() {
329
- return this.scrollContainer;
330
- }
331
- storeState() {
332
- return {
333
- firstVisibleChildID: this.firstVisibleChildID,
334
- };
335
- }
336
- restoreState(oldState) {
337
- this.firstVisibleChildID = oldState.firstVisibleChildID;
338
- this.resetScroll(this.firstVisibleChildID);
339
- }
340
- };
341
- PreferencesEditorWidget.ID = 'settings.editor';
342
- PreferencesEditorWidget.LABEL = 'Settings Editor';
343
- __decorate([
344
- (0, inversify_1.inject)(browser_1.PreferenceService),
345
- __metadata("design:type", Object)
346
- ], PreferencesEditorWidget.prototype, "preferenceService", void 0);
347
- __decorate([
348
- (0, inversify_1.inject)(preference_tree_model_1.PreferenceTreeModel),
349
- __metadata("design:type", preference_tree_model_1.PreferenceTreeModel)
350
- ], PreferencesEditorWidget.prototype, "model", void 0);
351
- __decorate([
352
- (0, inversify_1.inject)(preference_node_renderer_1.PreferenceNodeRendererFactory),
353
- __metadata("design:type", Function)
354
- ], PreferencesEditorWidget.prototype, "rendererFactory", void 0);
355
- __decorate([
356
- (0, inversify_1.inject)(preference_node_renderer_creator_1.PreferenceNodeRendererCreatorRegistry),
357
- __metadata("design:type", Object)
358
- ], PreferencesEditorWidget.prototype, "rendererRegistry", void 0);
359
- __decorate([
360
- (0, inversify_1.inject)(browser_1.PreferenceSchemaProvider),
361
- __metadata("design:type", browser_1.PreferenceSchemaProvider)
362
- ], PreferencesEditorWidget.prototype, "schemaProvider", void 0);
363
- __decorate([
364
- (0, inversify_1.inject)(preference_scope_tabbar_widget_1.PreferencesScopeTabBar),
365
- __metadata("design:type", preference_scope_tabbar_widget_1.PreferencesScopeTabBar)
366
- ], PreferencesEditorWidget.prototype, "tabbar", void 0);
367
- __decorate([
368
- (0, inversify_1.postConstruct)(),
369
- __metadata("design:type", Function),
370
- __metadata("design:paramtypes", []),
371
- __metadata("design:returntype", Promise)
372
- ], PreferencesEditorWidget.prototype, "init", null);
373
- PreferencesEditorWidget = PreferencesEditorWidget_1 = __decorate([
374
- (0, inversify_1.injectable)()
375
- ], PreferencesEditorWidget);
376
- exports.PreferencesEditorWidget = PreferencesEditorWidget;
1
+ "use strict";
2
+ // *****************************************************************************
3
+ // Copyright (C) 2020 Ericsson and others.
4
+ //
5
+ // This program and the accompanying materials are made available under the
6
+ // terms of the Eclipse Public License v. 2.0 which is available at
7
+ // http://www.eclipse.org/legal/epl-2.0.
8
+ //
9
+ // This Source Code may also be made available under the following Secondary
10
+ // Licenses when the conditions for such availability set forth in the Eclipse
11
+ // Public License v. 2.0 are satisfied: GNU General Public License, version 2
12
+ // with the GNU Classpath Exception which is available at
13
+ // https://www.gnu.org/software/classpath/license.html.
14
+ //
15
+ // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
16
+ // *****************************************************************************
17
+ var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
18
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
19
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
20
+ else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
21
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
22
+ };
23
+ var __metadata = (this && this.__metadata) || function (k, v) {
24
+ if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
25
+ };
26
+ var PreferencesEditorWidget_1;
27
+ Object.defineProperty(exports, "__esModule", { value: true });
28
+ exports.PreferencesEditorWidget = void 0;
29
+ /* eslint-disable @typescript-eslint/no-explicit-any */
30
+ const inversify_1 = require("@theia/core/shared/inversify");
31
+ const throttle = require("@theia/core/shared/lodash.throttle");
32
+ const browser_1 = require("@theia/core/lib/browser");
33
+ const common_1 = require("@theia/core/lib/common");
34
+ const widget_1 = require("@theia/core/lib/browser/widgets/widget");
35
+ const preference_tree_model_1 = require("../preference-tree-model");
36
+ const preference_node_renderer_1 = require("./components/preference-node-renderer");
37
+ const preference_types_1 = require("../util/preference-types");
38
+ const preference_tree_generator_1 = require("../util/preference-tree-generator");
39
+ const preference_scope_tabbar_widget_1 = require("./preference-scope-tabbar-widget");
40
+ const preference_node_renderer_creator_1 = require("./components/preference-node-renderer-creator");
41
+ const stableJsonStringify = require("fast-json-stable-stringify");
42
+ let PreferencesEditorWidget = PreferencesEditorWidget_1 = class PreferencesEditorWidget extends widget_1.BaseWidget {
43
+ constructor() {
44
+ super(...arguments);
45
+ this.scrollOptions = widget_1.DEFAULT_SCROLL_OPTIONS;
46
+ /**
47
+ * Guards against scroll events and selection events looping into each other. Set before this widget initiates a selection.
48
+ */
49
+ this.currentModelSelectionId = '';
50
+ /**
51
+ * Permits the user to expand multiple nodes without each one being collapsed on a new selection.
52
+ */
53
+ this.lastUserSelection = '';
54
+ this.isAtScrollTop = true;
55
+ this.firstVisibleChildID = '';
56
+ this.renderers = new Map();
57
+ this.preferenceDataKeys = new Map();
58
+ // The commonly used section will duplicate preference ID's, so we'll keep a separate list of them.
59
+ this.commonlyUsedRenderers = new Map();
60
+ this.onScroll = throttle(this.doOnScroll.bind(this), 50);
61
+ }
62
+ async init() {
63
+ this.id = PreferencesEditorWidget_1.ID;
64
+ this.title.label = PreferencesEditorWidget_1.LABEL;
65
+ this.addClass('settings-main');
66
+ this.toDispose.pushAll([
67
+ this.preferenceService.onPreferencesChanged(e => this.handlePreferenceChanges(e)),
68
+ this.model.onFilterChanged(e => this.handleDisplayChange(e)),
69
+ this.model.onSelectionChanged(e => this.handleSelectionChange(e)),
70
+ ]);
71
+ this.createContainers();
72
+ await this.preferenceService.ready;
73
+ this.handleDisplayChange({ source: preference_tree_model_1.PreferenceFilterChangeSource.Schema });
74
+ this.rendererRegistry.onDidChange(() => this.handleRegistryChange());
75
+ }
76
+ createContainers() {
77
+ const innerWrapper = document.createElement('div');
78
+ innerWrapper.classList.add('settings-main-scroll-container');
79
+ this.scrollContainer = innerWrapper;
80
+ innerWrapper.addEventListener('scroll', this.onScroll, { passive: true });
81
+ this.node.appendChild(innerWrapper);
82
+ const noLeavesMessage = document.createElement('div');
83
+ noLeavesMessage.classList.add('settings-no-results-announcement');
84
+ noLeavesMessage.textContent = 'That search query has returned no results.';
85
+ this.node.appendChild(noLeavesMessage);
86
+ }
87
+ handleDisplayChange(e) {
88
+ const { isFiltered } = this.model;
89
+ const currentFirstVisible = this.firstVisibleChildID;
90
+ const leavesAreVisible = this.areLeavesVisible();
91
+ if (e.source === preference_tree_model_1.PreferenceFilterChangeSource.Search) {
92
+ this.handleSearchChange(isFiltered, leavesAreVisible);
93
+ }
94
+ else if (e.source === preference_tree_model_1.PreferenceFilterChangeSource.Scope) {
95
+ this.handleScopeChange(isFiltered);
96
+ }
97
+ else if (e.source === preference_tree_model_1.PreferenceFilterChangeSource.Schema) {
98
+ this.handleSchemaChange(isFiltered);
99
+ }
100
+ else {
101
+ (0, common_1.unreachable)(e.source, 'Not all PreferenceFilterChangeSource enum variants handled.');
102
+ }
103
+ this.resetScroll(currentFirstVisible, e.source === preference_tree_model_1.PreferenceFilterChangeSource.Search && !isFiltered);
104
+ }
105
+ handleRegistryChange() {
106
+ for (const [id, renderer, collection] of this.allRenderers()) {
107
+ renderer.dispose();
108
+ collection.delete(id);
109
+ }
110
+ this.handleDisplayChange({ source: preference_tree_model_1.PreferenceFilterChangeSource.Schema });
111
+ }
112
+ handleSchemaChange(isFiltered) {
113
+ var _a;
114
+ for (const [id, renderer, collection] of this.allRenderers()) {
115
+ const node = this.model.getNode(renderer.nodeId);
116
+ if (!node || (preference_types_1.Preference.LeafNode.is(node) && this.hasSchemaChanged(node))) {
117
+ renderer.dispose();
118
+ collection.delete(id);
119
+ }
120
+ }
121
+ if (this.model.root) {
122
+ const nodeIterator = Array.from(this.scrollContainer.children)[Symbol.iterator]();
123
+ let nextNode = nodeIterator.next().value;
124
+ for (const node of new browser_1.TopDownTreeIterator(this.model.root)) {
125
+ if (preference_types_1.Preference.TreeNode.is(node)) {
126
+ const { collection, id } = this.analyzeIDAndGetRendererGroup(node.id);
127
+ const renderer = (_a = collection.get(id)) !== null && _a !== void 0 ? _a : this.rendererFactory(node);
128
+ if (!renderer.node.parentElement) { // If it hasn't been attached yet, it hasn't been checked for the current search.
129
+ this.hideIfFailsFilters(renderer, isFiltered);
130
+ collection.set(id, renderer);
131
+ }
132
+ if (!this.preferenceDataKeys.has(node.id) && preference_types_1.Preference.LeafNode.is(node)) {
133
+ this.setSchemaPropertyKey(node);
134
+ }
135
+ if (nextNode !== renderer.node) {
136
+ if (nextNode) {
137
+ renderer.insertBefore(nextNode);
138
+ }
139
+ else {
140
+ renderer.appendTo(this.scrollContainer);
141
+ }
142
+ }
143
+ else {
144
+ nextNode = nodeIterator.next().value;
145
+ }
146
+ }
147
+ }
148
+ }
149
+ }
150
+ handleScopeChange(isFiltered = this.model.isFiltered) {
151
+ var _a;
152
+ for (const [, renderer] of this.allRenderers()) {
153
+ const isHidden = this.hideIfFailsFilters(renderer, isFiltered);
154
+ if (isFiltered || !isHidden) {
155
+ (_a = renderer.handleScopeChange) === null || _a === void 0 ? void 0 : _a.call(renderer, isFiltered);
156
+ }
157
+ }
158
+ }
159
+ hasSchemaChanged(leafNode) {
160
+ const oldKey = this.preferenceDataKeys.get(leafNode.id);
161
+ const newKey = this.setSchemaPropertyKey(leafNode);
162
+ return oldKey !== newKey;
163
+ }
164
+ setSchemaPropertyKey(leafNode) {
165
+ const schemaProperty = this.schemaProvider.getSchemaProperty(leafNode.preferenceId);
166
+ if (schemaProperty) {
167
+ const key = stableJsonStringify(schemaProperty);
168
+ this.preferenceDataKeys.set(leafNode.id, key);
169
+ return key;
170
+ }
171
+ else {
172
+ return undefined;
173
+ }
174
+ }
175
+ handleSearchChange(isFiltered, leavesAreVisible) {
176
+ var _a;
177
+ if (leavesAreVisible) {
178
+ for (const [, renderer] of this.allRenderers()) {
179
+ const isHidden = this.hideIfFailsFilters(renderer, isFiltered);
180
+ if (!isHidden) {
181
+ (_a = renderer.handleSearchChange) === null || _a === void 0 ? void 0 : _a.call(renderer, isFiltered);
182
+ }
183
+ }
184
+ }
185
+ }
186
+ areLeavesVisible() {
187
+ const leavesAreVisible = this.model.totalVisibleLeaves > 0;
188
+ this.node.classList.toggle('no-results', !leavesAreVisible);
189
+ this.scrollContainer.classList.toggle('hidden', !leavesAreVisible);
190
+ return leavesAreVisible;
191
+ }
192
+ *allRenderers() {
193
+ for (const [id, renderer] of this.commonlyUsedRenderers.entries()) {
194
+ yield [id, renderer, this.commonlyUsedRenderers];
195
+ }
196
+ for (const [id, renderer] of this.renderers.entries()) {
197
+ yield [id, renderer, this.renderers];
198
+ }
199
+ }
200
+ handlePreferenceChanges(e) {
201
+ var _a, _b, _c, _d;
202
+ for (const id of Object.keys(e)) {
203
+ (_b = (_a = this.commonlyUsedRenderers.get(id)) === null || _a === void 0 ? void 0 : _a.handleValueChange) === null || _b === void 0 ? void 0 : _b.call(_a);
204
+ (_d = (_c = this.renderers.get(id)) === null || _c === void 0 ? void 0 : _c.handleValueChange) === null || _d === void 0 ? void 0 : _d.call(_c);
205
+ }
206
+ }
207
+ /**
208
+ * @returns true if the renderer is hidden, false otherwise.
209
+ */
210
+ hideIfFailsFilters(renderer, isFiltered) {
211
+ const row = this.model.currentRows.get(renderer.nodeId);
212
+ if (!row || (browser_1.CompositeTreeNode.is(row.node) && (isFiltered || row.visibleChildren === 0))) {
213
+ renderer.hide();
214
+ return true;
215
+ }
216
+ else {
217
+ renderer.show();
218
+ return false;
219
+ }
220
+ }
221
+ resetScroll(nodeIDToScrollTo, filterWasCleared = false) {
222
+ if (this.scrollBar) { // Absent on widget creation
223
+ this.doResetScroll(nodeIDToScrollTo, filterWasCleared);
224
+ }
225
+ else {
226
+ const interval = setInterval(() => {
227
+ if (this.scrollBar) {
228
+ clearInterval(interval);
229
+ this.doResetScroll(nodeIDToScrollTo, filterWasCleared);
230
+ }
231
+ }, 500);
232
+ }
233
+ }
234
+ doResetScroll(nodeIDToScrollTo, filterWasCleared = false) {
235
+ requestAnimationFrame(() => {
236
+ var _a;
237
+ (_a = this.scrollBar) === null || _a === void 0 ? void 0 : _a.update();
238
+ if (!filterWasCleared && nodeIDToScrollTo) {
239
+ const { id, collection } = this.analyzeIDAndGetRendererGroup(nodeIDToScrollTo);
240
+ const renderer = collection.get(id);
241
+ if (renderer === null || renderer === void 0 ? void 0 : renderer.visible) {
242
+ renderer.node.scrollIntoView();
243
+ return;
244
+ }
245
+ }
246
+ this.scrollContainer.scrollTop = 0;
247
+ });
248
+ }
249
+ ;
250
+ doOnScroll() {
251
+ const { scrollContainer } = this;
252
+ const firstVisibleChildID = this.findFirstVisibleChildID();
253
+ this.setFirstVisibleChildID(firstVisibleChildID);
254
+ if (this.isAtScrollTop && scrollContainer.scrollTop !== 0) {
255
+ this.isAtScrollTop = false;
256
+ this.tabbar.toggleShadow(true);
257
+ }
258
+ else if (!this.isAtScrollTop && scrollContainer.scrollTop === 0) {
259
+ this.isAtScrollTop = true;
260
+ this.tabbar.toggleShadow(false);
261
+ }
262
+ }
263
+ ;
264
+ findFirstVisibleChildID() {
265
+ const { scrollTop } = this.scrollContainer;
266
+ for (const [, renderer] of this.allRenderers()) {
267
+ const { offsetTop, offsetHeight } = renderer.node;
268
+ if (Math.abs(offsetTop - scrollTop) <= offsetHeight / 2) {
269
+ return renderer.nodeId;
270
+ }
271
+ }
272
+ }
273
+ setFirstVisibleChildID(id) {
274
+ if (id && id !== this.firstVisibleChildID) {
275
+ this.firstVisibleChildID = id;
276
+ let currentNode = this.model.getNode(id);
277
+ let expansionAncestor;
278
+ let selectionAncestor;
279
+ while (currentNode && (!expansionAncestor || !selectionAncestor)) {
280
+ if (!selectionAncestor && browser_1.SelectableTreeNode.is(currentNode)) {
281
+ selectionAncestor = currentNode;
282
+ }
283
+ if (!expansionAncestor && browser_1.ExpandableTreeNode.is(currentNode)) {
284
+ expansionAncestor = currentNode;
285
+ }
286
+ currentNode = currentNode.parent;
287
+ }
288
+ if (selectionAncestor) {
289
+ this.currentModelSelectionId = selectionAncestor.id;
290
+ expansionAncestor = expansionAncestor !== null && expansionAncestor !== void 0 ? expansionAncestor : selectionAncestor;
291
+ this.model.selectIfNotSelected(selectionAncestor);
292
+ if (!this.model.isFiltered && id !== this.lastUserSelection) {
293
+ this.lastUserSelection = '';
294
+ this.model.collapseAllExcept(expansionAncestor);
295
+ }
296
+ }
297
+ }
298
+ }
299
+ handleSelectionChange(selectionEvent) {
300
+ const node = selectionEvent[0];
301
+ if (node && node.id !== this.currentModelSelectionId) {
302
+ this.currentModelSelectionId = node.id;
303
+ this.lastUserSelection = node.id;
304
+ if (this.model.isFiltered && browser_1.CompositeTreeNode.is(node)) {
305
+ for (const candidate of new browser_1.TopDownTreeIterator(node, { pruneSiblings: true })) {
306
+ const { id, collection } = this.analyzeIDAndGetRendererGroup(candidate.id);
307
+ const renderer = collection.get(id);
308
+ if (renderer === null || renderer === void 0 ? void 0 : renderer.visible) {
309
+ // When filtered, treat the first visible child as the selected node, since it will be the one scrolled to.
310
+ this.lastUserSelection = renderer.nodeId;
311
+ renderer.node.scrollIntoView();
312
+ return;
313
+ }
314
+ }
315
+ }
316
+ else {
317
+ const { id, collection } = this.analyzeIDAndGetRendererGroup(node.id);
318
+ const renderer = collection.get(id);
319
+ renderer === null || renderer === void 0 ? void 0 : renderer.node.scrollIntoView();
320
+ }
321
+ }
322
+ }
323
+ analyzeIDAndGetRendererGroup(nodeID) {
324
+ const { id, group } = preference_types_1.Preference.TreeNode.getGroupAndIdFromNodeId(nodeID);
325
+ const collection = group === preference_tree_generator_1.COMMONLY_USED_SECTION_PREFIX ? this.commonlyUsedRenderers : this.renderers;
326
+ return { id, group, collection };
327
+ }
328
+ getScrollContainer() {
329
+ return this.scrollContainer;
330
+ }
331
+ storeState() {
332
+ return {
333
+ firstVisibleChildID: this.firstVisibleChildID,
334
+ };
335
+ }
336
+ restoreState(oldState) {
337
+ this.firstVisibleChildID = oldState.firstVisibleChildID;
338
+ this.resetScroll(this.firstVisibleChildID);
339
+ }
340
+ };
341
+ PreferencesEditorWidget.ID = 'settings.editor';
342
+ PreferencesEditorWidget.LABEL = 'Settings Editor';
343
+ __decorate([
344
+ (0, inversify_1.inject)(browser_1.PreferenceService),
345
+ __metadata("design:type", Object)
346
+ ], PreferencesEditorWidget.prototype, "preferenceService", void 0);
347
+ __decorate([
348
+ (0, inversify_1.inject)(preference_tree_model_1.PreferenceTreeModel),
349
+ __metadata("design:type", preference_tree_model_1.PreferenceTreeModel)
350
+ ], PreferencesEditorWidget.prototype, "model", void 0);
351
+ __decorate([
352
+ (0, inversify_1.inject)(preference_node_renderer_1.PreferenceNodeRendererFactory),
353
+ __metadata("design:type", Function)
354
+ ], PreferencesEditorWidget.prototype, "rendererFactory", void 0);
355
+ __decorate([
356
+ (0, inversify_1.inject)(preference_node_renderer_creator_1.PreferenceNodeRendererCreatorRegistry),
357
+ __metadata("design:type", Object)
358
+ ], PreferencesEditorWidget.prototype, "rendererRegistry", void 0);
359
+ __decorate([
360
+ (0, inversify_1.inject)(browser_1.PreferenceSchemaProvider),
361
+ __metadata("design:type", browser_1.PreferenceSchemaProvider)
362
+ ], PreferencesEditorWidget.prototype, "schemaProvider", void 0);
363
+ __decorate([
364
+ (0, inversify_1.inject)(preference_scope_tabbar_widget_1.PreferencesScopeTabBar),
365
+ __metadata("design:type", preference_scope_tabbar_widget_1.PreferencesScopeTabBar)
366
+ ], PreferencesEditorWidget.prototype, "tabbar", void 0);
367
+ __decorate([
368
+ (0, inversify_1.postConstruct)(),
369
+ __metadata("design:type", Function),
370
+ __metadata("design:paramtypes", []),
371
+ __metadata("design:returntype", Promise)
372
+ ], PreferencesEditorWidget.prototype, "init", null);
373
+ PreferencesEditorWidget = PreferencesEditorWidget_1 = __decorate([
374
+ (0, inversify_1.injectable)()
375
+ ], PreferencesEditorWidget);
376
+ exports.PreferencesEditorWidget = PreferencesEditorWidget;
377
377
  //# sourceMappingURL=preference-editor-widget.js.map