@openfin/node-adapter 35.78.14 → 35.78.16
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/out/node-adapter-alpha.d.ts +40 -23
- package/out/node-adapter-beta.d.ts +40 -23
- package/out/node-adapter-public.d.ts +40 -23
- package/out/node-adapter.d.ts +55 -126
- package/out/node-adapter.js +15 -117
- package/package.json +1 -1
@@ -43,6 +43,8 @@ declare type Accelerator = {
|
|
43
43
|
};
|
44
44
|
|
45
45
|
/**
|
46
|
+
* Options to use when adding a view to a {@link TabStack}.
|
47
|
+
*
|
46
48
|
* @interface
|
47
49
|
*/
|
48
50
|
declare type AddViewOptions = CreateViewTarget & {
|
@@ -927,6 +929,7 @@ declare namespace ApplicationEvents {
|
|
927
929
|
RespondingEvent,
|
928
930
|
StartedEvent,
|
929
931
|
ApplicationSourcedEvent,
|
932
|
+
ApplicationSourcedEventType,
|
930
933
|
Event_3 as Event,
|
931
934
|
ApplicationEvent,
|
932
935
|
EventType_3 as EventType,
|
@@ -1299,6 +1302,11 @@ declare type ApplicationPermissions = {
|
|
1299
1302
|
*/
|
1300
1303
|
declare type ApplicationSourcedEvent = ClosedEvent | ConnectedEvent_2 | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent_2 | StartedEvent | TrayIconClickedEvent | FileDownloadLocationChangedEvent;
|
1301
1304
|
|
1305
|
+
/**
|
1306
|
+
* Union of possible type values for an {@link ApplicationSourcedEvent}.
|
1307
|
+
*/
|
1308
|
+
declare type ApplicationSourcedEventType = ApplicationSourcedEvent['type'];
|
1309
|
+
|
1302
1310
|
declare type ApplicationState = OpenFin.ApplicationState;
|
1303
1311
|
|
1304
1312
|
/**
|
@@ -4458,7 +4466,7 @@ declare type CreateViewPayload = {
|
|
4458
4466
|
/**
|
4459
4467
|
* @interface
|
4460
4468
|
*/
|
4461
|
-
declare type CreateViewTarget = LayoutIdentity & {
|
4469
|
+
declare type CreateViewTarget = (Identity_5 | LayoutIdentity) & {
|
4462
4470
|
/**
|
4463
4471
|
* If specified, view creation will not attach to a window and caller must
|
4464
4472
|
* insert the view into the layout explicitly
|
@@ -5291,7 +5299,7 @@ declare type EventType_7 = Event_10['type'];
|
|
5291
5299
|
/**
|
5292
5300
|
* Union of possible `type` values for a {@link SystemEvent}.
|
5293
5301
|
*/
|
5294
|
-
declare type EventType_8 =
|
5302
|
+
declare type EventType_8 = Event_11['type'];
|
5295
5303
|
|
5296
5304
|
/* Excluded from this release type: EventWithId */
|
5297
5305
|
|
@@ -8627,7 +8635,7 @@ declare type LaunchIntoPlatformPayload = {
|
|
8627
8635
|
declare class Layout extends Base {
|
8628
8636
|
#private;
|
8629
8637
|
/* Excluded from this release type: init */
|
8630
|
-
identity: OpenFin.LayoutIdentity;
|
8638
|
+
identity: OpenFin.Identity | OpenFin.LayoutIdentity;
|
8631
8639
|
private platform;
|
8632
8640
|
wire: Transport;
|
8633
8641
|
/* Excluded from this release type: __constructor */
|
@@ -8843,10 +8851,9 @@ declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'r
|
|
8843
8851
|
*/
|
8844
8852
|
declare type LayoutIdentity = Identity_5 & {
|
8845
8853
|
/**
|
8846
|
-
* The name of the layout
|
8847
|
-
* OpenFin attempts to resolve the instance via visibility checks.
|
8854
|
+
* The name of the layout in a given window.
|
8848
8855
|
*/
|
8849
|
-
layoutName
|
8856
|
+
layoutName: string;
|
8850
8857
|
};
|
8851
8858
|
|
8852
8859
|
/**
|
@@ -8929,6 +8936,27 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
|
|
8929
8936
|
* @returns T
|
8930
8937
|
*/
|
8931
8938
|
getLayoutSnapshot(): Promise<T>;
|
8939
|
+
/**
|
8940
|
+
* @experimental
|
8941
|
+
*
|
8942
|
+
* A hook provided to the consumer for controlling how OpenFin routes Layout API calls. Override
|
8943
|
+
* this method to control the target layout for Layout API calls.
|
8944
|
+
*
|
8945
|
+
* Example use case: You have hidden all the layouts and are showing a dialog that will
|
8946
|
+
* execute an API call (ex: Layout.replace()) - override this method and save the
|
8947
|
+
* "last visible" layout identity and return it.
|
8948
|
+
*
|
8949
|
+
* By default, OpenFin will use a series of checks to determine which Layout the API
|
8950
|
+
* call must route to in this order of precedence:
|
8951
|
+
* - try to resolve the layout from the layoutIdentity, throws if missing
|
8952
|
+
* - if there is only 1 layout, resolves that one
|
8953
|
+
* - enumerates all layouts checks visibility via element offsetTop/Left + window.innerHeight/Width
|
8954
|
+
* - returns undefined
|
8955
|
+
*
|
8956
|
+
* @param identity
|
8957
|
+
* @returns LayoutIdentity | undefined
|
8958
|
+
*/
|
8959
|
+
resolveLayoutIdentity(identity?: Identity_5 | LayoutIdentity): LayoutIdentity | undefined;
|
8932
8960
|
/**
|
8933
8961
|
* @experimental
|
8934
8962
|
*
|
@@ -9000,7 +9028,7 @@ declare class LayoutModule extends Base {
|
|
9000
9028
|
* const layoutConfig = await layout.getConfig();
|
9001
9029
|
* ```
|
9002
9030
|
*/
|
9003
|
-
wrap(identity: OpenFin.LayoutIdentity): Promise<OpenFin.Layout>;
|
9031
|
+
wrap(identity: OpenFin.Identity | OpenFin.LayoutIdentity): Promise<OpenFin.Layout>;
|
9004
9032
|
/**
|
9005
9033
|
* Synchronously returns a Layout object that represents a Window's layout.
|
9006
9034
|
*
|
@@ -9020,7 +9048,7 @@ declare class LayoutModule extends Base {
|
|
9020
9048
|
* const layoutConfig = await layout.getConfig();
|
9021
9049
|
* ```
|
9022
9050
|
*/
|
9023
|
-
wrapSync(identity: OpenFin.LayoutIdentity): OpenFin.Layout;
|
9051
|
+
wrapSync(identity: OpenFin.Identity | OpenFin.LayoutIdentity): OpenFin.Layout;
|
9024
9052
|
/**
|
9025
9053
|
* Asynchronously returns a Layout object that represents a Window's layout.
|
9026
9054
|
*
|
@@ -9188,6 +9216,9 @@ declare type LayoutOptions = {
|
|
9188
9216
|
};
|
9189
9217
|
};
|
9190
9218
|
|
9219
|
+
/**
|
9220
|
+
* Represents the position of an item in a layout relative to another.
|
9221
|
+
*/
|
9191
9222
|
declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
|
9192
9223
|
|
9193
9224
|
/**
|
@@ -12829,7 +12860,7 @@ declare type ReplaceLayoutPayload = {
|
|
12829
12860
|
/**
|
12830
12861
|
* Identity of the window whose layout will be replaced.
|
12831
12862
|
*/
|
12832
|
-
target: LayoutIdentity;
|
12863
|
+
target: Identity_5 | LayoutIdentity;
|
12833
12864
|
};
|
12834
12865
|
|
12835
12866
|
/**
|
@@ -15320,20 +15351,6 @@ declare interface TabDragListener extends EventEmitter_2 {
|
|
15320
15351
|
contentItem: ContentItem;
|
15321
15352
|
}
|
15322
15353
|
|
15323
|
-
/**
|
15324
|
-
* @typedef {string} LayoutPosition
|
15325
|
-
* @summary Represents the position of an item in a layout relative to another. Possible values are 'top', 'bottom', 'left' and 'right'.
|
15326
|
-
*/
|
15327
|
-
/**
|
15328
|
-
* @typedef {object} StackCreationOptions
|
15329
|
-
* @summary Stack creation options.
|
15330
|
-
* @property {LayoutPosition} [position] - The position to create the new {@link TabStack} in, relative to the given adjacent {@link TabStack}. Defaults to 'right'.
|
15331
|
-
*/
|
15332
|
-
/**
|
15333
|
-
* @typedef {object} TabStack~AddViewOptions
|
15334
|
-
* @summary Options to use when adding a view to a {@link TabStack}
|
15335
|
-
* @property {number} [index] - Insertion index when adding the view. Defaults to 0.
|
15336
|
-
*/
|
15337
15354
|
/**
|
15338
15355
|
* A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
|
15339
15356
|
*/
|
@@ -43,6 +43,8 @@ declare type Accelerator = {
|
|
43
43
|
};
|
44
44
|
|
45
45
|
/**
|
46
|
+
* Options to use when adding a view to a {@link TabStack}.
|
47
|
+
*
|
46
48
|
* @interface
|
47
49
|
*/
|
48
50
|
declare type AddViewOptions = CreateViewTarget & {
|
@@ -927,6 +929,7 @@ declare namespace ApplicationEvents {
|
|
927
929
|
RespondingEvent,
|
928
930
|
StartedEvent,
|
929
931
|
ApplicationSourcedEvent,
|
932
|
+
ApplicationSourcedEventType,
|
930
933
|
Event_3 as Event,
|
931
934
|
ApplicationEvent,
|
932
935
|
EventType_3 as EventType,
|
@@ -1299,6 +1302,11 @@ declare type ApplicationPermissions = {
|
|
1299
1302
|
*/
|
1300
1303
|
declare type ApplicationSourcedEvent = ClosedEvent | ConnectedEvent_2 | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent_2 | StartedEvent | TrayIconClickedEvent | FileDownloadLocationChangedEvent;
|
1301
1304
|
|
1305
|
+
/**
|
1306
|
+
* Union of possible type values for an {@link ApplicationSourcedEvent}.
|
1307
|
+
*/
|
1308
|
+
declare type ApplicationSourcedEventType = ApplicationSourcedEvent['type'];
|
1309
|
+
|
1302
1310
|
declare type ApplicationState = OpenFin.ApplicationState;
|
1303
1311
|
|
1304
1312
|
/**
|
@@ -4458,7 +4466,7 @@ declare type CreateViewPayload = {
|
|
4458
4466
|
/**
|
4459
4467
|
* @interface
|
4460
4468
|
*/
|
4461
|
-
declare type CreateViewTarget = LayoutIdentity & {
|
4469
|
+
declare type CreateViewTarget = (Identity_5 | LayoutIdentity) & {
|
4462
4470
|
/**
|
4463
4471
|
* If specified, view creation will not attach to a window and caller must
|
4464
4472
|
* insert the view into the layout explicitly
|
@@ -5291,7 +5299,7 @@ declare type EventType_7 = Event_10['type'];
|
|
5291
5299
|
/**
|
5292
5300
|
* Union of possible `type` values for a {@link SystemEvent}.
|
5293
5301
|
*/
|
5294
|
-
declare type EventType_8 =
|
5302
|
+
declare type EventType_8 = Event_11['type'];
|
5295
5303
|
|
5296
5304
|
/* Excluded from this release type: EventWithId */
|
5297
5305
|
|
@@ -8627,7 +8635,7 @@ declare type LaunchIntoPlatformPayload = {
|
|
8627
8635
|
declare class Layout extends Base {
|
8628
8636
|
#private;
|
8629
8637
|
/* Excluded from this release type: init */
|
8630
|
-
identity: OpenFin.LayoutIdentity;
|
8638
|
+
identity: OpenFin.Identity | OpenFin.LayoutIdentity;
|
8631
8639
|
private platform;
|
8632
8640
|
wire: Transport;
|
8633
8641
|
/* Excluded from this release type: __constructor */
|
@@ -8843,10 +8851,9 @@ declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'r
|
|
8843
8851
|
*/
|
8844
8852
|
declare type LayoutIdentity = Identity_5 & {
|
8845
8853
|
/**
|
8846
|
-
* The name of the layout
|
8847
|
-
* OpenFin attempts to resolve the instance via visibility checks.
|
8854
|
+
* The name of the layout in a given window.
|
8848
8855
|
*/
|
8849
|
-
layoutName
|
8856
|
+
layoutName: string;
|
8850
8857
|
};
|
8851
8858
|
|
8852
8859
|
/**
|
@@ -8929,6 +8936,27 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
|
|
8929
8936
|
* @returns T
|
8930
8937
|
*/
|
8931
8938
|
getLayoutSnapshot(): Promise<T>;
|
8939
|
+
/**
|
8940
|
+
* @experimental
|
8941
|
+
*
|
8942
|
+
* A hook provided to the consumer for controlling how OpenFin routes Layout API calls. Override
|
8943
|
+
* this method to control the target layout for Layout API calls.
|
8944
|
+
*
|
8945
|
+
* Example use case: You have hidden all the layouts and are showing a dialog that will
|
8946
|
+
* execute an API call (ex: Layout.replace()) - override this method and save the
|
8947
|
+
* "last visible" layout identity and return it.
|
8948
|
+
*
|
8949
|
+
* By default, OpenFin will use a series of checks to determine which Layout the API
|
8950
|
+
* call must route to in this order of precedence:
|
8951
|
+
* - try to resolve the layout from the layoutIdentity, throws if missing
|
8952
|
+
* - if there is only 1 layout, resolves that one
|
8953
|
+
* - enumerates all layouts checks visibility via element offsetTop/Left + window.innerHeight/Width
|
8954
|
+
* - returns undefined
|
8955
|
+
*
|
8956
|
+
* @param identity
|
8957
|
+
* @returns LayoutIdentity | undefined
|
8958
|
+
*/
|
8959
|
+
resolveLayoutIdentity(identity?: Identity_5 | LayoutIdentity): LayoutIdentity | undefined;
|
8932
8960
|
/**
|
8933
8961
|
* @experimental
|
8934
8962
|
*
|
@@ -9000,7 +9028,7 @@ declare class LayoutModule extends Base {
|
|
9000
9028
|
* const layoutConfig = await layout.getConfig();
|
9001
9029
|
* ```
|
9002
9030
|
*/
|
9003
|
-
wrap(identity: OpenFin.LayoutIdentity): Promise<OpenFin.Layout>;
|
9031
|
+
wrap(identity: OpenFin.Identity | OpenFin.LayoutIdentity): Promise<OpenFin.Layout>;
|
9004
9032
|
/**
|
9005
9033
|
* Synchronously returns a Layout object that represents a Window's layout.
|
9006
9034
|
*
|
@@ -9020,7 +9048,7 @@ declare class LayoutModule extends Base {
|
|
9020
9048
|
* const layoutConfig = await layout.getConfig();
|
9021
9049
|
* ```
|
9022
9050
|
*/
|
9023
|
-
wrapSync(identity: OpenFin.LayoutIdentity): OpenFin.Layout;
|
9051
|
+
wrapSync(identity: OpenFin.Identity | OpenFin.LayoutIdentity): OpenFin.Layout;
|
9024
9052
|
/**
|
9025
9053
|
* Asynchronously returns a Layout object that represents a Window's layout.
|
9026
9054
|
*
|
@@ -9188,6 +9216,9 @@ declare type LayoutOptions = {
|
|
9188
9216
|
};
|
9189
9217
|
};
|
9190
9218
|
|
9219
|
+
/**
|
9220
|
+
* Represents the position of an item in a layout relative to another.
|
9221
|
+
*/
|
9191
9222
|
declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
|
9192
9223
|
|
9193
9224
|
/**
|
@@ -12829,7 +12860,7 @@ declare type ReplaceLayoutPayload = {
|
|
12829
12860
|
/**
|
12830
12861
|
* Identity of the window whose layout will be replaced.
|
12831
12862
|
*/
|
12832
|
-
target: LayoutIdentity;
|
12863
|
+
target: Identity_5 | LayoutIdentity;
|
12833
12864
|
};
|
12834
12865
|
|
12835
12866
|
/**
|
@@ -15320,20 +15351,6 @@ declare interface TabDragListener extends EventEmitter_2 {
|
|
15320
15351
|
contentItem: ContentItem;
|
15321
15352
|
}
|
15322
15353
|
|
15323
|
-
/**
|
15324
|
-
* @typedef {string} LayoutPosition
|
15325
|
-
* @summary Represents the position of an item in a layout relative to another. Possible values are 'top', 'bottom', 'left' and 'right'.
|
15326
|
-
*/
|
15327
|
-
/**
|
15328
|
-
* @typedef {object} StackCreationOptions
|
15329
|
-
* @summary Stack creation options.
|
15330
|
-
* @property {LayoutPosition} [position] - The position to create the new {@link TabStack} in, relative to the given adjacent {@link TabStack}. Defaults to 'right'.
|
15331
|
-
*/
|
15332
|
-
/**
|
15333
|
-
* @typedef {object} TabStack~AddViewOptions
|
15334
|
-
* @summary Options to use when adding a view to a {@link TabStack}
|
15335
|
-
* @property {number} [index] - Insertion index when adding the view. Defaults to 0.
|
15336
|
-
*/
|
15337
15354
|
/**
|
15338
15355
|
* A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
|
15339
15356
|
*/
|
@@ -43,6 +43,8 @@ declare type Accelerator = {
|
|
43
43
|
};
|
44
44
|
|
45
45
|
/**
|
46
|
+
* Options to use when adding a view to a {@link TabStack}.
|
47
|
+
*
|
46
48
|
* @interface
|
47
49
|
*/
|
48
50
|
declare type AddViewOptions = CreateViewTarget & {
|
@@ -927,6 +929,7 @@ declare namespace ApplicationEvents {
|
|
927
929
|
RespondingEvent,
|
928
930
|
StartedEvent,
|
929
931
|
ApplicationSourcedEvent,
|
932
|
+
ApplicationSourcedEventType,
|
930
933
|
Event_3 as Event,
|
931
934
|
ApplicationEvent,
|
932
935
|
EventType_3 as EventType,
|
@@ -1299,6 +1302,11 @@ declare type ApplicationPermissions = {
|
|
1299
1302
|
*/
|
1300
1303
|
declare type ApplicationSourcedEvent = ClosedEvent | ConnectedEvent_2 | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent_2 | StartedEvent | TrayIconClickedEvent | FileDownloadLocationChangedEvent;
|
1301
1304
|
|
1305
|
+
/**
|
1306
|
+
* Union of possible type values for an {@link ApplicationSourcedEvent}.
|
1307
|
+
*/
|
1308
|
+
declare type ApplicationSourcedEventType = ApplicationSourcedEvent['type'];
|
1309
|
+
|
1302
1310
|
declare type ApplicationState = OpenFin.ApplicationState;
|
1303
1311
|
|
1304
1312
|
/**
|
@@ -4458,7 +4466,7 @@ declare type CreateViewPayload = {
|
|
4458
4466
|
/**
|
4459
4467
|
* @interface
|
4460
4468
|
*/
|
4461
|
-
declare type CreateViewTarget = LayoutIdentity & {
|
4469
|
+
declare type CreateViewTarget = (Identity_5 | LayoutIdentity) & {
|
4462
4470
|
/**
|
4463
4471
|
* If specified, view creation will not attach to a window and caller must
|
4464
4472
|
* insert the view into the layout explicitly
|
@@ -5291,7 +5299,7 @@ declare type EventType_7 = Event_10['type'];
|
|
5291
5299
|
/**
|
5292
5300
|
* Union of possible `type` values for a {@link SystemEvent}.
|
5293
5301
|
*/
|
5294
|
-
declare type EventType_8 =
|
5302
|
+
declare type EventType_8 = Event_11['type'];
|
5295
5303
|
|
5296
5304
|
/* Excluded from this release type: EventWithId */
|
5297
5305
|
|
@@ -8627,7 +8635,7 @@ declare type LaunchIntoPlatformPayload = {
|
|
8627
8635
|
declare class Layout extends Base {
|
8628
8636
|
#private;
|
8629
8637
|
/* Excluded from this release type: init */
|
8630
|
-
identity: OpenFin.LayoutIdentity;
|
8638
|
+
identity: OpenFin.Identity | OpenFin.LayoutIdentity;
|
8631
8639
|
private platform;
|
8632
8640
|
wire: Transport;
|
8633
8641
|
/* Excluded from this release type: __constructor */
|
@@ -8843,10 +8851,9 @@ declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'r
|
|
8843
8851
|
*/
|
8844
8852
|
declare type LayoutIdentity = Identity_5 & {
|
8845
8853
|
/**
|
8846
|
-
* The name of the layout
|
8847
|
-
* OpenFin attempts to resolve the instance via visibility checks.
|
8854
|
+
* The name of the layout in a given window.
|
8848
8855
|
*/
|
8849
|
-
layoutName
|
8856
|
+
layoutName: string;
|
8850
8857
|
};
|
8851
8858
|
|
8852
8859
|
/**
|
@@ -8929,6 +8936,27 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
|
|
8929
8936
|
* @returns T
|
8930
8937
|
*/
|
8931
8938
|
getLayoutSnapshot(): Promise<T>;
|
8939
|
+
/**
|
8940
|
+
* @experimental
|
8941
|
+
*
|
8942
|
+
* A hook provided to the consumer for controlling how OpenFin routes Layout API calls. Override
|
8943
|
+
* this method to control the target layout for Layout API calls.
|
8944
|
+
*
|
8945
|
+
* Example use case: You have hidden all the layouts and are showing a dialog that will
|
8946
|
+
* execute an API call (ex: Layout.replace()) - override this method and save the
|
8947
|
+
* "last visible" layout identity and return it.
|
8948
|
+
*
|
8949
|
+
* By default, OpenFin will use a series of checks to determine which Layout the API
|
8950
|
+
* call must route to in this order of precedence:
|
8951
|
+
* - try to resolve the layout from the layoutIdentity, throws if missing
|
8952
|
+
* - if there is only 1 layout, resolves that one
|
8953
|
+
* - enumerates all layouts checks visibility via element offsetTop/Left + window.innerHeight/Width
|
8954
|
+
* - returns undefined
|
8955
|
+
*
|
8956
|
+
* @param identity
|
8957
|
+
* @returns LayoutIdentity | undefined
|
8958
|
+
*/
|
8959
|
+
resolveLayoutIdentity(identity?: Identity_5 | LayoutIdentity): LayoutIdentity | undefined;
|
8932
8960
|
/**
|
8933
8961
|
* @experimental
|
8934
8962
|
*
|
@@ -9000,7 +9028,7 @@ declare class LayoutModule extends Base {
|
|
9000
9028
|
* const layoutConfig = await layout.getConfig();
|
9001
9029
|
* ```
|
9002
9030
|
*/
|
9003
|
-
wrap(identity: OpenFin.LayoutIdentity): Promise<OpenFin.Layout>;
|
9031
|
+
wrap(identity: OpenFin.Identity | OpenFin.LayoutIdentity): Promise<OpenFin.Layout>;
|
9004
9032
|
/**
|
9005
9033
|
* Synchronously returns a Layout object that represents a Window's layout.
|
9006
9034
|
*
|
@@ -9020,7 +9048,7 @@ declare class LayoutModule extends Base {
|
|
9020
9048
|
* const layoutConfig = await layout.getConfig();
|
9021
9049
|
* ```
|
9022
9050
|
*/
|
9023
|
-
wrapSync(identity: OpenFin.LayoutIdentity): OpenFin.Layout;
|
9051
|
+
wrapSync(identity: OpenFin.Identity | OpenFin.LayoutIdentity): OpenFin.Layout;
|
9024
9052
|
/**
|
9025
9053
|
* Asynchronously returns a Layout object that represents a Window's layout.
|
9026
9054
|
*
|
@@ -9188,6 +9216,9 @@ declare type LayoutOptions = {
|
|
9188
9216
|
};
|
9189
9217
|
};
|
9190
9218
|
|
9219
|
+
/**
|
9220
|
+
* Represents the position of an item in a layout relative to another.
|
9221
|
+
*/
|
9191
9222
|
declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
|
9192
9223
|
|
9193
9224
|
/**
|
@@ -12829,7 +12860,7 @@ declare type ReplaceLayoutPayload = {
|
|
12829
12860
|
/**
|
12830
12861
|
* Identity of the window whose layout will be replaced.
|
12831
12862
|
*/
|
12832
|
-
target: LayoutIdentity;
|
12863
|
+
target: Identity_5 | LayoutIdentity;
|
12833
12864
|
};
|
12834
12865
|
|
12835
12866
|
/**
|
@@ -15320,20 +15351,6 @@ declare interface TabDragListener extends EventEmitter_2 {
|
|
15320
15351
|
contentItem: ContentItem;
|
15321
15352
|
}
|
15322
15353
|
|
15323
|
-
/**
|
15324
|
-
* @typedef {string} LayoutPosition
|
15325
|
-
* @summary Represents the position of an item in a layout relative to another. Possible values are 'top', 'bottom', 'left' and 'right'.
|
15326
|
-
*/
|
15327
|
-
/**
|
15328
|
-
* @typedef {object} StackCreationOptions
|
15329
|
-
* @summary Stack creation options.
|
15330
|
-
* @property {LayoutPosition} [position] - The position to create the new {@link TabStack} in, relative to the given adjacent {@link TabStack}. Defaults to 'right'.
|
15331
|
-
*/
|
15332
|
-
/**
|
15333
|
-
* @typedef {object} TabStack~AddViewOptions
|
15334
|
-
* @summary Options to use when adding a view to a {@link TabStack}
|
15335
|
-
* @property {number} [index] - Insertion index when adding the view. Defaults to 0.
|
15336
|
-
*/
|
15337
15354
|
/**
|
15338
15355
|
* A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
|
15339
15356
|
*/
|
package/out/node-adapter.d.ts
CHANGED
@@ -43,6 +43,8 @@ declare type Accelerator = {
|
|
43
43
|
};
|
44
44
|
|
45
45
|
/**
|
46
|
+
* Options to use when adding a view to a {@link TabStack}.
|
47
|
+
*
|
46
48
|
* @interface
|
47
49
|
*/
|
48
50
|
declare type AddViewOptions = CreateViewTarget & {
|
@@ -933,6 +935,7 @@ declare namespace ApplicationEvents {
|
|
933
935
|
RespondingEvent,
|
934
936
|
StartedEvent,
|
935
937
|
ApplicationSourcedEvent,
|
938
|
+
ApplicationSourcedEventType,
|
936
939
|
Event_3 as Event,
|
937
940
|
ApplicationEvent,
|
938
941
|
EventType_3 as EventType,
|
@@ -1305,6 +1308,11 @@ declare type ApplicationPermissions = {
|
|
1305
1308
|
*/
|
1306
1309
|
declare type ApplicationSourcedEvent = ClosedEvent | ConnectedEvent_2 | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent_2 | StartedEvent | TrayIconClickedEvent | FileDownloadLocationChangedEvent;
|
1307
1310
|
|
1311
|
+
/**
|
1312
|
+
* Union of possible type values for an {@link ApplicationSourcedEvent}.
|
1313
|
+
*/
|
1314
|
+
declare type ApplicationSourcedEventType = ApplicationSourcedEvent['type'];
|
1315
|
+
|
1308
1316
|
declare type ApplicationState = OpenFin.ApplicationState;
|
1309
1317
|
|
1310
1318
|
/**
|
@@ -3411,57 +3419,6 @@ declare type ClosingEvent = BaseEvent_5 & {
|
|
3411
3419
|
*/
|
3412
3420
|
declare class ColumnOrRow extends LayoutNode {
|
3413
3421
|
#private;
|
3414
|
-
/**
|
3415
|
-
* Determines if this {@link ColumnOrRow} is the top level content item in the current layout.
|
3416
|
-
* @function isRoot
|
3417
|
-
* @memberof ColumnOrRow
|
3418
|
-
* @instance
|
3419
|
-
* @tutorial ColumnOrRow.isRoot
|
3420
|
-
* @returns Resolves true if this TabStack is the top level content item, or false if it is not.
|
3421
|
-
*/
|
3422
|
-
/**
|
3423
|
-
* Determines if this {@link ColumnOrRow} exists.
|
3424
|
-
* @function exists
|
3425
|
-
* @instance
|
3426
|
-
* @memberof ColumnOrRow
|
3427
|
-
* @tutorial ColumnOrRow.exists
|
3428
|
-
* @returns Resolves true if the TabStack exists, or false if it has been destroyed.
|
3429
|
-
*/
|
3430
|
-
/**
|
3431
|
-
* Retrieves the parent {@link ColumnOrRow} of this {@link ColumnOrRow}, if one exists.
|
3432
|
-
* @function getParent
|
3433
|
-
* @instance
|
3434
|
-
* @memberof ColumnOrRow
|
3435
|
-
* @tutorial ColumnOrRow.getParent
|
3436
|
-
* @returns Promise resolving with the {@link ColumnOrRow} that contains this item, or undefined if
|
3437
|
-
* this {@link ColumnOrRow}does not exist or is the root content item.
|
3438
|
-
*/
|
3439
|
-
/**
|
3440
|
-
* Returns all the adjacent stacks that share an edge with the given {@link ColumnOrRow}.
|
3441
|
-
* @function getAdjacentStacks
|
3442
|
-
* @instance
|
3443
|
-
* @memberof ColumnOrRow
|
3444
|
-
* @param {LayoutPosition} edge - Edge to check for any adjacent stacks.
|
3445
|
-
*
|
3446
|
-
* @tutorial ColumnOrRow.getAdjacentStacks
|
3447
|
-
*/
|
3448
|
-
/**
|
3449
|
-
* Given a list of view creation options or references and a layout position, creates a {@link TabStack} adjacent to the given {@link ColumnOrRow}
|
3450
|
-
*
|
3451
|
-
* Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
|
3452
|
-
* during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
|
3453
|
-
* This means the views you pass to createAdjacentStack() may not render in the order given by the array.
|
3454
|
-
* Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
|
3455
|
-
*
|
3456
|
-
* @function createAdjacentStack
|
3457
|
-
* @instance
|
3458
|
-
* @memberof ColumnOrRow
|
3459
|
-
* @param views - List of identities or view creation options of the views to include in the stack
|
3460
|
-
* @param options - Creation options.
|
3461
|
-
* @returns The created TabStack
|
3462
|
-
* @tutorial ColumnOrRow.createAdjacentStack
|
3463
|
-
* @experimental
|
3464
|
-
*/
|
3465
3422
|
/**
|
3466
3423
|
* @internal
|
3467
3424
|
*/
|
@@ -4552,7 +4509,7 @@ declare type CreateViewPayload = {
|
|
4552
4509
|
/**
|
4553
4510
|
* @interface
|
4554
4511
|
*/
|
4555
|
-
declare type CreateViewTarget = LayoutIdentity & {
|
4512
|
+
declare type CreateViewTarget = (Identity_5 | LayoutIdentity) & {
|
4556
4513
|
/**
|
4557
4514
|
* If specified, view creation will not attach to a window and caller must
|
4558
4515
|
* insert the view into the layout explicitly
|
@@ -5390,7 +5347,7 @@ declare type EventType_7 = Event_10['type'];
|
|
5390
5347
|
/**
|
5391
5348
|
* Union of possible `type` values for a {@link SystemEvent}.
|
5392
5349
|
*/
|
5393
|
-
declare type EventType_8 =
|
5350
|
+
declare type EventType_8 = Event_11['type'];
|
5394
5351
|
|
5395
5352
|
/**
|
5396
5353
|
* @internal
|
@@ -8799,7 +8756,7 @@ declare class Layout extends Base {
|
|
8799
8756
|
* @internal
|
8800
8757
|
*/
|
8801
8758
|
init: (options?: OpenFin.InitLayoutOptions) => Promise<Layout>;
|
8802
|
-
identity: OpenFin.LayoutIdentity;
|
8759
|
+
identity: OpenFin.Identity | OpenFin.LayoutIdentity;
|
8803
8760
|
private platform;
|
8804
8761
|
wire: Transport;
|
8805
8762
|
/**
|
@@ -9018,10 +8975,9 @@ declare type LayoutEntityTypes = Exclude<GoldenLayout.ItemType, 'component' | 'r
|
|
9018
8975
|
*/
|
9019
8976
|
declare type LayoutIdentity = Identity_5 & {
|
9020
8977
|
/**
|
9021
|
-
* The name of the layout
|
9022
|
-
* OpenFin attempts to resolve the instance via visibility checks.
|
8978
|
+
* The name of the layout in a given window.
|
9023
8979
|
*/
|
9024
|
-
layoutName
|
8980
|
+
layoutName: string;
|
9025
8981
|
};
|
9026
8982
|
|
9027
8983
|
/**
|
@@ -9104,6 +9060,27 @@ declare interface LayoutManager<T extends LayoutSnapshot> {
|
|
9104
9060
|
* @returns T
|
9105
9061
|
*/
|
9106
9062
|
getLayoutSnapshot(): Promise<T>;
|
9063
|
+
/**
|
9064
|
+
* @experimental
|
9065
|
+
*
|
9066
|
+
* A hook provided to the consumer for controlling how OpenFin routes Layout API calls. Override
|
9067
|
+
* this method to control the target layout for Layout API calls.
|
9068
|
+
*
|
9069
|
+
* Example use case: You have hidden all the layouts and are showing a dialog that will
|
9070
|
+
* execute an API call (ex: Layout.replace()) - override this method and save the
|
9071
|
+
* "last visible" layout identity and return it.
|
9072
|
+
*
|
9073
|
+
* By default, OpenFin will use a series of checks to determine which Layout the API
|
9074
|
+
* call must route to in this order of precedence:
|
9075
|
+
* - try to resolve the layout from the layoutIdentity, throws if missing
|
9076
|
+
* - if there is only 1 layout, resolves that one
|
9077
|
+
* - enumerates all layouts checks visibility via element offsetTop/Left + window.innerHeight/Width
|
9078
|
+
* - returns undefined
|
9079
|
+
*
|
9080
|
+
* @param identity
|
9081
|
+
* @returns LayoutIdentity | undefined
|
9082
|
+
*/
|
9083
|
+
resolveLayoutIdentity(identity?: Identity_5 | LayoutIdentity): LayoutIdentity | undefined;
|
9107
9084
|
/**
|
9108
9085
|
* @experimental
|
9109
9086
|
*
|
@@ -9175,7 +9152,7 @@ declare class LayoutModule extends Base {
|
|
9175
9152
|
* const layoutConfig = await layout.getConfig();
|
9176
9153
|
* ```
|
9177
9154
|
*/
|
9178
|
-
wrap(identity: OpenFin.LayoutIdentity): Promise<OpenFin.Layout>;
|
9155
|
+
wrap(identity: OpenFin.Identity | OpenFin.LayoutIdentity): Promise<OpenFin.Layout>;
|
9179
9156
|
/**
|
9180
9157
|
* Synchronously returns a Layout object that represents a Window's layout.
|
9181
9158
|
*
|
@@ -9195,7 +9172,7 @@ declare class LayoutModule extends Base {
|
|
9195
9172
|
* const layoutConfig = await layout.getConfig();
|
9196
9173
|
* ```
|
9197
9174
|
*/
|
9198
|
-
wrapSync(identity: OpenFin.LayoutIdentity): OpenFin.Layout;
|
9175
|
+
wrapSync(identity: OpenFin.Identity | OpenFin.LayoutIdentity): OpenFin.Layout;
|
9199
9176
|
/**
|
9200
9177
|
* Asynchronously returns a Layout object that represents a Window's layout.
|
9201
9178
|
*
|
@@ -9367,6 +9344,15 @@ declare abstract class LayoutNode {
|
|
9367
9344
|
/**
|
9368
9345
|
* Creates a new TabStack adjacent to the given TabStack or ColumnOrRow. Inputs can be new views to create, or existing views.
|
9369
9346
|
*
|
9347
|
+
* Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
|
9348
|
+
* during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
|
9349
|
+
* This means the views you pass to createAdjacentStack() may not render in the order given by the array.
|
9350
|
+
* Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
|
9351
|
+
*
|
9352
|
+
* @param views The views that will populate the new TabStack.
|
9353
|
+
* @param options Additional options that control new TabStack creation.
|
9354
|
+
* @returns The newly-created TabStack.
|
9355
|
+
*
|
9370
9356
|
* @example
|
9371
9357
|
* ```js
|
9372
9358
|
* if (!fin.me.isView) {
|
@@ -9401,12 +9387,15 @@ declare abstract class LayoutNode {
|
|
9401
9387
|
* console.log(`A new TabStack created to the right has ${newStack.length} views in it`);
|
9402
9388
|
*
|
9403
9389
|
* ```
|
9390
|
+
* @experimental
|
9404
9391
|
*/
|
9405
9392
|
createAdjacentStack: (views: OpenFin.PlatformViewCreationOptions[], options: {
|
9406
9393
|
position?: OpenFin.LayoutPosition;
|
9407
9394
|
}) => Promise<TabStack>;
|
9408
9395
|
/**
|
9409
|
-
* Retrieves the adjacent TabStacks of the given TabStack or ColumnOrRow
|
9396
|
+
* Retrieves the adjacent TabStacks of the given TabStack or ColumnOrRow.
|
9397
|
+
*
|
9398
|
+
* @param edge Edge whose adjacent TabStacks will be returned.
|
9410
9399
|
*
|
9411
9400
|
* @example
|
9412
9401
|
* ```js
|
@@ -9426,6 +9415,7 @@ declare abstract class LayoutNode {
|
|
9426
9415
|
* console.log(`The entity has ${rightStacks.length} stacks to the right, and ${leftStacks.length} stacks to the left`);
|
9427
9416
|
*
|
9428
9417
|
* ```
|
9418
|
+
* @experimental
|
9429
9419
|
*/
|
9430
9420
|
getAdjacentStacks: (edge: OpenFin.LayoutPosition) => Promise<TabStack[]>;
|
9431
9421
|
}
|
@@ -9520,6 +9510,9 @@ declare type LayoutOptions = {
|
|
9520
9510
|
};
|
9521
9511
|
};
|
9522
9512
|
|
9513
|
+
/**
|
9514
|
+
* Represents the position of an item in a layout relative to another.
|
9515
|
+
*/
|
9523
9516
|
declare type LayoutPosition = 'top' | 'bottom' | 'left' | 'right';
|
9524
9517
|
|
9525
9518
|
/**
|
@@ -10332,7 +10325,7 @@ declare type NotCloseRequested<EventType extends string> = Exclude<EventType, 'c
|
|
10332
10325
|
*
|
10333
10326
|
* Ensures that an event type key doesn't include any `-requested` events. Distributes over unions.
|
10334
10327
|
*/
|
10335
|
-
declare type NotRequested<EventType extends String> = EventType extends `${
|
10328
|
+
declare type NotRequested<EventType extends String> = EventType extends `${string}-requested` ? never : EventType;
|
10336
10329
|
|
10337
10330
|
/**
|
10338
10331
|
* Generated when an application is not responding.
|
@@ -13272,7 +13265,7 @@ declare type ReplaceLayoutPayload = {
|
|
13272
13265
|
/**
|
13273
13266
|
* Identity of the window whose layout will be replaced.
|
13274
13267
|
*/
|
13275
|
-
target: LayoutIdentity;
|
13268
|
+
target: Identity_5 | LayoutIdentity;
|
13276
13269
|
};
|
13277
13270
|
|
13278
13271
|
/**
|
@@ -15775,75 +15768,11 @@ declare interface TabDragListener extends EventEmitter_2 {
|
|
15775
15768
|
contentItem: ContentItem;
|
15776
15769
|
}
|
15777
15770
|
|
15778
|
-
/**
|
15779
|
-
* @typedef {string} LayoutPosition
|
15780
|
-
* @summary Represents the position of an item in a layout relative to another. Possible values are 'top', 'bottom', 'left' and 'right'.
|
15781
|
-
*/
|
15782
|
-
/**
|
15783
|
-
* @typedef {object} StackCreationOptions
|
15784
|
-
* @summary Stack creation options.
|
15785
|
-
* @property {LayoutPosition} [position] - The position to create the new {@link TabStack} in, relative to the given adjacent {@link TabStack}. Defaults to 'right'.
|
15786
|
-
*/
|
15787
|
-
/**
|
15788
|
-
* @typedef {object} TabStack~AddViewOptions
|
15789
|
-
* @summary Options to use when adding a view to a {@link TabStack}
|
15790
|
-
* @property {number} [index] - Insertion index when adding the view. Defaults to 0.
|
15791
|
-
*/
|
15792
15771
|
/**
|
15793
15772
|
* A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
|
15794
15773
|
*/
|
15795
15774
|
declare class TabStack extends LayoutNode {
|
15796
15775
|
#private;
|
15797
|
-
/**
|
15798
|
-
* Determines if this {@link TabStack} is the top level content item in the current layout.
|
15799
|
-
* @function isRoot
|
15800
|
-
* @memberof TabStack
|
15801
|
-
* @instance
|
15802
|
-
* @tutorial TabStack.isRoot
|
15803
|
-
* @returns Resolves true if this TabStack is the top level content item, or false if it is not.
|
15804
|
-
*/
|
15805
|
-
/**
|
15806
|
-
* Determines if this {@link TabStack} exists.
|
15807
|
-
* @function exists
|
15808
|
-
* @instance
|
15809
|
-
* @memberof TabStack
|
15810
|
-
* @tutorial TabStack.exists
|
15811
|
-
* @returns Resolves true if this is the TabStack exists, or false if it has been destroyed.
|
15812
|
-
*/
|
15813
|
-
/**
|
15814
|
-
* Retrieves the parent {@link ColumnOrRow} of this {@link TabStack}, if one exists.
|
15815
|
-
* @function getParent
|
15816
|
-
* @instance
|
15817
|
-
* @memberof TabStack
|
15818
|
-
* @tutorial TabStack.getParent
|
15819
|
-
* @returns is the root content item or does not exist.
|
15820
|
-
*/
|
15821
|
-
/**
|
15822
|
-
* Returns all the adjacent stacks that share an edge with the given {@link TabStack}.
|
15823
|
-
* @function getAdjacentStacks
|
15824
|
-
* @instance
|
15825
|
-
* @memberof TabStack
|
15826
|
-
* @param {LayoutPosition} edge - Edge to check for any adjacent stacks.
|
15827
|
-
*
|
15828
|
-
* @tutorial TabStack.getAdjacentStacks
|
15829
|
-
*/
|
15830
|
-
/**
|
15831
|
-
* Given a list of view creation options or references and a layout position, creates a {@link TabStack} adjacent to the current {@link TabStack}
|
15832
|
-
*
|
15833
|
-
* Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
|
15834
|
-
* during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
|
15835
|
-
* This means the views you pass to createAdjacentStack() may not render in the order given by the array.
|
15836
|
-
* Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
|
15837
|
-
*
|
15838
|
-
* @function createAdjacentStack
|
15839
|
-
* @instance
|
15840
|
-
* @memberof TabStack
|
15841
|
-
* @param views - List of identities or view creation options of the views to include in the stack
|
15842
|
-
* @param options - Creation options.
|
15843
|
-
* @returns The created TabStack.
|
15844
|
-
* @tutorial TabStack.createAdjacentStack
|
15845
|
-
* @experimental
|
15846
|
-
*/
|
15847
15776
|
/** @internal */
|
15848
15777
|
constructor(client: LayoutEntitiesClient, entityId: string);
|
15849
15778
|
/**
|
package/out/node-adapter.js
CHANGED
@@ -1012,6 +1012,15 @@ class LayoutNode {
|
|
1012
1012
|
/**
|
1013
1013
|
* Creates a new TabStack adjacent to the given TabStack or ColumnOrRow. Inputs can be new views to create, or existing views.
|
1014
1014
|
*
|
1015
|
+
* Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
|
1016
|
+
* during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
|
1017
|
+
* This means the views you pass to createAdjacentStack() may not render in the order given by the array.
|
1018
|
+
* Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
|
1019
|
+
*
|
1020
|
+
* @param views The views that will populate the new TabStack.
|
1021
|
+
* @param options Additional options that control new TabStack creation.
|
1022
|
+
* @returns The newly-created TabStack.
|
1023
|
+
*
|
1015
1024
|
* @example
|
1016
1025
|
* ```js
|
1017
1026
|
* if (!fin.me.isView) {
|
@@ -1046,13 +1055,16 @@ class LayoutNode {
|
|
1046
1055
|
* console.log(`A new TabStack created to the right has ${newStack.length} views in it`);
|
1047
1056
|
*
|
1048
1057
|
* ```
|
1058
|
+
* @experimental
|
1049
1059
|
*/
|
1050
1060
|
this.createAdjacentStack = async (views, options) => {
|
1051
1061
|
const entityId = await __classPrivateFieldGet$e(this, _LayoutNode_client, "f").createAdjacentStack(this.entityId, views, options);
|
1052
1062
|
return LayoutNode.getEntity({ entityId, type: 'stack' }, __classPrivateFieldGet$e(this, _LayoutNode_client, "f"));
|
1053
1063
|
};
|
1054
1064
|
/**
|
1055
|
-
* Retrieves the adjacent TabStacks of the given TabStack or ColumnOrRow
|
1065
|
+
* Retrieves the adjacent TabStacks of the given TabStack or ColumnOrRow.
|
1066
|
+
*
|
1067
|
+
* @param edge Edge whose adjacent TabStacks will be returned.
|
1056
1068
|
*
|
1057
1069
|
* @example
|
1058
1070
|
* ```js
|
@@ -1072,6 +1084,7 @@ class LayoutNode {
|
|
1072
1084
|
* console.log(`The entity has ${rightStacks.length} stacks to the right, and ${leftStacks.length} stacks to the left`);
|
1073
1085
|
*
|
1074
1086
|
* ```
|
1087
|
+
* @experimental
|
1075
1088
|
*/
|
1076
1089
|
this.getAdjacentStacks = async (edge) => {
|
1077
1090
|
const adjacentStacks = await __classPrivateFieldGet$e(this, _LayoutNode_client, "f").getAdjacentStacks({
|
@@ -1115,74 +1128,10 @@ LayoutNode.getEntity = (definition, client) => {
|
|
1115
1128
|
throw new Error(`Unrecognised Layout Entity encountered ('${JSON.stringify(definition)})`);
|
1116
1129
|
}
|
1117
1130
|
};
|
1118
|
-
/**
|
1119
|
-
* @typedef {string} LayoutPosition
|
1120
|
-
* @summary Represents the position of an item in a layout relative to another. Possible values are 'top', 'bottom', 'left' and 'right'.
|
1121
|
-
*/
|
1122
|
-
/**
|
1123
|
-
* @typedef {object} StackCreationOptions
|
1124
|
-
* @summary Stack creation options.
|
1125
|
-
* @property {LayoutPosition} [position] - The position to create the new {@link TabStack} in, relative to the given adjacent {@link TabStack}. Defaults to 'right'.
|
1126
|
-
*/
|
1127
|
-
/**
|
1128
|
-
* @typedef {object} TabStack~AddViewOptions
|
1129
|
-
* @summary Options to use when adding a view to a {@link TabStack}
|
1130
|
-
* @property {number} [index] - Insertion index when adding the view. Defaults to 0.
|
1131
|
-
*/
|
1132
1131
|
/**
|
1133
1132
|
* A TabStack is used to manage the state of a stack of tabs within an OpenFin Layout.
|
1134
1133
|
*/
|
1135
1134
|
class TabStack extends LayoutNode {
|
1136
|
-
/**
|
1137
|
-
* Determines if this {@link TabStack} is the top level content item in the current layout.
|
1138
|
-
* @function isRoot
|
1139
|
-
* @memberof TabStack
|
1140
|
-
* @instance
|
1141
|
-
* @tutorial TabStack.isRoot
|
1142
|
-
* @returns Resolves true if this TabStack is the top level content item, or false if it is not.
|
1143
|
-
*/
|
1144
|
-
/**
|
1145
|
-
* Determines if this {@link TabStack} exists.
|
1146
|
-
* @function exists
|
1147
|
-
* @instance
|
1148
|
-
* @memberof TabStack
|
1149
|
-
* @tutorial TabStack.exists
|
1150
|
-
* @returns Resolves true if this is the TabStack exists, or false if it has been destroyed.
|
1151
|
-
*/
|
1152
|
-
/**
|
1153
|
-
* Retrieves the parent {@link ColumnOrRow} of this {@link TabStack}, if one exists.
|
1154
|
-
* @function getParent
|
1155
|
-
* @instance
|
1156
|
-
* @memberof TabStack
|
1157
|
-
* @tutorial TabStack.getParent
|
1158
|
-
* @returns is the root content item or does not exist.
|
1159
|
-
*/
|
1160
|
-
/**
|
1161
|
-
* Returns all the adjacent stacks that share an edge with the given {@link TabStack}.
|
1162
|
-
* @function getAdjacentStacks
|
1163
|
-
* @instance
|
1164
|
-
* @memberof TabStack
|
1165
|
-
* @param {LayoutPosition} edge - Edge to check for any adjacent stacks.
|
1166
|
-
*
|
1167
|
-
* @tutorial TabStack.getAdjacentStacks
|
1168
|
-
*/
|
1169
|
-
/**
|
1170
|
-
* Given a list of view creation options or references and a layout position, creates a {@link TabStack} adjacent to the current {@link TabStack}
|
1171
|
-
*
|
1172
|
-
* Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
|
1173
|
-
* during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
|
1174
|
-
* This means the views you pass to createAdjacentStack() may not render in the order given by the array.
|
1175
|
-
* Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
|
1176
|
-
*
|
1177
|
-
* @function createAdjacentStack
|
1178
|
-
* @instance
|
1179
|
-
* @memberof TabStack
|
1180
|
-
* @param views - List of identities or view creation options of the views to include in the stack
|
1181
|
-
* @param options - Creation options.
|
1182
|
-
* @returns The created TabStack.
|
1183
|
-
* @tutorial TabStack.createAdjacentStack
|
1184
|
-
* @experimental
|
1185
|
-
*/
|
1186
1135
|
/** @internal */
|
1187
1136
|
constructor(client, entityId) {
|
1188
1137
|
super(client, entityId);
|
@@ -1315,57 +1264,6 @@ _TabStack_client = new WeakMap();
|
|
1315
1264
|
* A ColumnOrRow is used to manage the state of Column and Rows within an OpenFin Layout.
|
1316
1265
|
*/
|
1317
1266
|
class ColumnOrRow extends LayoutNode {
|
1318
|
-
/**
|
1319
|
-
* Determines if this {@link ColumnOrRow} is the top level content item in the current layout.
|
1320
|
-
* @function isRoot
|
1321
|
-
* @memberof ColumnOrRow
|
1322
|
-
* @instance
|
1323
|
-
* @tutorial ColumnOrRow.isRoot
|
1324
|
-
* @returns Resolves true if this TabStack is the top level content item, or false if it is not.
|
1325
|
-
*/
|
1326
|
-
/**
|
1327
|
-
* Determines if this {@link ColumnOrRow} exists.
|
1328
|
-
* @function exists
|
1329
|
-
* @instance
|
1330
|
-
* @memberof ColumnOrRow
|
1331
|
-
* @tutorial ColumnOrRow.exists
|
1332
|
-
* @returns Resolves true if the TabStack exists, or false if it has been destroyed.
|
1333
|
-
*/
|
1334
|
-
/**
|
1335
|
-
* Retrieves the parent {@link ColumnOrRow} of this {@link ColumnOrRow}, if one exists.
|
1336
|
-
* @function getParent
|
1337
|
-
* @instance
|
1338
|
-
* @memberof ColumnOrRow
|
1339
|
-
* @tutorial ColumnOrRow.getParent
|
1340
|
-
* @returns Promise resolving with the {@link ColumnOrRow} that contains this item, or undefined if
|
1341
|
-
* this {@link ColumnOrRow}does not exist or is the root content item.
|
1342
|
-
*/
|
1343
|
-
/**
|
1344
|
-
* Returns all the adjacent stacks that share an edge with the given {@link ColumnOrRow}.
|
1345
|
-
* @function getAdjacentStacks
|
1346
|
-
* @instance
|
1347
|
-
* @memberof ColumnOrRow
|
1348
|
-
* @param {LayoutPosition} edge - Edge to check for any adjacent stacks.
|
1349
|
-
*
|
1350
|
-
* @tutorial ColumnOrRow.getAdjacentStacks
|
1351
|
-
*/
|
1352
|
-
/**
|
1353
|
-
* Given a list of view creation options or references and a layout position, creates a {@link TabStack} adjacent to the given {@link ColumnOrRow}
|
1354
|
-
*
|
1355
|
-
* Known Issue: If the number of views to add overflows the tab-container, the added views will be set as active
|
1356
|
-
* during each render, and then placed at the front of the tab-stack, while the underlying order of tabs will remain unchanged.
|
1357
|
-
* This means the views you pass to createAdjacentStack() may not render in the order given by the array.
|
1358
|
-
* Until fixed, this problem can be avoided only if your window is wide enough to fit creating all the views in the tabstack.
|
1359
|
-
*
|
1360
|
-
* @function createAdjacentStack
|
1361
|
-
* @instance
|
1362
|
-
* @memberof ColumnOrRow
|
1363
|
-
* @param views - List of identities or view creation options of the views to include in the stack
|
1364
|
-
* @param options - Creation options.
|
1365
|
-
* @returns The created TabStack
|
1366
|
-
* @tutorial ColumnOrRow.createAdjacentStack
|
1367
|
-
* @experimental
|
1368
|
-
*/
|
1369
1267
|
/**
|
1370
1268
|
* @internal
|
1371
1269
|
*/
|
@@ -12841,7 +12739,7 @@ class Layout extends base_1$6.Base {
|
|
12841
12739
|
// don't expose
|
12842
12740
|
});
|
12843
12741
|
const client = await __classPrivateFieldGet$5(this, _Layout_layoutClient, "f").getValue();
|
12844
|
-
const root = await client.getRoot(this.identity);
|
12742
|
+
const root = await client.getRoot('layoutName' in this.identity ? this.identity : undefined);
|
12845
12743
|
return layout_entities_1.LayoutNode.getEntity(root, client);
|
12846
12744
|
}
|
12847
12745
|
}
|