1 /**
2 * This file Copyright (c) 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.i18nsystem.I18nText;
37 import info.magnolia.i18nsystem.I18nable;
38 import info.magnolia.ui.api.action.ActionDefinition;
39 import info.magnolia.ui.framework.layout.LayoutDefinition;
40 import info.magnolia.ui.framework.layout.LayoutProducer;
41
42 import java.util.Map;
43
44 /**
45 * Base definition of a dialog.
46 */
47 @I18nable(keyGenerator = DialogDefinitionKeyGenerator.class)
48 public interface DialogDefinition {
49
50 /**
51 * Unique identifier for this dialog.
52 */
53 String getId();
54
55 @I18nText
56 String getLabel();
57
58 Map<String, ActionDefinition> getActions();
59
60 default boolean isLight() {
61 return false;
62 }
63
64 default LayoutDefinition<? extends LayoutProducer> getFooterLayout() {
65 return null;
66 }
67 }