/
shell.ts
1267 lines (1114 loc) · 33.5 KB
/
shell.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright (c) Jupyter Development Team.
// Distributed under the terms of the Modified BSD License.
import { DocumentRegistry } from '@jupyterlab/docregistry';
import { DockPanelSvg, TabBarSvg } from '@jupyterlab/ui-components';
import { ArrayExt, find, IIterator, iter, toArray } from '@lumino/algorithm';
import { PromiseDelegate, Token } from '@lumino/coreutils';
import { Message, MessageLoop, IMessageHandler } from '@lumino/messaging';
import { Debouncer } from '@lumino/polling';
import { ISignal, Signal } from '@lumino/signaling';
import {
BoxLayout,
BoxPanel,
DockLayout,
DockPanel,
FocusTracker,
Panel,
SplitPanel,
StackedPanel,
TabBar,
Title,
Widget
} from '@lumino/widgets';
import { JupyterFrontEnd } from './frontend';
/**
* The class name added to AppShell instances.
*/
const APPLICATION_SHELL_CLASS = 'jp-LabShell';
/**
* The class name added to side bar instances.
*/
const SIDEBAR_CLASS = 'jp-SideBar';
/**
* The class name added to the current widget's title.
*/
const CURRENT_CLASS = 'jp-mod-current';
/**
* The class name added to the active widget's title.
*/
const ACTIVE_CLASS = 'jp-mod-active';
/**
* The default rank of items added to a sidebar.
*/
const DEFAULT_RANK = 500;
const ACTIVITY_CLASS = 'jp-Activity';
/* tslint:disable */
/**
* The JupyterLab application shell token.
*/
export const ILabShell = new Token<ILabShell>(
'@jupyterlab/application:ILabShell'
);
/* tslint:enable */
/**
* The JupyterLab application shell interface.
*/
export interface ILabShell extends LabShell {}
/**
* The namespace for `ILabShell` type information.
*/
export namespace ILabShell {
/**
* The areas of the application shell where widgets can reside.
*/
export type Area = 'main' | 'header' | 'top' | 'left' | 'right' | 'bottom';
/**
* The restorable description of an area within the main dock panel.
*/
export type AreaConfig = DockLayout.AreaConfig;
/**
* An arguments object for the changed signals.
*/
export type IChangedArgs = FocusTracker.IChangedArgs<Widget>;
/**
* A description of the application's user interface layout.
*/
export interface ILayout {
/**
* Indicates whether fetched session restore data was actually retrieved
* from the state database or whether it is a fresh blank slate.
*
* #### Notes
* This attribute is only relevant when the layout data is retrieved via a
* `fetch` call. If it is set when being passed into `save`, it will be
* ignored.
*/
readonly fresh?: boolean;
/**
* The main area of the user interface.
*/
readonly mainArea: IMainArea | null;
/**
* The left area of the user interface.
*/
readonly leftArea: ISideArea | null;
/**
* The right area of the user interface.
*/
readonly rightArea: ISideArea | null;
}
/**
* The restorable description of the main application area.
*/
export interface IMainArea {
/**
* The current widget that has application focus.
*/
readonly currentWidget: Widget | null;
/**
* The contents of the main application dock panel.
*/
readonly dock: DockLayout.ILayoutConfig | null;
/**
* The document mode (i.e., multiple/single) of the main dock panel.
*/
readonly mode: DockPanel.Mode | null;
}
/**
* The restorable description of a sidebar in the user interface.
*/
export interface ISideArea {
/**
* A flag denoting whether the sidebar has been collapsed.
*/
readonly collapsed: boolean;
/**
* The current widget that has side area focus.
*/
readonly currentWidget: Widget | null;
/**
* The collection of widgets held by the sidebar.
*/
readonly widgets: Array<Widget> | null;
}
}
/**
* The application shell for JupyterLab.
*/
export class LabShell extends Widget implements JupyterFrontEnd.IShell {
/**
* Construct a new application shell.
*/
constructor() {
super();
this.addClass(APPLICATION_SHELL_CLASS);
this.id = 'main';
let headerPanel = (this._headerPanel = new Panel());
let topHandler = (this._topHandler = new Private.PanelHandler());
let bottomPanel = (this._bottomPanel = new BoxPanel());
let hboxPanel = new BoxPanel();
let dockPanel = (this._dockPanel = new DockPanelSvg({
kind: 'dockPanelBar'
}));
MessageLoop.installMessageHook(dockPanel, this._dockChildHook);
let hsplitPanel = new SplitPanel();
let leftHandler = (this._leftHandler = new Private.SideBarHandler());
let rightHandler = (this._rightHandler = new Private.SideBarHandler());
let rootLayout = new BoxLayout();
headerPanel.id = 'jp-header-panel';
topHandler.panel.id = 'jp-top-panel';
bottomPanel.id = 'jp-bottom-panel';
hboxPanel.id = 'jp-main-content-panel';
dockPanel.id = 'jp-main-dock-panel';
hsplitPanel.id = 'jp-main-split-panel';
leftHandler.sideBar.addClass(SIDEBAR_CLASS);
leftHandler.sideBar.addClass('jp-mod-left');
leftHandler.stackedPanel.id = 'jp-left-stack';
rightHandler.sideBar.addClass(SIDEBAR_CLASS);
rightHandler.sideBar.addClass('jp-mod-right');
rightHandler.stackedPanel.id = 'jp-right-stack';
hboxPanel.spacing = 0;
dockPanel.spacing = 5;
hsplitPanel.spacing = 1;
hboxPanel.direction = 'left-to-right';
hsplitPanel.orientation = 'horizontal';
bottomPanel.direction = 'bottom-to-top';
SplitPanel.setStretch(leftHandler.stackedPanel, 0);
SplitPanel.setStretch(dockPanel, 1);
SplitPanel.setStretch(rightHandler.stackedPanel, 0);
BoxPanel.setStretch(leftHandler.sideBar, 0);
BoxPanel.setStretch(hsplitPanel, 1);
BoxPanel.setStretch(rightHandler.sideBar, 0);
hsplitPanel.addWidget(leftHandler.stackedPanel);
hsplitPanel.addWidget(dockPanel);
hsplitPanel.addWidget(rightHandler.stackedPanel);
hboxPanel.addWidget(leftHandler.sideBar);
hboxPanel.addWidget(hsplitPanel);
hboxPanel.addWidget(rightHandler.sideBar);
rootLayout.direction = 'top-to-bottom';
rootLayout.spacing = 0; // TODO make this configurable?
// Use relative sizing to set the width of the side panels.
// This will still respect the min-size of children widget in the stacked
// panel.
hsplitPanel.setRelativeSizes([1, 2.5, 1]);
BoxLayout.setStretch(headerPanel, 0);
BoxLayout.setStretch(topHandler.panel, 0);
BoxLayout.setStretch(hboxPanel, 1);
BoxLayout.setStretch(bottomPanel, 0);
rootLayout.addWidget(headerPanel);
rootLayout.addWidget(topHandler.panel);
rootLayout.addWidget(hboxPanel);
rootLayout.addWidget(bottomPanel);
// initially hiding header and bottom panel when no elements inside
this._headerPanel.hide();
this._bottomPanel.hide();
this.layout = rootLayout;
// Connect change listeners.
this._tracker.currentChanged.connect(this._onCurrentChanged, this);
this._tracker.activeChanged.connect(this._onActiveChanged, this);
// Connect main layout change listener.
this._dockPanel.layoutModified.connect(this._onLayoutModified, this);
// Catch current changed events on the side handlers.
this._leftHandler.sideBar.currentChanged.connect(
this._onLayoutModified,
this
);
this._rightHandler.sideBar.currentChanged.connect(
this._onLayoutModified,
this
);
}
/**
* A signal emitted when main area's active focus changes.
*/
get activeChanged(): ISignal<this, ILabShell.IChangedArgs> {
return this._activeChanged;
}
/**
* The active widget in the shell's main area.
*/
get activeWidget(): Widget | null {
return this._tracker.activeWidget;
}
/**
* A signal emitted when main area's current focus changes.
*/
get currentChanged(): ISignal<this, ILabShell.IChangedArgs> {
return this._currentChanged;
}
/**
* The current widget in the shell's main area.
*/
get currentWidget(): Widget | null {
return this._tracker.currentWidget;
}
/**
* A signal emitted when the main area's layout is modified.
*/
get layoutModified(): ISignal<this, void> {
return this._layoutModified;
}
/**
* Whether the left area is collapsed.
*/
get leftCollapsed(): boolean {
return !this._leftHandler.sideBar.currentTitle;
}
/**
* Whether the left area is collapsed.
*/
get rightCollapsed(): boolean {
return !this._rightHandler.sideBar.currentTitle;
}
/**
* Whether JupyterLab is in presentation mode with the
* `jp-mod-presentationMode` CSS class.
*/
get presentationMode(): boolean {
return this.hasClass('jp-mod-presentationMode');
}
/**
* Enable/disable presentation mode (`jp-mod-presentationMode` CSS class) with
* a boolean.
*/
set presentationMode(value: boolean) {
this.toggleClass('jp-mod-presentationMode', value);
}
/**
* The main dock area's user interface mode.
*/
get mode(): DockPanel.Mode {
return this._dockPanel.mode;
}
set mode(mode: DockPanel.Mode) {
const dock = this._dockPanel;
if (mode === dock.mode) {
return;
}
const applicationCurrentWidget = this.currentWidget;
if (mode === 'single-document') {
this._cachedLayout = dock.saveLayout();
dock.mode = mode;
// In case the active widget in the dock panel is *not* the active widget
// of the application, defer to the application.
if (this.currentWidget) {
dock.activateWidget(this.currentWidget);
}
// Set the mode data attribute on the application shell node.
this.node.dataset.shellMode = mode;
return;
}
// Cache a reference to every widget currently in the dock panel.
const widgets = toArray(dock.widgets());
// Toggle back to multiple document mode.
dock.mode = mode;
// Restore the original layout.
if (this._cachedLayout) {
// Remove any disposed widgets in the cached layout and restore.
Private.normalizeAreaConfig(dock, this._cachedLayout.main);
dock.restoreLayout(this._cachedLayout);
this._cachedLayout = null;
}
// Add any widgets created during single document mode, which have
// subsequently been removed from the dock panel after the multiple document
// layout has been restored. If the widget has add options cached for
// it (i.e., if it has been placed with respect to another widget),
// then take that into account.
widgets.forEach(widget => {
if (!widget.parent) {
this._addToMainArea(widget, {
...this._mainOptionsCache.get(widget),
activate: false
});
}
});
this._mainOptionsCache.clear();
// In case the active widget in the dock panel is *not* the active widget
// of the application, defer to the application.
if (applicationCurrentWidget) {
dock.activateWidget(applicationCurrentWidget);
}
// Set the mode data attribute on the applications shell node.
this.node.dataset.shellMode = mode;
}
/**
* Promise that resolves when state is first restored, returning layout
* description.
*/
get restored(): Promise<ILabShell.ILayout> {
return this._restored.promise;
}
/**
* Activate a widget in its area.
*/
activateById(id: string): void {
if (this._leftHandler.has(id)) {
this._leftHandler.activate(id);
return;
}
if (this._rightHandler.has(id)) {
this._rightHandler.activate(id);
return;
}
const dock = this._dockPanel;
const widget = find(dock.widgets(), value => value.id === id);
if (widget) {
dock.activateWidget(widget);
}
}
/*
* Activate the next Tab in the active TabBar.
*/
activateNextTab(): void {
let current = this._currentTabBar();
if (!current) {
return;
}
let ci = current.currentIndex;
if (ci === -1) {
return;
}
if (ci < current.titles.length - 1) {
current.currentIndex += 1;
if (current.currentTitle) {
current.currentTitle.owner.activate();
}
return;
}
if (ci === current.titles.length - 1) {
let nextBar = this._adjacentBar('next');
if (nextBar) {
nextBar.currentIndex = 0;
if (nextBar.currentTitle) {
nextBar.currentTitle.owner.activate();
}
}
}
}
/*
* Activate the previous Tab in the active TabBar.
*/
activatePreviousTab(): void {
let current = this._currentTabBar();
if (!current) {
return;
}
let ci = current.currentIndex;
if (ci === -1) {
return;
}
if (ci > 0) {
current.currentIndex -= 1;
if (current.currentTitle) {
current.currentTitle.owner.activate();
}
return;
}
if (ci === 0) {
let prevBar = this._adjacentBar('previous');
if (prevBar) {
let len = prevBar.titles.length;
prevBar.currentIndex = len - 1;
if (prevBar.currentTitle) {
prevBar.currentTitle.owner.activate();
}
}
}
}
add(
widget: Widget,
area: ILabShell.Area = 'main',
options?: DocumentRegistry.IOpenOptions
): void {
switch (area || 'main') {
case 'main':
return this._addToMainArea(widget, options);
case 'left':
return this._addToLeftArea(widget, options);
case 'right':
return this._addToRightArea(widget, options);
case 'header':
return this._addToHeaderArea(widget, options);
case 'top':
return this._addToTopArea(widget, options);
case 'bottom':
return this._addToBottomArea(widget, options);
default:
throw new Error(`Invalid area: ${area}`);
}
}
/**
* Collapse the left area.
*/
collapseLeft(): void {
this._leftHandler.collapse();
this._onLayoutModified();
}
/**
* Collapse the right area.
*/
collapseRight(): void {
this._rightHandler.collapse();
this._onLayoutModified();
}
/**
* Dispose the shell.
*/
dispose(): void {
if (this.isDisposed) {
return;
}
this._layoutDebouncer.dispose();
super.dispose();
}
/**
* Expand the left area.
*
* #### Notes
* This will open the most recently used tab,
* or the first tab if there is no most recently used.
*/
expandLeft(): void {
this._leftHandler.expand();
this._onLayoutModified();
}
/**
* Expand the right area.
*
* #### Notes
* This will open the most recently used tab,
* or the first tab if there is no most recently used.
*/
expandRight(): void {
this._rightHandler.expand();
this._onLayoutModified();
}
/**
* Close all widgets in the main area.
*/
closeAll(): void {
// Make a copy of all the widget in the dock panel (using `toArray()`)
// before removing them because removing them while iterating through them
// modifies the underlying data of the iterator.
toArray(this._dockPanel.widgets()).forEach(widget => widget.close());
}
/**
* True if the given area is empty.
*/
isEmpty(area: ILabShell.Area): boolean {
switch (area) {
case 'left':
return this._leftHandler.stackedPanel.widgets.length === 0;
case 'main':
return this._dockPanel.isEmpty;
case 'header':
return this._headerPanel.widgets.length === 0;
case 'top':
return this._topHandler.panel.widgets.length === 0;
case 'bottom':
return this._bottomPanel.widgets.length === 0;
case 'right':
return this._rightHandler.stackedPanel.widgets.length === 0;
default:
return true;
}
}
/**
* Restore the layout state for the application shell.
*/
restoreLayout(layout: ILabShell.ILayout): void {
const { mainArea, leftArea, rightArea } = layout;
// Rehydrate the main area.
if (mainArea) {
const { currentWidget, dock, mode } = mainArea;
if (dock) {
this._dockPanel.restoreLayout(dock);
}
if (mode) {
this.mode = mode;
}
if (currentWidget) {
this.activateById(currentWidget.id);
}
}
// Rehydrate the left area.
if (leftArea) {
this._leftHandler.rehydrate(leftArea);
}
// Rehydrate the right area.
if (rightArea) {
this._rightHandler.rehydrate(rightArea);
}
if (!this._isRestored) {
// Make sure all messages in the queue are finished before notifying
// any extensions that are waiting for the promise that guarantees the
// application state has been restored.
MessageLoop.flush();
this._restored.resolve(layout);
}
}
/**
* Save the dehydrated state of the application shell.
*/
saveLayout(): ILabShell.ILayout {
// If the application is in single document mode, use the cached layout if
// available. Otherwise, default to querying the dock panel for layout.
return {
mainArea: {
currentWidget: this._tracker.currentWidget,
dock:
this.mode === 'single-document'
? this._cachedLayout || this._dockPanel.saveLayout()
: this._dockPanel.saveLayout(),
mode: this._dockPanel.mode
},
leftArea: this._leftHandler.dehydrate(),
rightArea: this._rightHandler.dehydrate()
};
}
/**
* Returns the widgets for an application area.
*/
widgets(area?: ILabShell.Area): IIterator<Widget> {
switch (area || 'main') {
case 'main':
return this._dockPanel.widgets();
case 'left':
return iter(this._leftHandler.sideBar.titles.map(t => t.owner));
case 'right':
return iter(this._rightHandler.sideBar.titles.map(t => t.owner));
case 'header':
return this._headerPanel.children();
case 'top':
return this._topHandler.panel.children();
case 'bottom':
return this._bottomPanel.children();
default:
throw new Error(`Invalid area: ${area}`);
}
}
/**
* Handle `after-attach` messages for the application shell.
*/
protected onAfterAttach(msg: Message): void {
this.node.dataset.shellMode = this.mode;
}
/**
* Add a widget to the left content area.
*
* #### Notes
* Widgets must have a unique `id` property, which will be used as the DOM id.
*/
private _addToLeftArea(
widget: Widget,
options?: DocumentRegistry.IOpenOptions
): void {
if (!widget.id) {
console.error('Widgets added to app shell must have unique id property.');
return;
}
options = options || this._sideOptionsCache.get(widget) || {};
this._sideOptionsCache.set(widget, options);
let rank = 'rank' in options ? options.rank : DEFAULT_RANK;
this._leftHandler.addWidget(widget, rank!);
this._onLayoutModified();
}
/**
* Add a widget to the main content area.
*
* #### Notes
* Widgets must have a unique `id` property, which will be used as the DOM id.
* All widgets added to the main area should be disposed after removal
* (disposal before removal will remove the widget automatically).
*
* In the options, `ref` defaults to `null`, `mode` defaults to `'tab-after'`,
* and `activate` defaults to `true`.
*/
private _addToMainArea(
widget: Widget,
options?: DocumentRegistry.IOpenOptions
): void {
if (!widget.id) {
console.error('Widgets added to app shell must have unique id property.');
return;
}
options = options || {};
const dock = this._dockPanel;
const mode = options.mode || 'tab-after';
let ref: Widget | null = this.currentWidget;
if (options.ref) {
ref = find(dock.widgets(), value => value.id === options!.ref!) || null;
}
// Add widget ID to tab so that we can get a handle on the tab's widget
// (for context menu support)
widget.title.dataset = { ...widget.title.dataset, id: widget.id };
dock.addWidget(widget, { mode, ref });
// The dock panel doesn't account for placement information while
// in single document mode, so upon rehydrating any widgets that were
// added will not be in the correct place. Cache the placement information
// here so that we can later rehydrate correctly.
if (dock.mode === 'single-document') {
this._mainOptionsCache.set(widget, options);
}
if (options.activate !== false) {
dock.activateWidget(widget);
}
}
/**
* Add a widget to the right content area.
*
* #### Notes
* Widgets must have a unique `id` property, which will be used as the DOM id.
*/
private _addToRightArea(
widget: Widget,
options?: DocumentRegistry.IOpenOptions
): void {
if (!widget.id) {
console.error('Widgets added to app shell must have unique id property.');
return;
}
options = options || this._sideOptionsCache.get(widget) || {};
const rank = 'rank' in options ? options.rank : DEFAULT_RANK;
this._sideOptionsCache.set(widget, options);
this._rightHandler.addWidget(widget, rank!);
this._onLayoutModified();
}
/**
* Add a widget to the top content area.
*
* #### Notes
* Widgets must have a unique `id` property, which will be used as the DOM id.
*/
private _addToTopArea(
widget: Widget,
options?: DocumentRegistry.IOpenOptions
): void {
if (!widget.id) {
console.error('Widgets added to app shell must have unique id property.');
return;
}
options = options || {};
const rank = options.rank ?? DEFAULT_RANK;
this._topHandler.addWidget(widget, rank);
this._onLayoutModified();
if (this._topHandler.panel.isHidden) {
this._topHandler.panel.show();
}
}
/**
* Add a widget to the header content area.
*
* #### Notes
* Widgets must have a unique `id` property, which will be used as the DOM id.
*/
private _addToHeaderArea(
widget: Widget,
options?: DocumentRegistry.IOpenOptions
): void {
if (!widget.id) {
console.error('Widgets added to app shell must have unique id property.');
return;
}
// Temporary: widgets are added to the panel in order of insertion.
this._headerPanel.addWidget(widget);
this._onLayoutModified();
if (this._headerPanel.isHidden) {
this._headerPanel.show();
}
}
/**
* Add a widget to the bottom content area.
*
* #### Notes
* Widgets must have a unique `id` property, which will be used as the DOM id.
*/
private _addToBottomArea(
widget: Widget,
options?: DocumentRegistry.IOpenOptions
): void {
if (!widget.id) {
console.error('Widgets added to app shell must have unique id property.');
return;
}
// Temporary: widgets are added to the panel in order of insertion.
this._bottomPanel.addWidget(widget);
this._onLayoutModified();
if (this._bottomPanel.isHidden) {
this._bottomPanel.show();
}
}
/*
* Return the tab bar adjacent to the current TabBar or `null`.
*/
private _adjacentBar(direction: 'next' | 'previous'): TabBar<Widget> | null {
const current = this._currentTabBar();
if (!current) {
return null;
}
const bars = toArray(this._dockPanel.tabBars());
const len = bars.length;
const index = bars.indexOf(current);
if (direction === 'previous') {
return index > 0 ? bars[index - 1] : index === 0 ? bars[len - 1] : null;
}
// Otherwise, direction is 'next'.
return index < len - 1
? bars[index + 1]
: index === len - 1
? bars[0]
: null;
}
/*
* Return the TabBar that has the currently active Widget or null.
*/
private _currentTabBar(): TabBar<Widget> | null {
const current = this._tracker.currentWidget;
if (!current) {
return null;
}
const title = current.title;
const bars = this._dockPanel.tabBars();
return find(bars, bar => bar.titles.indexOf(title) > -1) || null;
}
/**
* Handle a change to the dock area active widget.
*/
private _onActiveChanged(
sender: any,
args: FocusTracker.IChangedArgs<Widget>
): void {
if (args.newValue) {
args.newValue.title.className += ` ${ACTIVE_CLASS}`;
}
if (args.oldValue) {
args.oldValue.title.className = args.oldValue.title.className.replace(
ACTIVE_CLASS,
''
);
}
this._activeChanged.emit(args);
}
/**
* Handle a change to the dock area current widget.
*/
private _onCurrentChanged(
sender: any,
args: FocusTracker.IChangedArgs<Widget>
): void {
if (args.newValue) {
args.newValue.title.className += ` ${CURRENT_CLASS}`;
}
if (args.oldValue) {
args.oldValue.title.className = args.oldValue.title.className.replace(
CURRENT_CLASS,
''
);
}
this._currentChanged.emit(args);
this._onLayoutModified();
}
/**
* Handle a change to the layout.
*/
private _onLayoutModified(): void {
void this._layoutDebouncer.invoke();
}
/**
* A message hook for child add/remove messages on the main area dock panel.
*/
private _dockChildHook = (
handler: IMessageHandler,
msg: Message
): boolean => {
switch (msg.type) {
case 'child-added':
(msg as Widget.ChildMessage).child.addClass(ACTIVITY_CLASS);
this._tracker.add((msg as Widget.ChildMessage).child);
break;
case 'child-removed':
(msg as Widget.ChildMessage).child.removeClass(ACTIVITY_CLASS);
this._tracker.remove((msg as Widget.ChildMessage).child);
break;
default:
break;
}
return true;
};
private _activeChanged = new Signal<this, ILabShell.IChangedArgs>(this);
private _cachedLayout: DockLayout.ILayoutConfig | null = null;
private _currentChanged = new Signal<this, ILabShell.IChangedArgs>(this);
private _dockPanel: DockPanel;
private _isRestored = false;
private _layoutModified = new Signal<this, void>(this);
private _layoutDebouncer = new Debouncer(() => {
this._layoutModified.emit(undefined);
}, 0);
private _leftHandler: Private.SideBarHandler;
private _restored = new PromiseDelegate<ILabShell.ILayout>();
private _rightHandler: Private.SideBarHandler;
private _tracker = new FocusTracker<Widget>();
private _headerPanel: Panel;
private _topHandler: Private.PanelHandler;
private _bottomPanel: Panel;
private _mainOptionsCache = new Map<Widget, DocumentRegistry.IOpenOptions>();
private _sideOptionsCache = new Map<Widget, DocumentRegistry.IOpenOptions>();
}
namespace Private {
/**
* An object which holds a widget and its sort rank.
*/
export interface IRankItem {
/**
* The widget for the item.
*/
widget: Widget;
/**
* The sort rank of the widget.
*/
rank: number;
}