1 /**
2 * This file Copyright (c) 2013 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.overlay;
35
36 import info.magnolia.ui.api.overlay.OverlayLayer;
37 import info.magnolia.ui.vaadin.gwt.client.dialog.connector.OverlayState;
38 import info.magnolia.ui.vaadin.gwt.client.dialog.rpc.OverlayClientRpc;
39 import info.magnolia.ui.vaadin.gwt.client.dialog.rpc.OverlayServerRpc;
40
41 import com.vaadin.ui.AbstractSingleComponentContainer;
42 import com.vaadin.ui.Component;
43
44 /**
45 * A Single component container that includes a "glass" or "curtain" which dims out and prevents interaction on the elements
46 * below it. It is different than a Vaadin Window in that ONLY the component that it is attached to receives the modal glass.
47 * It is only modal within the component that it is added to.
48 * Positioning of the glass and component depends on one of the parents having css position set to relative or absolute.
49 */
50 public class Overlay extends AbstractSingleComponentContainer {
51
52 /**
53 * Timeout listener interface.
54 */
55 public interface Listener {
56 void onOverlayClosed();
57 };
58
59 private Listener listener;
60
61 public Overlay(final Component content, final Component overlayParent, final OverlayLayer.ModalityDomain modalityDomain, final OverlayLayer.ModalityLevel modalityLevel) {
62 setImmediate(true);
63
64 content.addStyleName("overlay-child");
65 setContent(content);
66 getState().overlayContent = content;
67 getState().overlayParent = overlayParent;
68
69 this.addStyleName("overlay");
70 this.addStyleName("open");
71
72 // Set css classes of Modal
73 this.addStyleName(modalityDomain.getCssClass());
74 this.addStyleName(modalityLevel.getCssClass());
75
76 registerRpc(new OverlayServerRpc() {
77 @Override
78 public void onClosed() {
79 if (listener != null) {
80 listener.onOverlayClosed();
81 }
82 }
83 });
84 }
85
86 public void setListener(Listener listener) {
87 this.listener = listener;
88 }
89
90 @Override
91 protected OverlayState getState() {
92 return (OverlayState) super.getState();
93 }
94
95 public void setCloseTimeout(int closeTimeout) {
96 getState().closeTimeout = closeTimeout;
97 }
98
99 public void close() {
100 getRpcProxy(OverlayClientRpc.class).close();
101 }
102
103 @Override
104 public void detach() {
105 if (getParent() != null) {
106 super.detach();
107 }
108 }
109 }