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.api.i18n;
35
36 import java.util.List;
37 import java.util.Locale;
38 import java.util.Objects;
39
40 import javax.jcr.Node;
41
42 import com.vaadin.ui.HasComponents;
43 import com.vaadin.v7.data.Item;
44
45 /**
46 * Allows authors to create components with locale-dependent controls.
47 *
48 * @param <T>
49 * domain item type
50 */
51 public interface I18NAuthoringSupport<T> {
52
53 default boolean isDefaultLocale(Locale locale, T item) {
54 return Objects.equals(locale, getDefaultLocale(item));
55 }
56
57 String deriveLocalisedPropertyName(String base, Locale locale);
58
59 List<Locale> getAvailableLocales(T node);
60
61 Locale getDefaultLocale(T node);
62
63 /**
64 * @deprecated I18nAuthoringSupport is an instance singleton, and should not be used to sync UI state of a specific user. Since 5.3.9, use {@link info.magnolia.ui.api.app.SubAppContext#getAuthoringLocale() SubAppContext#getAuthoringLocale()}.
65 * @see <a href="https://jira.magnolia-cms.com/browse/MGNLUI-3221">[MGNLUI-3221] All authors share the same authoring locale</a>
66 */
67 @Deprecated
68 Locale getAuthorLocale();
69
70 /**
71 * @deprecated since 5.4.2 without a substitute - the i18n-ready components should now take
72 * of switching the language on their own.
73 */
74 @Deprecated
75 void i18nize(HasComponents fieldContainer, Locale locale);
76
77 /**
78 * @deprecated since 6.0 - use {@link #getAvailableLocales(Node)} (Node)} instead.
79 */
80 @Deprecated
81 default List<Locale> getAvailableLocales(Item item) {
82 throw new UnsupportedOperationException("Operations with pre-Vaadin 8 Items is no longer supported by default");
83 }
84
85 /**
86 * @deprecated since 6.0 - use {@link #getDefaultLocale(Node)} instead.
87 */
88 @Deprecated
89 default Locale getDefaultLocale(Item item) {
90 throw new UnsupportedOperationException("Operations with pre-Vaadin 8 Items is no longer supported by default");
91 }
92
93 /**
94 * @deprecated since 6.0 - use {@link #isDefaultLocale(Locale, Node)} instead.
95 */
96 @Deprecated
97 default boolean isDefaultLocale(Locale locale, Item item) {
98 throw new UnsupportedOperationException("Operations with pre-Vaadin 8 Items is no longer supported by default");
99 }
100
101 /**
102 * @deprecated since 6.0 without explicit replacement, this part of interface is no longer used in the system.
103 */
104 @Deprecated
105 default String createI18NURI(Node node, Locale locale) {
106 throw new UnsupportedOperationException();
107 }
108 }