@itwin/appui-abstract 4.0.0-dev.48 → 4.0.0-dev.51
Sign up to get free protection for your applications and to get access to all the features.
- package/lib/cjs/appui-abstract/BaseUiItemsProvider.d.ts +30 -30
- package/lib/cjs/appui-abstract/BaseUiItemsProvider.js +79 -79
- package/lib/cjs/appui-abstract/BaseUiItemsProvider.js.map +1 -1
- package/lib/cjs/appui-abstract/UiAdmin.d.ts +221 -221
- package/lib/cjs/appui-abstract/UiAdmin.js +224 -224
- package/lib/cjs/appui-abstract/UiAdmin.js.map +1 -1
- package/lib/cjs/appui-abstract/UiItemsManager.d.ts +113 -113
- package/lib/cjs/appui-abstract/UiItemsManager.js +193 -193
- package/lib/cjs/appui-abstract/UiItemsManager.js.map +1 -1
- package/lib/cjs/appui-abstract/UiItemsProvider.d.ts +29 -29
- package/lib/cjs/appui-abstract/UiItemsProvider.js +9 -9
- package/lib/cjs/appui-abstract/UiItemsProvider.js.map +1 -1
- package/lib/cjs/appui-abstract/backstage/BackstageItem.d.ts +91 -91
- package/lib/cjs/appui-abstract/backstage/BackstageItem.js +70 -70
- package/lib/cjs/appui-abstract/backstage/BackstageItem.js.map +1 -1
- package/lib/cjs/appui-abstract/backstage/BackstageItemsManager.d.ts +38 -38
- package/lib/cjs/appui-abstract/backstage/BackstageItemsManager.js +133 -133
- package/lib/cjs/appui-abstract/backstage/BackstageItemsManager.js.map +1 -1
- package/lib/cjs/appui-abstract/common/KeyboardKey.d.ts +51 -51
- package/lib/cjs/appui-abstract/common/KeyboardKey.js +63 -63
- package/lib/cjs/appui-abstract/common/KeyboardKey.js.map +1 -1
- package/lib/cjs/appui-abstract/content/ContentLayoutProps.d.ts +62 -62
- package/lib/cjs/appui-abstract/content/ContentLayoutProps.js +9 -9
- package/lib/cjs/appui-abstract/content/ContentLayoutProps.js.map +1 -1
- package/lib/cjs/appui-abstract/content/StandardContentLayouts.d.ts +19 -19
- package/lib/cjs/appui-abstract/content/StandardContentLayouts.js +108 -108
- package/lib/cjs/appui-abstract/content/StandardContentLayouts.js.map +1 -1
- package/lib/cjs/appui-abstract/dialogs/DialogItem.d.ts +76 -76
- package/lib/cjs/appui-abstract/dialogs/DialogItem.js +67 -67
- package/lib/cjs/appui-abstract/dialogs/DialogItem.js.map +1 -1
- package/lib/cjs/appui-abstract/dialogs/UiDataProvider.d.ts +55 -55
- package/lib/cjs/appui-abstract/dialogs/UiDataProvider.js +66 -66
- package/lib/cjs/appui-abstract/dialogs/UiDataProvider.js.map +1 -1
- package/lib/cjs/appui-abstract/dialogs/UiLayoutDataProvider.d.ts +97 -97
- package/lib/cjs/appui-abstract/dialogs/UiLayoutDataProvider.js +175 -175
- package/lib/cjs/appui-abstract/dialogs/UiLayoutDataProvider.js.map +1 -1
- package/lib/cjs/appui-abstract/items/AbstractItemProps.d.ts +53 -53
- package/lib/cjs/appui-abstract/items/AbstractItemProps.js +9 -9
- package/lib/cjs/appui-abstract/items/AbstractItemProps.js.map +1 -1
- package/lib/cjs/appui-abstract/items/AbstractMenuItemProps.d.ts +20 -20
- package/lib/cjs/appui-abstract/items/AbstractMenuItemProps.js +9 -9
- package/lib/cjs/appui-abstract/items/AbstractMenuItemProps.js.map +1 -1
- package/lib/cjs/appui-abstract/items/AbstractToolbarProps.d.ts +13 -13
- package/lib/cjs/appui-abstract/items/AbstractToolbarProps.js +9 -9
- package/lib/cjs/appui-abstract/items/AbstractToolbarProps.js.map +1 -1
- package/lib/cjs/appui-abstract/items/BadgeType.d.ts +14 -14
- package/lib/cjs/appui-abstract/items/BadgeType.js +22 -22
- package/lib/cjs/appui-abstract/items/BadgeType.js.map +1 -1
- package/lib/cjs/appui-abstract/items/ConditionalBooleanValue.d.ts +27 -27
- package/lib/cjs/appui-abstract/items/ConditionalBooleanValue.js +60 -60
- package/lib/cjs/appui-abstract/items/ConditionalBooleanValue.js.map +1 -1
- package/lib/cjs/appui-abstract/items/ConditionalStringValue.d.ts +29 -29
- package/lib/cjs/appui-abstract/items/ConditionalStringValue.js +62 -62
- package/lib/cjs/appui-abstract/items/ConditionalStringValue.js.map +1 -1
- package/lib/cjs/appui-abstract/items/ProvidedItem.d.ts +11 -11
- package/lib/cjs/appui-abstract/items/ProvidedItem.js +9 -9
- package/lib/cjs/appui-abstract/items/ProvidedItem.js.map +1 -1
- package/lib/cjs/appui-abstract/items/RelativePosition.d.ts +18 -18
- package/lib/cjs/appui-abstract/items/RelativePosition.js +26 -26
- package/lib/cjs/appui-abstract/items/RelativePosition.js.map +1 -1
- package/lib/cjs/appui-abstract/items/StageUsage.d.ts +16 -16
- package/lib/cjs/appui-abstract/items/StageUsage.js +24 -24
- package/lib/cjs/appui-abstract/items/StageUsage.js.map +1 -1
- package/lib/cjs/appui-abstract/notification/MessagePresenter.d.ts +42 -42
- package/lib/cjs/appui-abstract/notification/MessagePresenter.js +24 -24
- package/lib/cjs/appui-abstract/notification/MessagePresenter.js.map +1 -1
- package/lib/cjs/appui-abstract/notification/MessageSeverity.d.ts +15 -15
- package/lib/cjs/appui-abstract/notification/MessageSeverity.js +23 -23
- package/lib/cjs/appui-abstract/notification/MessageSeverity.js.map +1 -1
- package/lib/cjs/appui-abstract/properties/Description.d.ts +127 -127
- package/lib/cjs/appui-abstract/properties/Description.js +196 -196
- package/lib/cjs/appui-abstract/properties/Description.js.map +1 -1
- package/lib/cjs/appui-abstract/properties/EditorParams.d.ts +260 -260
- package/lib/cjs/appui-abstract/properties/EditorParams.js +106 -106
- package/lib/cjs/appui-abstract/properties/EditorParams.js.map +1 -1
- package/lib/cjs/appui-abstract/properties/PrimitiveTypes.d.ts +60 -60
- package/lib/cjs/appui-abstract/properties/PrimitiveTypes.js +9 -9
- package/lib/cjs/appui-abstract/properties/PrimitiveTypes.js.map +1 -1
- package/lib/cjs/appui-abstract/properties/Record.d.ts +57 -57
- package/lib/cjs/appui-abstract/properties/Record.js +78 -78
- package/lib/cjs/appui-abstract/properties/Record.js.map +1 -1
- package/lib/cjs/appui-abstract/properties/StandardEditorNames.d.ts +22 -22
- package/lib/cjs/appui-abstract/properties/StandardEditorNames.js +30 -30
- package/lib/cjs/appui-abstract/properties/StandardEditorNames.js.map +1 -1
- package/lib/cjs/appui-abstract/properties/StandardTypeNames.d.ts +30 -30
- package/lib/cjs/appui-abstract/properties/StandardTypeNames.js +39 -39
- package/lib/cjs/appui-abstract/properties/StandardTypeNames.js.map +1 -1
- package/lib/cjs/appui-abstract/properties/Value.d.ts +49 -49
- package/lib/cjs/appui-abstract/properties/Value.js +20 -20
- package/lib/cjs/appui-abstract/properties/Value.js.map +1 -1
- package/lib/cjs/appui-abstract/quantity/BaseQuantityDescription.d.ts +22 -22
- package/lib/cjs/appui-abstract/quantity/BaseQuantityDescription.js +48 -48
- package/lib/cjs/appui-abstract/quantity/BaseQuantityDescription.js.map +1 -1
- package/lib/cjs/appui-abstract/statusbar/StatusBarItem.d.ts +128 -128
- package/lib/cjs/appui-abstract/statusbar/StatusBarItem.js +87 -87
- package/lib/cjs/appui-abstract/statusbar/StatusBarItem.js.map +1 -1
- package/lib/cjs/appui-abstract/statusbar/StatusBarItemsManager.d.ts +39 -39
- package/lib/cjs/appui-abstract/statusbar/StatusBarItemsManager.js +135 -135
- package/lib/cjs/appui-abstract/statusbar/StatusBarItemsManager.js.map +1 -1
- package/lib/cjs/appui-abstract/toolbars/ToolbarItem.d.ts +121 -121
- package/lib/cjs/appui-abstract/toolbars/ToolbarItem.js +64 -64
- package/lib/cjs/appui-abstract/toolbars/ToolbarItem.js.map +1 -1
- package/lib/cjs/appui-abstract/toolbars/ToolbarItemsManager.d.ts +45 -45
- package/lib/cjs/appui-abstract/toolbars/ToolbarItemsManager.js +235 -235
- package/lib/cjs/appui-abstract/toolbars/ToolbarItemsManager.js.map +1 -1
- package/lib/cjs/appui-abstract/utils/IconSpecUtilities.d.ts +29 -29
- package/lib/cjs/appui-abstract/utils/IconSpecUtilities.js +51 -51
- package/lib/cjs/appui-abstract/utils/IconSpecUtilities.js.map +1 -1
- package/lib/cjs/appui-abstract/utils/PointProps.d.ts +10 -10
- package/lib/cjs/appui-abstract/utils/PointProps.js +9 -9
- package/lib/cjs/appui-abstract/utils/PointProps.js.map +1 -1
- package/lib/cjs/appui-abstract/utils/UiError.d.ts +12 -12
- package/lib/cjs/appui-abstract/utils/UiError.js +22 -22
- package/lib/cjs/appui-abstract/utils/UiError.js.map +1 -1
- package/lib/cjs/appui-abstract/utils/UiEvent.d.ts +9 -9
- package/lib/cjs/appui-abstract/utils/UiEvent.js +17 -17
- package/lib/cjs/appui-abstract/utils/UiEvent.js.map +1 -1
- package/lib/cjs/appui-abstract/utils/UiEventDispatcher.d.ts +46 -46
- package/lib/cjs/appui-abstract/utils/UiEventDispatcher.js +131 -131
- package/lib/cjs/appui-abstract/utils/UiEventDispatcher.js.map +1 -1
- package/lib/cjs/appui-abstract/utils/callbacks.d.ts +20 -20
- package/lib/cjs/appui-abstract/utils/callbacks.js +9 -9
- package/lib/cjs/appui-abstract/utils/callbacks.js.map +1 -1
- package/lib/cjs/appui-abstract/utils/filter/charCode.d.ts +416 -416
- package/lib/cjs/appui-abstract/utils/filter/charCode.js +6 -6
- package/lib/cjs/appui-abstract/utils/filter/charCode.js.map +1 -1
- package/lib/cjs/appui-abstract/utils/filter/filters.d.ts +98 -98
- package/lib/cjs/appui-abstract/utils/filter/filters.js +709 -709
- package/lib/cjs/appui-abstract/utils/filter/filters.js.map +1 -1
- package/lib/cjs/appui-abstract/utils/filter/map.d.ts +59 -59
- package/lib/cjs/appui-abstract/utils/filter/map.js +402 -402
- package/lib/cjs/appui-abstract/utils/filter/map.js.map +1 -1
- package/lib/cjs/appui-abstract/utils/filter/strings.d.ts +20 -20
- package/lib/cjs/appui-abstract/utils/filter/strings.js +78 -78
- package/lib/cjs/appui-abstract/utils/filter/strings.js.map +1 -1
- package/lib/cjs/appui-abstract/utils/isLetter.d.ts +9 -9
- package/lib/cjs/appui-abstract/utils/isLetter.js +19 -19
- package/lib/cjs/appui-abstract/utils/isLetter.js.map +1 -1
- package/lib/cjs/appui-abstract/utils/misc.d.ts +11 -11
- package/lib/cjs/appui-abstract/utils/misc.js +36 -36
- package/lib/cjs/appui-abstract/utils/misc.js.map +1 -1
- package/lib/cjs/appui-abstract/widget/AbstractWidgetProps.d.ts +86 -86
- package/lib/cjs/appui-abstract/widget/AbstractWidgetProps.js +9 -9
- package/lib/cjs/appui-abstract/widget/AbstractWidgetProps.js.map +1 -1
- package/lib/cjs/appui-abstract/widget/StagePanel.d.ts +36 -36
- package/lib/cjs/appui-abstract/widget/StagePanel.js +46 -46
- package/lib/cjs/appui-abstract/widget/StagePanel.js.map +1 -1
- package/lib/cjs/appui-abstract/widget/WidgetState.d.ts +19 -19
- package/lib/cjs/appui-abstract/widget/WidgetState.js +27 -27
- package/lib/cjs/appui-abstract/widget/WidgetState.js.map +1 -1
- package/lib/cjs/appui-abstract.d.ts +103 -103
- package/lib/cjs/appui-abstract.js +119 -119
- package/lib/cjs/appui-abstract.js.map +1 -1
- package/lib/esm/appui-abstract/BaseUiItemsProvider.d.ts +30 -30
- package/lib/esm/appui-abstract/BaseUiItemsProvider.js +75 -75
- package/lib/esm/appui-abstract/BaseUiItemsProvider.js.map +1 -1
- package/lib/esm/appui-abstract/UiAdmin.d.ts +221 -221
- package/lib/esm/appui-abstract/UiAdmin.js +219 -219
- package/lib/esm/appui-abstract/UiAdmin.js.map +1 -1
- package/lib/esm/appui-abstract/UiItemsManager.d.ts +113 -113
- package/lib/esm/appui-abstract/UiItemsManager.js +189 -189
- package/lib/esm/appui-abstract/UiItemsManager.js.map +1 -1
- package/lib/esm/appui-abstract/UiItemsProvider.d.ts +29 -29
- package/lib/esm/appui-abstract/UiItemsProvider.js +8 -8
- package/lib/esm/appui-abstract/UiItemsProvider.js.map +1 -1
- package/lib/esm/appui-abstract/backstage/BackstageItem.d.ts +91 -91
- package/lib/esm/appui-abstract/backstage/BackstageItem.js +64 -64
- package/lib/esm/appui-abstract/backstage/BackstageItem.js.map +1 -1
- package/lib/esm/appui-abstract/backstage/BackstageItemsManager.d.ts +38 -38
- package/lib/esm/appui-abstract/backstage/BackstageItemsManager.js +129 -129
- package/lib/esm/appui-abstract/backstage/BackstageItemsManager.js.map +1 -1
- package/lib/esm/appui-abstract/common/KeyboardKey.d.ts +51 -51
- package/lib/esm/appui-abstract/common/KeyboardKey.js +59 -59
- package/lib/esm/appui-abstract/common/KeyboardKey.js.map +1 -1
- package/lib/esm/appui-abstract/content/ContentLayoutProps.d.ts +62 -62
- package/lib/esm/appui-abstract/content/ContentLayoutProps.js +8 -8
- package/lib/esm/appui-abstract/content/ContentLayoutProps.js.map +1 -1
- package/lib/esm/appui-abstract/content/StandardContentLayouts.d.ts +19 -19
- package/lib/esm/appui-abstract/content/StandardContentLayouts.js +104 -104
- package/lib/esm/appui-abstract/content/StandardContentLayouts.js.map +1 -1
- package/lib/esm/appui-abstract/dialogs/DialogItem.d.ts +76 -76
- package/lib/esm/appui-abstract/dialogs/DialogItem.js +63 -63
- package/lib/esm/appui-abstract/dialogs/DialogItem.js.map +1 -1
- package/lib/esm/appui-abstract/dialogs/UiDataProvider.d.ts +55 -55
- package/lib/esm/appui-abstract/dialogs/UiDataProvider.js +61 -61
- package/lib/esm/appui-abstract/dialogs/UiDataProvider.js.map +1 -1
- package/lib/esm/appui-abstract/dialogs/UiLayoutDataProvider.d.ts +97 -97
- package/lib/esm/appui-abstract/dialogs/UiLayoutDataProvider.js +170 -170
- package/lib/esm/appui-abstract/dialogs/UiLayoutDataProvider.js.map +1 -1
- package/lib/esm/appui-abstract/items/AbstractItemProps.d.ts +53 -53
- package/lib/esm/appui-abstract/items/AbstractItemProps.js +8 -8
- package/lib/esm/appui-abstract/items/AbstractItemProps.js.map +1 -1
- package/lib/esm/appui-abstract/items/AbstractMenuItemProps.d.ts +20 -20
- package/lib/esm/appui-abstract/items/AbstractMenuItemProps.js +8 -8
- package/lib/esm/appui-abstract/items/AbstractMenuItemProps.js.map +1 -1
- package/lib/esm/appui-abstract/items/AbstractToolbarProps.d.ts +13 -13
- package/lib/esm/appui-abstract/items/AbstractToolbarProps.js +8 -8
- package/lib/esm/appui-abstract/items/AbstractToolbarProps.js.map +1 -1
- package/lib/esm/appui-abstract/items/BadgeType.d.ts +14 -14
- package/lib/esm/appui-abstract/items/BadgeType.js +19 -19
- package/lib/esm/appui-abstract/items/BadgeType.js.map +1 -1
- package/lib/esm/appui-abstract/items/ConditionalBooleanValue.d.ts +27 -27
- package/lib/esm/appui-abstract/items/ConditionalBooleanValue.js +56 -56
- package/lib/esm/appui-abstract/items/ConditionalBooleanValue.js.map +1 -1
- package/lib/esm/appui-abstract/items/ConditionalStringValue.d.ts +29 -29
- package/lib/esm/appui-abstract/items/ConditionalStringValue.js +58 -58
- package/lib/esm/appui-abstract/items/ConditionalStringValue.js.map +1 -1
- package/lib/esm/appui-abstract/items/ProvidedItem.d.ts +11 -11
- package/lib/esm/appui-abstract/items/ProvidedItem.js +8 -8
- package/lib/esm/appui-abstract/items/ProvidedItem.js.map +1 -1
- package/lib/esm/appui-abstract/items/RelativePosition.d.ts +18 -18
- package/lib/esm/appui-abstract/items/RelativePosition.js +23 -23
- package/lib/esm/appui-abstract/items/RelativePosition.js.map +1 -1
- package/lib/esm/appui-abstract/items/StageUsage.d.ts +16 -16
- package/lib/esm/appui-abstract/items/StageUsage.js +21 -21
- package/lib/esm/appui-abstract/items/StageUsage.js.map +1 -1
- package/lib/esm/appui-abstract/notification/MessagePresenter.d.ts +42 -42
- package/lib/esm/appui-abstract/notification/MessagePresenter.js +21 -21
- package/lib/esm/appui-abstract/notification/MessagePresenter.js.map +1 -1
- package/lib/esm/appui-abstract/notification/MessageSeverity.d.ts +15 -15
- package/lib/esm/appui-abstract/notification/MessageSeverity.js +20 -20
- package/lib/esm/appui-abstract/notification/MessageSeverity.js.map +1 -1
- package/lib/esm/appui-abstract/properties/Description.d.ts +127 -127
- package/lib/esm/appui-abstract/properties/Description.js +192 -192
- package/lib/esm/appui-abstract/properties/Description.js.map +1 -1
- package/lib/esm/appui-abstract/properties/EditorParams.d.ts +260 -260
- package/lib/esm/appui-abstract/properties/EditorParams.js +97 -97
- package/lib/esm/appui-abstract/properties/EditorParams.js.map +1 -1
- package/lib/esm/appui-abstract/properties/PrimitiveTypes.d.ts +60 -60
- package/lib/esm/appui-abstract/properties/PrimitiveTypes.js +8 -8
- package/lib/esm/appui-abstract/properties/PrimitiveTypes.js.map +1 -1
- package/lib/esm/appui-abstract/properties/Record.d.ts +57 -57
- package/lib/esm/appui-abstract/properties/Record.js +74 -74
- package/lib/esm/appui-abstract/properties/Record.js.map +1 -1
- package/lib/esm/appui-abstract/properties/StandardEditorNames.d.ts +22 -22
- package/lib/esm/appui-abstract/properties/StandardEditorNames.js +27 -27
- package/lib/esm/appui-abstract/properties/StandardEditorNames.js.map +1 -1
- package/lib/esm/appui-abstract/properties/StandardTypeNames.d.ts +30 -30
- package/lib/esm/appui-abstract/properties/StandardTypeNames.js +36 -36
- package/lib/esm/appui-abstract/properties/StandardTypeNames.js.map +1 -1
- package/lib/esm/appui-abstract/properties/Value.d.ts +49 -49
- package/lib/esm/appui-abstract/properties/Value.js +17 -17
- package/lib/esm/appui-abstract/properties/Value.js.map +1 -1
- package/lib/esm/appui-abstract/quantity/BaseQuantityDescription.d.ts +22 -22
- package/lib/esm/appui-abstract/quantity/BaseQuantityDescription.js +44 -44
- package/lib/esm/appui-abstract/quantity/BaseQuantityDescription.js.map +1 -1
- package/lib/esm/appui-abstract/statusbar/StatusBarItem.d.ts +128 -128
- package/lib/esm/appui-abstract/statusbar/StatusBarItem.js +80 -80
- package/lib/esm/appui-abstract/statusbar/StatusBarItem.js.map +1 -1
- package/lib/esm/appui-abstract/statusbar/StatusBarItemsManager.d.ts +39 -39
- package/lib/esm/appui-abstract/statusbar/StatusBarItemsManager.js +131 -131
- package/lib/esm/appui-abstract/statusbar/StatusBarItemsManager.js.map +1 -1
- package/lib/esm/appui-abstract/toolbars/ToolbarItem.d.ts +121 -121
- package/lib/esm/appui-abstract/toolbars/ToolbarItem.js +60 -60
- package/lib/esm/appui-abstract/toolbars/ToolbarItem.js.map +1 -1
- package/lib/esm/appui-abstract/toolbars/ToolbarItemsManager.d.ts +45 -45
- package/lib/esm/appui-abstract/toolbars/ToolbarItemsManager.js +231 -231
- package/lib/esm/appui-abstract/toolbars/ToolbarItemsManager.js.map +1 -1
- package/lib/esm/appui-abstract/utils/IconSpecUtilities.d.ts +29 -29
- package/lib/esm/appui-abstract/utils/IconSpecUtilities.js +47 -47
- package/lib/esm/appui-abstract/utils/IconSpecUtilities.js.map +1 -1
- package/lib/esm/appui-abstract/utils/PointProps.d.ts +10 -10
- package/lib/esm/appui-abstract/utils/PointProps.js +8 -8
- package/lib/esm/appui-abstract/utils/PointProps.js.map +1 -1
- package/lib/esm/appui-abstract/utils/UiError.d.ts +12 -12
- package/lib/esm/appui-abstract/utils/UiError.js +18 -18
- package/lib/esm/appui-abstract/utils/UiError.js.map +1 -1
- package/lib/esm/appui-abstract/utils/UiEvent.d.ts +9 -9
- package/lib/esm/appui-abstract/utils/UiEvent.js +13 -13
- package/lib/esm/appui-abstract/utils/UiEvent.js.map +1 -1
- package/lib/esm/appui-abstract/utils/UiEventDispatcher.d.ts +46 -46
- package/lib/esm/appui-abstract/utils/UiEventDispatcher.js +126 -126
- package/lib/esm/appui-abstract/utils/UiEventDispatcher.js.map +1 -1
- package/lib/esm/appui-abstract/utils/callbacks.d.ts +20 -20
- package/lib/esm/appui-abstract/utils/callbacks.js +8 -8
- package/lib/esm/appui-abstract/utils/callbacks.js.map +1 -1
- package/lib/esm/appui-abstract/utils/filter/charCode.d.ts +416 -416
- package/lib/esm/appui-abstract/utils/filter/charCode.js +5 -5
- package/lib/esm/appui-abstract/utils/filter/charCode.js.map +1 -1
- package/lib/esm/appui-abstract/utils/filter/filters.d.ts +98 -98
- package/lib/esm/appui-abstract/utils/filter/filters.js +694 -694
- package/lib/esm/appui-abstract/utils/filter/filters.js.map +1 -1
- package/lib/esm/appui-abstract/utils/filter/map.d.ts +59 -59
- package/lib/esm/appui-abstract/utils/filter/map.js +397 -397
- package/lib/esm/appui-abstract/utils/filter/map.js.map +1 -1
- package/lib/esm/appui-abstract/utils/filter/strings.d.ts +20 -20
- package/lib/esm/appui-abstract/utils/filter/strings.js +70 -70
- package/lib/esm/appui-abstract/utils/filter/strings.js.map +1 -1
- package/lib/esm/appui-abstract/utils/isLetter.d.ts +9 -9
- package/lib/esm/appui-abstract/utils/isLetter.js +15 -15
- package/lib/esm/appui-abstract/utils/isLetter.js.map +1 -1
- package/lib/esm/appui-abstract/utils/misc.d.ts +11 -11
- package/lib/esm/appui-abstract/utils/misc.js +31 -31
- package/lib/esm/appui-abstract/utils/misc.js.map +1 -1
- package/lib/esm/appui-abstract/widget/AbstractWidgetProps.d.ts +86 -86
- package/lib/esm/appui-abstract/widget/AbstractWidgetProps.js +8 -8
- package/lib/esm/appui-abstract/widget/AbstractWidgetProps.js.map +1 -1
- package/lib/esm/appui-abstract/widget/StagePanel.d.ts +36 -36
- package/lib/esm/appui-abstract/widget/StagePanel.js +43 -43
- package/lib/esm/appui-abstract/widget/StagePanel.js.map +1 -1
- package/lib/esm/appui-abstract/widget/WidgetState.d.ts +19 -19
- package/lib/esm/appui-abstract/widget/WidgetState.js +24 -24
- package/lib/esm/appui-abstract/widget/WidgetState.js.map +1 -1
- package/lib/esm/appui-abstract.d.ts +103 -103
- package/lib/esm/appui-abstract.js +107 -107
- package/lib/esm/appui-abstract.js.map +1 -1
- package/package.json +4 -4
@@ -1,114 +1,114 @@
|
|
1
|
-
/** @packageDocumentation
|
2
|
-
* @module UiItemsProvider
|
3
|
-
*/
|
4
|
-
import { BeEvent, MarkRequired } from "@itwin/core-bentley";
|
5
|
-
import { BackstageItem } from "./backstage/BackstageItem";
|
6
|
-
import { CommonStatusBarItem } from "./statusbar/StatusBarItem";
|
7
|
-
import { CommonToolbarItem, ToolbarOrientation, ToolbarUsage } from "./toolbars/ToolbarItem";
|
8
|
-
import { AbstractWidgetProps } from "./widget/AbstractWidgetProps";
|
9
|
-
import { AbstractZoneLocation, StagePanelLocation, StagePanelSection } from "./widget/StagePanel";
|
10
|
-
import { UiItemsProvider } from "./UiItemsProvider";
|
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 declare enum UiItemsApplicationAction {
|
15
|
-
/** Allow the change to the item */
|
16
|
-
Allow = 0,
|
17
|
-
/** Disallow the change to the item */
|
18
|
-
Disallow = 1,
|
19
|
-
/** Update the item during the change */
|
20
|
-
Update = 2
|
21
|
-
}
|
22
|
-
/** UIProvider Registered Event Args interface.
|
23
|
-
* @deprecated in 3.6. Use [UiItemsProviderRegisteredEventArgs]($appui-react) instead.
|
24
|
-
* @public
|
25
|
-
*/
|
26
|
-
export interface UiItemProviderRegisteredEventArgs {
|
27
|
-
providerId: string;
|
28
|
-
}
|
29
|
-
/** UiItemProviderOverrides allows the application that registers a provider to limit when it is allowed to provide items
|
30
|
-
* @deprecated in 3.6. Use [AllowedUiItemsProviderOverrides]($appui-react) instead.
|
31
|
-
* @public
|
32
|
-
*/
|
33
|
-
export interface AllowedUiItemProviderOverrides {
|
34
|
-
/** allows providerId to be overridden in the items manager for cases where the same provider needs to provide different content to different stages
|
35
|
-
* @beta
|
36
|
-
*/
|
37
|
-
providerId?: string;
|
38
|
-
/** if specified then the current stage's Usage will be compared before allowing any items to be provided
|
39
|
-
* @beta
|
40
|
-
*/
|
41
|
-
stageUsages?: string[];
|
42
|
-
/** if specified then the current stage's Id will be compared before allowing any items to be provided
|
43
|
-
* @beta
|
44
|
-
*/
|
45
|
-
stageIds?: string[];
|
46
|
-
}
|
47
|
-
/** Allowed overrides applied to a UiItemsProvider the application that registers a provider to limit when it is allowed to provide items.
|
48
|
-
* Note that if an override `providerId` is specified then either `stageIds` or `stageUsages` must be defined to limit when the provider's
|
49
|
-
* items are allowed.
|
50
|
-
* @deprecated in 3.6. Use [UiItemsProviderOverrides]($appui-react) instead.
|
51
|
-
* @public
|
52
|
-
*/
|
53
|
-
export declare type UiItemProviderOverrides = MarkRequired<AllowedUiItemProviderOverrides, "providerId" | "stageUsages"> | MarkRequired<AllowedUiItemProviderOverrides, "providerId" | "stageIds"> | // eslint-disable-line @typescript-eslint/indent
|
54
|
-
MarkRequired<AllowedUiItemProviderOverrides, "stageIds"> | // eslint-disable-line @typescript-eslint/indent
|
55
|
-
MarkRequired<AllowedUiItemProviderOverrides, "stageUsages"> | // eslint-disable-line @typescript-eslint/indent
|
56
|
-
MarkRequired<AllowedUiItemProviderOverrides, "providerId" | "stageUsages" | "stageIds">;
|
57
|
-
/** Controls registering of UiItemsProviders and calls the provider's methods when populating different parts of the User Interface.
|
58
|
-
* @deprecated in 3.6. Use [UiItemsManager]($appui-react) instead.
|
59
|
-
* @public
|
60
|
-
*/
|
61
|
-
export declare class UiItemsManager {
|
62
|
-
private static _registeredUiItemsProviders;
|
63
|
-
/** For use in unit testing
|
64
|
-
* @internal */
|
65
|
-
static clearAllProviders(): void;
|
66
|
-
/** Event raised any time a UiProvider is registered or unregistered. */
|
67
|
-
static readonly onUiProviderRegisteredEvent: BeEvent<(ev: UiItemProviderRegisteredEventArgs) => void>;
|
68
|
-
/** Return number of registered UiProvider. */
|
69
|
-
static get registeredProviderIds(): string[];
|
70
|
-
/** Return true if there is any registered UiProvider. */
|
71
|
-
static get hasRegisteredProviders(): boolean;
|
72
|
-
/**
|
73
|
-
* Retrieves a previously loaded UiItemsProvider.
|
74
|
-
* @param providerId id of the UiItemsProvider to get
|
75
|
-
*/
|
76
|
-
static getUiItemsProvider(providerId: string): UiItemsProvider | undefined;
|
77
|
-
private static sendRegisteredEvent;
|
78
|
-
/**
|
79
|
-
* Registers a UiItemsProvider with the UiItemsManager.
|
80
|
-
* @param uiProvider the UI items provider to register.
|
81
|
-
*/
|
82
|
-
static register(uiProvider: UiItemsProvider, overrides?: UiItemProviderOverrides): void;
|
83
|
-
/** Remove a specific UiItemsProvider from the list of available providers. */
|
84
|
-
static unregister(uiProviderId: string): void;
|
85
|
-
private static allowItemsFromProvider;
|
86
|
-
/** Called when the application is populating a toolbar so that any registered UiItemsProvider can add tool buttons that either either execute
|
87
|
-
* an action or specify a registered ToolId into toolbar.
|
88
|
-
* @param stageId a string identifier the active stage.
|
89
|
-
* @param stageUsage the StageUsage of the active stage.
|
90
|
-
* @param toolbarUsage usage of the toolbar
|
91
|
-
* @param toolbarOrientation orientation of the toolbar
|
92
|
-
* @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.
|
93
|
-
*/
|
94
|
-
static getToolbarButtonItems(stageId: string, stageUsage: string, toolbarUsage: ToolbarUsage, toolbarOrientation: ToolbarOrientation, stageAppData?: any): CommonToolbarItem[];
|
95
|
-
/** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields
|
96
|
-
* @param stageId a string identifier the active stage.
|
97
|
-
* @param stageUsage the StageUsage of the active stage.
|
98
|
-
* @returns An array of CommonStatusBarItem that will be used to create controls for the status bar.
|
99
|
-
*/
|
100
|
-
static getStatusBarItems(stageId: string, stageUsage: string, stageAppData?: any): CommonStatusBarItem[];
|
101
|
-
/** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields
|
102
|
-
* @returns An array of BackstageItem that will be used to create controls for the backstage menu.
|
103
|
-
*/
|
104
|
-
static getBackstageItems(): BackstageItem[];
|
105
|
-
/** Called when the application is populating the Stage Panels so that any registered UiItemsProvider can add widgets
|
106
|
-
* @param stageId a string identifier the active stage.
|
107
|
-
* @param stageUsage the StageUsage of the active stage.
|
108
|
-
* @param location the location within the stage.
|
109
|
-
* @param section the section within location.
|
110
|
-
* @returns An array of AbstractWidgetProps that will be used to create widgets.
|
111
|
-
*/
|
112
|
-
static getWidgets(stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection, zoneLocation?: AbstractZoneLocation, stageAppData?: any): ReadonlyArray<AbstractWidgetProps>;
|
113
|
-
}
|
1
|
+
/** @packageDocumentation
|
2
|
+
* @module UiItemsProvider
|
3
|
+
*/
|
4
|
+
import { BeEvent, MarkRequired } from "@itwin/core-bentley";
|
5
|
+
import { BackstageItem } from "./backstage/BackstageItem";
|
6
|
+
import { CommonStatusBarItem } from "./statusbar/StatusBarItem";
|
7
|
+
import { CommonToolbarItem, ToolbarOrientation, ToolbarUsage } from "./toolbars/ToolbarItem";
|
8
|
+
import { AbstractWidgetProps } from "./widget/AbstractWidgetProps";
|
9
|
+
import { AbstractZoneLocation, StagePanelLocation, StagePanelSection } from "./widget/StagePanel";
|
10
|
+
import { UiItemsProvider } from "./UiItemsProvider";
|
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 declare enum UiItemsApplicationAction {
|
15
|
+
/** Allow the change to the item */
|
16
|
+
Allow = 0,
|
17
|
+
/** Disallow the change to the item */
|
18
|
+
Disallow = 1,
|
19
|
+
/** Update the item during the change */
|
20
|
+
Update = 2
|
21
|
+
}
|
22
|
+
/** UIProvider Registered Event Args interface.
|
23
|
+
* @deprecated in 3.6. Use [UiItemsProviderRegisteredEventArgs]($appui-react) instead.
|
24
|
+
* @public
|
25
|
+
*/
|
26
|
+
export interface UiItemProviderRegisteredEventArgs {
|
27
|
+
providerId: string;
|
28
|
+
}
|
29
|
+
/** UiItemProviderOverrides allows the application that registers a provider to limit when it is allowed to provide items
|
30
|
+
* @deprecated in 3.6. Use [AllowedUiItemsProviderOverrides]($appui-react) instead.
|
31
|
+
* @public
|
32
|
+
*/
|
33
|
+
export interface AllowedUiItemProviderOverrides {
|
34
|
+
/** allows providerId to be overridden in the items manager for cases where the same provider needs to provide different content to different stages
|
35
|
+
* @beta
|
36
|
+
*/
|
37
|
+
providerId?: string;
|
38
|
+
/** if specified then the current stage's Usage will be compared before allowing any items to be provided
|
39
|
+
* @beta
|
40
|
+
*/
|
41
|
+
stageUsages?: string[];
|
42
|
+
/** if specified then the current stage's Id will be compared before allowing any items to be provided
|
43
|
+
* @beta
|
44
|
+
*/
|
45
|
+
stageIds?: string[];
|
46
|
+
}
|
47
|
+
/** Allowed overrides applied to a UiItemsProvider the application that registers a provider to limit when it is allowed to provide items.
|
48
|
+
* Note that if an override `providerId` is specified then either `stageIds` or `stageUsages` must be defined to limit when the provider's
|
49
|
+
* items are allowed.
|
50
|
+
* @deprecated in 3.6. Use [UiItemsProviderOverrides]($appui-react) instead.
|
51
|
+
* @public
|
52
|
+
*/
|
53
|
+
export declare type UiItemProviderOverrides = MarkRequired<AllowedUiItemProviderOverrides, "providerId" | "stageUsages"> | MarkRequired<AllowedUiItemProviderOverrides, "providerId" | "stageIds"> | // eslint-disable-line @typescript-eslint/indent
|
54
|
+
MarkRequired<AllowedUiItemProviderOverrides, "stageIds"> | // eslint-disable-line @typescript-eslint/indent
|
55
|
+
MarkRequired<AllowedUiItemProviderOverrides, "stageUsages"> | // eslint-disable-line @typescript-eslint/indent
|
56
|
+
MarkRequired<AllowedUiItemProviderOverrides, "providerId" | "stageUsages" | "stageIds">;
|
57
|
+
/** Controls registering of UiItemsProviders and calls the provider's methods when populating different parts of the User Interface.
|
58
|
+
* @deprecated in 3.6. Use [UiItemsManager]($appui-react) instead.
|
59
|
+
* @public
|
60
|
+
*/
|
61
|
+
export declare class UiItemsManager {
|
62
|
+
private static _registeredUiItemsProviders;
|
63
|
+
/** For use in unit testing
|
64
|
+
* @internal */
|
65
|
+
static clearAllProviders(): void;
|
66
|
+
/** Event raised any time a UiProvider is registered or unregistered. */
|
67
|
+
static readonly onUiProviderRegisteredEvent: BeEvent<(ev: UiItemProviderRegisteredEventArgs) => void>;
|
68
|
+
/** Return number of registered UiProvider. */
|
69
|
+
static get registeredProviderIds(): string[];
|
70
|
+
/** Return true if there is any registered UiProvider. */
|
71
|
+
static get hasRegisteredProviders(): boolean;
|
72
|
+
/**
|
73
|
+
* Retrieves a previously loaded UiItemsProvider.
|
74
|
+
* @param providerId id of the UiItemsProvider to get
|
75
|
+
*/
|
76
|
+
static getUiItemsProvider(providerId: string): UiItemsProvider | undefined;
|
77
|
+
private static sendRegisteredEvent;
|
78
|
+
/**
|
79
|
+
* Registers a UiItemsProvider with the UiItemsManager.
|
80
|
+
* @param uiProvider the UI items provider to register.
|
81
|
+
*/
|
82
|
+
static register(uiProvider: UiItemsProvider, overrides?: UiItemProviderOverrides): void;
|
83
|
+
/** Remove a specific UiItemsProvider from the list of available providers. */
|
84
|
+
static unregister(uiProviderId: string): void;
|
85
|
+
private static allowItemsFromProvider;
|
86
|
+
/** Called when the application is populating a toolbar so that any registered UiItemsProvider can add tool buttons that either either execute
|
87
|
+
* an action or specify a registered ToolId into toolbar.
|
88
|
+
* @param stageId a string identifier the active stage.
|
89
|
+
* @param stageUsage the StageUsage of the active stage.
|
90
|
+
* @param toolbarUsage usage of the toolbar
|
91
|
+
* @param toolbarOrientation orientation of the toolbar
|
92
|
+
* @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.
|
93
|
+
*/
|
94
|
+
static getToolbarButtonItems(stageId: string, stageUsage: string, toolbarUsage: ToolbarUsage, toolbarOrientation: ToolbarOrientation, stageAppData?: any): CommonToolbarItem[];
|
95
|
+
/** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields
|
96
|
+
* @param stageId a string identifier the active stage.
|
97
|
+
* @param stageUsage the StageUsage of the active stage.
|
98
|
+
* @returns An array of CommonStatusBarItem that will be used to create controls for the status bar.
|
99
|
+
*/
|
100
|
+
static getStatusBarItems(stageId: string, stageUsage: string, stageAppData?: any): CommonStatusBarItem[];
|
101
|
+
/** Called when the application is populating the statusbar so that any registered UiItemsProvider can add status fields
|
102
|
+
* @returns An array of BackstageItem that will be used to create controls for the backstage menu.
|
103
|
+
*/
|
104
|
+
static getBackstageItems(): BackstageItem[];
|
105
|
+
/** Called when the application is populating the Stage Panels so that any registered UiItemsProvider can add widgets
|
106
|
+
* @param stageId a string identifier the active stage.
|
107
|
+
* @param stageUsage the StageUsage of the active stage.
|
108
|
+
* @param location the location within the stage.
|
109
|
+
* @param section the section within location.
|
110
|
+
* @returns An array of AbstractWidgetProps that will be used to create widgets.
|
111
|
+
*/
|
112
|
+
static getWidgets(stageId: string, stageUsage: string, location: StagePanelLocation, section?: StagePanelSection, zoneLocation?: AbstractZoneLocation, stageAppData?: any): ReadonlyArray<AbstractWidgetProps>;
|
113
|
+
}
|
114
114
|
//# sourceMappingURL=UiItemsManager.d.ts.map
|
@@ -1,190 +1,190 @@
|
|
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
|
-
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();
|
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
|
+
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
190
|
//# sourceMappingURL=UiItemsManager.js.map
|