1 /**
2 * This file Copyright (c) 2013-2015 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
39 import javax.jcr.Node;
40
41 import com.vaadin.ui.HasComponents;
42
43 /**
44 * Allows authors to create components with locale-dependent controls.
45 */
46 public interface I18NAuthoringSupport {
47
48 /**
49 * Returns the available locales for the given page, area or component node.
50 */
51 List<Locale> getAvailableLocales(Node node);
52
53 void i18nize(HasComponents fieldContainer, Locale locale);
54
55 String createI18NURI(Node node, Locale locale);
56
57 /**
58 * @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()}.
59 * @see <a href="https://jira.magnolia-cms.com/browse/MGNLUI-3221">[MGNLUI-3221] All authors share the same authoring locale</a>
60 */
61 @Deprecated
62 Locale getAuthorLocale();
63
64 }