1 | // *****************************************************************************
|
2 | // Copyright (C) 2022 STMicroelectronics, Ericsson, ARM, EclipseSource and others.
|
3 | //
|
4 | // This program and the accompanying materials are made available under the
|
5 | // terms of the Eclipse Public License v. 2.0 which is available at
|
6 | // http://www.eclipse.org/legal/epl-2.0.
|
7 | //
|
8 | // This Source Code may also be made available under the following Secondary
|
9 | // Licenses when the conditions for such availability set forth in the Eclipse
|
10 | // Public License v. 2.0 are satisfied: GNU General Public License, version 2
|
11 | // with the GNU Classpath Exception which is available at
|
12 | // https://www.gnu.org/software/classpath/license.html.
|
13 | //
|
14 | // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
|
15 | // *****************************************************************************
|
16 |
|
17 | import { Widget } from './widget';
|
18 |
|
19 | /**
|
20 | * A contract for widgets that are extractable to a secondary window.
|
21 | */
|
22 | export interface ExtractableWidget extends Widget {
|
23 | /** Set to `true` to mark the widget to be extractable. */
|
24 | isExtractable: boolean;
|
25 | /** The secondary window that the window was extracted to or `undefined` if it is not yet extracted. */
|
26 | secondaryWindow: Window | undefined;
|
27 | }
|
28 |
|
29 | export namespace ExtractableWidget {
|
30 | export function is(widget: unknown): widget is ExtractableWidget {
|
31 | return widget instanceof Widget && widget.hasOwnProperty('isExtractable') && (widget as ExtractableWidget).isExtractable === true;
|
32 | }
|
33 | }
|