@itwin/appui-react 4.0.0-dev.17 → 4.0.0-dev.19

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 (185) hide show
  1. package/CHANGELOG.md +43 -18
  2. package/lib/cjs/appui-react/UiFramework.d.ts +10 -20
  3. package/lib/cjs/appui-react/UiFramework.d.ts.map +1 -1
  4. package/lib/cjs/appui-react/UiFramework.js +12 -24
  5. package/lib/cjs/appui-react/UiFramework.js.map +1 -1
  6. package/lib/cjs/appui-react/backstage/BackstageItemUtilities.d.ts +3 -2
  7. package/lib/cjs/appui-react/backstage/BackstageItemUtilities.d.ts.map +1 -1
  8. package/lib/cjs/appui-react/backstage/BackstageItemUtilities.js +4 -4
  9. package/lib/cjs/appui-react/backstage/BackstageItemUtilities.js.map +1 -1
  10. package/lib/cjs/appui-react/childwindow/InternalChildWindowManager.d.ts.map +1 -1
  11. package/lib/cjs/appui-react/childwindow/InternalChildWindowManager.js +4 -4
  12. package/lib/cjs/appui-react/childwindow/InternalChildWindowManager.js.map +1 -1
  13. package/lib/cjs/appui-react/dialog/ContentDialogManager.d.ts +0 -39
  14. package/lib/cjs/appui-react/dialog/ContentDialogManager.d.ts.map +1 -1
  15. package/lib/cjs/appui-react/dialog/ContentDialogManager.js +1 -61
  16. package/lib/cjs/appui-react/dialog/ContentDialogManager.js.map +1 -1
  17. package/lib/cjs/appui-react/dialog/ModalDialogManager.d.ts +0 -30
  18. package/lib/cjs/appui-react/dialog/ModalDialogManager.d.ts.map +1 -1
  19. package/lib/cjs/appui-react/dialog/ModalDialogManager.js +1 -44
  20. package/lib/cjs/appui-react/dialog/ModalDialogManager.js.map +1 -1
  21. package/lib/cjs/appui-react/dialog/ModelessDialogManager.d.ts +0 -39
  22. package/lib/cjs/appui-react/dialog/ModelessDialogManager.d.ts.map +1 -1
  23. package/lib/cjs/appui-react/dialog/ModelessDialogManager.js +1 -60
  24. package/lib/cjs/appui-react/dialog/ModelessDialogManager.js.map +1 -1
  25. package/lib/cjs/appui-react/framework/FrameworkChildWindows.d.ts +1 -1
  26. package/lib/cjs/appui-react/framework/FrameworkChildWindows.js.map +1 -1
  27. package/lib/cjs/appui-react/framework/FrameworkContent.d.ts +2 -2
  28. package/lib/cjs/appui-react/framework/FrameworkContent.js.map +1 -1
  29. package/lib/cjs/appui-react/framework/FrameworkControls.d.ts +1 -1
  30. package/lib/cjs/appui-react/framework/FrameworkControls.js.map +1 -1
  31. package/lib/cjs/appui-react/framework/FrameworkDialogs.d.ts +1 -1
  32. package/lib/cjs/appui-react/framework/FrameworkDialogs.js.map +1 -1
  33. package/lib/cjs/appui-react/framework/FrameworkFrontstages.d.ts +1 -1
  34. package/lib/cjs/appui-react/framework/FrameworkFrontstages.js.map +1 -1
  35. package/lib/cjs/appui-react/framework/FrameworkKeyboardShortcuts.d.ts +1 -1
  36. package/lib/cjs/appui-react/framework/FrameworkKeyboardShortcuts.js.map +1 -1
  37. package/lib/cjs/appui-react/framework/FrameworkToolSettings.d.ts +1 -1
  38. package/lib/cjs/appui-react/framework/FrameworkToolSettings.js.map +1 -1
  39. package/lib/cjs/appui-react/framework/FrameworkVisibility.d.ts +1 -1
  40. package/lib/cjs/appui-react/framework/FrameworkVisibility.js.map +1 -1
  41. package/lib/cjs/appui-react/keyboardshortcut/KeyboardShortcut.d.ts +0 -32
  42. package/lib/cjs/appui-react/keyboardshortcut/KeyboardShortcut.d.ts.map +1 -1
  43. package/lib/cjs/appui-react/keyboardshortcut/KeyboardShortcut.js +1 -55
  44. package/lib/cjs/appui-react/keyboardshortcut/KeyboardShortcut.js.map +1 -1
  45. package/lib/cjs/appui-react/messages/MessageManager.js +2 -3
  46. package/lib/cjs/appui-react/messages/MessageManager.js.map +1 -1
  47. package/lib/cjs/appui-react/statusbar/StatusBarItemUtilities.d.ts +3 -2
  48. package/lib/cjs/appui-react/statusbar/StatusBarItemUtilities.d.ts.map +1 -1
  49. package/lib/cjs/appui-react/statusbar/StatusBarItemUtilities.js.map +1 -1
  50. package/lib/cjs/appui-react/syncui/SyncUiEventDispatcher.d.ts.map +1 -1
  51. package/lib/cjs/appui-react/syncui/SyncUiEventDispatcher.js +4 -0
  52. package/lib/cjs/appui-react/syncui/SyncUiEventDispatcher.js.map +1 -1
  53. package/lib/cjs/appui-react/ui-items-provider/AbstractUiItemsManager.d.ts +34 -0
  54. package/lib/cjs/appui-react/ui-items-provider/AbstractUiItemsManager.d.ts.map +1 -0
  55. package/lib/cjs/appui-react/ui-items-provider/AbstractUiItemsManager.js +500 -0
  56. package/lib/cjs/appui-react/ui-items-provider/AbstractUiItemsManager.js.map +1 -0
  57. package/lib/cjs/appui-react/ui-items-provider/UiItemsManager.d.ts +6 -4
  58. package/lib/cjs/appui-react/ui-items-provider/UiItemsManager.d.ts.map +1 -1
  59. package/lib/cjs/appui-react/ui-items-provider/UiItemsManager.js +33 -6
  60. package/lib/cjs/appui-react/ui-items-provider/UiItemsManager.js.map +1 -1
  61. package/lib/cjs/appui-react.d.ts +0 -7
  62. package/lib/cjs/appui-react.d.ts.map +1 -1
  63. package/lib/cjs/appui-react.js +0 -7
  64. package/lib/cjs/appui-react.js.map +1 -1
  65. package/lib/esm/appui-react/UiFramework.d.ts +10 -20
  66. package/lib/esm/appui-react/UiFramework.d.ts.map +1 -1
  67. package/lib/esm/appui-react/UiFramework.js +12 -24
  68. package/lib/esm/appui-react/UiFramework.js.map +1 -1
  69. package/lib/esm/appui-react/backstage/BackstageItemUtilities.d.ts +3 -2
  70. package/lib/esm/appui-react/backstage/BackstageItemUtilities.d.ts.map +1 -1
  71. package/lib/esm/appui-react/backstage/BackstageItemUtilities.js +4 -4
  72. package/lib/esm/appui-react/backstage/BackstageItemUtilities.js.map +1 -1
  73. package/lib/esm/appui-react/childwindow/InternalChildWindowManager.d.ts.map +1 -1
  74. package/lib/esm/appui-react/childwindow/InternalChildWindowManager.js +4 -4
  75. package/lib/esm/appui-react/childwindow/InternalChildWindowManager.js.map +1 -1
  76. package/lib/esm/appui-react/dialog/ContentDialogManager.d.ts +0 -39
  77. package/lib/esm/appui-react/dialog/ContentDialogManager.d.ts.map +1 -1
  78. package/lib/esm/appui-react/dialog/ContentDialogManager.js +0 -59
  79. package/lib/esm/appui-react/dialog/ContentDialogManager.js.map +1 -1
  80. package/lib/esm/appui-react/dialog/ModalDialogManager.d.ts +0 -30
  81. package/lib/esm/appui-react/dialog/ModalDialogManager.d.ts.map +1 -1
  82. package/lib/esm/appui-react/dialog/ModalDialogManager.js +0 -42
  83. package/lib/esm/appui-react/dialog/ModalDialogManager.js.map +1 -1
  84. package/lib/esm/appui-react/dialog/ModelessDialogManager.d.ts +0 -39
  85. package/lib/esm/appui-react/dialog/ModelessDialogManager.d.ts.map +1 -1
  86. package/lib/esm/appui-react/dialog/ModelessDialogManager.js +0 -58
  87. package/lib/esm/appui-react/dialog/ModelessDialogManager.js.map +1 -1
  88. package/lib/esm/appui-react/framework/FrameworkChildWindows.d.ts +1 -1
  89. package/lib/esm/appui-react/framework/FrameworkChildWindows.js.map +1 -1
  90. package/lib/esm/appui-react/framework/FrameworkContent.d.ts +2 -2
  91. package/lib/esm/appui-react/framework/FrameworkContent.js.map +1 -1
  92. package/lib/esm/appui-react/framework/FrameworkControls.d.ts +1 -1
  93. package/lib/esm/appui-react/framework/FrameworkControls.js.map +1 -1
  94. package/lib/esm/appui-react/framework/FrameworkDialogs.d.ts +1 -1
  95. package/lib/esm/appui-react/framework/FrameworkDialogs.js.map +1 -1
  96. package/lib/esm/appui-react/framework/FrameworkFrontstages.d.ts +1 -1
  97. package/lib/esm/appui-react/framework/FrameworkFrontstages.js.map +1 -1
  98. package/lib/esm/appui-react/framework/FrameworkKeyboardShortcuts.d.ts +1 -1
  99. package/lib/esm/appui-react/framework/FrameworkKeyboardShortcuts.js.map +1 -1
  100. package/lib/esm/appui-react/framework/FrameworkToolSettings.d.ts +1 -1
  101. package/lib/esm/appui-react/framework/FrameworkToolSettings.js.map +1 -1
  102. package/lib/esm/appui-react/framework/FrameworkVisibility.d.ts +1 -1
  103. package/lib/esm/appui-react/framework/FrameworkVisibility.js.map +1 -1
  104. package/lib/esm/appui-react/keyboardshortcut/KeyboardShortcut.d.ts +0 -32
  105. package/lib/esm/appui-react/keyboardshortcut/KeyboardShortcut.d.ts.map +1 -1
  106. package/lib/esm/appui-react/keyboardshortcut/KeyboardShortcut.js +0 -53
  107. package/lib/esm/appui-react/keyboardshortcut/KeyboardShortcut.js.map +1 -1
  108. package/lib/esm/appui-react/messages/MessageManager.js +2 -3
  109. package/lib/esm/appui-react/messages/MessageManager.js.map +1 -1
  110. package/lib/esm/appui-react/statusbar/StatusBarItemUtilities.d.ts +3 -2
  111. package/lib/esm/appui-react/statusbar/StatusBarItemUtilities.d.ts.map +1 -1
  112. package/lib/esm/appui-react/statusbar/StatusBarItemUtilities.js.map +1 -1
  113. package/lib/esm/appui-react/syncui/SyncUiEventDispatcher.d.ts.map +1 -1
  114. package/lib/esm/appui-react/syncui/SyncUiEventDispatcher.js +4 -0
  115. package/lib/esm/appui-react/syncui/SyncUiEventDispatcher.js.map +1 -1
  116. package/lib/esm/appui-react/ui-items-provider/AbstractUiItemsManager.d.ts +34 -0
  117. package/lib/esm/appui-react/ui-items-provider/AbstractUiItemsManager.d.ts.map +1 -0
  118. package/lib/esm/appui-react/ui-items-provider/AbstractUiItemsManager.js +496 -0
  119. package/lib/esm/appui-react/ui-items-provider/AbstractUiItemsManager.js.map +1 -0
  120. package/lib/esm/appui-react/ui-items-provider/UiItemsManager.d.ts +6 -4
  121. package/lib/esm/appui-react/ui-items-provider/UiItemsManager.d.ts.map +1 -1
  122. package/lib/esm/appui-react/ui-items-provider/UiItemsManager.js +33 -6
  123. package/lib/esm/appui-react/ui-items-provider/UiItemsManager.js.map +1 -1
  124. package/lib/esm/appui-react.d.ts +0 -7
  125. package/lib/esm/appui-react.d.ts.map +1 -1
  126. package/lib/esm/appui-react.js +0 -7
  127. package/lib/esm/appui-react.js.map +1 -1
  128. package/lib/public/locales/en/UiFramework.json +0 -45
  129. package/package.json +21 -13
  130. package/lib/cjs/appui-react/childwindow/ChildWindowManager.d.ts +0 -74
  131. package/lib/cjs/appui-react/childwindow/ChildWindowManager.d.ts.map +0 -1
  132. package/lib/cjs/appui-react/childwindow/ChildWindowManager.js +0 -107
  133. package/lib/cjs/appui-react/childwindow/ChildWindowManager.js.map +0 -1
  134. package/lib/cjs/appui-react/configurableui/ConfigurableUiManager.d.ts +0 -66
  135. package/lib/cjs/appui-react/configurableui/ConfigurableUiManager.d.ts.map +0 -1
  136. package/lib/cjs/appui-react/configurableui/ConfigurableUiManager.js +0 -93
  137. package/lib/cjs/appui-react/configurableui/ConfigurableUiManager.js.map +0 -1
  138. package/lib/cjs/appui-react/content/ContentLayoutManager.d.ts +0 -48
  139. package/lib/cjs/appui-react/content/ContentLayoutManager.d.ts.map +0 -1
  140. package/lib/cjs/appui-react/content/ContentLayoutManager.js +0 -69
  141. package/lib/cjs/appui-react/content/ContentLayoutManager.js.map +0 -1
  142. package/lib/cjs/appui-react/content/ContentViewManager.d.ts +0 -63
  143. package/lib/cjs/appui-react/content/ContentViewManager.d.ts.map +0 -1
  144. package/lib/cjs/appui-react/content/ContentViewManager.js +0 -96
  145. package/lib/cjs/appui-react/content/ContentViewManager.js.map +0 -1
  146. package/lib/cjs/appui-react/frontstage/FrontstageManager.d.ts +0 -202
  147. package/lib/cjs/appui-react/frontstage/FrontstageManager.d.ts.map +0 -1
  148. package/lib/cjs/appui-react/frontstage/FrontstageManager.js +0 -269
  149. package/lib/cjs/appui-react/frontstage/FrontstageManager.js.map +0 -1
  150. package/lib/cjs/appui-react/toolsettings/ToolSettingsManager.d.ts +0 -44
  151. package/lib/cjs/appui-react/toolsettings/ToolSettingsManager.d.ts.map +0 -1
  152. package/lib/cjs/appui-react/toolsettings/ToolSettingsManager.js +0 -64
  153. package/lib/cjs/appui-react/toolsettings/ToolSettingsManager.js.map +0 -1
  154. package/lib/cjs/appui-react/utils/UiShowHideManager.d.ts +0 -54
  155. package/lib/cjs/appui-react/utils/UiShowHideManager.d.ts.map +0 -1
  156. package/lib/cjs/appui-react/utils/UiShowHideManager.js +0 -108
  157. package/lib/cjs/appui-react/utils/UiShowHideManager.js.map +0 -1
  158. package/lib/esm/appui-react/childwindow/ChildWindowManager.d.ts +0 -74
  159. package/lib/esm/appui-react/childwindow/ChildWindowManager.d.ts.map +0 -1
  160. package/lib/esm/appui-react/childwindow/ChildWindowManager.js +0 -103
  161. package/lib/esm/appui-react/childwindow/ChildWindowManager.js.map +0 -1
  162. package/lib/esm/appui-react/configurableui/ConfigurableUiManager.d.ts +0 -66
  163. package/lib/esm/appui-react/configurableui/ConfigurableUiManager.d.ts.map +0 -1
  164. package/lib/esm/appui-react/configurableui/ConfigurableUiManager.js +0 -89
  165. package/lib/esm/appui-react/configurableui/ConfigurableUiManager.js.map +0 -1
  166. package/lib/esm/appui-react/content/ContentLayoutManager.d.ts +0 -48
  167. package/lib/esm/appui-react/content/ContentLayoutManager.d.ts.map +0 -1
  168. package/lib/esm/appui-react/content/ContentLayoutManager.js +0 -65
  169. package/lib/esm/appui-react/content/ContentLayoutManager.js.map +0 -1
  170. package/lib/esm/appui-react/content/ContentViewManager.d.ts +0 -63
  171. package/lib/esm/appui-react/content/ContentViewManager.d.ts.map +0 -1
  172. package/lib/esm/appui-react/content/ContentViewManager.js +0 -92
  173. package/lib/esm/appui-react/content/ContentViewManager.js.map +0 -1
  174. package/lib/esm/appui-react/frontstage/FrontstageManager.d.ts +0 -202
  175. package/lib/esm/appui-react/frontstage/FrontstageManager.d.ts.map +0 -1
  176. package/lib/esm/appui-react/frontstage/FrontstageManager.js +0 -265
  177. package/lib/esm/appui-react/frontstage/FrontstageManager.js.map +0 -1
  178. package/lib/esm/appui-react/toolsettings/ToolSettingsManager.d.ts +0 -44
  179. package/lib/esm/appui-react/toolsettings/ToolSettingsManager.d.ts.map +0 -1
  180. package/lib/esm/appui-react/toolsettings/ToolSettingsManager.js +0 -60
  181. package/lib/esm/appui-react/toolsettings/ToolSettingsManager.js.map +0 -1
  182. package/lib/esm/appui-react/utils/UiShowHideManager.d.ts +0 -54
  183. package/lib/esm/appui-react/utils/UiShowHideManager.d.ts.map +0 -1
  184. package/lib/esm/appui-react/utils/UiShowHideManager.js +0 -105
  185. package/lib/esm/appui-react/utils/UiShowHideManager.js.map +0 -1
@@ -1,265 +0,0 @@
1
- /*---------------------------------------------------------------------------------------------
2
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
3
- * See LICENSE.md in the project root for license terms and full copyright notice.
4
- *--------------------------------------------------------------------------------------------*/
5
- /** @packageDocumentation
6
- * @module Frontstage
7
- */
8
- import { InternalFrontstageManager as internal } from "./InternalFrontstageManager";
9
- /** Frontstage Manager class.
10
- * @public
11
- * @deprecated in 3.7. Use `UiFramework.frontstages` property.
12
- */
13
- export class FrontstageManager {
14
- /** Initializes the InternalFrontstageManager
15
- * @deprecated in 3.7. This is called internally.
16
- */
17
- static initialize() {
18
- internal.initialize();
19
- }
20
- /** This should only be called within InternalFrontstageManager and its tests.
21
- * @internal
22
- */
23
- static ensureToolInformationIsSet(toolId) {
24
- return internal.ensureToolInformationIsSet(toolId);
25
- }
26
- /** @internal */
27
- static get isInitialized() { return internal.isInitialized; }
28
- static set isInitialized(v) { internal.isInitialized = v; }
29
- /** Returns true if Frontstage is loading its controls. If false the Frontstage content and controls have been created. */
30
- static get isLoading() { return internal.isLoading; }
31
- /** @internal */
32
- static get nineZoneSize() { return internal.nineZoneSize; }
33
- static set nineZoneSize(size) {
34
- internal.nineZoneSize = size;
35
- }
36
- /** @internal */
37
- static get frontstageDefs() {
38
- return internal.frontstageDefs;
39
- }
40
- /** Get Frontstage Deactivated event. */
41
- static get onFrontstageDeactivatedEvent() { return internal.onFrontstageDeactivatedEvent; }
42
- /** Get Frontstage Activated event. */
43
- static get onFrontstageActivatedEvent() { return internal.onFrontstageActivatedEvent; }
44
- /** Get Frontstage Activated event. */
45
- static get onFrontstageReadyEvent() { return internal.onFrontstageReadyEvent; }
46
- /** Get Modal Frontstage Changed event. */
47
- static get onModalFrontstageChangedEvent() { return internal.onModalFrontstageChangedEvent; }
48
- /** Get Modal Frontstage Closed event. */
49
- static get onModalFrontstageClosedEvent() { return internal.onModalFrontstageClosedEvent; }
50
- /** Get Modal Frontstage Requested Closed event.
51
- * @alpha
52
- */
53
- static get onCloseModalFrontstageRequestedEvent() { return internal.onCloseModalFrontstageRequestedEvent; }
54
- /** Get Tool Activated event. */
55
- static get onToolActivatedEvent() { return internal.onToolActivatedEvent; }
56
- /** Get ToolSetting Reload event. */
57
- static get onToolSettingsReloadEvent() { return internal.onToolSettingsReloadEvent; }
58
- /** Get Tool Panel Opened event.
59
- * @internal
60
- */
61
- static get onToolPanelOpenedEvent() { return internal.onToolPanelOpenedEvent; }
62
- /** Get Tool Icon Changed event. */
63
- static get onToolIconChangedEvent() { return internal.onToolIconChangedEvent; }
64
- /** Get Content Layout Activated event. */
65
- static get onContentLayoutActivatedEvent() { return internal.onContentLayoutActivatedEvent; }
66
- /** Get Content Control Activated event. */
67
- static get onContentControlActivatedEvent() { return internal.onContentControlActivatedEvent; }
68
- /** Get Navigation Aid Activated event. */
69
- static get onNavigationAidActivatedEvent() { return internal.onNavigationAidActivatedEvent; }
70
- /** Get Widget State Changed event. */
71
- static get onWidgetStateChangedEvent() { return internal.onWidgetStateChangedEvent; }
72
- /** @internal */
73
- static get onWidgetLabelChangedEvent() { return internal.onWidgetLabelChangedEvent; }
74
- /** @internal */
75
- static get onWidgetShowEvent() { return internal.onWidgetShowEvent; }
76
- /** @internal */
77
- static get onWidgetExpandEvent() { return internal.onWidgetExpandEvent; }
78
- /** @internal */
79
- static get onWidgetDefsUpdatedEvent() { return internal.onWidgetDefsUpdatedEvent; }
80
- /** @internal */
81
- static get onFrontstageNineZoneStateChangedEvent() { return internal.onFrontstageNineZoneStateChangedEvent; }
82
- /** @internal */
83
- static get onFrontstageRestoreLayoutEvent() { return internal.onFrontstageRestoreLayoutEvent; }
84
- /** Get Widget State Changed event.
85
- * @alpha
86
- */
87
- static get onPanelStateChangedEvent() { return internal.onPanelStateChangedEvent; }
88
- /** @internal */
89
- static get onPanelSizeChangedEvent() { return internal.onPanelSizeChangedEvent; }
90
- /** Clears the Frontstage map.
91
- */
92
- static clearFrontstageDefs() {
93
- return internal.clearFrontstageDefs();
94
- }
95
- /** Clears the Frontstage Providers and the defs that may have been created from them.
96
- */
97
- static clearFrontstageProviders() {
98
- return internal.clearFrontstageProviders();
99
- }
100
- /** @internal */
101
- static clearFrontstageDefsForIModelId(iModelId) {
102
- return internal.clearFrontstageDefsForIModelId(iModelId);
103
- }
104
- /** Add a Frontstage via a [[FrontstageProvider]].
105
- * @param frontstageProvider FrontstageProvider representing the Frontstage to add
106
- */
107
- static addFrontstageProvider(frontstageProvider) {
108
- return internal.addFrontstageProvider(frontstageProvider);
109
- }
110
- /** Find a loaded Frontstage with a given id. If the id is not provided, the active Frontstage is returned. If
111
- * no cached FrontstageDef is found but a FrontstageProvider is registered a FrontstageDef will be created, cached, and
112
- * returned.
113
- * @param id Id of the Frontstage to find
114
- * @returns FrontstageDef with a given id if found, or undefined if not found.
115
- */
116
- static async getFrontstageDef(id) {
117
- return internal.getFrontstageDef(id);
118
- }
119
- /** Gets the active FrontstageDef. If a Frontstage is not active, undefined is returned.
120
- * @return Active FrontstageDef, or undefined if one is not active.
121
- */
122
- static get activeFrontstageDef() {
123
- return internal.activeFrontstageDef;
124
- }
125
- /** Gets the Id of the active FrontstageDef. If a Frontstage is not active, blank is returned.
126
- * @return Id of the active FrontstageDef, or blank if one is not active.
127
- */
128
- static get activeFrontstageId() {
129
- return internal.activeFrontstageId;
130
- }
131
- static hasFrontstage(frontstageId) {
132
- return internal.hasFrontstage(frontstageId);
133
- }
134
- /** Sets the active FrontstageDef give the stageId.
135
- * @param frontstageId Id of the Frontstage to set active.
136
- * @returns A Promise that is fulfilled when the [[Frontstage]] is ready.
137
- */
138
- static async setActiveFrontstage(frontstageId) {
139
- return internal.setActiveFrontstage(frontstageId);
140
- }
141
- /** Sets the active FrontstageDef.
142
- * @param frontstageDef FrontstageDef to set active.
143
- * @returns A Promise that is fulfilled when the [[FrontstageDef]] is ready.
144
- */
145
- static async setActiveFrontstageDef(frontstageDef) {
146
- return internal.setActiveFrontstageDef(frontstageDef);
147
- }
148
- /** Deactivates the active FrontstageDef.
149
- */
150
- static async deactivateFrontstageDef() {
151
- return internal.deactivateFrontstageDef();
152
- }
153
- /** Gets the Id of the active tool. If a tool is not active, blank is returned.
154
- * @return Id of the active tool, or blank if one is not active.
155
- */
156
- static get activeToolId() {
157
- return internal.activeToolId;
158
- }
159
- /** Sets the active tool id */
160
- static setActiveToolId(toolId) {
161
- return internal.setActiveToolId(toolId);
162
- }
163
- /** Sets the active tool */
164
- static setActiveTool(tool) {
165
- return internal.setActiveTool(tool);
166
- }
167
- /** Gets the active tool's [[ToolInformation]] */
168
- static get activeToolInformation() {
169
- return internal.activeToolInformation;
170
- }
171
- /** Gets the Tool Setting React node of the active tool.
172
- * @return Tool Setting React node of the active tool, or undefined if there is no active tool or Tool Settings for the active tool.
173
- * @internal
174
- */
175
- static get activeToolSettingsProvider() {
176
- return internal.activeToolSettingsProvider;
177
- }
178
- /** Sets the active layout, content group and active content.
179
- * @param contentLayoutDef Content layout to make active
180
- * @param contentGroup Content Group to make active
181
- */
182
- static async setActiveLayout(contentLayoutDef, contentGroup) {
183
- return internal.setActiveLayout(contentLayoutDef, contentGroup);
184
- }
185
- /** Sets the active layout, content group and active content.
186
- * @param contentGroup Content Group to make active
187
- */
188
- static async setActiveContentGroup(contentGroup) {
189
- return internal.setActiveContentGroup(contentGroup);
190
- }
191
- /** Opens a modal Frontstage. Modal Frontstages can be stacked.
192
- * @param modalFrontstage Information about the modal Frontstage
193
- */
194
- static openModalFrontstage(modalFrontstage) {
195
- return internal.openModalFrontstage(modalFrontstage);
196
- }
197
- /** Closes the top-most modal Frontstage.
198
- */
199
- static closeModalFrontstage() {
200
- return internal.closeModalFrontstage();
201
- }
202
- /** Updates the top-most modal Frontstage.
203
- */
204
- static updateModalFrontstage() {
205
- return internal.updateModalFrontstage();
206
- }
207
- /** Gets the top-most modal Frontstage.
208
- * @returns Top-most modal Frontstage, or undefined if there is none.
209
- */
210
- static get activeModalFrontstage() {
211
- return internal.activeModalFrontstage;
212
- }
213
- /** Gets the number of modal Frontstages.
214
- * @returns Modal Frontstage count
215
- */
216
- static get modalFrontstageCount() {
217
- return internal.modalFrontstageCount;
218
- }
219
- /** Sets the active Navigation Aid via its Id.
220
- * @param navigationAidId Id of the Navigation Aid to set as active
221
- * @param iModelConnection IModelConnection to query for view data
222
- */
223
- static setActiveNavigationAid(navigationAidId, iModelConnection) {
224
- return internal.setActiveNavigationAid(navigationAidId, iModelConnection);
225
- }
226
- /** Sets the state of the widget with the given id
227
- * @param widgetId Id of the Widget for which to set the state
228
- * @param state New state of the widget
229
- * @returns true if the widget state was set successfully, or false if not.
230
- */
231
- static setWidgetState(widgetId, state) {
232
- return internal.setWidgetState(widgetId, state);
233
- }
234
- /** Finds a widget with the given id in the active frontstage
235
- * @param widgetId Id of the Widget to find
236
- * @returns The WidgetDef with the given id, or undefined if not found.
237
- */
238
- static findWidget(widgetId) {
239
- return internal.findWidget(widgetId);
240
- }
241
- /** Opens a nested Frontstage. Nested Frontstages can be stacked.
242
- * @param nestedFrontstage Information about the nested Frontstage
243
- */
244
- static async openNestedFrontstage(nestedFrontstage) {
245
- return internal.openNestedFrontstage(nestedFrontstage);
246
- }
247
- /** Closes the top-most nested Frontstage.
248
- */
249
- static async closeNestedFrontstage() {
250
- return internal.closeNestedFrontstage();
251
- }
252
- /** Gets the top-most nested Frontstage.
253
- * @returns Top-most nested Frontstage, or undefined if there is none.
254
- */
255
- static get activeNestedFrontstage() {
256
- return internal.activeNestedFrontstage;
257
- }
258
- /** Gets the number of nested Frontstages.
259
- * @returns Nested Frontstage count
260
- */
261
- static get nestedFrontstageCount() {
262
- return internal.nestedFrontstageCount;
263
- }
264
- }
265
- //# sourceMappingURL=FrontstageManager.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"FrontstageManager.js","sourceRoot":"","sources":["../../../../src/appui-react/frontstage/FrontstageManager.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAYH,OAAO,EAAE,yBAAyB,IAAI,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AAEpF;;;GAGG;AACH,MAAM,OAAO,iBAAiB;IAC5B;;MAEE;IACK,MAAM,CAAC,UAAU;QACtB,QAAQ,CAAC,UAAU,EAAE,CAAC;IACxB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,0BAA0B,CAAC,MAAc;QACrD,OAAO,QAAQ,CAAC,0BAA0B,CAAC,MAAM,CAAC,CAAC;IACrD,CAAC;IAED,gBAAgB;IACT,MAAM,KAAK,aAAa,KAAc,OAAO,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAC;IACtE,MAAM,KAAK,aAAa,CAAC,CAAU,IAAI,QAAQ,CAAC,aAAa,GAAG,CAAC,CAAC,CAAC,CAAC;IAE3E,0HAA0H;IACnH,MAAM,KAAK,SAAS,KAAc,OAAO,QAAQ,CAAC,SAAS,CAAC,CAAC,CAAC;IAErE,gBAAgB;IACT,MAAM,KAAK,YAAY,KAAK,OAAO,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC;IAE3D,MAAM,KAAK,YAAY,CAAC,IAAI;QACjC,QAAQ,CAAC,YAAY,GAAG,IAAI,CAAC;IAC/B,CAAC;IAED,gBAAgB;IACT,MAAM,KAAK,cAAc;QAC9B,OAAO,QAAQ,CAAC,cAAc,CAAC;IACjC,CAAC;IAED,wCAAwC;IACjC,MAAM,KAAK,4BAA4B,KAAK,OAAO,QAAQ,CAAC,4BAA4B,CAAC,CAAC,CAAC;IAElG,sCAAsC;IAC/B,MAAM,KAAK,0BAA0B,KAAK,OAAO,QAAQ,CAAC,0BAA0B,CAAC,CAAC,CAAC;IAE9F,sCAAsC;IAC/B,MAAM,KAAK,sBAAsB,KAAK,OAAO,QAAQ,CAAC,sBAAsB,CAAC,CAAC,CAAC;IAEtF,0CAA0C;IACnC,MAAM,KAAK,6BAA6B,KAAK,OAAO,QAAQ,CAAC,6BAA6B,CAAC,CAAC,CAAC;IAEpG,yCAAyC;IAClC,MAAM,KAAK,4BAA4B,KAAK,OAAO,QAAQ,CAAC,4BAA4B,CAAC,CAAC,CAAC;IAElG;;SAEK;IACE,MAAM,KAAK,oCAAoC,KAAK,OAAO,QAAQ,CAAC,oCAAoC,CAAC,CAAC,CAAC;IAElH,gCAAgC;IACzB,MAAM,KAAK,oBAAoB,KAAK,OAAO,QAAQ,CAAC,oBAAoB,CAAC,CAAC,CAAC;IAElF,oCAAoC;IAC7B,MAAM,KAAK,yBAAyB,KAAK,OAAO,QAAQ,CAAC,yBAAyB,CAAC,CAAC,CAAC;IAE5F;;SAEK;IACE,MAAM,KAAK,sBAAsB,KAAK,OAAO,QAAQ,CAAC,sBAAsB,CAAC,CAAC,CAAC;IAEtF,mCAAmC;IAC5B,MAAM,KAAK,sBAAsB,KAAK,OAAO,QAAQ,CAAC,sBAAsB,CAAC,CAAC,CAAC;IAEtF,0CAA0C;IACnC,MAAM,KAAK,6BAA6B,KAAK,OAAO,QAAQ,CAAC,6BAA6B,CAAC,CAAC,CAAC;IAEpG,2CAA2C;IACpC,MAAM,KAAK,8BAA8B,KAAK,OAAO,QAAQ,CAAC,8BAA8B,CAAC,CAAC,CAAC;IAEtG,0CAA0C;IACnC,MAAM,KAAK,6BAA6B,KAAK,OAAO,QAAQ,CAAC,6BAA6B,CAAC,CAAC,CAAC;IAEpG,sCAAsC;IAC/B,MAAM,KAAK,yBAAyB,KAAK,OAAO,QAAQ,CAAC,yBAAyB,CAAC,CAAC,CAAC;IAE5F,gBAAgB;IACT,MAAM,KAAK,yBAAyB,KAAK,OAAO,QAAQ,CAAC,yBAAyB,CAAC,CAAC,CAAC;IAE5F,gBAAgB;IACT,MAAM,KAAK,iBAAiB,KAAK,OAAO,QAAQ,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAE5E,gBAAgB;IACT,MAAM,KAAK,mBAAmB,KAAK,OAAO,QAAQ,CAAC,mBAAmB,CAAC,CAAC,CAAC;IAEhF,gBAAgB;IACT,MAAM,KAAK,wBAAwB,KAAK,OAAO,QAAQ,CAAC,wBAAwB,CAAC,CAAC,CAAC;IAE1F,gBAAgB;IACT,MAAM,KAAK,qCAAqC,KAAK,OAAO,QAAQ,CAAC,qCAAqC,CAAC,CAAC,CAAC;IAEpH,gBAAgB;IACT,MAAM,KAAK,8BAA8B,KAAK,OAAO,QAAQ,CAAC,8BAA8B,CAAC,CAAC,CAAC;IAEtG;;SAEK;IACE,MAAM,KAAK,wBAAwB,KAAK,OAAO,QAAQ,CAAC,wBAAwB,CAAC,CAAC,CAAC;IAE1F,gBAAgB;IACT,MAAM,KAAK,uBAAuB,KAAK,OAAO,QAAQ,CAAC,uBAAuB,CAAC,CAAC,CAAC;IAExF;SACK;IACE,MAAM,CAAC,mBAAmB;QAC/B,OAAO,QAAQ,CAAC,mBAAmB,EAAE,CAAC;IACxC,CAAC;IAED;SACK;IACE,MAAM,CAAC,wBAAwB;QACpC,OAAO,QAAQ,CAAC,wBAAwB,EAAE,CAAC;IAC7C,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,8BAA8B,CAAC,QAA4B;QACvE,OAAO,QAAQ,CAAC,8BAA8B,CAAC,QAAQ,CAAC,CAAC;IAC3D,CAAC;IAED;;SAEK;IACE,MAAM,CAAC,qBAAqB,CAAC,kBAAsC;QACxE,OAAO,QAAQ,CAAC,qBAAqB,CAAC,kBAAkB,CAAC,CAAC;IAC5D,CAAC;IAED;;;;;SAKK;IACE,MAAM,CAAC,KAAK,CAAC,gBAAgB,CAAC,EAAW;QAC9C,OAAO,QAAQ,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;IACvC,CAAC;IAED;;SAEK;IACE,MAAM,KAAK,mBAAmB;QACnC,OAAO,QAAQ,CAAC,mBAAmB,CAAC;IACtC,CAAC;IAED;;SAEK;IACE,MAAM,KAAK,kBAAkB;QAClC,OAAO,QAAQ,CAAC,kBAAkB,CAAC;IACrC,CAAC;IAEM,MAAM,CAAC,aAAa,CAAC,YAAoB;QAC9C,OAAO,QAAQ,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;IAC9C,CAAC;IAED;;;SAGK;IACE,MAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC,YAAoB;QAC1D,OAAO,QAAQ,CAAC,mBAAmB,CAAC,YAAY,CAAC,CAAC;IACpD,CAAC;IAED;;;SAGK;IACE,MAAM,CAAC,KAAK,CAAC,sBAAsB,CAAC,aAAwC;QACjF,OAAO,QAAQ,CAAC,sBAAsB,CAAC,aAAa,CAAC,CAAC;IACxD,CAAC;IAED;SACK;IACE,MAAM,CAAC,KAAK,CAAC,uBAAuB;QACzC,OAAO,QAAQ,CAAC,uBAAuB,EAAE,CAAC;IAC5C,CAAC;IAED;;SAEK;IACE,MAAM,KAAK,YAAY;QAC5B,OAAO,QAAQ,CAAC,YAAY,CAAC;IAC/B,CAAC;IAED,8BAA8B;IACvB,MAAM,CAAC,eAAe,CAAC,MAAc;QAC1C,OAAO,QAAQ,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;IAC1C,CAAC;IAED,2BAA2B;IACpB,MAAM,CAAC,aAAa,CAAC,IAAU;QACpC,OAAO,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;IAED,iDAAiD;IAC1C,MAAM,KAAK,qBAAqB;QACrC,OAAO,QAAQ,CAAC,qBAAqB,CAAC;IACxC,CAAC;IAED;;;SAGK;IACE,MAAM,KAAK,0BAA0B;QAC1C,OAAO,QAAQ,CAAC,0BAA0B,CAAC;IAC7C,CAAC;IAED;;;SAGK;IACE,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,gBAAkC,EAAE,YAA0B;QAChG,OAAO,QAAQ,CAAC,eAAe,CAAC,gBAAgB,EAAE,YAAY,CAAC,CAAC;IAClE,CAAC;IAED;;SAEK;IACE,MAAM,CAAC,KAAK,CAAC,qBAAqB,CAAC,YAA0B;QAClE,OAAO,QAAQ,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC;IACtD,CAAC;IAED;;SAEK;IACE,MAAM,CAAC,mBAAmB,CAAC,eAAoC;QACpE,OAAO,QAAQ,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;IACvD,CAAC;IAED;SACK;IACE,MAAM,CAAC,oBAAoB;QAChC,OAAO,QAAQ,CAAC,oBAAoB,EAAE,CAAC;IACzC,CAAC;IAED;SACK;IACE,MAAM,CAAC,qBAAqB;QACjC,OAAO,QAAQ,CAAC,qBAAqB,EAAE,CAAC;IAC1C,CAAC;IAED;;SAEK;IACE,MAAM,KAAK,qBAAqB;QACrC,OAAO,QAAQ,CAAC,qBAAqB,CAAC;IACxC,CAAC;IAED;;SAEK;IACE,MAAM,KAAK,oBAAoB;QACpC,OAAO,QAAQ,CAAC,oBAAoB,CAAC;IACvC,CAAC;IAED;;;SAGK;IACE,MAAM,CAAC,sBAAsB,CAAC,eAAuB,EAAE,gBAAkC;QAC9F,OAAO,QAAQ,CAAC,sBAAsB,CAAC,eAAe,EAAE,gBAAgB,CAAC,CAAC;IAC5E,CAAC;IAED;;;;SAIK;IACE,MAAM,CAAC,cAAc,CAAC,QAAgB,EAAE,KAAkB;QAC/D,OAAO,QAAQ,CAAC,cAAc,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;IAClD,CAAC;IAED;;;SAGK;IACE,MAAM,CAAC,UAAU,CAAC,QAAgB;QACvC,OAAO,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IACvC,CAAC;IAED;;SAEK;IACE,MAAM,CAAC,KAAK,CAAC,oBAAoB,CAAC,gBAA+B;QACtE,OAAO,QAAQ,CAAC,oBAAoB,CAAC,gBAAgB,CAAC,CAAC;IACzD,CAAC;IAED;SACK;IACE,MAAM,CAAC,KAAK,CAAC,qBAAqB;QACvC,OAAO,QAAQ,CAAC,qBAAqB,EAAE,CAAC;IAC1C,CAAC;IAED;;SAEK;IACE,MAAM,KAAK,sBAAsB;QACtC,OAAO,QAAQ,CAAC,sBAAsB,CAAC;IACzC,CAAC;IAED;;SAEK;IACE,MAAM,KAAK,qBAAqB;QACrC,OAAO,QAAQ,CAAC,qBAAqB,CAAC;IACxC,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Frontstage\r\n */\r\n\r\nimport { IModelConnection, Tool } from \"@itwin/core-frontend\";\r\nimport { WidgetState } from \"../widgets/WidgetState\";\r\nimport { ContentGroup } from \"../content/ContentGroup\";\r\nimport { ContentLayoutDef } from \"../content/ContentLayout\";\r\nimport { WidgetDef } from \"../widgets/WidgetDef\";\r\nimport { ToolInformation } from \"../toolsettings/ToolInformation\";\r\nimport { ToolUiProvider } from \"../toolsettings/ToolUiProvider\";\r\nimport { FrontstageDef } from \"./FrontstageDef\";\r\nimport { FrontstageProvider } from \"./FrontstageProvider\";\r\nimport { ModalFrontstageInfo } from \"../framework/FrameworkFrontstages\";\r\nimport { InternalFrontstageManager as internal } from \"./InternalFrontstageManager\";\r\n\r\n/** Frontstage Manager class.\r\n * @public\r\n * @deprecated in 3.7. Use `UiFramework.frontstages` property.\r\n */\r\nexport class FrontstageManager {\r\n /** Initializes the InternalFrontstageManager\r\n * @deprecated in 3.7. This is called internally.\r\n */\r\n public static initialize() {\r\n internal.initialize();\r\n }\r\n\r\n /** This should only be called within InternalFrontstageManager and its tests.\r\n * @internal\r\n */\r\n public static ensureToolInformationIsSet(toolId: string): void {\r\n return internal.ensureToolInformationIsSet(toolId);\r\n }\r\n\r\n /** @internal */\r\n public static get isInitialized(): boolean { return internal.isInitialized; }\r\n public static set isInitialized(v: boolean) { internal.isInitialized = v; }\r\n\r\n /** Returns true if Frontstage is loading its controls. If false the Frontstage content and controls have been created. */\r\n public static get isLoading(): boolean { return internal.isLoading; }\r\n\r\n /** @internal */\r\n public static get nineZoneSize() { return internal.nineZoneSize; }\r\n\r\n public static set nineZoneSize(size) {\r\n internal.nineZoneSize = size;\r\n }\r\n\r\n /** @internal */\r\n public static get frontstageDefs(): ReadonlyMap<string, FrontstageDef> {\r\n return internal.frontstageDefs;\r\n }\r\n\r\n /** Get Frontstage Deactivated event. */\r\n public static get onFrontstageDeactivatedEvent() { return internal.onFrontstageDeactivatedEvent; }\r\n\r\n /** Get Frontstage Activated event. */\r\n public static get onFrontstageActivatedEvent() { return internal.onFrontstageActivatedEvent; }\r\n\r\n /** Get Frontstage Activated event. */\r\n public static get onFrontstageReadyEvent() { return internal.onFrontstageReadyEvent; }\r\n\r\n /** Get Modal Frontstage Changed event. */\r\n public static get onModalFrontstageChangedEvent() { return internal.onModalFrontstageChangedEvent; }\r\n\r\n /** Get Modal Frontstage Closed event. */\r\n public static get onModalFrontstageClosedEvent() { return internal.onModalFrontstageClosedEvent; }\r\n\r\n /** Get Modal Frontstage Requested Closed event.\r\n * @alpha\r\n */\r\n public static get onCloseModalFrontstageRequestedEvent() { return internal.onCloseModalFrontstageRequestedEvent; }\r\n\r\n /** Get Tool Activated event. */\r\n public static get onToolActivatedEvent() { return internal.onToolActivatedEvent; }\r\n\r\n /** Get ToolSetting Reload event. */\r\n public static get onToolSettingsReloadEvent() { return internal.onToolSettingsReloadEvent; }\r\n\r\n /** Get Tool Panel Opened event.\r\n * @internal\r\n */\r\n public static get onToolPanelOpenedEvent() { return internal.onToolPanelOpenedEvent; }\r\n\r\n /** Get Tool Icon Changed event. */\r\n public static get onToolIconChangedEvent() { return internal.onToolIconChangedEvent; }\r\n\r\n /** Get Content Layout Activated event. */\r\n public static get onContentLayoutActivatedEvent() { return internal.onContentLayoutActivatedEvent; }\r\n\r\n /** Get Content Control Activated event. */\r\n public static get onContentControlActivatedEvent() { return internal.onContentControlActivatedEvent; }\r\n\r\n /** Get Navigation Aid Activated event. */\r\n public static get onNavigationAidActivatedEvent() { return internal.onNavigationAidActivatedEvent; }\r\n\r\n /** Get Widget State Changed event. */\r\n public static get onWidgetStateChangedEvent() { return internal.onWidgetStateChangedEvent; }\r\n\r\n /** @internal */\r\n public static get onWidgetLabelChangedEvent() { return internal.onWidgetLabelChangedEvent; }\r\n\r\n /** @internal */\r\n public static get onWidgetShowEvent() { return internal.onWidgetShowEvent; }\r\n\r\n /** @internal */\r\n public static get onWidgetExpandEvent() { return internal.onWidgetExpandEvent; }\r\n\r\n /** @internal */\r\n public static get onWidgetDefsUpdatedEvent() { return internal.onWidgetDefsUpdatedEvent; }\r\n\r\n /** @internal */\r\n public static get onFrontstageNineZoneStateChangedEvent() { return internal.onFrontstageNineZoneStateChangedEvent; }\r\n\r\n /** @internal */\r\n public static get onFrontstageRestoreLayoutEvent() { return internal.onFrontstageRestoreLayoutEvent; }\r\n\r\n /** Get Widget State Changed event.\r\n * @alpha\r\n */\r\n public static get onPanelStateChangedEvent() { return internal.onPanelStateChangedEvent; }\r\n\r\n /** @internal */\r\n public static get onPanelSizeChangedEvent() { return internal.onPanelSizeChangedEvent; }\r\n\r\n /** Clears the Frontstage map.\r\n */\r\n public static clearFrontstageDefs(): void {\r\n return internal.clearFrontstageDefs();\r\n }\r\n\r\n /** Clears the Frontstage Providers and the defs that may have been created from them.\r\n */\r\n public static clearFrontstageProviders(): void {\r\n return internal.clearFrontstageProviders();\r\n }\r\n\r\n /** @internal */\r\n public static clearFrontstageDefsForIModelId(iModelId: string | undefined) {\r\n return internal.clearFrontstageDefsForIModelId(iModelId);\r\n }\r\n\r\n /** Add a Frontstage via a [[FrontstageProvider]].\r\n * @param frontstageProvider FrontstageProvider representing the Frontstage to add\r\n */\r\n public static addFrontstageProvider(frontstageProvider: FrontstageProvider): void {\r\n return internal.addFrontstageProvider(frontstageProvider);\r\n }\r\n\r\n /** Find a loaded Frontstage with a given id. If the id is not provided, the active Frontstage is returned. If\r\n * no cached FrontstageDef is found but a FrontstageProvider is registered a FrontstageDef will be created, cached, and\r\n * returned.\r\n * @param id Id of the Frontstage to find\r\n * @returns FrontstageDef with a given id if found, or undefined if not found.\r\n */\r\n public static async getFrontstageDef(id?: string): Promise<FrontstageDef | undefined> {\r\n return internal.getFrontstageDef(id);\r\n }\r\n\r\n /** Gets the active FrontstageDef. If a Frontstage is not active, undefined is returned.\r\n * @return Active FrontstageDef, or undefined if one is not active.\r\n */\r\n public static get activeFrontstageDef(): FrontstageDef | undefined {\r\n return internal.activeFrontstageDef;\r\n }\r\n\r\n /** Gets the Id of the active FrontstageDef. If a Frontstage is not active, blank is returned.\r\n * @return Id of the active FrontstageDef, or blank if one is not active.\r\n */\r\n public static get activeFrontstageId(): string {\r\n return internal.activeFrontstageId;\r\n }\r\n\r\n public static hasFrontstage(frontstageId: string) {\r\n return internal.hasFrontstage(frontstageId);\r\n }\r\n\r\n /** Sets the active FrontstageDef give the stageId.\r\n * @param frontstageId Id of the Frontstage to set active.\r\n * @returns A Promise that is fulfilled when the [[Frontstage]] is ready.\r\n */\r\n public static async setActiveFrontstage(frontstageId: string): Promise<void> {\r\n return internal.setActiveFrontstage(frontstageId);\r\n }\r\n\r\n /** Sets the active FrontstageDef.\r\n * @param frontstageDef FrontstageDef to set active.\r\n * @returns A Promise that is fulfilled when the [[FrontstageDef]] is ready.\r\n */\r\n public static async setActiveFrontstageDef(frontstageDef: FrontstageDef | undefined): Promise<void> {\r\n return internal.setActiveFrontstageDef(frontstageDef);\r\n }\r\n\r\n /** Deactivates the active FrontstageDef.\r\n */\r\n public static async deactivateFrontstageDef(): Promise<void> {\r\n return internal.deactivateFrontstageDef();\r\n }\r\n\r\n /** Gets the Id of the active tool. If a tool is not active, blank is returned.\r\n * @return Id of the active tool, or blank if one is not active.\r\n */\r\n public static get activeToolId(): string {\r\n return internal.activeToolId;\r\n }\r\n\r\n /** Sets the active tool id */\r\n public static setActiveToolId(toolId: string): void {\r\n return internal.setActiveToolId(toolId);\r\n }\r\n\r\n /** Sets the active tool */\r\n public static setActiveTool(tool: Tool): void {\r\n return internal.setActiveTool(tool);\r\n }\r\n\r\n /** Gets the active tool's [[ToolInformation]] */\r\n public static get activeToolInformation(): ToolInformation | undefined {\r\n return internal.activeToolInformation;\r\n }\r\n\r\n /** Gets the Tool Setting React node of the active tool.\r\n * @return Tool Setting React node of the active tool, or undefined if there is no active tool or Tool Settings for the active tool.\r\n * @internal\r\n */\r\n public static get activeToolSettingsProvider(): ToolUiProvider | undefined {\r\n return internal.activeToolSettingsProvider;\r\n }\r\n\r\n /** Sets the active layout, content group and active content.\r\n * @param contentLayoutDef Content layout to make active\r\n * @param contentGroup Content Group to make active\r\n */\r\n public static async setActiveLayout(contentLayoutDef: ContentLayoutDef, contentGroup: ContentGroup): Promise<void> {\r\n return internal.setActiveLayout(contentLayoutDef, contentGroup);\r\n }\r\n\r\n /** Sets the active layout, content group and active content.\r\n * @param contentGroup Content Group to make active\r\n */\r\n public static async setActiveContentGroup(contentGroup: ContentGroup): Promise<void> {\r\n return internal.setActiveContentGroup(contentGroup);\r\n }\r\n\r\n /** Opens a modal Frontstage. Modal Frontstages can be stacked.\r\n * @param modalFrontstage Information about the modal Frontstage\r\n */\r\n public static openModalFrontstage(modalFrontstage: ModalFrontstageInfo): void {\r\n return internal.openModalFrontstage(modalFrontstage);\r\n }\r\n\r\n /** Closes the top-most modal Frontstage.\r\n */\r\n public static closeModalFrontstage(): void {\r\n return internal.closeModalFrontstage();\r\n }\r\n\r\n /** Updates the top-most modal Frontstage.\r\n */\r\n public static updateModalFrontstage(): void {\r\n return internal.updateModalFrontstage();\r\n }\r\n\r\n /** Gets the top-most modal Frontstage.\r\n * @returns Top-most modal Frontstage, or undefined if there is none.\r\n */\r\n public static get activeModalFrontstage(): ModalFrontstageInfo | undefined {\r\n return internal.activeModalFrontstage;\r\n }\r\n\r\n /** Gets the number of modal Frontstages.\r\n * @returns Modal Frontstage count\r\n */\r\n public static get modalFrontstageCount(): number {\r\n return internal.modalFrontstageCount;\r\n }\r\n\r\n /** Sets the active Navigation Aid via its Id.\r\n * @param navigationAidId Id of the Navigation Aid to set as active\r\n * @param iModelConnection IModelConnection to query for view data\r\n */\r\n public static setActiveNavigationAid(navigationAidId: string, iModelConnection: IModelConnection) {\r\n return internal.setActiveNavigationAid(navigationAidId, iModelConnection);\r\n }\r\n\r\n /** Sets the state of the widget with the given id\r\n * @param widgetId Id of the Widget for which to set the state\r\n * @param state New state of the widget\r\n * @returns true if the widget state was set successfully, or false if not.\r\n */\r\n public static setWidgetState(widgetId: string, state: WidgetState): boolean {\r\n return internal.setWidgetState(widgetId, state);\r\n }\r\n\r\n /** Finds a widget with the given id in the active frontstage\r\n * @param widgetId Id of the Widget to find\r\n * @returns The WidgetDef with the given id, or undefined if not found.\r\n */\r\n public static findWidget(widgetId: string): WidgetDef | undefined {\r\n return internal.findWidget(widgetId);\r\n }\r\n\r\n /** Opens a nested Frontstage. Nested Frontstages can be stacked.\r\n * @param nestedFrontstage Information about the nested Frontstage\r\n */\r\n public static async openNestedFrontstage(nestedFrontstage: FrontstageDef): Promise<void> {\r\n return internal.openNestedFrontstage(nestedFrontstage);\r\n }\r\n\r\n /** Closes the top-most nested Frontstage.\r\n */\r\n public static async closeNestedFrontstage(): Promise<void> {\r\n return internal.closeNestedFrontstage();\r\n }\r\n\r\n /** Gets the top-most nested Frontstage.\r\n * @returns Top-most nested Frontstage, or undefined if there is none.\r\n */\r\n public static get activeNestedFrontstage(): FrontstageDef | undefined {\r\n return internal.activeNestedFrontstage;\r\n }\r\n\r\n /** Gets the number of nested Frontstages.\r\n * @returns Nested Frontstage count\r\n */\r\n public static get nestedFrontstageCount(): number {\r\n return internal.nestedFrontstageCount;\r\n }\r\n}\r\n"]}
@@ -1,44 +0,0 @@
1
- /** @packageDocumentation
2
- * @module ToolSettings
3
- */
4
- import { InteractiveTool } from "@itwin/core-frontend";
5
- import { DialogItem, UiEvent } from "@itwin/appui-abstract";
6
- import { SyncToolSettingsPropertiesEvent } from "../framework/FrameworkToolSettings";
7
- /** Tool Settings Manager class. Used to generate UI components for Tool Settings.
8
- * @public
9
- * @deprecated in 3.7. Use `UiFramework.toolSettings` property.
10
- */
11
- export declare class ToolSettingsManager {
12
- /** Initializes the ToolSettingsManager
13
- * @deprecated in 3.7. This is called internally.
14
- */
15
- static initialize(): void;
16
- /** clear cached Tool Settings properties. */
17
- static clearToolSettingsData(): void;
18
- /** Cache Tool Settings properties */
19
- static initializeToolSettingsData(toolSettingsProperties: DialogItem[] | undefined, toolId?: string, toolLabel?: string, toolDescription?: string): boolean;
20
- /** Set of data used in Tool Settings for the specified tool. The tool specified should be the "active" tool.
21
- */
22
- static initializeDataForTool(tool: InteractiveTool): void;
23
- /** Returns the toolSettings properties that can be used to populate the tool settings widget. */
24
- static get toolSettingsProperties(): DialogItem[];
25
- /** Returns true if the Tool Settings are to be auto populated from the toolSettingsProperties.
26
- * The setter is chiefly for testing.
27
- */
28
- static get useDefaultToolSettingsProvider(): boolean;
29
- static set useDefaultToolSettingsProvider(useDefaultToolSettings: boolean);
30
- /** The name of the active tool. This is typically the flyover text specified for the tool. */
31
- static get activeToolLabel(): string;
32
- static set activeToolLabel(label: string);
33
- /** Returns the description of the active tool. */
34
- static get activeToolDescription(): string;
35
- /** Get ToolSettings Properties sync event. */
36
- static get onSyncToolSettingsProperties(): SyncToolSettingsPropertiesEvent;
37
- static get onReloadToolSettingsProperties(): UiEvent<void>;
38
- /** Gets the Id of the active tool. If a tool is not active, blank is returned.
39
- * @return Id of the active tool, or blank if one is not active.
40
- */
41
- static get toolIdForToolSettings(): string;
42
- static focusIntoToolSettings(): boolean;
43
- }
44
- //# sourceMappingURL=ToolSettingsManager.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"ToolSettingsManager.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/toolsettings/ToolSettingsManager.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AACvD,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAC5D,OAAO,EAAE,+BAA+B,EAAE,MAAM,oCAAoC,CAAC;AAGrF;;;GAGG;AACH,qBAAa,mBAAmB;IAC9B;;OAEG;WACW,UAAU;IAIxB,6CAA6C;WAC/B,qBAAqB;IAInC,qCAAqC;WACvB,0BAA0B,CAAC,sBAAsB,EAAE,UAAU,EAAE,GAAG,SAAS,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,eAAe,CAAC,EAAE,MAAM,GAAG,OAAO;IAIlK;OACG;WACW,qBAAqB,CAAC,IAAI,EAAE,eAAe,GAAG,IAAI;IAIhE,iGAAiG;IACjG,WAAkB,sBAAsB,IAAI,UAAU,EAAE,CAEvD;IAED;;OAEG;IACH,WAAkB,8BAA8B,IAAI,OAAO,CAAoD;IAC/G,WAAkB,8BAA8B,CAAC,sBAAsB,EAAE,OAAO,EAAuE;IAEvJ,8FAA8F;IAC9F,WAAkB,eAAe,IAAI,MAAM,CAAqC;IAChF,WAAkB,eAAe,CAAC,KAAK,EAAE,MAAM,EAAuC;IAEtF,kDAAkD;IAClD,WAAkB,qBAAqB,IAAI,MAAM,CAA2C;IAE5F,8CAA8C;IAC9C,WAAkB,4BAA4B,IAAI,+BAA+B,CAAkD;IACnI,WAAkB,8BAA8B,IAAI,OAAO,CAAC,IAAI,CAAC,CAAoD;IAErH;;OAEG;IACH,WAAkB,qBAAqB,IAAI,MAAM,CAEhD;WAEa,qBAAqB,IAAI,OAAO;CAG/C"}
@@ -1,60 +0,0 @@
1
- /*---------------------------------------------------------------------------------------------
2
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
3
- * See LICENSE.md in the project root for license terms and full copyright notice.
4
- *--------------------------------------------------------------------------------------------*/
5
- /** @packageDocumentation
6
- * @module ToolSettings
7
- */
8
- import { InternalToolSettingsManager as internal } from "./InternalToolSettingsManager";
9
- /** Tool Settings Manager class. Used to generate UI components for Tool Settings.
10
- * @public
11
- * @deprecated in 3.7. Use `UiFramework.toolSettings` property.
12
- */
13
- export class ToolSettingsManager {
14
- /** Initializes the ToolSettingsManager
15
- * @deprecated in 3.7. This is called internally.
16
- */
17
- static initialize() {
18
- return internal.initialize();
19
- }
20
- /** clear cached Tool Settings properties. */
21
- static clearToolSettingsData() {
22
- return internal.clearToolSettingsData();
23
- }
24
- /** Cache Tool Settings properties */
25
- static initializeToolSettingsData(toolSettingsProperties, toolId, toolLabel, toolDescription) {
26
- return internal.initializeToolSettingsData(toolSettingsProperties, toolId, toolLabel, toolDescription);
27
- }
28
- /** Set of data used in Tool Settings for the specified tool. The tool specified should be the "active" tool.
29
- */
30
- static initializeDataForTool(tool) {
31
- return internal.initializeDataForTool(tool);
32
- }
33
- /** Returns the toolSettings properties that can be used to populate the tool settings widget. */
34
- static get toolSettingsProperties() {
35
- return internal.toolSettingsProperties;
36
- }
37
- /** Returns true if the Tool Settings are to be auto populated from the toolSettingsProperties.
38
- * The setter is chiefly for testing.
39
- */
40
- static get useDefaultToolSettingsProvider() { return internal.useDefaultToolSettingsProvider; }
41
- static set useDefaultToolSettingsProvider(useDefaultToolSettings) { internal.useDefaultToolSettingsProvider = useDefaultToolSettings; }
42
- /** The name of the active tool. This is typically the flyover text specified for the tool. */
43
- static get activeToolLabel() { return internal.activeToolLabel; }
44
- static set activeToolLabel(label) { internal.activeToolLabel = label; }
45
- /** Returns the description of the active tool. */
46
- static get activeToolDescription() { return internal.activeToolDescription; }
47
- /** Get ToolSettings Properties sync event. */
48
- static get onSyncToolSettingsProperties() { return internal.onSyncToolSettingsProperties; }
49
- static get onReloadToolSettingsProperties() { return internal.onReloadToolSettingsProperties; }
50
- /** Gets the Id of the active tool. If a tool is not active, blank is returned.
51
- * @return Id of the active tool, or blank if one is not active.
52
- */
53
- static get toolIdForToolSettings() {
54
- return internal.toolIdForToolSettings;
55
- }
56
- static focusIntoToolSettings() {
57
- return internal.focusIntoToolSettings();
58
- }
59
- }
60
- //# sourceMappingURL=ToolSettingsManager.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"ToolSettingsManager.js","sourceRoot":"","sources":["../../../../src/appui-react/toolsettings/ToolSettingsManager.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAKH,OAAO,EAAE,2BAA2B,IAAI,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AAExF;;;GAGG;AACH,MAAM,OAAO,mBAAmB;IAC9B;;OAEG;IACI,MAAM,CAAC,UAAU;QACtB,OAAO,QAAQ,CAAC,UAAU,EAAE,CAAC;IAC/B,CAAC;IAED,6CAA6C;IACtC,MAAM,CAAC,qBAAqB;QACjC,OAAO,QAAQ,CAAC,qBAAqB,EAAE,CAAC;IAC1C,CAAC;IAED,qCAAqC;IAC9B,MAAM,CAAC,0BAA0B,CAAC,sBAAgD,EAAE,MAAe,EAAE,SAAkB,EAAE,eAAwB;QACtJ,OAAO,QAAQ,CAAC,0BAA0B,CAAC,sBAAsB,EAAE,MAAM,EAAE,SAAS,EAAE,eAAe,CAAC,CAAC;IACzG,CAAC;IAED;OACG;IACI,MAAM,CAAC,qBAAqB,CAAC,IAAqB;QACvD,OAAO,QAAQ,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;IAC9C,CAAC;IAED,iGAAiG;IAC1F,MAAM,KAAK,sBAAsB;QACtC,OAAO,QAAQ,CAAC,sBAAsB,CAAC;IACzC,CAAC;IAED;;OAEG;IACI,MAAM,KAAK,8BAA8B,KAAc,OAAO,QAAQ,CAAC,8BAA8B,CAAC,CAAC,CAAC;IACxG,MAAM,KAAK,8BAA8B,CAAC,sBAA+B,IAAI,QAAQ,CAAC,8BAA8B,GAAG,sBAAsB,CAAC,CAAC,CAAC;IAEvJ,8FAA8F;IACvF,MAAM,KAAK,eAAe,KAAa,OAAO,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAC;IACzE,MAAM,KAAK,eAAe,CAAC,KAAa,IAAI,QAAQ,CAAC,eAAe,GAAG,KAAK,CAAC,CAAC,CAAC;IAEtF,kDAAkD;IAC3C,MAAM,KAAK,qBAAqB,KAAa,OAAO,QAAQ,CAAC,qBAAqB,CAAC,CAAC,CAAC;IAE5F,8CAA8C;IACvC,MAAM,KAAK,4BAA4B,KAAsC,OAAO,QAAQ,CAAC,4BAA4B,CAAC,CAAC,CAAC;IAC5H,MAAM,KAAK,8BAA8B,KAAoB,OAAO,QAAQ,CAAC,8BAA8B,CAAC,CAAC,CAAC;IAErH;;OAEG;IACI,MAAM,KAAK,qBAAqB;QACrC,OAAO,QAAQ,CAAC,qBAAqB,CAAC;IACxC,CAAC;IAEM,MAAM,CAAC,qBAAqB;QACjC,OAAO,QAAQ,CAAC,qBAAqB,EAAE,CAAC;IAC1C,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module ToolSettings\r\n */\r\n\r\nimport { InteractiveTool } from \"@itwin/core-frontend\";\r\nimport { DialogItem, UiEvent } from \"@itwin/appui-abstract\";\r\nimport { SyncToolSettingsPropertiesEvent } from \"../framework/FrameworkToolSettings\";\r\nimport { InternalToolSettingsManager as internal } from \"./InternalToolSettingsManager\";\r\n\r\n/** Tool Settings Manager class. Used to generate UI components for Tool Settings.\r\n * @public\r\n * @deprecated in 3.7. Use `UiFramework.toolSettings` property.\r\n */\r\nexport class ToolSettingsManager {\r\n /** Initializes the ToolSettingsManager\r\n * @deprecated in 3.7. This is called internally.\r\n */\r\n public static initialize() {\r\n return internal.initialize();\r\n }\r\n\r\n /** clear cached Tool Settings properties. */\r\n public static clearToolSettingsData() {\r\n return internal.clearToolSettingsData();\r\n }\r\n\r\n /** Cache Tool Settings properties */\r\n public static initializeToolSettingsData(toolSettingsProperties: DialogItem[] | undefined, toolId?: string, toolLabel?: string, toolDescription?: string): boolean {\r\n return internal.initializeToolSettingsData(toolSettingsProperties, toolId, toolLabel, toolDescription);\r\n }\r\n\r\n /** Set of data used in Tool Settings for the specified tool. The tool specified should be the \"active\" tool.\r\n */\r\n public static initializeDataForTool(tool: InteractiveTool): void {\r\n return internal.initializeDataForTool(tool);\r\n }\r\n\r\n /** Returns the toolSettings properties that can be used to populate the tool settings widget. */\r\n public static get toolSettingsProperties(): DialogItem[] {\r\n return internal.toolSettingsProperties;\r\n }\r\n\r\n /** Returns true if the Tool Settings are to be auto populated from the toolSettingsProperties.\r\n * The setter is chiefly for testing.\r\n */\r\n public static get useDefaultToolSettingsProvider(): boolean { return internal.useDefaultToolSettingsProvider; }\r\n public static set useDefaultToolSettingsProvider(useDefaultToolSettings: boolean) { internal.useDefaultToolSettingsProvider = useDefaultToolSettings; }\r\n\r\n /** The name of the active tool. This is typically the flyover text specified for the tool. */\r\n public static get activeToolLabel(): string { return internal.activeToolLabel; }\r\n public static set activeToolLabel(label: string) { internal.activeToolLabel = label; }\r\n\r\n /** Returns the description of the active tool. */\r\n public static get activeToolDescription(): string { return internal.activeToolDescription; }\r\n\r\n /** Get ToolSettings Properties sync event. */\r\n public static get onSyncToolSettingsProperties(): SyncToolSettingsPropertiesEvent { return internal.onSyncToolSettingsProperties; }\r\n public static get onReloadToolSettingsProperties(): UiEvent<void> { return internal.onReloadToolSettingsProperties; }\r\n\r\n /** Gets the Id of the active tool. If a tool is not active, blank is returned.\r\n * @return Id of the active tool, or blank if one is not active.\r\n */\r\n public static get toolIdForToolSettings(): string {\r\n return internal.toolIdForToolSettings;\r\n }\r\n\r\n public static focusIntoToolSettings(): boolean {\r\n return internal.focusIntoToolSettings();\r\n }\r\n}\r\n"]}
@@ -1,54 +0,0 @@
1
- /** @packageDocumentation
2
- * @module Utilities
3
- */
4
- /// <reference types="react" />
5
- import { UiShowHideSettingsProvider } from "./InternalUiShowHideManager";
6
- export { UiShowHideSettingsProvider };
7
- /** Maintains Ui Show/Hide state. The `Ui` includes widgets, panels and the status bar.
8
- * @public
9
- * @deprecated in 3.7. Use `UiFramework.visibility` property.
10
- */
11
- export declare class UiShowHideManager {
12
- /** Determines if the Ui is visible */
13
- static get isUiVisible(): boolean;
14
- static set isUiVisible(visible: boolean);
15
- /** @internal */
16
- static setAutoHideUi(value: boolean): void;
17
- /** @internal */
18
- static setUseProximityOpacity(value: boolean): void;
19
- /** @internal */
20
- static setSnapWidgetOpacity(value: boolean): void;
21
- /** Determines whether the `auto-hide Ui` feature is on. Defaults to false.
22
- * When true, the Ui automatically hides after a few seconds of inactivity.
23
- */
24
- static get autoHideUi(): boolean;
25
- static set autoHideUi(autoHide: boolean);
26
- /** Determines whether the widget panels are shown and hidden. Defaults to false. */
27
- static get showHidePanels(): boolean;
28
- static set showHidePanels(showHide: boolean);
29
- /** Determines whether the status bar is shown and hidden. Defaults to false. */
30
- static get showHideFooter(): boolean;
31
- static set showHideFooter(showHide: boolean);
32
- /** Determines the amount of inactivity time before the Ui is hidden. Defaults to 3.5 seconds. */
33
- static get inactivityTime(): number;
34
- static set inactivityTime(time: number);
35
- /** Determines whether the proximity of the mouse should alter the opacity of a toolbar. Defaults to true. */
36
- static get useProximityOpacity(): boolean;
37
- static set useProximityOpacity(value: boolean);
38
- /** Determines whether the opacity of a toolbar should snap. Defaults to false. */
39
- static get snapWidgetOpacity(): boolean;
40
- static set snapWidgetOpacity(value: boolean);
41
- /** Handler for when a Frontstage is ready */
42
- static handleFrontstageReady(): void;
43
- /** Handler for when the mouse moves over the content area */
44
- static handleContentMouseMove(_event?: React.MouseEvent<HTMLElement, MouseEvent>): void;
45
- /** Handler for when the mouse enters a widget */
46
- static handleWidgetMouseEnter(_event?: React.MouseEvent<HTMLElement, MouseEvent>): void;
47
- /** Shows the Ui and resets the inactivity timer */
48
- static showUiAndResetTimer(): void;
49
- /** Shows the Ui and cancels the inactivity timer */
50
- static showUiAndCancelTimer(): void;
51
- /** @internal */
52
- static terminate(): void;
53
- }
54
- //# sourceMappingURL=UiShowHideManager.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"UiShowHideManager.d.ts","sourceRoot":"","sources":["../../../../src/appui-react/utils/UiShowHideManager.ts"],"names":[],"mappings":"AAIA;;GAEG;;AAEH,OAAO,EAAyC,0BAA0B,EAAE,MAAM,6BAA6B,CAAC;AAEhH,OAAO,EAAE,0BAA0B,EAAE,CAAC;AAEtC;;;GAGG;AACH,qBAAa,iBAAiB;IAE5B,sCAAsC;IACtC,WAAkB,WAAW,IAGU,OAAO,CAD7C;IACD,WAAkB,WAAW,CAAC,OAAO,EAAE,OAAO,EAE7C;IAED,gBAAgB;WACF,aAAa,CAAC,KAAK,EAAE,OAAO;IAI1C,gBAAgB;WACF,sBAAsB,CAAC,KAAK,EAAE,OAAO;IAInD,gBAAgB;WACF,oBAAoB,CAAC,KAAK,EAAE,OAAO;IAIjD;;OAEG;IACH,WAAkB,UAAU,IAAI,OAAO,CAEtC;IAED,WAAkB,UAAU,CAAC,QAAQ,EAAE,OAAO,EAE7C;IACD,oFAAoF;IACpF,WAAkB,cAAc,IAAI,OAAO,CAE1C;IACD,WAAkB,cAAc,CAAC,QAAQ,EAAE,OAAO,EAEjD;IAED,gFAAgF;IAChF,WAAkB,cAAc,IAAI,OAAO,CAE1C;IACD,WAAkB,cAAc,CAAC,QAAQ,EAAE,OAAO,EAEjD;IAED,iGAAiG;IACjG,WAAkB,cAAc,IAAI,MAAM,CAEzC;IACD,WAAkB,cAAc,CAAC,IAAI,EAAE,MAAM,EAE5C;IAED,6GAA6G;IAC7G,WAAkB,mBAAmB,IAAI,OAAO,CAE/C;IACD,WAAkB,mBAAmB,CAAC,KAAK,EAAE,OAAO,EAEnD;IAED,kFAAkF;IAClF,WAAkB,iBAAiB,IAAI,OAAO,CAE7C;IACD,WAAkB,iBAAiB,CAAC,KAAK,EAAE,OAAO,EAEjD;IAED,6CAA6C;WAC/B,qBAAqB;IAKnC,6DAA6D;WAC/C,sBAAsB,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,WAAW,EAAE,UAAU,CAAC;IAIvF,iDAAiD;WACnC,sBAAsB,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,WAAW,EAAE,UAAU,CAAC;IAIvF,mDAAmD;WACrC,mBAAmB;IAIjC,oDAAoD;WACtC,oBAAoB;IAIlC,gBAAgB;WACF,SAAS;CAGxB"}
@@ -1,105 +0,0 @@
1
- /*---------------------------------------------------------------------------------------------
2
- * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
3
- * See LICENSE.md in the project root for license terms and full copyright notice.
4
- *--------------------------------------------------------------------------------------------*/
5
- /** @packageDocumentation
6
- * @module Utilities
7
- */
8
- import { InternalUiShowHideManager as internal, UiShowHideSettingsProvider } from "./InternalUiShowHideManager";
9
- // reexporting to ensure no breaking changes in barrel exports, remove when removing deprecated.
10
- export { UiShowHideSettingsProvider };
11
- /** Maintains Ui Show/Hide state. The `Ui` includes widgets, panels and the status bar.
12
- * @public
13
- * @deprecated in 3.7. Use `UiFramework.visibility` property.
14
- */
15
- export class UiShowHideManager {
16
- /** Determines if the Ui is visible */
17
- static get isUiVisible() {
18
- return internal.isUiVisible;
19
- }
20
- static set isUiVisible(visible) {
21
- internal.isUiVisible = visible;
22
- }
23
- /** @internal */
24
- static setAutoHideUi(value) {
25
- return internal.setAutoHideUi(value);
26
- }
27
- /** @internal */
28
- static setUseProximityOpacity(value) {
29
- return internal.setUseProximityOpacity(value);
30
- }
31
- /** @internal */
32
- static setSnapWidgetOpacity(value) {
33
- return internal.setSnapWidgetOpacity(value);
34
- }
35
- /** Determines whether the `auto-hide Ui` feature is on. Defaults to false.
36
- * When true, the Ui automatically hides after a few seconds of inactivity.
37
- */
38
- static get autoHideUi() {
39
- return internal.autoHideUi;
40
- }
41
- static set autoHideUi(autoHide) {
42
- internal.autoHideUi = autoHide;
43
- }
44
- /** Determines whether the widget panels are shown and hidden. Defaults to false. */
45
- static get showHidePanels() {
46
- return internal.showHidePanels;
47
- }
48
- static set showHidePanels(showHide) {
49
- internal.showHidePanels = showHide;
50
- }
51
- /** Determines whether the status bar is shown and hidden. Defaults to false. */
52
- static get showHideFooter() {
53
- return internal.showHideFooter;
54
- }
55
- static set showHideFooter(showHide) {
56
- internal.showHideFooter = showHide;
57
- }
58
- /** Determines the amount of inactivity time before the Ui is hidden. Defaults to 3.5 seconds. */
59
- static get inactivityTime() {
60
- return internal.inactivityTime;
61
- }
62
- static set inactivityTime(time) {
63
- internal.inactivityTime = time;
64
- }
65
- /** Determines whether the proximity of the mouse should alter the opacity of a toolbar. Defaults to true. */
66
- static get useProximityOpacity() {
67
- return internal.useProximityOpacity;
68
- }
69
- static set useProximityOpacity(value) {
70
- internal.useProximityOpacity = value;
71
- }
72
- /** Determines whether the opacity of a toolbar should snap. Defaults to false. */
73
- static get snapWidgetOpacity() {
74
- return internal.snapWidgetOpacity;
75
- }
76
- static set snapWidgetOpacity(value) {
77
- internal.snapWidgetOpacity = value;
78
- }
79
- /** Handler for when a Frontstage is ready */
80
- static handleFrontstageReady() {
81
- // istanbul ignore next
82
- return internal.handleFrontstageReady();
83
- }
84
- /** Handler for when the mouse moves over the content area */
85
- static handleContentMouseMove(_event) {
86
- return internal.handleContentMouseMove(_event);
87
- }
88
- /** Handler for when the mouse enters a widget */
89
- static handleWidgetMouseEnter(_event) {
90
- return internal.handleWidgetMouseEnter(_event);
91
- }
92
- /** Shows the Ui and resets the inactivity timer */
93
- static showUiAndResetTimer() {
94
- return internal.showUiAndResetTimer();
95
- }
96
- /** Shows the Ui and cancels the inactivity timer */
97
- static showUiAndCancelTimer() {
98
- return internal.showUiAndCancelTimer();
99
- }
100
- /** @internal */
101
- static terminate() {
102
- return internal.terminate();
103
- }
104
- }
105
- //# sourceMappingURL=UiShowHideManager.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"UiShowHideManager.js","sourceRoot":"","sources":["../../../../src/appui-react/utils/UiShowHideManager.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,yBAAyB,IAAI,QAAQ,EAAE,0BAA0B,EAAE,MAAM,6BAA6B,CAAC;AAChH,gGAAgG;AAChG,OAAO,EAAE,0BAA0B,EAAE,CAAC;AAEtC;;;GAGG;AACH,MAAM,OAAO,iBAAiB;IAE5B,sCAAsC;IAC/B,MAAM,KAAK,WAAW;QAC3B,OAAO,QAAQ,CAAC,WAAW,CAAC;IAC9B,CAAC;IACM,MAAM,KAAK,WAAW,CAAC,OAAgB;QAC5C,QAAQ,CAAC,WAAW,GAAG,OAAO,CAAC;IACjC,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,aAAa,CAAC,KAAc;QACxC,OAAO,QAAQ,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;IACvC,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,sBAAsB,CAAC,KAAc;QACjD,OAAO,QAAQ,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;IAChD,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,oBAAoB,CAAC,KAAc;QAC/C,OAAO,QAAQ,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;IAC9C,CAAC;IAED;;OAEG;IACI,MAAM,KAAK,UAAU;QAC1B,OAAO,QAAQ,CAAC,UAAU,CAAC;IAC7B,CAAC;IAEM,MAAM,KAAK,UAAU,CAAC,QAAiB;QAC5C,QAAQ,CAAC,UAAU,GAAG,QAAQ,CAAC;IACjC,CAAC;IACD,oFAAoF;IAC7E,MAAM,KAAK,cAAc;QAC9B,OAAO,QAAQ,CAAC,cAAc,CAAC;IACjC,CAAC;IACM,MAAM,KAAK,cAAc,CAAC,QAAiB;QAChD,QAAQ,CAAC,cAAc,GAAG,QAAQ,CAAC;IACrC,CAAC;IAED,gFAAgF;IACzE,MAAM,KAAK,cAAc;QAC9B,OAAO,QAAQ,CAAC,cAAc,CAAC;IACjC,CAAC;IACM,MAAM,KAAK,cAAc,CAAC,QAAiB;QAChD,QAAQ,CAAC,cAAc,GAAG,QAAQ,CAAC;IACrC,CAAC;IAED,iGAAiG;IAC1F,MAAM,KAAK,cAAc;QAC9B,OAAO,QAAQ,CAAC,cAAc,CAAC;IACjC,CAAC;IACM,MAAM,KAAK,cAAc,CAAC,IAAY;QAC3C,QAAQ,CAAC,cAAc,GAAG,IAAI,CAAC;IACjC,CAAC;IAED,6GAA6G;IACtG,MAAM,KAAK,mBAAmB;QACnC,OAAO,QAAQ,CAAC,mBAAmB,CAAC;IACtC,CAAC;IACM,MAAM,KAAK,mBAAmB,CAAC,KAAc;QAClD,QAAQ,CAAC,mBAAmB,GAAG,KAAK,CAAC;IACvC,CAAC;IAED,kFAAkF;IAC3E,MAAM,KAAK,iBAAiB;QACjC,OAAO,QAAQ,CAAC,iBAAiB,CAAC;IACpC,CAAC;IACM,MAAM,KAAK,iBAAiB,CAAC,KAAc;QAChD,QAAQ,CAAC,iBAAiB,GAAG,KAAK,CAAC;IACrC,CAAC;IAED,6CAA6C;IACtC,MAAM,CAAC,qBAAqB;QACjC,uBAAuB;QACvB,OAAO,QAAQ,CAAC,qBAAqB,EAAE,CAAC;IAC1C,CAAC;IAED,6DAA6D;IACtD,MAAM,CAAC,sBAAsB,CAAC,MAAkD;QACrF,OAAO,QAAQ,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC;IACjD,CAAC;IAED,iDAAiD;IAC1C,MAAM,CAAC,sBAAsB,CAAC,MAAkD;QACrF,OAAO,QAAQ,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC;IACjD,CAAC;IAED,mDAAmD;IAC5C,MAAM,CAAC,mBAAmB;QAC/B,OAAO,QAAQ,CAAC,mBAAmB,EAAE,CAAC;IACxC,CAAC;IAED,oDAAoD;IAC7C,MAAM,CAAC,oBAAoB;QAChC,OAAO,QAAQ,CAAC,oBAAoB,EAAE,CAAC;IACzC,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,SAAS;QACrB,OAAO,QAAQ,CAAC,SAAS,EAAE,CAAC;IAC9B,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Utilities\r\n */\r\n\r\nimport { InternalUiShowHideManager as internal, UiShowHideSettingsProvider } from \"./InternalUiShowHideManager\";\r\n// reexporting to ensure no breaking changes in barrel exports, remove when removing deprecated.\r\nexport { UiShowHideSettingsProvider };\r\n\r\n/** Maintains Ui Show/Hide state. The `Ui` includes widgets, panels and the status bar.\r\n * @public\r\n * @deprecated in 3.7. Use `UiFramework.visibility` property.\r\n */\r\nexport class UiShowHideManager {\r\n\r\n /** Determines if the Ui is visible */\r\n public static get isUiVisible() {\r\n return internal.isUiVisible;\r\n }\r\n public static set isUiVisible(visible: boolean) {\r\n internal.isUiVisible = visible;\r\n }\r\n\r\n /** @internal */\r\n public static setAutoHideUi(value: boolean) {\r\n return internal.setAutoHideUi(value);\r\n }\r\n\r\n /** @internal */\r\n public static setUseProximityOpacity(value: boolean) {\r\n return internal.setUseProximityOpacity(value);\r\n }\r\n\r\n /** @internal */\r\n public static setSnapWidgetOpacity(value: boolean) {\r\n return internal.setSnapWidgetOpacity(value);\r\n }\r\n\r\n /** Determines whether the `auto-hide Ui` feature is on. Defaults to false.\r\n * When true, the Ui automatically hides after a few seconds of inactivity.\r\n */\r\n public static get autoHideUi(): boolean {\r\n return internal.autoHideUi;\r\n }\r\n\r\n public static set autoHideUi(autoHide: boolean) {\r\n internal.autoHideUi = autoHide;\r\n }\r\n /** Determines whether the widget panels are shown and hidden. Defaults to false. */\r\n public static get showHidePanels(): boolean {\r\n return internal.showHidePanels;\r\n }\r\n public static set showHidePanels(showHide: boolean) {\r\n internal.showHidePanels = showHide;\r\n }\r\n\r\n /** Determines whether the status bar is shown and hidden. Defaults to false. */\r\n public static get showHideFooter(): boolean {\r\n return internal.showHideFooter;\r\n }\r\n public static set showHideFooter(showHide: boolean) {\r\n internal.showHideFooter = showHide;\r\n }\r\n\r\n /** Determines the amount of inactivity time before the Ui is hidden. Defaults to 3.5 seconds. */\r\n public static get inactivityTime(): number {\r\n return internal.inactivityTime;\r\n }\r\n public static set inactivityTime(time: number) {\r\n internal.inactivityTime = time;\r\n }\r\n\r\n /** Determines whether the proximity of the mouse should alter the opacity of a toolbar. Defaults to true. */\r\n public static get useProximityOpacity(): boolean {\r\n return internal.useProximityOpacity;\r\n }\r\n public static set useProximityOpacity(value: boolean) {\r\n internal.useProximityOpacity = value;\r\n }\r\n\r\n /** Determines whether the opacity of a toolbar should snap. Defaults to false. */\r\n public static get snapWidgetOpacity(): boolean {\r\n return internal.snapWidgetOpacity;\r\n }\r\n public static set snapWidgetOpacity(value: boolean) {\r\n internal.snapWidgetOpacity = value;\r\n }\r\n\r\n /** Handler for when a Frontstage is ready */\r\n public static handleFrontstageReady() {\r\n // istanbul ignore next\r\n return internal.handleFrontstageReady();\r\n }\r\n\r\n /** Handler for when the mouse moves over the content area */\r\n public static handleContentMouseMove(_event?: React.MouseEvent<HTMLElement, MouseEvent>) {\r\n return internal.handleContentMouseMove(_event);\r\n }\r\n\r\n /** Handler for when the mouse enters a widget */\r\n public static handleWidgetMouseEnter(_event?: React.MouseEvent<HTMLElement, MouseEvent>) {\r\n return internal.handleWidgetMouseEnter(_event);\r\n }\r\n\r\n /** Shows the Ui and resets the inactivity timer */\r\n public static showUiAndResetTimer() {\r\n return internal.showUiAndResetTimer();\r\n }\r\n\r\n /** Shows the Ui and cancels the inactivity timer */\r\n public static showUiAndCancelTimer() {\r\n return internal.showUiAndCancelTimer();\r\n }\r\n\r\n /** @internal */\r\n public static terminate() {\r\n return internal.terminate();\r\n }\r\n}\r\n"]}