@itwin/appui-abstract 3.4.0-dev.57 → 3.4.0-dev.58

Sign up to get free protection for your applications and to get access to all the features.
Files changed (307) hide show
  1. package/lib/cjs/appui-abstract/BaseUiItemsProvider.d.ts +30 -30
  2. package/lib/cjs/appui-abstract/BaseUiItemsProvider.js +79 -79
  3. package/lib/cjs/appui-abstract/BaseUiItemsProvider.js.map +1 -1
  4. package/lib/cjs/appui-abstract/UiAdmin.d.ts +221 -221
  5. package/lib/cjs/appui-abstract/UiAdmin.js +224 -224
  6. package/lib/cjs/appui-abstract/UiAdmin.js.map +1 -1
  7. package/lib/cjs/appui-abstract/UiItemsManager.d.ts +110 -110
  8. package/lib/cjs/appui-abstract/UiItemsManager.js +199 -199
  9. package/lib/cjs/appui-abstract/UiItemsManager.js.map +1 -1
  10. package/lib/cjs/appui-abstract/UiItemsProvider.d.ts +27 -27
  11. package/lib/cjs/appui-abstract/UiItemsProvider.js +10 -10
  12. package/lib/cjs/appui-abstract/UiItemsProvider.js.map +1 -1
  13. package/lib/cjs/appui-abstract/backstage/BackstageItem.d.ts +83 -83
  14. package/lib/cjs/appui-abstract/backstage/BackstageItem.js +64 -64
  15. package/lib/cjs/appui-abstract/backstage/BackstageItem.js.map +1 -1
  16. package/lib/cjs/appui-abstract/backstage/BackstageItemsManager.d.ts +38 -38
  17. package/lib/cjs/appui-abstract/backstage/BackstageItemsManager.js +133 -133
  18. package/lib/cjs/appui-abstract/backstage/BackstageItemsManager.js.map +1 -1
  19. package/lib/cjs/appui-abstract/common/KeyboardKey.d.ts +51 -51
  20. package/lib/cjs/appui-abstract/common/KeyboardKey.js +63 -63
  21. package/lib/cjs/appui-abstract/common/KeyboardKey.js.map +1 -1
  22. package/lib/cjs/appui-abstract/content/ContentLayoutProps.d.ts +62 -62
  23. package/lib/cjs/appui-abstract/content/ContentLayoutProps.js +9 -9
  24. package/lib/cjs/appui-abstract/content/ContentLayoutProps.js.map +1 -1
  25. package/lib/cjs/appui-abstract/content/StandardContentLayouts.d.ts +19 -19
  26. package/lib/cjs/appui-abstract/content/StandardContentLayouts.js +108 -108
  27. package/lib/cjs/appui-abstract/content/StandardContentLayouts.js.map +1 -1
  28. package/lib/cjs/appui-abstract/dialogs/DialogItem.d.ts +76 -76
  29. package/lib/cjs/appui-abstract/dialogs/DialogItem.js +67 -67
  30. package/lib/cjs/appui-abstract/dialogs/DialogItem.js.map +1 -1
  31. package/lib/cjs/appui-abstract/dialogs/UiDataProvider.d.ts +55 -55
  32. package/lib/cjs/appui-abstract/dialogs/UiDataProvider.js +66 -66
  33. package/lib/cjs/appui-abstract/dialogs/UiDataProvider.js.map +1 -1
  34. package/lib/cjs/appui-abstract/dialogs/UiLayoutDataProvider.d.ts +97 -97
  35. package/lib/cjs/appui-abstract/dialogs/UiLayoutDataProvider.js +175 -175
  36. package/lib/cjs/appui-abstract/dialogs/UiLayoutDataProvider.js.map +1 -1
  37. package/lib/cjs/appui-abstract/items/AbstractItemProps.d.ts +53 -53
  38. package/lib/cjs/appui-abstract/items/AbstractItemProps.js +9 -9
  39. package/lib/cjs/appui-abstract/items/AbstractItemProps.js.map +1 -1
  40. package/lib/cjs/appui-abstract/items/AbstractMenuItemProps.d.ts +20 -20
  41. package/lib/cjs/appui-abstract/items/AbstractMenuItemProps.js +9 -9
  42. package/lib/cjs/appui-abstract/items/AbstractMenuItemProps.js.map +1 -1
  43. package/lib/cjs/appui-abstract/items/AbstractToolbarProps.d.ts +13 -13
  44. package/lib/cjs/appui-abstract/items/AbstractToolbarProps.js +9 -9
  45. package/lib/cjs/appui-abstract/items/AbstractToolbarProps.js.map +1 -1
  46. package/lib/cjs/appui-abstract/items/BadgeType.d.ts +14 -14
  47. package/lib/cjs/appui-abstract/items/BadgeType.js +22 -22
  48. package/lib/cjs/appui-abstract/items/BadgeType.js.map +1 -1
  49. package/lib/cjs/appui-abstract/items/ConditionalBooleanValue.d.ts +27 -27
  50. package/lib/cjs/appui-abstract/items/ConditionalBooleanValue.js +60 -60
  51. package/lib/cjs/appui-abstract/items/ConditionalBooleanValue.js.map +1 -1
  52. package/lib/cjs/appui-abstract/items/ConditionalStringValue.d.ts +29 -29
  53. package/lib/cjs/appui-abstract/items/ConditionalStringValue.js +62 -62
  54. package/lib/cjs/appui-abstract/items/ConditionalStringValue.js.map +1 -1
  55. package/lib/cjs/appui-abstract/items/ProvidedItem.d.ts +10 -10
  56. package/lib/cjs/appui-abstract/items/ProvidedItem.js +9 -9
  57. package/lib/cjs/appui-abstract/items/ProvidedItem.js.map +1 -1
  58. package/lib/cjs/appui-abstract/items/RelativePosition.d.ts +18 -18
  59. package/lib/cjs/appui-abstract/items/RelativePosition.js +26 -26
  60. package/lib/cjs/appui-abstract/items/RelativePosition.js.map +1 -1
  61. package/lib/cjs/appui-abstract/items/StageUsage.d.ts +15 -15
  62. package/lib/cjs/appui-abstract/items/StageUsage.js +23 -23
  63. package/lib/cjs/appui-abstract/items/StageUsage.js.map +1 -1
  64. package/lib/cjs/appui-abstract/notification/MessagePresenter.d.ts +42 -42
  65. package/lib/cjs/appui-abstract/notification/MessagePresenter.js +24 -24
  66. package/lib/cjs/appui-abstract/notification/MessagePresenter.js.map +1 -1
  67. package/lib/cjs/appui-abstract/notification/MessageSeverity.d.ts +15 -15
  68. package/lib/cjs/appui-abstract/notification/MessageSeverity.js +23 -23
  69. package/lib/cjs/appui-abstract/notification/MessageSeverity.js.map +1 -1
  70. package/lib/cjs/appui-abstract/properties/Description.d.ts +127 -127
  71. package/lib/cjs/appui-abstract/properties/Description.js +196 -196
  72. package/lib/cjs/appui-abstract/properties/Description.js.map +1 -1
  73. package/lib/cjs/appui-abstract/properties/EditorParams.d.ts +260 -260
  74. package/lib/cjs/appui-abstract/properties/EditorParams.js +106 -106
  75. package/lib/cjs/appui-abstract/properties/EditorParams.js.map +1 -1
  76. package/lib/cjs/appui-abstract/properties/PrimitiveTypes.d.ts +60 -60
  77. package/lib/cjs/appui-abstract/properties/PrimitiveTypes.js +9 -9
  78. package/lib/cjs/appui-abstract/properties/PrimitiveTypes.js.map +1 -1
  79. package/lib/cjs/appui-abstract/properties/Record.d.ts +57 -57
  80. package/lib/cjs/appui-abstract/properties/Record.js +78 -78
  81. package/lib/cjs/appui-abstract/properties/Record.js.map +1 -1
  82. package/lib/cjs/appui-abstract/properties/StandardEditorNames.d.ts +22 -22
  83. package/lib/cjs/appui-abstract/properties/StandardEditorNames.js +30 -30
  84. package/lib/cjs/appui-abstract/properties/StandardEditorNames.js.map +1 -1
  85. package/lib/cjs/appui-abstract/properties/StandardTypeNames.d.ts +30 -30
  86. package/lib/cjs/appui-abstract/properties/StandardTypeNames.js +39 -39
  87. package/lib/cjs/appui-abstract/properties/StandardTypeNames.js.map +1 -1
  88. package/lib/cjs/appui-abstract/properties/Value.d.ts +49 -49
  89. package/lib/cjs/appui-abstract/properties/Value.js +20 -20
  90. package/lib/cjs/appui-abstract/properties/Value.js.map +1 -1
  91. package/lib/cjs/appui-abstract/quantity/BaseQuantityDescription.d.ts +22 -22
  92. package/lib/cjs/appui-abstract/quantity/BaseQuantityDescription.js +48 -48
  93. package/lib/cjs/appui-abstract/quantity/BaseQuantityDescription.js.map +1 -1
  94. package/lib/cjs/appui-abstract/statusbar/StatusBarItem.d.ts +116 -116
  95. package/lib/cjs/appui-abstract/statusbar/StatusBarItem.js +81 -81
  96. package/lib/cjs/appui-abstract/statusbar/StatusBarItem.js.map +1 -1
  97. package/lib/cjs/appui-abstract/statusbar/StatusBarItemsManager.d.ts +39 -39
  98. package/lib/cjs/appui-abstract/statusbar/StatusBarItemsManager.js +135 -135
  99. package/lib/cjs/appui-abstract/statusbar/StatusBarItemsManager.js.map +1 -1
  100. package/lib/cjs/appui-abstract/toolbars/ToolbarItem.d.ts +118 -118
  101. package/lib/cjs/appui-abstract/toolbars/ToolbarItem.js +62 -62
  102. package/lib/cjs/appui-abstract/toolbars/ToolbarItem.js.map +1 -1
  103. package/lib/cjs/appui-abstract/toolbars/ToolbarItemsManager.d.ts +45 -45
  104. package/lib/cjs/appui-abstract/toolbars/ToolbarItemsManager.js +235 -235
  105. package/lib/cjs/appui-abstract/toolbars/ToolbarItemsManager.js.map +1 -1
  106. package/lib/cjs/appui-abstract/utils/IconSpecUtilities.d.ts +29 -29
  107. package/lib/cjs/appui-abstract/utils/IconSpecUtilities.js +51 -51
  108. package/lib/cjs/appui-abstract/utils/IconSpecUtilities.js.map +1 -1
  109. package/lib/cjs/appui-abstract/utils/PointProps.d.ts +10 -10
  110. package/lib/cjs/appui-abstract/utils/PointProps.js +9 -9
  111. package/lib/cjs/appui-abstract/utils/PointProps.js.map +1 -1
  112. package/lib/cjs/appui-abstract/utils/UiError.d.ts +12 -12
  113. package/lib/cjs/appui-abstract/utils/UiError.js +22 -22
  114. package/lib/cjs/appui-abstract/utils/UiError.js.map +1 -1
  115. package/lib/cjs/appui-abstract/utils/UiEvent.d.ts +9 -9
  116. package/lib/cjs/appui-abstract/utils/UiEvent.js +17 -17
  117. package/lib/cjs/appui-abstract/utils/UiEvent.js.map +1 -1
  118. package/lib/cjs/appui-abstract/utils/UiEventDispatcher.d.ts +46 -46
  119. package/lib/cjs/appui-abstract/utils/UiEventDispatcher.js +131 -131
  120. package/lib/cjs/appui-abstract/utils/UiEventDispatcher.js.map +1 -1
  121. package/lib/cjs/appui-abstract/utils/callbacks.d.ts +20 -20
  122. package/lib/cjs/appui-abstract/utils/callbacks.js +9 -9
  123. package/lib/cjs/appui-abstract/utils/callbacks.js.map +1 -1
  124. package/lib/cjs/appui-abstract/utils/filter/charCode.d.ts +416 -416
  125. package/lib/cjs/appui-abstract/utils/filter/charCode.js +6 -6
  126. package/lib/cjs/appui-abstract/utils/filter/charCode.js.map +1 -1
  127. package/lib/cjs/appui-abstract/utils/filter/filters.d.ts +98 -98
  128. package/lib/cjs/appui-abstract/utils/filter/filters.js +709 -709
  129. package/lib/cjs/appui-abstract/utils/filter/filters.js.map +1 -1
  130. package/lib/cjs/appui-abstract/utils/filter/map.d.ts +59 -59
  131. package/lib/cjs/appui-abstract/utils/filter/map.js +404 -404
  132. package/lib/cjs/appui-abstract/utils/filter/map.js.map +1 -1
  133. package/lib/cjs/appui-abstract/utils/filter/strings.d.ts +20 -20
  134. package/lib/cjs/appui-abstract/utils/filter/strings.js +78 -78
  135. package/lib/cjs/appui-abstract/utils/filter/strings.js.map +1 -1
  136. package/lib/cjs/appui-abstract/utils/isLetter.d.ts +9 -9
  137. package/lib/cjs/appui-abstract/utils/isLetter.js +19 -19
  138. package/lib/cjs/appui-abstract/utils/isLetter.js.map +1 -1
  139. package/lib/cjs/appui-abstract/utils/misc.d.ts +11 -11
  140. package/lib/cjs/appui-abstract/utils/misc.js +36 -36
  141. package/lib/cjs/appui-abstract/utils/misc.js.map +1 -1
  142. package/lib/cjs/appui-abstract/widget/AbstractWidgetProps.d.ts +80 -80
  143. package/lib/cjs/appui-abstract/widget/AbstractWidgetProps.js +9 -9
  144. package/lib/cjs/appui-abstract/widget/AbstractWidgetProps.js.map +1 -1
  145. package/lib/cjs/appui-abstract/widget/StagePanel.d.ts +32 -32
  146. package/lib/cjs/appui-abstract/widget/StagePanel.js +42 -42
  147. package/lib/cjs/appui-abstract/widget/StagePanel.js.map +1 -1
  148. package/lib/cjs/appui-abstract/widget/WidgetState.d.ts +18 -18
  149. package/lib/cjs/appui-abstract/widget/WidgetState.js +26 -26
  150. package/lib/cjs/appui-abstract/widget/WidgetState.js.map +1 -1
  151. package/lib/cjs/appui-abstract.d.ts +105 -105
  152. package/lib/cjs/appui-abstract.js +121 -121
  153. package/lib/cjs/appui-abstract.js.map +1 -1
  154. package/lib/esm/appui-abstract/BaseUiItemsProvider.d.ts +30 -30
  155. package/lib/esm/appui-abstract/BaseUiItemsProvider.js +75 -75
  156. package/lib/esm/appui-abstract/BaseUiItemsProvider.js.map +1 -1
  157. package/lib/esm/appui-abstract/UiAdmin.d.ts +221 -221
  158. package/lib/esm/appui-abstract/UiAdmin.js +219 -219
  159. package/lib/esm/appui-abstract/UiAdmin.js.map +1 -1
  160. package/lib/esm/appui-abstract/UiItemsManager.d.ts +110 -110
  161. package/lib/esm/appui-abstract/UiItemsManager.js +195 -195
  162. package/lib/esm/appui-abstract/UiItemsManager.js.map +1 -1
  163. package/lib/esm/appui-abstract/UiItemsProvider.d.ts +27 -27
  164. package/lib/esm/appui-abstract/UiItemsProvider.js +9 -9
  165. package/lib/esm/appui-abstract/UiItemsProvider.js.map +1 -1
  166. package/lib/esm/appui-abstract/backstage/BackstageItem.d.ts +83 -83
  167. package/lib/esm/appui-abstract/backstage/BackstageItem.js +58 -58
  168. package/lib/esm/appui-abstract/backstage/BackstageItem.js.map +1 -1
  169. package/lib/esm/appui-abstract/backstage/BackstageItemsManager.d.ts +38 -38
  170. package/lib/esm/appui-abstract/backstage/BackstageItemsManager.js +129 -129
  171. package/lib/esm/appui-abstract/backstage/BackstageItemsManager.js.map +1 -1
  172. package/lib/esm/appui-abstract/common/KeyboardKey.d.ts +51 -51
  173. package/lib/esm/appui-abstract/common/KeyboardKey.js +59 -59
  174. package/lib/esm/appui-abstract/common/KeyboardKey.js.map +1 -1
  175. package/lib/esm/appui-abstract/content/ContentLayoutProps.d.ts +62 -62
  176. package/lib/esm/appui-abstract/content/ContentLayoutProps.js +8 -8
  177. package/lib/esm/appui-abstract/content/ContentLayoutProps.js.map +1 -1
  178. package/lib/esm/appui-abstract/content/StandardContentLayouts.d.ts +19 -19
  179. package/lib/esm/appui-abstract/content/StandardContentLayouts.js +104 -104
  180. package/lib/esm/appui-abstract/content/StandardContentLayouts.js.map +1 -1
  181. package/lib/esm/appui-abstract/dialogs/DialogItem.d.ts +76 -76
  182. package/lib/esm/appui-abstract/dialogs/DialogItem.js +63 -63
  183. package/lib/esm/appui-abstract/dialogs/DialogItem.js.map +1 -1
  184. package/lib/esm/appui-abstract/dialogs/UiDataProvider.d.ts +55 -55
  185. package/lib/esm/appui-abstract/dialogs/UiDataProvider.js +61 -61
  186. package/lib/esm/appui-abstract/dialogs/UiDataProvider.js.map +1 -1
  187. package/lib/esm/appui-abstract/dialogs/UiLayoutDataProvider.d.ts +97 -97
  188. package/lib/esm/appui-abstract/dialogs/UiLayoutDataProvider.js +170 -170
  189. package/lib/esm/appui-abstract/dialogs/UiLayoutDataProvider.js.map +1 -1
  190. package/lib/esm/appui-abstract/items/AbstractItemProps.d.ts +53 -53
  191. package/lib/esm/appui-abstract/items/AbstractItemProps.js +8 -8
  192. package/lib/esm/appui-abstract/items/AbstractItemProps.js.map +1 -1
  193. package/lib/esm/appui-abstract/items/AbstractMenuItemProps.d.ts +20 -20
  194. package/lib/esm/appui-abstract/items/AbstractMenuItemProps.js +8 -8
  195. package/lib/esm/appui-abstract/items/AbstractMenuItemProps.js.map +1 -1
  196. package/lib/esm/appui-abstract/items/AbstractToolbarProps.d.ts +13 -13
  197. package/lib/esm/appui-abstract/items/AbstractToolbarProps.js +8 -8
  198. package/lib/esm/appui-abstract/items/AbstractToolbarProps.js.map +1 -1
  199. package/lib/esm/appui-abstract/items/BadgeType.d.ts +14 -14
  200. package/lib/esm/appui-abstract/items/BadgeType.js +19 -19
  201. package/lib/esm/appui-abstract/items/BadgeType.js.map +1 -1
  202. package/lib/esm/appui-abstract/items/ConditionalBooleanValue.d.ts +27 -27
  203. package/lib/esm/appui-abstract/items/ConditionalBooleanValue.js +56 -56
  204. package/lib/esm/appui-abstract/items/ConditionalBooleanValue.js.map +1 -1
  205. package/lib/esm/appui-abstract/items/ConditionalStringValue.d.ts +29 -29
  206. package/lib/esm/appui-abstract/items/ConditionalStringValue.js +58 -58
  207. package/lib/esm/appui-abstract/items/ConditionalStringValue.js.map +1 -1
  208. package/lib/esm/appui-abstract/items/ProvidedItem.d.ts +10 -10
  209. package/lib/esm/appui-abstract/items/ProvidedItem.js +8 -8
  210. package/lib/esm/appui-abstract/items/ProvidedItem.js.map +1 -1
  211. package/lib/esm/appui-abstract/items/RelativePosition.d.ts +18 -18
  212. package/lib/esm/appui-abstract/items/RelativePosition.js +23 -23
  213. package/lib/esm/appui-abstract/items/RelativePosition.js.map +1 -1
  214. package/lib/esm/appui-abstract/items/StageUsage.d.ts +15 -15
  215. package/lib/esm/appui-abstract/items/StageUsage.js +20 -20
  216. package/lib/esm/appui-abstract/items/StageUsage.js.map +1 -1
  217. package/lib/esm/appui-abstract/notification/MessagePresenter.d.ts +42 -42
  218. package/lib/esm/appui-abstract/notification/MessagePresenter.js +21 -21
  219. package/lib/esm/appui-abstract/notification/MessagePresenter.js.map +1 -1
  220. package/lib/esm/appui-abstract/notification/MessageSeverity.d.ts +15 -15
  221. package/lib/esm/appui-abstract/notification/MessageSeverity.js +20 -20
  222. package/lib/esm/appui-abstract/notification/MessageSeverity.js.map +1 -1
  223. package/lib/esm/appui-abstract/properties/Description.d.ts +127 -127
  224. package/lib/esm/appui-abstract/properties/Description.js +192 -192
  225. package/lib/esm/appui-abstract/properties/Description.js.map +1 -1
  226. package/lib/esm/appui-abstract/properties/EditorParams.d.ts +260 -260
  227. package/lib/esm/appui-abstract/properties/EditorParams.js +97 -97
  228. package/lib/esm/appui-abstract/properties/EditorParams.js.map +1 -1
  229. package/lib/esm/appui-abstract/properties/PrimitiveTypes.d.ts +60 -60
  230. package/lib/esm/appui-abstract/properties/PrimitiveTypes.js +8 -8
  231. package/lib/esm/appui-abstract/properties/PrimitiveTypes.js.map +1 -1
  232. package/lib/esm/appui-abstract/properties/Record.d.ts +57 -57
  233. package/lib/esm/appui-abstract/properties/Record.js +74 -74
  234. package/lib/esm/appui-abstract/properties/Record.js.map +1 -1
  235. package/lib/esm/appui-abstract/properties/StandardEditorNames.d.ts +22 -22
  236. package/lib/esm/appui-abstract/properties/StandardEditorNames.js +27 -27
  237. package/lib/esm/appui-abstract/properties/StandardEditorNames.js.map +1 -1
  238. package/lib/esm/appui-abstract/properties/StandardTypeNames.d.ts +30 -30
  239. package/lib/esm/appui-abstract/properties/StandardTypeNames.js +36 -36
  240. package/lib/esm/appui-abstract/properties/StandardTypeNames.js.map +1 -1
  241. package/lib/esm/appui-abstract/properties/Value.d.ts +49 -49
  242. package/lib/esm/appui-abstract/properties/Value.js +17 -17
  243. package/lib/esm/appui-abstract/properties/Value.js.map +1 -1
  244. package/lib/esm/appui-abstract/quantity/BaseQuantityDescription.d.ts +22 -22
  245. package/lib/esm/appui-abstract/quantity/BaseQuantityDescription.js +44 -44
  246. package/lib/esm/appui-abstract/quantity/BaseQuantityDescription.js.map +1 -1
  247. package/lib/esm/appui-abstract/statusbar/StatusBarItem.d.ts +116 -116
  248. package/lib/esm/appui-abstract/statusbar/StatusBarItem.js +74 -74
  249. package/lib/esm/appui-abstract/statusbar/StatusBarItem.js.map +1 -1
  250. package/lib/esm/appui-abstract/statusbar/StatusBarItemsManager.d.ts +39 -39
  251. package/lib/esm/appui-abstract/statusbar/StatusBarItemsManager.js +131 -131
  252. package/lib/esm/appui-abstract/statusbar/StatusBarItemsManager.js.map +1 -1
  253. package/lib/esm/appui-abstract/toolbars/ToolbarItem.d.ts +118 -118
  254. package/lib/esm/appui-abstract/toolbars/ToolbarItem.js +58 -58
  255. package/lib/esm/appui-abstract/toolbars/ToolbarItem.js.map +1 -1
  256. package/lib/esm/appui-abstract/toolbars/ToolbarItemsManager.d.ts +45 -45
  257. package/lib/esm/appui-abstract/toolbars/ToolbarItemsManager.js +231 -231
  258. package/lib/esm/appui-abstract/toolbars/ToolbarItemsManager.js.map +1 -1
  259. package/lib/esm/appui-abstract/utils/IconSpecUtilities.d.ts +29 -29
  260. package/lib/esm/appui-abstract/utils/IconSpecUtilities.js +47 -47
  261. package/lib/esm/appui-abstract/utils/IconSpecUtilities.js.map +1 -1
  262. package/lib/esm/appui-abstract/utils/PointProps.d.ts +10 -10
  263. package/lib/esm/appui-abstract/utils/PointProps.js +8 -8
  264. package/lib/esm/appui-abstract/utils/PointProps.js.map +1 -1
  265. package/lib/esm/appui-abstract/utils/UiError.d.ts +12 -12
  266. package/lib/esm/appui-abstract/utils/UiError.js +18 -18
  267. package/lib/esm/appui-abstract/utils/UiError.js.map +1 -1
  268. package/lib/esm/appui-abstract/utils/UiEvent.d.ts +9 -9
  269. package/lib/esm/appui-abstract/utils/UiEvent.js +13 -13
  270. package/lib/esm/appui-abstract/utils/UiEvent.js.map +1 -1
  271. package/lib/esm/appui-abstract/utils/UiEventDispatcher.d.ts +46 -46
  272. package/lib/esm/appui-abstract/utils/UiEventDispatcher.js +126 -126
  273. package/lib/esm/appui-abstract/utils/UiEventDispatcher.js.map +1 -1
  274. package/lib/esm/appui-abstract/utils/callbacks.d.ts +20 -20
  275. package/lib/esm/appui-abstract/utils/callbacks.js +8 -8
  276. package/lib/esm/appui-abstract/utils/callbacks.js.map +1 -1
  277. package/lib/esm/appui-abstract/utils/filter/charCode.d.ts +416 -416
  278. package/lib/esm/appui-abstract/utils/filter/charCode.js +5 -5
  279. package/lib/esm/appui-abstract/utils/filter/charCode.js.map +1 -1
  280. package/lib/esm/appui-abstract/utils/filter/filters.d.ts +98 -98
  281. package/lib/esm/appui-abstract/utils/filter/filters.js +694 -694
  282. package/lib/esm/appui-abstract/utils/filter/filters.js.map +1 -1
  283. package/lib/esm/appui-abstract/utils/filter/map.d.ts +59 -59
  284. package/lib/esm/appui-abstract/utils/filter/map.js +399 -399
  285. package/lib/esm/appui-abstract/utils/filter/map.js.map +1 -1
  286. package/lib/esm/appui-abstract/utils/filter/strings.d.ts +20 -20
  287. package/lib/esm/appui-abstract/utils/filter/strings.js +70 -70
  288. package/lib/esm/appui-abstract/utils/filter/strings.js.map +1 -1
  289. package/lib/esm/appui-abstract/utils/isLetter.d.ts +9 -9
  290. package/lib/esm/appui-abstract/utils/isLetter.js +15 -15
  291. package/lib/esm/appui-abstract/utils/isLetter.js.map +1 -1
  292. package/lib/esm/appui-abstract/utils/misc.d.ts +11 -11
  293. package/lib/esm/appui-abstract/utils/misc.js +31 -31
  294. package/lib/esm/appui-abstract/utils/misc.js.map +1 -1
  295. package/lib/esm/appui-abstract/widget/AbstractWidgetProps.d.ts +80 -80
  296. package/lib/esm/appui-abstract/widget/AbstractWidgetProps.js +8 -8
  297. package/lib/esm/appui-abstract/widget/AbstractWidgetProps.js.map +1 -1
  298. package/lib/esm/appui-abstract/widget/StagePanel.d.ts +32 -32
  299. package/lib/esm/appui-abstract/widget/StagePanel.js +39 -39
  300. package/lib/esm/appui-abstract/widget/StagePanel.js.map +1 -1
  301. package/lib/esm/appui-abstract/widget/WidgetState.d.ts +18 -18
  302. package/lib/esm/appui-abstract/widget/WidgetState.js +23 -23
  303. package/lib/esm/appui-abstract/widget/WidgetState.js.map +1 -1
  304. package/lib/esm/appui-abstract.d.ts +105 -105
  305. package/lib/esm/appui-abstract.js +109 -109
  306. package/lib/esm/appui-abstract.js.map +1 -1
  307. package/package.json +5 -5
@@ -1,23 +1,23 @@
1
- /** @packageDocumentation
2
- * @module Properties
3
- */
4
- import { PropertyDescription, PropertyEditorInfo } from "../properties/Description";
5
- import { ParseResults } from "../properties/EditorParams";
6
- /**
7
- * Base Quantity Property Description
8
- * @beta
9
- */
10
- export declare abstract class BaseQuantityDescription implements PropertyDescription {
11
- name: string;
12
- displayLabel: string;
13
- typename: string;
14
- editor: PropertyEditorInfo;
15
- constructor(name: string, displayLabel: string, iconSpec?: string);
16
- protected abstract formatValue(numberValue: number): string;
17
- format: (numberValue: number) => string;
18
- protected abstract parseString(userInput: string): ParseResults;
19
- parse: (userInput: string) => ParseResults;
20
- abstract get quantityType(): string;
21
- abstract get parseError(): string;
22
- }
1
+ /** @packageDocumentation
2
+ * @module Properties
3
+ */
4
+ import { PropertyDescription, PropertyEditorInfo } from "../properties/Description";
5
+ import { ParseResults } from "../properties/EditorParams";
6
+ /**
7
+ * Base Quantity Property Description
8
+ * @beta
9
+ */
10
+ export declare abstract class BaseQuantityDescription implements PropertyDescription {
11
+ name: string;
12
+ displayLabel: string;
13
+ typename: string;
14
+ editor: PropertyEditorInfo;
15
+ constructor(name: string, displayLabel: string, iconSpec?: string);
16
+ protected abstract formatValue(numberValue: number): string;
17
+ format: (numberValue: number) => string;
18
+ protected abstract parseString(userInput: string): ParseResults;
19
+ parse: (userInput: string) => ParseResults;
20
+ abstract get quantityType(): string;
21
+ abstract get parseError(): string;
22
+ }
23
23
  //# sourceMappingURL=BaseQuantityDescription.d.ts.map
@@ -1,45 +1,45 @@
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 Properties
7
- */
8
- import { PropertyEditorParamTypes } from "../properties/EditorParams";
9
- import { StandardTypeNames } from "../properties/StandardTypeNames";
10
- import { StandardEditorNames } from "../properties/StandardEditorNames";
11
- /**
12
- * Base Quantity Property Description
13
- * @beta
14
- */
15
- export class BaseQuantityDescription {
16
- constructor(name, displayLabel, iconSpec) {
17
- this.format = (numberValue) => {
18
- return this.formatValue(numberValue);
19
- };
20
- this.parse = (userInput) => {
21
- return this.parseString(userInput);
22
- };
23
- this.name = name;
24
- this.displayLabel = displayLabel;
25
- this.typename = StandardTypeNames.Number;
26
- this.editor = {
27
- name: StandardEditorNames.NumberCustom,
28
- params: [{
29
- type: PropertyEditorParamTypes.CustomFormattedNumber,
30
- formatFunction: this.format,
31
- parseFunction: this.parse,
32
- },
33
- ],
34
- };
35
- // istanbul ignore else
36
- if (iconSpec) {
37
- const params = {
38
- type: PropertyEditorParamTypes.Icon,
39
- definition: { iconSpec },
40
- };
41
- this.editor.params.push(params);
42
- }
43
- }
44
- }
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 Properties
7
+ */
8
+ import { PropertyEditorParamTypes } from "../properties/EditorParams";
9
+ import { StandardTypeNames } from "../properties/StandardTypeNames";
10
+ import { StandardEditorNames } from "../properties/StandardEditorNames";
11
+ /**
12
+ * Base Quantity Property Description
13
+ * @beta
14
+ */
15
+ export class BaseQuantityDescription {
16
+ constructor(name, displayLabel, iconSpec) {
17
+ this.format = (numberValue) => {
18
+ return this.formatValue(numberValue);
19
+ };
20
+ this.parse = (userInput) => {
21
+ return this.parseString(userInput);
22
+ };
23
+ this.name = name;
24
+ this.displayLabel = displayLabel;
25
+ this.typename = StandardTypeNames.Number;
26
+ this.editor = {
27
+ name: StandardEditorNames.NumberCustom,
28
+ params: [{
29
+ type: PropertyEditorParamTypes.CustomFormattedNumber,
30
+ formatFunction: this.format,
31
+ parseFunction: this.parse,
32
+ },
33
+ ],
34
+ };
35
+ // istanbul ignore else
36
+ if (iconSpec) {
37
+ const params = {
38
+ type: PropertyEditorParamTypes.Icon,
39
+ definition: { iconSpec },
40
+ };
41
+ this.editor.params.push(params);
42
+ }
43
+ }
44
+ }
45
45
  //# sourceMappingURL=BaseQuantityDescription.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"BaseQuantityDescription.js","sourceRoot":"","sources":["../../../../src/appui-abstract/quantity/BaseQuantityDescription.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAA+D,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AACnI,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AAExE;;;GAGG;AACH,MAAM,OAAgB,uBAAuB;IAM3C,YAAY,IAAY,EAAE,YAAoB,EAAE,QAAiB;QA0B1D,WAAM,GAAG,CAAC,WAAmB,EAAU,EAAE;YAC9C,OAAO,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;QACvC,CAAC,CAAC;QAGK,UAAK,GAAG,CAAC,SAAiB,EAAgB,EAAE;YACjD,OAAO,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;QACrC,CAAC,CAAC;QAhCA,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,QAAQ,GAAG,iBAAiB,CAAC,MAAM,CAAC;QACzC,IAAI,CAAC,MAAM,GAAG;YACZ,IAAI,EAAE,mBAAmB,CAAC,YAAY;YACtC,MAAM,EAAE,CAAC;oBACP,IAAI,EAAE,wBAAwB,CAAC,qBAAqB;oBACpD,cAAc,EAAE,IAAI,CAAC,MAAM;oBAC3B,aAAa,EAAE,IAAI,CAAC,KAAK;iBACK;aAC/B;SACF,CAAC;QAEF,uBAAuB;QACvB,IAAI,QAAQ,EAAE;YACZ,MAAM,MAAM,GAAqB;gBAC/B,IAAI,EAAE,wBAAwB,CAAC,IAAI;gBACnC,UAAU,EAAE,EAAE,QAAQ,EAAE;aACzB,CAAC;YACF,IAAI,CAAC,MAAM,CAAC,MAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SAClC;IACH,CAAC;CAiBF","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 Properties\n */\n\nimport { PropertyDescription, PropertyEditorInfo } from \"../properties/Description\";\nimport { CustomFormattedNumberParams, IconEditorParams, ParseResults, PropertyEditorParamTypes } from \"../properties/EditorParams\";\nimport { StandardTypeNames } from \"../properties/StandardTypeNames\";\nimport { StandardEditorNames } from \"../properties/StandardEditorNames\";\n\n/**\n * Base Quantity Property Description\n * @beta\n */\nexport abstract class BaseQuantityDescription implements PropertyDescription {\n public name: string;\n public displayLabel: string;\n public typename: string;\n public editor: PropertyEditorInfo;\n\n constructor(name: string, displayLabel: string, iconSpec?: string) {\n this.name = name;\n this.displayLabel = displayLabel;\n this.typename = StandardTypeNames.Number;\n this.editor = {\n name: StandardEditorNames.NumberCustom,\n params: [{\n type: PropertyEditorParamTypes.CustomFormattedNumber,\n formatFunction: this.format,\n parseFunction: this.parse,\n } as CustomFormattedNumberParams,\n ],\n };\n\n // istanbul ignore else\n if (iconSpec) {\n const params: IconEditorParams = {\n type: PropertyEditorParamTypes.Icon,\n definition: { iconSpec },\n };\n this.editor.params!.push(params);\n }\n }\n\n protected abstract formatValue(numberValue: number): string;\n\n public format = (numberValue: number): string => {\n return this.formatValue(numberValue);\n };\n protected abstract parseString(userInput: string): ParseResults;\n\n public parse = (userInput: string): ParseResults => {\n return this.parseString(userInput);\n };\n\n public abstract get quantityType(): string;\n\n public abstract get parseError(): string;\n\n}\n"]}
1
+ {"version":3,"file":"BaseQuantityDescription.js","sourceRoot":"","sources":["../../../../src/appui-abstract/quantity/BaseQuantityDescription.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAGH,OAAO,EAA+D,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AACnI,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,EAAE,mBAAmB,EAAE,MAAM,mCAAmC,CAAC;AAExE;;;GAGG;AACH,MAAM,OAAgB,uBAAuB;IAM3C,YAAY,IAAY,EAAE,YAAoB,EAAE,QAAiB;QA0B1D,WAAM,GAAG,CAAC,WAAmB,EAAU,EAAE;YAC9C,OAAO,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;QACvC,CAAC,CAAC;QAGK,UAAK,GAAG,CAAC,SAAiB,EAAgB,EAAE;YACjD,OAAO,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;QACrC,CAAC,CAAC;QAhCA,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,YAAY,GAAG,YAAY,CAAC;QACjC,IAAI,CAAC,QAAQ,GAAG,iBAAiB,CAAC,MAAM,CAAC;QACzC,IAAI,CAAC,MAAM,GAAG;YACZ,IAAI,EAAE,mBAAmB,CAAC,YAAY;YACtC,MAAM,EAAE,CAAC;oBACP,IAAI,EAAE,wBAAwB,CAAC,qBAAqB;oBACpD,cAAc,EAAE,IAAI,CAAC,MAAM;oBAC3B,aAAa,EAAE,IAAI,CAAC,KAAK;iBACK;aAC/B;SACF,CAAC;QAEF,uBAAuB;QACvB,IAAI,QAAQ,EAAE;YACZ,MAAM,MAAM,GAAqB;gBAC/B,IAAI,EAAE,wBAAwB,CAAC,IAAI;gBACnC,UAAU,EAAE,EAAE,QAAQ,EAAE;aACzB,CAAC;YACF,IAAI,CAAC,MAAM,CAAC,MAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SAClC;IACH,CAAC;CAiBF","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 Properties\r\n */\r\n\r\nimport { PropertyDescription, PropertyEditorInfo } from \"../properties/Description\";\r\nimport { CustomFormattedNumberParams, IconEditorParams, ParseResults, PropertyEditorParamTypes } from \"../properties/EditorParams\";\r\nimport { StandardTypeNames } from \"../properties/StandardTypeNames\";\r\nimport { StandardEditorNames } from \"../properties/StandardEditorNames\";\r\n\r\n/**\r\n * Base Quantity Property Description\r\n * @beta\r\n */\r\nexport abstract class BaseQuantityDescription implements PropertyDescription {\r\n public name: string;\r\n public displayLabel: string;\r\n public typename: string;\r\n public editor: PropertyEditorInfo;\r\n\r\n constructor(name: string, displayLabel: string, iconSpec?: string) {\r\n this.name = name;\r\n this.displayLabel = displayLabel;\r\n this.typename = StandardTypeNames.Number;\r\n this.editor = {\r\n name: StandardEditorNames.NumberCustom,\r\n params: [{\r\n type: PropertyEditorParamTypes.CustomFormattedNumber,\r\n formatFunction: this.format,\r\n parseFunction: this.parse,\r\n } as CustomFormattedNumberParams,\r\n ],\r\n };\r\n\r\n // istanbul ignore else\r\n if (iconSpec) {\r\n const params: IconEditorParams = {\r\n type: PropertyEditorParamTypes.Icon,\r\n definition: { iconSpec },\r\n };\r\n this.editor.params!.push(params);\r\n }\r\n }\r\n\r\n protected abstract formatValue(numberValue: number): string;\r\n\r\n public format = (numberValue: number): string => {\r\n return this.formatValue(numberValue);\r\n };\r\n protected abstract parseString(userInput: string): ParseResults;\r\n\r\n public parse = (userInput: string): ParseResults => {\r\n return this.parseString(userInput);\r\n };\r\n\r\n public abstract get quantityType(): string;\r\n\r\n public abstract get parseError(): string;\r\n\r\n}\r\n"]}
@@ -1,117 +1,117 @@
1
- /** @packageDocumentation
2
- * @module StatusBar
3
- */
4
- import { BadgeType } from "../items/BadgeType";
5
- import { ConditionalBooleanValue } from "../items/ConditionalBooleanValue";
6
- import { ConditionalStringValue } from "../items/ConditionalStringValue";
7
- import { ProvidedItem } from "../items/ProvidedItem";
8
- /** Status bar Groups/Sections from Left to Right
9
- * @public
10
- */
11
- export declare enum StatusBarSection {
12
- /** area for tool assistance and messages */
13
- Message = 0,
14
- /** area for tool assistance and messages */
15
- Left = 0,
16
- /** items specific to stage/task */
17
- Stage = 1,
18
- /** items specific to stage/task */
19
- Center = 1,
20
- /** Select scope and selection info */
21
- Selection = 2,
22
- /** Select scope and selection info */
23
- Right = 2,
24
- /** items that only show based on context */
25
- Context = 3
26
- }
27
- /** Defines which side of Icon where label is placed
28
- * @public
29
- */
30
- export declare enum StatusBarLabelSide {
31
- /** Label is placed left side of icon. This is the default if not specified */
32
- Left = 0,
33
- /** Label is placed on right side of icon. */
34
- Right = 1
35
- }
36
- /** Type for StatusBar Item Id
37
- * @public
38
- */
39
- export declare type StatusBarItemId = CommonStatusBarItem["id"];
40
- /** Describes the data needed to insert a button into the status bar.
41
- * @public
42
- */
43
- export interface AbstractStatusBarItem extends ProvidedItem {
44
- /** can be used by application to store miscellaneous data. */
45
- applicationData?: any;
46
- /** Describes badge. Renders no badge if not specified. */
47
- readonly badgeType?: BadgeType;
48
- /** Required unique id of the item. To ensure uniqueness it is suggested that a namespace prefix of the extension name be used. */
49
- readonly id: string;
50
- /** optional data to used by item implementor. */
51
- readonly internalData?: Map<string, any>;
52
- /** Describes if the item is visible or hidden. The default is for the item to be visible. */
53
- readonly isHidden?: boolean | ConditionalBooleanValue;
54
- /** Describes if the item is enabled or disabled. The default is for the item to be enabled. */
55
- readonly isDisabled?: boolean | ConditionalBooleanValue;
56
- /** Priority within a section (recommend using values 1 through 100). */
57
- readonly itemPriority: number;
58
- /** status bar section */
59
- readonly section: StatusBarSection;
60
- }
61
- /** Describes the data needed to insert an action item into the status bar.
62
- * @public
63
- */
64
- export interface AbstractStatusBarActionItem extends AbstractStatusBarItem {
65
- /** method to execute when icon is pressed */
66
- readonly execute: () => void;
67
- /** Name of icon WebFont entry or if specifying an imported SVG symbol use "webSvg:" prefix to imported symbol Id. */
68
- readonly icon?: string | ConditionalStringValue;
69
- /** Label. */
70
- readonly label?: string | ConditionalStringValue;
71
- /** tooltip. */
72
- readonly tooltip?: string | ConditionalStringValue;
73
- }
74
- /** Describes the data needed to insert a label item with an optional icon into the status bar.
75
- * @public
76
- */
77
- export interface AbstractStatusBarLabelItem extends AbstractStatusBarItem {
78
- /** Name of icon WebFont entry or if specifying an imported SVG symbol use "webSvg:" prefix to imported symbol Id. */
79
- readonly icon?: string | ConditionalStringValue;
80
- /** Label. */
81
- readonly label: string | ConditionalStringValue;
82
- /** Defines which side of icon to display label if icon is defined. */
83
- readonly labelSide?: StatusBarLabelSide;
84
- }
85
- /** Describes the data needed to insert a custom item into the status bar. This is used to allow extension
86
- * implementer to create a framework specific component.
87
- * @public
88
- */
89
- export interface AbstractStatusBarCustomItem extends AbstractStatusBarItem {
90
- readonly isCustom: true;
91
- }
92
- /** Describes the data needed to insert a button into the status bar.
93
- * @public
94
- */
95
- export declare type CommonStatusBarItem = AbstractStatusBarActionItem | AbstractStatusBarLabelItem | AbstractStatusBarCustomItem;
96
- /** AbstractStatusBarActionItem type guard.
97
- * @public
98
- */
99
- export declare const isAbstractStatusBarActionItem: (item: CommonStatusBarItem) => item is AbstractStatusBarActionItem;
100
- /** AbstractStatusBarLabelItem type guard.
101
- * @public
102
- */
103
- export declare const isAbstractStatusBarLabelItem: (item: CommonStatusBarItem) => item is AbstractStatusBarLabelItem;
104
- /** AbstractStatusBarCustomItem type guard.
105
- * @public
106
- */
107
- export declare const isAbstractStatusBarCustomItem: (item: CommonStatusBarItem) => item is AbstractStatusBarCustomItem;
108
- /** Helper class to create Abstract StatusBar Item definitions.
109
- * @public
110
- */
111
- export declare class AbstractStatusBarItemUtilities {
112
- /** Creates a StatusBar item to perform an action */
113
- static createActionItem: (id: string, section: StatusBarSection, itemPriority: number, icon: string | ConditionalStringValue, tooltip: string | ConditionalStringValue, execute: () => void, overrides?: Partial<AbstractStatusBarCustomItem> | undefined) => AbstractStatusBarActionItem;
114
- /** Creates a StatusBar item to display a label */
115
- static createLabelItem: (id: string, section: StatusBarSection, itemPriority: number, icon: string | ConditionalStringValue, label: string | ConditionalStringValue, labelSide?: StatusBarLabelSide, overrides?: Partial<AbstractStatusBarLabelItem> | undefined) => AbstractStatusBarLabelItem;
116
- }
1
+ /** @packageDocumentation
2
+ * @module StatusBar
3
+ */
4
+ import { BadgeType } from "../items/BadgeType";
5
+ import { ConditionalBooleanValue } from "../items/ConditionalBooleanValue";
6
+ import { ConditionalStringValue } from "../items/ConditionalStringValue";
7
+ import { ProvidedItem } from "../items/ProvidedItem";
8
+ /** Status bar Groups/Sections from Left to Right
9
+ * @public
10
+ */
11
+ export declare enum StatusBarSection {
12
+ /** area for tool assistance and messages */
13
+ Message = 0,
14
+ /** area for tool assistance and messages */
15
+ Left = 0,
16
+ /** items specific to stage/task */
17
+ Stage = 1,
18
+ /** items specific to stage/task */
19
+ Center = 1,
20
+ /** Select scope and selection info */
21
+ Selection = 2,
22
+ /** Select scope and selection info */
23
+ Right = 2,
24
+ /** items that only show based on context */
25
+ Context = 3
26
+ }
27
+ /** Defines which side of Icon where label is placed
28
+ * @public
29
+ */
30
+ export declare enum StatusBarLabelSide {
31
+ /** Label is placed left side of icon. This is the default if not specified */
32
+ Left = 0,
33
+ /** Label is placed on right side of icon. */
34
+ Right = 1
35
+ }
36
+ /** Type for StatusBar Item Id
37
+ * @public
38
+ */
39
+ export declare type StatusBarItemId = CommonStatusBarItem["id"];
40
+ /** Describes the data needed to insert a button into the status bar.
41
+ * @public
42
+ */
43
+ export interface AbstractStatusBarItem extends ProvidedItem {
44
+ /** can be used by application to store miscellaneous data. */
45
+ applicationData?: any;
46
+ /** Describes badge. Renders no badge if not specified. */
47
+ readonly badgeType?: BadgeType;
48
+ /** Required unique id of the item. To ensure uniqueness it is suggested that a namespace prefix of the extension name be used. */
49
+ readonly id: string;
50
+ /** optional data to used by item implementor. */
51
+ readonly internalData?: Map<string, any>;
52
+ /** Describes if the item is visible or hidden. The default is for the item to be visible. */
53
+ readonly isHidden?: boolean | ConditionalBooleanValue;
54
+ /** Describes if the item is enabled or disabled. The default is for the item to be enabled. */
55
+ readonly isDisabled?: boolean | ConditionalBooleanValue;
56
+ /** Priority within a section (recommend using values 1 through 100). */
57
+ readonly itemPriority: number;
58
+ /** status bar section */
59
+ readonly section: StatusBarSection;
60
+ }
61
+ /** Describes the data needed to insert an action item into the status bar.
62
+ * @public
63
+ */
64
+ export interface AbstractStatusBarActionItem extends AbstractStatusBarItem {
65
+ /** method to execute when icon is pressed */
66
+ readonly execute: () => void;
67
+ /** Name of icon WebFont entry or if specifying an imported SVG symbol use "webSvg:" prefix to imported symbol Id. */
68
+ readonly icon?: string | ConditionalStringValue;
69
+ /** Label. */
70
+ readonly label?: string | ConditionalStringValue;
71
+ /** tooltip. */
72
+ readonly tooltip?: string | ConditionalStringValue;
73
+ }
74
+ /** Describes the data needed to insert a label item with an optional icon into the status bar.
75
+ * @public
76
+ */
77
+ export interface AbstractStatusBarLabelItem extends AbstractStatusBarItem {
78
+ /** Name of icon WebFont entry or if specifying an imported SVG symbol use "webSvg:" prefix to imported symbol Id. */
79
+ readonly icon?: string | ConditionalStringValue;
80
+ /** Label. */
81
+ readonly label: string | ConditionalStringValue;
82
+ /** Defines which side of icon to display label if icon is defined. */
83
+ readonly labelSide?: StatusBarLabelSide;
84
+ }
85
+ /** Describes the data needed to insert a custom item into the status bar. This is used to allow extension
86
+ * implementer to create a framework specific component.
87
+ * @public
88
+ */
89
+ export interface AbstractStatusBarCustomItem extends AbstractStatusBarItem {
90
+ readonly isCustom: true;
91
+ }
92
+ /** Describes the data needed to insert a button into the status bar.
93
+ * @public
94
+ */
95
+ export declare type CommonStatusBarItem = AbstractStatusBarActionItem | AbstractStatusBarLabelItem | AbstractStatusBarCustomItem;
96
+ /** AbstractStatusBarActionItem type guard.
97
+ * @public
98
+ */
99
+ export declare const isAbstractStatusBarActionItem: (item: CommonStatusBarItem) => item is AbstractStatusBarActionItem;
100
+ /** AbstractStatusBarLabelItem type guard.
101
+ * @public
102
+ */
103
+ export declare const isAbstractStatusBarLabelItem: (item: CommonStatusBarItem) => item is AbstractStatusBarLabelItem;
104
+ /** AbstractStatusBarCustomItem type guard.
105
+ * @public
106
+ */
107
+ export declare const isAbstractStatusBarCustomItem: (item: CommonStatusBarItem) => item is AbstractStatusBarCustomItem;
108
+ /** Helper class to create Abstract StatusBar Item definitions.
109
+ * @public
110
+ */
111
+ export declare class AbstractStatusBarItemUtilities {
112
+ /** Creates a StatusBar item to perform an action */
113
+ static createActionItem: (id: string, section: StatusBarSection, itemPriority: number, icon: string | ConditionalStringValue, tooltip: string | ConditionalStringValue, execute: () => void, overrides?: Partial<AbstractStatusBarCustomItem> | undefined) => AbstractStatusBarActionItem;
114
+ /** Creates a StatusBar item to display a label */
115
+ static createLabelItem: (id: string, section: StatusBarSection, itemPriority: number, icon: string | ConditionalStringValue, label: string | ConditionalStringValue, labelSide?: StatusBarLabelSide, overrides?: Partial<AbstractStatusBarLabelItem> | undefined) => AbstractStatusBarLabelItem;
116
+ }
117
117
  //# sourceMappingURL=StatusBarItem.d.ts.map
@@ -1,75 +1,75 @@
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 StatusBar
7
- */
8
- /** Status bar Groups/Sections from Left to Right
9
- * @public
10
- */
11
- export var StatusBarSection;
12
- (function (StatusBarSection) {
13
- /** area for tool assistance and messages */
14
- StatusBarSection[StatusBarSection["Message"] = 0] = "Message";
15
- /** area for tool assistance and messages */
16
- StatusBarSection[StatusBarSection["Left"] = 0] = "Left";
17
- /** items specific to stage/task */
18
- StatusBarSection[StatusBarSection["Stage"] = 1] = "Stage";
19
- /** items specific to stage/task */
20
- StatusBarSection[StatusBarSection["Center"] = 1] = "Center";
21
- /** Select scope and selection info */
22
- StatusBarSection[StatusBarSection["Selection"] = 2] = "Selection";
23
- /** Select scope and selection info */
24
- StatusBarSection[StatusBarSection["Right"] = 2] = "Right";
25
- /** items that only show based on context */
26
- StatusBarSection[StatusBarSection["Context"] = 3] = "Context";
27
- })(StatusBarSection || (StatusBarSection = {}));
28
- /** Defines which side of Icon where label is placed
29
- * @public
30
- */
31
- export var StatusBarLabelSide;
32
- (function (StatusBarLabelSide) {
33
- /** Label is placed left side of icon. This is the default if not specified */
34
- StatusBarLabelSide[StatusBarLabelSide["Left"] = 0] = "Left";
35
- /** Label is placed on right side of icon. */
36
- StatusBarLabelSide[StatusBarLabelSide["Right"] = 1] = "Right";
37
- })(StatusBarLabelSide || (StatusBarLabelSide = {}));
38
- /** AbstractStatusBarActionItem type guard.
39
- * @public
40
- */
41
- export const isAbstractStatusBarActionItem = (item) => {
42
- return item.execute !== undefined;
43
- };
44
- /** AbstractStatusBarLabelItem type guard.
45
- * @public
46
- */
47
- export const isAbstractStatusBarLabelItem = (item) => {
48
- return item.label !== undefined && item.execute === undefined;
49
- };
50
- /** AbstractStatusBarCustomItem type guard.
51
- * @public
52
- */
53
- export const isAbstractStatusBarCustomItem = (item) => {
54
- return !!item.isCustom;
55
- };
56
- /** Helper class to create Abstract StatusBar Item definitions.
57
- * @public
58
- */
59
- export class AbstractStatusBarItemUtilities {
60
- }
61
- /** Creates a StatusBar item to perform an action */
62
- AbstractStatusBarItemUtilities.createActionItem = (id, section, itemPriority, icon, tooltip, execute, overrides) => ({
63
- id, section, itemPriority,
64
- icon, tooltip,
65
- execute,
66
- ...overrides,
67
- });
68
- /** Creates a StatusBar item to display a label */
69
- AbstractStatusBarItemUtilities.createLabelItem = (id, section, itemPriority, icon, label, labelSide = StatusBarLabelSide.Right, overrides) => ({
70
- id, section, itemPriority,
71
- icon, label,
72
- labelSide,
73
- ...overrides,
74
- });
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 StatusBar
7
+ */
8
+ /** Status bar Groups/Sections from Left to Right
9
+ * @public
10
+ */
11
+ export var StatusBarSection;
12
+ (function (StatusBarSection) {
13
+ /** area for tool assistance and messages */
14
+ StatusBarSection[StatusBarSection["Message"] = 0] = "Message";
15
+ /** area for tool assistance and messages */
16
+ StatusBarSection[StatusBarSection["Left"] = 0] = "Left";
17
+ /** items specific to stage/task */
18
+ StatusBarSection[StatusBarSection["Stage"] = 1] = "Stage";
19
+ /** items specific to stage/task */
20
+ StatusBarSection[StatusBarSection["Center"] = 1] = "Center";
21
+ /** Select scope and selection info */
22
+ StatusBarSection[StatusBarSection["Selection"] = 2] = "Selection";
23
+ /** Select scope and selection info */
24
+ StatusBarSection[StatusBarSection["Right"] = 2] = "Right";
25
+ /** items that only show based on context */
26
+ StatusBarSection[StatusBarSection["Context"] = 3] = "Context";
27
+ })(StatusBarSection || (StatusBarSection = {}));
28
+ /** Defines which side of Icon where label is placed
29
+ * @public
30
+ */
31
+ export var StatusBarLabelSide;
32
+ (function (StatusBarLabelSide) {
33
+ /** Label is placed left side of icon. This is the default if not specified */
34
+ StatusBarLabelSide[StatusBarLabelSide["Left"] = 0] = "Left";
35
+ /** Label is placed on right side of icon. */
36
+ StatusBarLabelSide[StatusBarLabelSide["Right"] = 1] = "Right";
37
+ })(StatusBarLabelSide || (StatusBarLabelSide = {}));
38
+ /** AbstractStatusBarActionItem type guard.
39
+ * @public
40
+ */
41
+ export const isAbstractStatusBarActionItem = (item) => {
42
+ return item.execute !== undefined;
43
+ };
44
+ /** AbstractStatusBarLabelItem type guard.
45
+ * @public
46
+ */
47
+ export const isAbstractStatusBarLabelItem = (item) => {
48
+ return item.label !== undefined && item.execute === undefined;
49
+ };
50
+ /** AbstractStatusBarCustomItem type guard.
51
+ * @public
52
+ */
53
+ export const isAbstractStatusBarCustomItem = (item) => {
54
+ return !!item.isCustom;
55
+ };
56
+ /** Helper class to create Abstract StatusBar Item definitions.
57
+ * @public
58
+ */
59
+ export class AbstractStatusBarItemUtilities {
60
+ }
61
+ /** Creates a StatusBar item to perform an action */
62
+ AbstractStatusBarItemUtilities.createActionItem = (id, section, itemPriority, icon, tooltip, execute, overrides) => ({
63
+ id, section, itemPriority,
64
+ icon, tooltip,
65
+ execute,
66
+ ...overrides,
67
+ });
68
+ /** Creates a StatusBar item to display a label */
69
+ AbstractStatusBarItemUtilities.createLabelItem = (id, section, itemPriority, icon, label, labelSide = StatusBarLabelSide.Right, overrides) => ({
70
+ id, section, itemPriority,
71
+ icon, label,
72
+ labelSide,
73
+ ...overrides,
74
+ });
75
75
  //# sourceMappingURL=StatusBarItem.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"StatusBarItem.js","sourceRoot":"","sources":["../../../../src/appui-abstract/statusbar/StatusBarItem.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAOH;;GAEG;AACH,MAAM,CAAN,IAAY,gBAeX;AAfD,WAAY,gBAAgB;IAC1B,4CAA4C;IAC5C,6DAAW,CAAA;IACX,4CAA4C;IAC5C,uDAAQ,CAAA;IACR,mCAAmC;IACnC,yDAAS,CAAA;IACT,mCAAmC;IACnC,2DAAU,CAAA;IACV,sCAAsC;IACtC,iEAAa,CAAA;IACb,sCAAsC;IACtC,yDAAS,CAAA;IACT,4CAA4C;IAC5C,6DAAW,CAAA;AACb,CAAC,EAfW,gBAAgB,KAAhB,gBAAgB,QAe3B;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,8EAA8E;IAC9E,2DAAI,CAAA;IACJ,6CAA6C;IAC7C,6DAAK,CAAA;AACP,CAAC,EALW,kBAAkB,KAAlB,kBAAkB,QAK7B;AAoED;;GAEG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,IAAyB,EAAuC,EAAE;IAC9G,OAAQ,IAAoC,CAAC,OAAO,KAAK,SAAS,CAAC;AACrE,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,IAAyB,EAAsC,EAAE;IAC5G,OAAQ,IAAmC,CAAC,KAAK,KAAK,SAAS,IAAK,IAAoC,CAAC,OAAO,KAAK,SAAS,CAAC;AACjI,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,IAAyB,EAAuC,EAAE;IAC9G,OAAO,CAAC,CAAE,IAAoC,CAAC,QAAQ,CAAC;AAC1D,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,OAAO,8BAA8B;;AACzC,oDAAoD;AACtC,+CAAgB,GAAG,CAAC,EAAU,EAAE,OAAyB,EAAE,YAAoB,EAAE,IAAqC,EAAE,OAAwC,EAAE,OAAmB,EAAE,SAAgD,EAA+B,EAAE,CAAC,CAAC;IACtR,EAAE,EAAE,OAAO,EAAE,YAAY;IACzB,IAAI,EAAE,OAAO;IACb,OAAO;IACP,GAAG,SAAS;CACb,CAAC,CAAC;AAEH,kDAAkD;AACpC,8CAAe,GAAG,CAAC,EAAU,EAAE,OAAyB,EAAE,YAAoB,EAAE,IAAqC,EAAE,KAAsC,EAAE,SAAS,GAAG,kBAAkB,CAAC,KAAK,EAAE,SAA+C,EAA8B,EAAE,CAAC,CAAC;IAClS,EAAE,EAAE,OAAO,EAAE,YAAY;IACzB,IAAI,EAAE,KAAK;IACX,SAAS;IACT,GAAG,SAAS;CACb,CAAC,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/** @packageDocumentation\n * @module StatusBar\n */\n\nimport { BadgeType } from \"../items/BadgeType\";\nimport { ConditionalBooleanValue } from \"../items/ConditionalBooleanValue\";\nimport { ConditionalStringValue } from \"../items/ConditionalStringValue\";\nimport { ProvidedItem } from \"../items/ProvidedItem\";\n\n/** Status bar Groups/Sections from Left to Right\n * @public\n */\nexport enum StatusBarSection {\n /** area for tool assistance and messages */\n Message = 0,\n /** area for tool assistance and messages */\n Left = 0,\n /** items specific to stage/task */\n Stage = 1,\n /** items specific to stage/task */\n Center = 1,\n /** Select scope and selection info */\n Selection = 2,\n /** Select scope and selection info */\n Right = 2,\n /** items that only show based on context */\n Context = 3,\n}\n\n/** Defines which side of Icon where label is placed\n * @public\n */\nexport enum StatusBarLabelSide {\n /** Label is placed left side of icon. This is the default if not specified */\n Left,\n /** Label is placed on right side of icon. */\n Right,\n}\n\n/** Type for StatusBar Item Id\n * @public\n */\nexport type StatusBarItemId = CommonStatusBarItem[\"id\"];\n\n/** Describes the data needed to insert a button into the status bar.\n * @public\n */\nexport interface AbstractStatusBarItem extends ProvidedItem {\n /** can be used by application to store miscellaneous data. */\n applicationData?: any;\n /** Describes badge. Renders no badge if not specified. */\n readonly badgeType?: BadgeType;\n /** Required unique id of the item. To ensure uniqueness it is suggested that a namespace prefix of the extension name be used. */\n readonly id: string;\n /** optional data to used by item implementor. */\n readonly internalData?: Map<string, any>;\n /** Describes if the item is visible or hidden. The default is for the item to be visible. */\n readonly isHidden?: boolean | ConditionalBooleanValue;\n /** Describes if the item is enabled or disabled. The default is for the item to be enabled. */\n readonly isDisabled?: boolean | ConditionalBooleanValue;\n /** Priority within a section (recommend using values 1 through 100). */\n readonly itemPriority: number;\n /** status bar section */\n readonly section: StatusBarSection;\n}\n\n/** Describes the data needed to insert an action item into the status bar.\n * @public\n */\nexport interface AbstractStatusBarActionItem extends AbstractStatusBarItem {\n /** method to execute when icon is pressed */\n readonly execute: () => void;\n /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix to imported symbol Id. */\n readonly icon?: string | ConditionalStringValue;\n /** Label. */\n readonly label?: string | ConditionalStringValue;\n /** tooltip. */\n readonly tooltip?: string | ConditionalStringValue;\n}\n\n/** Describes the data needed to insert a label item with an optional icon into the status bar.\n * @public\n */\nexport interface AbstractStatusBarLabelItem extends AbstractStatusBarItem {\n /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix to imported symbol Id. */\n readonly icon?: string | ConditionalStringValue;\n /** Label. */\n readonly label: string | ConditionalStringValue;\n /** Defines which side of icon to display label if icon is defined. */\n readonly labelSide?: StatusBarLabelSide;\n}\n\n/** Describes the data needed to insert a custom item into the status bar. This is used to allow extension\n * implementer to create a framework specific component.\n * @public\n */\nexport interface AbstractStatusBarCustomItem extends AbstractStatusBarItem {\n readonly isCustom: true;\n}\n\n/** Describes the data needed to insert a button into the status bar.\n * @public\n */\nexport type CommonStatusBarItem = AbstractStatusBarActionItem | AbstractStatusBarLabelItem | AbstractStatusBarCustomItem;\n\n/** AbstractStatusBarActionItem type guard.\n * @public\n */\nexport const isAbstractStatusBarActionItem = (item: CommonStatusBarItem): item is AbstractStatusBarActionItem => {\n return (item as AbstractStatusBarActionItem).execute !== undefined;\n};\n\n/** AbstractStatusBarLabelItem type guard.\n * @public\n */\nexport const isAbstractStatusBarLabelItem = (item: CommonStatusBarItem): item is AbstractStatusBarLabelItem => {\n return (item as AbstractStatusBarLabelItem).label !== undefined && (item as AbstractStatusBarActionItem).execute === undefined;\n};\n\n/** AbstractStatusBarCustomItem type guard.\n * @public\n */\nexport const isAbstractStatusBarCustomItem = (item: CommonStatusBarItem): item is AbstractStatusBarCustomItem => {\n return !!(item as AbstractStatusBarCustomItem).isCustom;\n};\n\n/** Helper class to create Abstract StatusBar Item definitions.\n * @public\n */\nexport class AbstractStatusBarItemUtilities {\n /** Creates a StatusBar item to perform an action */\n public static createActionItem = (id: string, section: StatusBarSection, itemPriority: number, icon: string | ConditionalStringValue, tooltip: string | ConditionalStringValue, execute: () => void, overrides?: Partial<AbstractStatusBarCustomItem>): AbstractStatusBarActionItem => ({\n id, section, itemPriority,\n icon, tooltip,\n execute,\n ...overrides,\n });\n\n /** Creates a StatusBar item to display a label */\n public static createLabelItem = (id: string, section: StatusBarSection, itemPriority: number, icon: string | ConditionalStringValue, label: string | ConditionalStringValue, labelSide = StatusBarLabelSide.Right, overrides?: Partial<AbstractStatusBarLabelItem>): AbstractStatusBarLabelItem => ({\n id, section, itemPriority,\n icon, label,\n labelSide,\n ...overrides,\n });\n}\n"]}
1
+ {"version":3,"file":"StatusBarItem.js","sourceRoot":"","sources":["../../../../src/appui-abstract/statusbar/StatusBarItem.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAOH;;GAEG;AACH,MAAM,CAAN,IAAY,gBAeX;AAfD,WAAY,gBAAgB;IAC1B,4CAA4C;IAC5C,6DAAW,CAAA;IACX,4CAA4C;IAC5C,uDAAQ,CAAA;IACR,mCAAmC;IACnC,yDAAS,CAAA;IACT,mCAAmC;IACnC,2DAAU,CAAA;IACV,sCAAsC;IACtC,iEAAa,CAAA;IACb,sCAAsC;IACtC,yDAAS,CAAA;IACT,4CAA4C;IAC5C,6DAAW,CAAA;AACb,CAAC,EAfW,gBAAgB,KAAhB,gBAAgB,QAe3B;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,8EAA8E;IAC9E,2DAAI,CAAA;IACJ,6CAA6C;IAC7C,6DAAK,CAAA;AACP,CAAC,EALW,kBAAkB,KAAlB,kBAAkB,QAK7B;AAoED;;GAEG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,IAAyB,EAAuC,EAAE;IAC9G,OAAQ,IAAoC,CAAC,OAAO,KAAK,SAAS,CAAC;AACrE,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,CAAC,IAAyB,EAAsC,EAAE;IAC5G,OAAQ,IAAmC,CAAC,KAAK,KAAK,SAAS,IAAK,IAAoC,CAAC,OAAO,KAAK,SAAS,CAAC;AACjI,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAC,IAAyB,EAAuC,EAAE;IAC9G,OAAO,CAAC,CAAE,IAAoC,CAAC,QAAQ,CAAC;AAC1D,CAAC,CAAC;AAEF;;GAEG;AACH,MAAM,OAAO,8BAA8B;;AACzC,oDAAoD;AACtC,+CAAgB,GAAG,CAAC,EAAU,EAAE,OAAyB,EAAE,YAAoB,EAAE,IAAqC,EAAE,OAAwC,EAAE,OAAmB,EAAE,SAAgD,EAA+B,EAAE,CAAC,CAAC;IACtR,EAAE,EAAE,OAAO,EAAE,YAAY;IACzB,IAAI,EAAE,OAAO;IACb,OAAO;IACP,GAAG,SAAS;CACb,CAAC,CAAC;AAEH,kDAAkD;AACpC,8CAAe,GAAG,CAAC,EAAU,EAAE,OAAyB,EAAE,YAAoB,EAAE,IAAqC,EAAE,KAAsC,EAAE,SAAS,GAAG,kBAAkB,CAAC,KAAK,EAAE,SAA+C,EAA8B,EAAE,CAAC,CAAC;IAClS,EAAE,EAAE,OAAO,EAAE,YAAY;IACzB,IAAI,EAAE,KAAK;IACX,SAAS;IACT,GAAG,SAAS;CACb,CAAC,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/** @packageDocumentation\r\n * @module StatusBar\r\n */\r\n\r\nimport { BadgeType } from \"../items/BadgeType\";\r\nimport { ConditionalBooleanValue } from \"../items/ConditionalBooleanValue\";\r\nimport { ConditionalStringValue } from \"../items/ConditionalStringValue\";\r\nimport { ProvidedItem } from \"../items/ProvidedItem\";\r\n\r\n/** Status bar Groups/Sections from Left to Right\r\n * @public\r\n */\r\nexport enum StatusBarSection {\r\n /** area for tool assistance and messages */\r\n Message = 0,\r\n /** area for tool assistance and messages */\r\n Left = 0,\r\n /** items specific to stage/task */\r\n Stage = 1,\r\n /** items specific to stage/task */\r\n Center = 1,\r\n /** Select scope and selection info */\r\n Selection = 2,\r\n /** Select scope and selection info */\r\n Right = 2,\r\n /** items that only show based on context */\r\n Context = 3,\r\n}\r\n\r\n/** Defines which side of Icon where label is placed\r\n * @public\r\n */\r\nexport enum StatusBarLabelSide {\r\n /** Label is placed left side of icon. This is the default if not specified */\r\n Left,\r\n /** Label is placed on right side of icon. */\r\n Right,\r\n}\r\n\r\n/** Type for StatusBar Item Id\r\n * @public\r\n */\r\nexport type StatusBarItemId = CommonStatusBarItem[\"id\"];\r\n\r\n/** Describes the data needed to insert a button into the status bar.\r\n * @public\r\n */\r\nexport interface AbstractStatusBarItem extends ProvidedItem {\r\n /** can be used by application to store miscellaneous data. */\r\n applicationData?: any;\r\n /** Describes badge. Renders no badge if not specified. */\r\n readonly badgeType?: BadgeType;\r\n /** Required unique id of the item. To ensure uniqueness it is suggested that a namespace prefix of the extension name be used. */\r\n readonly id: string;\r\n /** optional data to used by item implementor. */\r\n readonly internalData?: Map<string, any>;\r\n /** Describes if the item is visible or hidden. The default is for the item to be visible. */\r\n readonly isHidden?: boolean | ConditionalBooleanValue;\r\n /** Describes if the item is enabled or disabled. The default is for the item to be enabled. */\r\n readonly isDisabled?: boolean | ConditionalBooleanValue;\r\n /** Priority within a section (recommend using values 1 through 100). */\r\n readonly itemPriority: number;\r\n /** status bar section */\r\n readonly section: StatusBarSection;\r\n}\r\n\r\n/** Describes the data needed to insert an action item into the status bar.\r\n * @public\r\n */\r\nexport interface AbstractStatusBarActionItem extends AbstractStatusBarItem {\r\n /** method to execute when icon is pressed */\r\n readonly execute: () => void;\r\n /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix to imported symbol Id. */\r\n readonly icon?: string | ConditionalStringValue;\r\n /** Label. */\r\n readonly label?: string | ConditionalStringValue;\r\n /** tooltip. */\r\n readonly tooltip?: string | ConditionalStringValue;\r\n}\r\n\r\n/** Describes the data needed to insert a label item with an optional icon into the status bar.\r\n * @public\r\n */\r\nexport interface AbstractStatusBarLabelItem extends AbstractStatusBarItem {\r\n /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix to imported symbol Id. */\r\n readonly icon?: string | ConditionalStringValue;\r\n /** Label. */\r\n readonly label: string | ConditionalStringValue;\r\n /** Defines which side of icon to display label if icon is defined. */\r\n readonly labelSide?: StatusBarLabelSide;\r\n}\r\n\r\n/** Describes the data needed to insert a custom item into the status bar. This is used to allow extension\r\n * implementer to create a framework specific component.\r\n * @public\r\n */\r\nexport interface AbstractStatusBarCustomItem extends AbstractStatusBarItem {\r\n readonly isCustom: true;\r\n}\r\n\r\n/** Describes the data needed to insert a button into the status bar.\r\n * @public\r\n */\r\nexport type CommonStatusBarItem = AbstractStatusBarActionItem | AbstractStatusBarLabelItem | AbstractStatusBarCustomItem;\r\n\r\n/** AbstractStatusBarActionItem type guard.\r\n * @public\r\n */\r\nexport const isAbstractStatusBarActionItem = (item: CommonStatusBarItem): item is AbstractStatusBarActionItem => {\r\n return (item as AbstractStatusBarActionItem).execute !== undefined;\r\n};\r\n\r\n/** AbstractStatusBarLabelItem type guard.\r\n * @public\r\n */\r\nexport const isAbstractStatusBarLabelItem = (item: CommonStatusBarItem): item is AbstractStatusBarLabelItem => {\r\n return (item as AbstractStatusBarLabelItem).label !== undefined && (item as AbstractStatusBarActionItem).execute === undefined;\r\n};\r\n\r\n/** AbstractStatusBarCustomItem type guard.\r\n * @public\r\n */\r\nexport const isAbstractStatusBarCustomItem = (item: CommonStatusBarItem): item is AbstractStatusBarCustomItem => {\r\n return !!(item as AbstractStatusBarCustomItem).isCustom;\r\n};\r\n\r\n/** Helper class to create Abstract StatusBar Item definitions.\r\n * @public\r\n */\r\nexport class AbstractStatusBarItemUtilities {\r\n /** Creates a StatusBar item to perform an action */\r\n public static createActionItem = (id: string, section: StatusBarSection, itemPriority: number, icon: string | ConditionalStringValue, tooltip: string | ConditionalStringValue, execute: () => void, overrides?: Partial<AbstractStatusBarCustomItem>): AbstractStatusBarActionItem => ({\r\n id, section, itemPriority,\r\n icon, tooltip,\r\n execute,\r\n ...overrides,\r\n });\r\n\r\n /** Creates a StatusBar item to display a label */\r\n public static createLabelItem = (id: string, section: StatusBarSection, itemPriority: number, icon: string | ConditionalStringValue, label: string | ConditionalStringValue, labelSide = StatusBarLabelSide.Right, overrides?: Partial<AbstractStatusBarLabelItem>): AbstractStatusBarLabelItem => ({\r\n id, section, itemPriority,\r\n icon, label,\r\n labelSide,\r\n ...overrides,\r\n });\r\n}\r\n"]}