1 /**
2 * This file Copyright (c) 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.extension;
35
36 import info.magnolia.ui.vaadin.gwt.client.extension.CloseIconRpc;
37
38 import java.io.Serializable;
39
40 import com.vaadin.server.AbstractExtension;
41 import com.vaadin.ui.TabSheet;
42
43 /**
44 * The {@link CloseIcon} is a Vaadin {@link com.vaadin.server.Extension Extension} for Vaadin {@link TabSheet TabSheets}.
45 *
46 * <p>It merely adds a close icon to the top-right corner,
47 * and leaves the actual closing behavior to implementation, through the {@link CloseHandler}.
48 */
49 public class CloseIcon extends AbstractExtension {
50
51 CloseIcon(TabSheet tabSheet, CloseHandler handler) {
52 extend(tabSheet);
53 registerRpc((CloseIconRpc) handler::close);
54 }
55
56 public static void extend(TabSheet tabSheet, CloseHandler handler) {
57 new CloseIcon(tabSheet, handler);
58 }
59
60 /**
61 * {@link CloseIcon}-enabled components must define what happens when pressing it with a {@link CloseHandler}.
62 */
63 @FunctionalInterface
64 public interface CloseHandler extends Serializable {
65 void close();
66 }
67 }