1 /**
2 * This file Copyright (c) 2010-2018 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.ui.dialog;
35
36 import info.magnolia.ui.api.overlay.OverlayLayer.ModalityLevel;
37 import info.magnolia.ui.api.view.View;
38 import info.magnolia.ui.dialog.actionarea.view.EditorActionAreaView;
39
40 import com.vaadin.event.ShortcutListener;
41
42 /**
43 * Interface for {@link info.magnolia.ui.vaadin.dialog.BaseDialog}.
44 */
45 public interface DialogView extends View {
46
47 void setDescriptionVisible(boolean isDescriptionVisible);
48
49 void setDescription(String description);
50
51 void setCaption(String caption);
52
53 void setContent(View content);
54
55 void close();
56
57 void setClosable(boolean isClosable);
58
59 void addShortcut(ShortcutListener shortcut);
60
61 void removeShortcut(ShortcutListener shortcut);
62
63 void addDialogCloseHandler(DialogCloseHandler handler);
64
65 void removeDialogCloseHandler(DialogCloseHandler handler);
66
67 void setActionAreaView(EditorActionAreaView actionView);
68
69 View getContentView();
70
71 EditorActionAreaView getActionAreaView();
72
73 ModalityLevel getModalityLevel();
74
75 void setModalityLevel(ModalityLevel modalityLevel);
76
77 default boolean isClosable() {
78 return true;
79 }
80
81 default String getTitle() {
82 return "";
83 }
84
85 /**
86 * @deprecated since 6.0, dialogs are wide by default, and can only be wide.
87 */
88 @Deprecated
89 default void setWide(boolean isWide) {
90 throw new UnsupportedOperationException("Dialogs are wide by default, and can only be wide.");
91 }
92 }