1 /**
2 * This file Copyright (c) 2014-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.pages.app.editor.parameters;
35
36 import info.magnolia.ui.contentapp.detail.DetailLocation;
37 import info.magnolia.ui.vaadin.editor.gwt.shared.PlatformType;
38 import info.magnolia.ui.vaadin.gwt.client.shared.AbstractElement;
39 import info.magnolia.ui.vaadin.gwt.client.shared.PageEditorParameters;
40
41 import java.util.Locale;
42 import java.util.Map;
43
44 /**
45 * Holds and updates the necessary status information used between server and client.
46 * Creates {@link PageEditorParameters} object.
47 */
48 public interface PageEditorStatus {
49
50 public static final String VERSION_PARAMETER = "mgnlVersion";
51 public static final String PREVIEW_PARAMETER = "mgnlPreview";
52 public static final String CHANNEL_PARAMETER = "mgnlChannel";
53
54 void updateStatusFromLocation(DetailLocation location);
55
56 boolean isLocationChanged(DetailLocation location);
57
58 String getNodePath();
59
60 PlatformType getPlatformType();
61
62 Locale getLocale();
63
64 String getVersion();
65
66 boolean isPreview();
67
68 void setPlatformType(PlatformType platform);
69
70 void setLocale(Locale locale);
71
72 PageEditorParameters getParameters();
73
74 AbstractElement getSelectedElement();
75
76 void setNodePath(String nodePath);
77
78 void setSelectedElement(AbstractElement element);
79
80 void setI18nKeys(Map<String, String> i18nKeys);
81 }