@itwin/appui-abstract 5.0.0-dev.7 → 5.0.0-dev.72
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +31 -1
- package/lib/cjs/appui-abstract/UiAdmin.js +4 -5
- package/lib/cjs/appui-abstract/UiAdmin.js.map +1 -1
- package/lib/cjs/appui-abstract/content/StandardContentLayouts.js +91 -91
- package/lib/cjs/appui-abstract/content/StandardContentLayouts.js.map +1 -1
- package/lib/cjs/appui-abstract/dialogs/DialogItem.d.ts +1 -5
- package/lib/cjs/appui-abstract/dialogs/DialogItem.d.ts.map +1 -1
- package/lib/cjs/appui-abstract/dialogs/DialogItem.js +4 -0
- package/lib/cjs/appui-abstract/dialogs/DialogItem.js.map +1 -1
- package/lib/cjs/appui-abstract/dialogs/UiDataProvider.js +3 -5
- package/lib/cjs/appui-abstract/dialogs/UiDataProvider.js.map +1 -1
- package/lib/cjs/appui-abstract/dialogs/UiLayoutDataProvider.js +15 -19
- package/lib/cjs/appui-abstract/dialogs/UiLayoutDataProvider.js.map +1 -1
- package/lib/cjs/appui-abstract/items/ConditionalBooleanValue.js +3 -0
- package/lib/cjs/appui-abstract/items/ConditionalBooleanValue.js.map +1 -1
- package/lib/cjs/appui-abstract/items/ConditionalStringValue.js +3 -0
- package/lib/cjs/appui-abstract/items/ConditionalStringValue.js.map +1 -1
- package/lib/cjs/appui-abstract/properties/Record.js +18 -0
- package/lib/cjs/appui-abstract/properties/Record.js.map +1 -1
- package/lib/cjs/appui-abstract/quantity/BaseQuantityDescription.js +10 -6
- package/lib/cjs/appui-abstract/quantity/BaseQuantityDescription.js.map +1 -1
- package/lib/cjs/appui-abstract/toolbars/ToolbarItem.d.ts +3 -27
- package/lib/cjs/appui-abstract/toolbars/ToolbarItem.d.ts.map +1 -1
- package/lib/cjs/appui-abstract/toolbars/ToolbarItem.js +15 -37
- package/lib/cjs/appui-abstract/toolbars/ToolbarItem.js.map +1 -1
- package/lib/cjs/appui-abstract/utils/IconSpecUtilities.d.ts +0 -10
- package/lib/cjs/appui-abstract/utils/IconSpecUtilities.d.ts.map +1 -1
- package/lib/cjs/appui-abstract/utils/IconSpecUtilities.js +3 -20
- package/lib/cjs/appui-abstract/utils/IconSpecUtilities.js.map +1 -1
- package/lib/cjs/appui-abstract/utils/UiError.js +1 -0
- package/lib/cjs/appui-abstract/utils/UiError.js.map +1 -1
- package/lib/cjs/appui-abstract/utils/UiEventDispatcher.js +7 -0
- package/lib/cjs/appui-abstract/utils/UiEventDispatcher.js.map +1 -1
- package/lib/cjs/appui-abstract.d.ts +1 -28
- package/lib/cjs/appui-abstract.d.ts.map +1 -1
- package/lib/cjs/appui-abstract.js +1 -28
- package/lib/cjs/appui-abstract.js.map +1 -1
- package/lib/esm/appui-abstract/UiAdmin.js +4 -5
- package/lib/esm/appui-abstract/UiAdmin.js.map +1 -1
- package/lib/esm/appui-abstract/content/StandardContentLayouts.js +91 -91
- package/lib/esm/appui-abstract/content/StandardContentLayouts.js.map +1 -1
- package/lib/esm/appui-abstract/dialogs/DialogItem.d.ts +1 -5
- package/lib/esm/appui-abstract/dialogs/DialogItem.d.ts.map +1 -1
- package/lib/esm/appui-abstract/dialogs/DialogItem.js +4 -0
- package/lib/esm/appui-abstract/dialogs/DialogItem.js.map +1 -1
- package/lib/esm/appui-abstract/dialogs/UiDataProvider.js +3 -5
- package/lib/esm/appui-abstract/dialogs/UiDataProvider.js.map +1 -1
- package/lib/esm/appui-abstract/dialogs/UiLayoutDataProvider.js +15 -19
- package/lib/esm/appui-abstract/dialogs/UiLayoutDataProvider.js.map +1 -1
- package/lib/esm/appui-abstract/items/ConditionalBooleanValue.js +3 -0
- package/lib/esm/appui-abstract/items/ConditionalBooleanValue.js.map +1 -1
- package/lib/esm/appui-abstract/items/ConditionalStringValue.js +3 -0
- package/lib/esm/appui-abstract/items/ConditionalStringValue.js.map +1 -1
- package/lib/esm/appui-abstract/properties/Record.js +18 -0
- package/lib/esm/appui-abstract/properties/Record.js.map +1 -1
- package/lib/esm/appui-abstract/quantity/BaseQuantityDescription.js +10 -6
- package/lib/esm/appui-abstract/quantity/BaseQuantityDescription.js.map +1 -1
- package/lib/esm/appui-abstract/toolbars/ToolbarItem.d.ts +3 -27
- package/lib/esm/appui-abstract/toolbars/ToolbarItem.d.ts.map +1 -1
- package/lib/esm/appui-abstract/toolbars/ToolbarItem.js +14 -36
- package/lib/esm/appui-abstract/toolbars/ToolbarItem.js.map +1 -1
- package/lib/esm/appui-abstract/utils/IconSpecUtilities.d.ts +0 -10
- package/lib/esm/appui-abstract/utils/IconSpecUtilities.d.ts.map +1 -1
- package/lib/esm/appui-abstract/utils/IconSpecUtilities.js +3 -20
- package/lib/esm/appui-abstract/utils/IconSpecUtilities.js.map +1 -1
- package/lib/esm/appui-abstract/utils/UiError.js +1 -0
- package/lib/esm/appui-abstract/utils/UiError.js.map +1 -1
- package/lib/esm/appui-abstract/utils/UiEventDispatcher.js +7 -0
- package/lib/esm/appui-abstract/utils/UiEventDispatcher.js.map +1 -1
- package/lib/esm/appui-abstract.d.ts +1 -28
- package/lib/esm/appui-abstract.d.ts.map +1 -1
- package/lib/esm/appui-abstract.js +1 -28
- package/lib/esm/appui-abstract.js.map +1 -1
- package/package.json +7 -7
- package/lib/cjs/appui-abstract/BaseUiItemsProvider.d.ts +0 -31
- package/lib/cjs/appui-abstract/BaseUiItemsProvider.d.ts.map +0 -1
- package/lib/cjs/appui-abstract/BaseUiItemsProvider.js +0 -80
- package/lib/cjs/appui-abstract/BaseUiItemsProvider.js.map +0 -1
- package/lib/cjs/appui-abstract/UiItemsManager.d.ts +0 -111
- package/lib/cjs/appui-abstract/UiItemsManager.d.ts.map +0 -1
- package/lib/cjs/appui-abstract/UiItemsManager.js +0 -194
- package/lib/cjs/appui-abstract/UiItemsManager.js.map +0 -1
- package/lib/cjs/appui-abstract/UiItemsProvider.d.ts +0 -30
- package/lib/cjs/appui-abstract/UiItemsProvider.d.ts.map +0 -1
- package/lib/cjs/appui-abstract/UiItemsProvider.js +0 -10
- package/lib/cjs/appui-abstract/UiItemsProvider.js.map +0 -1
- package/lib/cjs/appui-abstract/backstage/BackstageItem.d.ts +0 -92
- package/lib/cjs/appui-abstract/backstage/BackstageItem.d.ts.map +0 -1
- package/lib/cjs/appui-abstract/backstage/BackstageItem.js +0 -69
- package/lib/cjs/appui-abstract/backstage/BackstageItem.js.map +0 -1
- package/lib/cjs/appui-abstract/backstage/BackstageItemsManager.d.ts +0 -43
- package/lib/cjs/appui-abstract/backstage/BackstageItemsManager.d.ts.map +0 -1
- package/lib/cjs/appui-abstract/backstage/BackstageItemsManager.js +0 -136
- package/lib/cjs/appui-abstract/backstage/BackstageItemsManager.js.map +0 -1
- package/lib/cjs/appui-abstract/items/ProvidedItem.d.ts +0 -12
- package/lib/cjs/appui-abstract/items/ProvidedItem.d.ts.map +0 -1
- package/lib/cjs/appui-abstract/items/ProvidedItem.js +0 -10
- package/lib/cjs/appui-abstract/items/ProvidedItem.js.map +0 -1
- package/lib/cjs/appui-abstract/items/StageUsage.d.ts +0 -17
- package/lib/cjs/appui-abstract/items/StageUsage.d.ts.map +0 -1
- package/lib/cjs/appui-abstract/items/StageUsage.js +0 -25
- package/lib/cjs/appui-abstract/items/StageUsage.js.map +0 -1
- package/lib/cjs/appui-abstract/statusbar/StatusBarItem.d.ts +0 -129
- package/lib/cjs/appui-abstract/statusbar/StatusBarItem.d.ts.map +0 -1
- package/lib/cjs/appui-abstract/statusbar/StatusBarItem.js +0 -88
- package/lib/cjs/appui-abstract/statusbar/StatusBarItem.js.map +0 -1
- package/lib/cjs/appui-abstract/statusbar/StatusBarItemsManager.d.ts +0 -40
- package/lib/cjs/appui-abstract/statusbar/StatusBarItemsManager.d.ts.map +0 -1
- package/lib/cjs/appui-abstract/statusbar/StatusBarItemsManager.js +0 -136
- package/lib/cjs/appui-abstract/statusbar/StatusBarItemsManager.js.map +0 -1
- package/lib/cjs/appui-abstract/toolbars/ToolbarItemsManager.d.ts +0 -46
- package/lib/cjs/appui-abstract/toolbars/ToolbarItemsManager.d.ts.map +0 -1
- package/lib/cjs/appui-abstract/toolbars/ToolbarItemsManager.js +0 -236
- package/lib/cjs/appui-abstract/toolbars/ToolbarItemsManager.js.map +0 -1
- package/lib/cjs/appui-abstract/widget/AbstractWidgetProps.d.ts +0 -87
- package/lib/cjs/appui-abstract/widget/AbstractWidgetProps.d.ts.map +0 -1
- package/lib/cjs/appui-abstract/widget/AbstractWidgetProps.js +0 -10
- package/lib/cjs/appui-abstract/widget/AbstractWidgetProps.js.map +0 -1
- package/lib/cjs/appui-abstract/widget/StagePanel.d.ts +0 -37
- package/lib/cjs/appui-abstract/widget/StagePanel.d.ts.map +0 -1
- package/lib/cjs/appui-abstract/widget/StagePanel.js +0 -47
- package/lib/cjs/appui-abstract/widget/StagePanel.js.map +0 -1
- package/lib/cjs/appui-abstract/widget/WidgetState.d.ts +0 -20
- package/lib/cjs/appui-abstract/widget/WidgetState.d.ts.map +0 -1
- package/lib/cjs/appui-abstract/widget/WidgetState.js +0 -28
- package/lib/cjs/appui-abstract/widget/WidgetState.js.map +0 -1
- package/lib/esm/appui-abstract/BaseUiItemsProvider.d.ts +0 -31
- package/lib/esm/appui-abstract/BaseUiItemsProvider.d.ts.map +0 -1
- package/lib/esm/appui-abstract/BaseUiItemsProvider.js +0 -76
- package/lib/esm/appui-abstract/BaseUiItemsProvider.js.map +0 -1
- package/lib/esm/appui-abstract/UiItemsManager.d.ts +0 -111
- package/lib/esm/appui-abstract/UiItemsManager.d.ts.map +0 -1
- package/lib/esm/appui-abstract/UiItemsManager.js +0 -190
- package/lib/esm/appui-abstract/UiItemsManager.js.map +0 -1
- package/lib/esm/appui-abstract/UiItemsProvider.d.ts +0 -30
- package/lib/esm/appui-abstract/UiItemsProvider.d.ts.map +0 -1
- package/lib/esm/appui-abstract/UiItemsProvider.js +0 -9
- package/lib/esm/appui-abstract/UiItemsProvider.js.map +0 -1
- package/lib/esm/appui-abstract/backstage/BackstageItem.d.ts +0 -92
- package/lib/esm/appui-abstract/backstage/BackstageItem.d.ts.map +0 -1
- package/lib/esm/appui-abstract/backstage/BackstageItem.js +0 -63
- package/lib/esm/appui-abstract/backstage/BackstageItem.js.map +0 -1
- package/lib/esm/appui-abstract/backstage/BackstageItemsManager.d.ts +0 -43
- package/lib/esm/appui-abstract/backstage/BackstageItemsManager.d.ts.map +0 -1
- package/lib/esm/appui-abstract/backstage/BackstageItemsManager.js +0 -132
- package/lib/esm/appui-abstract/backstage/BackstageItemsManager.js.map +0 -1
- package/lib/esm/appui-abstract/items/ProvidedItem.d.ts +0 -12
- package/lib/esm/appui-abstract/items/ProvidedItem.d.ts.map +0 -1
- package/lib/esm/appui-abstract/items/ProvidedItem.js +0 -9
- package/lib/esm/appui-abstract/items/ProvidedItem.js.map +0 -1
- package/lib/esm/appui-abstract/items/StageUsage.d.ts +0 -17
- package/lib/esm/appui-abstract/items/StageUsage.d.ts.map +0 -1
- package/lib/esm/appui-abstract/items/StageUsage.js +0 -22
- package/lib/esm/appui-abstract/items/StageUsage.js.map +0 -1
- package/lib/esm/appui-abstract/statusbar/StatusBarItem.d.ts +0 -129
- package/lib/esm/appui-abstract/statusbar/StatusBarItem.d.ts.map +0 -1
- package/lib/esm/appui-abstract/statusbar/StatusBarItem.js +0 -81
- package/lib/esm/appui-abstract/statusbar/StatusBarItem.js.map +0 -1
- package/lib/esm/appui-abstract/statusbar/StatusBarItemsManager.d.ts +0 -40
- package/lib/esm/appui-abstract/statusbar/StatusBarItemsManager.d.ts.map +0 -1
- package/lib/esm/appui-abstract/statusbar/StatusBarItemsManager.js +0 -132
- package/lib/esm/appui-abstract/statusbar/StatusBarItemsManager.js.map +0 -1
- package/lib/esm/appui-abstract/toolbars/ToolbarItemsManager.d.ts +0 -46
- package/lib/esm/appui-abstract/toolbars/ToolbarItemsManager.d.ts.map +0 -1
- package/lib/esm/appui-abstract/toolbars/ToolbarItemsManager.js +0 -232
- package/lib/esm/appui-abstract/toolbars/ToolbarItemsManager.js.map +0 -1
- package/lib/esm/appui-abstract/widget/AbstractWidgetProps.d.ts +0 -87
- package/lib/esm/appui-abstract/widget/AbstractWidgetProps.d.ts.map +0 -1
- package/lib/esm/appui-abstract/widget/AbstractWidgetProps.js +0 -9
- package/lib/esm/appui-abstract/widget/AbstractWidgetProps.js.map +0 -1
- package/lib/esm/appui-abstract/widget/StagePanel.d.ts +0 -37
- package/lib/esm/appui-abstract/widget/StagePanel.d.ts.map +0 -1
- package/lib/esm/appui-abstract/widget/StagePanel.js +0 -44
- package/lib/esm/appui-abstract/widget/StagePanel.js.map +0 -1
- package/lib/esm/appui-abstract/widget/WidgetState.d.ts +0 -20
- package/lib/esm/appui-abstract/widget/WidgetState.d.ts.map +0 -1
- package/lib/esm/appui-abstract/widget/WidgetState.js +0 -25
- package/lib/esm/appui-abstract/widget/WidgetState.js.map +0 -1
@@ -1,136 +0,0 @@
|
|
1
|
-
"use strict";
|
2
|
-
/*---------------------------------------------------------------------------------------------
|
3
|
-
* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
|
4
|
-
* See LICENSE.md in the project root for license terms and full copyright notice.
|
5
|
-
*--------------------------------------------------------------------------------------------*/
|
6
|
-
/** @packageDocumentation
|
7
|
-
* @module Backstage
|
8
|
-
*/
|
9
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
10
|
-
exports.BackstageItemsManager = void 0;
|
11
|
-
const core_bentley_1 = require("@itwin/core-bentley");
|
12
|
-
const ConditionalBooleanValue_1 = require("../items/ConditionalBooleanValue");
|
13
|
-
const ConditionalStringValue_1 = require("../items/ConditionalStringValue");
|
14
|
-
const isInstance = (args) => {
|
15
|
-
return !Array.isArray(args);
|
16
|
-
};
|
17
|
-
/**
|
18
|
-
* Controls backstage items.
|
19
|
-
* @internal
|
20
|
-
* @deprecated in 4.10.x. Use `UiFramework.backstage` from `@itwin/appui-react`.
|
21
|
-
* Please note: this internal API will be removed in 5.0.0.
|
22
|
-
*/
|
23
|
-
class BackstageItemsManager {
|
24
|
-
constructor(items) {
|
25
|
-
this._items = [];
|
26
|
-
/** Event raised when backstage items are changed.
|
27
|
-
* @internal
|
28
|
-
*/
|
29
|
-
this.onItemsChanged = new core_bentley_1.BeEvent();
|
30
|
-
// istanbul ignore else
|
31
|
-
if (items)
|
32
|
-
this.loadItemsInternal(items, true, false);
|
33
|
-
}
|
34
|
-
loadItemsInternal(items, processConditions, sendItemChanged) {
|
35
|
-
if (processConditions && items) {
|
36
|
-
const eventIds = BackstageItemsManager.getSyncIdsOfInterest(items);
|
37
|
-
if (0 !== eventIds.length) {
|
38
|
-
const { itemsUpdated, updatedItems } = this.internalRefreshAffectedItems(items, new Set(eventIds));
|
39
|
-
// istanbul ignore else
|
40
|
-
if (itemsUpdated)
|
41
|
-
items = updatedItems;
|
42
|
-
}
|
43
|
-
}
|
44
|
-
this._items = items;
|
45
|
-
if (sendItemChanged)
|
46
|
-
this.onItemsChanged.raiseEvent({ items });
|
47
|
-
}
|
48
|
-
/** load items but do not fire onItemsChanged
|
49
|
-
* @internal
|
50
|
-
*/
|
51
|
-
loadItems(items) {
|
52
|
-
this.loadItemsInternal(items, true, false);
|
53
|
-
}
|
54
|
-
get items() {
|
55
|
-
return this._items;
|
56
|
-
}
|
57
|
-
set items(items) {
|
58
|
-
// istanbul ignore else
|
59
|
-
if (items !== this._items)
|
60
|
-
this.loadItemsInternal(items, true, true);
|
61
|
-
}
|
62
|
-
/** @internal */
|
63
|
-
add(itemOrItems) {
|
64
|
-
let itemsToAdd;
|
65
|
-
if (isInstance(itemOrItems))
|
66
|
-
itemsToAdd = [itemOrItems];
|
67
|
-
else {
|
68
|
-
itemsToAdd = itemOrItems.filter((itemToAdd, index) => itemOrItems.findIndex((item) => item.id === itemToAdd.id) === index);
|
69
|
-
}
|
70
|
-
itemsToAdd = itemsToAdd.filter((itemToAdd) => this._items.find((item) => item.id === itemToAdd.id) === undefined);
|
71
|
-
if (itemsToAdd.length === 0)
|
72
|
-
return;
|
73
|
-
const items = [
|
74
|
-
...this._items,
|
75
|
-
...itemsToAdd,
|
76
|
-
];
|
77
|
-
this.items = items;
|
78
|
-
}
|
79
|
-
/** @internal */
|
80
|
-
remove(itemIdOrItemIds) {
|
81
|
-
const items = this._items.filter((item) => {
|
82
|
-
return isInstance(itemIdOrItemIds) ? item.id !== itemIdOrItemIds : !itemIdOrItemIds.find((itemId) => itemId === item.id);
|
83
|
-
});
|
84
|
-
this.items = items;
|
85
|
-
}
|
86
|
-
/** @internal */
|
87
|
-
static getSyncIdsOfInterest(items) {
|
88
|
-
const eventIds = new Set();
|
89
|
-
items.forEach((item) => {
|
90
|
-
for (const [, entry] of Object.entries(item)) {
|
91
|
-
if (entry instanceof ConditionalBooleanValue_1.ConditionalBooleanValue) {
|
92
|
-
entry.syncEventIds.forEach((eventId) => eventIds.add(eventId.toLowerCase()));
|
93
|
-
}
|
94
|
-
else /* istanbul ignore else */ if (entry instanceof ConditionalStringValue_1.ConditionalStringValue) {
|
95
|
-
entry.syncEventIds.forEach((eventId) => eventIds.add(eventId.toLowerCase()));
|
96
|
-
}
|
97
|
-
}
|
98
|
-
});
|
99
|
-
return [...eventIds.values()];
|
100
|
-
}
|
101
|
-
internalRefreshAffectedItems(items, eventIds) {
|
102
|
-
// istanbul ignore next
|
103
|
-
if (0 === eventIds.size)
|
104
|
-
return { itemsUpdated: false, updatedItems: [] };
|
105
|
-
let updateRequired = false;
|
106
|
-
const newItems = [];
|
107
|
-
for (const item of items) {
|
108
|
-
const updatedItem = { ...item };
|
109
|
-
for (const [, entry] of Object.entries(updatedItem)) {
|
110
|
-
if (entry instanceof ConditionalBooleanValue_1.ConditionalBooleanValue) {
|
111
|
-
// istanbul ignore else
|
112
|
-
if (ConditionalBooleanValue_1.ConditionalBooleanValue.refreshValue(entry, eventIds))
|
113
|
-
updateRequired = true;
|
114
|
-
}
|
115
|
-
else /* istanbul ignore else */ if (entry instanceof ConditionalStringValue_1.ConditionalStringValue) {
|
116
|
-
// istanbul ignore else
|
117
|
-
if (ConditionalStringValue_1.ConditionalStringValue.refreshValue(entry, eventIds))
|
118
|
-
updateRequired = true;
|
119
|
-
}
|
120
|
-
}
|
121
|
-
newItems.push(updatedItem);
|
122
|
-
}
|
123
|
-
return { itemsUpdated: updateRequired, updatedItems: newItems };
|
124
|
-
}
|
125
|
-
refreshAffectedItems(eventIds) {
|
126
|
-
// istanbul ignore next
|
127
|
-
if (0 === eventIds.size)
|
128
|
-
return;
|
129
|
-
const { itemsUpdated, updatedItems } = this.internalRefreshAffectedItems(this.items, eventIds);
|
130
|
-
// istanbul ignore else
|
131
|
-
if (itemsUpdated)
|
132
|
-
this.loadItemsInternal(updatedItems, false, true);
|
133
|
-
}
|
134
|
-
}
|
135
|
-
exports.BackstageItemsManager = BackstageItemsManager;
|
136
|
-
//# sourceMappingURL=BackstageItemsManager.js.map
|
@@ -1 +0,0 @@
|
|
1
|
-
{"version":3,"file":"BackstageItemsManager.js","sourceRoot":"","sources":["../../../../src/appui-abstract/backstage/BackstageItemsManager.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA8C;AAC9C,8EAA2E;AAC3E,4EAAyE;AAgBzE,MAAM,UAAU,GAAG,CAAI,IAAwB,EAAa,EAAE;IAC5D,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;AAC9B,CAAC,CAAC;AAEF;;;;;GAKG;AACH,MAAa,qBAAqB;IAGhC,YAAY,KAAoC;QAFxC,WAAM,GAAiC,EAAE,CAAC;QAgClD;;WAEG;QACa,mBAAc,GAAG,IAAI,sBAAO,EAA6C,CAAC;QAhCxF,uBAAuB;QACvB,IAAI,KAAK;YACP,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IAC/C,CAAC;IAEO,iBAAiB,CAAC,KAAmC,EAAE,iBAA0B,EAAE,eAAwB;QACjH,IAAI,iBAAiB,IAAI,KAAK,EAAE,CAAC;YAC/B,MAAM,QAAQ,GAAG,qBAAqB,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;YACnE,IAAI,CAAC,KAAK,QAAQ,CAAC,MAAM,EAAE,CAAC;gBAC1B,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC,4BAA4B,CAAC,KAAK,EAAE,IAAI,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;gBAEnG,uBAAuB;gBACvB,IAAI,YAAY;oBACd,KAAK,GAAG,YAAY,CAAC;YACzB,CAAC;QACH,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,eAAe;YACjB,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IAC9C,CAAC;IAED;;OAEG;IACI,SAAS,CAAC,KAAmC;QAClD,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IAC7C,CAAC;IAOD,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,IAAW,KAAK,CAAC,KAAmC;QAClD,uBAAuB;QACvB,IAAI,KAAK,KAAK,IAAI,CAAC,MAAM;YACvB,IAAI,CAAC,iBAAiB,CAAC,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IAC9C,CAAC;IAED,gBAAgB;IACT,GAAG,CAAC,WAAyD;QAClE,IAAI,UAAU,CAAC;QACf,IAAI,UAAU,CAAC,WAAW,CAAC;YACzB,UAAU,GAAG,CAAC,WAAW,CAAC,CAAC;aACxB,CAAC;YACJ,UAAU,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,SAAS,CAAC,EAAE,CAAC,KAAK,KAAK,CAAC,CAAC;QAC7H,CAAC;QACD,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,SAAS,CAAC,EAAE,CAAC,KAAK,SAAS,CAAC,CAAC;QAClH,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;YACzB,OAAO;QACT,MAAM,KAAK,GAAG;YACZ,GAAG,IAAI,CAAC,MAAM;YACd,GAAG,UAAU;SACd,CAAC;QACF,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,eAAyE;QACrF,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE;YACxC,OAAO,UAAU,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,KAAK,eAAe,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,KAAK,IAAI,CAAC,EAAE,CAAC,CAAC;QAC3H,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,oBAAoB,CAAC,KAA+B;QAChE,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAC;QACnC,KAAK,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;YACrB,KAAK,MAAM,CAAC,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC7C,IAAI,KAAK,YAAY,iDAAuB,EAAE,CAAC;oBAC7C,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,OAAe,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;gBACvF,CAAC;qBAAM,0BAA0B,CAAC,IAAI,KAAK,YAAY,+CAAsB,EAAE,CAAC;oBAC9E,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,OAAe,EAAE,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;gBACvF,CAAC;YACH,CAAC;QACH,CAAC,CAAC,CAAC;QACH,OAAO,CAAC,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;IAChC,CAAC;IAEO,4BAA4B,CAAC,KAA+B,EAAE,QAAqB;QACzF,uBAAuB;QACvB,IAAI,CAAC,KAAK,QAAQ,CAAC,IAAI;YACrB,OAAO,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE,EAAE,EAAE,CAAC;QAEnD,IAAI,cAAc,GAAG,KAAK,CAAC;QAE3B,MAAM,QAAQ,GAAoB,EAAE,CAAC;QACrC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,MAAM,WAAW,GAAG,EAAE,GAAG,IAAI,EAAE,CAAC;YAEhC,KAAK,MAAM,CAAC,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;gBACpD,IAAI,KAAK,YAAY,iDAAuB,EAAE,CAAC;oBAC7C,uBAAuB;oBACvB,IAAI,iDAAuB,CAAC,YAAY,CAAC,KAAK,EAAE,QAAQ,CAAC;wBACvD,cAAc,GAAG,IAAI,CAAC;gBAC1B,CAAC;qBAAM,0BAA0B,CAAC,IAAI,KAAK,YAAY,+CAAsB,EAAE,CAAC;oBAC9E,uBAAuB;oBACvB,IAAI,+CAAsB,CAAC,YAAY,CAAC,KAAK,EAAE,QAAQ,CAAC;wBACtD,cAAc,GAAG,IAAI,CAAC;gBAC1B,CAAC;YACH,CAAC;YAED,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC7B,CAAC;QAED,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC;IAClE,CAAC;IAEM,oBAAoB,CAAC,QAAqB;QAC/C,uBAAuB;QACvB,IAAI,CAAC,KAAK,QAAQ,CAAC,IAAI;YACrB,OAAO;QAET,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,GAAG,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;QAE/F,uBAAuB;QACvB,IAAI,YAAY;YACd,IAAI,CAAC,iBAAiB,CAAC,YAAY,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IACtD,CAAC;CAEF;AAlID,sDAkIC","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 Backstage\r\n */\r\n\r\nimport { BeEvent } from \"@itwin/core-bentley\";\r\nimport { ConditionalBooleanValue } from \"../items/ConditionalBooleanValue\";\r\nimport { ConditionalStringValue } from \"../items/ConditionalStringValue\";\r\nimport { BackstageItem } from \"./BackstageItem\";\r\n\r\n/* eslint-disable @typescript-eslint/no-deprecated */\r\n\r\n/** Arguments of [[BackstageItemsManager.onChanged]] event.\r\n * @internal\r\n * @deprecated in 4.10.x. Used internally by `@itwin/appui-react`.\r\n * Please note: this internal API will be removed in 5.0.0.\r\n */\r\nexport interface BackstageItemsChangedArgs {\r\n readonly items: ReadonlyArray<BackstageItem>;\r\n}\r\n\r\ntype InstanceOrArray<T> = T | ReadonlyArray<T>;\r\n\r\nconst isInstance = <T>(args: InstanceOrArray<T>): args is T => {\r\n return !Array.isArray(args);\r\n};\r\n\r\n/**\r\n * Controls backstage items.\r\n * @internal\r\n * @deprecated in 4.10.x. Use `UiFramework.backstage` from `@itwin/appui-react`.\r\n * Please note: this internal API will be removed in 5.0.0.\r\n */\r\nexport class BackstageItemsManager {\r\n private _items: ReadonlyArray<BackstageItem> = [];\r\n\r\n constructor(items?: ReadonlyArray<BackstageItem>) {\r\n // istanbul ignore else\r\n if (items)\r\n this.loadItemsInternal(items, true, false);\r\n }\r\n\r\n private loadItemsInternal(items: ReadonlyArray<BackstageItem>, processConditions: boolean, sendItemChanged: boolean) {\r\n if (processConditions && items) {\r\n const eventIds = BackstageItemsManager.getSyncIdsOfInterest(items);\r\n if (0 !== eventIds.length) {\r\n const { itemsUpdated, updatedItems } = this.internalRefreshAffectedItems(items, new Set(eventIds));\r\n\r\n // istanbul ignore else\r\n if (itemsUpdated)\r\n items = updatedItems;\r\n }\r\n }\r\n\r\n this._items = items;\r\n if (sendItemChanged)\r\n this.onItemsChanged.raiseEvent({ items });\r\n }\r\n\r\n /** load items but do not fire onItemsChanged\r\n * @internal\r\n */\r\n public loadItems(items: ReadonlyArray<BackstageItem>) {\r\n this.loadItemsInternal(items, true, false);\r\n }\r\n\r\n /** Event raised when backstage items are changed.\r\n * @internal\r\n */\r\n public readonly onItemsChanged = new BeEvent<(args: BackstageItemsChangedArgs) => void>();\r\n\r\n public get items(): ReadonlyArray<BackstageItem> {\r\n return this._items;\r\n }\r\n\r\n public set items(items: ReadonlyArray<BackstageItem>) {\r\n // istanbul ignore else\r\n if (items !== this._items)\r\n this.loadItemsInternal(items, true, true);\r\n }\r\n\r\n /** @internal */\r\n public add(itemOrItems: BackstageItem | ReadonlyArray<BackstageItem>) {\r\n let itemsToAdd;\r\n if (isInstance(itemOrItems))\r\n itemsToAdd = [itemOrItems];\r\n else {\r\n itemsToAdd = itemOrItems.filter((itemToAdd, index) => itemOrItems.findIndex((item) => item.id === itemToAdd.id) === index);\r\n }\r\n itemsToAdd = itemsToAdd.filter((itemToAdd) => this._items.find((item) => item.id === itemToAdd.id) === undefined);\r\n if (itemsToAdd.length === 0)\r\n return;\r\n const items = [\r\n ...this._items,\r\n ...itemsToAdd,\r\n ];\r\n this.items = items;\r\n }\r\n\r\n /** @internal */\r\n public remove(itemIdOrItemIds: BackstageItem[\"id\"] | ReadonlyArray<BackstageItem[\"id\"]>) {\r\n const items = this._items.filter((item) => {\r\n return isInstance(itemIdOrItemIds) ? item.id !== itemIdOrItemIds : !itemIdOrItemIds.find((itemId) => itemId === item.id);\r\n });\r\n this.items = items;\r\n }\r\n\r\n /** @internal */\r\n public static getSyncIdsOfInterest(items: readonly BackstageItem[]): string[] {\r\n const eventIds = new Set<string>();\r\n items.forEach((item) => {\r\n for (const [, entry] of Object.entries(item)) {\r\n if (entry instanceof ConditionalBooleanValue) {\r\n entry.syncEventIds.forEach((eventId: string) => eventIds.add(eventId.toLowerCase()));\r\n } else /* istanbul ignore else */ if (entry instanceof ConditionalStringValue) {\r\n entry.syncEventIds.forEach((eventId: string) => eventIds.add(eventId.toLowerCase()));\r\n }\r\n }\r\n });\r\n return [...eventIds.values()];\r\n }\r\n\r\n private internalRefreshAffectedItems(items: readonly BackstageItem[], eventIds: Set<string>): { itemsUpdated: boolean, updatedItems: BackstageItem[] } {\r\n // istanbul ignore next\r\n if (0 === eventIds.size)\r\n return { itemsUpdated: false, updatedItems: [] };\r\n\r\n let updateRequired = false;\r\n\r\n const newItems: BackstageItem[] = [];\r\n for (const item of items) {\r\n const updatedItem = { ...item };\r\n\r\n for (const [, entry] of Object.entries(updatedItem)) {\r\n if (entry instanceof ConditionalBooleanValue) {\r\n // istanbul ignore else\r\n if (ConditionalBooleanValue.refreshValue(entry, eventIds))\r\n updateRequired = true;\r\n } else /* istanbul ignore else */ if (entry instanceof ConditionalStringValue) {\r\n // istanbul ignore else\r\n if (ConditionalStringValue.refreshValue(entry, eventIds))\r\n updateRequired = true;\r\n }\r\n }\r\n\r\n newItems.push(updatedItem);\r\n }\r\n\r\n return { itemsUpdated: updateRequired, updatedItems: newItems };\r\n }\r\n\r\n public refreshAffectedItems(eventIds: Set<string>) {\r\n // istanbul ignore next\r\n if (0 === eventIds.size)\r\n return;\r\n\r\n const { itemsUpdated, updatedItems } = this.internalRefreshAffectedItems(this.items, eventIds);\r\n\r\n // istanbul ignore else\r\n if (itemsUpdated)\r\n this.loadItemsInternal(updatedItems, false, true);\r\n }\r\n\r\n}\r\n"]}
|
@@ -1,12 +0,0 @@
|
|
1
|
-
/** @packageDocumentation
|
2
|
-
* @module Item
|
3
|
-
*/
|
4
|
-
/** Properties for an item provided by UiItemsProvider
|
5
|
-
* @deprecated in 3.6. Use [ProviderItem]($appui-react) instead.
|
6
|
-
* @public
|
7
|
-
*/
|
8
|
-
export interface ProvidedItem {
|
9
|
-
/** id of UiItemsProvider */
|
10
|
-
readonly providerId?: string;
|
11
|
-
}
|
12
|
-
//# sourceMappingURL=ProvidedItem.d.ts.map
|
@@ -1 +0,0 @@
|
|
1
|
-
{"version":3,"file":"ProvidedItem.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/items/ProvidedItem.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B,4BAA4B;IAC5B,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC9B"}
|
@@ -1,10 +0,0 @@
|
|
1
|
-
"use strict";
|
2
|
-
/*---------------------------------------------------------------------------------------------
|
3
|
-
* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
|
4
|
-
* See LICENSE.md in the project root for license terms and full copyright notice.
|
5
|
-
*--------------------------------------------------------------------------------------------*/
|
6
|
-
/** @packageDocumentation
|
7
|
-
* @module Item
|
8
|
-
*/
|
9
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
10
|
-
//# sourceMappingURL=ProvidedItem.js.map
|
@@ -1 +0,0 @@
|
|
1
|
-
{"version":3,"file":"ProvidedItem.js","sourceRoot":"","sources":["../../../../src/appui-abstract/items/ProvidedItem.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Item\r\n */\r\n\r\n/** Properties for an item provided by UiItemsProvider\r\n * @deprecated in 3.6. Use [ProviderItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport interface ProvidedItem {\r\n /** id of UiItemsProvider */\r\n readonly providerId?: string;\r\n}\r\n"]}
|
@@ -1,17 +0,0 @@
|
|
1
|
-
/** @packageDocumentation
|
2
|
-
* @module Item
|
3
|
-
*/
|
4
|
-
/** Standard stage uses. Allows extension to target ui item to include on a stage without
|
5
|
-
* knowing the stage name defined in the host application.
|
6
|
-
* @deprecated in 3.6. Use [StageUsage]($appui-react) instead.
|
7
|
-
* @public
|
8
|
-
*/
|
9
|
-
export declare enum StageUsage {
|
10
|
-
Private = "Private",
|
11
|
-
General = "General",
|
12
|
-
Redline = "Redline",
|
13
|
-
ViewOnly = "ViewOnly",
|
14
|
-
Edit = "Edit",
|
15
|
-
Settings = "Settings"
|
16
|
-
}
|
17
|
-
//# sourceMappingURL=StageUsage.d.ts.map
|
@@ -1 +0,0 @@
|
|
1
|
-
{"version":3,"file":"StageUsage.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/items/StageUsage.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;;GAIG;AACH,oBAAY,UAAU;IACpB,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,IAAI,SAAS;IACb,QAAQ,aAAa;CACtB"}
|
@@ -1,25 +0,0 @@
|
|
1
|
-
"use strict";
|
2
|
-
/*---------------------------------------------------------------------------------------------
|
3
|
-
* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
|
4
|
-
* See LICENSE.md in the project root for license terms and full copyright notice.
|
5
|
-
*--------------------------------------------------------------------------------------------*/
|
6
|
-
/** @packageDocumentation
|
7
|
-
* @module Item
|
8
|
-
*/
|
9
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
10
|
-
exports.StageUsage = void 0;
|
11
|
-
/** Standard stage uses. Allows extension to target ui item to include on a stage without
|
12
|
-
* knowing the stage name defined in the host application.
|
13
|
-
* @deprecated in 3.6. Use [StageUsage]($appui-react) instead.
|
14
|
-
* @public
|
15
|
-
*/
|
16
|
-
var StageUsage;
|
17
|
-
(function (StageUsage) {
|
18
|
-
StageUsage["Private"] = "Private";
|
19
|
-
StageUsage["General"] = "General";
|
20
|
-
StageUsage["Redline"] = "Redline";
|
21
|
-
StageUsage["ViewOnly"] = "ViewOnly";
|
22
|
-
StageUsage["Edit"] = "Edit";
|
23
|
-
StageUsage["Settings"] = "Settings";
|
24
|
-
})(StageUsage || (exports.StageUsage = StageUsage = {}));
|
25
|
-
//# sourceMappingURL=StageUsage.js.map
|
@@ -1 +0,0 @@
|
|
1
|
-
{"version":3,"file":"StageUsage.js","sourceRoot":"","sources":["../../../../src/appui-abstract/items/StageUsage.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH;;;;GAIG;AACH,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,iCAAmB,CAAA;IACnB,iCAAmB,CAAA;IACnB,iCAAmB,CAAA;IACnB,mCAAqB,CAAA;IACrB,2BAAa,CAAA;IACb,mCAAqB,CAAA;AACvB,CAAC,EAPW,UAAU,0BAAV,UAAU,QAOrB","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 Item\r\n */\r\n\r\n/** Standard stage uses. Allows extension to target ui item to include on a stage without\r\n * knowing the stage name defined in the host application.\r\n * @deprecated in 3.6. Use [StageUsage]($appui-react) instead.\r\n * @public\r\n */\r\nexport enum StageUsage {\r\n Private = \"Private\",\r\n General = \"General\",\r\n Redline = \"Redline\",\r\n ViewOnly = \"ViewOnly\",\r\n Edit = \"Edit\",\r\n Settings = \"Settings\",\r\n}\r\n"]}
|
@@ -1,129 +0,0 @@
|
|
1
|
-
/** @packageDocumentation
|
2
|
-
* @module StatusBar
|
3
|
-
*/
|
4
|
-
import { BadgeType } from "../items/BadgeType";
|
5
|
-
import { ConditionalBooleanValue } from "../items/ConditionalBooleanValue";
|
6
|
-
import { ConditionalStringValue } from "../items/ConditionalStringValue";
|
7
|
-
import { ProvidedItem } from "../items/ProvidedItem";
|
8
|
-
/** Status bar Groups/Sections from Left to Right
|
9
|
-
* @deprecated in 3.6. Use [StatusBarSection]($appui-react) instead.
|
10
|
-
* @public
|
11
|
-
*/
|
12
|
-
export declare enum StatusBarSection {
|
13
|
-
/** area for tool assistance and messages */
|
14
|
-
Message = 0,
|
15
|
-
/** area for tool assistance and messages */
|
16
|
-
Left = 0,// eslint-disable-line @typescript-eslint/no-duplicate-enum-values
|
17
|
-
/** items specific to stage/task */
|
18
|
-
Stage = 1,
|
19
|
-
/** items specific to stage/task */
|
20
|
-
Center = 1,// eslint-disable-line @typescript-eslint/no-duplicate-enum-values
|
21
|
-
/** Select scope and selection info */
|
22
|
-
Selection = 2,
|
23
|
-
/** Select scope and selection info */
|
24
|
-
Right = 2,// eslint-disable-line @typescript-eslint/no-duplicate-enum-values
|
25
|
-
/** items that only show based on context */
|
26
|
-
Context = 3
|
27
|
-
}
|
28
|
-
/** Defines which side of Icon where label is placed
|
29
|
-
* @deprecated in 3.6. Use [StatusBarLabelSide]($appui-react) instead.
|
30
|
-
* @public
|
31
|
-
*/
|
32
|
-
export declare enum StatusBarLabelSide {
|
33
|
-
/** Label is placed left side of icon. This is the default if not specified */
|
34
|
-
Left = 0,
|
35
|
-
/** Label is placed on right side of icon. */
|
36
|
-
Right = 1
|
37
|
-
}
|
38
|
-
/** Type for StatusBar Item Id
|
39
|
-
* @deprecated in 3.6. Please use `CommonStatusBarItem["id"]` from @itwin/appui-react.
|
40
|
-
* @public
|
41
|
-
*/
|
42
|
-
export type StatusBarItemId = CommonStatusBarItem["id"];
|
43
|
-
/** Describes the data needed to insert a button into the status bar.
|
44
|
-
* @deprecated in 3.6. Use [CommonStatusBarItem]($appui-react) instead.
|
45
|
-
* @public
|
46
|
-
*/
|
47
|
-
export interface AbstractStatusBarItem extends ProvidedItem {
|
48
|
-
/** can be used by application to store miscellaneous data. */
|
49
|
-
applicationData?: any;
|
50
|
-
/** Describes badge. Renders no badge if not specified. */
|
51
|
-
readonly badgeType?: BadgeType;
|
52
|
-
/** Required unique id of the item. To ensure uniqueness it is suggested that a namespace prefix of the extension name be used. */
|
53
|
-
readonly id: string;
|
54
|
-
/** optional data to used by item implementor. */
|
55
|
-
readonly internalData?: Map<string, any>;
|
56
|
-
/** Describes if the item is visible or hidden. The default is for the item to be visible. */
|
57
|
-
readonly isHidden?: boolean | ConditionalBooleanValue;
|
58
|
-
/** Describes if the item is enabled or disabled. The default is for the item to be enabled. */
|
59
|
-
readonly isDisabled?: boolean | ConditionalBooleanValue;
|
60
|
-
/** Priority within a section (recommend using values 1 through 100). */
|
61
|
-
readonly itemPriority: number;
|
62
|
-
/** status bar section */
|
63
|
-
readonly section: StatusBarSection;
|
64
|
-
}
|
65
|
-
/** Describes the data needed to insert an action item into the status bar.
|
66
|
-
* @deprecated in 3.6. Use [StatusBarActionItem]($appui-react) instead.
|
67
|
-
* @public
|
68
|
-
*/
|
69
|
-
export interface AbstractStatusBarActionItem extends AbstractStatusBarItem {
|
70
|
-
/** method to execute when icon is pressed */
|
71
|
-
readonly execute: () => void;
|
72
|
-
/** Name of icon WebFont entry or if specifying an imported SVG symbol use "webSvg:" prefix to imported symbol Id. */
|
73
|
-
readonly icon?: string | ConditionalStringValue;
|
74
|
-
/** Label. */
|
75
|
-
readonly label?: string | ConditionalStringValue;
|
76
|
-
/** tooltip. */
|
77
|
-
readonly tooltip?: string | ConditionalStringValue;
|
78
|
-
}
|
79
|
-
/** Describes the data needed to insert a label item with an optional icon into the status bar.
|
80
|
-
* @deprecated in 3.6. Use [StatusBarLabelItem]($appui-react) instead.
|
81
|
-
* @public
|
82
|
-
*/
|
83
|
-
export interface AbstractStatusBarLabelItem extends AbstractStatusBarItem {
|
84
|
-
/** Name of icon WebFont entry or if specifying an imported SVG symbol use "webSvg:" prefix to imported symbol Id. */
|
85
|
-
readonly icon?: string | ConditionalStringValue;
|
86
|
-
/** Label. */
|
87
|
-
readonly label: string | ConditionalStringValue;
|
88
|
-
/** Defines which side of icon to display label if icon is defined. */
|
89
|
-
readonly labelSide?: StatusBarLabelSide;
|
90
|
-
}
|
91
|
-
/** Describes the data needed to insert a custom item into the status bar. This is used to allow extension
|
92
|
-
* implementer to create a framework specific component.
|
93
|
-
* @deprecated in 3.6. Use [StatusBarCustomItem]($appui-react) instead.
|
94
|
-
* @public
|
95
|
-
*/
|
96
|
-
export interface AbstractStatusBarCustomItem extends AbstractStatusBarItem {
|
97
|
-
readonly isCustom: true;
|
98
|
-
}
|
99
|
-
/** Describes the data needed to insert a button into the status bar.
|
100
|
-
* @deprecated in 3.6. Use [StatusBarItem]($appui-react) instead.
|
101
|
-
* @public
|
102
|
-
*/
|
103
|
-
export type CommonStatusBarItem = AbstractStatusBarActionItem | AbstractStatusBarLabelItem | AbstractStatusBarCustomItem;
|
104
|
-
/** AbstractStatusBarActionItem type guard.
|
105
|
-
* @deprecated in 3.6. Use [isStatusBarActionItem]($appui-react) instead.
|
106
|
-
* @public
|
107
|
-
*/
|
108
|
-
export declare const isAbstractStatusBarActionItem: (item: CommonStatusBarItem) => item is AbstractStatusBarActionItem;
|
109
|
-
/** AbstractStatusBarLabelItem type guard.
|
110
|
-
* @deprecated in 3.6. Use [isStatusBarLabelItem]($appui-react) instead.
|
111
|
-
* @public
|
112
|
-
*/
|
113
|
-
export declare const isAbstractStatusBarLabelItem: (item: CommonStatusBarItem) => item is AbstractStatusBarLabelItem;
|
114
|
-
/** AbstractStatusBarCustomItem type guard.
|
115
|
-
* @deprecated in 3.6. Use [isStatusBarCustomItem]($appui-react) instead.
|
116
|
-
* @public
|
117
|
-
*/
|
118
|
-
export declare const isAbstractStatusBarCustomItem: (item: CommonStatusBarItem) => item is AbstractStatusBarCustomItem;
|
119
|
-
/** Helper class to create Abstract StatusBar Item definitions.
|
120
|
-
* @deprecated in 3.6. Use [StatusBarItemUtilities]($appui-react) instead.
|
121
|
-
* @public
|
122
|
-
*/
|
123
|
-
export declare class AbstractStatusBarItemUtilities {
|
124
|
-
/** Creates a StatusBar item to perform an action */
|
125
|
-
static createActionItem: (id: string, section: StatusBarSection, itemPriority: number, icon: string | ConditionalStringValue, tooltip: string | ConditionalStringValue, execute: () => void, overrides?: Partial<AbstractStatusBarCustomItem>) => AbstractStatusBarActionItem;
|
126
|
-
/** Creates a StatusBar item to display a label */
|
127
|
-
static createLabelItem: (id: string, section: StatusBarSection, itemPriority: number, icon: string | ConditionalStringValue, label: string | ConditionalStringValue, labelSide?: StatusBarLabelSide, overrides?: Partial<AbstractStatusBarLabelItem>) => AbstractStatusBarLabelItem;
|
128
|
-
}
|
129
|
-
//# sourceMappingURL=StatusBarItem.d.ts.map
|
@@ -1 +0,0 @@
|
|
1
|
-
{"version":3,"file":"StatusBarItem.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/statusbar/StatusBarItem.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,uBAAuB,EAAE,MAAM,kCAAkC,CAAC;AAC3E,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AACzE,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAErD;;;GAGG;AACH,oBAAY,gBAAgB;IAC1B,4CAA4C;IAC5C,OAAO,IAAI;IACX,4CAA4C;IAC5C,IAAI,IAAI,CAAG,kEAAkE;IAC7E,mCAAmC;IACnC,KAAK,IAAI;IACT,mCAAmC;IACnC,MAAM,IAAI,CAAG,kEAAkE;IAC/E,sCAAsC;IACtC,SAAS,IAAI;IACb,sCAAsC;IACtC,KAAK,IAAI,CAAG,kEAAkE;IAC9E,4CAA4C;IAC5C,OAAO,IAAI;CACZ;AAED;;;GAGG;AACH,oBAAY,kBAAkB;IAC5B,8EAA8E;IAC9E,IAAI,IAAA;IACJ,6CAA6C;IAC7C,KAAK,IAAA;CACN;AAED;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,mBAAmB,CAAC,IAAI,CAAC,CAAC;AAExD;;;GAGG;AACH,MAAM,WAAW,qBAAsB,SAAQ,YAAY;IACzD,8DAA8D;IAC9D,eAAe,CAAC,EAAE,GAAG,CAAC;IACtB,0DAA0D;IAC1D,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC;IAC/B,kIAAkI;IAClI,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,iDAAiD;IACjD,QAAQ,CAAC,YAAY,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACzC,6FAA6F;IAC7F,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAC;IACtD,+FAA+F;IAC/F,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,GAAG,uBAAuB,CAAC;IACxD,wEAAwE;IACxE,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B,yBAAyB;IACzB,QAAQ,CAAC,OAAO,EAAE,gBAAgB,CAAC;CACpC;AAED;;;GAGG;AACH,MAAM,WAAW,2BAA4B,SAAQ,qBAAqB;IACxE,6CAA6C;IAC7C,QAAQ,CAAC,OAAO,EAAE,MAAM,IAAI,CAAC;IAC7B,sHAAsH;IACtH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAChD,aAAa;IACb,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IACjD,eAAe;IACf,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;CACpD;AAED;;;GAGG;AACH,MAAM,WAAW,0BAA2B,SAAQ,qBAAqB;IACvE,sHAAsH;IACtH,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAChD,aAAa;IACb,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,sBAAsB,CAAC;IAChD,sEAAsE;IACtE,QAAQ,CAAC,SAAS,CAAC,EAAE,kBAAkB,CAAC;CACzC;AAED;;;;GAIG;AACH,MAAM,WAAW,2BAA4B,SAAQ,qBAAqB;IACxE,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,MAAM,mBAAmB,GAAG,2BAA2B,GAAG,0BAA0B,GAAG,2BAA2B,CAAC;AAEzH;;;GAGG;AACH,eAAO,MAAM,6BAA6B,SAAU,mBAAmB,KAAG,IAAI,IAAI,2BAEjF,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,4BAA4B,SAAU,mBAAmB,KAAG,IAAI,IAAI,0BAEhF,CAAC;AAEF;;;GAGG;AACH,eAAO,MAAM,6BAA6B,SAAU,mBAAmB,KAAG,IAAI,IAAI,2BAEjF,CAAC;AAEF;;;GAGG;AACH,qBAAa,8BAA8B;IACzC,oDAAoD;IACpD,OAAc,gBAAgB,OAAQ,MAAM,WAAW,gBAAgB,gBAAgB,MAAM,QAAQ,MAAM,GAAG,sBAAsB,WAAW,MAAM,GAAG,sBAAsB,WAAW,MAAM,IAAI,cAAc,OAAO,CAAC,2BAA2B,CAAC,KAAG,2BAA2B,CAKhR;IAEH,kDAAkD;IAClD,OAAc,eAAe,OAAQ,MAAM,WAAW,gBAAgB,gBAAgB,MAAM,QAAQ,MAAM,GAAG,sBAAsB,SAAS,MAAM,GAAG,sBAAsB,8CAAoD,OAAO,CAAC,0BAA0B,CAAC,KAAG,0BAA0B,CAK5R;CACJ"}
|
@@ -1,88 +0,0 @@
|
|
1
|
-
"use strict";
|
2
|
-
/*---------------------------------------------------------------------------------------------
|
3
|
-
* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
|
4
|
-
* See LICENSE.md in the project root for license terms and full copyright notice.
|
5
|
-
*--------------------------------------------------------------------------------------------*/
|
6
|
-
/** @packageDocumentation
|
7
|
-
* @module StatusBar
|
8
|
-
*/
|
9
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
10
|
-
exports.AbstractStatusBarItemUtilities = exports.isAbstractStatusBarCustomItem = exports.isAbstractStatusBarLabelItem = exports.isAbstractStatusBarActionItem = exports.StatusBarLabelSide = exports.StatusBarSection = void 0;
|
11
|
-
/** Status bar Groups/Sections from Left to Right
|
12
|
-
* @deprecated in 3.6. Use [StatusBarSection]($appui-react) instead.
|
13
|
-
* @public
|
14
|
-
*/
|
15
|
-
var StatusBarSection;
|
16
|
-
(function (StatusBarSection) {
|
17
|
-
/** area for tool assistance and messages */
|
18
|
-
StatusBarSection[StatusBarSection["Message"] = 0] = "Message";
|
19
|
-
/** area for tool assistance and messages */
|
20
|
-
StatusBarSection[StatusBarSection["Left"] = 0] = "Left";
|
21
|
-
/** items specific to stage/task */
|
22
|
-
StatusBarSection[StatusBarSection["Stage"] = 1] = "Stage";
|
23
|
-
/** items specific to stage/task */
|
24
|
-
StatusBarSection[StatusBarSection["Center"] = 1] = "Center";
|
25
|
-
/** Select scope and selection info */
|
26
|
-
StatusBarSection[StatusBarSection["Selection"] = 2] = "Selection";
|
27
|
-
/** Select scope and selection info */
|
28
|
-
StatusBarSection[StatusBarSection["Right"] = 2] = "Right";
|
29
|
-
/** items that only show based on context */
|
30
|
-
StatusBarSection[StatusBarSection["Context"] = 3] = "Context";
|
31
|
-
})(StatusBarSection || (exports.StatusBarSection = StatusBarSection = {}));
|
32
|
-
/** Defines which side of Icon where label is placed
|
33
|
-
* @deprecated in 3.6. Use [StatusBarLabelSide]($appui-react) instead.
|
34
|
-
* @public
|
35
|
-
*/
|
36
|
-
var StatusBarLabelSide;
|
37
|
-
(function (StatusBarLabelSide) {
|
38
|
-
/** Label is placed left side of icon. This is the default if not specified */
|
39
|
-
StatusBarLabelSide[StatusBarLabelSide["Left"] = 0] = "Left";
|
40
|
-
/** Label is placed on right side of icon. */
|
41
|
-
StatusBarLabelSide[StatusBarLabelSide["Right"] = 1] = "Right";
|
42
|
-
})(StatusBarLabelSide || (exports.StatusBarLabelSide = StatusBarLabelSide = {}));
|
43
|
-
/** AbstractStatusBarActionItem type guard.
|
44
|
-
* @deprecated in 3.6. Use [isStatusBarActionItem]($appui-react) instead.
|
45
|
-
* @public
|
46
|
-
*/
|
47
|
-
const isAbstractStatusBarActionItem = (item) => {
|
48
|
-
return item.execute !== undefined; // eslint-disable-line @typescript-eslint/no-deprecated
|
49
|
-
};
|
50
|
-
exports.isAbstractStatusBarActionItem = isAbstractStatusBarActionItem;
|
51
|
-
/** AbstractStatusBarLabelItem type guard.
|
52
|
-
* @deprecated in 3.6. Use [isStatusBarLabelItem]($appui-react) instead.
|
53
|
-
* @public
|
54
|
-
*/
|
55
|
-
const isAbstractStatusBarLabelItem = (item) => {
|
56
|
-
return item.label !== undefined && item.execute === undefined; // eslint-disable-line @typescript-eslint/no-deprecated
|
57
|
-
};
|
58
|
-
exports.isAbstractStatusBarLabelItem = isAbstractStatusBarLabelItem;
|
59
|
-
/** AbstractStatusBarCustomItem type guard.
|
60
|
-
* @deprecated in 3.6. Use [isStatusBarCustomItem]($appui-react) instead.
|
61
|
-
* @public
|
62
|
-
*/
|
63
|
-
const isAbstractStatusBarCustomItem = (item) => {
|
64
|
-
return !!item.isCustom; // eslint-disable-line @typescript-eslint/no-deprecated
|
65
|
-
};
|
66
|
-
exports.isAbstractStatusBarCustomItem = isAbstractStatusBarCustomItem;
|
67
|
-
/** Helper class to create Abstract StatusBar Item definitions.
|
68
|
-
* @deprecated in 3.6. Use [StatusBarItemUtilities]($appui-react) instead.
|
69
|
-
* @public
|
70
|
-
*/
|
71
|
-
class AbstractStatusBarItemUtilities {
|
72
|
-
}
|
73
|
-
exports.AbstractStatusBarItemUtilities = AbstractStatusBarItemUtilities;
|
74
|
-
/** Creates a StatusBar item to perform an action */
|
75
|
-
AbstractStatusBarItemUtilities.createActionItem = (id, section, itemPriority, icon, tooltip, execute, overrides) => ({
|
76
|
-
id, section, itemPriority,
|
77
|
-
icon, tooltip,
|
78
|
-
execute,
|
79
|
-
...overrides,
|
80
|
-
});
|
81
|
-
/** Creates a StatusBar item to display a label */
|
82
|
-
AbstractStatusBarItemUtilities.createLabelItem = (id, section, itemPriority, icon, label, labelSide = StatusBarLabelSide.Right, overrides) => ({
|
83
|
-
id, section, itemPriority,
|
84
|
-
icon, label,
|
85
|
-
labelSide,
|
86
|
-
...overrides,
|
87
|
-
});
|
88
|
-
//# sourceMappingURL=StatusBarItem.js.map
|
@@ -1 +0,0 @@
|
|
1
|
-
{"version":3,"file":"StatusBarItem.js","sourceRoot":"","sources":["../../../../src/appui-abstract/statusbar/StatusBarItem.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAOH;;;GAGG;AACH,IAAY,gBAeX;AAfD,WAAY,gBAAgB;IAC1B,4CAA4C;IAC5C,6DAAW,CAAA;IACX,4CAA4C;IAC5C,uDAAQ,CAAA;IACR,mCAAmC;IACnC,yDAAS,CAAA;IACT,mCAAmC;IACnC,2DAAU,CAAA;IACV,sCAAsC;IACtC,iEAAa,CAAA;IACb,sCAAsC;IACtC,yDAAS,CAAA;IACT,4CAA4C;IAC5C,6DAAW,CAAA;AACb,CAAC,EAfW,gBAAgB,gCAAhB,gBAAgB,QAe3B;AAED;;;GAGG;AACH,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,8EAA8E;IAC9E,2DAAI,CAAA;IACJ,6CAA6C;IAC7C,6DAAK,CAAA;AACP,CAAC,EALW,kBAAkB,kCAAlB,kBAAkB,QAK7B;AA0ED;;;GAGG;AACI,MAAM,6BAA6B,GAAG,CAAC,IAAyB,EAAuC,EAAE;IAC9G,OAAQ,IAAoC,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,uDAAuD;AAC7H,CAAC,CAAC;AAFW,QAAA,6BAA6B,iCAExC;AAEF;;;GAGG;AACI,MAAM,4BAA4B,GAAG,CAAC,IAAyB,EAAsC,EAAE;IAC5G,OAAQ,IAAmC,CAAC,KAAK,KAAK,SAAS,IAAK,IAAoC,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,uDAAuD;AACzL,CAAC,CAAC;AAFW,QAAA,4BAA4B,gCAEvC;AAEF;;;GAGG;AACI,MAAM,6BAA6B,GAAG,CAAC,IAAyB,EAAuC,EAAE;IAC9G,OAAO,CAAC,CAAE,IAAoC,CAAC,QAAQ,CAAC,CAAC,uDAAuD;AAClH,CAAC,CAAC;AAFW,QAAA,6BAA6B,iCAExC;AAEF;;;GAGG;AACH,MAAa,8BAA8B;;AAA3C,wEAgBC;AAfC,oDAAoD;AACtC,+CAAgB,GAAG,CAAC,EAAU,EAAE,OAAyB,EAAE,YAAoB,EAAE,IAAqC,EAAE,OAAwC,EAAE,OAAmB,EAAE,SAAgD,EAA+B,EAAE,CAAC,CAAC;IACtR,EAAE,EAAE,OAAO,EAAE,YAAY;IACzB,IAAI,EAAE,OAAO;IACb,OAAO;IACP,GAAG,SAAS;CACb,CAAC,CAAC;AAEH,kDAAkD;AACpC,8CAAe,GAAG,CAAC,EAAU,EAAE,OAAyB,EAAE,YAAoB,EAAE,IAAqC,EAAE,KAAsC,EAAE,SAAS,GAAG,kBAAkB,CAAC,KAAK,EAAE,SAA+C,EAA8B,EAAE,CAAC,CAAC;IAClS,EAAE,EAAE,OAAO,EAAE,YAAY;IACzB,IAAI,EAAE,KAAK;IACX,SAAS;IACT,GAAG,SAAS;CACb,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module StatusBar\r\n */\r\n\r\nimport { BadgeType } from \"../items/BadgeType\";\r\nimport { ConditionalBooleanValue } from \"../items/ConditionalBooleanValue\";\r\nimport { ConditionalStringValue } from \"../items/ConditionalStringValue\";\r\nimport { ProvidedItem } from \"../items/ProvidedItem\";\r\n\r\n/** Status bar Groups/Sections from Left to Right\r\n * @deprecated in 3.6. Use [StatusBarSection]($appui-react) instead.\r\n * @public\r\n */\r\nexport enum StatusBarSection {\r\n /** area for tool assistance and messages */\r\n Message = 0,\r\n /** area for tool assistance and messages */\r\n Left = 0, // eslint-disable-line @typescript-eslint/no-duplicate-enum-values\r\n /** items specific to stage/task */\r\n Stage = 1,\r\n /** items specific to stage/task */\r\n Center = 1, // eslint-disable-line @typescript-eslint/no-duplicate-enum-values\r\n /** Select scope and selection info */\r\n Selection = 2,\r\n /** Select scope and selection info */\r\n Right = 2, // eslint-disable-line @typescript-eslint/no-duplicate-enum-values\r\n /** items that only show based on context */\r\n Context = 3,\r\n}\r\n\r\n/** Defines which side of Icon where label is placed\r\n * @deprecated in 3.6. Use [StatusBarLabelSide]($appui-react) instead.\r\n * @public\r\n */\r\nexport enum StatusBarLabelSide {\r\n /** Label is placed left side of icon. This is the default if not specified */\r\n Left,\r\n /** Label is placed on right side of icon. */\r\n Right,\r\n}\r\n\r\n/** Type for StatusBar Item Id\r\n * @deprecated in 3.6. Please use `CommonStatusBarItem[\"id\"]` from @itwin/appui-react.\r\n * @public\r\n */\r\nexport type StatusBarItemId = CommonStatusBarItem[\"id\"];\r\n\r\n/** Describes the data needed to insert a button into the status bar.\r\n * @deprecated in 3.6. Use [CommonStatusBarItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport interface AbstractStatusBarItem extends ProvidedItem { // eslint-disable-line @typescript-eslint/no-deprecated\r\n /** can be used by application to store miscellaneous data. */\r\n applicationData?: any;\r\n /** Describes badge. Renders no badge if not specified. */\r\n readonly badgeType?: BadgeType;\r\n /** Required unique id of the item. To ensure uniqueness it is suggested that a namespace prefix of the extension name be used. */\r\n readonly id: string;\r\n /** optional data to used by item implementor. */\r\n readonly internalData?: Map<string, any>;\r\n /** Describes if the item is visible or hidden. The default is for the item to be visible. */\r\n readonly isHidden?: boolean | ConditionalBooleanValue;\r\n /** Describes if the item is enabled or disabled. The default is for the item to be enabled. */\r\n readonly isDisabled?: boolean | ConditionalBooleanValue;\r\n /** Priority within a section (recommend using values 1 through 100). */\r\n readonly itemPriority: number;\r\n /** status bar section */\r\n readonly section: StatusBarSection; // eslint-disable-line @typescript-eslint/no-deprecated\r\n}\r\n\r\n/** Describes the data needed to insert an action item into the status bar.\r\n * @deprecated in 3.6. Use [StatusBarActionItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport interface AbstractStatusBarActionItem extends AbstractStatusBarItem { // eslint-disable-line @typescript-eslint/no-deprecated\r\n /** method to execute when icon is pressed */\r\n readonly execute: () => void;\r\n /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix to imported symbol Id. */\r\n readonly icon?: string | ConditionalStringValue;\r\n /** Label. */\r\n readonly label?: string | ConditionalStringValue;\r\n /** tooltip. */\r\n readonly tooltip?: string | ConditionalStringValue;\r\n}\r\n\r\n/** Describes the data needed to insert a label item with an optional icon into the status bar.\r\n * @deprecated in 3.6. Use [StatusBarLabelItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport interface AbstractStatusBarLabelItem extends AbstractStatusBarItem { // eslint-disable-line @typescript-eslint/no-deprecated\r\n /** Name of icon WebFont entry or if specifying an imported SVG symbol use \"webSvg:\" prefix to imported symbol Id. */\r\n readonly icon?: string | ConditionalStringValue;\r\n /** Label. */\r\n readonly label: string | ConditionalStringValue;\r\n /** Defines which side of icon to display label if icon is defined. */\r\n readonly labelSide?: StatusBarLabelSide; // eslint-disable-line @typescript-eslint/no-deprecated\r\n}\r\n\r\n/** Describes the data needed to insert a custom item into the status bar. This is used to allow extension\r\n * implementer to create a framework specific component.\r\n * @deprecated in 3.6. Use [StatusBarCustomItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport interface AbstractStatusBarCustomItem extends AbstractStatusBarItem { // eslint-disable-line @typescript-eslint/no-deprecated\r\n readonly isCustom: true;\r\n}\r\n\r\n/** Describes the data needed to insert a button into the status bar.\r\n * @deprecated in 3.6. Use [StatusBarItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport type CommonStatusBarItem = AbstractStatusBarActionItem | AbstractStatusBarLabelItem | AbstractStatusBarCustomItem; // eslint-disable-line @typescript-eslint/no-deprecated\r\n\r\n/** AbstractStatusBarActionItem type guard.\r\n * @deprecated in 3.6. Use [isStatusBarActionItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport const isAbstractStatusBarActionItem = (item: CommonStatusBarItem): item is AbstractStatusBarActionItem => { // eslint-disable-line @typescript-eslint/no-deprecated\r\n return (item as AbstractStatusBarActionItem).execute !== undefined; // eslint-disable-line @typescript-eslint/no-deprecated\r\n};\r\n\r\n/** AbstractStatusBarLabelItem type guard.\r\n * @deprecated in 3.6. Use [isStatusBarLabelItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport const isAbstractStatusBarLabelItem = (item: CommonStatusBarItem): item is AbstractStatusBarLabelItem => { // eslint-disable-line @typescript-eslint/no-deprecated\r\n return (item as AbstractStatusBarLabelItem).label !== undefined && (item as AbstractStatusBarActionItem).execute === undefined; // eslint-disable-line @typescript-eslint/no-deprecated\r\n};\r\n\r\n/** AbstractStatusBarCustomItem type guard.\r\n * @deprecated in 3.6. Use [isStatusBarCustomItem]($appui-react) instead.\r\n * @public\r\n */\r\nexport const isAbstractStatusBarCustomItem = (item: CommonStatusBarItem): item is AbstractStatusBarCustomItem => { // eslint-disable-line @typescript-eslint/no-deprecated\r\n return !!(item as AbstractStatusBarCustomItem).isCustom; // eslint-disable-line @typescript-eslint/no-deprecated\r\n};\r\n\r\n/** Helper class to create Abstract StatusBar Item definitions.\r\n * @deprecated in 3.6. Use [StatusBarItemUtilities]($appui-react) instead.\r\n * @public\r\n */\r\nexport class AbstractStatusBarItemUtilities {\r\n /** Creates a StatusBar item to perform an action */\r\n public static createActionItem = (id: string, section: StatusBarSection, itemPriority: number, icon: string | ConditionalStringValue, tooltip: string | ConditionalStringValue, execute: () => void, overrides?: Partial<AbstractStatusBarCustomItem>): AbstractStatusBarActionItem => ({ // eslint-disable-line @typescript-eslint/no-deprecated\r\n id, section, itemPriority,\r\n icon, tooltip,\r\n execute,\r\n ...overrides,\r\n });\r\n\r\n /** Creates a StatusBar item to display a label */\r\n public static createLabelItem = (id: string, section: StatusBarSection, itemPriority: number, icon: string | ConditionalStringValue, label: string | ConditionalStringValue, labelSide = StatusBarLabelSide.Right, overrides?: Partial<AbstractStatusBarLabelItem>): AbstractStatusBarLabelItem => ({ // eslint-disable-line @typescript-eslint/no-deprecated\r\n id, section, itemPriority,\r\n icon, label,\r\n labelSide,\r\n ...overrides,\r\n });\r\n}\r\n"]}
|
@@ -1,40 +0,0 @@
|
|
1
|
-
/** @packageDocumentation
|
2
|
-
* @module StatusBar
|
3
|
-
*/
|
4
|
-
import { BeEvent } from "@itwin/core-bentley";
|
5
|
-
import { CommonStatusBarItem, StatusBarItemId } from "./StatusBarItem";
|
6
|
-
/** Arguments of [[StatusBarItemsManager.onChanged]] event.
|
7
|
-
* @internal
|
8
|
-
*/
|
9
|
-
export interface StatusBarItemsChangedArgs {
|
10
|
-
readonly items: ReadonlyArray<CommonStatusBarItem>;
|
11
|
-
}
|
12
|
-
/**
|
13
|
-
* Controls status bar items.
|
14
|
-
* @internal
|
15
|
-
*/
|
16
|
-
export declare class StatusBarItemsManager {
|
17
|
-
private _items;
|
18
|
-
constructor(items?: ReadonlyArray<CommonStatusBarItem>);
|
19
|
-
/** Event raised when StatusBar items are changed.
|
20
|
-
* @internal
|
21
|
-
*/
|
22
|
-
readonly onItemsChanged: BeEvent<(args: StatusBarItemsChangedArgs) => void>;
|
23
|
-
private loadItemsInternal;
|
24
|
-
/** load items but do not fire onItemsChanged
|
25
|
-
* @internal
|
26
|
-
*/
|
27
|
-
loadItems(items: ReadonlyArray<CommonStatusBarItem>): void;
|
28
|
-
/** Get an array of the StatusBar items */
|
29
|
-
get items(): ReadonlyArray<CommonStatusBarItem>;
|
30
|
-
set items(items: ReadonlyArray<CommonStatusBarItem>);
|
31
|
-
add(itemOrItems: CommonStatusBarItem | ReadonlyArray<CommonStatusBarItem>): void;
|
32
|
-
/** Remove StatusBar items based on id */
|
33
|
-
remove(itemIdOrItemIds: StatusBarItemId | ReadonlyArray<StatusBarItemId>): void;
|
34
|
-
/** @internal */
|
35
|
-
removeAll(): void;
|
36
|
-
static getSyncIdsOfInterest(items: readonly CommonStatusBarItem[]): string[];
|
37
|
-
private internalRefreshAffectedItems;
|
38
|
-
refreshAffectedItems(eventIds: Set<string>): void;
|
39
|
-
}
|
40
|
-
//# sourceMappingURL=StatusBarItemsManager.d.ts.map
|
@@ -1 +0,0 @@
|
|
1
|
-
{"version":3,"file":"StatusBarItemsManager.d.ts","sourceRoot":"","sources":["../../../../src/appui-abstract/statusbar/StatusBarItemsManager.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAG9C,OAAO,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAUvE;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC,mBAAmB,CAAC,CAAC;CACpD;AAED;;;GAGG;AACH,qBAAa,qBAAqB;IAChC,OAAO,CAAC,MAAM,CAA0C;gBAE5C,KAAK,CAAC,EAAE,aAAa,CAAC,mBAAmB,CAAC;IAKtD;;OAEG;IACH,SAAgB,cAAc,iBAAsB,yBAAyB,KAAK,IAAI,EAAI;IAE1F,OAAO,CAAC,iBAAiB;IAiBzB;;OAEG;IACI,SAAS,CAAC,KAAK,EAAE,aAAa,CAAC,mBAAmB,CAAC;IAI1D,2CAA2C;IAC3C,IAAW,KAAK,IAAI,aAAa,CAAC,mBAAmB,CAAC,CAErD;IAED,IAAW,KAAK,CAAC,KAAK,EAAE,aAAa,CAAC,mBAAmB,CAAC,EAIzD;IAEM,GAAG,CAAC,WAAW,EAAE,mBAAmB,GAAG,aAAa,CAAC,mBAAmB,CAAC;IAiBhF,yCAAyC;IAClC,MAAM,CAAC,eAAe,EAAE,eAAe,GAAG,aAAa,CAAC,eAAe,CAC7E;IAOD,gBAAgB;IACT,SAAS;WAIF,oBAAoB,CAAC,KAAK,EAAE,SAAS,mBAAmB,EAAE,GAAG,MAAM,EAAE;IAcnF,OAAO,CAAC,4BAA4B;IA6B7B,oBAAoB,CAAC,QAAQ,EAAE,GAAG,CAAC,MAAM,CAAC;CAWlD"}
|