1 /**
2 * This file Copyright (c) 2011-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.vaadin.gwt.client.editor.model;
35
36 import info.magnolia.ui.vaadin.gwt.client.editor.dom.MgnlArea;
37 import info.magnolia.ui.vaadin.gwt.client.editor.dom.MgnlElement;
38 import info.magnolia.ui.vaadin.gwt.client.editor.dom.MgnlPage;
39 import info.magnolia.ui.vaadin.gwt.client.shared.AbstractElement;
40
41 import java.util.List;
42
43 import com.google.gwt.dom.client.Element;
44
45 /**
46 * Interface for the model storing all elements used across application.
47 */
48 public interface Model {
49
50 String CMS_TAG = "cms:";
51 String CMS_PAGE = "cms:page";
52 String CMS_AREA = "cms:area";
53 String CMS_COMPONENT = "cms:component";
54 String[] INHERITED_ATTRIBUTES = {"editable"};
55
56 void addElement(MgnlElement mgnlElement, Element element);
57
58 void addElements(MgnlElement mgnlElement, Element element);
59
60 MgnlElement getMgnlElement(Element element);
61
62 MgnlElement getMgnlElement(AbstractElement element);
63
64 void addRootArea(MgnlArea area);
65
66 List<MgnlArea> getRootAreas();
67
68 void removeMgnlElement(MgnlElement mgnlElement);
69
70 void setRootPage(MgnlPage mgnlElement);
71
72 MgnlPage getRootPage();
73
74 void reset();
75
76 boolean isMoving();
77
78 void setMoving(boolean isMoving);
79 }