1 /** 2 * This file Copyright (c) 2012-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.form; 35 36 import info.magnolia.cms.i18n.Messages; 37 import info.magnolia.cms.i18n.MessagesUtil; 38 39 import java.util.ArrayList; 40 import java.util.List; 41 42 import org.apache.commons.lang3.StringUtils; 43 44 /** 45 * Abstract base class for dialog items, provides resolution of {@link Messages} in the hierarchical. 46 * 47 * @see Messages 48 * @see FormItem 49 */ 50 public abstract class AbstractFormItem implements FormItem { 51 52 private FormItem parent; 53 54 private static String[] UI_BASENAMES; 55 56 static { 57 String uiPackagePrefix = "info.magnolia.ui."; 58 String[] uiModules = { "admincentral", "model", "framework", "widget.actionbar", "widget.dialog", "widget.editor", "widget.magnoliashell", "widget.tabsheet", "vaadin.integration" }; 59 List<String> basenames = new ArrayList<String>(); 60 for (String module : uiModules) { 61 basenames.add(uiPackagePrefix + module + ".messages"); 62 } 63 UI_BASENAMES = basenames.toArray(new String[] {}); 64 } 65 66 @Override 67 public void setParent(FormItem parent) { 68 this.parent = parent; 69 } 70 71 @Override 72 public FormItem getParent() { 73 return parent; 74 } 75 76 @Override 77 /** 78 * @deprecated since 5.1. You should use {@link info.magnolia.i18nsystem.I18nizer} mechanism instead. 79 */ 80 @Deprecated 81 public Messages getMessages() { 82 Messages messages = null; 83 if (getParent() != null) { 84 messages = getParent().getMessages(); 85 } else { 86 messages = MessagesUtil.chain(UI_BASENAMES); 87 } 88 if (StringUtils.isNotBlank(getI18nBasename())) { 89 messages = MessagesUtil.chain(getI18nBasename(), messages); 90 } 91 return messages; 92 } 93 94 /** 95 * @deprecated since 5.1. You should use {@link info.magnolia.i18nsystem.I18nizer} mechanism instead. 96 */ 97 @Deprecated 98 protected abstract String getI18nBasename(); 99 100 /** 101 * @deprecated since 5.1. You should use {@link info.magnolia.i18nsystem.I18nizer} mechanism instead. 102 */ 103 @Deprecated 104 public String getMessage(String key) { 105 String message = getMessages().get(key); 106 return message != null && !message.startsWith("???") ? message : key; 107 } 108 }