@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,220 +1,220 @@
|
|
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 UiAdmin
|
7
|
-
*/
|
8
|
-
import { BeUiEvent } from "@itwin/core-bentley";
|
9
|
-
import { loggerCategory } from "./utils/misc";
|
10
|
-
import { UiError } from "./utils/UiError";
|
11
|
-
/** The GenericUiEvent is the base event class for UI events that target a specific component, as identified in uiComponentId.
|
12
|
-
* @public
|
13
|
-
*/
|
14
|
-
export class GenericUiEvent extends BeUiEvent {
|
15
|
-
}
|
16
|
-
/** The UiAdmin controls various UI components and is callable from IModelApp.uiAdmin in the core-frontend package.
|
17
|
-
* @public
|
18
|
-
*/
|
19
|
-
export class UiAdmin {
|
20
|
-
constructor() {
|
21
|
-
this._featureFlags = {};
|
22
|
-
}
|
23
|
-
/** The MessagePresenter used to display messages. */
|
24
|
-
static get messagePresenter() {
|
25
|
-
if (!UiAdmin._messagePresenter)
|
26
|
-
throw new UiError(loggerCategory(this), "UiAdmin.messagePresenter not set");
|
27
|
-
return UiAdmin._messagePresenter;
|
28
|
-
}
|
29
|
-
static set messagePresenter(mp) {
|
30
|
-
UiAdmin._messagePresenter = mp;
|
31
|
-
}
|
32
|
-
get featureFlags() {
|
33
|
-
return { ...this._featureFlags }; // return copy so no direct access to modify value
|
34
|
-
}
|
35
|
-
updateFeatureFlags(uiFlags) {
|
36
|
-
this._featureFlags = { ...this._featureFlags, ...uiFlags };
|
37
|
-
}
|
38
|
-
/** @internal */
|
39
|
-
onInitialized() { }
|
40
|
-
/** Get the cursor X and Y position. */
|
41
|
-
get cursorPosition() { return { x: 0, y: 0 }; }
|
42
|
-
/** Create a PointProps object. */
|
43
|
-
createXAndY(x, y) { return { x, y }; }
|
44
|
-
/** Determines if focus is set to Home */
|
45
|
-
get isFocusOnHome() { return false; }
|
46
|
-
/** Sets focus to Home */
|
47
|
-
setFocusToHome() { }
|
48
|
-
/** Show a context menu at a particular location.
|
49
|
-
* @param _menuItemsProps Properties of the menu items to display.
|
50
|
-
* @param _location Location of the context menu, relative to the origin of htmlElement or the window.
|
51
|
-
* @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
|
52
|
-
* @return true if the menu was displayed, false if the menu could not be displayed.
|
53
|
-
*/
|
54
|
-
showContextMenu(_menuItemsProps, _location, _htmlElement) {
|
55
|
-
return false;
|
56
|
-
}
|
57
|
-
/** Show a Toolbar at a particular location.
|
58
|
-
* @param _toolbarProps Properties of the Toolbar to display.
|
59
|
-
* @param _location Location of the Toolbar, relative to the origin of htmlElement or the window.
|
60
|
-
* @param _offset Offset of the Toolbar from the location.
|
61
|
-
* @param _onItemExecuted Function invoked after a Toolbar item is executed
|
62
|
-
* @param _onCancel Function invoked when the Escape key is pressed or a click occurs outside the Toolbar
|
63
|
-
* @param _relativePosition Position relative to the given location. Defaults to TopRight.
|
64
|
-
* @param _htmlElement The HTMLElement that anchors the Toolbar. If undefined, the location is relative to the overall window.
|
65
|
-
* @return true if the Toolbar was displayed, false if the Toolbar could not be displayed.
|
66
|
-
*/
|
67
|
-
showToolbar(_toolbarProps, _location, _offset, _onItemExecuted, _onCancel, _relativePosition, _htmlElement) {
|
68
|
-
return false;
|
69
|
-
}
|
70
|
-
/** Hides the toolbar. */
|
71
|
-
hideToolbar() { return false; }
|
72
|
-
/** Show a menu button at a particular location. A menu button opens a context menu.
|
73
|
-
* @param _id Id of the menu button. Multiple menu buttons may be displayed.
|
74
|
-
* @param _menuItemsProps Properties of the menu items to display.
|
75
|
-
* @param _location Location of the context menu, relative to the origin of htmlElement or the window.
|
76
|
-
* @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
|
77
|
-
* @return true if the button was displayed, false if the button could not be displayed.
|
78
|
-
*/
|
79
|
-
showMenuButton(_id, _menuItemsProps, _location, _htmlElement) {
|
80
|
-
return false;
|
81
|
-
}
|
82
|
-
/** Hides a menu button.
|
83
|
-
* @param _id Id of the menu button. Multiple menu buttons may be displayed.
|
84
|
-
* @return true if the menu was hidden, false if the menu could not be hidden.
|
85
|
-
*/
|
86
|
-
hideMenuButton(_id) { return false; }
|
87
|
-
/** Show a calculator at a particular location.
|
88
|
-
* @param _initialValue Value initially displayed in the calculator.
|
89
|
-
* @param _resultIcon Icon displayed to the left of the value.
|
90
|
-
* @param _location Location of the calculator, relative to the origin of htmlElement or the window.
|
91
|
-
* @param _onCommit Function called when the OK button or the Enter key is pressed.
|
92
|
-
* @param _onCancel Function called when the Cancel button or the Escape key is pressed.
|
93
|
-
* @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
|
94
|
-
* @return true if the calculator was displayed, false if the calculator could not be displayed.
|
95
|
-
*/
|
96
|
-
showCalculator(_initialValue, _resultIcon, _location, _onCommit, _onCancel, _htmlElement) {
|
97
|
-
return false;
|
98
|
-
}
|
99
|
-
/** Hides the calculator. */
|
100
|
-
hideCalculator() { return false; }
|
101
|
-
/** Show an input editor for an angle value at a particular location.
|
102
|
-
* @param _initialValue Value initially displayed in the editor.
|
103
|
-
* @param _location Location of the editor, relative to the origin of htmlElement or the window.
|
104
|
-
* @param _onCommit Function called when the OK button or the Enter key is pressed.
|
105
|
-
* @param _onCancel Function called when the Cancel button or the Escape key is pressed.
|
106
|
-
* @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
|
107
|
-
* @return true if the editor was displayed, false if the editor could not be displayed.
|
108
|
-
*/
|
109
|
-
showAngleEditor(_initialValue, _location, _onCommit, _onCancel, _htmlElement) {
|
110
|
-
return false;
|
111
|
-
}
|
112
|
-
/** Show an input editor for a length value at a particular location.
|
113
|
-
* @param _initialValue Value initially displayed in the editor.
|
114
|
-
* @param _location Location of the editor, relative to the origin of htmlElement or the window.
|
115
|
-
* @param _onCommit Function called when the OK button or the Enter key is pressed.
|
116
|
-
* @param _onCancel Function called when the Cancel button or the Escape key is pressed.
|
117
|
-
* @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
|
118
|
-
* @return true if the editor was displayed, false if the editor could not be displayed.
|
119
|
-
*/
|
120
|
-
showLengthEditor(_initialValue, _location, _onCommit, _onCancel, _htmlElement) {
|
121
|
-
return false;
|
122
|
-
}
|
123
|
-
/** Show an input editor for a height value at a particular location.
|
124
|
-
* @param _initialValue Value initially displayed in the editor.
|
125
|
-
* @param _location Location of the editor, relative to the origin of htmlElement or the window.
|
126
|
-
* @param _onCommit Function called when the OK button or the Enter key is pressed.
|
127
|
-
* @param _onCancel Function called when the Cancel button or the Escape key is pressed.
|
128
|
-
* @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
|
129
|
-
* @return true if the editor was displayed, false if the editor could not be displayed.
|
130
|
-
*/
|
131
|
-
showHeightEditor(_initialValue, _location, _onCommit, _onCancel, _htmlElement) {
|
132
|
-
return false;
|
133
|
-
}
|
134
|
-
/** Show an input editor for a primitive value at a particular location.
|
135
|
-
* @param _initialValue Value initially displayed in the editor.
|
136
|
-
* @param _propertyDescription Description of the primitive value property.
|
137
|
-
* @param _location Location of the editor, relative to the origin of htmlElement or the window.
|
138
|
-
* @param _onCommit Function called when the OK button or the Enter key is pressed.
|
139
|
-
* @param _onCancel Function called when the Cancel button or the Escape key is pressed.
|
140
|
-
* @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
|
141
|
-
* @return true if the editor was displayed, false if the editor could not be displayed.
|
142
|
-
*/
|
143
|
-
showInputEditor(_initialValue, _propertyDescription, _location, _onCommit, _onCancel, _htmlElement) {
|
144
|
-
return false;
|
145
|
-
}
|
146
|
-
/** Hides the input editor. */
|
147
|
-
hideInputEditor() { return false; }
|
148
|
-
/** Show an HTML element at a particular location.
|
149
|
-
* @param _displayElement The HTMLElement to display
|
150
|
-
* @param _location Location of the tool settings, relative to the origin of anchorElement or the window
|
151
|
-
* @param _offset Offset of the display element from the location
|
152
|
-
* @param _onCancel Function invoked when the Escape key is pressed or a click occurs outside the display element
|
153
|
-
* @param _relativePosition Position relative to the given location. Defaults to TopRight.
|
154
|
-
* @param _anchorElement The HTMLElement that anchors the display element. If undefined, the location is relative to the overall window.
|
155
|
-
* @return true if the display element was displayed, false if the display element could not be displayed.
|
156
|
-
*/
|
157
|
-
showHTMLElement(_displayElement, _location, _offset, _onCancel, _relativePosition, _anchorElement) {
|
158
|
-
return false;
|
159
|
-
}
|
160
|
-
/** Hides the HTML Element. */
|
161
|
-
hideHTMLElement() { return false; }
|
162
|
-
/** Show a Card containing content, a title and a toolbar at a particular location.
|
163
|
-
* @param _content The HTMLElement of the content to display
|
164
|
-
* @param _title Title to display at the top of the card.
|
165
|
-
* @param _toolbarProps Properties of the Toolbar to display.
|
166
|
-
* @param _location Location of the Card, relative to the origin of anchorElement or the window.
|
167
|
-
* @param _offset Offset of the Card from the location.
|
168
|
-
* @param _onItemExecuted Function invoked after a Toolbar item is executed
|
169
|
-
* @param _onCancel Function invoked when the Escape key is pressed or a click occurs outside the Card
|
170
|
-
* @param _relativePosition Position relative to the given location. Defaults to TopRight.
|
171
|
-
* @param _anchorElement The HTMLElement that anchors the Card. If undefined, the location is relative to the overall window.
|
172
|
-
* @return true if the Card was displayed, false if the Card could not be displayed.
|
173
|
-
*/
|
174
|
-
showCard(_content, _title, _toolbarProps, _location, _offset, _onItemExecuted, _onCancel, _relativePosition, _anchorElement) {
|
175
|
-
return false;
|
176
|
-
}
|
177
|
-
/** Hides the Card. */
|
178
|
-
hideCard() { return false; }
|
179
|
-
/** Opens a Tool Settings Ui popup at a particular location.
|
180
|
-
* @param _dataProvider The UiDataProvider for the tool settings
|
181
|
-
* @param _location Location of the tool settings, relative to the origin of anchorElement or the window
|
182
|
-
* @param _offset Offset of the tool settings from the location
|
183
|
-
* @param _onCancel Function invoked when the Escape key is pressed or a click occurs outside the tool settings
|
184
|
-
* @param _relativePosition Position relative to the given location. Defaults to TopRight.
|
185
|
-
* @param _anchorElement The HTMLElement that anchors the tool settings. If undefined, the location is relative to the overall window.
|
186
|
-
* @return true if the tool settings were displayed, false if the tool settings could not be displayed.
|
187
|
-
*/
|
188
|
-
openToolSettingsPopup(_dataProvider, _location, _offset, _onCancel, _relativePosition, _anchorElement) {
|
189
|
-
return false;
|
190
|
-
}
|
191
|
-
/** Closes the Tool Settings Ui popup. */
|
192
|
-
closeToolSettingsPopup() { return false; }
|
193
|
-
/** Show the Keyin Palette to display all support Tool key-ins.
|
194
|
-
* @param _htmlElement The HTMLElement that anchors the Keyin Palette. If undefined, the location is relative to the overall window.
|
195
|
-
* @return true if the Keyin Palette was displayed, false if it could not be displayed.
|
196
|
-
*/
|
197
|
-
showKeyinPalette(_htmlElement) { return false; }
|
198
|
-
/** Hides the Keyin Palette. */
|
199
|
-
hideKeyinPalette() { return false; }
|
200
|
-
/** Send a UI event */
|
201
|
-
static sendUiEvent(args) {
|
202
|
-
UiAdmin.onGenericUiEvent.emit(args);
|
203
|
-
}
|
204
|
-
/** Opens a Dialog and automatically populates it using the properties defined by the UiDataProvider.
|
205
|
-
* @param _uiDataProvider The DialogLayoutDataProvider for the dialog
|
206
|
-
* @param _title Specify title for dialog.
|
207
|
-
* @param _isModal Specify if the dialog is opened as a modal or modeless.
|
208
|
-
* @param _id Id of the dialog that is used to close it.
|
209
|
-
* @param _optionalProps Optional props for Dialog construction.
|
210
|
-
* @return true if the tool settings were displayed, false if the tool settings could not be displayed.
|
211
|
-
*/
|
212
|
-
openDialog(_uiDataProvider, _title, _isModal, _id, _optionalProps) {
|
213
|
-
return false;
|
214
|
-
}
|
215
|
-
/** Closes the Dialog with a given Id. */
|
216
|
-
closeDialog(_dialogId) { return false; }
|
217
|
-
}
|
218
|
-
/** GenericUiEvent */
|
219
|
-
UiAdmin.onGenericUiEvent = new GenericUiEvent();
|
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 UiAdmin
|
7
|
+
*/
|
8
|
+
import { BeUiEvent } from "@itwin/core-bentley";
|
9
|
+
import { loggerCategory } from "./utils/misc";
|
10
|
+
import { UiError } from "./utils/UiError";
|
11
|
+
/** The GenericUiEvent is the base event class for UI events that target a specific component, as identified in uiComponentId.
|
12
|
+
* @public
|
13
|
+
*/
|
14
|
+
export class GenericUiEvent extends BeUiEvent {
|
15
|
+
}
|
16
|
+
/** The UiAdmin controls various UI components and is callable from IModelApp.uiAdmin in the core-frontend package.
|
17
|
+
* @public
|
18
|
+
*/
|
19
|
+
export class UiAdmin {
|
20
|
+
constructor() {
|
21
|
+
this._featureFlags = {};
|
22
|
+
}
|
23
|
+
/** The MessagePresenter used to display messages. */
|
24
|
+
static get messagePresenter() {
|
25
|
+
if (!UiAdmin._messagePresenter)
|
26
|
+
throw new UiError(loggerCategory(this), "UiAdmin.messagePresenter not set");
|
27
|
+
return UiAdmin._messagePresenter;
|
28
|
+
}
|
29
|
+
static set messagePresenter(mp) {
|
30
|
+
UiAdmin._messagePresenter = mp;
|
31
|
+
}
|
32
|
+
get featureFlags() {
|
33
|
+
return { ...this._featureFlags }; // return copy so no direct access to modify value
|
34
|
+
}
|
35
|
+
updateFeatureFlags(uiFlags) {
|
36
|
+
this._featureFlags = { ...this._featureFlags, ...uiFlags };
|
37
|
+
}
|
38
|
+
/** @internal */
|
39
|
+
onInitialized() { }
|
40
|
+
/** Get the cursor X and Y position. */
|
41
|
+
get cursorPosition() { return { x: 0, y: 0 }; }
|
42
|
+
/** Create a PointProps object. */
|
43
|
+
createXAndY(x, y) { return { x, y }; }
|
44
|
+
/** Determines if focus is set to Home */
|
45
|
+
get isFocusOnHome() { return false; }
|
46
|
+
/** Sets focus to Home */
|
47
|
+
setFocusToHome() { }
|
48
|
+
/** Show a context menu at a particular location.
|
49
|
+
* @param _menuItemsProps Properties of the menu items to display.
|
50
|
+
* @param _location Location of the context menu, relative to the origin of htmlElement or the window.
|
51
|
+
* @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
|
52
|
+
* @return true if the menu was displayed, false if the menu could not be displayed.
|
53
|
+
*/
|
54
|
+
showContextMenu(_menuItemsProps, _location, _htmlElement) {
|
55
|
+
return false;
|
56
|
+
}
|
57
|
+
/** Show a Toolbar at a particular location.
|
58
|
+
* @param _toolbarProps Properties of the Toolbar to display.
|
59
|
+
* @param _location Location of the Toolbar, relative to the origin of htmlElement or the window.
|
60
|
+
* @param _offset Offset of the Toolbar from the location.
|
61
|
+
* @param _onItemExecuted Function invoked after a Toolbar item is executed
|
62
|
+
* @param _onCancel Function invoked when the Escape key is pressed or a click occurs outside the Toolbar
|
63
|
+
* @param _relativePosition Position relative to the given location. Defaults to TopRight.
|
64
|
+
* @param _htmlElement The HTMLElement that anchors the Toolbar. If undefined, the location is relative to the overall window.
|
65
|
+
* @return true if the Toolbar was displayed, false if the Toolbar could not be displayed.
|
66
|
+
*/
|
67
|
+
showToolbar(_toolbarProps, _location, _offset, _onItemExecuted, _onCancel, _relativePosition, _htmlElement) {
|
68
|
+
return false;
|
69
|
+
}
|
70
|
+
/** Hides the toolbar. */
|
71
|
+
hideToolbar() { return false; }
|
72
|
+
/** Show a menu button at a particular location. A menu button opens a context menu.
|
73
|
+
* @param _id Id of the menu button. Multiple menu buttons may be displayed.
|
74
|
+
* @param _menuItemsProps Properties of the menu items to display.
|
75
|
+
* @param _location Location of the context menu, relative to the origin of htmlElement or the window.
|
76
|
+
* @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
|
77
|
+
* @return true if the button was displayed, false if the button could not be displayed.
|
78
|
+
*/
|
79
|
+
showMenuButton(_id, _menuItemsProps, _location, _htmlElement) {
|
80
|
+
return false;
|
81
|
+
}
|
82
|
+
/** Hides a menu button.
|
83
|
+
* @param _id Id of the menu button. Multiple menu buttons may be displayed.
|
84
|
+
* @return true if the menu was hidden, false if the menu could not be hidden.
|
85
|
+
*/
|
86
|
+
hideMenuButton(_id) { return false; }
|
87
|
+
/** Show a calculator at a particular location.
|
88
|
+
* @param _initialValue Value initially displayed in the calculator.
|
89
|
+
* @param _resultIcon Icon displayed to the left of the value.
|
90
|
+
* @param _location Location of the calculator, relative to the origin of htmlElement or the window.
|
91
|
+
* @param _onCommit Function called when the OK button or the Enter key is pressed.
|
92
|
+
* @param _onCancel Function called when the Cancel button or the Escape key is pressed.
|
93
|
+
* @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
|
94
|
+
* @return true if the calculator was displayed, false if the calculator could not be displayed.
|
95
|
+
*/
|
96
|
+
showCalculator(_initialValue, _resultIcon, _location, _onCommit, _onCancel, _htmlElement) {
|
97
|
+
return false;
|
98
|
+
}
|
99
|
+
/** Hides the calculator. */
|
100
|
+
hideCalculator() { return false; }
|
101
|
+
/** Show an input editor for an angle value at a particular location.
|
102
|
+
* @param _initialValue Value initially displayed in the editor.
|
103
|
+
* @param _location Location of the editor, relative to the origin of htmlElement or the window.
|
104
|
+
* @param _onCommit Function called when the OK button or the Enter key is pressed.
|
105
|
+
* @param _onCancel Function called when the Cancel button or the Escape key is pressed.
|
106
|
+
* @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
|
107
|
+
* @return true if the editor was displayed, false if the editor could not be displayed.
|
108
|
+
*/
|
109
|
+
showAngleEditor(_initialValue, _location, _onCommit, _onCancel, _htmlElement) {
|
110
|
+
return false;
|
111
|
+
}
|
112
|
+
/** Show an input editor for a length value at a particular location.
|
113
|
+
* @param _initialValue Value initially displayed in the editor.
|
114
|
+
* @param _location Location of the editor, relative to the origin of htmlElement or the window.
|
115
|
+
* @param _onCommit Function called when the OK button or the Enter key is pressed.
|
116
|
+
* @param _onCancel Function called when the Cancel button or the Escape key is pressed.
|
117
|
+
* @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
|
118
|
+
* @return true if the editor was displayed, false if the editor could not be displayed.
|
119
|
+
*/
|
120
|
+
showLengthEditor(_initialValue, _location, _onCommit, _onCancel, _htmlElement) {
|
121
|
+
return false;
|
122
|
+
}
|
123
|
+
/** Show an input editor for a height value at a particular location.
|
124
|
+
* @param _initialValue Value initially displayed in the editor.
|
125
|
+
* @param _location Location of the editor, relative to the origin of htmlElement or the window.
|
126
|
+
* @param _onCommit Function called when the OK button or the Enter key is pressed.
|
127
|
+
* @param _onCancel Function called when the Cancel button or the Escape key is pressed.
|
128
|
+
* @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
|
129
|
+
* @return true if the editor was displayed, false if the editor could not be displayed.
|
130
|
+
*/
|
131
|
+
showHeightEditor(_initialValue, _location, _onCommit, _onCancel, _htmlElement) {
|
132
|
+
return false;
|
133
|
+
}
|
134
|
+
/** Show an input editor for a primitive value at a particular location.
|
135
|
+
* @param _initialValue Value initially displayed in the editor.
|
136
|
+
* @param _propertyDescription Description of the primitive value property.
|
137
|
+
* @param _location Location of the editor, relative to the origin of htmlElement or the window.
|
138
|
+
* @param _onCommit Function called when the OK button or the Enter key is pressed.
|
139
|
+
* @param _onCancel Function called when the Cancel button or the Escape key is pressed.
|
140
|
+
* @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
|
141
|
+
* @return true if the editor was displayed, false if the editor could not be displayed.
|
142
|
+
*/
|
143
|
+
showInputEditor(_initialValue, _propertyDescription, _location, _onCommit, _onCancel, _htmlElement) {
|
144
|
+
return false;
|
145
|
+
}
|
146
|
+
/** Hides the input editor. */
|
147
|
+
hideInputEditor() { return false; }
|
148
|
+
/** Show an HTML element at a particular location.
|
149
|
+
* @param _displayElement The HTMLElement to display
|
150
|
+
* @param _location Location of the tool settings, relative to the origin of anchorElement or the window
|
151
|
+
* @param _offset Offset of the display element from the location
|
152
|
+
* @param _onCancel Function invoked when the Escape key is pressed or a click occurs outside the display element
|
153
|
+
* @param _relativePosition Position relative to the given location. Defaults to TopRight.
|
154
|
+
* @param _anchorElement The HTMLElement that anchors the display element. If undefined, the location is relative to the overall window.
|
155
|
+
* @return true if the display element was displayed, false if the display element could not be displayed.
|
156
|
+
*/
|
157
|
+
showHTMLElement(_displayElement, _location, _offset, _onCancel, _relativePosition, _anchorElement) {
|
158
|
+
return false;
|
159
|
+
}
|
160
|
+
/** Hides the HTML Element. */
|
161
|
+
hideHTMLElement() { return false; }
|
162
|
+
/** Show a Card containing content, a title and a toolbar at a particular location.
|
163
|
+
* @param _content The HTMLElement of the content to display
|
164
|
+
* @param _title Title to display at the top of the card.
|
165
|
+
* @param _toolbarProps Properties of the Toolbar to display.
|
166
|
+
* @param _location Location of the Card, relative to the origin of anchorElement or the window.
|
167
|
+
* @param _offset Offset of the Card from the location.
|
168
|
+
* @param _onItemExecuted Function invoked after a Toolbar item is executed
|
169
|
+
* @param _onCancel Function invoked when the Escape key is pressed or a click occurs outside the Card
|
170
|
+
* @param _relativePosition Position relative to the given location. Defaults to TopRight.
|
171
|
+
* @param _anchorElement The HTMLElement that anchors the Card. If undefined, the location is relative to the overall window.
|
172
|
+
* @return true if the Card was displayed, false if the Card could not be displayed.
|
173
|
+
*/
|
174
|
+
showCard(_content, _title, _toolbarProps, _location, _offset, _onItemExecuted, _onCancel, _relativePosition, _anchorElement) {
|
175
|
+
return false;
|
176
|
+
}
|
177
|
+
/** Hides the Card. */
|
178
|
+
hideCard() { return false; }
|
179
|
+
/** Opens a Tool Settings Ui popup at a particular location.
|
180
|
+
* @param _dataProvider The UiDataProvider for the tool settings
|
181
|
+
* @param _location Location of the tool settings, relative to the origin of anchorElement or the window
|
182
|
+
* @param _offset Offset of the tool settings from the location
|
183
|
+
* @param _onCancel Function invoked when the Escape key is pressed or a click occurs outside the tool settings
|
184
|
+
* @param _relativePosition Position relative to the given location. Defaults to TopRight.
|
185
|
+
* @param _anchorElement The HTMLElement that anchors the tool settings. If undefined, the location is relative to the overall window.
|
186
|
+
* @return true if the tool settings were displayed, false if the tool settings could not be displayed.
|
187
|
+
*/
|
188
|
+
openToolSettingsPopup(_dataProvider, _location, _offset, _onCancel, _relativePosition, _anchorElement) {
|
189
|
+
return false;
|
190
|
+
}
|
191
|
+
/** Closes the Tool Settings Ui popup. */
|
192
|
+
closeToolSettingsPopup() { return false; }
|
193
|
+
/** Show the Keyin Palette to display all support Tool key-ins.
|
194
|
+
* @param _htmlElement The HTMLElement that anchors the Keyin Palette. If undefined, the location is relative to the overall window.
|
195
|
+
* @return true if the Keyin Palette was displayed, false if it could not be displayed.
|
196
|
+
*/
|
197
|
+
showKeyinPalette(_htmlElement) { return false; }
|
198
|
+
/** Hides the Keyin Palette. */
|
199
|
+
hideKeyinPalette() { return false; }
|
200
|
+
/** Send a UI event */
|
201
|
+
static sendUiEvent(args) {
|
202
|
+
UiAdmin.onGenericUiEvent.emit(args);
|
203
|
+
}
|
204
|
+
/** Opens a Dialog and automatically populates it using the properties defined by the UiDataProvider.
|
205
|
+
* @param _uiDataProvider The DialogLayoutDataProvider for the dialog
|
206
|
+
* @param _title Specify title for dialog.
|
207
|
+
* @param _isModal Specify if the dialog is opened as a modal or modeless.
|
208
|
+
* @param _id Id of the dialog that is used to close it.
|
209
|
+
* @param _optionalProps Optional props for Dialog construction.
|
210
|
+
* @return true if the tool settings were displayed, false if the tool settings could not be displayed.
|
211
|
+
*/
|
212
|
+
openDialog(_uiDataProvider, _title, _isModal, _id, _optionalProps) {
|
213
|
+
return false;
|
214
|
+
}
|
215
|
+
/** Closes the Dialog with a given Id. */
|
216
|
+
closeDialog(_dialogId) { return false; }
|
217
|
+
}
|
218
|
+
/** GenericUiEvent */
|
219
|
+
UiAdmin.onGenericUiEvent = new GenericUiEvent();
|
220
220
|
//# sourceMappingURL=UiAdmin.js.map
|
@@ -1 +1 @@
|
|
1
|
-
{"version":3,"file":"UiAdmin.js","sourceRoot":"","sources":["../../../src/appui-abstract/UiAdmin.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAWhD,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AA+B1C;;GAEG;AACH,MAAM,OAAO,cAAe,SAAQ,SAA6B;CAAI;AAUrE;;GAEG;AACH,MAAM,OAAO,OAAO;IAApB;QACU,kBAAa,GAAY,EAAE,CAAC;IA+OtC,CAAC;IA5OC,qDAAqD;IAC9C,MAAM,KAAK,gBAAgB;QAChC,IAAI,CAAC,OAAO,CAAC,iBAAiB;YAC5B,MAAM,IAAI,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,kCAAkC,CAAC,CAAC;QAC9E,OAAO,OAAO,CAAC,iBAAiB,CAAC;IACnC,CAAC;IACM,MAAM,KAAK,gBAAgB,CAAC,EAAoB;QACrD,OAAO,CAAC,iBAAiB,GAAG,EAAE,CAAC;IACjC,CAAC;IAED,IAAW,YAAY;QACrB,OAAO,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC,kDAAkD;IACtF,CAAC;IAEM,kBAAkB,CAAC,OAAgB;QACxC,IAAI,CAAC,aAAa,GAAG,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,GAAG,OAAO,EAAE,CAAC;IAC7D,CAAC;IAED,gBAAgB;IACT,aAAa,KAAK,CAAC;IAE1B,uCAAuC;IACvC,IAAW,cAAc,KAAiB,OAAO,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAElE,kCAAkC;IAC3B,WAAW,CAAC,CAAS,EAAE,CAAS,IAAgB,OAAO,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAEzE,yCAAyC;IACzC,IAAW,aAAa,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAErD,yBAAyB;IAClB,cAAc,KAAW,CAAC;IAEjC;;;;;OAKG;IACI,eAAe,CAAC,eAAwC,EAAE,SAAqB,EAAE,YAA0B;QAChH,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;;;OASG;IACI,WAAW,CAChB,aAAmC,EAAE,SAAqB,EAAE,OAAmB,EAAE,eAAmC,EAAE,SAAuB,EAC7I,iBAAoC,EAAE,YAA0B;QAChE,OAAO,KAAK,CAAC;IACf,CAAC;IAED,yBAAyB;IAClB,WAAW,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAE/C;;;;;;OAMG;IACI,cAAc,CAAC,GAAW,EAAE,eAAwC,EAAE,SAAqB,EAAE,YAA0B;QAC5H,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;OAGG;IACI,cAAc,CAAC,GAAW,IAAa,OAAO,KAAK,CAAC,CAAC,CAAC;IAE7D;;;;;;;;OAQG;IACI,cAAc,CAAC,aAAqB,EAAE,WAAmB,EAAE,SAAqB,EAAE,SAA6B,EAAE,SAAuB,EAAE,YAA0B;QACzK,OAAO,KAAK,CAAC;IACf,CAAC;IAED,4BAA4B;IACrB,cAAc,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAElD;;;;;;;OAOG;IACI,eAAe,CAAC,aAAqB,EAAE,SAAqB,EAAE,SAA6B,EAAE,SAAuB,EAAE,YAA0B;QACrJ,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;OAOG;IACI,gBAAgB,CAAC,aAAqB,EAAE,SAAqB,EAAE,SAA6B,EAAE,SAAuB,EAAE,YAA0B;QACtJ,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;OAOG;IACI,gBAAgB,CAAC,aAAqB,EAAE,SAAqB,EAAE,SAA6B,EAAE,SAAuB,EAAE,YAA0B;QACtJ,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;;OAQG;IACI,eAAe,CAAC,aAA+B,EAAE,oBAAyC,EAAE,SAAqB,EAAE,SAA4B,EAAE,SAAuB,EAAE,YAA0B;QACzM,OAAO,KAAK,CAAC;IACf,CAAC;IAED,8BAA8B;IACvB,eAAe,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAEnD;;;;;;;;OAQG;IACI,eAAe,CACpB,eAA4B,EAAE,SAAqB,EAAE,OAAmB,EAAE,SAAuB,EACjG,iBAAoC,EAAE,cAA4B;QAClE,OAAO,KAAK,CAAC;IACf,CAAC;IAED,8BAA8B;IACvB,eAAe,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAEnD;;;;;;;;;;;OAWG;IACI,QAAQ,CACb,QAAqB,EAAE,MAA2C,EAAE,aAA+C,EACnH,SAAqB,EAAE,OAAmB,EAAE,eAAmC,EAAE,SAAuB,EACxG,iBAAoC,EAAE,cAA4B;QAClE,OAAO,KAAK,CAAC;IACf,CAAC;IAED,sBAAsB;IACf,QAAQ,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAE5C;;;;;;;;OAQG;IACI,qBAAqB,CAC1B,aAA6B,EAAE,SAAqB,EAAE,OAAmB,EAAE,SAAuB,EAClG,iBAAoC,EAAE,cAA4B;QAClE,OAAO,KAAK,CAAC;IACf,CAAC;IAED,yCAAyC;IAClC,sBAAsB,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAE1D;;;OAGG;IACI,gBAAgB,CAAC,YAA0B,IAAa,OAAO,KAAK,CAAC,CAAC,CAAC;IAE9E,+BAA+B;IACxB,gBAAgB,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAEpD,sBAAsB;IACf,MAAM,CAAC,WAAW,CAAC,IAAwB;QAChD,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;IAID;;;;;;;OAOG;IACI,UAAU,CAAC,eAAyC,EAAE,MAAc,EAAE,QAAiB,EAAE,GAAW,EACzG,cAA4B;QAC5B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,yCAAyC;IAClC,WAAW,CAAC,SAAiB,IAAa,OAAO,KAAK,CAAC,CAAC,CAAC;;AAjBhE,sBAAsB;AACC,wBAAgB,GAAG,IAAI,cAAc,EAAE,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 UiAdmin\n */\n\nimport { BeUiEvent } from \"@itwin/core-bentley\";\nimport { AbstractMenuItemProps } from \"./items/AbstractMenuItemProps\";\nimport { AbstractToolbarProps } from \"./items/AbstractToolbarProps\";\nimport { RelativePosition } from \"./items/RelativePosition\";\nimport { PropertyDescription } from \"./properties/Description\";\nimport { Primitives } from \"./properties/PrimitiveTypes\";\nimport { OnCancelFunc, OnItemExecutedFunc, OnNumberCommitFunc, OnValueCommitFunc } from \"./utils/callbacks\";\nimport { PropertyRecord } from \"./properties/Record\";\nimport { UiDataProvider } from \"./dialogs/UiDataProvider\";\nimport { DialogLayoutDataProvider } from \"./dialogs/UiLayoutDataProvider\";\nimport { PointProps } from \"./utils/PointProps\";\nimport { loggerCategory } from \"./utils/misc\";\nimport { MessagePresenter } from \"./notification/MessagePresenter\";\nimport { UiError } from \"./utils/UiError\";\n\n/** The Generic UI Event args contains information useful for any UI message\n * @public\n */\nexport interface GenericUiEventArgs {\n uiComponentId: string;\n}\n\n/** Optional props to pass to the Dialog control that is generated.\n * @public\n */\nexport interface DialogProps {\n /** Indicates whether the user can resize dialog with cursor. */\n resizable?: boolean;\n /** Indicates whether the user can move dialog with cursor.*/\n movable?: boolean;\n /** Initial width of dialog. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */\n width?: string | number;\n /** Initial height of dialog. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */\n height?: string | number;\n /** Minimum width that the dialog may be resized to. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */\n minWidth?: string | number;\n /** Minimum height that the dialog may be resized to. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */\n minHeight?: string | number;\n /** Maximum width that the dialog may be resized to. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */\n maxWidth?: string | number;\n /** Maximum height that the dialog may be resized to. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */\n maxHeight?: string | number;\n}\n\n/** The GenericUiEvent is the base event class for UI events that target a specific component, as identified in uiComponentId.\n * @public\n */\nexport class GenericUiEvent extends BeUiEvent<GenericUiEventArgs> { }\n\n/** Flags that control enabling/disabling certain UI features\n * @public\n */\nexport interface UiFlags {\n /** if true then Ctrl+F2 will show popup key-in palette */\n allowKeyinPalette?: boolean;\n}\n\n/** The UiAdmin controls various UI components and is callable from IModelApp.uiAdmin in the core-frontend package.\n * @public\n */\nexport class UiAdmin {\n private _featureFlags: UiFlags = {};\n private static _messagePresenter?: MessagePresenter;\n\n /** The MessagePresenter used to display messages. */\n public static get messagePresenter(): MessagePresenter {\n if (!UiAdmin._messagePresenter)\n throw new UiError(loggerCategory(this), \"UiAdmin.messagePresenter not set\");\n return UiAdmin._messagePresenter;\n }\n public static set messagePresenter(mp: MessagePresenter) {\n UiAdmin._messagePresenter = mp;\n }\n\n public get featureFlags(): UiFlags {\n return { ...this._featureFlags }; // return copy so no direct access to modify value\n }\n\n public updateFeatureFlags(uiFlags: UiFlags) {\n this._featureFlags = { ...this._featureFlags, ...uiFlags };\n }\n\n /** @internal */\n public onInitialized() { }\n\n /** Get the cursor X and Y position. */\n public get cursorPosition(): PointProps { return { x: 0, y: 0 }; }\n\n /** Create a PointProps object. */\n public createXAndY(x: number, y: number): PointProps { return { x, y }; }\n\n /** Determines if focus is set to Home */\n public get isFocusOnHome(): boolean { return false; }\n\n /** Sets focus to Home */\n public setFocusToHome(): void { }\n\n /** Show a context menu at a particular location.\n * @param _menuItemsProps Properties of the menu items to display.\n * @param _location Location of the context menu, relative to the origin of htmlElement or the window.\n * @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\n * @return true if the menu was displayed, false if the menu could not be displayed.\n */\n public showContextMenu(_menuItemsProps: AbstractMenuItemProps[], _location: PointProps, _htmlElement?: HTMLElement): boolean {\n return false;\n }\n\n /** Show a Toolbar at a particular location.\n * @param _toolbarProps Properties of the Toolbar to display.\n * @param _location Location of the Toolbar, relative to the origin of htmlElement or the window.\n * @param _offset Offset of the Toolbar from the location.\n * @param _onItemExecuted Function invoked after a Toolbar item is executed\n * @param _onCancel Function invoked when the Escape key is pressed or a click occurs outside the Toolbar\n * @param _relativePosition Position relative to the given location. Defaults to TopRight.\n * @param _htmlElement The HTMLElement that anchors the Toolbar. If undefined, the location is relative to the overall window.\n * @return true if the Toolbar was displayed, false if the Toolbar could not be displayed.\n */\n public showToolbar(\n _toolbarProps: AbstractToolbarProps, _location: PointProps, _offset: PointProps, _onItemExecuted: OnItemExecutedFunc, _onCancel: OnCancelFunc,\n _relativePosition?: RelativePosition, _htmlElement?: HTMLElement): boolean {\n return false;\n }\n\n /** Hides the toolbar. */\n public hideToolbar(): boolean { return false; }\n\n /** Show a menu button at a particular location. A menu button opens a context menu.\n * @param _id Id of the menu button. Multiple menu buttons may be displayed.\n * @param _menuItemsProps Properties of the menu items to display.\n * @param _location Location of the context menu, relative to the origin of htmlElement or the window.\n * @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\n * @return true if the button was displayed, false if the button could not be displayed.\n */\n public showMenuButton(_id: string, _menuItemsProps: AbstractMenuItemProps[], _location: PointProps, _htmlElement?: HTMLElement): boolean {\n return false;\n }\n\n /** Hides a menu button.\n * @param _id Id of the menu button. Multiple menu buttons may be displayed.\n * @return true if the menu was hidden, false if the menu could not be hidden.\n */\n public hideMenuButton(_id: string): boolean { return false; }\n\n /** Show a calculator at a particular location.\n * @param _initialValue Value initially displayed in the calculator.\n * @param _resultIcon Icon displayed to the left of the value.\n * @param _location Location of the calculator, relative to the origin of htmlElement or the window.\n * @param _onCommit Function called when the OK button or the Enter key is pressed.\n * @param _onCancel Function called when the Cancel button or the Escape key is pressed.\n * @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\n * @return true if the calculator was displayed, false if the calculator could not be displayed.\n */\n public showCalculator(_initialValue: number, _resultIcon: string, _location: PointProps, _onCommit: OnNumberCommitFunc, _onCancel: OnCancelFunc, _htmlElement?: HTMLElement): boolean {\n return false;\n }\n\n /** Hides the calculator. */\n public hideCalculator(): boolean { return false; }\n\n /** Show an input editor for an angle value at a particular location.\n * @param _initialValue Value initially displayed in the editor.\n * @param _location Location of the editor, relative to the origin of htmlElement or the window.\n * @param _onCommit Function called when the OK button or the Enter key is pressed.\n * @param _onCancel Function called when the Cancel button or the Escape key is pressed.\n * @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\n * @return true if the editor was displayed, false if the editor could not be displayed.\n */\n public showAngleEditor(_initialValue: number, _location: PointProps, _onCommit: OnNumberCommitFunc, _onCancel: OnCancelFunc, _htmlElement?: HTMLElement): boolean {\n return false;\n }\n\n /** Show an input editor for a length value at a particular location.\n * @param _initialValue Value initially displayed in the editor.\n * @param _location Location of the editor, relative to the origin of htmlElement or the window.\n * @param _onCommit Function called when the OK button or the Enter key is pressed.\n * @param _onCancel Function called when the Cancel button or the Escape key is pressed.\n * @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\n * @return true if the editor was displayed, false if the editor could not be displayed.\n */\n public showLengthEditor(_initialValue: number, _location: PointProps, _onCommit: OnNumberCommitFunc, _onCancel: OnCancelFunc, _htmlElement?: HTMLElement): boolean {\n return false;\n }\n\n /** Show an input editor for a height value at a particular location.\n * @param _initialValue Value initially displayed in the editor.\n * @param _location Location of the editor, relative to the origin of htmlElement or the window.\n * @param _onCommit Function called when the OK button or the Enter key is pressed.\n * @param _onCancel Function called when the Cancel button or the Escape key is pressed.\n * @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\n * @return true if the editor was displayed, false if the editor could not be displayed.\n */\n public showHeightEditor(_initialValue: number, _location: PointProps, _onCommit: OnNumberCommitFunc, _onCancel: OnCancelFunc, _htmlElement?: HTMLElement): boolean {\n return false;\n }\n\n /** Show an input editor for a primitive value at a particular location.\n * @param _initialValue Value initially displayed in the editor.\n * @param _propertyDescription Description of the primitive value property.\n * @param _location Location of the editor, relative to the origin of htmlElement or the window.\n * @param _onCommit Function called when the OK button or the Enter key is pressed.\n * @param _onCancel Function called when the Cancel button or the Escape key is pressed.\n * @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\n * @return true if the editor was displayed, false if the editor could not be displayed.\n */\n public showInputEditor(_initialValue: Primitives.Value, _propertyDescription: PropertyDescription, _location: PointProps, _onCommit: OnValueCommitFunc, _onCancel: OnCancelFunc, _htmlElement?: HTMLElement): boolean {\n return false;\n }\n\n /** Hides the input editor. */\n public hideInputEditor(): boolean { return false; }\n\n /** Show an HTML element at a particular location.\n * @param _displayElement The HTMLElement to display\n * @param _location Location of the tool settings, relative to the origin of anchorElement or the window\n * @param _offset Offset of the display element from the location\n * @param _onCancel Function invoked when the Escape key is pressed or a click occurs outside the display element\n * @param _relativePosition Position relative to the given location. Defaults to TopRight.\n * @param _anchorElement The HTMLElement that anchors the display element. If undefined, the location is relative to the overall window.\n * @return true if the display element was displayed, false if the display element could not be displayed.\n */\n public showHTMLElement(\n _displayElement: HTMLElement, _location: PointProps, _offset: PointProps, _onCancel: OnCancelFunc,\n _relativePosition?: RelativePosition, _anchorElement?: HTMLElement): boolean {\n return false;\n }\n\n /** Hides the HTML Element. */\n public hideHTMLElement(): boolean { return false; }\n\n /** Show a Card containing content, a title and a toolbar at a particular location.\n * @param _content The HTMLElement of the content to display\n * @param _title Title to display at the top of the card.\n * @param _toolbarProps Properties of the Toolbar to display.\n * @param _location Location of the Card, relative to the origin of anchorElement or the window.\n * @param _offset Offset of the Card from the location.\n * @param _onItemExecuted Function invoked after a Toolbar item is executed\n * @param _onCancel Function invoked when the Escape key is pressed or a click occurs outside the Card\n * @param _relativePosition Position relative to the given location. Defaults to TopRight.\n * @param _anchorElement The HTMLElement that anchors the Card. If undefined, the location is relative to the overall window.\n * @return true if the Card was displayed, false if the Card could not be displayed.\n */\n public showCard(\n _content: HTMLElement, _title: string | PropertyRecord | undefined, _toolbarProps: AbstractToolbarProps | undefined,\n _location: PointProps, _offset: PointProps, _onItemExecuted: OnItemExecutedFunc, _onCancel: OnCancelFunc,\n _relativePosition?: RelativePosition, _anchorElement?: HTMLElement): boolean {\n return false;\n }\n\n /** Hides the Card. */\n public hideCard(): boolean { return false; }\n\n /** Opens a Tool Settings Ui popup at a particular location.\n * @param _dataProvider The UiDataProvider for the tool settings\n * @param _location Location of the tool settings, relative to the origin of anchorElement or the window\n * @param _offset Offset of the tool settings from the location\n * @param _onCancel Function invoked when the Escape key is pressed or a click occurs outside the tool settings\n * @param _relativePosition Position relative to the given location. Defaults to TopRight.\n * @param _anchorElement The HTMLElement that anchors the tool settings. If undefined, the location is relative to the overall window.\n * @return true if the tool settings were displayed, false if the tool settings could not be displayed.\n */\n public openToolSettingsPopup(\n _dataProvider: UiDataProvider, _location: PointProps, _offset: PointProps, _onCancel: OnCancelFunc,\n _relativePosition?: RelativePosition, _anchorElement?: HTMLElement): boolean {\n return false;\n }\n\n /** Closes the Tool Settings Ui popup. */\n public closeToolSettingsPopup(): boolean { return false; }\n\n /** Show the Keyin Palette to display all support Tool key-ins.\n * @param _htmlElement The HTMLElement that anchors the Keyin Palette. If undefined, the location is relative to the overall window.\n * @return true if the Keyin Palette was displayed, false if it could not be displayed.\n */\n public showKeyinPalette(_htmlElement?: HTMLElement): boolean { return false; }\n\n /** Hides the Keyin Palette. */\n public hideKeyinPalette(): boolean { return false; }\n\n /** Send a UI event */\n public static sendUiEvent(args: GenericUiEventArgs) {\n UiAdmin.onGenericUiEvent.emit(args);\n }\n /** GenericUiEvent */\n public static readonly onGenericUiEvent = new GenericUiEvent();\n\n /** Opens a Dialog and automatically populates it using the properties defined by the UiDataProvider.\n * @param _uiDataProvider The DialogLayoutDataProvider for the dialog\n * @param _title Specify title for dialog.\n * @param _isModal Specify if the dialog is opened as a modal or modeless.\n * @param _id Id of the dialog that is used to close it.\n * @param _optionalProps Optional props for Dialog construction.\n * @return true if the tool settings were displayed, false if the tool settings could not be displayed.\n */\n public openDialog(_uiDataProvider: DialogLayoutDataProvider, _title: string, _isModal: boolean, _id: string,\n _optionalProps?: DialogProps): boolean {\n return false;\n }\n\n /** Closes the Dialog with a given Id. */\n public closeDialog(_dialogId: string): boolean { return false; }\n}\n"]}
|
1
|
+
{"version":3,"file":"UiAdmin.js","sourceRoot":"","sources":["../../../src/appui-abstract/UiAdmin.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAWhD,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAE9C,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AA+B1C;;GAEG;AACH,MAAM,OAAO,cAAe,SAAQ,SAA6B;CAAI;AAUrE;;GAEG;AACH,MAAM,OAAO,OAAO;IAApB;QACU,kBAAa,GAAY,EAAE,CAAC;IA+OtC,CAAC;IA5OC,qDAAqD;IAC9C,MAAM,KAAK,gBAAgB;QAChC,IAAI,CAAC,OAAO,CAAC,iBAAiB;YAC5B,MAAM,IAAI,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,EAAE,kCAAkC,CAAC,CAAC;QAC9E,OAAO,OAAO,CAAC,iBAAiB,CAAC;IACnC,CAAC;IACM,MAAM,KAAK,gBAAgB,CAAC,EAAoB;QACrD,OAAO,CAAC,iBAAiB,GAAG,EAAE,CAAC;IACjC,CAAC;IAED,IAAW,YAAY;QACrB,OAAO,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC,kDAAkD;IACtF,CAAC;IAEM,kBAAkB,CAAC,OAAgB;QACxC,IAAI,CAAC,aAAa,GAAG,EAAE,GAAG,IAAI,CAAC,aAAa,EAAE,GAAG,OAAO,EAAE,CAAC;IAC7D,CAAC;IAED,gBAAgB;IACT,aAAa,KAAK,CAAC;IAE1B,uCAAuC;IACvC,IAAW,cAAc,KAAiB,OAAO,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAElE,kCAAkC;IAC3B,WAAW,CAAC,CAAS,EAAE,CAAS,IAAgB,OAAO,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAEzE,yCAAyC;IACzC,IAAW,aAAa,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAErD,yBAAyB;IAClB,cAAc,KAAW,CAAC;IAEjC;;;;;OAKG;IACI,eAAe,CAAC,eAAwC,EAAE,SAAqB,EAAE,YAA0B;QAChH,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;;;OASG;IACI,WAAW,CAChB,aAAmC,EAAE,SAAqB,EAAE,OAAmB,EAAE,eAAmC,EAAE,SAAuB,EAC7I,iBAAoC,EAAE,YAA0B;QAChE,OAAO,KAAK,CAAC;IACf,CAAC;IAED,yBAAyB;IAClB,WAAW,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAE/C;;;;;;OAMG;IACI,cAAc,CAAC,GAAW,EAAE,eAAwC,EAAE,SAAqB,EAAE,YAA0B;QAC5H,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;OAGG;IACI,cAAc,CAAC,GAAW,IAAa,OAAO,KAAK,CAAC,CAAC,CAAC;IAE7D;;;;;;;;OAQG;IACI,cAAc,CAAC,aAAqB,EAAE,WAAmB,EAAE,SAAqB,EAAE,SAA6B,EAAE,SAAuB,EAAE,YAA0B;QACzK,OAAO,KAAK,CAAC;IACf,CAAC;IAED,4BAA4B;IACrB,cAAc,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAElD;;;;;;;OAOG;IACI,eAAe,CAAC,aAAqB,EAAE,SAAqB,EAAE,SAA6B,EAAE,SAAuB,EAAE,YAA0B;QACrJ,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;OAOG;IACI,gBAAgB,CAAC,aAAqB,EAAE,SAAqB,EAAE,SAA6B,EAAE,SAAuB,EAAE,YAA0B;QACtJ,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;OAOG;IACI,gBAAgB,CAAC,aAAqB,EAAE,SAAqB,EAAE,SAA6B,EAAE,SAAuB,EAAE,YAA0B;QACtJ,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;;;;;;OAQG;IACI,eAAe,CAAC,aAA+B,EAAE,oBAAyC,EAAE,SAAqB,EAAE,SAA4B,EAAE,SAAuB,EAAE,YAA0B;QACzM,OAAO,KAAK,CAAC;IACf,CAAC;IAED,8BAA8B;IACvB,eAAe,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAEnD;;;;;;;;OAQG;IACI,eAAe,CACpB,eAA4B,EAAE,SAAqB,EAAE,OAAmB,EAAE,SAAuB,EACjG,iBAAoC,EAAE,cAA4B;QAClE,OAAO,KAAK,CAAC;IACf,CAAC;IAED,8BAA8B;IACvB,eAAe,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAEnD;;;;;;;;;;;OAWG;IACI,QAAQ,CACb,QAAqB,EAAE,MAA2C,EAAE,aAA+C,EACnH,SAAqB,EAAE,OAAmB,EAAE,eAAmC,EAAE,SAAuB,EACxG,iBAAoC,EAAE,cAA4B;QAClE,OAAO,KAAK,CAAC;IACf,CAAC;IAED,sBAAsB;IACf,QAAQ,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAE5C;;;;;;;;OAQG;IACI,qBAAqB,CAC1B,aAA6B,EAAE,SAAqB,EAAE,OAAmB,EAAE,SAAuB,EAClG,iBAAoC,EAAE,cAA4B;QAClE,OAAO,KAAK,CAAC;IACf,CAAC;IAED,yCAAyC;IAClC,sBAAsB,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAE1D;;;OAGG;IACI,gBAAgB,CAAC,YAA0B,IAAa,OAAO,KAAK,CAAC,CAAC,CAAC;IAE9E,+BAA+B;IACxB,gBAAgB,KAAc,OAAO,KAAK,CAAC,CAAC,CAAC;IAEpD,sBAAsB;IACf,MAAM,CAAC,WAAW,CAAC,IAAwB;QAChD,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;IAID;;;;;;;OAOG;IACI,UAAU,CAAC,eAAyC,EAAE,MAAc,EAAE,QAAiB,EAAE,GAAW,EACzG,cAA4B;QAC5B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,yCAAyC;IAClC,WAAW,CAAC,SAAiB,IAAa,OAAO,KAAK,CAAC,CAAC,CAAC;;AAjBhE,sBAAsB;AACC,wBAAgB,GAAG,IAAI,cAAc,EAAE,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 UiAdmin\r\n */\r\n\r\nimport { BeUiEvent } from \"@itwin/core-bentley\";\r\nimport { AbstractMenuItemProps } from \"./items/AbstractMenuItemProps\";\r\nimport { AbstractToolbarProps } from \"./items/AbstractToolbarProps\";\r\nimport { RelativePosition } from \"./items/RelativePosition\";\r\nimport { PropertyDescription } from \"./properties/Description\";\r\nimport { Primitives } from \"./properties/PrimitiveTypes\";\r\nimport { OnCancelFunc, OnItemExecutedFunc, OnNumberCommitFunc, OnValueCommitFunc } from \"./utils/callbacks\";\r\nimport { PropertyRecord } from \"./properties/Record\";\r\nimport { UiDataProvider } from \"./dialogs/UiDataProvider\";\r\nimport { DialogLayoutDataProvider } from \"./dialogs/UiLayoutDataProvider\";\r\nimport { PointProps } from \"./utils/PointProps\";\r\nimport { loggerCategory } from \"./utils/misc\";\r\nimport { MessagePresenter } from \"./notification/MessagePresenter\";\r\nimport { UiError } from \"./utils/UiError\";\r\n\r\n/** The Generic UI Event args contains information useful for any UI message\r\n * @public\r\n */\r\nexport interface GenericUiEventArgs {\r\n uiComponentId: string;\r\n}\r\n\r\n/** Optional props to pass to the Dialog control that is generated.\r\n * @public\r\n */\r\nexport interface DialogProps {\r\n /** Indicates whether the user can resize dialog with cursor. */\r\n resizable?: boolean;\r\n /** Indicates whether the user can move dialog with cursor.*/\r\n movable?: boolean;\r\n /** Initial width of dialog. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */\r\n width?: string | number;\r\n /** Initial height of dialog. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */\r\n height?: string | number;\r\n /** Minimum width that the dialog may be resized to. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */\r\n minWidth?: string | number;\r\n /** Minimum height that the dialog may be resized to. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */\r\n minHeight?: string | number;\r\n /** Maximum width that the dialog may be resized to. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */\r\n maxWidth?: string | number;\r\n /** Maximum height that the dialog may be resized to. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */\r\n maxHeight?: string | number;\r\n}\r\n\r\n/** The GenericUiEvent is the base event class for UI events that target a specific component, as identified in uiComponentId.\r\n * @public\r\n */\r\nexport class GenericUiEvent extends BeUiEvent<GenericUiEventArgs> { }\r\n\r\n/** Flags that control enabling/disabling certain UI features\r\n * @public\r\n */\r\nexport interface UiFlags {\r\n /** if true then Ctrl+F2 will show popup key-in palette */\r\n allowKeyinPalette?: boolean;\r\n}\r\n\r\n/** The UiAdmin controls various UI components and is callable from IModelApp.uiAdmin in the core-frontend package.\r\n * @public\r\n */\r\nexport class UiAdmin {\r\n private _featureFlags: UiFlags = {};\r\n private static _messagePresenter?: MessagePresenter;\r\n\r\n /** The MessagePresenter used to display messages. */\r\n public static get messagePresenter(): MessagePresenter {\r\n if (!UiAdmin._messagePresenter)\r\n throw new UiError(loggerCategory(this), \"UiAdmin.messagePresenter not set\");\r\n return UiAdmin._messagePresenter;\r\n }\r\n public static set messagePresenter(mp: MessagePresenter) {\r\n UiAdmin._messagePresenter = mp;\r\n }\r\n\r\n public get featureFlags(): UiFlags {\r\n return { ...this._featureFlags }; // return copy so no direct access to modify value\r\n }\r\n\r\n public updateFeatureFlags(uiFlags: UiFlags) {\r\n this._featureFlags = { ...this._featureFlags, ...uiFlags };\r\n }\r\n\r\n /** @internal */\r\n public onInitialized() { }\r\n\r\n /** Get the cursor X and Y position. */\r\n public get cursorPosition(): PointProps { return { x: 0, y: 0 }; }\r\n\r\n /** Create a PointProps object. */\r\n public createXAndY(x: number, y: number): PointProps { return { x, y }; }\r\n\r\n /** Determines if focus is set to Home */\r\n public get isFocusOnHome(): boolean { return false; }\r\n\r\n /** Sets focus to Home */\r\n public setFocusToHome(): void { }\r\n\r\n /** Show a context menu at a particular location.\r\n * @param _menuItemsProps Properties of the menu items to display.\r\n * @param _location Location of the context menu, relative to the origin of htmlElement or the window.\r\n * @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\r\n * @return true if the menu was displayed, false if the menu could not be displayed.\r\n */\r\n public showContextMenu(_menuItemsProps: AbstractMenuItemProps[], _location: PointProps, _htmlElement?: HTMLElement): boolean {\r\n return false;\r\n }\r\n\r\n /** Show a Toolbar at a particular location.\r\n * @param _toolbarProps Properties of the Toolbar to display.\r\n * @param _location Location of the Toolbar, relative to the origin of htmlElement or the window.\r\n * @param _offset Offset of the Toolbar from the location.\r\n * @param _onItemExecuted Function invoked after a Toolbar item is executed\r\n * @param _onCancel Function invoked when the Escape key is pressed or a click occurs outside the Toolbar\r\n * @param _relativePosition Position relative to the given location. Defaults to TopRight.\r\n * @param _htmlElement The HTMLElement that anchors the Toolbar. If undefined, the location is relative to the overall window.\r\n * @return true if the Toolbar was displayed, false if the Toolbar could not be displayed.\r\n */\r\n public showToolbar(\r\n _toolbarProps: AbstractToolbarProps, _location: PointProps, _offset: PointProps, _onItemExecuted: OnItemExecutedFunc, _onCancel: OnCancelFunc,\r\n _relativePosition?: RelativePosition, _htmlElement?: HTMLElement): boolean {\r\n return false;\r\n }\r\n\r\n /** Hides the toolbar. */\r\n public hideToolbar(): boolean { return false; }\r\n\r\n /** Show a menu button at a particular location. A menu button opens a context menu.\r\n * @param _id Id of the menu button. Multiple menu buttons may be displayed.\r\n * @param _menuItemsProps Properties of the menu items to display.\r\n * @param _location Location of the context menu, relative to the origin of htmlElement or the window.\r\n * @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\r\n * @return true if the button was displayed, false if the button could not be displayed.\r\n */\r\n public showMenuButton(_id: string, _menuItemsProps: AbstractMenuItemProps[], _location: PointProps, _htmlElement?: HTMLElement): boolean {\r\n return false;\r\n }\r\n\r\n /** Hides a menu button.\r\n * @param _id Id of the menu button. Multiple menu buttons may be displayed.\r\n * @return true if the menu was hidden, false if the menu could not be hidden.\r\n */\r\n public hideMenuButton(_id: string): boolean { return false; }\r\n\r\n /** Show a calculator at a particular location.\r\n * @param _initialValue Value initially displayed in the calculator.\r\n * @param _resultIcon Icon displayed to the left of the value.\r\n * @param _location Location of the calculator, relative to the origin of htmlElement or the window.\r\n * @param _onCommit Function called when the OK button or the Enter key is pressed.\r\n * @param _onCancel Function called when the Cancel button or the Escape key is pressed.\r\n * @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\r\n * @return true if the calculator was displayed, false if the calculator could not be displayed.\r\n */\r\n public showCalculator(_initialValue: number, _resultIcon: string, _location: PointProps, _onCommit: OnNumberCommitFunc, _onCancel: OnCancelFunc, _htmlElement?: HTMLElement): boolean {\r\n return false;\r\n }\r\n\r\n /** Hides the calculator. */\r\n public hideCalculator(): boolean { return false; }\r\n\r\n /** Show an input editor for an angle value at a particular location.\r\n * @param _initialValue Value initially displayed in the editor.\r\n * @param _location Location of the editor, relative to the origin of htmlElement or the window.\r\n * @param _onCommit Function called when the OK button or the Enter key is pressed.\r\n * @param _onCancel Function called when the Cancel button or the Escape key is pressed.\r\n * @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\r\n * @return true if the editor was displayed, false if the editor could not be displayed.\r\n */\r\n public showAngleEditor(_initialValue: number, _location: PointProps, _onCommit: OnNumberCommitFunc, _onCancel: OnCancelFunc, _htmlElement?: HTMLElement): boolean {\r\n return false;\r\n }\r\n\r\n /** Show an input editor for a length value at a particular location.\r\n * @param _initialValue Value initially displayed in the editor.\r\n * @param _location Location of the editor, relative to the origin of htmlElement or the window.\r\n * @param _onCommit Function called when the OK button or the Enter key is pressed.\r\n * @param _onCancel Function called when the Cancel button or the Escape key is pressed.\r\n * @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\r\n * @return true if the editor was displayed, false if the editor could not be displayed.\r\n */\r\n public showLengthEditor(_initialValue: number, _location: PointProps, _onCommit: OnNumberCommitFunc, _onCancel: OnCancelFunc, _htmlElement?: HTMLElement): boolean {\r\n return false;\r\n }\r\n\r\n /** Show an input editor for a height value at a particular location.\r\n * @param _initialValue Value initially displayed in the editor.\r\n * @param _location Location of the editor, relative to the origin of htmlElement or the window.\r\n * @param _onCommit Function called when the OK button or the Enter key is pressed.\r\n * @param _onCancel Function called when the Cancel button or the Escape key is pressed.\r\n * @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\r\n * @return true if the editor was displayed, false if the editor could not be displayed.\r\n */\r\n public showHeightEditor(_initialValue: number, _location: PointProps, _onCommit: OnNumberCommitFunc, _onCancel: OnCancelFunc, _htmlElement?: HTMLElement): boolean {\r\n return false;\r\n }\r\n\r\n /** Show an input editor for a primitive value at a particular location.\r\n * @param _initialValue Value initially displayed in the editor.\r\n * @param _propertyDescription Description of the primitive value property.\r\n * @param _location Location of the editor, relative to the origin of htmlElement or the window.\r\n * @param _onCommit Function called when the OK button or the Enter key is pressed.\r\n * @param _onCancel Function called when the Cancel button or the Escape key is pressed.\r\n * @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.\r\n * @return true if the editor was displayed, false if the editor could not be displayed.\r\n */\r\n public showInputEditor(_initialValue: Primitives.Value, _propertyDescription: PropertyDescription, _location: PointProps, _onCommit: OnValueCommitFunc, _onCancel: OnCancelFunc, _htmlElement?: HTMLElement): boolean {\r\n return false;\r\n }\r\n\r\n /** Hides the input editor. */\r\n public hideInputEditor(): boolean { return false; }\r\n\r\n /** Show an HTML element at a particular location.\r\n * @param _displayElement The HTMLElement to display\r\n * @param _location Location of the tool settings, relative to the origin of anchorElement or the window\r\n * @param _offset Offset of the display element from the location\r\n * @param _onCancel Function invoked when the Escape key is pressed or a click occurs outside the display element\r\n * @param _relativePosition Position relative to the given location. Defaults to TopRight.\r\n * @param _anchorElement The HTMLElement that anchors the display element. If undefined, the location is relative to the overall window.\r\n * @return true if the display element was displayed, false if the display element could not be displayed.\r\n */\r\n public showHTMLElement(\r\n _displayElement: HTMLElement, _location: PointProps, _offset: PointProps, _onCancel: OnCancelFunc,\r\n _relativePosition?: RelativePosition, _anchorElement?: HTMLElement): boolean {\r\n return false;\r\n }\r\n\r\n /** Hides the HTML Element. */\r\n public hideHTMLElement(): boolean { return false; }\r\n\r\n /** Show a Card containing content, a title and a toolbar at a particular location.\r\n * @param _content The HTMLElement of the content to display\r\n * @param _title Title to display at the top of the card.\r\n * @param _toolbarProps Properties of the Toolbar to display.\r\n * @param _location Location of the Card, relative to the origin of anchorElement or the window.\r\n * @param _offset Offset of the Card from the location.\r\n * @param _onItemExecuted Function invoked after a Toolbar item is executed\r\n * @param _onCancel Function invoked when the Escape key is pressed or a click occurs outside the Card\r\n * @param _relativePosition Position relative to the given location. Defaults to TopRight.\r\n * @param _anchorElement The HTMLElement that anchors the Card. If undefined, the location is relative to the overall window.\r\n * @return true if the Card was displayed, false if the Card could not be displayed.\r\n */\r\n public showCard(\r\n _content: HTMLElement, _title: string | PropertyRecord | undefined, _toolbarProps: AbstractToolbarProps | undefined,\r\n _location: PointProps, _offset: PointProps, _onItemExecuted: OnItemExecutedFunc, _onCancel: OnCancelFunc,\r\n _relativePosition?: RelativePosition, _anchorElement?: HTMLElement): boolean {\r\n return false;\r\n }\r\n\r\n /** Hides the Card. */\r\n public hideCard(): boolean { return false; }\r\n\r\n /** Opens a Tool Settings Ui popup at a particular location.\r\n * @param _dataProvider The UiDataProvider for the tool settings\r\n * @param _location Location of the tool settings, relative to the origin of anchorElement or the window\r\n * @param _offset Offset of the tool settings from the location\r\n * @param _onCancel Function invoked when the Escape key is pressed or a click occurs outside the tool settings\r\n * @param _relativePosition Position relative to the given location. Defaults to TopRight.\r\n * @param _anchorElement The HTMLElement that anchors the tool settings. If undefined, the location is relative to the overall window.\r\n * @return true if the tool settings were displayed, false if the tool settings could not be displayed.\r\n */\r\n public openToolSettingsPopup(\r\n _dataProvider: UiDataProvider, _location: PointProps, _offset: PointProps, _onCancel: OnCancelFunc,\r\n _relativePosition?: RelativePosition, _anchorElement?: HTMLElement): boolean {\r\n return false;\r\n }\r\n\r\n /** Closes the Tool Settings Ui popup. */\r\n public closeToolSettingsPopup(): boolean { return false; }\r\n\r\n /** Show the Keyin Palette to display all support Tool key-ins.\r\n * @param _htmlElement The HTMLElement that anchors the Keyin Palette. If undefined, the location is relative to the overall window.\r\n * @return true if the Keyin Palette was displayed, false if it could not be displayed.\r\n */\r\n public showKeyinPalette(_htmlElement?: HTMLElement): boolean { return false; }\r\n\r\n /** Hides the Keyin Palette. */\r\n public hideKeyinPalette(): boolean { return false; }\r\n\r\n /** Send a UI event */\r\n public static sendUiEvent(args: GenericUiEventArgs) {\r\n UiAdmin.onGenericUiEvent.emit(args);\r\n }\r\n /** GenericUiEvent */\r\n public static readonly onGenericUiEvent = new GenericUiEvent();\r\n\r\n /** Opens a Dialog and automatically populates it using the properties defined by the UiDataProvider.\r\n * @param _uiDataProvider The DialogLayoutDataProvider for the dialog\r\n * @param _title Specify title for dialog.\r\n * @param _isModal Specify if the dialog is opened as a modal or modeless.\r\n * @param _id Id of the dialog that is used to close it.\r\n * @param _optionalProps Optional props for Dialog construction.\r\n * @return true if the tool settings were displayed, false if the tool settings could not be displayed.\r\n */\r\n public openDialog(_uiDataProvider: DialogLayoutDataProvider, _title: string, _isModal: boolean, _id: string,\r\n _optionalProps?: DialogProps): boolean {\r\n return false;\r\n }\r\n\r\n /** Closes the Dialog with a given Id. */\r\n public closeDialog(_dialogId: string): boolean { return false; }\r\n}\r\n"]}
|