@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,104 +1,104 @@
1
- // *****************************************************************************
2
- // Copyright (C) 2022 EclipseSource and others.
3
- //
4
- // This program and the accompanying materials are made available under the
5
- // terms of the Eclipse Public License v. 2.0 which is available at
6
- // http://www.eclipse.org/legal/epl-2.0.
7
- //
8
- // This Source Code may also be made available under the following Secondary
9
- // Licenses when the conditions for such availability set forth in the Eclipse
10
- // Public License v. 2.0 are satisfied: GNU General Public License, version 2
11
- // with the GNU Classpath Exception which is available at
12
- // https://www.gnu.org/software/classpath/license.html.
13
- //
14
- // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
15
- // *****************************************************************************
16
-
17
- import { isObject } from '@theia/core/lib/common';
18
- import { nls } from '@theia/core/lib/common/nls';
19
- import { inject, injectable, interfaces } from '@theia/core/shared/inversify';
20
- import { OpenFileDialogProps } from '@theia/filesystem/lib/browser';
21
- import { FileDialogService } from '@theia/filesystem/lib/browser/file-dialog/file-dialog-service';
22
- import { WorkspaceCommands } from '@theia/workspace/lib/browser';
23
- import { Preference } from '../../util/preference-types';
24
- import { PreferenceNodeRenderer } from './preference-node-renderer';
25
- import { PreferenceLeafNodeRendererContribution } from './preference-node-renderer-creator';
26
- import { PreferenceStringInputRenderer } from './preference-string-input';
27
-
28
- export interface FileNodeTypeDetails {
29
- isFilepath: true;
30
- selectionProps?: Partial<OpenFileDialogProps>;
31
- }
32
-
33
- export namespace FileNodeTypeDetails {
34
- export function is(typeDetails: unknown): typeDetails is FileNodeTypeDetails {
35
- return isObject<FileNodeTypeDetails>(typeDetails) && !!typeDetails.isFilepath;
36
- }
37
- }
38
-
39
- @injectable()
40
- export class PreferenceSingleFilePathInputRendererContribution extends PreferenceLeafNodeRendererContribution {
41
- static ID = 'preference-single-file-path-input-renderer';
42
- id = PreferenceSingleFilePathInputRendererContribution.ID;
43
-
44
- canHandleLeafNode(node: Preference.LeafNode): number {
45
- const typeDetails = node.preference.data.typeDetails;
46
- return FileNodeTypeDetails.is(typeDetails) && !typeDetails.selectionProps?.canSelectMany ? 5 : 0;
47
- }
48
-
49
- createLeafNodeRenderer(container: interfaces.Container): PreferenceNodeRenderer {
50
- return container.get(PreferenceSingleFilePathInputRenderer);
51
- }
52
- }
53
-
54
- @injectable()
55
- export class PreferenceSingleFilePathInputRenderer extends PreferenceStringInputRenderer {
56
- @inject(FileDialogService) fileDialogService: FileDialogService;
57
-
58
- get typeDetails(): FileNodeTypeDetails {
59
- return this.preferenceNode.preference.data.typeDetails as FileNodeTypeDetails;
60
- }
61
-
62
- protected createInputWrapper(): HTMLElement {
63
- const inputWrapper = document.createElement('div');
64
- inputWrapper.classList.add('preference-file-container');
65
- return inputWrapper;
66
- }
67
-
68
- protected override createInteractable(parent: HTMLElement): void {
69
- const inputWrapper = this.createInputWrapper();
70
-
71
- super.createInteractable(inputWrapper);
72
- this.interactable.classList.add('preference-file-input');
73
-
74
- this.createBrowseButton(inputWrapper);
75
-
76
- parent.appendChild(inputWrapper);
77
- }
78
-
79
- protected createBrowseButton(parent: HTMLElement): void {
80
- const button = document.createElement('button');
81
- button.classList.add('theia-button', 'main', 'preference-file-button');
82
- button.textContent = nls.localize('theia/core/file/browse', 'Browse');
83
- const handler = this.browse.bind(this);
84
- button.onclick = handler;
85
- button.onkeydown = handler;
86
- button.tabIndex = 0;
87
- button.setAttribute('aria-label', 'Submit Preference Input');
88
- parent.appendChild(button);
89
- }
90
-
91
- protected async browse(): Promise<void> {
92
- const selectionProps = this.typeDetails.selectionProps;
93
- const title = selectionProps?.title ?? selectionProps?.canSelectFolders ? WorkspaceCommands.OPEN_FOLDER.dialogLabel : WorkspaceCommands.OPEN_FILE.dialogLabel;
94
- const selection = await this.fileDialogService.showOpenDialog({ title, ...selectionProps });
95
- if (selection) {
96
- this.setPreferenceImmediately(selection.path.fsPath());
97
- }
98
- }
99
-
100
- protected override setPreferenceImmediately(value: string): Promise<void> {
101
- this.interactable.value = value;
102
- return super.setPreferenceImmediately(value);
103
- }
104
- }
1
+ // *****************************************************************************
2
+ // Copyright (C) 2022 EclipseSource and others.
3
+ //
4
+ // This program and the accompanying materials are made available under the
5
+ // terms of the Eclipse Public License v. 2.0 which is available at
6
+ // http://www.eclipse.org/legal/epl-2.0.
7
+ //
8
+ // This Source Code may also be made available under the following Secondary
9
+ // Licenses when the conditions for such availability set forth in the Eclipse
10
+ // Public License v. 2.0 are satisfied: GNU General Public License, version 2
11
+ // with the GNU Classpath Exception which is available at
12
+ // https://www.gnu.org/software/classpath/license.html.
13
+ //
14
+ // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
15
+ // *****************************************************************************
16
+
17
+ import { isObject } from '@theia/core/lib/common';
18
+ import { nls } from '@theia/core/lib/common/nls';
19
+ import { inject, injectable, interfaces } from '@theia/core/shared/inversify';
20
+ import { OpenFileDialogProps } from '@theia/filesystem/lib/browser';
21
+ import { FileDialogService } from '@theia/filesystem/lib/browser/file-dialog/file-dialog-service';
22
+ import { WorkspaceCommands } from '@theia/workspace/lib/browser';
23
+ import { Preference } from '../../util/preference-types';
24
+ import { PreferenceNodeRenderer } from './preference-node-renderer';
25
+ import { PreferenceLeafNodeRendererContribution } from './preference-node-renderer-creator';
26
+ import { PreferenceStringInputRenderer } from './preference-string-input';
27
+
28
+ export interface FileNodeTypeDetails {
29
+ isFilepath: true;
30
+ selectionProps?: Partial<OpenFileDialogProps>;
31
+ }
32
+
33
+ export namespace FileNodeTypeDetails {
34
+ export function is(typeDetails: unknown): typeDetails is FileNodeTypeDetails {
35
+ return isObject<FileNodeTypeDetails>(typeDetails) && !!typeDetails.isFilepath;
36
+ }
37
+ }
38
+
39
+ @injectable()
40
+ export class PreferenceSingleFilePathInputRendererContribution extends PreferenceLeafNodeRendererContribution {
41
+ static ID = 'preference-single-file-path-input-renderer';
42
+ id = PreferenceSingleFilePathInputRendererContribution.ID;
43
+
44
+ canHandleLeafNode(node: Preference.LeafNode): number {
45
+ const typeDetails = node.preference.data.typeDetails;
46
+ return FileNodeTypeDetails.is(typeDetails) && !typeDetails.selectionProps?.canSelectMany ? 5 : 0;
47
+ }
48
+
49
+ createLeafNodeRenderer(container: interfaces.Container): PreferenceNodeRenderer {
50
+ return container.get(PreferenceSingleFilePathInputRenderer);
51
+ }
52
+ }
53
+
54
+ @injectable()
55
+ export class PreferenceSingleFilePathInputRenderer extends PreferenceStringInputRenderer {
56
+ @inject(FileDialogService) fileDialogService: FileDialogService;
57
+
58
+ get typeDetails(): FileNodeTypeDetails {
59
+ return this.preferenceNode.preference.data.typeDetails as FileNodeTypeDetails;
60
+ }
61
+
62
+ protected createInputWrapper(): HTMLElement {
63
+ const inputWrapper = document.createElement('div');
64
+ inputWrapper.classList.add('preference-file-container');
65
+ return inputWrapper;
66
+ }
67
+
68
+ protected override createInteractable(parent: HTMLElement): void {
69
+ const inputWrapper = this.createInputWrapper();
70
+
71
+ super.createInteractable(inputWrapper);
72
+ this.interactable.classList.add('preference-file-input');
73
+
74
+ this.createBrowseButton(inputWrapper);
75
+
76
+ parent.appendChild(inputWrapper);
77
+ }
78
+
79
+ protected createBrowseButton(parent: HTMLElement): void {
80
+ const button = document.createElement('button');
81
+ button.classList.add('theia-button', 'main', 'preference-file-button');
82
+ button.textContent = nls.localize('theia/core/file/browse', 'Browse');
83
+ const handler = this.browse.bind(this);
84
+ button.onclick = handler;
85
+ button.onkeydown = handler;
86
+ button.tabIndex = 0;
87
+ button.setAttribute('aria-label', 'Submit Preference Input');
88
+ parent.appendChild(button);
89
+ }
90
+
91
+ protected async browse(): Promise<void> {
92
+ const selectionProps = this.typeDetails.selectionProps;
93
+ const title = selectionProps?.title ?? selectionProps?.canSelectFolders ? WorkspaceCommands.OPEN_FOLDER.dialogLabel : WorkspaceCommands.OPEN_FILE.dialogLabel;
94
+ const selection = await this.fileDialogService.showOpenDialog({ title, ...selectionProps });
95
+ if (selection) {
96
+ this.setPreferenceImmediately(selection.path.fsPath());
97
+ }
98
+ }
99
+
100
+ protected override setPreferenceImmediately(value: string): Promise<void> {
101
+ this.interactable.value = value;
102
+ return super.setPreferenceImmediately(value);
103
+ }
104
+ }
@@ -1,78 +1,78 @@
1
- // *****************************************************************************
2
- // Copyright (C) 2021 Ericsson and others.
3
- //
4
- // This program and the accompanying materials are made available under the
5
- // terms of the Eclipse Public License v. 2.0 which is available at
6
- // http://www.eclipse.org/legal/epl-2.0.
7
- //
8
- // This Source Code may also be made available under the following Secondary
9
- // Licenses when the conditions for such availability set forth in the Eclipse
10
- // Public License v. 2.0 are satisfied: GNU General Public License, version 2
11
- // with the GNU Classpath Exception which is available at
12
- // https://www.gnu.org/software/classpath/license.html.
13
- //
14
- // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
15
- // *****************************************************************************
16
-
17
- import { PreferenceLeafNodeRenderer, PreferenceNodeRenderer } from './preference-node-renderer';
18
- import { injectable, inject, interfaces } from '@theia/core/shared/inversify';
19
- import { CommandService, nls } from '@theia/core/lib/common';
20
- import { Preference, PreferencesCommands } from '../../util/preference-types';
21
- import { JSONValue } from '@theia/core/shared/@phosphor/coreutils';
22
- import { PreferenceLeafNodeRendererContribution } from './preference-node-renderer-creator';
23
-
24
- @injectable()
25
- export class PreferenceJSONLinkRenderer extends PreferenceLeafNodeRenderer<JSONValue, HTMLAnchorElement> {
26
- @inject(CommandService) protected readonly commandService: CommandService;
27
-
28
- protected createInteractable(parent: HTMLElement): void {
29
- const message = nls.localizeByDefault('Edit in settings.json');
30
- const interactable = document.createElement('a');
31
- this.interactable = interactable;
32
- interactable.classList.add('theia-json-input');
33
- interactable.setAttribute('role', 'button');
34
- interactable.title = message;
35
- interactable.textContent = message;
36
- interactable.onclick = this.handleUserInteraction.bind(this);
37
- interactable.onkeydown = this.handleUserInteraction.bind(this);
38
- parent.appendChild(interactable);
39
- }
40
-
41
- protected getFallbackValue(): JSONValue {
42
- const node = this.preferenceNode;
43
- const type = Array.isArray(node.preference.data.type) ? node.preference.data.type[0] : node.preference.data.type;
44
- switch (type) {
45
- case 'object':
46
- return {};
47
- case 'array':
48
- return [];
49
- case 'null':
50
- return null; // eslint-disable-line no-null/no-null
51
- default: // Should all be handled by other input types.
52
- return '';
53
- }
54
- }
55
-
56
- protected doHandleValueChange(): void {
57
- this.updateInspection();
58
- this.updateModificationStatus();
59
- }
60
-
61
- protected handleUserInteraction(): void {
62
- this.commandService.executeCommand(PreferencesCommands.OPEN_PREFERENCES_JSON_TOOLBAR.id, this.id);
63
- }
64
- }
65
-
66
- @injectable()
67
- export class PreferenceJSONLinkRendererContribution extends PreferenceLeafNodeRendererContribution {
68
- static ID = 'preference-json-link-renderer';
69
- id = PreferenceJSONLinkRendererContribution.ID;
70
-
71
- canHandleLeafNode(_node: Preference.LeafNode): number {
72
- return 1;
73
- }
74
-
75
- createLeafNodeRenderer(container: interfaces.Container): PreferenceNodeRenderer {
76
- return container.get(PreferenceJSONLinkRenderer);
77
- }
78
- }
1
+ // *****************************************************************************
2
+ // Copyright (C) 2021 Ericsson and others.
3
+ //
4
+ // This program and the accompanying materials are made available under the
5
+ // terms of the Eclipse Public License v. 2.0 which is available at
6
+ // http://www.eclipse.org/legal/epl-2.0.
7
+ //
8
+ // This Source Code may also be made available under the following Secondary
9
+ // Licenses when the conditions for such availability set forth in the Eclipse
10
+ // Public License v. 2.0 are satisfied: GNU General Public License, version 2
11
+ // with the GNU Classpath Exception which is available at
12
+ // https://www.gnu.org/software/classpath/license.html.
13
+ //
14
+ // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
15
+ // *****************************************************************************
16
+
17
+ import { PreferenceLeafNodeRenderer, PreferenceNodeRenderer } from './preference-node-renderer';
18
+ import { injectable, inject, interfaces } from '@theia/core/shared/inversify';
19
+ import { CommandService, nls } from '@theia/core/lib/common';
20
+ import { Preference, PreferencesCommands } from '../../util/preference-types';
21
+ import { JSONValue } from '@theia/core/shared/@phosphor/coreutils';
22
+ import { PreferenceLeafNodeRendererContribution } from './preference-node-renderer-creator';
23
+
24
+ @injectable()
25
+ export class PreferenceJSONLinkRenderer extends PreferenceLeafNodeRenderer<JSONValue, HTMLAnchorElement> {
26
+ @inject(CommandService) protected readonly commandService: CommandService;
27
+
28
+ protected createInteractable(parent: HTMLElement): void {
29
+ const message = nls.localizeByDefault('Edit in settings.json');
30
+ const interactable = document.createElement('a');
31
+ this.interactable = interactable;
32
+ interactable.classList.add('theia-json-input');
33
+ interactable.setAttribute('role', 'button');
34
+ interactable.title = message;
35
+ interactable.textContent = message;
36
+ interactable.onclick = this.handleUserInteraction.bind(this);
37
+ interactable.onkeydown = this.handleUserInteraction.bind(this);
38
+ parent.appendChild(interactable);
39
+ }
40
+
41
+ protected getFallbackValue(): JSONValue {
42
+ const node = this.preferenceNode;
43
+ const type = Array.isArray(node.preference.data.type) ? node.preference.data.type[0] : node.preference.data.type;
44
+ switch (type) {
45
+ case 'object':
46
+ return {};
47
+ case 'array':
48
+ return [];
49
+ case 'null':
50
+ return null; // eslint-disable-line no-null/no-null
51
+ default: // Should all be handled by other input types.
52
+ return '';
53
+ }
54
+ }
55
+
56
+ protected doHandleValueChange(): void {
57
+ this.updateInspection();
58
+ this.updateModificationStatus();
59
+ }
60
+
61
+ protected handleUserInteraction(): void {
62
+ this.commandService.executeCommand(PreferencesCommands.OPEN_PREFERENCES_JSON_TOOLBAR.id, this.id);
63
+ }
64
+ }
65
+
66
+ @injectable()
67
+ export class PreferenceJSONLinkRendererContribution extends PreferenceLeafNodeRendererContribution {
68
+ static ID = 'preference-json-link-renderer';
69
+ id = PreferenceJSONLinkRendererContribution.ID;
70
+
71
+ canHandleLeafNode(_node: Preference.LeafNode): number {
72
+ return 1;
73
+ }
74
+
75
+ createLeafNodeRenderer(container: interfaces.Container): PreferenceNodeRenderer {
76
+ return container.get(PreferenceJSONLinkRenderer);
77
+ }
78
+ }
@@ -1,141 +1,141 @@
1
- // *****************************************************************************
2
- // Copyright (C) 2022 EclipseSource and others.
3
- //
4
- // This program and the accompanying materials are made available under the
5
- // terms of the Eclipse Public License v. 2.0 which is available at
6
- // http://www.eclipse.org/legal/epl-2.0.
7
- //
8
- // This Source Code may also be made available under the following Secondary
9
- // Licenses when the conditions for such availability set forth in the Eclipse
10
- // Public License v. 2.0 are satisfied: GNU General Public License, version 2
11
- // with the GNU Classpath Exception which is available at
12
- // https://www.gnu.org/software/classpath/license.html.
13
- //
14
- // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
15
- // *****************************************************************************
16
-
17
- import { ContributionProvider, Disposable, Emitter, Event, Prioritizeable } from '@theia/core';
18
- import { inject, injectable, interfaces, named } from '@theia/core/shared/inversify';
19
- import { Preference } from '../../util/preference-types';
20
- import { PreferenceHeaderRenderer, PreferenceNodeRenderer } from './preference-node-renderer';
21
-
22
- export const PreferenceNodeRendererCreatorRegistry = Symbol('PreferenceNodeRendererCreatorRegistry');
23
- export interface PreferenceNodeRendererCreatorRegistry {
24
- registerPreferenceNodeRendererCreator(creator: PreferenceNodeRendererCreator): Disposable;
25
- unregisterPreferenceNodeRendererCreator(creator: PreferenceNodeRendererCreator): void;
26
- getPreferenceNodeRendererCreator(node: Preference.TreeNode): PreferenceNodeRendererCreator;
27
- onDidChange: Event<void>;
28
- }
29
-
30
- export const PreferenceNodeRendererContribution = Symbol('PreferenceNodeRendererContribution');
31
- export interface PreferenceNodeRendererContribution {
32
- registerPreferenceNodeRendererCreator(registry: PreferenceNodeRendererCreatorRegistry): void;
33
- }
34
-
35
- export const PreferenceNodeRendererCreator = Symbol('PreferenceNodeRendererCreator');
36
- export interface PreferenceNodeRendererCreator {
37
- id: string;
38
- canHandle(node: Preference.TreeNode): number;
39
- createRenderer(node: Preference.TreeNode, container: interfaces.Container): PreferenceNodeRenderer;
40
- }
41
-
42
- @injectable()
43
- export class DefaultPreferenceNodeRendererCreatorRegistry implements PreferenceNodeRendererCreatorRegistry {
44
- protected readonly _creators: Map<string, PreferenceNodeRendererCreator> = new Map<string, PreferenceNodeRendererCreator>();
45
- protected readonly onDidChangeEmitter = new Emitter<void>();
46
- readonly onDidChange = this.onDidChangeEmitter.event;
47
-
48
- constructor(
49
- @inject(ContributionProvider) @named(PreferenceNodeRendererContribution)
50
- protected readonly contributionProvider: ContributionProvider<PreferenceNodeRendererContribution>
51
- ) {
52
- const contributions = this.contributionProvider.getContributions();
53
- for (const contrib of contributions) {
54
- contrib.registerPreferenceNodeRendererCreator(this);
55
- }
56
- }
57
-
58
- registerPreferenceNodeRendererCreator(creator: PreferenceNodeRendererCreator): Disposable {
59
- if (this._creators.has(creator.id)) {
60
- console.warn(`A preference node renderer creator ${creator.id} is already registered.`);
61
- return Disposable.NULL;
62
- }
63
- this._creators.set(creator.id, creator);
64
- this.fireDidChange();
65
- return Disposable.create(() => this._creators.delete(creator.id));
66
- }
67
-
68
- unregisterPreferenceNodeRendererCreator(creator: PreferenceNodeRendererCreator | string): void {
69
- const id = typeof creator === 'string' ? creator : creator.id;
70
- if (this._creators.delete(id)) {
71
- this.fireDidChange();
72
- }
73
- }
74
-
75
- getPreferenceNodeRendererCreator(node: Preference.TreeNode): PreferenceNodeRendererCreator {
76
- const contributions = this.prioritize(node);
77
- if (contributions.length >= 1) {
78
- return contributions[0];
79
- }
80
- // we already bind a default creator contribution so if that happens it was deliberate
81
- throw new Error(`There is no contribution for ${node.id}.`);
82
- }
83
-
84
- protected fireDidChange(): void {
85
- this.onDidChangeEmitter.fire(undefined);
86
- }
87
-
88
- protected prioritize(node: Preference.TreeNode): PreferenceNodeRendererCreator[] {
89
- const prioritized = Prioritizeable.prioritizeAllSync(Array.from(this._creators.values()), creator => {
90
- try {
91
- return creator.canHandle(node);
92
- } catch {
93
- return 0;
94
- }
95
- });
96
- return prioritized.map(p => p.value);
97
- }
98
- }
99
-
100
- @injectable()
101
- export abstract class PreferenceLeafNodeRendererContribution implements PreferenceNodeRendererCreator, PreferenceNodeRendererContribution {
102
- abstract id: string;
103
-
104
- canHandle(node: Preference.TreeNode): number {
105
- return Preference.LeafNode.is(node) ? this.canHandleLeafNode(node) : 0;
106
- }
107
-
108
- registerPreferenceNodeRendererCreator(registry: PreferenceNodeRendererCreatorRegistry): void {
109
- registry.registerPreferenceNodeRendererCreator(this);
110
- }
111
-
112
- abstract canHandleLeafNode(node: Preference.LeafNode): number;
113
-
114
- createRenderer(node: Preference.TreeNode, container: interfaces.Container): PreferenceNodeRenderer {
115
- const child = container.createChild();
116
- child.bind(Preference.Node).toConstantValue(node);
117
- return this.createLeafNodeRenderer(child);
118
- }
119
-
120
- abstract createLeafNodeRenderer(container: interfaces.Container): PreferenceNodeRenderer;
121
- }
122
-
123
- @injectable()
124
- export class PreferenceHeaderRendererContribution implements PreferenceNodeRendererCreator, PreferenceNodeRendererContribution {
125
- static ID = 'preference-header-renderer';
126
- id = PreferenceHeaderRendererContribution.ID;
127
-
128
- registerPreferenceNodeRendererCreator(registry: PreferenceNodeRendererCreatorRegistry): void {
129
- registry.registerPreferenceNodeRendererCreator(this);
130
- }
131
-
132
- canHandle(node: Preference.TreeNode): number {
133
- return !Preference.LeafNode.is(node) ? 1 : 0;
134
- }
135
-
136
- createRenderer(node: Preference.TreeNode, container: interfaces.Container): PreferenceNodeRenderer {
137
- const grandchild = container.createChild();
138
- grandchild.bind(Preference.Node).toConstantValue(node);
139
- return grandchild.get(PreferenceHeaderRenderer);
140
- }
141
- }
1
+ // *****************************************************************************
2
+ // Copyright (C) 2022 EclipseSource and others.
3
+ //
4
+ // This program and the accompanying materials are made available under the
5
+ // terms of the Eclipse Public License v. 2.0 which is available at
6
+ // http://www.eclipse.org/legal/epl-2.0.
7
+ //
8
+ // This Source Code may also be made available under the following Secondary
9
+ // Licenses when the conditions for such availability set forth in the Eclipse
10
+ // Public License v. 2.0 are satisfied: GNU General Public License, version 2
11
+ // with the GNU Classpath Exception which is available at
12
+ // https://www.gnu.org/software/classpath/license.html.
13
+ //
14
+ // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
15
+ // *****************************************************************************
16
+
17
+ import { ContributionProvider, Disposable, Emitter, Event, Prioritizeable } from '@theia/core';
18
+ import { inject, injectable, interfaces, named } from '@theia/core/shared/inversify';
19
+ import { Preference } from '../../util/preference-types';
20
+ import { PreferenceHeaderRenderer, PreferenceNodeRenderer } from './preference-node-renderer';
21
+
22
+ export const PreferenceNodeRendererCreatorRegistry = Symbol('PreferenceNodeRendererCreatorRegistry');
23
+ export interface PreferenceNodeRendererCreatorRegistry {
24
+ registerPreferenceNodeRendererCreator(creator: PreferenceNodeRendererCreator): Disposable;
25
+ unregisterPreferenceNodeRendererCreator(creator: PreferenceNodeRendererCreator): void;
26
+ getPreferenceNodeRendererCreator(node: Preference.TreeNode): PreferenceNodeRendererCreator;
27
+ onDidChange: Event<void>;
28
+ }
29
+
30
+ export const PreferenceNodeRendererContribution = Symbol('PreferenceNodeRendererContribution');
31
+ export interface PreferenceNodeRendererContribution {
32
+ registerPreferenceNodeRendererCreator(registry: PreferenceNodeRendererCreatorRegistry): void;
33
+ }
34
+
35
+ export const PreferenceNodeRendererCreator = Symbol('PreferenceNodeRendererCreator');
36
+ export interface PreferenceNodeRendererCreator {
37
+ id: string;
38
+ canHandle(node: Preference.TreeNode): number;
39
+ createRenderer(node: Preference.TreeNode, container: interfaces.Container): PreferenceNodeRenderer;
40
+ }
41
+
42
+ @injectable()
43
+ export class DefaultPreferenceNodeRendererCreatorRegistry implements PreferenceNodeRendererCreatorRegistry {
44
+ protected readonly _creators: Map<string, PreferenceNodeRendererCreator> = new Map<string, PreferenceNodeRendererCreator>();
45
+ protected readonly onDidChangeEmitter = new Emitter<void>();
46
+ readonly onDidChange = this.onDidChangeEmitter.event;
47
+
48
+ constructor(
49
+ @inject(ContributionProvider) @named(PreferenceNodeRendererContribution)
50
+ protected readonly contributionProvider: ContributionProvider<PreferenceNodeRendererContribution>
51
+ ) {
52
+ const contributions = this.contributionProvider.getContributions();
53
+ for (const contrib of contributions) {
54
+ contrib.registerPreferenceNodeRendererCreator(this);
55
+ }
56
+ }
57
+
58
+ registerPreferenceNodeRendererCreator(creator: PreferenceNodeRendererCreator): Disposable {
59
+ if (this._creators.has(creator.id)) {
60
+ console.warn(`A preference node renderer creator ${creator.id} is already registered.`);
61
+ return Disposable.NULL;
62
+ }
63
+ this._creators.set(creator.id, creator);
64
+ this.fireDidChange();
65
+ return Disposable.create(() => this._creators.delete(creator.id));
66
+ }
67
+
68
+ unregisterPreferenceNodeRendererCreator(creator: PreferenceNodeRendererCreator | string): void {
69
+ const id = typeof creator === 'string' ? creator : creator.id;
70
+ if (this._creators.delete(id)) {
71
+ this.fireDidChange();
72
+ }
73
+ }
74
+
75
+ getPreferenceNodeRendererCreator(node: Preference.TreeNode): PreferenceNodeRendererCreator {
76
+ const contributions = this.prioritize(node);
77
+ if (contributions.length >= 1) {
78
+ return contributions[0];
79
+ }
80
+ // we already bind a default creator contribution so if that happens it was deliberate
81
+ throw new Error(`There is no contribution for ${node.id}.`);
82
+ }
83
+
84
+ protected fireDidChange(): void {
85
+ this.onDidChangeEmitter.fire(undefined);
86
+ }
87
+
88
+ protected prioritize(node: Preference.TreeNode): PreferenceNodeRendererCreator[] {
89
+ const prioritized = Prioritizeable.prioritizeAllSync(Array.from(this._creators.values()), creator => {
90
+ try {
91
+ return creator.canHandle(node);
92
+ } catch {
93
+ return 0;
94
+ }
95
+ });
96
+ return prioritized.map(p => p.value);
97
+ }
98
+ }
99
+
100
+ @injectable()
101
+ export abstract class PreferenceLeafNodeRendererContribution implements PreferenceNodeRendererCreator, PreferenceNodeRendererContribution {
102
+ abstract id: string;
103
+
104
+ canHandle(node: Preference.TreeNode): number {
105
+ return Preference.LeafNode.is(node) ? this.canHandleLeafNode(node) : 0;
106
+ }
107
+
108
+ registerPreferenceNodeRendererCreator(registry: PreferenceNodeRendererCreatorRegistry): void {
109
+ registry.registerPreferenceNodeRendererCreator(this);
110
+ }
111
+
112
+ abstract canHandleLeafNode(node: Preference.LeafNode): number;
113
+
114
+ createRenderer(node: Preference.TreeNode, container: interfaces.Container): PreferenceNodeRenderer {
115
+ const child = container.createChild();
116
+ child.bind(Preference.Node).toConstantValue(node);
117
+ return this.createLeafNodeRenderer(child);
118
+ }
119
+
120
+ abstract createLeafNodeRenderer(container: interfaces.Container): PreferenceNodeRenderer;
121
+ }
122
+
123
+ @injectable()
124
+ export class PreferenceHeaderRendererContribution implements PreferenceNodeRendererCreator, PreferenceNodeRendererContribution {
125
+ static ID = 'preference-header-renderer';
126
+ id = PreferenceHeaderRendererContribution.ID;
127
+
128
+ registerPreferenceNodeRendererCreator(registry: PreferenceNodeRendererCreatorRegistry): void {
129
+ registry.registerPreferenceNodeRendererCreator(this);
130
+ }
131
+
132
+ canHandle(node: Preference.TreeNode): number {
133
+ return !Preference.LeafNode.is(node) ? 1 : 0;
134
+ }
135
+
136
+ createRenderer(node: Preference.TreeNode, container: interfaces.Container): PreferenceNodeRenderer {
137
+ const grandchild = container.createChild();
138
+ grandchild.bind(Preference.Node).toConstantValue(node);
139
+ return grandchild.get(PreferenceHeaderRenderer);
140
+ }
141
+ }