@openfin/node-adapter 36.79.13 → 36.79.15

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.
@@ -4470,6 +4470,32 @@ declare type CreateLayoutOptions = {
4470
4470
  container: HTMLElement;
4471
4471
  layoutName: string;
4472
4472
  layout: LayoutOptions;
4473
+ /**
4474
+ * @defaultValue 'default'
4475
+ *
4476
+ * Controls the View behavior for the given `layout` property. Note
4477
+ * that the selected behavior only applies to unnamed Views or
4478
+ * Views with the prefix `internal-generated-`. In all cases, if any
4479
+ * View in the `layout` does not already exist, it will be created
4480
+ * with a name that starts with `internal-generated-`.
4481
+ *
4482
+ * When set to `reparent`, Views prefixed with `internal-generated-` will
4483
+ * be reparented to the current Window and added to this new Layout.
4484
+ * Use this option when you need to transfer an existing Layout between Windows.
4485
+ *
4486
+ * When set to 'duplicate', Views prefixed with `internal-generated-` will
4487
+ * be duplicated with new generated names. Use this option when you need
4488
+ * to clone a Layout to any Window.
4489
+ *
4490
+ * When set to `default` or omitted, the Layout will attempt to re-use
4491
+ * existing Views only if they are attached to the current Window or
4492
+ * the Provider Window. Set to `default` or omit this option when creating
4493
+ * Layouts as part of implementing the LayoutManager::applyLayoutSnapshot
4494
+ * override. Note that during applyLayoutSnapshot, Views are created and
4495
+ * attached to the Provider while the Window is being created, so it's
4496
+ * important to not 'duplicate' Views in this workflow.
4497
+ */
4498
+ multiInstanceViewBehavior?: MultiInstanceViewBehavior;
4473
4499
  };
4474
4500
 
4475
4501
  /**
@@ -9413,6 +9439,13 @@ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin.MonitorInfo & {
9413
9439
  type: 'monitor-info-changed';
9414
9440
  };
9415
9441
 
9442
+ /**
9443
+ * @experimental
9444
+ *
9445
+ * Used to control view behavior for Layout.create API
9446
+ */
9447
+ declare type MultiInstanceViewBehavior = 'reparent' | 'duplicate' | 'default';
9448
+
9416
9449
  /**
9417
9450
  * @interface
9418
9451
  */
@@ -10133,6 +10166,7 @@ declare namespace OpenFin {
10133
10166
  LayoutManagerOverride,
10134
10167
  LayoutManager,
10135
10168
  CreateLayoutOptions,
10169
+ MultiInstanceViewBehavior,
10136
10170
  PresetLayoutOptions_2 as PresetLayoutOptions,
10137
10171
  ResultBehavior,
10138
10172
  PopupBaseBehavior,
@@ -4470,6 +4470,32 @@ declare type CreateLayoutOptions = {
4470
4470
  container: HTMLElement;
4471
4471
  layoutName: string;
4472
4472
  layout: LayoutOptions;
4473
+ /**
4474
+ * @defaultValue 'default'
4475
+ *
4476
+ * Controls the View behavior for the given `layout` property. Note
4477
+ * that the selected behavior only applies to unnamed Views or
4478
+ * Views with the prefix `internal-generated-`. In all cases, if any
4479
+ * View in the `layout` does not already exist, it will be created
4480
+ * with a name that starts with `internal-generated-`.
4481
+ *
4482
+ * When set to `reparent`, Views prefixed with `internal-generated-` will
4483
+ * be reparented to the current Window and added to this new Layout.
4484
+ * Use this option when you need to transfer an existing Layout between Windows.
4485
+ *
4486
+ * When set to 'duplicate', Views prefixed with `internal-generated-` will
4487
+ * be duplicated with new generated names. Use this option when you need
4488
+ * to clone a Layout to any Window.
4489
+ *
4490
+ * When set to `default` or omitted, the Layout will attempt to re-use
4491
+ * existing Views only if they are attached to the current Window or
4492
+ * the Provider Window. Set to `default` or omit this option when creating
4493
+ * Layouts as part of implementing the LayoutManager::applyLayoutSnapshot
4494
+ * override. Note that during applyLayoutSnapshot, Views are created and
4495
+ * attached to the Provider while the Window is being created, so it's
4496
+ * important to not 'duplicate' Views in this workflow.
4497
+ */
4498
+ multiInstanceViewBehavior?: MultiInstanceViewBehavior;
4473
4499
  };
4474
4500
 
4475
4501
  /**
@@ -9413,6 +9439,13 @@ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin.MonitorInfo & {
9413
9439
  type: 'monitor-info-changed';
9414
9440
  };
9415
9441
 
9442
+ /**
9443
+ * @experimental
9444
+ *
9445
+ * Used to control view behavior for Layout.create API
9446
+ */
9447
+ declare type MultiInstanceViewBehavior = 'reparent' | 'duplicate' | 'default';
9448
+
9416
9449
  /**
9417
9450
  * @interface
9418
9451
  */
@@ -10133,6 +10166,7 @@ declare namespace OpenFin {
10133
10166
  LayoutManagerOverride,
10134
10167
  LayoutManager,
10135
10168
  CreateLayoutOptions,
10169
+ MultiInstanceViewBehavior,
10136
10170
  PresetLayoutOptions_2 as PresetLayoutOptions,
10137
10171
  ResultBehavior,
10138
10172
  PopupBaseBehavior,
@@ -4470,6 +4470,32 @@ declare type CreateLayoutOptions = {
4470
4470
  container: HTMLElement;
4471
4471
  layoutName: string;
4472
4472
  layout: LayoutOptions;
4473
+ /**
4474
+ * @defaultValue 'default'
4475
+ *
4476
+ * Controls the View behavior for the given `layout` property. Note
4477
+ * that the selected behavior only applies to unnamed Views or
4478
+ * Views with the prefix `internal-generated-`. In all cases, if any
4479
+ * View in the `layout` does not already exist, it will be created
4480
+ * with a name that starts with `internal-generated-`.
4481
+ *
4482
+ * When set to `reparent`, Views prefixed with `internal-generated-` will
4483
+ * be reparented to the current Window and added to this new Layout.
4484
+ * Use this option when you need to transfer an existing Layout between Windows.
4485
+ *
4486
+ * When set to 'duplicate', Views prefixed with `internal-generated-` will
4487
+ * be duplicated with new generated names. Use this option when you need
4488
+ * to clone a Layout to any Window.
4489
+ *
4490
+ * When set to `default` or omitted, the Layout will attempt to re-use
4491
+ * existing Views only if they are attached to the current Window or
4492
+ * the Provider Window. Set to `default` or omit this option when creating
4493
+ * Layouts as part of implementing the LayoutManager::applyLayoutSnapshot
4494
+ * override. Note that during applyLayoutSnapshot, Views are created and
4495
+ * attached to the Provider while the Window is being created, so it's
4496
+ * important to not 'duplicate' Views in this workflow.
4497
+ */
4498
+ multiInstanceViewBehavior?: MultiInstanceViewBehavior;
4473
4499
  };
4474
4500
 
4475
4501
  /**
@@ -9413,6 +9439,13 @@ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin.MonitorInfo & {
9413
9439
  type: 'monitor-info-changed';
9414
9440
  };
9415
9441
 
9442
+ /**
9443
+ * @experimental
9444
+ *
9445
+ * Used to control view behavior for Layout.create API
9446
+ */
9447
+ declare type MultiInstanceViewBehavior = 'reparent' | 'duplicate' | 'default';
9448
+
9416
9449
  /**
9417
9450
  * @interface
9418
9451
  */
@@ -10133,6 +10166,7 @@ declare namespace OpenFin {
10133
10166
  LayoutManagerOverride,
10134
10167
  LayoutManager,
10135
10168
  CreateLayoutOptions,
10169
+ MultiInstanceViewBehavior,
10136
10170
  PresetLayoutOptions_2 as PresetLayoutOptions,
10137
10171
  ResultBehavior,
10138
10172
  PopupBaseBehavior,
@@ -4513,6 +4513,32 @@ declare type CreateLayoutOptions = {
4513
4513
  container: HTMLElement;
4514
4514
  layoutName: string;
4515
4515
  layout: LayoutOptions;
4516
+ /**
4517
+ * @defaultValue 'default'
4518
+ *
4519
+ * Controls the View behavior for the given `layout` property. Note
4520
+ * that the selected behavior only applies to unnamed Views or
4521
+ * Views with the prefix `internal-generated-`. In all cases, if any
4522
+ * View in the `layout` does not already exist, it will be created
4523
+ * with a name that starts with `internal-generated-`.
4524
+ *
4525
+ * When set to `reparent`, Views prefixed with `internal-generated-` will
4526
+ * be reparented to the current Window and added to this new Layout.
4527
+ * Use this option when you need to transfer an existing Layout between Windows.
4528
+ *
4529
+ * When set to 'duplicate', Views prefixed with `internal-generated-` will
4530
+ * be duplicated with new generated names. Use this option when you need
4531
+ * to clone a Layout to any Window.
4532
+ *
4533
+ * When set to `default` or omitted, the Layout will attempt to re-use
4534
+ * existing Views only if they are attached to the current Window or
4535
+ * the Provider Window. Set to `default` or omit this option when creating
4536
+ * Layouts as part of implementing the LayoutManager::applyLayoutSnapshot
4537
+ * override. Note that during applyLayoutSnapshot, Views are created and
4538
+ * attached to the Provider while the Window is being created, so it's
4539
+ * important to not 'duplicate' Views in this workflow.
4540
+ */
4541
+ multiInstanceViewBehavior?: MultiInstanceViewBehavior;
4516
4542
  };
4517
4543
 
4518
4544
  /**
@@ -9712,6 +9738,13 @@ declare type MonitorInfoChangedEvent = BaseEvent_9 & OpenFin.MonitorInfo & {
9712
9738
  type: 'monitor-info-changed';
9713
9739
  };
9714
9740
 
9741
+ /**
9742
+ * @experimental
9743
+ *
9744
+ * Used to control view behavior for Layout.create API
9745
+ */
9746
+ declare type MultiInstanceViewBehavior = 'reparent' | 'duplicate' | 'default';
9747
+
9715
9748
  /**
9716
9749
  * @interface
9717
9750
  */
@@ -10454,6 +10487,7 @@ declare namespace OpenFin {
10454
10487
  LayoutManagerOverride,
10455
10488
  LayoutManager,
10456
10489
  CreateLayoutOptions,
10490
+ MultiInstanceViewBehavior,
10457
10491
  PresetLayoutOptions_2 as PresetLayoutOptions,
10458
10492
  ResultBehavior,
10459
10493
  PopupBaseBehavior,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/node-adapter",
3
- "version": "36.79.13",
3
+ "version": "36.79.15",
4
4
  "description": "See README.md",
5
5
  "main": "out/node-adapter.js",
6
6
  "types": "out/node-adapter.d.ts",