@itwin/appui-abstract 4.0.0-dev.8 → 4.0.0-dev.81

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 (332) hide show
  1. package/CHANGELOG.md +45 -1
  2. package/lib/cjs/appui-abstract/BaseUiItemsProvider.d.ts +30 -30
  3. package/lib/cjs/appui-abstract/BaseUiItemsProvider.d.ts.map +1 -1
  4. package/lib/cjs/appui-abstract/BaseUiItemsProvider.js +79 -79
  5. package/lib/cjs/appui-abstract/BaseUiItemsProvider.js.map +1 -1
  6. package/lib/cjs/appui-abstract/UiAdmin.d.ts +221 -221
  7. package/lib/cjs/appui-abstract/UiAdmin.js +224 -224
  8. package/lib/cjs/appui-abstract/UiAdmin.js.map +1 -1
  9. package/lib/cjs/appui-abstract/UiItemsManager.d.ts +113 -113
  10. package/lib/cjs/appui-abstract/UiItemsManager.d.ts.map +1 -1
  11. package/lib/cjs/appui-abstract/UiItemsManager.js +193 -199
  12. package/lib/cjs/appui-abstract/UiItemsManager.js.map +1 -1
  13. package/lib/cjs/appui-abstract/UiItemsProvider.d.ts +29 -29
  14. package/lib/cjs/appui-abstract/UiItemsProvider.js +9 -9
  15. package/lib/cjs/appui-abstract/UiItemsProvider.js.map +1 -1
  16. package/lib/cjs/appui-abstract/backstage/BackstageItem.d.ts +91 -91
  17. package/lib/cjs/appui-abstract/backstage/BackstageItem.d.ts.map +1 -1
  18. package/lib/cjs/appui-abstract/backstage/BackstageItem.js +70 -70
  19. package/lib/cjs/appui-abstract/backstage/BackstageItem.js.map +1 -1
  20. package/lib/cjs/appui-abstract/backstage/BackstageItemsManager.d.ts +38 -38
  21. package/lib/cjs/appui-abstract/backstage/BackstageItemsManager.js +133 -133
  22. package/lib/cjs/appui-abstract/backstage/BackstageItemsManager.js.map +1 -1
  23. package/lib/cjs/appui-abstract/common/KeyboardKey.d.ts +51 -51
  24. package/lib/cjs/appui-abstract/common/KeyboardKey.js +63 -63
  25. package/lib/cjs/appui-abstract/common/KeyboardKey.js.map +1 -1
  26. package/lib/cjs/appui-abstract/content/ContentLayoutProps.d.ts +62 -62
  27. package/lib/cjs/appui-abstract/content/ContentLayoutProps.js +9 -9
  28. package/lib/cjs/appui-abstract/content/ContentLayoutProps.js.map +1 -1
  29. package/lib/cjs/appui-abstract/content/StandardContentLayouts.d.ts +19 -19
  30. package/lib/cjs/appui-abstract/content/StandardContentLayouts.js +108 -108
  31. package/lib/cjs/appui-abstract/content/StandardContentLayouts.js.map +1 -1
  32. package/lib/cjs/appui-abstract/dialogs/DialogItem.d.ts +76 -76
  33. package/lib/cjs/appui-abstract/dialogs/DialogItem.js +67 -67
  34. package/lib/cjs/appui-abstract/dialogs/DialogItem.js.map +1 -1
  35. package/lib/cjs/appui-abstract/dialogs/UiDataProvider.d.ts +55 -55
  36. package/lib/cjs/appui-abstract/dialogs/UiDataProvider.js +66 -66
  37. package/lib/cjs/appui-abstract/dialogs/UiDataProvider.js.map +1 -1
  38. package/lib/cjs/appui-abstract/dialogs/UiLayoutDataProvider.d.ts +97 -97
  39. package/lib/cjs/appui-abstract/dialogs/UiLayoutDataProvider.js +175 -175
  40. package/lib/cjs/appui-abstract/dialogs/UiLayoutDataProvider.js.map +1 -1
  41. package/lib/cjs/appui-abstract/items/AbstractItemProps.d.ts +53 -53
  42. package/lib/cjs/appui-abstract/items/AbstractItemProps.d.ts.map +1 -1
  43. package/lib/cjs/appui-abstract/items/AbstractItemProps.js +9 -9
  44. package/lib/cjs/appui-abstract/items/AbstractItemProps.js.map +1 -1
  45. package/lib/cjs/appui-abstract/items/AbstractMenuItemProps.d.ts +20 -20
  46. package/lib/cjs/appui-abstract/items/AbstractMenuItemProps.js +9 -9
  47. package/lib/cjs/appui-abstract/items/AbstractMenuItemProps.js.map +1 -1
  48. package/lib/cjs/appui-abstract/items/AbstractToolbarProps.d.ts +13 -13
  49. package/lib/cjs/appui-abstract/items/AbstractToolbarProps.js +9 -9
  50. package/lib/cjs/appui-abstract/items/AbstractToolbarProps.js.map +1 -1
  51. package/lib/cjs/appui-abstract/items/BadgeType.d.ts +14 -14
  52. package/lib/cjs/appui-abstract/items/BadgeType.js +22 -22
  53. package/lib/cjs/appui-abstract/items/BadgeType.js.map +1 -1
  54. package/lib/cjs/appui-abstract/items/ConditionalBooleanValue.d.ts +27 -27
  55. package/lib/cjs/appui-abstract/items/ConditionalBooleanValue.js +60 -60
  56. package/lib/cjs/appui-abstract/items/ConditionalBooleanValue.js.map +1 -1
  57. package/lib/cjs/appui-abstract/items/ConditionalStringValue.d.ts +29 -29
  58. package/lib/cjs/appui-abstract/items/ConditionalStringValue.js +62 -62
  59. package/lib/cjs/appui-abstract/items/ConditionalStringValue.js.map +1 -1
  60. package/lib/cjs/appui-abstract/items/ProvidedItem.d.ts +11 -11
  61. package/lib/cjs/appui-abstract/items/ProvidedItem.js +9 -9
  62. package/lib/cjs/appui-abstract/items/ProvidedItem.js.map +1 -1
  63. package/lib/cjs/appui-abstract/items/RelativePosition.d.ts +18 -18
  64. package/lib/cjs/appui-abstract/items/RelativePosition.js +26 -26
  65. package/lib/cjs/appui-abstract/items/RelativePosition.js.map +1 -1
  66. package/lib/cjs/appui-abstract/items/StageUsage.d.ts +16 -16
  67. package/lib/cjs/appui-abstract/items/StageUsage.js +24 -24
  68. package/lib/cjs/appui-abstract/items/StageUsage.js.map +1 -1
  69. package/lib/cjs/appui-abstract/notification/MessagePresenter.d.ts +42 -42
  70. package/lib/cjs/appui-abstract/notification/MessagePresenter.js +24 -24
  71. package/lib/cjs/appui-abstract/notification/MessagePresenter.js.map +1 -1
  72. package/lib/cjs/appui-abstract/notification/MessageSeverity.d.ts +15 -15
  73. package/lib/cjs/appui-abstract/notification/MessageSeverity.js +23 -23
  74. package/lib/cjs/appui-abstract/notification/MessageSeverity.js.map +1 -1
  75. package/lib/cjs/appui-abstract/properties/Description.d.ts +124 -127
  76. package/lib/cjs/appui-abstract/properties/Description.d.ts.map +1 -1
  77. package/lib/cjs/appui-abstract/properties/Description.js +196 -196
  78. package/lib/cjs/appui-abstract/properties/Description.js.map +1 -1
  79. package/lib/cjs/appui-abstract/properties/EditorParams.d.ts +260 -260
  80. package/lib/cjs/appui-abstract/properties/EditorParams.d.ts.map +1 -1
  81. package/lib/cjs/appui-abstract/properties/EditorParams.js +106 -106
  82. package/lib/cjs/appui-abstract/properties/EditorParams.js.map +1 -1
  83. package/lib/cjs/appui-abstract/properties/PrimitiveTypes.d.ts +60 -60
  84. package/lib/cjs/appui-abstract/properties/PrimitiveTypes.js +9 -9
  85. package/lib/cjs/appui-abstract/properties/PrimitiveTypes.js.map +1 -1
  86. package/lib/cjs/appui-abstract/properties/Record.d.ts +57 -57
  87. package/lib/cjs/appui-abstract/properties/Record.js +78 -78
  88. package/lib/cjs/appui-abstract/properties/Record.js.map +1 -1
  89. package/lib/cjs/appui-abstract/properties/StandardEditorNames.d.ts +22 -22
  90. package/lib/cjs/appui-abstract/properties/StandardEditorNames.js +30 -30
  91. package/lib/cjs/appui-abstract/properties/StandardEditorNames.js.map +1 -1
  92. package/lib/cjs/appui-abstract/properties/StandardTypeNames.d.ts +30 -30
  93. package/lib/cjs/appui-abstract/properties/StandardTypeNames.js +39 -39
  94. package/lib/cjs/appui-abstract/properties/StandardTypeNames.js.map +1 -1
  95. package/lib/cjs/appui-abstract/properties/Value.d.ts +49 -49
  96. package/lib/cjs/appui-abstract/properties/Value.d.ts.map +1 -1
  97. package/lib/cjs/appui-abstract/properties/Value.js +20 -20
  98. package/lib/cjs/appui-abstract/properties/Value.js.map +1 -1
  99. package/lib/cjs/appui-abstract/quantity/BaseQuantityDescription.d.ts +22 -22
  100. package/lib/cjs/appui-abstract/quantity/BaseQuantityDescription.js +48 -48
  101. package/lib/cjs/appui-abstract/quantity/BaseQuantityDescription.js.map +1 -1
  102. package/lib/cjs/appui-abstract/statusbar/StatusBarItem.d.ts +128 -128
  103. package/lib/cjs/appui-abstract/statusbar/StatusBarItem.d.ts.map +1 -1
  104. package/lib/cjs/appui-abstract/statusbar/StatusBarItem.js +87 -87
  105. package/lib/cjs/appui-abstract/statusbar/StatusBarItem.js.map +1 -1
  106. package/lib/cjs/appui-abstract/statusbar/StatusBarItemsManager.d.ts +39 -39
  107. package/lib/cjs/appui-abstract/statusbar/StatusBarItemsManager.js +135 -135
  108. package/lib/cjs/appui-abstract/statusbar/StatusBarItemsManager.js.map +1 -1
  109. package/lib/cjs/appui-abstract/toolbars/ToolbarItem.d.ts +121 -121
  110. package/lib/cjs/appui-abstract/toolbars/ToolbarItem.d.ts.map +1 -1
  111. package/lib/cjs/appui-abstract/toolbars/ToolbarItem.js +64 -64
  112. package/lib/cjs/appui-abstract/toolbars/ToolbarItem.js.map +1 -1
  113. package/lib/cjs/appui-abstract/toolbars/ToolbarItemsManager.d.ts +45 -45
  114. package/lib/cjs/appui-abstract/toolbars/ToolbarItemsManager.js +235 -235
  115. package/lib/cjs/appui-abstract/toolbars/ToolbarItemsManager.js.map +1 -1
  116. package/lib/cjs/appui-abstract/utils/IconSpecUtilities.d.ts +29 -29
  117. package/lib/cjs/appui-abstract/utils/IconSpecUtilities.js +51 -51
  118. package/lib/cjs/appui-abstract/utils/IconSpecUtilities.js.map +1 -1
  119. package/lib/cjs/appui-abstract/utils/PointProps.d.ts +10 -10
  120. package/lib/cjs/appui-abstract/utils/PointProps.js +9 -9
  121. package/lib/cjs/appui-abstract/utils/PointProps.js.map +1 -1
  122. package/lib/cjs/appui-abstract/utils/UiError.d.ts +12 -12
  123. package/lib/cjs/appui-abstract/utils/UiError.js +22 -22
  124. package/lib/cjs/appui-abstract/utils/UiError.js.map +1 -1
  125. package/lib/cjs/appui-abstract/utils/UiEvent.d.ts +9 -9
  126. package/lib/cjs/appui-abstract/utils/UiEvent.js +17 -17
  127. package/lib/cjs/appui-abstract/utils/UiEvent.js.map +1 -1
  128. package/lib/cjs/appui-abstract/utils/UiEventDispatcher.d.ts +46 -46
  129. package/lib/cjs/appui-abstract/utils/UiEventDispatcher.js +131 -131
  130. package/lib/cjs/appui-abstract/utils/UiEventDispatcher.js.map +1 -1
  131. package/lib/cjs/appui-abstract/utils/callbacks.d.ts +20 -20
  132. package/lib/cjs/appui-abstract/utils/callbacks.d.ts.map +1 -1
  133. package/lib/cjs/appui-abstract/utils/callbacks.js +9 -9
  134. package/lib/cjs/appui-abstract/utils/callbacks.js.map +1 -1
  135. package/lib/cjs/appui-abstract/utils/filter/charCode.d.ts +416 -416
  136. package/lib/cjs/appui-abstract/utils/filter/charCode.js +6 -6
  137. package/lib/cjs/appui-abstract/utils/filter/charCode.js.map +1 -1
  138. package/lib/cjs/appui-abstract/utils/filter/filters.d.ts +98 -98
  139. package/lib/cjs/appui-abstract/utils/filter/filters.d.ts.map +1 -1
  140. package/lib/cjs/appui-abstract/utils/filter/filters.js +709 -709
  141. package/lib/cjs/appui-abstract/utils/filter/filters.js.map +1 -1
  142. package/lib/cjs/appui-abstract/utils/filter/map.d.ts +59 -59
  143. package/lib/cjs/appui-abstract/utils/filter/map.js +402 -404
  144. package/lib/cjs/appui-abstract/utils/filter/map.js.map +1 -1
  145. package/lib/cjs/appui-abstract/utils/filter/strings.d.ts +20 -20
  146. package/lib/cjs/appui-abstract/utils/filter/strings.js +78 -78
  147. package/lib/cjs/appui-abstract/utils/filter/strings.js.map +1 -1
  148. package/lib/cjs/appui-abstract/utils/isLetter.d.ts +9 -9
  149. package/lib/cjs/appui-abstract/utils/isLetter.js +19 -19
  150. package/lib/cjs/appui-abstract/utils/isLetter.js.map +1 -1
  151. package/lib/cjs/appui-abstract/utils/misc.d.ts +11 -11
  152. package/lib/cjs/appui-abstract/utils/misc.js +36 -36
  153. package/lib/cjs/appui-abstract/utils/misc.js.map +1 -1
  154. package/lib/cjs/appui-abstract/widget/AbstractWidgetProps.d.ts +86 -86
  155. package/lib/cjs/appui-abstract/widget/AbstractWidgetProps.js +9 -9
  156. package/lib/cjs/appui-abstract/widget/AbstractWidgetProps.js.map +1 -1
  157. package/lib/cjs/appui-abstract/widget/StagePanel.d.ts +36 -36
  158. package/lib/cjs/appui-abstract/widget/StagePanel.d.ts.map +1 -1
  159. package/lib/cjs/appui-abstract/widget/StagePanel.js +46 -46
  160. package/lib/cjs/appui-abstract/widget/StagePanel.js.map +1 -1
  161. package/lib/cjs/appui-abstract/widget/WidgetState.d.ts +19 -19
  162. package/lib/cjs/appui-abstract/widget/WidgetState.js +27 -27
  163. package/lib/cjs/appui-abstract/widget/WidgetState.js.map +1 -1
  164. package/lib/cjs/appui-abstract.d.ts +103 -103
  165. package/lib/cjs/appui-abstract.js +123 -119
  166. package/lib/cjs/appui-abstract.js.map +1 -1
  167. package/lib/esm/appui-abstract/BaseUiItemsProvider.d.ts +30 -30
  168. package/lib/esm/appui-abstract/BaseUiItemsProvider.d.ts.map +1 -1
  169. package/lib/esm/appui-abstract/BaseUiItemsProvider.js +75 -75
  170. package/lib/esm/appui-abstract/BaseUiItemsProvider.js.map +1 -1
  171. package/lib/esm/appui-abstract/UiAdmin.d.ts +221 -221
  172. package/lib/esm/appui-abstract/UiAdmin.js +220 -219
  173. package/lib/esm/appui-abstract/UiAdmin.js.map +1 -1
  174. package/lib/esm/appui-abstract/UiItemsManager.d.ts +113 -113
  175. package/lib/esm/appui-abstract/UiItemsManager.d.ts.map +1 -1
  176. package/lib/esm/appui-abstract/UiItemsManager.js +190 -195
  177. package/lib/esm/appui-abstract/UiItemsManager.js.map +1 -1
  178. package/lib/esm/appui-abstract/UiItemsProvider.d.ts +29 -29
  179. package/lib/esm/appui-abstract/UiItemsProvider.js +8 -8
  180. package/lib/esm/appui-abstract/UiItemsProvider.js.map +1 -1
  181. package/lib/esm/appui-abstract/backstage/BackstageItem.d.ts +91 -91
  182. package/lib/esm/appui-abstract/backstage/BackstageItem.d.ts.map +1 -1
  183. package/lib/esm/appui-abstract/backstage/BackstageItem.js +65 -64
  184. package/lib/esm/appui-abstract/backstage/BackstageItem.js.map +1 -1
  185. package/lib/esm/appui-abstract/backstage/BackstageItemsManager.d.ts +38 -38
  186. package/lib/esm/appui-abstract/backstage/BackstageItemsManager.js +129 -129
  187. package/lib/esm/appui-abstract/backstage/BackstageItemsManager.js.map +1 -1
  188. package/lib/esm/appui-abstract/common/KeyboardKey.d.ts +51 -51
  189. package/lib/esm/appui-abstract/common/KeyboardKey.js +59 -59
  190. package/lib/esm/appui-abstract/common/KeyboardKey.js.map +1 -1
  191. package/lib/esm/appui-abstract/content/ContentLayoutProps.d.ts +62 -62
  192. package/lib/esm/appui-abstract/content/ContentLayoutProps.js +8 -8
  193. package/lib/esm/appui-abstract/content/ContentLayoutProps.js.map +1 -1
  194. package/lib/esm/appui-abstract/content/StandardContentLayouts.d.ts +19 -19
  195. package/lib/esm/appui-abstract/content/StandardContentLayouts.js +105 -104
  196. package/lib/esm/appui-abstract/content/StandardContentLayouts.js.map +1 -1
  197. package/lib/esm/appui-abstract/dialogs/DialogItem.d.ts +76 -76
  198. package/lib/esm/appui-abstract/dialogs/DialogItem.js +63 -63
  199. package/lib/esm/appui-abstract/dialogs/DialogItem.js.map +1 -1
  200. package/lib/esm/appui-abstract/dialogs/UiDataProvider.d.ts +55 -55
  201. package/lib/esm/appui-abstract/dialogs/UiDataProvider.js +61 -61
  202. package/lib/esm/appui-abstract/dialogs/UiDataProvider.js.map +1 -1
  203. package/lib/esm/appui-abstract/dialogs/UiLayoutDataProvider.d.ts +97 -97
  204. package/lib/esm/appui-abstract/dialogs/UiLayoutDataProvider.js +171 -170
  205. package/lib/esm/appui-abstract/dialogs/UiLayoutDataProvider.js.map +1 -1
  206. package/lib/esm/appui-abstract/items/AbstractItemProps.d.ts +53 -53
  207. package/lib/esm/appui-abstract/items/AbstractItemProps.d.ts.map +1 -1
  208. package/lib/esm/appui-abstract/items/AbstractItemProps.js +8 -8
  209. package/lib/esm/appui-abstract/items/AbstractItemProps.js.map +1 -1
  210. package/lib/esm/appui-abstract/items/AbstractMenuItemProps.d.ts +20 -20
  211. package/lib/esm/appui-abstract/items/AbstractMenuItemProps.js +8 -8
  212. package/lib/esm/appui-abstract/items/AbstractMenuItemProps.js.map +1 -1
  213. package/lib/esm/appui-abstract/items/AbstractToolbarProps.d.ts +13 -13
  214. package/lib/esm/appui-abstract/items/AbstractToolbarProps.js +8 -8
  215. package/lib/esm/appui-abstract/items/AbstractToolbarProps.js.map +1 -1
  216. package/lib/esm/appui-abstract/items/BadgeType.d.ts +14 -14
  217. package/lib/esm/appui-abstract/items/BadgeType.js +19 -19
  218. package/lib/esm/appui-abstract/items/BadgeType.js.map +1 -1
  219. package/lib/esm/appui-abstract/items/ConditionalBooleanValue.d.ts +27 -27
  220. package/lib/esm/appui-abstract/items/ConditionalBooleanValue.js +56 -56
  221. package/lib/esm/appui-abstract/items/ConditionalBooleanValue.js.map +1 -1
  222. package/lib/esm/appui-abstract/items/ConditionalStringValue.d.ts +29 -29
  223. package/lib/esm/appui-abstract/items/ConditionalStringValue.js +58 -58
  224. package/lib/esm/appui-abstract/items/ConditionalStringValue.js.map +1 -1
  225. package/lib/esm/appui-abstract/items/ProvidedItem.d.ts +11 -11
  226. package/lib/esm/appui-abstract/items/ProvidedItem.js +8 -8
  227. package/lib/esm/appui-abstract/items/ProvidedItem.js.map +1 -1
  228. package/lib/esm/appui-abstract/items/RelativePosition.d.ts +18 -18
  229. package/lib/esm/appui-abstract/items/RelativePosition.js +23 -23
  230. package/lib/esm/appui-abstract/items/RelativePosition.js.map +1 -1
  231. package/lib/esm/appui-abstract/items/StageUsage.d.ts +16 -16
  232. package/lib/esm/appui-abstract/items/StageUsage.js +21 -21
  233. package/lib/esm/appui-abstract/items/StageUsage.js.map +1 -1
  234. package/lib/esm/appui-abstract/notification/MessagePresenter.d.ts +42 -42
  235. package/lib/esm/appui-abstract/notification/MessagePresenter.js +21 -21
  236. package/lib/esm/appui-abstract/notification/MessagePresenter.js.map +1 -1
  237. package/lib/esm/appui-abstract/notification/MessageSeverity.d.ts +15 -15
  238. package/lib/esm/appui-abstract/notification/MessageSeverity.js +20 -20
  239. package/lib/esm/appui-abstract/notification/MessageSeverity.js.map +1 -1
  240. package/lib/esm/appui-abstract/properties/Description.d.ts +124 -127
  241. package/lib/esm/appui-abstract/properties/Description.d.ts.map +1 -1
  242. package/lib/esm/appui-abstract/properties/Description.js +192 -192
  243. package/lib/esm/appui-abstract/properties/Description.js.map +1 -1
  244. package/lib/esm/appui-abstract/properties/EditorParams.d.ts +260 -260
  245. package/lib/esm/appui-abstract/properties/EditorParams.d.ts.map +1 -1
  246. package/lib/esm/appui-abstract/properties/EditorParams.js +97 -97
  247. package/lib/esm/appui-abstract/properties/EditorParams.js.map +1 -1
  248. package/lib/esm/appui-abstract/properties/PrimitiveTypes.d.ts +60 -60
  249. package/lib/esm/appui-abstract/properties/PrimitiveTypes.js +8 -8
  250. package/lib/esm/appui-abstract/properties/PrimitiveTypes.js.map +1 -1
  251. package/lib/esm/appui-abstract/properties/Record.d.ts +57 -57
  252. package/lib/esm/appui-abstract/properties/Record.js +74 -74
  253. package/lib/esm/appui-abstract/properties/Record.js.map +1 -1
  254. package/lib/esm/appui-abstract/properties/StandardEditorNames.d.ts +22 -22
  255. package/lib/esm/appui-abstract/properties/StandardEditorNames.js +27 -27
  256. package/lib/esm/appui-abstract/properties/StandardEditorNames.js.map +1 -1
  257. package/lib/esm/appui-abstract/properties/StandardTypeNames.d.ts +30 -30
  258. package/lib/esm/appui-abstract/properties/StandardTypeNames.js +36 -36
  259. package/lib/esm/appui-abstract/properties/StandardTypeNames.js.map +1 -1
  260. package/lib/esm/appui-abstract/properties/Value.d.ts +49 -49
  261. package/lib/esm/appui-abstract/properties/Value.d.ts.map +1 -1
  262. package/lib/esm/appui-abstract/properties/Value.js +17 -17
  263. package/lib/esm/appui-abstract/properties/Value.js.map +1 -1
  264. package/lib/esm/appui-abstract/quantity/BaseQuantityDescription.d.ts +22 -22
  265. package/lib/esm/appui-abstract/quantity/BaseQuantityDescription.js +44 -44
  266. package/lib/esm/appui-abstract/quantity/BaseQuantityDescription.js.map +1 -1
  267. package/lib/esm/appui-abstract/statusbar/StatusBarItem.d.ts +128 -128
  268. package/lib/esm/appui-abstract/statusbar/StatusBarItem.d.ts.map +1 -1
  269. package/lib/esm/appui-abstract/statusbar/StatusBarItem.js +81 -80
  270. package/lib/esm/appui-abstract/statusbar/StatusBarItem.js.map +1 -1
  271. package/lib/esm/appui-abstract/statusbar/StatusBarItemsManager.d.ts +39 -39
  272. package/lib/esm/appui-abstract/statusbar/StatusBarItemsManager.js +131 -131
  273. package/lib/esm/appui-abstract/statusbar/StatusBarItemsManager.js.map +1 -1
  274. package/lib/esm/appui-abstract/toolbars/ToolbarItem.d.ts +121 -121
  275. package/lib/esm/appui-abstract/toolbars/ToolbarItem.d.ts.map +1 -1
  276. package/lib/esm/appui-abstract/toolbars/ToolbarItem.js +61 -60
  277. package/lib/esm/appui-abstract/toolbars/ToolbarItem.js.map +1 -1
  278. package/lib/esm/appui-abstract/toolbars/ToolbarItemsManager.d.ts +45 -45
  279. package/lib/esm/appui-abstract/toolbars/ToolbarItemsManager.js +231 -231
  280. package/lib/esm/appui-abstract/toolbars/ToolbarItemsManager.js.map +1 -1
  281. package/lib/esm/appui-abstract/utils/IconSpecUtilities.d.ts +29 -29
  282. package/lib/esm/appui-abstract/utils/IconSpecUtilities.js +48 -47
  283. package/lib/esm/appui-abstract/utils/IconSpecUtilities.js.map +1 -1
  284. package/lib/esm/appui-abstract/utils/PointProps.d.ts +10 -10
  285. package/lib/esm/appui-abstract/utils/PointProps.js +8 -8
  286. package/lib/esm/appui-abstract/utils/PointProps.js.map +1 -1
  287. package/lib/esm/appui-abstract/utils/UiError.d.ts +12 -12
  288. package/lib/esm/appui-abstract/utils/UiError.js +18 -18
  289. package/lib/esm/appui-abstract/utils/UiError.js.map +1 -1
  290. package/lib/esm/appui-abstract/utils/UiEvent.d.ts +9 -9
  291. package/lib/esm/appui-abstract/utils/UiEvent.js +13 -13
  292. package/lib/esm/appui-abstract/utils/UiEvent.js.map +1 -1
  293. package/lib/esm/appui-abstract/utils/UiEventDispatcher.d.ts +46 -46
  294. package/lib/esm/appui-abstract/utils/UiEventDispatcher.js +126 -126
  295. package/lib/esm/appui-abstract/utils/UiEventDispatcher.js.map +1 -1
  296. package/lib/esm/appui-abstract/utils/callbacks.d.ts +20 -20
  297. package/lib/esm/appui-abstract/utils/callbacks.d.ts.map +1 -1
  298. package/lib/esm/appui-abstract/utils/callbacks.js +8 -8
  299. package/lib/esm/appui-abstract/utils/callbacks.js.map +1 -1
  300. package/lib/esm/appui-abstract/utils/filter/charCode.d.ts +416 -416
  301. package/lib/esm/appui-abstract/utils/filter/charCode.js +5 -5
  302. package/lib/esm/appui-abstract/utils/filter/charCode.js.map +1 -1
  303. package/lib/esm/appui-abstract/utils/filter/filters.d.ts +98 -98
  304. package/lib/esm/appui-abstract/utils/filter/filters.d.ts.map +1 -1
  305. package/lib/esm/appui-abstract/utils/filter/filters.js +694 -694
  306. package/lib/esm/appui-abstract/utils/filter/filters.js.map +1 -1
  307. package/lib/esm/appui-abstract/utils/filter/map.d.ts +59 -59
  308. package/lib/esm/appui-abstract/utils/filter/map.js +397 -399
  309. package/lib/esm/appui-abstract/utils/filter/map.js.map +1 -1
  310. package/lib/esm/appui-abstract/utils/filter/strings.d.ts +20 -20
  311. package/lib/esm/appui-abstract/utils/filter/strings.js +70 -70
  312. package/lib/esm/appui-abstract/utils/filter/strings.js.map +1 -1
  313. package/lib/esm/appui-abstract/utils/isLetter.d.ts +9 -9
  314. package/lib/esm/appui-abstract/utils/isLetter.js +15 -15
  315. package/lib/esm/appui-abstract/utils/isLetter.js.map +1 -1
  316. package/lib/esm/appui-abstract/utils/misc.d.ts +11 -11
  317. package/lib/esm/appui-abstract/utils/misc.js +31 -31
  318. package/lib/esm/appui-abstract/utils/misc.js.map +1 -1
  319. package/lib/esm/appui-abstract/widget/AbstractWidgetProps.d.ts +86 -86
  320. package/lib/esm/appui-abstract/widget/AbstractWidgetProps.js +8 -8
  321. package/lib/esm/appui-abstract/widget/AbstractWidgetProps.js.map +1 -1
  322. package/lib/esm/appui-abstract/widget/StagePanel.d.ts +36 -36
  323. package/lib/esm/appui-abstract/widget/StagePanel.d.ts.map +1 -1
  324. package/lib/esm/appui-abstract/widget/StagePanel.js +43 -43
  325. package/lib/esm/appui-abstract/widget/StagePanel.js.map +1 -1
  326. package/lib/esm/appui-abstract/widget/WidgetState.d.ts +19 -19
  327. package/lib/esm/appui-abstract/widget/WidgetState.js +24 -24
  328. package/lib/esm/appui-abstract/widget/WidgetState.js.map +1 -1
  329. package/lib/esm/appui-abstract.d.ts +103 -103
  330. package/lib/esm/appui-abstract.js +107 -107
  331. package/lib/esm/appui-abstract.js.map +1 -1
  332. package/package.json +11 -11
@@ -1,196 +1,191 @@
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
- /* eslint-disable deprecation/deprecation */
6
- /** @packageDocumentation
7
- * @module UiItemsProvider
8
- */
9
- import { BeEvent, Logger } from "@itwin/core-bentley";
10
- import { loggerCategory } from "./utils/misc";
11
- /** Action taken by the application on item provided by a UiItemsProvider
12
- * @public @deprecated in 3.2. This was only used by the previously removed UiItemsArbiter.
13
- */
14
- export var UiItemsApplicationAction;
15
- (function (UiItemsApplicationAction) {
16
- /** Allow the change to the item */
17
- UiItemsApplicationAction[UiItemsApplicationAction["Allow"] = 0] = "Allow";
18
- /** Disallow the change to the item */
19
- UiItemsApplicationAction[UiItemsApplicationAction["Disallow"] = 1] = "Disallow";
20
- /** Update the item during the change */
21
- UiItemsApplicationAction[UiItemsApplicationAction["Update"] = 2] = "Update";
22
- })(UiItemsApplicationAction || (UiItemsApplicationAction = {}));
23
- /** Controls registering of UiItemsProviders and calls the provider's methods when populating different parts of the User Interface.
24
- * @deprecated in 3.6. Use [UiItemsManager]($appui-react) instead.
25
- * @public
26
- */
27
- export class UiItemsManager {
28
- /** For use in unit testing
29
- * @internal */
30
- static clearAllProviders() {
31
- UiItemsManager._registeredUiItemsProviders.clear();
32
- }
33
- /** Return number of registered UiProvider. */
34
- static get registeredProviderIds() {
35
- const ids = [...UiItemsManager._registeredUiItemsProviders.keys()];
36
- return ids;
37
- }
38
- /** Return true if there is any registered UiProvider. */
39
- static get hasRegisteredProviders() {
40
- return this._registeredUiItemsProviders.size > 0;
41
- }
42
- /**
43
- * Retrieves a previously loaded UiItemsProvider.
44
- * @param providerId id of the UiItemsProvider to get
45
- */
46
- static getUiItemsProvider(providerId) {
47
- var _a;
48
- return (_a = UiItemsManager._registeredUiItemsProviders.get(providerId)) === null || _a === void 0 ? void 0 : _a.provider;
49
- }
50
- static sendRegisteredEvent(ev) {
51
- UiItemsManager.onUiProviderRegisteredEvent.raiseEvent(ev);
52
- }
53
- /**
54
- * Registers a UiItemsProvider with the UiItemsManager.
55
- * @param uiProvider the UI items provider to register.
56
- */
57
- static register(uiProvider, overrides) {
58
- var _a;
59
- const providerId = (_a = overrides === null || overrides === void 0 ? void 0 : overrides.providerId) !== null && _a !== void 0 ? _a : uiProvider.id;
60
- if (UiItemsManager.getUiItemsProvider(providerId)) {
61
- Logger.logInfo(loggerCategory(this), `UiItemsProvider (${providerId}) is already loaded`);
62
- }
63
- else {
64
- UiItemsManager._registeredUiItemsProviders.set(providerId, { provider: uiProvider, overrides });
65
- Logger.logInfo(loggerCategory(this), `UiItemsProvider ${uiProvider.id} registered as ${providerId} `);
66
- UiItemsManager.sendRegisteredEvent({ providerId });
67
- }
68
- }
69
- /** Remove a specific UiItemsProvider from the list of available providers. */
70
- static unregister(uiProviderId) {
71
- const provider = UiItemsManager.getUiItemsProvider(uiProviderId);
72
- if (!provider)
73
- return;
74
- provider.onUnregister && provider.onUnregister();
75
- UiItemsManager._registeredUiItemsProviders.delete(uiProviderId);
76
- Logger.logInfo(loggerCategory(this), `UiItemsProvider (${uiProviderId}) unloaded`);
77
- // trigger a refresh of the ui
78
- UiItemsManager.sendRegisteredEvent({ providerId: uiProviderId });
79
- }
80
- static allowItemsFromProvider(entry, stageId, stageUsage) {
81
- // istanbul ignore else
82
- const overrides = entry.overrides;
83
- if (undefined !== stageId && (overrides === null || overrides === void 0 ? void 0 : overrides.stageIds) && !(overrides.stageIds.some((value) => value === stageId)))
84
- return false;
85
- if (undefined !== stageUsage && (overrides === null || overrides === void 0 ? void 0 : overrides.stageUsages) && !(overrides.stageUsages.some((value) => value === stageUsage)))
86
- return false;
87
- return true;
88
- }
89
- /** Called when the application is populating a toolbar so that any registered UiItemsProvider can add tool buttons that either either execute
90
- * an action or specify a registered ToolId into toolbar.
91
- * @param stageId a string identifier the active stage.
92
- * @param stageUsage the StageUsage of the active stage.
93
- * @param toolbarUsage usage of the toolbar
94
- * @param toolbarOrientation orientation of the toolbar
95
- * @returns an array of error messages. The array will be empty if the load is successful, otherwise it is a list of one or more problems.
96
- */
97
- static getToolbarButtonItems(stageId, stageUsage, toolbarUsage, toolbarOrientation, stageAppData) {
98
- const buttonItems = [];
99
- if (0 === UiItemsManager._registeredUiItemsProviders.size)
100
- return buttonItems;
101
- UiItemsManager._registeredUiItemsProviders.forEach((entry) => {
102
- var _a, _b;
103
- const uiProvider = entry.provider;
104
- const providerId = (_b = (_a = entry.overrides) === null || _a === void 0 ? void 0 : _a.providerId) !== null && _b !== void 0 ? _b : uiProvider.id;
105
- // istanbul ignore else
106
- if (uiProvider.provideToolbarButtonItems && this.allowItemsFromProvider(entry, stageId, stageUsage)) {
107
- uiProvider.provideToolbarButtonItems(stageId, stageUsage, toolbarUsage, toolbarOrientation, stageAppData)
108
- .forEach((spec) => {
109
- // ignore duplicate ids
110
- if (-1 === buttonItems.findIndex((existingItem) => spec.id === existingItem.id))
111
- buttonItems.push({ ...spec, providerId });
112
- });
113
- }
114
- });
115
- return buttonItems;
116
- }
117
- /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields
118
- * @param stageId a string identifier the active stage.
119
- * @param stageUsage the StageUsage of the active stage.
120
- * @returns An array of CommonStatusBarItem that will be used to create controls for the status bar.
121
- */
122
- static getStatusBarItems(stageId, stageUsage, stageAppData) {
123
- const statusBarItems = [];
124
- if (0 === UiItemsManager._registeredUiItemsProviders.size)
125
- return statusBarItems;
126
- UiItemsManager._registeredUiItemsProviders.forEach((entry) => {
127
- var _a, _b;
128
- const uiProvider = entry.provider;
129
- const providerId = (_b = (_a = entry.overrides) === null || _a === void 0 ? void 0 : _a.providerId) !== null && _b !== void 0 ? _b : uiProvider.id;
130
- // istanbul ignore else
131
- if (uiProvider.provideStatusBarItems && this.allowItemsFromProvider(entry, stageId, stageUsage)) {
132
- uiProvider.provideStatusBarItems(stageId, stageUsage, stageAppData)
133
- .forEach((item) => {
134
- // ignore duplicate ids
135
- if (-1 === statusBarItems.findIndex((existingItem) => item.id === existingItem.id))
136
- statusBarItems.push({ ...item, providerId });
137
- });
138
- }
139
- });
140
- return statusBarItems;
141
- }
142
- /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields
143
- * @returns An array of BackstageItem that will be used to create controls for the backstage menu.
144
- */
145
- static getBackstageItems() {
146
- const backstageItems = [];
147
- if (0 === UiItemsManager._registeredUiItemsProviders.size)
148
- return backstageItems;
149
- UiItemsManager._registeredUiItemsProviders.forEach((entry) => {
150
- var _a, _b;
151
- const uiProvider = entry.provider;
152
- const providerId = (_b = (_a = entry.overrides) === null || _a === void 0 ? void 0 : _a.providerId) !== null && _b !== void 0 ? _b : uiProvider.id;
153
- // istanbul ignore else
154
- if (uiProvider.provideBackstageItems) { // Note: We do not call this.allowItemsFromProvider here as backstage items
155
- uiProvider.provideBackstageItems() // should not be considered stage specific. If they need to be hidden
156
- .forEach((item) => {
157
- // ignore duplicate ids
158
- if (-1 === backstageItems.findIndex((existingItem) => item.id === existingItem.id))
159
- backstageItems.push({ ...item, providerId });
160
- });
161
- }
162
- });
163
- return backstageItems;
164
- }
165
- /** Called when the application is populating the Stage Panels so that any registered UiItemsProvider can add widgets
166
- * @param stageId a string identifier the active stage.
167
- * @param stageUsage the StageUsage of the active stage.
168
- * @param location the location within the stage.
169
- * @param section the section within location.
170
- * @returns An array of AbstractWidgetProps that will be used to create widgets.
171
- */
172
- static getWidgets(stageId, stageUsage, location, section, zoneLocation, stageAppData) {
173
- const widgets = [];
174
- if (0 === UiItemsManager._registeredUiItemsProviders.size)
175
- return widgets;
176
- UiItemsManager._registeredUiItemsProviders.forEach((entry) => {
177
- var _a, _b;
178
- const uiProvider = entry.provider;
179
- const providerId = (_b = (_a = entry.overrides) === null || _a === void 0 ? void 0 : _a.providerId) !== null && _b !== void 0 ? _b : uiProvider.id;
180
- // istanbul ignore else
181
- if (uiProvider.provideWidgets && this.allowItemsFromProvider(entry, stageId, stageUsage)) {
182
- uiProvider.provideWidgets(stageId, stageUsage, location, section, zoneLocation, stageAppData)
183
- .forEach((widget) => {
184
- // ignore duplicate ids
185
- if (-1 === widgets.findIndex((existingItem) => widget.id === existingItem.id))
186
- widgets.push({ ...widget, providerId });
187
- });
188
- }
189
- });
190
- return widgets;
191
- }
192
- }
193
- UiItemsManager._registeredUiItemsProviders = new Map();
194
- /** Event raised any time a UiProvider is registered or unregistered. */
195
- UiItemsManager.onUiProviderRegisteredEvent = new BeEvent();
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
+ /* eslint-disable deprecation/deprecation */
6
+ /** @packageDocumentation
7
+ * @module UiItemsProvider
8
+ */
9
+ import { BeEvent, Logger } from "@itwin/core-bentley";
10
+ import { loggerCategory } from "./utils/misc";
11
+ /** Action taken by the application on item provided by a UiItemsProvider
12
+ * @public @deprecated in 3.2. This was only used by the previously removed UiItemsArbiter.
13
+ */
14
+ export var UiItemsApplicationAction;
15
+ (function (UiItemsApplicationAction) {
16
+ /** Allow the change to the item */
17
+ UiItemsApplicationAction[UiItemsApplicationAction["Allow"] = 0] = "Allow";
18
+ /** Disallow the change to the item */
19
+ UiItemsApplicationAction[UiItemsApplicationAction["Disallow"] = 1] = "Disallow";
20
+ /** Update the item during the change */
21
+ UiItemsApplicationAction[UiItemsApplicationAction["Update"] = 2] = "Update";
22
+ })(UiItemsApplicationAction || (UiItemsApplicationAction = {}));
23
+ /** Controls registering of UiItemsProviders and calls the provider's methods when populating different parts of the User Interface.
24
+ * @deprecated in 3.6. Use [UiItemsManager]($appui-react) instead.
25
+ * @public
26
+ */
27
+ class UiItemsManager {
28
+ /** For use in unit testing
29
+ * @internal */
30
+ static clearAllProviders() {
31
+ UiItemsManager._registeredUiItemsProviders.clear();
32
+ }
33
+ /** Return number of registered UiProvider. */
34
+ static get registeredProviderIds() {
35
+ const ids = [...UiItemsManager._registeredUiItemsProviders.keys()];
36
+ return ids;
37
+ }
38
+ /** Return true if there is any registered UiProvider. */
39
+ static get hasRegisteredProviders() {
40
+ return this._registeredUiItemsProviders.size > 0;
41
+ }
42
+ /**
43
+ * Retrieves a previously loaded UiItemsProvider.
44
+ * @param providerId id of the UiItemsProvider to get
45
+ */
46
+ static getUiItemsProvider(providerId) {
47
+ return UiItemsManager._registeredUiItemsProviders.get(providerId)?.provider;
48
+ }
49
+ static sendRegisteredEvent(ev) {
50
+ UiItemsManager.onUiProviderRegisteredEvent.raiseEvent(ev);
51
+ }
52
+ /**
53
+ * Registers a UiItemsProvider with the UiItemsManager.
54
+ * @param uiProvider the UI items provider to register.
55
+ */
56
+ static register(uiProvider, overrides) {
57
+ const providerId = overrides?.providerId ?? uiProvider.id;
58
+ if (UiItemsManager.getUiItemsProvider(providerId)) {
59
+ Logger.logInfo(loggerCategory(this), `UiItemsProvider (${providerId}) is already loaded`);
60
+ }
61
+ else {
62
+ UiItemsManager._registeredUiItemsProviders.set(providerId, { provider: uiProvider, overrides });
63
+ Logger.logInfo(loggerCategory(this), `UiItemsProvider ${uiProvider.id} registered as ${providerId} `);
64
+ UiItemsManager.sendRegisteredEvent({ providerId });
65
+ }
66
+ }
67
+ /** Remove a specific UiItemsProvider from the list of available providers. */
68
+ static unregister(uiProviderId) {
69
+ const provider = UiItemsManager.getUiItemsProvider(uiProviderId);
70
+ if (!provider)
71
+ return;
72
+ provider.onUnregister && provider.onUnregister();
73
+ UiItemsManager._registeredUiItemsProviders.delete(uiProviderId);
74
+ Logger.logInfo(loggerCategory(this), `UiItemsProvider (${uiProviderId}) unloaded`);
75
+ // trigger a refresh of the ui
76
+ UiItemsManager.sendRegisteredEvent({ providerId: uiProviderId });
77
+ }
78
+ static allowItemsFromProvider(entry, stageId, stageUsage) {
79
+ // istanbul ignore else
80
+ const overrides = entry.overrides;
81
+ if (undefined !== stageId && overrides?.stageIds && !(overrides.stageIds.some((value) => value === stageId)))
82
+ return false;
83
+ if (undefined !== stageUsage && overrides?.stageUsages && !(overrides.stageUsages.some((value) => value === stageUsage)))
84
+ return false;
85
+ return true;
86
+ }
87
+ /** Called when the application is populating a toolbar so that any registered UiItemsProvider can add tool buttons that either either execute
88
+ * an action or specify a registered ToolId into toolbar.
89
+ * @param stageId a string identifier the active stage.
90
+ * @param stageUsage the StageUsage of the active stage.
91
+ * @param toolbarUsage usage of the toolbar
92
+ * @param toolbarOrientation orientation of the toolbar
93
+ * @returns an array of error messages. The array will be empty if the load is successful, otherwise it is a list of one or more problems.
94
+ */
95
+ static getToolbarButtonItems(stageId, stageUsage, toolbarUsage, toolbarOrientation, stageAppData) {
96
+ const buttonItems = [];
97
+ if (0 === UiItemsManager._registeredUiItemsProviders.size)
98
+ return buttonItems;
99
+ UiItemsManager._registeredUiItemsProviders.forEach((entry) => {
100
+ const uiProvider = entry.provider;
101
+ const providerId = entry.overrides?.providerId ?? uiProvider.id;
102
+ // istanbul ignore else
103
+ if (uiProvider.provideToolbarButtonItems && this.allowItemsFromProvider(entry, stageId, stageUsage)) {
104
+ uiProvider.provideToolbarButtonItems(stageId, stageUsage, toolbarUsage, toolbarOrientation, stageAppData)
105
+ .forEach((spec) => {
106
+ // ignore duplicate ids
107
+ if (-1 === buttonItems.findIndex((existingItem) => spec.id === existingItem.id))
108
+ buttonItems.push({ ...spec, providerId });
109
+ });
110
+ }
111
+ });
112
+ return buttonItems;
113
+ }
114
+ /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields
115
+ * @param stageId a string identifier the active stage.
116
+ * @param stageUsage the StageUsage of the active stage.
117
+ * @returns An array of CommonStatusBarItem that will be used to create controls for the status bar.
118
+ */
119
+ static getStatusBarItems(stageId, stageUsage, stageAppData) {
120
+ const statusBarItems = [];
121
+ if (0 === UiItemsManager._registeredUiItemsProviders.size)
122
+ return statusBarItems;
123
+ UiItemsManager._registeredUiItemsProviders.forEach((entry) => {
124
+ const uiProvider = entry.provider;
125
+ const providerId = entry.overrides?.providerId ?? uiProvider.id;
126
+ // istanbul ignore else
127
+ if (uiProvider.provideStatusBarItems && this.allowItemsFromProvider(entry, stageId, stageUsage)) {
128
+ uiProvider.provideStatusBarItems(stageId, stageUsage, stageAppData)
129
+ .forEach((item) => {
130
+ // ignore duplicate ids
131
+ if (-1 === statusBarItems.findIndex((existingItem) => item.id === existingItem.id))
132
+ statusBarItems.push({ ...item, providerId });
133
+ });
134
+ }
135
+ });
136
+ return statusBarItems;
137
+ }
138
+ /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields
139
+ * @returns An array of BackstageItem that will be used to create controls for the backstage menu.
140
+ */
141
+ static getBackstageItems() {
142
+ const backstageItems = [];
143
+ if (0 === UiItemsManager._registeredUiItemsProviders.size)
144
+ return backstageItems;
145
+ UiItemsManager._registeredUiItemsProviders.forEach((entry) => {
146
+ const uiProvider = entry.provider;
147
+ const providerId = entry.overrides?.providerId ?? uiProvider.id;
148
+ // istanbul ignore else
149
+ if (uiProvider.provideBackstageItems) { // Note: We do not call this.allowItemsFromProvider here as backstage items
150
+ uiProvider.provideBackstageItems() // should not be considered stage specific. If they need to be hidden
151
+ .forEach((item) => {
152
+ // ignore duplicate ids
153
+ if (-1 === backstageItems.findIndex((existingItem) => item.id === existingItem.id))
154
+ backstageItems.push({ ...item, providerId });
155
+ });
156
+ }
157
+ });
158
+ return backstageItems;
159
+ }
160
+ /** Called when the application is populating the Stage Panels so that any registered UiItemsProvider can add widgets
161
+ * @param stageId a string identifier the active stage.
162
+ * @param stageUsage the StageUsage of the active stage.
163
+ * @param location the location within the stage.
164
+ * @param section the section within location.
165
+ * @returns An array of AbstractWidgetProps that will be used to create widgets.
166
+ */
167
+ static getWidgets(stageId, stageUsage, location, section, zoneLocation, stageAppData) {
168
+ const widgets = [];
169
+ if (0 === UiItemsManager._registeredUiItemsProviders.size)
170
+ return widgets;
171
+ UiItemsManager._registeredUiItemsProviders.forEach((entry) => {
172
+ const uiProvider = entry.provider;
173
+ const providerId = entry.overrides?.providerId ?? uiProvider.id;
174
+ // istanbul ignore else
175
+ if (uiProvider.provideWidgets && this.allowItemsFromProvider(entry, stageId, stageUsage)) {
176
+ uiProvider.provideWidgets(stageId, stageUsage, location, section, zoneLocation, stageAppData)
177
+ .forEach((widget) => {
178
+ // ignore duplicate ids
179
+ if (-1 === widgets.findIndex((existingItem) => widget.id === existingItem.id))
180
+ widgets.push({ ...widget, providerId });
181
+ });
182
+ }
183
+ });
184
+ return widgets;
185
+ }
186
+ }
187
+ UiItemsManager._registeredUiItemsProviders = new Map();
188
+ /** Event raised any time a UiProvider is registered or unregistered. */
189
+ UiItemsManager.onUiProviderRegisteredEvent = new BeEvent();
190
+ export { UiItemsManager };
196
191
  //# sourceMappingURL=UiItemsManager.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"UiItemsManager.js","sourceRoot":"","sources":["../../../src/appui-abstract/UiItemsManager.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F,4CAA4C;AAC5C;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,EAAgB,MAAM,qBAAqB,CAAC;AAMpE,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAG9C;;GAEG;AACH,MAAM,CAAN,IAAY,wBAOX;AAPD,WAAY,wBAAwB;IAClC,mCAAmC;IACnC,yEAAK,CAAA;IACL,sCAAsC;IACtC,+EAAQ,CAAA;IACR,wCAAwC;IACxC,2EAAM,CAAA;AACR,CAAC,EAPW,wBAAwB,KAAxB,wBAAwB,QAOnC;AA+CD;;;GAGG;AACH,MAAM,OAAO,cAAc;IAGzB;mBACe;IACR,MAAM,CAAC,iBAAiB;QAC7B,cAAc,CAAC,2BAA2B,CAAC,KAAK,EAAE,CAAC;IACrD,CAAC;IAKD,8CAA8C;IACvC,MAAM,KAAK,qBAAqB;QACrC,MAAM,GAAG,GAAG,CAAC,GAAG,cAAc,CAAC,2BAA2B,CAAC,IAAI,EAAE,CAAC,CAAC;QACnE,OAAO,GAAG,CAAC;IACb,CAAC;IAED,yDAAyD;IAClD,MAAM,KAAK,sBAAsB;QACtC,OAAO,IAAI,CAAC,2BAA2B,CAAC,IAAI,GAAG,CAAC,CAAC;IACnD,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,kBAAkB,CAAC,UAAkB;;QACjD,OAAO,MAAA,cAAc,CAAC,2BAA2B,CAAC,GAAG,CAAC,UAAU,CAAC,0CAAE,QAAQ,CAAC;IAC9E,CAAC;IAEO,MAAM,CAAC,mBAAmB,CAAC,EAAqC;QACtE,cAAc,CAAC,2BAA2B,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,QAAQ,CAAC,UAA2B,EAAE,SAAmC;;QACrF,MAAM,UAAU,GAAG,MAAA,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,UAAU,mCAAI,UAAU,CAAC,EAAE,CAAC;QAE1D,IAAI,cAAc,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE;YACjD,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,oBAAoB,UAAU,qBAAqB,CAAC,CAAC;SAC3F;aAAM;YACL,cAAc,CAAC,2BAA2B,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC,CAAC;YAChG,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,mBAAmB,UAAU,CAAC,EAAE,kBAAkB,UAAU,GAAG,CAAC,CAAC;YAEtG,cAAc,CAAC,mBAAmB,CAAC,EAAE,UAAU,EAAuC,CAAC,CAAC;SACzF;IACH,CAAC;IAED,8EAA8E;IACvE,MAAM,CAAC,UAAU,CAAC,YAAoB;QAC3C,MAAM,QAAQ,GAAG,cAAc,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC;QACjE,IAAI,CAAC,QAAQ;YACX,OAAO;QAET,QAAQ,CAAC,YAAY,IAAI,QAAQ,CAAC,YAAY,EAAE,CAAC;QAEjD,cAAc,CAAC,2BAA2B,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QAChE,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,oBAAoB,YAAY,YAAY,CAAC,CAAC;QAEnF,8BAA8B;QAC9B,cAAc,CAAC,mBAAmB,CAAC,EAAE,UAAU,EAAE,YAAY,EAAuC,CAAC,CAAC;IACxG,CAAC;IAEO,MAAM,CAAC,sBAAsB,CAAC,KAA0B,EAAE,OAAgB,EAAE,UAAmB;QACrG,uBAAuB;QACvB,MAAM,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QAClC,IAAI,SAAS,KAAK,OAAO,KAAI,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,QAAQ,CAAA,IAAI,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK,KAAK,OAAO,CAAC,CAAC;YAClH,OAAO,KAAK,CAAC;QACf,IAAI,SAAS,KAAK,UAAU,KAAI,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,WAAW,CAAA,IAAI,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK,KAAK,UAAU,CAAC,CAAC;YAC9H,OAAO,KAAK,CAAC;QACf,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,qBAAqB,CAAC,OAAe,EAAE,UAAkB,EAAE,YAA0B,EACjG,kBAAsC,EAAE,YAAkB;QAC1D,MAAM,WAAW,GAAwB,EAAE,CAAC;QAC5C,IAAI,CAAC,KAAK,cAAc,CAAC,2BAA2B,CAAC,IAAI;YACvD,OAAO,WAAW,CAAC;QAErB,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,KAA0B,EAAE,EAAE;;YAChF,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC;YAClC,MAAM,UAAU,GAAG,MAAA,MAAA,KAAK,CAAC,SAAS,0CAAE,UAAU,mCAAI,UAAU,CAAC,EAAE,CAAC;YAChE,uBAAuB;YACvB,IAAI,UAAU,CAAC,yBAAyB,IAAI,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE;gBACnG,UAAU,CAAC,yBAAyB,CAAC,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,kBAAkB,EAAE,YAAY,CAAC;qBACtG,OAAO,CAAC,CAAC,IAAuB,EAAE,EAAE;oBACnC,uBAAuB;oBACvB,IAAI,CAAC,CAAC,KAAK,WAAW,CAAC,SAAS,CAAC,CAAC,YAAY,EAAC,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAAE;wBAC7E,WAAW,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;gBAC9C,CAAC,CAAC,CAAC;aACN;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,iBAAiB,CAAC,OAAe,EAAE,UAAkB,EAAE,YAAkB;QACrF,MAAM,cAAc,GAA0B,EAAE,CAAC;QAEjD,IAAI,CAAC,KAAK,cAAc,CAAC,2BAA2B,CAAC,IAAI;YACvD,OAAO,cAAc,CAAC;QAExB,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,KAA0B,EAAE,EAAE;;YAChF,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC;YAClC,MAAM,UAAU,GAAG,MAAA,MAAA,KAAK,CAAC,SAAS,0CAAE,UAAU,mCAAI,UAAU,CAAC,EAAE,CAAC;YAEhE,uBAAuB;YACvB,IAAI,UAAU,CAAC,qBAAqB,IAAI,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE;gBAC/F,UAAU,CAAC,qBAAqB,CAAC,OAAO,EAAE,UAAU,EAAE,YAAY,CAAC;qBAChE,OAAO,CAAC,CAAC,IAAyB,EAAE,EAAE;oBACrC,uBAAuB;oBACvB,IAAI,CAAC,CAAC,KAAK,cAAc,CAAC,SAAS,CAAC,CAAC,YAAY,EAAC,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAAE;wBAChF,cAAc,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;gBACjD,CAAC,CAAC,CAAC;aACN;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,iBAAiB;QAC7B,MAAM,cAAc,GAAoB,EAAE,CAAC;QAE3C,IAAI,CAAC,KAAK,cAAc,CAAC,2BAA2B,CAAC,IAAI;YACvD,OAAO,cAAc,CAAC;QAExB,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,KAA0B,EAAE,EAAE;;YAChF,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC;YAClC,MAAM,UAAU,GAAG,MAAA,MAAA,KAAK,CAAC,SAAS,0CAAE,UAAU,mCAAI,UAAU,CAAC,EAAE,CAAC;YAEhE,uBAAuB;YACvB,IAAI,UAAU,CAAC,qBAAqB,EAAE,EAAE,2EAA2E;gBACjH,UAAU,CAAC,qBAAqB,EAAE,CAAI,2EAA2E;qBAC9G,OAAO,CAAC,CAAC,IAAmB,EAAE,EAAE;oBAC/B,uBAAuB;oBACvB,IAAI,CAAC,CAAC,KAAK,cAAc,CAAC,SAAS,CAAC,CAAC,YAAY,EAAC,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAAE;wBAChF,cAAc,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;gBACjD,CAAC,CAAC,CAAC;aACN;QACH,CAAC,CAAC,CAAC;QACH,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,UAAU,CAAC,OAAe,EAAE,UAAkB,EAAE,QAA4B,EAAE,OAA2B,EAAE,YAAmC,EAAE,YAAkB;QAC9K,MAAM,OAAO,GAA0B,EAAE,CAAC;QAE1C,IAAI,CAAC,KAAK,cAAc,CAAC,2BAA2B,CAAC,IAAI;YACvD,OAAO,OAAO,CAAC;QAEjB,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,KAA0B,EAAE,EAAE;;YAChF,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC;YAClC,MAAM,UAAU,GAAG,MAAA,MAAA,KAAK,CAAC,SAAS,0CAAE,UAAU,mCAAI,UAAU,CAAC,EAAE,CAAC;YAEhE,uBAAuB;YACvB,IAAI,UAAU,CAAC,cAAc,IAAI,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE;gBACxF,UAAU,CAAC,cAAc,CAAC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,YAAY,EAAE,YAAY,CAAC;qBAC1F,OAAO,CAAC,CAAC,MAA2B,EAAE,EAAE;oBACvC,uBAAuB;oBACvB,IAAI,CAAC,CAAC,KAAK,OAAO,CAAC,SAAS,CAAC,CAAC,YAAY,EAAC,EAAE,CAAC,MAAM,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAAE;wBAC3E,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC;gBAC5C,CAAC,CAAC,CAAC;aACN;QACH,CAAC,CAAC,CAAC;QACH,OAAO,OAAO,CAAC;IACjB,CAAC;;AA9Lc,0CAA2B,GAAqC,IAAI,GAAG,EAA+B,CAAC;AAQtH,wEAAwE;AACjD,0CAA2B,GAAG,IAAI,OAAO,EAAmD,CAAC","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/* eslint-disable deprecation/deprecation */\r\n/** @packageDocumentation\r\n * @module UiItemsProvider\r\n */\r\n\r\nimport { BeEvent, Logger, MarkRequired } from \"@itwin/core-bentley\";\r\nimport { BackstageItem } from \"./backstage/BackstageItem\";\r\nimport { CommonStatusBarItem } from \"./statusbar/StatusBarItem\";\r\nimport { CommonToolbarItem, ToolbarOrientation, ToolbarUsage } from \"./toolbars/ToolbarItem\";\r\nimport { AbstractWidgetProps } from \"./widget/AbstractWidgetProps\";\r\nimport { AbstractZoneLocation, StagePanelLocation, StagePanelSection } from \"./widget/StagePanel\";\r\nimport { loggerCategory } from \"./utils/misc\";\r\nimport { UiItemsProvider } from \"./UiItemsProvider\";\r\n\r\n/** Action taken by the application on item provided by a UiItemsProvider\r\n * @public @deprecated in 3.2. This was only used by the previously removed UiItemsArbiter.\r\n */\r\nexport enum UiItemsApplicationAction {\r\n /** Allow the change to the item */\r\n Allow,\r\n /** Disallow the change to the item */\r\n Disallow,\r\n /** Update the item during the change */\r\n Update,\r\n}\r\n\r\n/** UIProvider Registered Event Args interface.\r\n * @deprecated in 3.6. Use [UiItemsProviderRegisteredEventArgs]($appui-react) instead.\r\n * @public\r\n */\r\nexport interface UiItemProviderRegisteredEventArgs {\r\n providerId: string;\r\n}\r\n\r\n/** UiItemProviderOverrides allows the application that registers a provider to limit when it is allowed to provide items\r\n * @deprecated in 3.6. Use [AllowedUiItemsProviderOverrides]($appui-react) instead.\r\n * @public\r\n */\r\nexport interface AllowedUiItemProviderOverrides {\r\n /** allows providerId to be overridden in the items manager for cases where the same provider needs to provide different content to different stages\r\n * @beta\r\n */\r\n providerId?: string;\r\n /** if specified then the current stage's Usage will be compared before allowing any items to be provided\r\n * @beta\r\n */\r\n stageUsages?: string[];\r\n /** if specified then the current stage's Id will be compared before allowing any items to be provided\r\n * @beta\r\n */\r\n stageIds?: string[];\r\n}\r\n\r\n/** Allowed overrides applied to a UiItemsProvider the application that registers a provider to limit when it is allowed to provide items.\r\n * Note that if an override `providerId` is specified then either `stageIds` or `stageUsages` must be defined to limit when the provider's\r\n * items are allowed.\r\n * @deprecated in 3.6. Use [UiItemsProviderOverrides]($appui-react) instead.\r\n * @public\r\n */\r\nexport type UiItemProviderOverrides = MarkRequired<AllowedUiItemProviderOverrides, \"providerId\" | \"stageUsages\"> |\r\n MarkRequired<AllowedUiItemProviderOverrides, \"providerId\" | \"stageIds\"> | // eslint-disable-line @typescript-eslint/indent\r\n MarkRequired<AllowedUiItemProviderOverrides, \"stageIds\"> | // eslint-disable-line @typescript-eslint/indent\r\n MarkRequired<AllowedUiItemProviderOverrides, \"stageUsages\"> | // eslint-disable-line @typescript-eslint/indent\r\n MarkRequired<AllowedUiItemProviderOverrides, \"providerId\" | \"stageUsages\" | \"stageIds\">; // eslint-disable-line @typescript-eslint/indent\r\n\r\n/** Interface that defines an instance of a UiItemsProvider and its application specified overrides. */\r\ninterface UiItemProviderEntry {\r\n provider: UiItemsProvider;\r\n overrides?: UiItemProviderOverrides;\r\n}\r\n\r\n/** Controls registering of UiItemsProviders and calls the provider's methods when populating different parts of the User Interface.\r\n * @deprecated in 3.6. Use [UiItemsManager]($appui-react) instead.\r\n * @public\r\n */\r\nexport class UiItemsManager {\r\n private static _registeredUiItemsProviders: Map<string, UiItemProviderEntry> = new Map<string, UiItemProviderEntry>();\r\n\r\n /** For use in unit testing\r\n * @internal */\r\n public static clearAllProviders() {\r\n UiItemsManager._registeredUiItemsProviders.clear();\r\n }\r\n\r\n /** Event raised any time a UiProvider is registered or unregistered. */\r\n public static readonly onUiProviderRegisteredEvent = new BeEvent<(ev: UiItemProviderRegisteredEventArgs) => void>();\r\n\r\n /** Return number of registered UiProvider. */\r\n public static get registeredProviderIds() {\r\n const ids = [...UiItemsManager._registeredUiItemsProviders.keys()];\r\n return ids;\r\n }\r\n\r\n /** Return true if there is any registered UiProvider. */\r\n public static get hasRegisteredProviders(): boolean {\r\n return this._registeredUiItemsProviders.size > 0;\r\n }\r\n\r\n /**\r\n * Retrieves a previously loaded UiItemsProvider.\r\n * @param providerId id of the UiItemsProvider to get\r\n */\r\n public static getUiItemsProvider(providerId: string): UiItemsProvider | undefined {\r\n return UiItemsManager._registeredUiItemsProviders.get(providerId)?.provider;\r\n }\r\n\r\n private static sendRegisteredEvent(ev: UiItemProviderRegisteredEventArgs) {\r\n UiItemsManager.onUiProviderRegisteredEvent.raiseEvent(ev);\r\n }\r\n\r\n /**\r\n * Registers a UiItemsProvider with the UiItemsManager.\r\n * @param uiProvider the UI items provider to register.\r\n */\r\n public static register(uiProvider: UiItemsProvider, overrides?: UiItemProviderOverrides): void {\r\n const providerId = overrides?.providerId ?? uiProvider.id;\r\n\r\n if (UiItemsManager.getUiItemsProvider(providerId)) {\r\n Logger.logInfo(loggerCategory(this), `UiItemsProvider (${providerId}) is already loaded`);\r\n } else {\r\n UiItemsManager._registeredUiItemsProviders.set(providerId, { provider: uiProvider, overrides });\r\n Logger.logInfo(loggerCategory(this), `UiItemsProvider ${uiProvider.id} registered as ${providerId} `);\r\n\r\n UiItemsManager.sendRegisteredEvent({ providerId } as UiItemProviderRegisteredEventArgs);\r\n }\r\n }\r\n\r\n /** Remove a specific UiItemsProvider from the list of available providers. */\r\n public static unregister(uiProviderId: string): void {\r\n const provider = UiItemsManager.getUiItemsProvider(uiProviderId);\r\n if (!provider)\r\n return;\r\n\r\n provider.onUnregister && provider.onUnregister();\r\n\r\n UiItemsManager._registeredUiItemsProviders.delete(uiProviderId);\r\n Logger.logInfo(loggerCategory(this), `UiItemsProvider (${uiProviderId}) unloaded`);\r\n\r\n // trigger a refresh of the ui\r\n UiItemsManager.sendRegisteredEvent({ providerId: uiProviderId } as UiItemProviderRegisteredEventArgs);\r\n }\r\n\r\n private static allowItemsFromProvider(entry: UiItemProviderEntry, stageId?: string, stageUsage?: string) {\r\n // istanbul ignore else\r\n const overrides = entry.overrides;\r\n if (undefined !== stageId && overrides?.stageIds && !(overrides.stageIds.some((value: string) => value === stageId)))\r\n return false;\r\n if (undefined !== stageUsage && overrides?.stageUsages && !(overrides.stageUsages.some((value: string) => value === stageUsage)))\r\n return false;\r\n return true;\r\n }\r\n\r\n /** Called when the application is populating a toolbar so that any registered UiItemsProvider can add tool buttons that either either execute\r\n * an action or specify a registered ToolId into toolbar.\r\n * @param stageId a string identifier the active stage.\r\n * @param stageUsage the StageUsage of the active stage.\r\n * @param toolbarUsage usage of the toolbar\r\n * @param toolbarOrientation orientation of the toolbar\r\n * @returns an array of error messages. The array will be empty if the load is successful, otherwise it is a list of one or more problems.\r\n */\r\n public static getToolbarButtonItems(stageId: string, stageUsage: string, toolbarUsage: ToolbarUsage,\r\n toolbarOrientation: ToolbarOrientation, stageAppData?: any): CommonToolbarItem[] {\r\n const buttonItems: CommonToolbarItem[] = [];\r\n if (0 === UiItemsManager._registeredUiItemsProviders.size)\r\n return buttonItems;\r\n\r\n UiItemsManager._registeredUiItemsProviders.forEach((entry: UiItemProviderEntry) => {\r\n const uiProvider = entry.provider;\r\n const providerId = entry.overrides?.providerId ?? uiProvider.id;\r\n // istanbul ignore else\r\n if (uiProvider.provideToolbarButtonItems && this.allowItemsFromProvider(entry, stageId, stageUsage)) {\r\n uiProvider.provideToolbarButtonItems(stageId, stageUsage, toolbarUsage, toolbarOrientation, stageAppData)\r\n .forEach((spec: CommonToolbarItem) => {\r\n // ignore duplicate ids\r\n if (-1 === buttonItems.findIndex((existingItem)=> spec.id === existingItem.id ))\r\n buttonItems.push({ ...spec, providerId });\r\n });\r\n }\r\n });\r\n\r\n return buttonItems;\r\n }\r\n\r\n /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields\r\n * @param stageId a string identifier the active stage.\r\n * @param stageUsage the StageUsage of the active stage.\r\n * @returns An array of CommonStatusBarItem that will be used to create controls for the status bar.\r\n */\r\n public static getStatusBarItems(stageId: string, stageUsage: string, stageAppData?: any): CommonStatusBarItem[] {\r\n const statusBarItems: CommonStatusBarItem[] = [];\r\n\r\n if (0 === UiItemsManager._registeredUiItemsProviders.size)\r\n return statusBarItems;\r\n\r\n UiItemsManager._registeredUiItemsProviders.forEach((entry: UiItemProviderEntry) => {\r\n const uiProvider = entry.provider;\r\n const providerId = entry.overrides?.providerId ?? uiProvider.id;\r\n\r\n // istanbul ignore else\r\n if (uiProvider.provideStatusBarItems && this.allowItemsFromProvider(entry, stageId, stageUsage)) {\r\n uiProvider.provideStatusBarItems(stageId, stageUsage, stageAppData)\r\n .forEach((item: CommonStatusBarItem) => {\r\n // ignore duplicate ids\r\n if (-1 === statusBarItems.findIndex((existingItem)=> item.id === existingItem.id ))\r\n statusBarItems.push({ ...item, providerId });\r\n });\r\n }\r\n });\r\n\r\n return statusBarItems;\r\n }\r\n\r\n /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields\r\n * @returns An array of BackstageItem that will be used to create controls for the backstage menu.\r\n */\r\n public static getBackstageItems(): BackstageItem[] {\r\n const backstageItems: BackstageItem[] = [];\r\n\r\n if (0 === UiItemsManager._registeredUiItemsProviders.size)\r\n return backstageItems;\r\n\r\n UiItemsManager._registeredUiItemsProviders.forEach((entry: UiItemProviderEntry) => {\r\n const uiProvider = entry.provider;\r\n const providerId = entry.overrides?.providerId ?? uiProvider.id;\r\n\r\n // istanbul ignore else\r\n if (uiProvider.provideBackstageItems) { // Note: We do not call this.allowItemsFromProvider here as backstage items\r\n uiProvider.provideBackstageItems() // should not be considered stage specific. If they need to be hidden\r\n .forEach((item: BackstageItem) => { // the isHidden property should be set to a ConditionalBooleanValue\r\n // ignore duplicate ids\r\n if (-1 === backstageItems.findIndex((existingItem)=> item.id === existingItem.id ))\r\n backstageItems.push({ ...item, providerId });\r\n });\r\n }\r\n });\r\n return backstageItems;\r\n }\r\n\r\n /** Called when the application is populating the Stage Panels so that any registered UiItemsProvider can add widgets\r\n * @param stageId a string identifier the active stage.\r\n * @param stageUsage the StageUsage of the active stage.\r\n * @param location the location within the stage.\r\n * @param section the section within location.\r\n * @returns An array of AbstractWidgetProps that will be used to create widgets.\r\n */\r\n public static getWidgets(stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection, zoneLocation?: AbstractZoneLocation, stageAppData?: any): ReadonlyArray<AbstractWidgetProps> {\r\n const widgets: AbstractWidgetProps[] = [];\r\n\r\n if (0 === UiItemsManager._registeredUiItemsProviders.size)\r\n return widgets;\r\n\r\n UiItemsManager._registeredUiItemsProviders.forEach((entry: UiItemProviderEntry) => {\r\n const uiProvider = entry.provider;\r\n const providerId = entry.overrides?.providerId ?? uiProvider.id;\r\n\r\n // istanbul ignore else\r\n if (uiProvider.provideWidgets && this.allowItemsFromProvider(entry, stageId, stageUsage)) {\r\n uiProvider.provideWidgets(stageId, stageUsage, location, section, zoneLocation, stageAppData)\r\n .forEach((widget: AbstractWidgetProps) => {\r\n // ignore duplicate ids\r\n if (-1 === widgets.findIndex((existingItem)=> widget.id === existingItem.id ))\r\n widgets.push({ ...widget, providerId });\r\n });\r\n }\r\n });\r\n return widgets;\r\n }\r\n\r\n}\r\n"]}
1
+ {"version":3,"file":"UiItemsManager.js","sourceRoot":"","sources":["../../../src/appui-abstract/UiItemsManager.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F,4CAA4C;AAC5C;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,EAAgB,MAAM,qBAAqB,CAAC;AAMpE,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAG9C;;GAEG;AACH,MAAM,CAAN,IAAY,wBAOX;AAPD,WAAY,wBAAwB;IAClC,mCAAmC;IACnC,yEAAK,CAAA;IACL,sCAAsC;IACtC,+EAAQ,CAAA;IACR,wCAAwC;IACxC,2EAAM,CAAA;AACR,CAAC,EAPW,wBAAwB,KAAxB,wBAAwB,QAOnC;AA+CD;;;GAGG;AACH,MAAa,cAAc;IAGzB;mBACe;IACR,MAAM,CAAC,iBAAiB;QAC7B,cAAc,CAAC,2BAA2B,CAAC,KAAK,EAAE,CAAC;IACrD,CAAC;IAKD,8CAA8C;IACvC,MAAM,KAAK,qBAAqB;QACrC,MAAM,GAAG,GAAG,CAAC,GAAG,cAAc,CAAC,2BAA2B,CAAC,IAAI,EAAE,CAAC,CAAC;QACnE,OAAO,GAAG,CAAC;IACb,CAAC;IAED,yDAAyD;IAClD,MAAM,KAAK,sBAAsB;QACtC,OAAO,IAAI,CAAC,2BAA2B,CAAC,IAAI,GAAG,CAAC,CAAC;IACnD,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,kBAAkB,CAAC,UAAkB;QACjD,OAAO,cAAc,CAAC,2BAA2B,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,QAAQ,CAAC;IAC9E,CAAC;IAEO,MAAM,CAAC,mBAAmB,CAAC,EAAqC;QACtE,cAAc,CAAC,2BAA2B,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED;;;OAGG;IACI,MAAM,CAAC,QAAQ,CAAC,UAA2B,EAAE,SAAmC;QACrF,MAAM,UAAU,GAAG,SAAS,EAAE,UAAU,IAAI,UAAU,CAAC,EAAE,CAAC;QAE1D,IAAI,cAAc,CAAC,kBAAkB,CAAC,UAAU,CAAC,EAAE;YACjD,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,oBAAoB,UAAU,qBAAqB,CAAC,CAAC;SAC3F;aAAM;YACL,cAAc,CAAC,2BAA2B,CAAC,GAAG,CAAC,UAAU,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC,CAAC;YAChG,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,mBAAmB,UAAU,CAAC,EAAE,kBAAkB,UAAU,GAAG,CAAC,CAAC;YAEtG,cAAc,CAAC,mBAAmB,CAAC,EAAE,UAAU,EAAuC,CAAC,CAAC;SACzF;IACH,CAAC;IAED,8EAA8E;IACvE,MAAM,CAAC,UAAU,CAAC,YAAoB;QAC3C,MAAM,QAAQ,GAAG,cAAc,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC;QACjE,IAAI,CAAC,QAAQ;YACX,OAAO;QAET,QAAQ,CAAC,YAAY,IAAI,QAAQ,CAAC,YAAY,EAAE,CAAC;QAEjD,cAAc,CAAC,2BAA2B,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;QAChE,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,oBAAoB,YAAY,YAAY,CAAC,CAAC;QAEnF,8BAA8B;QAC9B,cAAc,CAAC,mBAAmB,CAAC,EAAE,UAAU,EAAE,YAAY,EAAuC,CAAC,CAAC;IACxG,CAAC;IAEO,MAAM,CAAC,sBAAsB,CAAC,KAA0B,EAAE,OAAgB,EAAE,UAAmB;QACrG,uBAAuB;QACvB,MAAM,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;QAClC,IAAI,SAAS,KAAK,OAAO,IAAI,SAAS,EAAE,QAAQ,IAAI,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK,KAAK,OAAO,CAAC,CAAC;YAClH,OAAO,KAAK,CAAC;QACf,IAAI,SAAS,KAAK,UAAU,IAAI,SAAS,EAAE,WAAW,IAAI,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK,KAAK,UAAU,CAAC,CAAC;YAC9H,OAAO,KAAK,CAAC;QACf,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;OAOG;IACI,MAAM,CAAC,qBAAqB,CAAC,OAAe,EAAE,UAAkB,EAAE,YAA0B,EACjG,kBAAsC,EAAE,YAAkB;QAC1D,MAAM,WAAW,GAAwB,EAAE,CAAC;QAC5C,IAAI,CAAC,KAAK,cAAc,CAAC,2BAA2B,CAAC,IAAI;YACvD,OAAO,WAAW,CAAC;QAErB,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,KAA0B,EAAE,EAAE;YAChF,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC;YAClC,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,EAAE,UAAU,IAAI,UAAU,CAAC,EAAE,CAAC;YAChE,uBAAuB;YACvB,IAAI,UAAU,CAAC,yBAAyB,IAAI,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE;gBACnG,UAAU,CAAC,yBAAyB,CAAC,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,kBAAkB,EAAE,YAAY,CAAC;qBACtG,OAAO,CAAC,CAAC,IAAuB,EAAE,EAAE;oBACnC,uBAAuB;oBACvB,IAAI,CAAC,CAAC,KAAK,WAAW,CAAC,SAAS,CAAC,CAAC,YAAY,EAAC,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAAE;wBAC7E,WAAW,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;gBAC9C,CAAC,CAAC,CAAC;aACN;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,WAAW,CAAC;IACrB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,iBAAiB,CAAC,OAAe,EAAE,UAAkB,EAAE,YAAkB;QACrF,MAAM,cAAc,GAA0B,EAAE,CAAC;QAEjD,IAAI,CAAC,KAAK,cAAc,CAAC,2BAA2B,CAAC,IAAI;YACvD,OAAO,cAAc,CAAC;QAExB,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,KAA0B,EAAE,EAAE;YAChF,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC;YAClC,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,EAAE,UAAU,IAAI,UAAU,CAAC,EAAE,CAAC;YAEhE,uBAAuB;YACvB,IAAI,UAAU,CAAC,qBAAqB,IAAI,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE;gBAC/F,UAAU,CAAC,qBAAqB,CAAC,OAAO,EAAE,UAAU,EAAE,YAAY,CAAC;qBAChE,OAAO,CAAC,CAAC,IAAyB,EAAE,EAAE;oBACrC,uBAAuB;oBACvB,IAAI,CAAC,CAAC,KAAK,cAAc,CAAC,SAAS,CAAC,CAAC,YAAY,EAAC,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAAE;wBAChF,cAAc,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;gBACjD,CAAC,CAAC,CAAC;aACN;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,iBAAiB;QAC7B,MAAM,cAAc,GAAoB,EAAE,CAAC;QAE3C,IAAI,CAAC,KAAK,cAAc,CAAC,2BAA2B,CAAC,IAAI;YACvD,OAAO,cAAc,CAAC;QAExB,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,KAA0B,EAAE,EAAE;YAChF,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC;YAClC,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,EAAE,UAAU,IAAI,UAAU,CAAC,EAAE,CAAC;YAEhE,uBAAuB;YACvB,IAAI,UAAU,CAAC,qBAAqB,EAAE,EAAE,2EAA2E;gBACjH,UAAU,CAAC,qBAAqB,EAAE,CAAI,2EAA2E;qBAC9G,OAAO,CAAC,CAAC,IAAmB,EAAE,EAAE;oBAC/B,uBAAuB;oBACvB,IAAI,CAAC,CAAC,KAAK,cAAc,CAAC,SAAS,CAAC,CAAC,YAAY,EAAC,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAAE;wBAChF,cAAc,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,EAAE,UAAU,EAAE,CAAC,CAAC;gBACjD,CAAC,CAAC,CAAC;aACN;QACH,CAAC,CAAC,CAAC;QACH,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,UAAU,CAAC,OAAe,EAAE,UAAkB,EAAE,QAA4B,EAAE,OAA2B,EAAE,YAAmC,EAAE,YAAkB;QAC9K,MAAM,OAAO,GAA0B,EAAE,CAAC;QAE1C,IAAI,CAAC,KAAK,cAAc,CAAC,2BAA2B,CAAC,IAAI;YACvD,OAAO,OAAO,CAAC;QAEjB,cAAc,CAAC,2BAA2B,CAAC,OAAO,CAAC,CAAC,KAA0B,EAAE,EAAE;YAChF,MAAM,UAAU,GAAG,KAAK,CAAC,QAAQ,CAAC;YAClC,MAAM,UAAU,GAAG,KAAK,CAAC,SAAS,EAAE,UAAU,IAAI,UAAU,CAAC,EAAE,CAAC;YAEhE,uBAAuB;YACvB,IAAI,UAAU,CAAC,cAAc,IAAI,IAAI,CAAC,sBAAsB,CAAC,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE;gBACxF,UAAU,CAAC,cAAc,CAAC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,YAAY,EAAE,YAAY,CAAC;qBAC1F,OAAO,CAAC,CAAC,MAA2B,EAAE,EAAE;oBACvC,uBAAuB;oBACvB,IAAI,CAAC,CAAC,KAAK,OAAO,CAAC,SAAS,CAAC,CAAC,YAAY,EAAC,EAAE,CAAC,MAAM,CAAC,EAAE,KAAK,YAAY,CAAC,EAAE,CAAE;wBAC3E,OAAO,CAAC,IAAI,CAAC,EAAE,GAAG,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC;gBAC5C,CAAC,CAAC,CAAC;aACN;QACH,CAAC,CAAC,CAAC;QACH,OAAO,OAAO,CAAC;IACjB,CAAC;;AA9Lc,0CAA2B,GAAqC,IAAI,GAAG,EAA+B,CAAC;AAQtH,wEAAwE;AACjD,0CAA2B,GAAG,IAAI,OAAO,EAAmD,CAAC;SAVzG,cAAc","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/* eslint-disable deprecation/deprecation */\n/** @packageDocumentation\n * @module UiItemsProvider\n */\n\nimport { BeEvent, Logger, MarkRequired } from \"@itwin/core-bentley\";\nimport { BackstageItem } from \"./backstage/BackstageItem\";\nimport { CommonStatusBarItem } from \"./statusbar/StatusBarItem\";\nimport { CommonToolbarItem, ToolbarOrientation, ToolbarUsage } from \"./toolbars/ToolbarItem\";\nimport { AbstractWidgetProps } from \"./widget/AbstractWidgetProps\";\nimport { AbstractZoneLocation, StagePanelLocation, StagePanelSection } from \"./widget/StagePanel\";\nimport { loggerCategory } from \"./utils/misc\";\nimport { UiItemsProvider } from \"./UiItemsProvider\";\n\n/** Action taken by the application on item provided by a UiItemsProvider\n * @public @deprecated in 3.2. This was only used by the previously removed UiItemsArbiter.\n */\nexport enum UiItemsApplicationAction {\n /** Allow the change to the item */\n Allow,\n /** Disallow the change to the item */\n Disallow,\n /** Update the item during the change */\n Update,\n}\n\n/** UIProvider Registered Event Args interface.\n * @deprecated in 3.6. Use [UiItemsProviderRegisteredEventArgs]($appui-react) instead.\n * @public\n */\nexport interface UiItemProviderRegisteredEventArgs {\n providerId: string;\n}\n\n/** UiItemProviderOverrides allows the application that registers a provider to limit when it is allowed to provide items\n * @deprecated in 3.6. Use [AllowedUiItemsProviderOverrides]($appui-react) instead.\n * @public\n */\nexport interface AllowedUiItemProviderOverrides {\n /** allows providerId to be overridden in the items manager for cases where the same provider needs to provide different content to different stages\n * @beta\n */\n providerId?: string;\n /** if specified then the current stage's Usage will be compared before allowing any items to be provided\n * @beta\n */\n stageUsages?: string[];\n /** if specified then the current stage's Id will be compared before allowing any items to be provided\n * @beta\n */\n stageIds?: string[];\n}\n\n/** Allowed overrides applied to a UiItemsProvider the application that registers a provider to limit when it is allowed to provide items.\n * Note that if an override `providerId` is specified then either `stageIds` or `stageUsages` must be defined to limit when the provider's\n * items are allowed.\n * @deprecated in 3.6. Use [UiItemsProviderOverrides]($appui-react) instead.\n * @public\n */\nexport type UiItemProviderOverrides = MarkRequired<AllowedUiItemProviderOverrides, \"providerId\" | \"stageUsages\"> |\n MarkRequired<AllowedUiItemProviderOverrides, \"providerId\" | \"stageIds\"> | // eslint-disable-line @typescript-eslint/indent\n MarkRequired<AllowedUiItemProviderOverrides, \"stageIds\"> | // eslint-disable-line @typescript-eslint/indent\n MarkRequired<AllowedUiItemProviderOverrides, \"stageUsages\"> | // eslint-disable-line @typescript-eslint/indent\n MarkRequired<AllowedUiItemProviderOverrides, \"providerId\" | \"stageUsages\" | \"stageIds\">; // eslint-disable-line @typescript-eslint/indent\n\n/** Interface that defines an instance of a UiItemsProvider and its application specified overrides. */\ninterface UiItemProviderEntry {\n provider: UiItemsProvider;\n overrides?: UiItemProviderOverrides;\n}\n\n/** Controls registering of UiItemsProviders and calls the provider's methods when populating different parts of the User Interface.\n * @deprecated in 3.6. Use [UiItemsManager]($appui-react) instead.\n * @public\n */\nexport class UiItemsManager {\n private static _registeredUiItemsProviders: Map<string, UiItemProviderEntry> = new Map<string, UiItemProviderEntry>();\n\n /** For use in unit testing\n * @internal */\n public static clearAllProviders() {\n UiItemsManager._registeredUiItemsProviders.clear();\n }\n\n /** Event raised any time a UiProvider is registered or unregistered. */\n public static readonly onUiProviderRegisteredEvent = new BeEvent<(ev: UiItemProviderRegisteredEventArgs) => void>();\n\n /** Return number of registered UiProvider. */\n public static get registeredProviderIds() {\n const ids = [...UiItemsManager._registeredUiItemsProviders.keys()];\n return ids;\n }\n\n /** Return true if there is any registered UiProvider. */\n public static get hasRegisteredProviders(): boolean {\n return this._registeredUiItemsProviders.size > 0;\n }\n\n /**\n * Retrieves a previously loaded UiItemsProvider.\n * @param providerId id of the UiItemsProvider to get\n */\n public static getUiItemsProvider(providerId: string): UiItemsProvider | undefined {\n return UiItemsManager._registeredUiItemsProviders.get(providerId)?.provider;\n }\n\n private static sendRegisteredEvent(ev: UiItemProviderRegisteredEventArgs) {\n UiItemsManager.onUiProviderRegisteredEvent.raiseEvent(ev);\n }\n\n /**\n * Registers a UiItemsProvider with the UiItemsManager.\n * @param uiProvider the UI items provider to register.\n */\n public static register(uiProvider: UiItemsProvider, overrides?: UiItemProviderOverrides): void {\n const providerId = overrides?.providerId ?? uiProvider.id;\n\n if (UiItemsManager.getUiItemsProvider(providerId)) {\n Logger.logInfo(loggerCategory(this), `UiItemsProvider (${providerId}) is already loaded`);\n } else {\n UiItemsManager._registeredUiItemsProviders.set(providerId, { provider: uiProvider, overrides });\n Logger.logInfo(loggerCategory(this), `UiItemsProvider ${uiProvider.id} registered as ${providerId} `);\n\n UiItemsManager.sendRegisteredEvent({ providerId } as UiItemProviderRegisteredEventArgs);\n }\n }\n\n /** Remove a specific UiItemsProvider from the list of available providers. */\n public static unregister(uiProviderId: string): void {\n const provider = UiItemsManager.getUiItemsProvider(uiProviderId);\n if (!provider)\n return;\n\n provider.onUnregister && provider.onUnregister();\n\n UiItemsManager._registeredUiItemsProviders.delete(uiProviderId);\n Logger.logInfo(loggerCategory(this), `UiItemsProvider (${uiProviderId}) unloaded`);\n\n // trigger a refresh of the ui\n UiItemsManager.sendRegisteredEvent({ providerId: uiProviderId } as UiItemProviderRegisteredEventArgs);\n }\n\n private static allowItemsFromProvider(entry: UiItemProviderEntry, stageId?: string, stageUsage?: string) {\n // istanbul ignore else\n const overrides = entry.overrides;\n if (undefined !== stageId && overrides?.stageIds && !(overrides.stageIds.some((value: string) => value === stageId)))\n return false;\n if (undefined !== stageUsage && overrides?.stageUsages && !(overrides.stageUsages.some((value: string) => value === stageUsage)))\n return false;\n return true;\n }\n\n /** Called when the application is populating a toolbar so that any registered UiItemsProvider can add tool buttons that either either execute\n * an action or specify a registered ToolId into toolbar.\n * @param stageId a string identifier the active stage.\n * @param stageUsage the StageUsage of the active stage.\n * @param toolbarUsage usage of the toolbar\n * @param toolbarOrientation orientation of the toolbar\n * @returns an array of error messages. The array will be empty if the load is successful, otherwise it is a list of one or more problems.\n */\n public static getToolbarButtonItems(stageId: string, stageUsage: string, toolbarUsage: ToolbarUsage,\n toolbarOrientation: ToolbarOrientation, stageAppData?: any): CommonToolbarItem[] {\n const buttonItems: CommonToolbarItem[] = [];\n if (0 === UiItemsManager._registeredUiItemsProviders.size)\n return buttonItems;\n\n UiItemsManager._registeredUiItemsProviders.forEach((entry: UiItemProviderEntry) => {\n const uiProvider = entry.provider;\n const providerId = entry.overrides?.providerId ?? uiProvider.id;\n // istanbul ignore else\n if (uiProvider.provideToolbarButtonItems && this.allowItemsFromProvider(entry, stageId, stageUsage)) {\n uiProvider.provideToolbarButtonItems(stageId, stageUsage, toolbarUsage, toolbarOrientation, stageAppData)\n .forEach((spec: CommonToolbarItem) => {\n // ignore duplicate ids\n if (-1 === buttonItems.findIndex((existingItem)=> spec.id === existingItem.id ))\n buttonItems.push({ ...spec, providerId });\n });\n }\n });\n\n return buttonItems;\n }\n\n /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields\n * @param stageId a string identifier the active stage.\n * @param stageUsage the StageUsage of the active stage.\n * @returns An array of CommonStatusBarItem that will be used to create controls for the status bar.\n */\n public static getStatusBarItems(stageId: string, stageUsage: string, stageAppData?: any): CommonStatusBarItem[] {\n const statusBarItems: CommonStatusBarItem[] = [];\n\n if (0 === UiItemsManager._registeredUiItemsProviders.size)\n return statusBarItems;\n\n UiItemsManager._registeredUiItemsProviders.forEach((entry: UiItemProviderEntry) => {\n const uiProvider = entry.provider;\n const providerId = entry.overrides?.providerId ?? uiProvider.id;\n\n // istanbul ignore else\n if (uiProvider.provideStatusBarItems && this.allowItemsFromProvider(entry, stageId, stageUsage)) {\n uiProvider.provideStatusBarItems(stageId, stageUsage, stageAppData)\n .forEach((item: CommonStatusBarItem) => {\n // ignore duplicate ids\n if (-1 === statusBarItems.findIndex((existingItem)=> item.id === existingItem.id ))\n statusBarItems.push({ ...item, providerId });\n });\n }\n });\n\n return statusBarItems;\n }\n\n /** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields\n * @returns An array of BackstageItem that will be used to create controls for the backstage menu.\n */\n public static getBackstageItems(): BackstageItem[] {\n const backstageItems: BackstageItem[] = [];\n\n if (0 === UiItemsManager._registeredUiItemsProviders.size)\n return backstageItems;\n\n UiItemsManager._registeredUiItemsProviders.forEach((entry: UiItemProviderEntry) => {\n const uiProvider = entry.provider;\n const providerId = entry.overrides?.providerId ?? uiProvider.id;\n\n // istanbul ignore else\n if (uiProvider.provideBackstageItems) { // Note: We do not call this.allowItemsFromProvider here as backstage items\n uiProvider.provideBackstageItems() // should not be considered stage specific. If they need to be hidden\n .forEach((item: BackstageItem) => { // the isHidden property should be set to a ConditionalBooleanValue\n // ignore duplicate ids\n if (-1 === backstageItems.findIndex((existingItem)=> item.id === existingItem.id ))\n backstageItems.push({ ...item, providerId });\n });\n }\n });\n return backstageItems;\n }\n\n /** Called when the application is populating the Stage Panels so that any registered UiItemsProvider can add widgets\n * @param stageId a string identifier the active stage.\n * @param stageUsage the StageUsage of the active stage.\n * @param location the location within the stage.\n * @param section the section within location.\n * @returns An array of AbstractWidgetProps that will be used to create widgets.\n */\n public static getWidgets(stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection, zoneLocation?: AbstractZoneLocation, stageAppData?: any): ReadonlyArray<AbstractWidgetProps> {\n const widgets: AbstractWidgetProps[] = [];\n\n if (0 === UiItemsManager._registeredUiItemsProviders.size)\n return widgets;\n\n UiItemsManager._registeredUiItemsProviders.forEach((entry: UiItemProviderEntry) => {\n const uiProvider = entry.provider;\n const providerId = entry.overrides?.providerId ?? uiProvider.id;\n\n // istanbul ignore else\n if (uiProvider.provideWidgets && this.allowItemsFromProvider(entry, stageId, stageUsage)) {\n uiProvider.provideWidgets(stageId, stageUsage, location, section, zoneLocation, stageAppData)\n .forEach((widget: AbstractWidgetProps) => {\n // ignore duplicate ids\n if (-1 === widgets.findIndex((existingItem)=> widget.id === existingItem.id ))\n widgets.push({ ...widget, providerId });\n });\n }\n });\n return widgets;\n }\n\n}\n"]}
@@ -1,30 +1,30 @@
1
- /** @packageDocumentation
2
- * @module UiItemsProvider
3
- */
4
- import { BackstageItem } from "./backstage/BackstageItem";
5
- import { CommonStatusBarItem } from "./statusbar/StatusBarItem";
6
- import { CommonToolbarItem, ToolbarOrientation, ToolbarUsage } from "./toolbars/ToolbarItem";
7
- import { AbstractWidgetProps } from "./widget/AbstractWidgetProps";
8
- import { AbstractZoneLocation, StagePanelLocation, StagePanelSection } from "./widget/StagePanel";
9
- /** Describes interface of objects that want to provide UI component to the running IModelApp.
10
- * @deprecated in 3.6. Use [UiItemsProvider]($appui-react) instead.
11
- * @public
12
- */
13
- export interface UiItemsProvider {
14
- /** id of provider */
15
- readonly id: string;
16
- /** UiItemsManager calls following method to get items to populate specific toolbars */
17
- provideToolbarButtonItems?: (stageId: string, stageUsage: string, toolbarUsage: ToolbarUsage, toolbarOrientation: ToolbarOrientation, stageAppData?: any) => CommonToolbarItem[];
18
- /** UiItemsManager calls following method to augment base statusbar for stages that allow it. */
19
- provideStatusBarItems?: (stageId: string, stageUsage: string, stageAppData?: any) => CommonStatusBarItem[];
20
- /** UiItemsManager calls following method to augment backstage items. */
21
- provideBackstageItems?: () => BackstageItem[];
22
- /** UiItemsManager calls following method to augment Widget lists.
23
- * @note Returned widgets must provide unique `AbstractWidgetProps["id"]` to correctly save/restore App layout.
24
- */
25
- provideWidgets?: (stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection, // eslint-disable-line deprecation/deprecation
26
- zoneLocation?: AbstractZoneLocation, stageAppData?: any) => ReadonlyArray<AbstractWidgetProps>;
27
- /** Function called when the provider is unregistered via `ItemsManager.unregister` to allow provider to do cleanup. */
28
- onUnregister?: () => void;
29
- }
1
+ /** @packageDocumentation
2
+ * @module UiItemsProvider
3
+ */
4
+ import { BackstageItem } from "./backstage/BackstageItem";
5
+ import { CommonStatusBarItem } from "./statusbar/StatusBarItem";
6
+ import { CommonToolbarItem, ToolbarOrientation, ToolbarUsage } from "./toolbars/ToolbarItem";
7
+ import { AbstractWidgetProps } from "./widget/AbstractWidgetProps";
8
+ import { AbstractZoneLocation, StagePanelLocation, StagePanelSection } from "./widget/StagePanel";
9
+ /** Describes interface of objects that want to provide UI component to the running IModelApp.
10
+ * @deprecated in 3.6. Use [UiItemsProvider]($appui-react) instead.
11
+ * @public
12
+ */
13
+ export interface UiItemsProvider {
14
+ /** id of provider */
15
+ readonly id: string;
16
+ /** UiItemsManager calls following method to get items to populate specific toolbars */
17
+ provideToolbarButtonItems?: (stageId: string, stageUsage: string, toolbarUsage: ToolbarUsage, toolbarOrientation: ToolbarOrientation, stageAppData?: any) => CommonToolbarItem[];
18
+ /** UiItemsManager calls following method to augment base statusbar for stages that allow it. */
19
+ provideStatusBarItems?: (stageId: string, stageUsage: string, stageAppData?: any) => CommonStatusBarItem[];
20
+ /** UiItemsManager calls following method to augment backstage items. */
21
+ provideBackstageItems?: () => BackstageItem[];
22
+ /** UiItemsManager calls following method to augment Widget lists.
23
+ * @note Returned widgets must provide unique `AbstractWidgetProps["id"]` to correctly save/restore App layout.
24
+ */
25
+ provideWidgets?: (stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection, // eslint-disable-line deprecation/deprecation
26
+ zoneLocation?: AbstractZoneLocation, stageAppData?: any) => ReadonlyArray<AbstractWidgetProps>;
27
+ /** Function called when the provider is unregistered via `ItemsManager.unregister` to allow provider to do cleanup. */
28
+ onUnregister?: () => void;
29
+ }
30
30
  //# sourceMappingURL=UiItemsProvider.d.ts.map
@@ -1,9 +1,9 @@
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 UiItemsProvider
7
- */
8
- export {};
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 UiItemsProvider
7
+ */
8
+ export {};
9
9
  //# sourceMappingURL=UiItemsProvider.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"UiItemsProvider.js","sourceRoot":"","sources":["../../../src/appui-abstract/UiItemsProvider.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","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 UiItemsProvider\r\n */\r\n\r\nimport { BackstageItem } from \"./backstage/BackstageItem\";\r\nimport { CommonStatusBarItem } from \"./statusbar/StatusBarItem\";\r\nimport { CommonToolbarItem, ToolbarOrientation, ToolbarUsage } from \"./toolbars/ToolbarItem\";\r\nimport { AbstractWidgetProps } from \"./widget/AbstractWidgetProps\";\r\nimport { AbstractZoneLocation, StagePanelLocation, StagePanelSection } from \"./widget/StagePanel\";\r\n\r\n/** Describes interface of objects that want to provide UI component to the running IModelApp.\r\n * @deprecated in 3.6. Use [UiItemsProvider]($appui-react) instead.\r\n * @public\r\n */\r\nexport interface UiItemsProvider {\r\n /** id of provider */\r\n readonly id: string;\r\n\r\n /** UiItemsManager calls following method to get items to populate specific toolbars */\r\n provideToolbarButtonItems?: (stageId: string, stageUsage: string, toolbarUsage: ToolbarUsage, toolbarOrientation: ToolbarOrientation, stageAppData?: any) => CommonToolbarItem[]; // eslint-disable-line deprecation/deprecation\r\n /** UiItemsManager calls following method to augment base statusbar for stages that allow it. */\r\n provideStatusBarItems?: (stageId: string, stageUsage: string, stageAppData?: any) => CommonStatusBarItem[]; // eslint-disable-line deprecation/deprecation\r\n /** UiItemsManager calls following method to augment backstage items. */\r\n provideBackstageItems?: () => BackstageItem[]; // eslint-disable-line deprecation/deprecation\r\n /** UiItemsManager calls following method to augment Widget lists.\r\n * @note Returned widgets must provide unique `AbstractWidgetProps[\"id\"]` to correctly save/restore App layout.\r\n */\r\n provideWidgets?: (stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection, // eslint-disable-line deprecation/deprecation\r\n zoneLocation?: AbstractZoneLocation, stageAppData?: any) => ReadonlyArray<AbstractWidgetProps>; // eslint-disable-line deprecation/deprecation\r\n /** Function called when the provider is unregistered via `ItemsManager.unregister` to allow provider to do cleanup. */\r\n onUnregister?: () => void;\r\n}\r\n"]}
1
+ {"version":3,"file":"UiItemsProvider.js","sourceRoot":"","sources":["../../../src/appui-abstract/UiItemsProvider.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module UiItemsProvider\n */\n\nimport { BackstageItem } from \"./backstage/BackstageItem\";\nimport { CommonStatusBarItem } from \"./statusbar/StatusBarItem\";\nimport { CommonToolbarItem, ToolbarOrientation, ToolbarUsage } from \"./toolbars/ToolbarItem\";\nimport { AbstractWidgetProps } from \"./widget/AbstractWidgetProps\";\nimport { AbstractZoneLocation, StagePanelLocation, StagePanelSection } from \"./widget/StagePanel\";\n\n/** Describes interface of objects that want to provide UI component to the running IModelApp.\n * @deprecated in 3.6. Use [UiItemsProvider]($appui-react) instead.\n * @public\n */\nexport interface UiItemsProvider {\n /** id of provider */\n readonly id: string;\n\n /** UiItemsManager calls following method to get items to populate specific toolbars */\n provideToolbarButtonItems?: (stageId: string, stageUsage: string, toolbarUsage: ToolbarUsage, toolbarOrientation: ToolbarOrientation, stageAppData?: any) => CommonToolbarItem[]; // eslint-disable-line deprecation/deprecation\n /** UiItemsManager calls following method to augment base statusbar for stages that allow it. */\n provideStatusBarItems?: (stageId: string, stageUsage: string, stageAppData?: any) => CommonStatusBarItem[]; // eslint-disable-line deprecation/deprecation\n /** UiItemsManager calls following method to augment backstage items. */\n provideBackstageItems?: () => BackstageItem[]; // eslint-disable-line deprecation/deprecation\n /** UiItemsManager calls following method to augment Widget lists.\n * @note Returned widgets must provide unique `AbstractWidgetProps[\"id\"]` to correctly save/restore App layout.\n */\n provideWidgets?: (stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection, // eslint-disable-line deprecation/deprecation\n zoneLocation?: AbstractZoneLocation, stageAppData?: any) => ReadonlyArray<AbstractWidgetProps>; // eslint-disable-line deprecation/deprecation\n /** Function called when the provider is unregistered via `ItemsManager.unregister` to allow provider to do cleanup. */\n onUnregister?: () => void;\n}\n"]}