UNPKG

1.85 kBTypeScriptView Raw
1import { ISignal } from '@lumino/signaling';
2import { Panel } from './panel';
3import { StackedLayout } from './stackedlayout';
4import { Widget } from './widget';
5/**
6 * A panel where visible widgets are stacked atop one another.
7 *
8 * #### Notes
9 * This class provides a convenience wrapper around a {@link StackedLayout}.
10 */
11export declare class StackedPanel extends Panel {
12 /**
13 * Construct a new stacked panel.
14 *
15 * @param options - The options for initializing the panel.
16 */
17 constructor(options?: StackedPanel.IOptions);
18 /**
19 * The method for hiding widgets.
20 *
21 * #### Notes
22 * If there is only one child widget, `Display` hiding mode will be used
23 * regardless of this setting.
24 */
25 get hiddenMode(): Widget.HiddenMode;
26 /**
27 * Set the method for hiding widgets.
28 *
29 * #### Notes
30 * If there is only one child widget, `Display` hiding mode will be used
31 * regardless of this setting.
32 */
33 set hiddenMode(v: Widget.HiddenMode);
34 /**
35 * A signal emitted when a widget is removed from a stacked panel.
36 */
37 get widgetRemoved(): ISignal<this, Widget>;
38 /**
39 * A message handler invoked on a `'child-added'` message.
40 */
41 protected onChildAdded(msg: Widget.ChildMessage): void;
42 /**
43 * A message handler invoked on a `'child-removed'` message.
44 */
45 protected onChildRemoved(msg: Widget.ChildMessage): void;
46 private _widgetRemoved;
47}
48/**
49 * The namespace for the `StackedPanel` class statics.
50 */
51export declare namespace StackedPanel {
52 /**
53 * An options object for creating a stacked panel.
54 */
55 interface IOptions {
56 /**
57 * The stacked layout to use for the stacked panel.
58 *
59 * The default is a new `StackedLayout`.
60 */
61 layout?: StackedLayout;
62 }
63}