@theia/preferences 1.45.1 → 1.46.0-next.72

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 (130) hide show
  1. package/README.md +81 -81
  2. package/lib/browser/abstract-resource-preference-provider.d.ts +47 -47
  3. package/lib/browser/abstract-resource-preference-provider.js +240 -240
  4. package/lib/browser/abstract-resource-preference-provider.spec.d.ts +1 -1
  5. package/lib/browser/abstract-resource-preference-provider.spec.js +83 -83
  6. package/lib/browser/folder-preference-provider.d.ts +20 -20
  7. package/lib/browser/folder-preference-provider.js +59 -59
  8. package/lib/browser/folders-preferences-provider.d.ts +27 -27
  9. package/lib/browser/folders-preferences-provider.js +245 -245
  10. package/lib/browser/index.d.ts +7 -7
  11. package/lib/browser/index.js +34 -34
  12. package/lib/browser/monaco-jsonc-editor.d.ts +9 -9
  13. package/lib/browser/monaco-jsonc-editor.js +80 -80
  14. package/lib/browser/package.spec.js +25 -25
  15. package/lib/browser/preference-bindings.d.ts +4 -4
  16. package/lib/browser/preference-bindings.js +63 -63
  17. package/lib/browser/preference-frontend-module.d.ts +6 -6
  18. package/lib/browser/preference-frontend-module.js +52 -52
  19. package/lib/browser/preference-open-handler.d.ts +9 -9
  20. package/lib/browser/preference-open-handler.js +64 -64
  21. package/lib/browser/preference-transaction-manager.d.ts +100 -100
  22. package/lib/browser/preference-transaction-manager.js +293 -293
  23. package/lib/browser/preference-tree-model.d.ts +60 -60
  24. package/lib/browser/preference-tree-model.js +243 -243
  25. package/lib/browser/preferences-contribution.d.ts +37 -37
  26. package/lib/browser/preferences-contribution.js +280 -280
  27. package/lib/browser/preferences-json-schema-contribution.d.ts +17 -17
  28. package/lib/browser/preferences-json-schema-contribution.js +91 -91
  29. package/lib/browser/preferences-monaco-contribution.d.ts +1 -1
  30. package/lib/browser/preferences-monaco-contribution.js +27 -27
  31. package/lib/browser/section-preference-provider.d.ts +21 -21
  32. package/lib/browser/section-preference-provider.js +96 -96
  33. package/lib/browser/user-configs-preference-provider.d.ts +22 -22
  34. package/lib/browser/user-configs-preference-provider.js +137 -137
  35. package/lib/browser/user-preference-provider.d.ts +13 -13
  36. package/lib/browser/user-preference-provider.js +41 -41
  37. package/lib/browser/util/preference-scope-command-manager.d.ts +17 -17
  38. package/lib/browser/util/preference-scope-command-manager.js +87 -87
  39. package/lib/browser/util/preference-tree-generator.d.ts +31 -31
  40. package/lib/browser/util/preference-tree-generator.js +237 -237
  41. package/lib/browser/util/preference-tree-label-provider.d.ts +11 -11
  42. package/lib/browser/util/preference-tree-label-provider.js +77 -77
  43. package/lib/browser/util/preference-tree-label-provider.spec.d.ts +1 -1
  44. package/lib/browser/util/preference-tree-label-provider.spec.js +87 -87
  45. package/lib/browser/util/preference-types.d.ts +62 -62
  46. package/lib/browser/util/preference-types.js +128 -128
  47. package/lib/browser/views/components/preference-array-input.d.ts +28 -28
  48. package/lib/browser/views/components/preference-array-input.js +180 -180
  49. package/lib/browser/views/components/preference-boolean-input.d.ts +17 -17
  50. package/lib/browser/views/components/preference-boolean-input.js +79 -79
  51. package/lib/browser/views/components/preference-file-input.d.ts +29 -29
  52. package/lib/browser/views/components/preference-file-input.js +110 -110
  53. package/lib/browser/views/components/preference-json-input.d.ts +19 -19
  54. package/lib/browser/views/components/preference-json-input.js +93 -93
  55. package/lib/browser/views/components/preference-markdown-renderer.d.ts +12 -12
  56. package/lib/browser/views/components/preference-markdown-renderer.js +81 -81
  57. package/lib/browser/views/components/preference-node-renderer-creator.d.ts +48 -48
  58. package/lib/browser/views/components/preference-node-renderer-creator.js +132 -132
  59. package/lib/browser/views/components/preference-node-renderer.d.ts +112 -112
  60. package/lib/browser/views/components/preference-node-renderer.js +441 -441
  61. package/lib/browser/views/components/preference-number-input.d.ts +34 -34
  62. package/lib/browser/views/components/preference-number-input.js +142 -142
  63. package/lib/browser/views/components/preference-select-input.d.ts +28 -28
  64. package/lib/browser/views/components/preference-select-input.js +138 -138
  65. package/lib/browser/views/components/preference-string-input.d.ts +17 -17
  66. package/lib/browser/views/components/preference-string-input.js +89 -89
  67. package/lib/browser/views/preference-editor-widget.d.ts +67 -67
  68. package/lib/browser/views/preference-editor-widget.js +363 -363
  69. package/lib/browser/views/preference-scope-tabbar-widget.d.ts +54 -54
  70. package/lib/browser/views/preference-scope-tabbar-widget.js +343 -343
  71. package/lib/browser/views/preference-searchbar-widget.d.ts +53 -53
  72. package/lib/browser/views/preference-searchbar-widget.js +173 -173
  73. package/lib/browser/views/preference-tree-widget.d.ts +17 -17
  74. package/lib/browser/views/preference-tree-widget.js +104 -104
  75. package/lib/browser/views/preference-widget-bindings.d.ts +3 -3
  76. package/lib/browser/views/preference-widget-bindings.js +87 -87
  77. package/lib/browser/views/preference-widget.d.ts +36 -36
  78. package/lib/browser/views/preference-widget.js +126 -126
  79. package/lib/browser/workspace-file-preference-provider.d.ts +23 -23
  80. package/lib/browser/workspace-file-preference-provider.js +110 -110
  81. package/lib/browser/workspace-preference-provider.d.ts +28 -28
  82. package/lib/browser/workspace-preference-provider.js +142 -142
  83. package/package.json +10 -10
  84. package/src/browser/abstract-resource-preference-provider.spec.ts +95 -95
  85. package/src/browser/abstract-resource-preference-provider.ts +232 -232
  86. package/src/browser/folder-preference-provider.ts +58 -58
  87. package/src/browser/folders-preferences-provider.ts +244 -244
  88. package/src/browser/index.ts +23 -23
  89. package/src/browser/monaco-jsonc-editor.ts +67 -67
  90. package/src/browser/package.spec.ts +28 -28
  91. package/src/browser/preference-bindings.ts +65 -65
  92. package/src/browser/preference-frontend-module.ts +57 -57
  93. package/src/browser/preference-open-handler.ts +53 -53
  94. package/src/browser/preference-transaction-manager.ts +287 -287
  95. package/src/browser/preference-tree-model.ts +250 -250
  96. package/src/browser/preferences-contribution.ts +263 -263
  97. package/src/browser/preferences-json-schema-contribution.ts +86 -86
  98. package/src/browser/preferences-monaco-contribution.ts +27 -27
  99. package/src/browser/section-preference-provider.ts +83 -83
  100. package/src/browser/style/index.css +506 -506
  101. package/src/browser/style/preference-array.css +94 -94
  102. package/src/browser/style/preference-context-menu.css +74 -74
  103. package/src/browser/style/preference-file.css +31 -31
  104. package/src/browser/style/preference-object.css +49 -49
  105. package/src/browser/style/search-input.css +66 -66
  106. package/src/browser/user-configs-preference-provider.ts +127 -127
  107. package/src/browser/user-preference-provider.ts +35 -35
  108. package/src/browser/util/preference-scope-command-manager.ts +75 -75
  109. package/src/browser/util/preference-tree-generator.ts +226 -226
  110. package/src/browser/util/preference-tree-label-provider.spec.ts +108 -108
  111. package/src/browser/util/preference-tree-label-provider.ts +64 -64
  112. package/src/browser/util/preference-types.ts +169 -169
  113. package/src/browser/views/components/preference-array-input.ts +174 -174
  114. package/src/browser/views/components/preference-boolean-input.ts +69 -69
  115. package/src/browser/views/components/preference-file-input.ts +104 -104
  116. package/src/browser/views/components/preference-json-input.ts +78 -78
  117. package/src/browser/views/components/preference-markdown-renderer.ts +68 -68
  118. package/src/browser/views/components/preference-node-renderer-creator.ts +141 -141
  119. package/src/browser/views/components/preference-node-renderer.ts +477 -477
  120. package/src/browser/views/components/preference-number-input.ts +147 -147
  121. package/src/browser/views/components/preference-select-input.ts +131 -131
  122. package/src/browser/views/components/preference-string-input.ts +76 -76
  123. package/src/browser/views/preference-editor-widget.ts +349 -349
  124. package/src/browser/views/preference-scope-tabbar-widget.tsx +344 -344
  125. package/src/browser/views/preference-searchbar-widget.tsx +183 -183
  126. package/src/browser/views/preference-tree-widget.tsx +93 -93
  127. package/src/browser/views/preference-widget-bindings.ts +102 -102
  128. package/src/browser/views/preference-widget.tsx +117 -117
  129. package/src/browser/workspace-file-preference-provider.ts +100 -100
  130. package/src/browser/workspace-preference-provider.ts +134 -134
@@ -1,364 +1,364 @@
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-only 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 deepEqual = require("fast-deep-equal");
33
- const browser_1 = require("@theia/core/lib/browser");
34
- const common_1 = require("@theia/core/lib/common");
35
- const widget_1 = require("@theia/core/lib/browser/widgets/widget");
36
- const preference_tree_model_1 = require("../preference-tree-model");
37
- const preference_node_renderer_1 = require("./components/preference-node-renderer");
38
- const preference_types_1 = require("../util/preference-types");
39
- const preference_tree_generator_1 = require("../util/preference-tree-generator");
40
- const preference_scope_tabbar_widget_1 = require("./preference-scope-tabbar-widget");
41
- const preference_node_renderer_creator_1 = require("./components/preference-node-renderer-creator");
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
- init() {
63
- this.doInit();
64
- }
65
- async doInit() {
66
- this.id = PreferencesEditorWidget_1.ID;
67
- this.title.label = PreferencesEditorWidget_1.LABEL;
68
- this.addClass('settings-main');
69
- this.toDispose.pushAll([
70
- this.preferenceService.onPreferencesChanged(e => this.handlePreferenceChanges(e)),
71
- this.model.onFilterChanged(e => this.handleDisplayChange(e)),
72
- this.model.onSelectionChanged(e => this.handleSelectionChange(e)),
73
- ]);
74
- this.createContainers();
75
- await this.preferenceService.ready;
76
- this.handleDisplayChange({ source: preference_tree_model_1.PreferenceFilterChangeSource.Schema });
77
- this.rendererRegistry.onDidChange(() => this.handleRegistryChange());
78
- }
79
- createContainers() {
80
- const innerWrapper = document.createElement('div');
81
- innerWrapper.classList.add('settings-main-scroll-container');
82
- this.scrollContainer = innerWrapper;
83
- innerWrapper.addEventListener('scroll', this.onScroll, { passive: true });
84
- this.node.appendChild(innerWrapper);
85
- const noLeavesMessage = document.createElement('div');
86
- noLeavesMessage.classList.add('settings-no-results-announcement');
87
- noLeavesMessage.textContent = 'That search query has returned no results.';
88
- this.node.appendChild(noLeavesMessage);
89
- }
90
- handleDisplayChange(e) {
91
- const { isFiltered } = this.model;
92
- const currentFirstVisible = this.firstVisibleChildID;
93
- const leavesAreVisible = this.areLeavesVisible();
94
- if (e.source === preference_tree_model_1.PreferenceFilterChangeSource.Search) {
95
- this.handleSearchChange(isFiltered, leavesAreVisible);
96
- }
97
- else if (e.source === preference_tree_model_1.PreferenceFilterChangeSource.Scope) {
98
- this.handleScopeChange(isFiltered);
99
- }
100
- else if (e.source === preference_tree_model_1.PreferenceFilterChangeSource.Schema) {
101
- this.handleSchemaChange(isFiltered);
102
- }
103
- else {
104
- (0, common_1.unreachable)(e.source, 'Not all PreferenceFilterChangeSource enum variants handled.');
105
- }
106
- this.resetScroll(currentFirstVisible, e.source === preference_tree_model_1.PreferenceFilterChangeSource.Search && !isFiltered);
107
- }
108
- handleRegistryChange() {
109
- for (const [id, renderer, collection] of this.allRenderers()) {
110
- renderer.dispose();
111
- collection.delete(id);
112
- }
113
- this.handleDisplayChange({ source: preference_tree_model_1.PreferenceFilterChangeSource.Schema });
114
- }
115
- handleSchemaChange(isFiltered) {
116
- var _a;
117
- for (const [id, renderer, collection] of this.allRenderers()) {
118
- const node = this.model.getNode(renderer.nodeId);
119
- if (!node || (preference_types_1.Preference.LeafNode.is(node) && this.hasSchemaChanged(renderer, node))) {
120
- renderer.dispose();
121
- collection.delete(id);
122
- }
123
- }
124
- if (this.model.root) {
125
- const nodeIterator = Array.from(this.scrollContainer.children)[Symbol.iterator]();
126
- let nextNode = nodeIterator.next().value;
127
- for (const node of new browser_1.TopDownTreeIterator(this.model.root)) {
128
- if (preference_types_1.Preference.TreeNode.is(node)) {
129
- const { collection, id } = this.analyzeIDAndGetRendererGroup(node.id);
130
- const renderer = (_a = collection.get(id)) !== null && _a !== void 0 ? _a : this.rendererFactory(node);
131
- if (!renderer.node.parentElement) { // If it hasn't been attached yet, it hasn't been checked for the current search.
132
- this.hideIfFailsFilters(renderer, isFiltered);
133
- collection.set(id, renderer);
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(renderer, node) {
160
- return !deepEqual(renderer.schema, node.preference.data);
161
- }
162
- handleSearchChange(isFiltered, leavesAreVisible) {
163
- var _a;
164
- if (leavesAreVisible) {
165
- for (const [, renderer] of this.allRenderers()) {
166
- const isHidden = this.hideIfFailsFilters(renderer, isFiltered);
167
- if (!isHidden) {
168
- (_a = renderer.handleSearchChange) === null || _a === void 0 ? void 0 : _a.call(renderer, isFiltered);
169
- }
170
- }
171
- }
172
- }
173
- areLeavesVisible() {
174
- const leavesAreVisible = this.model.totalVisibleLeaves > 0;
175
- this.node.classList.toggle('no-results', !leavesAreVisible);
176
- this.scrollContainer.classList.toggle('hidden', !leavesAreVisible);
177
- return leavesAreVisible;
178
- }
179
- *allRenderers() {
180
- for (const [id, renderer] of this.commonlyUsedRenderers.entries()) {
181
- yield [id, renderer, this.commonlyUsedRenderers];
182
- }
183
- for (const [id, renderer] of this.renderers.entries()) {
184
- yield [id, renderer, this.renderers];
185
- }
186
- }
187
- handlePreferenceChanges(e) {
188
- var _a, _b, _c, _d;
189
- for (const id of Object.keys(e)) {
190
- (_b = (_a = this.commonlyUsedRenderers.get(id)) === null || _a === void 0 ? void 0 : _a.handleValueChange) === null || _b === void 0 ? void 0 : _b.call(_a);
191
- (_d = (_c = this.renderers.get(id)) === null || _c === void 0 ? void 0 : _c.handleValueChange) === null || _d === void 0 ? void 0 : _d.call(_c);
192
- }
193
- }
194
- /**
195
- * @returns true if the renderer is hidden, false otherwise.
196
- */
197
- hideIfFailsFilters(renderer, isFiltered) {
198
- const row = this.model.currentRows.get(renderer.nodeId);
199
- if (!row || (browser_1.CompositeTreeNode.is(row.node) && (isFiltered || row.visibleChildren === 0))) {
200
- renderer.hide();
201
- return true;
202
- }
203
- else {
204
- renderer.show();
205
- return false;
206
- }
207
- }
208
- resetScroll(nodeIDToScrollTo, filterWasCleared = false) {
209
- if (this.scrollBar) { // Absent on widget creation
210
- this.doResetScroll(nodeIDToScrollTo, filterWasCleared);
211
- }
212
- else {
213
- const interval = setInterval(() => {
214
- if (this.scrollBar) {
215
- clearInterval(interval);
216
- this.doResetScroll(nodeIDToScrollTo, filterWasCleared);
217
- }
218
- }, 500);
219
- }
220
- }
221
- doResetScroll(nodeIDToScrollTo, filterWasCleared = false) {
222
- requestAnimationFrame(() => {
223
- var _a;
224
- (_a = this.scrollBar) === null || _a === void 0 ? void 0 : _a.update();
225
- if (!filterWasCleared && nodeIDToScrollTo) {
226
- const { id, collection } = this.analyzeIDAndGetRendererGroup(nodeIDToScrollTo);
227
- const renderer = collection.get(id);
228
- if (renderer === null || renderer === void 0 ? void 0 : renderer.visible) {
229
- renderer.node.scrollIntoView();
230
- return;
231
- }
232
- }
233
- this.scrollContainer.scrollTop = 0;
234
- });
235
- }
236
- ;
237
- doOnScroll() {
238
- const { scrollContainer } = this;
239
- const firstVisibleChildID = this.findFirstVisibleChildID();
240
- this.setFirstVisibleChildID(firstVisibleChildID);
241
- if (this.isAtScrollTop && scrollContainer.scrollTop !== 0) {
242
- this.isAtScrollTop = false;
243
- this.tabbar.toggleShadow(true);
244
- }
245
- else if (!this.isAtScrollTop && scrollContainer.scrollTop === 0) {
246
- this.isAtScrollTop = true;
247
- this.tabbar.toggleShadow(false);
248
- }
249
- }
250
- ;
251
- findFirstVisibleChildID() {
252
- const { scrollTop } = this.scrollContainer;
253
- for (const [, renderer] of this.allRenderers()) {
254
- const { offsetTop, offsetHeight } = renderer.node;
255
- if (Math.abs(offsetTop - scrollTop) <= offsetHeight / 2) {
256
- return renderer.nodeId;
257
- }
258
- }
259
- }
260
- setFirstVisibleChildID(id) {
261
- if (id && id !== this.firstVisibleChildID) {
262
- this.firstVisibleChildID = id;
263
- let currentNode = this.model.getNode(id);
264
- let expansionAncestor;
265
- let selectionAncestor;
266
- while (currentNode && (!expansionAncestor || !selectionAncestor)) {
267
- if (!selectionAncestor && browser_1.SelectableTreeNode.is(currentNode)) {
268
- selectionAncestor = currentNode;
269
- }
270
- if (!expansionAncestor && browser_1.ExpandableTreeNode.is(currentNode)) {
271
- expansionAncestor = currentNode;
272
- }
273
- currentNode = currentNode.parent;
274
- }
275
- if (selectionAncestor) {
276
- this.currentModelSelectionId = selectionAncestor.id;
277
- expansionAncestor = expansionAncestor !== null && expansionAncestor !== void 0 ? expansionAncestor : selectionAncestor;
278
- this.model.selectIfNotSelected(selectionAncestor);
279
- if (!this.model.isFiltered && id !== this.lastUserSelection) {
280
- this.lastUserSelection = '';
281
- this.model.collapseAllExcept(expansionAncestor);
282
- }
283
- }
284
- }
285
- }
286
- handleSelectionChange(selectionEvent) {
287
- const node = selectionEvent[0];
288
- if (node && node.id !== this.currentModelSelectionId) {
289
- this.currentModelSelectionId = node.id;
290
- this.lastUserSelection = node.id;
291
- if (this.model.isFiltered && browser_1.CompositeTreeNode.is(node)) {
292
- for (const candidate of new browser_1.TopDownTreeIterator(node, { pruneSiblings: true })) {
293
- const { id, collection } = this.analyzeIDAndGetRendererGroup(candidate.id);
294
- const renderer = collection.get(id);
295
- if (renderer === null || renderer === void 0 ? void 0 : renderer.visible) {
296
- // When filtered, treat the first visible child as the selected node, since it will be the one scrolled to.
297
- this.lastUserSelection = renderer.nodeId;
298
- renderer.node.scrollIntoView();
299
- return;
300
- }
301
- }
302
- }
303
- else {
304
- const { id, collection } = this.analyzeIDAndGetRendererGroup(node.id);
305
- const renderer = collection.get(id);
306
- renderer === null || renderer === void 0 ? void 0 : renderer.node.scrollIntoView();
307
- }
308
- }
309
- }
310
- analyzeIDAndGetRendererGroup(nodeID) {
311
- const { id, group } = preference_types_1.Preference.TreeNode.getGroupAndIdFromNodeId(nodeID);
312
- const collection = group === preference_tree_generator_1.COMMONLY_USED_SECTION_PREFIX ? this.commonlyUsedRenderers : this.renderers;
313
- return { id, group, collection };
314
- }
315
- getScrollContainer() {
316
- return this.scrollContainer;
317
- }
318
- storeState() {
319
- return {
320
- firstVisibleChildID: this.firstVisibleChildID,
321
- };
322
- }
323
- restoreState(oldState) {
324
- this.firstVisibleChildID = oldState.firstVisibleChildID;
325
- this.resetScroll(this.firstVisibleChildID);
326
- }
327
- };
328
- PreferencesEditorWidget.ID = 'settings.editor';
329
- PreferencesEditorWidget.LABEL = 'Settings Editor';
330
- __decorate([
331
- (0, inversify_1.inject)(browser_1.PreferenceService),
332
- __metadata("design:type", Object)
333
- ], PreferencesEditorWidget.prototype, "preferenceService", void 0);
334
- __decorate([
335
- (0, inversify_1.inject)(preference_tree_model_1.PreferenceTreeModel),
336
- __metadata("design:type", preference_tree_model_1.PreferenceTreeModel)
337
- ], PreferencesEditorWidget.prototype, "model", void 0);
338
- __decorate([
339
- (0, inversify_1.inject)(preference_node_renderer_1.PreferenceNodeRendererFactory),
340
- __metadata("design:type", Function)
341
- ], PreferencesEditorWidget.prototype, "rendererFactory", void 0);
342
- __decorate([
343
- (0, inversify_1.inject)(preference_node_renderer_creator_1.PreferenceNodeRendererCreatorRegistry),
344
- __metadata("design:type", Object)
345
- ], PreferencesEditorWidget.prototype, "rendererRegistry", void 0);
346
- __decorate([
347
- (0, inversify_1.inject)(browser_1.PreferenceSchemaProvider),
348
- __metadata("design:type", browser_1.PreferenceSchemaProvider)
349
- ], PreferencesEditorWidget.prototype, "schemaProvider", void 0);
350
- __decorate([
351
- (0, inversify_1.inject)(preference_scope_tabbar_widget_1.PreferencesScopeTabBar),
352
- __metadata("design:type", preference_scope_tabbar_widget_1.PreferencesScopeTabBar)
353
- ], PreferencesEditorWidget.prototype, "tabbar", void 0);
354
- __decorate([
355
- (0, inversify_1.postConstruct)(),
356
- __metadata("design:type", Function),
357
- __metadata("design:paramtypes", []),
358
- __metadata("design:returntype", void 0)
359
- ], PreferencesEditorWidget.prototype, "init", null);
360
- PreferencesEditorWidget = PreferencesEditorWidget_1 = __decorate([
361
- (0, inversify_1.injectable)()
362
- ], PreferencesEditorWidget);
363
- 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-only 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 deepEqual = require("fast-deep-equal");
33
+ const browser_1 = require("@theia/core/lib/browser");
34
+ const common_1 = require("@theia/core/lib/common");
35
+ const widget_1 = require("@theia/core/lib/browser/widgets/widget");
36
+ const preference_tree_model_1 = require("../preference-tree-model");
37
+ const preference_node_renderer_1 = require("./components/preference-node-renderer");
38
+ const preference_types_1 = require("../util/preference-types");
39
+ const preference_tree_generator_1 = require("../util/preference-tree-generator");
40
+ const preference_scope_tabbar_widget_1 = require("./preference-scope-tabbar-widget");
41
+ const preference_node_renderer_creator_1 = require("./components/preference-node-renderer-creator");
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
+ init() {
63
+ this.doInit();
64
+ }
65
+ async doInit() {
66
+ this.id = PreferencesEditorWidget_1.ID;
67
+ this.title.label = PreferencesEditorWidget_1.LABEL;
68
+ this.addClass('settings-main');
69
+ this.toDispose.pushAll([
70
+ this.preferenceService.onPreferencesChanged(e => this.handlePreferenceChanges(e)),
71
+ this.model.onFilterChanged(e => this.handleDisplayChange(e)),
72
+ this.model.onSelectionChanged(e => this.handleSelectionChange(e)),
73
+ ]);
74
+ this.createContainers();
75
+ await this.preferenceService.ready;
76
+ this.handleDisplayChange({ source: preference_tree_model_1.PreferenceFilterChangeSource.Schema });
77
+ this.rendererRegistry.onDidChange(() => this.handleRegistryChange());
78
+ }
79
+ createContainers() {
80
+ const innerWrapper = document.createElement('div');
81
+ innerWrapper.classList.add('settings-main-scroll-container');
82
+ this.scrollContainer = innerWrapper;
83
+ innerWrapper.addEventListener('scroll', this.onScroll, { passive: true });
84
+ this.node.appendChild(innerWrapper);
85
+ const noLeavesMessage = document.createElement('div');
86
+ noLeavesMessage.classList.add('settings-no-results-announcement');
87
+ noLeavesMessage.textContent = 'That search query has returned no results.';
88
+ this.node.appendChild(noLeavesMessage);
89
+ }
90
+ handleDisplayChange(e) {
91
+ const { isFiltered } = this.model;
92
+ const currentFirstVisible = this.firstVisibleChildID;
93
+ const leavesAreVisible = this.areLeavesVisible();
94
+ if (e.source === preference_tree_model_1.PreferenceFilterChangeSource.Search) {
95
+ this.handleSearchChange(isFiltered, leavesAreVisible);
96
+ }
97
+ else if (e.source === preference_tree_model_1.PreferenceFilterChangeSource.Scope) {
98
+ this.handleScopeChange(isFiltered);
99
+ }
100
+ else if (e.source === preference_tree_model_1.PreferenceFilterChangeSource.Schema) {
101
+ this.handleSchemaChange(isFiltered);
102
+ }
103
+ else {
104
+ (0, common_1.unreachable)(e.source, 'Not all PreferenceFilterChangeSource enum variants handled.');
105
+ }
106
+ this.resetScroll(currentFirstVisible, e.source === preference_tree_model_1.PreferenceFilterChangeSource.Search && !isFiltered);
107
+ }
108
+ handleRegistryChange() {
109
+ for (const [id, renderer, collection] of this.allRenderers()) {
110
+ renderer.dispose();
111
+ collection.delete(id);
112
+ }
113
+ this.handleDisplayChange({ source: preference_tree_model_1.PreferenceFilterChangeSource.Schema });
114
+ }
115
+ handleSchemaChange(isFiltered) {
116
+ var _a;
117
+ for (const [id, renderer, collection] of this.allRenderers()) {
118
+ const node = this.model.getNode(renderer.nodeId);
119
+ if (!node || (preference_types_1.Preference.LeafNode.is(node) && this.hasSchemaChanged(renderer, node))) {
120
+ renderer.dispose();
121
+ collection.delete(id);
122
+ }
123
+ }
124
+ if (this.model.root) {
125
+ const nodeIterator = Array.from(this.scrollContainer.children)[Symbol.iterator]();
126
+ let nextNode = nodeIterator.next().value;
127
+ for (const node of new browser_1.TopDownTreeIterator(this.model.root)) {
128
+ if (preference_types_1.Preference.TreeNode.is(node)) {
129
+ const { collection, id } = this.analyzeIDAndGetRendererGroup(node.id);
130
+ const renderer = (_a = collection.get(id)) !== null && _a !== void 0 ? _a : this.rendererFactory(node);
131
+ if (!renderer.node.parentElement) { // If it hasn't been attached yet, it hasn't been checked for the current search.
132
+ this.hideIfFailsFilters(renderer, isFiltered);
133
+ collection.set(id, renderer);
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(renderer, node) {
160
+ return !deepEqual(renderer.schema, node.preference.data);
161
+ }
162
+ handleSearchChange(isFiltered, leavesAreVisible) {
163
+ var _a;
164
+ if (leavesAreVisible) {
165
+ for (const [, renderer] of this.allRenderers()) {
166
+ const isHidden = this.hideIfFailsFilters(renderer, isFiltered);
167
+ if (!isHidden) {
168
+ (_a = renderer.handleSearchChange) === null || _a === void 0 ? void 0 : _a.call(renderer, isFiltered);
169
+ }
170
+ }
171
+ }
172
+ }
173
+ areLeavesVisible() {
174
+ const leavesAreVisible = this.model.totalVisibleLeaves > 0;
175
+ this.node.classList.toggle('no-results', !leavesAreVisible);
176
+ this.scrollContainer.classList.toggle('hidden', !leavesAreVisible);
177
+ return leavesAreVisible;
178
+ }
179
+ *allRenderers() {
180
+ for (const [id, renderer] of this.commonlyUsedRenderers.entries()) {
181
+ yield [id, renderer, this.commonlyUsedRenderers];
182
+ }
183
+ for (const [id, renderer] of this.renderers.entries()) {
184
+ yield [id, renderer, this.renderers];
185
+ }
186
+ }
187
+ handlePreferenceChanges(e) {
188
+ var _a, _b, _c, _d;
189
+ for (const id of Object.keys(e)) {
190
+ (_b = (_a = this.commonlyUsedRenderers.get(id)) === null || _a === void 0 ? void 0 : _a.handleValueChange) === null || _b === void 0 ? void 0 : _b.call(_a);
191
+ (_d = (_c = this.renderers.get(id)) === null || _c === void 0 ? void 0 : _c.handleValueChange) === null || _d === void 0 ? void 0 : _d.call(_c);
192
+ }
193
+ }
194
+ /**
195
+ * @returns true if the renderer is hidden, false otherwise.
196
+ */
197
+ hideIfFailsFilters(renderer, isFiltered) {
198
+ const row = this.model.currentRows.get(renderer.nodeId);
199
+ if (!row || (browser_1.CompositeTreeNode.is(row.node) && (isFiltered || row.visibleChildren === 0))) {
200
+ renderer.hide();
201
+ return true;
202
+ }
203
+ else {
204
+ renderer.show();
205
+ return false;
206
+ }
207
+ }
208
+ resetScroll(nodeIDToScrollTo, filterWasCleared = false) {
209
+ if (this.scrollBar) { // Absent on widget creation
210
+ this.doResetScroll(nodeIDToScrollTo, filterWasCleared);
211
+ }
212
+ else {
213
+ const interval = setInterval(() => {
214
+ if (this.scrollBar) {
215
+ clearInterval(interval);
216
+ this.doResetScroll(nodeIDToScrollTo, filterWasCleared);
217
+ }
218
+ }, 500);
219
+ }
220
+ }
221
+ doResetScroll(nodeIDToScrollTo, filterWasCleared = false) {
222
+ requestAnimationFrame(() => {
223
+ var _a;
224
+ (_a = this.scrollBar) === null || _a === void 0 ? void 0 : _a.update();
225
+ if (!filterWasCleared && nodeIDToScrollTo) {
226
+ const { id, collection } = this.analyzeIDAndGetRendererGroup(nodeIDToScrollTo);
227
+ const renderer = collection.get(id);
228
+ if (renderer === null || renderer === void 0 ? void 0 : renderer.visible) {
229
+ renderer.node.scrollIntoView();
230
+ return;
231
+ }
232
+ }
233
+ this.scrollContainer.scrollTop = 0;
234
+ });
235
+ }
236
+ ;
237
+ doOnScroll() {
238
+ const { scrollContainer } = this;
239
+ const firstVisibleChildID = this.findFirstVisibleChildID();
240
+ this.setFirstVisibleChildID(firstVisibleChildID);
241
+ if (this.isAtScrollTop && scrollContainer.scrollTop !== 0) {
242
+ this.isAtScrollTop = false;
243
+ this.tabbar.toggleShadow(true);
244
+ }
245
+ else if (!this.isAtScrollTop && scrollContainer.scrollTop === 0) {
246
+ this.isAtScrollTop = true;
247
+ this.tabbar.toggleShadow(false);
248
+ }
249
+ }
250
+ ;
251
+ findFirstVisibleChildID() {
252
+ const { scrollTop } = this.scrollContainer;
253
+ for (const [, renderer] of this.allRenderers()) {
254
+ const { offsetTop, offsetHeight } = renderer.node;
255
+ if (Math.abs(offsetTop - scrollTop) <= offsetHeight / 2) {
256
+ return renderer.nodeId;
257
+ }
258
+ }
259
+ }
260
+ setFirstVisibleChildID(id) {
261
+ if (id && id !== this.firstVisibleChildID) {
262
+ this.firstVisibleChildID = id;
263
+ let currentNode = this.model.getNode(id);
264
+ let expansionAncestor;
265
+ let selectionAncestor;
266
+ while (currentNode && (!expansionAncestor || !selectionAncestor)) {
267
+ if (!selectionAncestor && browser_1.SelectableTreeNode.is(currentNode)) {
268
+ selectionAncestor = currentNode;
269
+ }
270
+ if (!expansionAncestor && browser_1.ExpandableTreeNode.is(currentNode)) {
271
+ expansionAncestor = currentNode;
272
+ }
273
+ currentNode = currentNode.parent;
274
+ }
275
+ if (selectionAncestor) {
276
+ this.currentModelSelectionId = selectionAncestor.id;
277
+ expansionAncestor = expansionAncestor !== null && expansionAncestor !== void 0 ? expansionAncestor : selectionAncestor;
278
+ this.model.selectIfNotSelected(selectionAncestor);
279
+ if (!this.model.isFiltered && id !== this.lastUserSelection) {
280
+ this.lastUserSelection = '';
281
+ this.model.collapseAllExcept(expansionAncestor);
282
+ }
283
+ }
284
+ }
285
+ }
286
+ handleSelectionChange(selectionEvent) {
287
+ const node = selectionEvent[0];
288
+ if (node && node.id !== this.currentModelSelectionId) {
289
+ this.currentModelSelectionId = node.id;
290
+ this.lastUserSelection = node.id;
291
+ if (this.model.isFiltered && browser_1.CompositeTreeNode.is(node)) {
292
+ for (const candidate of new browser_1.TopDownTreeIterator(node, { pruneSiblings: true })) {
293
+ const { id, collection } = this.analyzeIDAndGetRendererGroup(candidate.id);
294
+ const renderer = collection.get(id);
295
+ if (renderer === null || renderer === void 0 ? void 0 : renderer.visible) {
296
+ // When filtered, treat the first visible child as the selected node, since it will be the one scrolled to.
297
+ this.lastUserSelection = renderer.nodeId;
298
+ renderer.node.scrollIntoView();
299
+ return;
300
+ }
301
+ }
302
+ }
303
+ else {
304
+ const { id, collection } = this.analyzeIDAndGetRendererGroup(node.id);
305
+ const renderer = collection.get(id);
306
+ renderer === null || renderer === void 0 ? void 0 : renderer.node.scrollIntoView();
307
+ }
308
+ }
309
+ }
310
+ analyzeIDAndGetRendererGroup(nodeID) {
311
+ const { id, group } = preference_types_1.Preference.TreeNode.getGroupAndIdFromNodeId(nodeID);
312
+ const collection = group === preference_tree_generator_1.COMMONLY_USED_SECTION_PREFIX ? this.commonlyUsedRenderers : this.renderers;
313
+ return { id, group, collection };
314
+ }
315
+ getScrollContainer() {
316
+ return this.scrollContainer;
317
+ }
318
+ storeState() {
319
+ return {
320
+ firstVisibleChildID: this.firstVisibleChildID,
321
+ };
322
+ }
323
+ restoreState(oldState) {
324
+ this.firstVisibleChildID = oldState.firstVisibleChildID;
325
+ this.resetScroll(this.firstVisibleChildID);
326
+ }
327
+ };
328
+ PreferencesEditorWidget.ID = 'settings.editor';
329
+ PreferencesEditorWidget.LABEL = 'Settings Editor';
330
+ __decorate([
331
+ (0, inversify_1.inject)(browser_1.PreferenceService),
332
+ __metadata("design:type", Object)
333
+ ], PreferencesEditorWidget.prototype, "preferenceService", void 0);
334
+ __decorate([
335
+ (0, inversify_1.inject)(preference_tree_model_1.PreferenceTreeModel),
336
+ __metadata("design:type", preference_tree_model_1.PreferenceTreeModel)
337
+ ], PreferencesEditorWidget.prototype, "model", void 0);
338
+ __decorate([
339
+ (0, inversify_1.inject)(preference_node_renderer_1.PreferenceNodeRendererFactory),
340
+ __metadata("design:type", Function)
341
+ ], PreferencesEditorWidget.prototype, "rendererFactory", void 0);
342
+ __decorate([
343
+ (0, inversify_1.inject)(preference_node_renderer_creator_1.PreferenceNodeRendererCreatorRegistry),
344
+ __metadata("design:type", Object)
345
+ ], PreferencesEditorWidget.prototype, "rendererRegistry", void 0);
346
+ __decorate([
347
+ (0, inversify_1.inject)(browser_1.PreferenceSchemaProvider),
348
+ __metadata("design:type", browser_1.PreferenceSchemaProvider)
349
+ ], PreferencesEditorWidget.prototype, "schemaProvider", void 0);
350
+ __decorate([
351
+ (0, inversify_1.inject)(preference_scope_tabbar_widget_1.PreferencesScopeTabBar),
352
+ __metadata("design:type", preference_scope_tabbar_widget_1.PreferencesScopeTabBar)
353
+ ], PreferencesEditorWidget.prototype, "tabbar", void 0);
354
+ __decorate([
355
+ (0, inversify_1.postConstruct)(),
356
+ __metadata("design:type", Function),
357
+ __metadata("design:paramtypes", []),
358
+ __metadata("design:returntype", void 0)
359
+ ], PreferencesEditorWidget.prototype, "init", null);
360
+ PreferencesEditorWidget = PreferencesEditorWidget_1 = __decorate([
361
+ (0, inversify_1.injectable)()
362
+ ], PreferencesEditorWidget);
363
+ exports.PreferencesEditorWidget = PreferencesEditorWidget;
364
364
  //# sourceMappingURL=preference-editor-widget.js.map