1 /**
2 * This file Copyright (c) 2019 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.field;
35
36 import info.magnolia.ui.datasource.locale.LocaleSelectFieldSupport;
37 import info.magnolia.ui.editor.LocaleContext;
38
39 import java.util.Locale;
40
41 import javax.inject.Inject;
42
43 import com.vaadin.data.provider.DataProvider;
44 import com.vaadin.data.provider.Query;
45 import com.vaadin.server.SerializableConsumer;
46 import com.vaadin.ui.ComboBox;
47
48
49 /**
50 * Available locale drop down to be used within form dialogs and other editor views (in order
51 * to switch between different languages).
52 */
53 public class LocaleSelector extends ComboBox<Locale> {
54
55 /**
56 * Convenience ctor which creates an instance of LocaleSelector based on available locales synchronized with {@link info.magnolia.ui.editor.LocaleContext}.
57 */
58 @Inject
59 public LocaleSelector(LocaleSelectFieldSupport localeSelectFieldSupport, LocaleContext localeContext) {
60 this(localeSelectFieldSupport);
61
62 addValueChangeListener(locale -> localeContext.current().set(locale.getValue()));
63 localeContext.current().observeNullable(this::setValue);
64 }
65
66 /**
67 * Convenience ctor which creates an instance of LocaleSelector based on available locales.
68 */
69 public LocaleSelector(LocaleSelectFieldSupport localeSelectFieldSupport) {
70 setDataProvider(localeSelectFieldSupport.getDataProvider());
71 setItemCaptionGenerator(localeSelectFieldSupport.getItemCaptionGenerator());
72 setEmptySelectionAllowed(false);
73 setTextInputAllowed(false);
74 updateVisibility();
75 }
76
77 @Override
78 protected <F> SerializableConsumer<F> internalSetDataProvider(DataProvider<Locale, F> dataProvider, F initialFilter) {
79 SerializableConsumer<F> consumer = super.internalSetDataProvider(dataProvider, initialFilter);
80 dataProvider.addDataProviderListener(event -> updateVisibility());
81 return consumer;
82 }
83
84 private <F> void updateVisibility() {
85 setVisible(getDataProvider().size(new Query<>()) > 1);
86 }
87 }