@itwin/appui-abstract 4.0.0-dev.52 → 4.0.0-dev.55
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.d.ts.map +1 -1
- package/lib/cjs/appui-abstract/BaseUiItemsProvider.js +79 -79
- 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.d.ts.map +1 -1
- 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/backstage/BackstageItem.d.ts +91 -91
- package/lib/cjs/appui-abstract/backstage/BackstageItem.d.ts.map +1 -1
- 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/content/ContentLayoutProps.d.ts +62 -62
- package/lib/cjs/appui-abstract/content/ContentLayoutProps.js +9 -9
- 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/UiDataProvider.d.ts +55 -55
- package/lib/cjs/appui-abstract/dialogs/UiDataProvider.js +66 -66
- 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.d.ts.map +1 -1
- package/lib/cjs/appui-abstract/items/AbstractItemProps.js +9 -9
- 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/AbstractToolbarProps.d.ts +13 -13
- package/lib/cjs/appui-abstract/items/AbstractToolbarProps.js +9 -9
- 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/ConditionalBooleanValue.d.ts +27 -27
- package/lib/cjs/appui-abstract/items/ConditionalBooleanValue.js +60 -60
- 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/ProvidedItem.d.ts +11 -11
- package/lib/cjs/appui-abstract/items/ProvidedItem.js +9 -9
- 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/StageUsage.d.ts +16 -16
- package/lib/cjs/appui-abstract/items/StageUsage.js +24 -24
- 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/MessageSeverity.d.ts +15 -15
- package/lib/cjs/appui-abstract/notification/MessageSeverity.js +23 -23
- 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/EditorParams.d.ts +260 -260
- package/lib/cjs/appui-abstract/properties/EditorParams.d.ts.map +1 -1
- package/lib/cjs/appui-abstract/properties/EditorParams.js +106 -106
- 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/Record.d.ts +57 -57
- package/lib/cjs/appui-abstract/properties/Record.js +78 -78
- 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/StandardTypeNames.d.ts +30 -30
- package/lib/cjs/appui-abstract/properties/StandardTypeNames.js +39 -39
- package/lib/cjs/appui-abstract/properties/Value.d.ts +49 -49
- package/lib/cjs/appui-abstract/properties/Value.d.ts.map +1 -1
- package/lib/cjs/appui-abstract/properties/Value.js +20 -20
- 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/statusbar/StatusBarItem.d.ts +128 -128
- package/lib/cjs/appui-abstract/statusbar/StatusBarItem.d.ts.map +1 -1
- 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.d.ts.map +1 -1
- 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/UiError.d.ts +12 -12
- package/lib/cjs/appui-abstract/utils/UiError.js +22 -22
- 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/UiEventDispatcher.d.ts +46 -46
- package/lib/cjs/appui-abstract/utils/UiEventDispatcher.js +131 -131
- package/lib/cjs/appui-abstract/utils/callbacks.d.ts +20 -20
- package/lib/cjs/appui-abstract/utils/callbacks.d.ts.map +1 -1
- package/lib/cjs/appui-abstract/utils/callbacks.js +9 -9
- 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/filters.d.ts +98 -98
- package/lib/cjs/appui-abstract/utils/filter/filters.d.ts.map +1 -1
- 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/misc.d.ts +11 -11
- package/lib/cjs/appui-abstract/utils/misc.js +36 -36
- 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/StagePanel.d.ts +36 -36
- package/lib/cjs/appui-abstract/widget/StagePanel.js +46 -46
- 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.d.ts +103 -103
- package/lib/cjs/appui-abstract.js +123 -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.d.ts.map +1 -1
- package/lib/esm/appui-abstract/BaseUiItemsProvider.js +75 -75
- package/lib/esm/appui-abstract/UiAdmin.d.ts +221 -221
- package/lib/esm/appui-abstract/UiAdmin.js +220 -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.d.ts.map +1 -1
- package/lib/esm/appui-abstract/UiItemsManager.js +190 -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/backstage/BackstageItem.d.ts +91 -91
- package/lib/esm/appui-abstract/backstage/BackstageItem.d.ts.map +1 -1
- package/lib/esm/appui-abstract/backstage/BackstageItem.js +65 -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/content/ContentLayoutProps.d.ts +62 -62
- package/lib/esm/appui-abstract/content/ContentLayoutProps.js +8 -8
- package/lib/esm/appui-abstract/content/StandardContentLayouts.d.ts +19 -19
- package/lib/esm/appui-abstract/content/StandardContentLayouts.js +105 -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/UiDataProvider.d.ts +55 -55
- package/lib/esm/appui-abstract/dialogs/UiDataProvider.js +61 -61
- package/lib/esm/appui-abstract/dialogs/UiLayoutDataProvider.d.ts +97 -97
- package/lib/esm/appui-abstract/dialogs/UiLayoutDataProvider.js +171 -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.d.ts.map +1 -1
- package/lib/esm/appui-abstract/items/AbstractItemProps.js +8 -8
- 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/AbstractToolbarProps.d.ts +13 -13
- package/lib/esm/appui-abstract/items/AbstractToolbarProps.js +8 -8
- 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/ConditionalBooleanValue.d.ts +27 -27
- package/lib/esm/appui-abstract/items/ConditionalBooleanValue.js +56 -56
- 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/ProvidedItem.d.ts +11 -11
- package/lib/esm/appui-abstract/items/ProvidedItem.js +8 -8
- 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/StageUsage.d.ts +16 -16
- package/lib/esm/appui-abstract/items/StageUsage.js +21 -21
- 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/MessageSeverity.d.ts +15 -15
- package/lib/esm/appui-abstract/notification/MessageSeverity.js +20 -20
- 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/EditorParams.d.ts +260 -260
- package/lib/esm/appui-abstract/properties/EditorParams.d.ts.map +1 -1
- package/lib/esm/appui-abstract/properties/EditorParams.js +97 -97
- 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/Record.d.ts +57 -57
- package/lib/esm/appui-abstract/properties/Record.js +74 -74
- 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/StandardTypeNames.d.ts +30 -30
- package/lib/esm/appui-abstract/properties/StandardTypeNames.js +36 -36
- package/lib/esm/appui-abstract/properties/Value.d.ts +49 -49
- package/lib/esm/appui-abstract/properties/Value.d.ts.map +1 -1
- package/lib/esm/appui-abstract/properties/Value.js +17 -17
- 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/statusbar/StatusBarItem.d.ts +128 -128
- package/lib/esm/appui-abstract/statusbar/StatusBarItem.d.ts.map +1 -1
- package/lib/esm/appui-abstract/statusbar/StatusBarItem.js +81 -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.d.ts.map +1 -1
- package/lib/esm/appui-abstract/toolbars/ToolbarItem.js +61 -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 +48 -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/UiError.d.ts +12 -12
- package/lib/esm/appui-abstract/utils/UiError.js +18 -18
- 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/UiEventDispatcher.d.ts +46 -46
- package/lib/esm/appui-abstract/utils/UiEventDispatcher.js +126 -126
- package/lib/esm/appui-abstract/utils/callbacks.d.ts +20 -20
- package/lib/esm/appui-abstract/utils/callbacks.d.ts.map +1 -1
- package/lib/esm/appui-abstract/utils/callbacks.js +8 -8
- 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/filters.d.ts +98 -98
- package/lib/esm/appui-abstract/utils/filter/filters.d.ts.map +1 -1
- 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/misc.d.ts +11 -11
- package/lib/esm/appui-abstract/utils/misc.js +31 -31
- 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/StagePanel.d.ts +36 -36
- package/lib/esm/appui-abstract/widget/StagePanel.js +43 -43
- 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.d.ts +103 -103
- package/lib/esm/appui-abstract.js +107 -107
- package/package.json +6 -6
@@ -1,222 +1,222 @@
|
|
1
|
-
/** @packageDocumentation
|
2
|
-
* @module UiAdmin
|
3
|
-
*/
|
4
|
-
import { BeUiEvent } from "@itwin/core-bentley";
|
5
|
-
import { AbstractMenuItemProps } from "./items/AbstractMenuItemProps";
|
6
|
-
import { AbstractToolbarProps } from "./items/AbstractToolbarProps";
|
7
|
-
import { RelativePosition } from "./items/RelativePosition";
|
8
|
-
import { PropertyDescription } from "./properties/Description";
|
9
|
-
import { Primitives } from "./properties/PrimitiveTypes";
|
10
|
-
import { OnCancelFunc, OnItemExecutedFunc, OnNumberCommitFunc, OnValueCommitFunc } from "./utils/callbacks";
|
11
|
-
import { PropertyRecord } from "./properties/Record";
|
12
|
-
import { UiDataProvider } from "./dialogs/UiDataProvider";
|
13
|
-
import { DialogLayoutDataProvider } from "./dialogs/UiLayoutDataProvider";
|
14
|
-
import { PointProps } from "./utils/PointProps";
|
15
|
-
import { MessagePresenter } from "./notification/MessagePresenter";
|
16
|
-
/** The Generic UI Event args contains information useful for any UI message
|
17
|
-
* @public
|
18
|
-
*/
|
19
|
-
export interface GenericUiEventArgs {
|
20
|
-
uiComponentId: string;
|
21
|
-
}
|
22
|
-
/** Optional props to pass to the Dialog control that is generated.
|
23
|
-
* @public
|
24
|
-
*/
|
25
|
-
export interface DialogProps {
|
26
|
-
/** Indicates whether the user can resize dialog with cursor. */
|
27
|
-
resizable?: boolean;
|
28
|
-
/** Indicates whether the user can move dialog with cursor.*/
|
29
|
-
movable?: boolean;
|
30
|
-
/** Initial width of dialog. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */
|
31
|
-
width?: string | number;
|
32
|
-
/** Initial height of dialog. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */
|
33
|
-
height?: string | number;
|
34
|
-
/** Minimum width that the dialog may be resized to. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */
|
35
|
-
minWidth?: string | number;
|
36
|
-
/** Minimum height that the dialog may be resized to. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */
|
37
|
-
minHeight?: string | number;
|
38
|
-
/** Maximum width that the dialog may be resized to. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */
|
39
|
-
maxWidth?: string | number;
|
40
|
-
/** Maximum height that the dialog may be resized to. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */
|
41
|
-
maxHeight?: string | number;
|
42
|
-
}
|
43
|
-
/** The GenericUiEvent is the base event class for UI events that target a specific component, as identified in uiComponentId.
|
44
|
-
* @public
|
45
|
-
*/
|
46
|
-
export declare class GenericUiEvent extends BeUiEvent<GenericUiEventArgs> {
|
47
|
-
}
|
48
|
-
/** Flags that control enabling/disabling certain UI features
|
49
|
-
* @public
|
50
|
-
*/
|
51
|
-
export interface UiFlags {
|
52
|
-
/** if true then Ctrl+F2 will show popup key-in palette */
|
53
|
-
allowKeyinPalette?: boolean;
|
54
|
-
}
|
55
|
-
/** The UiAdmin controls various UI components and is callable from IModelApp.uiAdmin in the core-frontend package.
|
56
|
-
* @public
|
57
|
-
*/
|
58
|
-
export declare class UiAdmin {
|
59
|
-
private _featureFlags;
|
60
|
-
private static _messagePresenter?;
|
61
|
-
/** The MessagePresenter used to display messages. */
|
62
|
-
static get messagePresenter(): MessagePresenter;
|
63
|
-
static set messagePresenter(mp: MessagePresenter);
|
64
|
-
get featureFlags(): UiFlags;
|
65
|
-
updateFeatureFlags(uiFlags: UiFlags): void;
|
66
|
-
/** @internal */
|
67
|
-
onInitialized(): void;
|
68
|
-
/** Get the cursor X and Y position. */
|
69
|
-
get cursorPosition(): PointProps;
|
70
|
-
/** Create a PointProps object. */
|
71
|
-
createXAndY(x: number, y: number): PointProps;
|
72
|
-
/** Determines if focus is set to Home */
|
73
|
-
get isFocusOnHome(): boolean;
|
74
|
-
/** Sets focus to Home */
|
75
|
-
setFocusToHome(): void;
|
76
|
-
/** Show a context menu at a particular location.
|
77
|
-
* @param _menuItemsProps Properties of the menu items to display.
|
78
|
-
* @param _location Location of the context menu, relative to the origin of htmlElement or the window.
|
79
|
-
* @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
|
80
|
-
* @return true if the menu was displayed, false if the menu could not be displayed.
|
81
|
-
*/
|
82
|
-
showContextMenu(_menuItemsProps: AbstractMenuItemProps[], _location: PointProps, _htmlElement?: HTMLElement): boolean;
|
83
|
-
/** Show a Toolbar at a particular location.
|
84
|
-
* @param _toolbarProps Properties of the Toolbar to display.
|
85
|
-
* @param _location Location of the Toolbar, relative to the origin of htmlElement or the window.
|
86
|
-
* @param _offset Offset of the Toolbar from the location.
|
87
|
-
* @param _onItemExecuted Function invoked after a Toolbar item is executed
|
88
|
-
* @param _onCancel Function invoked when the Escape key is pressed or a click occurs outside the Toolbar
|
89
|
-
* @param _relativePosition Position relative to the given location. Defaults to TopRight.
|
90
|
-
* @param _htmlElement The HTMLElement that anchors the Toolbar. If undefined, the location is relative to the overall window.
|
91
|
-
* @return true if the Toolbar was displayed, false if the Toolbar could not be displayed.
|
92
|
-
*/
|
93
|
-
showToolbar(_toolbarProps: AbstractToolbarProps, _location: PointProps, _offset: PointProps, _onItemExecuted: OnItemExecutedFunc, _onCancel: OnCancelFunc, _relativePosition?: RelativePosition, _htmlElement?: HTMLElement): boolean;
|
94
|
-
/** Hides the toolbar. */
|
95
|
-
hideToolbar(): boolean;
|
96
|
-
/** Show a menu button at a particular location. A menu button opens a context menu.
|
97
|
-
* @param _id Id of the menu button. Multiple menu buttons may be displayed.
|
98
|
-
* @param _menuItemsProps Properties of the menu items to display.
|
99
|
-
* @param _location Location of the context menu, relative to the origin of htmlElement or the window.
|
100
|
-
* @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
|
101
|
-
* @return true if the button was displayed, false if the button could not be displayed.
|
102
|
-
*/
|
103
|
-
showMenuButton(_id: string, _menuItemsProps: AbstractMenuItemProps[], _location: PointProps, _htmlElement?: HTMLElement): boolean;
|
104
|
-
/** Hides a menu button.
|
105
|
-
* @param _id Id of the menu button. Multiple menu buttons may be displayed.
|
106
|
-
* @return true if the menu was hidden, false if the menu could not be hidden.
|
107
|
-
*/
|
108
|
-
hideMenuButton(_id: string): boolean;
|
109
|
-
/** Show a calculator at a particular location.
|
110
|
-
* @param _initialValue Value initially displayed in the calculator.
|
111
|
-
* @param _resultIcon Icon displayed to the left of the value.
|
112
|
-
* @param _location Location of the calculator, relative to the origin of htmlElement or the window.
|
113
|
-
* @param _onCommit Function called when the OK button or the Enter key is pressed.
|
114
|
-
* @param _onCancel Function called when the Cancel button or the Escape key is pressed.
|
115
|
-
* @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
|
116
|
-
* @return true if the calculator was displayed, false if the calculator could not be displayed.
|
117
|
-
*/
|
118
|
-
showCalculator(_initialValue: number, _resultIcon: string, _location: PointProps, _onCommit: OnNumberCommitFunc, _onCancel: OnCancelFunc, _htmlElement?: HTMLElement): boolean;
|
119
|
-
/** Hides the calculator. */
|
120
|
-
hideCalculator(): boolean;
|
121
|
-
/** Show an input editor for an angle value at a particular location.
|
122
|
-
* @param _initialValue Value initially displayed in the editor.
|
123
|
-
* @param _location Location of the editor, relative to the origin of htmlElement or the window.
|
124
|
-
* @param _onCommit Function called when the OK button or the Enter key is pressed.
|
125
|
-
* @param _onCancel Function called when the Cancel button or the Escape key is pressed.
|
126
|
-
* @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
|
127
|
-
* @return true if the editor was displayed, false if the editor could not be displayed.
|
128
|
-
*/
|
129
|
-
showAngleEditor(_initialValue: number, _location: PointProps, _onCommit: OnNumberCommitFunc, _onCancel: OnCancelFunc, _htmlElement?: HTMLElement): boolean;
|
130
|
-
/** Show an input editor for a length value at a particular location.
|
131
|
-
* @param _initialValue Value initially displayed in the editor.
|
132
|
-
* @param _location Location of the editor, relative to the origin of htmlElement or the window.
|
133
|
-
* @param _onCommit Function called when the OK button or the Enter key is pressed.
|
134
|
-
* @param _onCancel Function called when the Cancel button or the Escape key is pressed.
|
135
|
-
* @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
|
136
|
-
* @return true if the editor was displayed, false if the editor could not be displayed.
|
137
|
-
*/
|
138
|
-
showLengthEditor(_initialValue: number, _location: PointProps, _onCommit: OnNumberCommitFunc, _onCancel: OnCancelFunc, _htmlElement?: HTMLElement): boolean;
|
139
|
-
/** Show an input editor for a height value at a particular location.
|
140
|
-
* @param _initialValue Value initially displayed in the editor.
|
141
|
-
* @param _location Location of the editor, relative to the origin of htmlElement or the window.
|
142
|
-
* @param _onCommit Function called when the OK button or the Enter key is pressed.
|
143
|
-
* @param _onCancel Function called when the Cancel button or the Escape key is pressed.
|
144
|
-
* @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
|
145
|
-
* @return true if the editor was displayed, false if the editor could not be displayed.
|
146
|
-
*/
|
147
|
-
showHeightEditor(_initialValue: number, _location: PointProps, _onCommit: OnNumberCommitFunc, _onCancel: OnCancelFunc, _htmlElement?: HTMLElement): boolean;
|
148
|
-
/** Show an input editor for a primitive value at a particular location.
|
149
|
-
* @param _initialValue Value initially displayed in the editor.
|
150
|
-
* @param _propertyDescription Description of the primitive value property.
|
151
|
-
* @param _location Location of the editor, relative to the origin of htmlElement or the window.
|
152
|
-
* @param _onCommit Function called when the OK button or the Enter key is pressed.
|
153
|
-
* @param _onCancel Function called when the Cancel button or the Escape key is pressed.
|
154
|
-
* @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
|
155
|
-
* @return true if the editor was displayed, false if the editor could not be displayed.
|
156
|
-
*/
|
157
|
-
showInputEditor(_initialValue: Primitives.Value, _propertyDescription: PropertyDescription, _location: PointProps, _onCommit: OnValueCommitFunc, _onCancel: OnCancelFunc, _htmlElement?: HTMLElement): boolean;
|
158
|
-
/** Hides the input editor. */
|
159
|
-
hideInputEditor(): boolean;
|
160
|
-
/** Show an HTML element at a particular location.
|
161
|
-
* @param _displayElement The HTMLElement to display
|
162
|
-
* @param _location Location of the tool settings, relative to the origin of anchorElement or the window
|
163
|
-
* @param _offset Offset of the display element from the location
|
164
|
-
* @param _onCancel Function invoked when the Escape key is pressed or a click occurs outside the display element
|
165
|
-
* @param _relativePosition Position relative to the given location. Defaults to TopRight.
|
166
|
-
* @param _anchorElement The HTMLElement that anchors the display element. If undefined, the location is relative to the overall window.
|
167
|
-
* @return true if the display element was displayed, false if the display element could not be displayed.
|
168
|
-
*/
|
169
|
-
showHTMLElement(_displayElement: HTMLElement, _location: PointProps, _offset: PointProps, _onCancel: OnCancelFunc, _relativePosition?: RelativePosition, _anchorElement?: HTMLElement): boolean;
|
170
|
-
/** Hides the HTML Element. */
|
171
|
-
hideHTMLElement(): boolean;
|
172
|
-
/** Show a Card containing content, a title and a toolbar at a particular location.
|
173
|
-
* @param _content The HTMLElement of the content to display
|
174
|
-
* @param _title Title to display at the top of the card.
|
175
|
-
* @param _toolbarProps Properties of the Toolbar to display.
|
176
|
-
* @param _location Location of the Card, relative to the origin of anchorElement or the window.
|
177
|
-
* @param _offset Offset of the Card from the location.
|
178
|
-
* @param _onItemExecuted Function invoked after a Toolbar item is executed
|
179
|
-
* @param _onCancel Function invoked when the Escape key is pressed or a click occurs outside the Card
|
180
|
-
* @param _relativePosition Position relative to the given location. Defaults to TopRight.
|
181
|
-
* @param _anchorElement The HTMLElement that anchors the Card. If undefined, the location is relative to the overall window.
|
182
|
-
* @return true if the Card was displayed, false if the Card could not be displayed.
|
183
|
-
*/
|
184
|
-
showCard(_content: HTMLElement, _title: string | PropertyRecord | undefined, _toolbarProps: AbstractToolbarProps | undefined, _location: PointProps, _offset: PointProps, _onItemExecuted: OnItemExecutedFunc, _onCancel: OnCancelFunc, _relativePosition?: RelativePosition, _anchorElement?: HTMLElement): boolean;
|
185
|
-
/** Hides the Card. */
|
186
|
-
hideCard(): boolean;
|
187
|
-
/** Opens a Tool Settings Ui popup at a particular location.
|
188
|
-
* @param _dataProvider The UiDataProvider for the tool settings
|
189
|
-
* @param _location Location of the tool settings, relative to the origin of anchorElement or the window
|
190
|
-
* @param _offset Offset of the tool settings from the location
|
191
|
-
* @param _onCancel Function invoked when the Escape key is pressed or a click occurs outside the tool settings
|
192
|
-
* @param _relativePosition Position relative to the given location. Defaults to TopRight.
|
193
|
-
* @param _anchorElement The HTMLElement that anchors the tool settings. If undefined, the location is relative to the overall window.
|
194
|
-
* @return true if the tool settings were displayed, false if the tool settings could not be displayed.
|
195
|
-
*/
|
196
|
-
openToolSettingsPopup(_dataProvider: UiDataProvider, _location: PointProps, _offset: PointProps, _onCancel: OnCancelFunc, _relativePosition?: RelativePosition, _anchorElement?: HTMLElement): boolean;
|
197
|
-
/** Closes the Tool Settings Ui popup. */
|
198
|
-
closeToolSettingsPopup(): boolean;
|
199
|
-
/** Show the Keyin Palette to display all support Tool key-ins.
|
200
|
-
* @param _htmlElement The HTMLElement that anchors the Keyin Palette. If undefined, the location is relative to the overall window.
|
201
|
-
* @return true if the Keyin Palette was displayed, false if it could not be displayed.
|
202
|
-
*/
|
203
|
-
showKeyinPalette(_htmlElement?: HTMLElement): boolean;
|
204
|
-
/** Hides the Keyin Palette. */
|
205
|
-
hideKeyinPalette(): boolean;
|
206
|
-
/** Send a UI event */
|
207
|
-
static sendUiEvent(args: GenericUiEventArgs): void;
|
208
|
-
/** GenericUiEvent */
|
209
|
-
static readonly onGenericUiEvent: GenericUiEvent;
|
210
|
-
/** Opens a Dialog and automatically populates it using the properties defined by the UiDataProvider.
|
211
|
-
* @param _uiDataProvider The DialogLayoutDataProvider for the dialog
|
212
|
-
* @param _title Specify title for dialog.
|
213
|
-
* @param _isModal Specify if the dialog is opened as a modal or modeless.
|
214
|
-
* @param _id Id of the dialog that is used to close it.
|
215
|
-
* @param _optionalProps Optional props for Dialog construction.
|
216
|
-
* @return true if the tool settings were displayed, false if the tool settings could not be displayed.
|
217
|
-
*/
|
218
|
-
openDialog(_uiDataProvider: DialogLayoutDataProvider, _title: string, _isModal: boolean, _id: string, _optionalProps?: DialogProps): boolean;
|
219
|
-
/** Closes the Dialog with a given Id. */
|
220
|
-
closeDialog(_dialogId: string): boolean;
|
221
|
-
}
|
1
|
+
/** @packageDocumentation
|
2
|
+
* @module UiAdmin
|
3
|
+
*/
|
4
|
+
import { BeUiEvent } from "@itwin/core-bentley";
|
5
|
+
import { AbstractMenuItemProps } from "./items/AbstractMenuItemProps";
|
6
|
+
import { AbstractToolbarProps } from "./items/AbstractToolbarProps";
|
7
|
+
import { RelativePosition } from "./items/RelativePosition";
|
8
|
+
import { PropertyDescription } from "./properties/Description";
|
9
|
+
import { Primitives } from "./properties/PrimitiveTypes";
|
10
|
+
import { OnCancelFunc, OnItemExecutedFunc, OnNumberCommitFunc, OnValueCommitFunc } from "./utils/callbacks";
|
11
|
+
import { PropertyRecord } from "./properties/Record";
|
12
|
+
import { UiDataProvider } from "./dialogs/UiDataProvider";
|
13
|
+
import { DialogLayoutDataProvider } from "./dialogs/UiLayoutDataProvider";
|
14
|
+
import { PointProps } from "./utils/PointProps";
|
15
|
+
import { MessagePresenter } from "./notification/MessagePresenter";
|
16
|
+
/** The Generic UI Event args contains information useful for any UI message
|
17
|
+
* @public
|
18
|
+
*/
|
19
|
+
export interface GenericUiEventArgs {
|
20
|
+
uiComponentId: string;
|
21
|
+
}
|
22
|
+
/** Optional props to pass to the Dialog control that is generated.
|
23
|
+
* @public
|
24
|
+
*/
|
25
|
+
export interface DialogProps {
|
26
|
+
/** Indicates whether the user can resize dialog with cursor. */
|
27
|
+
resizable?: boolean;
|
28
|
+
/** Indicates whether the user can move dialog with cursor.*/
|
29
|
+
movable?: boolean;
|
30
|
+
/** Initial width of dialog. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */
|
31
|
+
width?: string | number;
|
32
|
+
/** Initial height of dialog. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */
|
33
|
+
height?: string | number;
|
34
|
+
/** Minimum width that the dialog may be resized to. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */
|
35
|
+
minWidth?: string | number;
|
36
|
+
/** Minimum height that the dialog may be resized to. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */
|
37
|
+
minHeight?: string | number;
|
38
|
+
/** Maximum width that the dialog may be resized to. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */
|
39
|
+
maxWidth?: string | number;
|
40
|
+
/** Maximum height that the dialog may be resized to. Displayed in px if value is a number; otherwise, displayed in specified CSS unit. */
|
41
|
+
maxHeight?: string | number;
|
42
|
+
}
|
43
|
+
/** The GenericUiEvent is the base event class for UI events that target a specific component, as identified in uiComponentId.
|
44
|
+
* @public
|
45
|
+
*/
|
46
|
+
export declare class GenericUiEvent extends BeUiEvent<GenericUiEventArgs> {
|
47
|
+
}
|
48
|
+
/** Flags that control enabling/disabling certain UI features
|
49
|
+
* @public
|
50
|
+
*/
|
51
|
+
export interface UiFlags {
|
52
|
+
/** if true then Ctrl+F2 will show popup key-in palette */
|
53
|
+
allowKeyinPalette?: boolean;
|
54
|
+
}
|
55
|
+
/** The UiAdmin controls various UI components and is callable from IModelApp.uiAdmin in the core-frontend package.
|
56
|
+
* @public
|
57
|
+
*/
|
58
|
+
export declare class UiAdmin {
|
59
|
+
private _featureFlags;
|
60
|
+
private static _messagePresenter?;
|
61
|
+
/** The MessagePresenter used to display messages. */
|
62
|
+
static get messagePresenter(): MessagePresenter;
|
63
|
+
static set messagePresenter(mp: MessagePresenter);
|
64
|
+
get featureFlags(): UiFlags;
|
65
|
+
updateFeatureFlags(uiFlags: UiFlags): void;
|
66
|
+
/** @internal */
|
67
|
+
onInitialized(): void;
|
68
|
+
/** Get the cursor X and Y position. */
|
69
|
+
get cursorPosition(): PointProps;
|
70
|
+
/** Create a PointProps object. */
|
71
|
+
createXAndY(x: number, y: number): PointProps;
|
72
|
+
/** Determines if focus is set to Home */
|
73
|
+
get isFocusOnHome(): boolean;
|
74
|
+
/** Sets focus to Home */
|
75
|
+
setFocusToHome(): void;
|
76
|
+
/** Show a context menu at a particular location.
|
77
|
+
* @param _menuItemsProps Properties of the menu items to display.
|
78
|
+
* @param _location Location of the context menu, relative to the origin of htmlElement or the window.
|
79
|
+
* @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
|
80
|
+
* @return true if the menu was displayed, false if the menu could not be displayed.
|
81
|
+
*/
|
82
|
+
showContextMenu(_menuItemsProps: AbstractMenuItemProps[], _location: PointProps, _htmlElement?: HTMLElement): boolean;
|
83
|
+
/** Show a Toolbar at a particular location.
|
84
|
+
* @param _toolbarProps Properties of the Toolbar to display.
|
85
|
+
* @param _location Location of the Toolbar, relative to the origin of htmlElement or the window.
|
86
|
+
* @param _offset Offset of the Toolbar from the location.
|
87
|
+
* @param _onItemExecuted Function invoked after a Toolbar item is executed
|
88
|
+
* @param _onCancel Function invoked when the Escape key is pressed or a click occurs outside the Toolbar
|
89
|
+
* @param _relativePosition Position relative to the given location. Defaults to TopRight.
|
90
|
+
* @param _htmlElement The HTMLElement that anchors the Toolbar. If undefined, the location is relative to the overall window.
|
91
|
+
* @return true if the Toolbar was displayed, false if the Toolbar could not be displayed.
|
92
|
+
*/
|
93
|
+
showToolbar(_toolbarProps: AbstractToolbarProps, _location: PointProps, _offset: PointProps, _onItemExecuted: OnItemExecutedFunc, _onCancel: OnCancelFunc, _relativePosition?: RelativePosition, _htmlElement?: HTMLElement): boolean;
|
94
|
+
/** Hides the toolbar. */
|
95
|
+
hideToolbar(): boolean;
|
96
|
+
/** Show a menu button at a particular location. A menu button opens a context menu.
|
97
|
+
* @param _id Id of the menu button. Multiple menu buttons may be displayed.
|
98
|
+
* @param _menuItemsProps Properties of the menu items to display.
|
99
|
+
* @param _location Location of the context menu, relative to the origin of htmlElement or the window.
|
100
|
+
* @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
|
101
|
+
* @return true if the button was displayed, false if the button could not be displayed.
|
102
|
+
*/
|
103
|
+
showMenuButton(_id: string, _menuItemsProps: AbstractMenuItemProps[], _location: PointProps, _htmlElement?: HTMLElement): boolean;
|
104
|
+
/** Hides a menu button.
|
105
|
+
* @param _id Id of the menu button. Multiple menu buttons may be displayed.
|
106
|
+
* @return true if the menu was hidden, false if the menu could not be hidden.
|
107
|
+
*/
|
108
|
+
hideMenuButton(_id: string): boolean;
|
109
|
+
/** Show a calculator at a particular location.
|
110
|
+
* @param _initialValue Value initially displayed in the calculator.
|
111
|
+
* @param _resultIcon Icon displayed to the left of the value.
|
112
|
+
* @param _location Location of the calculator, relative to the origin of htmlElement or the window.
|
113
|
+
* @param _onCommit Function called when the OK button or the Enter key is pressed.
|
114
|
+
* @param _onCancel Function called when the Cancel button or the Escape key is pressed.
|
115
|
+
* @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
|
116
|
+
* @return true if the calculator was displayed, false if the calculator could not be displayed.
|
117
|
+
*/
|
118
|
+
showCalculator(_initialValue: number, _resultIcon: string, _location: PointProps, _onCommit: OnNumberCommitFunc, _onCancel: OnCancelFunc, _htmlElement?: HTMLElement): boolean;
|
119
|
+
/** Hides the calculator. */
|
120
|
+
hideCalculator(): boolean;
|
121
|
+
/** Show an input editor for an angle value at a particular location.
|
122
|
+
* @param _initialValue Value initially displayed in the editor.
|
123
|
+
* @param _location Location of the editor, relative to the origin of htmlElement or the window.
|
124
|
+
* @param _onCommit Function called when the OK button or the Enter key is pressed.
|
125
|
+
* @param _onCancel Function called when the Cancel button or the Escape key is pressed.
|
126
|
+
* @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
|
127
|
+
* @return true if the editor was displayed, false if the editor could not be displayed.
|
128
|
+
*/
|
129
|
+
showAngleEditor(_initialValue: number, _location: PointProps, _onCommit: OnNumberCommitFunc, _onCancel: OnCancelFunc, _htmlElement?: HTMLElement): boolean;
|
130
|
+
/** Show an input editor for a length value at a particular location.
|
131
|
+
* @param _initialValue Value initially displayed in the editor.
|
132
|
+
* @param _location Location of the editor, relative to the origin of htmlElement or the window.
|
133
|
+
* @param _onCommit Function called when the OK button or the Enter key is pressed.
|
134
|
+
* @param _onCancel Function called when the Cancel button or the Escape key is pressed.
|
135
|
+
* @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
|
136
|
+
* @return true if the editor was displayed, false if the editor could not be displayed.
|
137
|
+
*/
|
138
|
+
showLengthEditor(_initialValue: number, _location: PointProps, _onCommit: OnNumberCommitFunc, _onCancel: OnCancelFunc, _htmlElement?: HTMLElement): boolean;
|
139
|
+
/** Show an input editor for a height value at a particular location.
|
140
|
+
* @param _initialValue Value initially displayed in the editor.
|
141
|
+
* @param _location Location of the editor, relative to the origin of htmlElement or the window.
|
142
|
+
* @param _onCommit Function called when the OK button or the Enter key is pressed.
|
143
|
+
* @param _onCancel Function called when the Cancel button or the Escape key is pressed.
|
144
|
+
* @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
|
145
|
+
* @return true if the editor was displayed, false if the editor could not be displayed.
|
146
|
+
*/
|
147
|
+
showHeightEditor(_initialValue: number, _location: PointProps, _onCommit: OnNumberCommitFunc, _onCancel: OnCancelFunc, _htmlElement?: HTMLElement): boolean;
|
148
|
+
/** Show an input editor for a primitive value at a particular location.
|
149
|
+
* @param _initialValue Value initially displayed in the editor.
|
150
|
+
* @param _propertyDescription Description of the primitive value property.
|
151
|
+
* @param _location Location of the editor, relative to the origin of htmlElement or the window.
|
152
|
+
* @param _onCommit Function called when the OK button or the Enter key is pressed.
|
153
|
+
* @param _onCancel Function called when the Cancel button or the Escape key is pressed.
|
154
|
+
* @param _htmlElement The HTMLElement that anchors the context menu. If undefined, the location is relative to the overall window.
|
155
|
+
* @return true if the editor was displayed, false if the editor could not be displayed.
|
156
|
+
*/
|
157
|
+
showInputEditor(_initialValue: Primitives.Value, _propertyDescription: PropertyDescription, _location: PointProps, _onCommit: OnValueCommitFunc, _onCancel: OnCancelFunc, _htmlElement?: HTMLElement): boolean;
|
158
|
+
/** Hides the input editor. */
|
159
|
+
hideInputEditor(): boolean;
|
160
|
+
/** Show an HTML element at a particular location.
|
161
|
+
* @param _displayElement The HTMLElement to display
|
162
|
+
* @param _location Location of the tool settings, relative to the origin of anchorElement or the window
|
163
|
+
* @param _offset Offset of the display element from the location
|
164
|
+
* @param _onCancel Function invoked when the Escape key is pressed or a click occurs outside the display element
|
165
|
+
* @param _relativePosition Position relative to the given location. Defaults to TopRight.
|
166
|
+
* @param _anchorElement The HTMLElement that anchors the display element. If undefined, the location is relative to the overall window.
|
167
|
+
* @return true if the display element was displayed, false if the display element could not be displayed.
|
168
|
+
*/
|
169
|
+
showHTMLElement(_displayElement: HTMLElement, _location: PointProps, _offset: PointProps, _onCancel: OnCancelFunc, _relativePosition?: RelativePosition, _anchorElement?: HTMLElement): boolean;
|
170
|
+
/** Hides the HTML Element. */
|
171
|
+
hideHTMLElement(): boolean;
|
172
|
+
/** Show a Card containing content, a title and a toolbar at a particular location.
|
173
|
+
* @param _content The HTMLElement of the content to display
|
174
|
+
* @param _title Title to display at the top of the card.
|
175
|
+
* @param _toolbarProps Properties of the Toolbar to display.
|
176
|
+
* @param _location Location of the Card, relative to the origin of anchorElement or the window.
|
177
|
+
* @param _offset Offset of the Card from the location.
|
178
|
+
* @param _onItemExecuted Function invoked after a Toolbar item is executed
|
179
|
+
* @param _onCancel Function invoked when the Escape key is pressed or a click occurs outside the Card
|
180
|
+
* @param _relativePosition Position relative to the given location. Defaults to TopRight.
|
181
|
+
* @param _anchorElement The HTMLElement that anchors the Card. If undefined, the location is relative to the overall window.
|
182
|
+
* @return true if the Card was displayed, false if the Card could not be displayed.
|
183
|
+
*/
|
184
|
+
showCard(_content: HTMLElement, _title: string | PropertyRecord | undefined, _toolbarProps: AbstractToolbarProps | undefined, _location: PointProps, _offset: PointProps, _onItemExecuted: OnItemExecutedFunc, _onCancel: OnCancelFunc, _relativePosition?: RelativePosition, _anchorElement?: HTMLElement): boolean;
|
185
|
+
/** Hides the Card. */
|
186
|
+
hideCard(): boolean;
|
187
|
+
/** Opens a Tool Settings Ui popup at a particular location.
|
188
|
+
* @param _dataProvider The UiDataProvider for the tool settings
|
189
|
+
* @param _location Location of the tool settings, relative to the origin of anchorElement or the window
|
190
|
+
* @param _offset Offset of the tool settings from the location
|
191
|
+
* @param _onCancel Function invoked when the Escape key is pressed or a click occurs outside the tool settings
|
192
|
+
* @param _relativePosition Position relative to the given location. Defaults to TopRight.
|
193
|
+
* @param _anchorElement The HTMLElement that anchors the tool settings. If undefined, the location is relative to the overall window.
|
194
|
+
* @return true if the tool settings were displayed, false if the tool settings could not be displayed.
|
195
|
+
*/
|
196
|
+
openToolSettingsPopup(_dataProvider: UiDataProvider, _location: PointProps, _offset: PointProps, _onCancel: OnCancelFunc, _relativePosition?: RelativePosition, _anchorElement?: HTMLElement): boolean;
|
197
|
+
/** Closes the Tool Settings Ui popup. */
|
198
|
+
closeToolSettingsPopup(): boolean;
|
199
|
+
/** Show the Keyin Palette to display all support Tool key-ins.
|
200
|
+
* @param _htmlElement The HTMLElement that anchors the Keyin Palette. If undefined, the location is relative to the overall window.
|
201
|
+
* @return true if the Keyin Palette was displayed, false if it could not be displayed.
|
202
|
+
*/
|
203
|
+
showKeyinPalette(_htmlElement?: HTMLElement): boolean;
|
204
|
+
/** Hides the Keyin Palette. */
|
205
|
+
hideKeyinPalette(): boolean;
|
206
|
+
/** Send a UI event */
|
207
|
+
static sendUiEvent(args: GenericUiEventArgs): void;
|
208
|
+
/** GenericUiEvent */
|
209
|
+
static readonly onGenericUiEvent: GenericUiEvent;
|
210
|
+
/** Opens a Dialog and automatically populates it using the properties defined by the UiDataProvider.
|
211
|
+
* @param _uiDataProvider The DialogLayoutDataProvider for the dialog
|
212
|
+
* @param _title Specify title for dialog.
|
213
|
+
* @param _isModal Specify if the dialog is opened as a modal or modeless.
|
214
|
+
* @param _id Id of the dialog that is used to close it.
|
215
|
+
* @param _optionalProps Optional props for Dialog construction.
|
216
|
+
* @return true if the tool settings were displayed, false if the tool settings could not be displayed.
|
217
|
+
*/
|
218
|
+
openDialog(_uiDataProvider: DialogLayoutDataProvider, _title: string, _isModal: boolean, _id: string, _optionalProps?: DialogProps): boolean;
|
219
|
+
/** Closes the Dialog with a given Id. */
|
220
|
+
closeDialog(_dialogId: string): boolean;
|
221
|
+
}
|
222
222
|
//# sourceMappingURL=UiAdmin.d.ts.map
|