1 /**
2 * This file Copyright (c) 2012-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.contentapp.detail;
35
36 import info.magnolia.ui.api.view.View;
37 import info.magnolia.ui.dialog.formdialog.FormView;
38
39 import com.vaadin.ui.Component;
40
41 /**
42 * ItemView.
43 *
44 * @see DetailViewImpl
45 */
46 public interface DetailView extends View {
47
48 default void setItemView(FormView formView, ViewType viewType) {
49 setItemView(formView.asVaadinComponent(), viewType);
50 }
51
52 /**
53 * @deprecated since 6.0 - use {@link #setItemView(FormView, ViewType)} instead.
54 */
55 @Deprecated
56 void setItemView(Component formView, ViewType viewType);
57
58 /**
59 * Enumeration for edit or preview types.
60 * <ul>
61 * <li>edit
62 * <li>view (preview)
63 * </ul>
64 */
65 enum ViewType {
66 ADD("add", "icon-add-item"),
67 EDIT("edit", "icon-edit"),
68 VIEW("view", "icon-view");
69
70 private String text;
71 private String icon;
72
73 ViewType(String text, String icon) {
74 this.text = text;
75 this.icon = icon;
76 }
77
78 public String getText() {
79 return this.text;
80 }
81
82 public String getIcon() {
83 return icon;
84 }
85
86 public static ViewType fromString(String text) {
87 if (text != null && !text.isEmpty()) {
88 for (ViewType type : ViewType.values()) {
89 if (text.equalsIgnoreCase(type.text)) {
90 return type;
91 }
92 }
93 }
94 return defaultViewType();
95
96 }
97
98 private static ViewType defaultViewType() {
99 return EDIT;
100 }
101
102 }
103
104 @Deprecated
105 default void setListener(Listener listener) {
106 // NOOP
107 }
108
109 @Deprecated
110 default void refresh() {
111 // NOOP
112 }
113
114
115 @Deprecated
116 default ViewType getViewType() {
117 throw new UnsupportedOperationException();
118 }
119
120 @Deprecated
121 default void setWide(boolean isWide) {
122 // NOOP
123 }
124
125 /**
126 * Listener for the ContentView.
127 */
128 @Deprecated
129 interface Listener {
130
131 }
132 }