1 /**
2 * This file Copyright (c) 2013-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.form.field.component;
35
36 import info.magnolia.ui.vaadin.integration.NullItem;
37
38 import org.apache.commons.lang3.StringUtils;
39
40 import com.vaadin.ui.Component;
41 import com.vaadin.ui.CustomComponent;
42 import com.vaadin.ui.Layout;
43
44 /**
45 * Base implementation of {@link ContentPreviewComponent}.<br>
46 *
47 * @param <T>.
48 */
49 public abstract class AbstractContentPreviewComponent<T> extends CustomComponent implements ContentPreviewComponent<T> {
50
51 protected String workspace;
52 protected Component contentDetail;
53 protected Component contentPreview;
54 protected Layout rootLayout;
55
56 public AbstractContentPreviewComponent(String workspace) {
57 this.workspace = workspace;
58 }
59
60 /**
61 * On value change: <br>
62 * - Clear the Root component <br>
63 * - Retrieve/Refresh the related item (based on the itemReference)<br>
64 * - Refresh the Content Detail and Preview component.
65 */
66 @Override
67 public void onValueChange(String itemReference) {
68 T item = null;
69 clearRootLayout();
70 if (StringUtils.isNotBlank(itemReference)) {
71 item = refreshItem(itemReference);
72 }
73 if (item != null && !(item instanceof NullItem)) {
74 contentDetail = refreshContentDetail(item);
75 contentPreview = refreshContentPreview(item);
76 refreshRootLayout();
77 }
78 }
79
80 /**
81 * Refresh the Content detail. <br>
82 * This method should be triggered by {@link ContentPreviewComponent#onValueChange(String)} in case of value changes.
83 */
84 abstract protected Component refreshContentDetail(T item);
85
86 /**
87 * Refresh the Content Preview.
88 * This method should be triggered by {@link ContentPreviewComponent#onValueChange(String)} in case of value changes.
89 */
90 abstract protected Component refreshContentPreview(T item);
91
92 /**
93 * Based on the item path, retrieve the corresponding item. This Item is the used to refresh the content component's.
94 */
95 abstract protected T refreshItem(String itemPath);
96
97 /**
98 * Clear the root layout.
99 */
100 protected void clearRootLayout() {
101 this.rootLayout.setVisible(false);
102 this.rootLayout.removeAllComponents();
103 removeStyleName("done");
104 }
105
106 /**
107 * Refresh the root layout.
108 */
109 protected void refreshRootLayout() {
110 this.rootLayout.setVisible(true);
111 addStyleName("done");
112 rootLayout.addComponent(contentPreview);
113 rootLayout.addComponent(contentDetail);
114 }
115
116 }