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.workbench.definition;
35
36 import info.magnolia.i18nsystem.I18nable;
37 import info.magnolia.ui.workbench.contenttool.ContentToolDefinition;
38 import info.magnolia.ui.workbench.tree.drop.DropConstraint;
39
40 import java.io.Serializable;
41 import java.util.List;
42
43 /**
44 * Defines a workbench. Contains all elements which define a workbench configuration.
45 */
46 @I18nable
47 public interface WorkbenchDefinition extends Serializable {
48
49 String getName();
50
51 /**
52 * Define if this workbench is used for Dialog.
53 */
54 boolean isDialogWorkbench();
55
56 /**
57 * Checks if workbench can edit tree view inplace.
58 *
59 * @return true, if workbench is editable
60 */
61 boolean isEditable();
62
63 /**
64 * Checks if drag&drop is enable.
65 */
66 boolean isDragAndDrop();
67
68 /**
69 * @return the DropConstraint class used to handle drag&drop.
70 */
71 Class<? extends DropConstraint> getDropConstraintClass();
72
73 /**
74 * @return the list of configured views.<br>
75 */
76 List<ContentPresenterDefinition> getContentViews();
77
78 /**
79 * @return the list of configured content tools
80 */
81 List<ContentToolDefinition> getContentTools();
82 }