@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,133 +1,133 @@
1
- "use strict";
2
- // *****************************************************************************
3
- // Copyright (C) 2022 EclipseSource 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 __param = (this && this.__param) || function (paramIndex, decorator) {
27
- return function (target, key) { decorator(target, key, paramIndex); }
28
- };
29
- var PreferenceHeaderRendererContribution_1;
30
- Object.defineProperty(exports, "__esModule", { value: true });
31
- exports.PreferenceHeaderRendererContribution = exports.PreferenceLeafNodeRendererContribution = exports.DefaultPreferenceNodeRendererCreatorRegistry = exports.PreferenceNodeRendererCreator = exports.PreferenceNodeRendererContribution = exports.PreferenceNodeRendererCreatorRegistry = void 0;
32
- const core_1 = require("@theia/core");
33
- const inversify_1 = require("@theia/core/shared/inversify");
34
- const preference_types_1 = require("../../util/preference-types");
35
- const preference_node_renderer_1 = require("./preference-node-renderer");
36
- exports.PreferenceNodeRendererCreatorRegistry = Symbol('PreferenceNodeRendererCreatorRegistry');
37
- exports.PreferenceNodeRendererContribution = Symbol('PreferenceNodeRendererContribution');
38
- exports.PreferenceNodeRendererCreator = Symbol('PreferenceNodeRendererCreator');
39
- let DefaultPreferenceNodeRendererCreatorRegistry = class DefaultPreferenceNodeRendererCreatorRegistry {
40
- constructor(contributionProvider) {
41
- this.contributionProvider = contributionProvider;
42
- this._creators = new Map();
43
- this.onDidChangeEmitter = new core_1.Emitter();
44
- this.onDidChange = this.onDidChangeEmitter.event;
45
- const contributions = this.contributionProvider.getContributions();
46
- for (const contrib of contributions) {
47
- contrib.registerPreferenceNodeRendererCreator(this);
48
- }
49
- }
50
- registerPreferenceNodeRendererCreator(creator) {
51
- if (this._creators.has(creator.id)) {
52
- console.warn(`A preference node renderer creator ${creator.id} is already registered.`);
53
- return core_1.Disposable.NULL;
54
- }
55
- this._creators.set(creator.id, creator);
56
- this.fireDidChange();
57
- return core_1.Disposable.create(() => this._creators.delete(creator.id));
58
- }
59
- unregisterPreferenceNodeRendererCreator(creator) {
60
- const id = typeof creator === 'string' ? creator : creator.id;
61
- if (this._creators.delete(id)) {
62
- this.fireDidChange();
63
- }
64
- }
65
- getPreferenceNodeRendererCreator(node) {
66
- const contributions = this.prioritize(node);
67
- if (contributions.length >= 1) {
68
- return contributions[0];
69
- }
70
- // we already bind a default creator contribution so if that happens it was deliberate
71
- throw new Error(`There is no contribution for ${node.id}.`);
72
- }
73
- fireDidChange() {
74
- this.onDidChangeEmitter.fire(undefined);
75
- }
76
- prioritize(node) {
77
- const prioritized = core_1.Prioritizeable.prioritizeAllSync(Array.from(this._creators.values()), creator => {
78
- try {
79
- return creator.canHandle(node);
80
- }
81
- catch (_a) {
82
- return 0;
83
- }
84
- });
85
- return prioritized.map(p => p.value);
86
- }
87
- };
88
- DefaultPreferenceNodeRendererCreatorRegistry = __decorate([
89
- (0, inversify_1.injectable)(),
90
- __param(0, (0, inversify_1.inject)(core_1.ContributionProvider)),
91
- __param(0, (0, inversify_1.named)(exports.PreferenceNodeRendererContribution)),
92
- __metadata("design:paramtypes", [Object])
93
- ], DefaultPreferenceNodeRendererCreatorRegistry);
94
- exports.DefaultPreferenceNodeRendererCreatorRegistry = DefaultPreferenceNodeRendererCreatorRegistry;
95
- let PreferenceLeafNodeRendererContribution = class PreferenceLeafNodeRendererContribution {
96
- canHandle(node) {
97
- return preference_types_1.Preference.LeafNode.is(node) ? this.canHandleLeafNode(node) : 0;
98
- }
99
- registerPreferenceNodeRendererCreator(registry) {
100
- registry.registerPreferenceNodeRendererCreator(this);
101
- }
102
- createRenderer(node, container) {
103
- const child = container.createChild();
104
- child.bind(preference_types_1.Preference.Node).toConstantValue(node);
105
- return this.createLeafNodeRenderer(child);
106
- }
107
- };
108
- PreferenceLeafNodeRendererContribution = __decorate([
109
- (0, inversify_1.injectable)()
110
- ], PreferenceLeafNodeRendererContribution);
111
- exports.PreferenceLeafNodeRendererContribution = PreferenceLeafNodeRendererContribution;
112
- let PreferenceHeaderRendererContribution = PreferenceHeaderRendererContribution_1 = class PreferenceHeaderRendererContribution {
113
- constructor() {
114
- this.id = PreferenceHeaderRendererContribution_1.ID;
115
- }
116
- registerPreferenceNodeRendererCreator(registry) {
117
- registry.registerPreferenceNodeRendererCreator(this);
118
- }
119
- canHandle(node) {
120
- return !preference_types_1.Preference.LeafNode.is(node) ? 1 : 0;
121
- }
122
- createRenderer(node, container) {
123
- const grandchild = container.createChild();
124
- grandchild.bind(preference_types_1.Preference.Node).toConstantValue(node);
125
- return grandchild.get(preference_node_renderer_1.PreferenceHeaderRenderer);
126
- }
127
- };
128
- PreferenceHeaderRendererContribution.ID = 'preference-header-renderer';
129
- PreferenceHeaderRendererContribution = PreferenceHeaderRendererContribution_1 = __decorate([
130
- (0, inversify_1.injectable)()
131
- ], PreferenceHeaderRendererContribution);
132
- exports.PreferenceHeaderRendererContribution = PreferenceHeaderRendererContribution;
1
+ "use strict";
2
+ // *****************************************************************************
3
+ // Copyright (C) 2022 EclipseSource 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 __param = (this && this.__param) || function (paramIndex, decorator) {
27
+ return function (target, key) { decorator(target, key, paramIndex); }
28
+ };
29
+ var PreferenceHeaderRendererContribution_1;
30
+ Object.defineProperty(exports, "__esModule", { value: true });
31
+ exports.PreferenceHeaderRendererContribution = exports.PreferenceLeafNodeRendererContribution = exports.DefaultPreferenceNodeRendererCreatorRegistry = exports.PreferenceNodeRendererCreator = exports.PreferenceNodeRendererContribution = exports.PreferenceNodeRendererCreatorRegistry = void 0;
32
+ const core_1 = require("@theia/core");
33
+ const inversify_1 = require("@theia/core/shared/inversify");
34
+ const preference_types_1 = require("../../util/preference-types");
35
+ const preference_node_renderer_1 = require("./preference-node-renderer");
36
+ exports.PreferenceNodeRendererCreatorRegistry = Symbol('PreferenceNodeRendererCreatorRegistry');
37
+ exports.PreferenceNodeRendererContribution = Symbol('PreferenceNodeRendererContribution');
38
+ exports.PreferenceNodeRendererCreator = Symbol('PreferenceNodeRendererCreator');
39
+ let DefaultPreferenceNodeRendererCreatorRegistry = class DefaultPreferenceNodeRendererCreatorRegistry {
40
+ constructor(contributionProvider) {
41
+ this.contributionProvider = contributionProvider;
42
+ this._creators = new Map();
43
+ this.onDidChangeEmitter = new core_1.Emitter();
44
+ this.onDidChange = this.onDidChangeEmitter.event;
45
+ const contributions = this.contributionProvider.getContributions();
46
+ for (const contrib of contributions) {
47
+ contrib.registerPreferenceNodeRendererCreator(this);
48
+ }
49
+ }
50
+ registerPreferenceNodeRendererCreator(creator) {
51
+ if (this._creators.has(creator.id)) {
52
+ console.warn(`A preference node renderer creator ${creator.id} is already registered.`);
53
+ return core_1.Disposable.NULL;
54
+ }
55
+ this._creators.set(creator.id, creator);
56
+ this.fireDidChange();
57
+ return core_1.Disposable.create(() => this._creators.delete(creator.id));
58
+ }
59
+ unregisterPreferenceNodeRendererCreator(creator) {
60
+ const id = typeof creator === 'string' ? creator : creator.id;
61
+ if (this._creators.delete(id)) {
62
+ this.fireDidChange();
63
+ }
64
+ }
65
+ getPreferenceNodeRendererCreator(node) {
66
+ const contributions = this.prioritize(node);
67
+ if (contributions.length >= 1) {
68
+ return contributions[0];
69
+ }
70
+ // we already bind a default creator contribution so if that happens it was deliberate
71
+ throw new Error(`There is no contribution for ${node.id}.`);
72
+ }
73
+ fireDidChange() {
74
+ this.onDidChangeEmitter.fire(undefined);
75
+ }
76
+ prioritize(node) {
77
+ const prioritized = core_1.Prioritizeable.prioritizeAllSync(Array.from(this._creators.values()), creator => {
78
+ try {
79
+ return creator.canHandle(node);
80
+ }
81
+ catch (_a) {
82
+ return 0;
83
+ }
84
+ });
85
+ return prioritized.map(p => p.value);
86
+ }
87
+ };
88
+ DefaultPreferenceNodeRendererCreatorRegistry = __decorate([
89
+ (0, inversify_1.injectable)(),
90
+ __param(0, (0, inversify_1.inject)(core_1.ContributionProvider)),
91
+ __param(0, (0, inversify_1.named)(exports.PreferenceNodeRendererContribution)),
92
+ __metadata("design:paramtypes", [Object])
93
+ ], DefaultPreferenceNodeRendererCreatorRegistry);
94
+ exports.DefaultPreferenceNodeRendererCreatorRegistry = DefaultPreferenceNodeRendererCreatorRegistry;
95
+ let PreferenceLeafNodeRendererContribution = class PreferenceLeafNodeRendererContribution {
96
+ canHandle(node) {
97
+ return preference_types_1.Preference.LeafNode.is(node) ? this.canHandleLeafNode(node) : 0;
98
+ }
99
+ registerPreferenceNodeRendererCreator(registry) {
100
+ registry.registerPreferenceNodeRendererCreator(this);
101
+ }
102
+ createRenderer(node, container) {
103
+ const child = container.createChild();
104
+ child.bind(preference_types_1.Preference.Node).toConstantValue(node);
105
+ return this.createLeafNodeRenderer(child);
106
+ }
107
+ };
108
+ PreferenceLeafNodeRendererContribution = __decorate([
109
+ (0, inversify_1.injectable)()
110
+ ], PreferenceLeafNodeRendererContribution);
111
+ exports.PreferenceLeafNodeRendererContribution = PreferenceLeafNodeRendererContribution;
112
+ let PreferenceHeaderRendererContribution = PreferenceHeaderRendererContribution_1 = class PreferenceHeaderRendererContribution {
113
+ constructor() {
114
+ this.id = PreferenceHeaderRendererContribution_1.ID;
115
+ }
116
+ registerPreferenceNodeRendererCreator(registry) {
117
+ registry.registerPreferenceNodeRendererCreator(this);
118
+ }
119
+ canHandle(node) {
120
+ return !preference_types_1.Preference.LeafNode.is(node) ? 1 : 0;
121
+ }
122
+ createRenderer(node, container) {
123
+ const grandchild = container.createChild();
124
+ grandchild.bind(preference_types_1.Preference.Node).toConstantValue(node);
125
+ return grandchild.get(preference_node_renderer_1.PreferenceHeaderRenderer);
126
+ }
127
+ };
128
+ PreferenceHeaderRendererContribution.ID = 'preference-header-renderer';
129
+ PreferenceHeaderRendererContribution = PreferenceHeaderRendererContribution_1 = __decorate([
130
+ (0, inversify_1.injectable)()
131
+ ], PreferenceHeaderRendererContribution);
132
+ exports.PreferenceHeaderRendererContribution = PreferenceHeaderRendererContribution;
133
133
  //# sourceMappingURL=preference-node-renderer-creator.js.map
@@ -1,112 +1,112 @@
1
- /// <reference types="lodash" />
2
- import { PreferenceService, ContextMenuRenderer, PreferenceInspection, PreferenceScope, OpenerService } from '@theia/core/lib/browser';
3
- import { Preference } from '../../util/preference-types';
4
- import { PreferenceTreeLabelProvider } from '../../util/preference-tree-label-provider';
5
- import { PreferencesScopeTabBar } from '../preference-scope-tabbar-widget';
6
- import { Disposable } from '@theia/core/lib/common';
7
- import { JSONValue } from '@theia/core/shared/@phosphor/coreutils';
8
- import { PreferenceTreeModel } from '../../preference-tree-model';
9
- import { PreferencesSearchbarWidget } from '../preference-searchbar-widget';
10
- import * as markdownit from '@theia/core/shared/markdown-it';
11
- export declare const PreferenceNodeRendererFactory: unique symbol;
12
- export declare type PreferenceNodeRendererFactory = (node: Preference.TreeNode) => PreferenceNodeRenderer;
13
- export declare const HEADER_CLASS = "settings-section-category-title";
14
- export declare const SUBHEADER_CLASS = "settings-section-subcategory-title";
15
- export interface GeneralPreferenceNodeRenderer extends Disposable {
16
- node: HTMLElement;
17
- id: string;
18
- group: string;
19
- nodeId: string;
20
- visible: boolean;
21
- insertBefore(nextSibling: HTMLElement): void;
22
- insertAfter(previousSibling: HTMLElement): void;
23
- appendTo(parent: HTMLElement): void;
24
- prependTo(parent: HTMLElement): void;
25
- handleValueChange?(): void;
26
- handleSearchChange?(isFiltered?: boolean): void;
27
- handleScopeChange?(isFiltered?: boolean): void;
28
- hide(): void;
29
- show(): void;
30
- }
31
- export declare abstract class PreferenceNodeRenderer implements Disposable, GeneralPreferenceNodeRenderer {
32
- protected readonly preferenceNode: Preference.Node;
33
- protected readonly labelProvider: PreferenceTreeLabelProvider;
34
- protected attached: boolean;
35
- _id: string;
36
- _group: string;
37
- _subgroup: string;
38
- protected domNode: HTMLElement;
39
- get node(): HTMLElement;
40
- get nodeId(): string;
41
- get id(): string;
42
- get group(): string;
43
- get visible(): boolean;
44
- protected init(): void;
45
- protected setId(): void;
46
- protected abstract createDomNode(): HTMLElement;
47
- protected getAdditionalNodeClassnames(): Iterable<string>;
48
- insertBefore(nextSibling: HTMLElement): void;
49
- insertAfter(previousSibling: HTMLElement): void;
50
- appendTo(parent: HTMLElement): void;
51
- prependTo(parent: HTMLElement): void;
52
- hide(): void;
53
- show(): void;
54
- dispose(): void;
55
- }
56
- export declare class PreferenceHeaderRenderer extends PreferenceNodeRenderer {
57
- protected createDomNode(): HTMLElement;
58
- }
59
- export declare abstract class PreferenceLeafNodeRenderer<ValueType extends JSONValue, InteractableType extends HTMLElement> extends PreferenceNodeRenderer implements Required<GeneralPreferenceNodeRenderer> {
60
- protected readonly preferenceNode: Preference.LeafNode;
61
- protected readonly preferenceService: PreferenceService;
62
- protected readonly menuRenderer: ContextMenuRenderer;
63
- protected readonly scopeTracker: PreferencesScopeTabBar;
64
- protected readonly model: PreferenceTreeModel;
65
- protected readonly searchbar: PreferencesSearchbarWidget;
66
- protected readonly openerService: OpenerService;
67
- protected headlineWrapper: HTMLDivElement;
68
- protected gutter: HTMLDivElement;
69
- protected interactable: InteractableType;
70
- protected inspection: PreferenceInspection<ValueType> | undefined;
71
- protected isModifiedFromDefault: boolean;
72
- protected markdownRenderer: markdownit;
73
- protected init(): void;
74
- protected updateInspection(): void;
75
- protected buildMarkdownRenderer(): markdownit;
76
- protected openLink(event: MouseEvent): void;
77
- protected createDomNode(): HTMLLIElement;
78
- protected handleCogAction({ currentTarget }: KeyboardEvent | MouseEvent): void;
79
- protected addModifiedMarking(): void;
80
- protected removeModifiedMarking(): void;
81
- protected showCog(): void;
82
- protected hideCog(): void;
83
- protected updateModificationStatus(knownCurrentValue?: JSONValue): void;
84
- protected updateHeadline(filtered?: boolean): void;
85
- protected compareOtherModifiedScopes(headlineWrapper: HTMLDivElement, currentSuffix: HTMLElement): void;
86
- protected createOtherModifiedScopes(headlineWrapper: HTMLDivElement): void;
87
- protected createModifiedScopeMessage(scope: PreferenceScope): HTMLSpanElement;
88
- protected getModifiedMessagePrefix(): string;
89
- protected addEventHandlerToModifiedScope(scope: PreferenceScope, scopeWrapper: HTMLElement): void;
90
- protected getModifiedScopesAsStrings(): PreferenceScope[];
91
- protected getValue(): ValueType | null;
92
- protected setPreferenceWithDebounce: import("lodash").DebouncedFunc<any>;
93
- protected setPreferenceImmediately(value: ValueType | undefined): Promise<void>;
94
- handleSearchChange(isFiltered?: boolean): void;
95
- handleScopeChange(isFiltered?: boolean): void;
96
- handleValueChange(): void;
97
- /**
98
- * Should create an HTML element that the user can interact with to change the value of the preference.
99
- * @param container the parent element for the interactable. This method is responsible for adding the new element to its parent.
100
- */
101
- protected abstract createInteractable(container: HTMLElement): void;
102
- /**
103
- * @returns a fallback default value for a preference of the type implemented by a concrete leaf renderer
104
- * This function is only called if the default value for a given preference is not specified in its schema.
105
- */
106
- protected abstract getFallbackValue(): ValueType;
107
- /**
108
- * This function is responsible for reconciling the display of the preference value with the value reported by the PreferenceService.
109
- */
110
- protected abstract doHandleValueChange(): void;
111
- }
1
+ /// <reference types="lodash" />
2
+ import { PreferenceService, ContextMenuRenderer, PreferenceInspection, PreferenceScope, OpenerService } from '@theia/core/lib/browser';
3
+ import { Preference } from '../../util/preference-types';
4
+ import { PreferenceTreeLabelProvider } from '../../util/preference-tree-label-provider';
5
+ import { PreferencesScopeTabBar } from '../preference-scope-tabbar-widget';
6
+ import { Disposable } from '@theia/core/lib/common';
7
+ import { JSONValue } from '@theia/core/shared/@phosphor/coreutils';
8
+ import { PreferenceTreeModel } from '../../preference-tree-model';
9
+ import { PreferencesSearchbarWidget } from '../preference-searchbar-widget';
10
+ import * as markdownit from '@theia/core/shared/markdown-it';
11
+ export declare const PreferenceNodeRendererFactory: unique symbol;
12
+ export declare type PreferenceNodeRendererFactory = (node: Preference.TreeNode) => PreferenceNodeRenderer;
13
+ export declare const HEADER_CLASS = "settings-section-category-title";
14
+ export declare const SUBHEADER_CLASS = "settings-section-subcategory-title";
15
+ export interface GeneralPreferenceNodeRenderer extends Disposable {
16
+ node: HTMLElement;
17
+ id: string;
18
+ group: string;
19
+ nodeId: string;
20
+ visible: boolean;
21
+ insertBefore(nextSibling: HTMLElement): void;
22
+ insertAfter(previousSibling: HTMLElement): void;
23
+ appendTo(parent: HTMLElement): void;
24
+ prependTo(parent: HTMLElement): void;
25
+ handleValueChange?(): void;
26
+ handleSearchChange?(isFiltered?: boolean): void;
27
+ handleScopeChange?(isFiltered?: boolean): void;
28
+ hide(): void;
29
+ show(): void;
30
+ }
31
+ export declare abstract class PreferenceNodeRenderer implements Disposable, GeneralPreferenceNodeRenderer {
32
+ protected readonly preferenceNode: Preference.Node;
33
+ protected readonly labelProvider: PreferenceTreeLabelProvider;
34
+ protected attached: boolean;
35
+ _id: string;
36
+ _group: string;
37
+ _subgroup: string;
38
+ protected domNode: HTMLElement;
39
+ get node(): HTMLElement;
40
+ get nodeId(): string;
41
+ get id(): string;
42
+ get group(): string;
43
+ get visible(): boolean;
44
+ protected init(): void;
45
+ protected setId(): void;
46
+ protected abstract createDomNode(): HTMLElement;
47
+ protected getAdditionalNodeClassnames(): Iterable<string>;
48
+ insertBefore(nextSibling: HTMLElement): void;
49
+ insertAfter(previousSibling: HTMLElement): void;
50
+ appendTo(parent: HTMLElement): void;
51
+ prependTo(parent: HTMLElement): void;
52
+ hide(): void;
53
+ show(): void;
54
+ dispose(): void;
55
+ }
56
+ export declare class PreferenceHeaderRenderer extends PreferenceNodeRenderer {
57
+ protected createDomNode(): HTMLElement;
58
+ }
59
+ export declare abstract class PreferenceLeafNodeRenderer<ValueType extends JSONValue, InteractableType extends HTMLElement> extends PreferenceNodeRenderer implements Required<GeneralPreferenceNodeRenderer> {
60
+ protected readonly preferenceNode: Preference.LeafNode;
61
+ protected readonly preferenceService: PreferenceService;
62
+ protected readonly menuRenderer: ContextMenuRenderer;
63
+ protected readonly scopeTracker: PreferencesScopeTabBar;
64
+ protected readonly model: PreferenceTreeModel;
65
+ protected readonly searchbar: PreferencesSearchbarWidget;
66
+ protected readonly openerService: OpenerService;
67
+ protected headlineWrapper: HTMLDivElement;
68
+ protected gutter: HTMLDivElement;
69
+ protected interactable: InteractableType;
70
+ protected inspection: PreferenceInspection<ValueType> | undefined;
71
+ protected isModifiedFromDefault: boolean;
72
+ protected markdownRenderer: markdownit;
73
+ protected init(): void;
74
+ protected updateInspection(): void;
75
+ protected buildMarkdownRenderer(): markdownit;
76
+ protected openLink(event: MouseEvent): void;
77
+ protected createDomNode(): HTMLLIElement;
78
+ protected handleCogAction({ currentTarget }: KeyboardEvent | MouseEvent): void;
79
+ protected addModifiedMarking(): void;
80
+ protected removeModifiedMarking(): void;
81
+ protected showCog(): void;
82
+ protected hideCog(): void;
83
+ protected updateModificationStatus(knownCurrentValue?: JSONValue): void;
84
+ protected updateHeadline(filtered?: boolean): void;
85
+ protected compareOtherModifiedScopes(headlineWrapper: HTMLDivElement, currentSuffix: HTMLElement): void;
86
+ protected createOtherModifiedScopes(headlineWrapper: HTMLDivElement): void;
87
+ protected createModifiedScopeMessage(scope: PreferenceScope): HTMLSpanElement;
88
+ protected getModifiedMessagePrefix(): string;
89
+ protected addEventHandlerToModifiedScope(scope: PreferenceScope, scopeWrapper: HTMLElement): void;
90
+ protected getModifiedScopesAsStrings(): PreferenceScope[];
91
+ protected getValue(): ValueType | null;
92
+ protected setPreferenceWithDebounce: import("lodash").DebouncedFunc<any>;
93
+ protected setPreferenceImmediately(value: ValueType | undefined): Promise<void>;
94
+ handleSearchChange(isFiltered?: boolean): void;
95
+ handleScopeChange(isFiltered?: boolean): void;
96
+ handleValueChange(): void;
97
+ /**
98
+ * Should create an HTML element that the user can interact with to change the value of the preference.
99
+ * @param container the parent element for the interactable. This method is responsible for adding the new element to its parent.
100
+ */
101
+ protected abstract createInteractable(container: HTMLElement): void;
102
+ /**
103
+ * @returns a fallback default value for a preference of the type implemented by a concrete leaf renderer
104
+ * This function is only called if the default value for a given preference is not specified in its schema.
105
+ */
106
+ protected abstract getFallbackValue(): ValueType;
107
+ /**
108
+ * This function is responsible for reconciling the display of the preference value with the value reported by the PreferenceService.
109
+ */
110
+ protected abstract doHandleValueChange(): void;
111
+ }
112
112
  //# sourceMappingURL=preference-node-renderer.d.ts.map