View Javadoc

1   /**
2    * This file Copyright (c) 2013-2014 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.actionbar.definition;
35  
36  import info.magnolia.i18nsystem.AbstractI18nKeyGenerator;
37  import info.magnolia.ui.api.app.AppDescriptor;
38  import info.magnolia.ui.api.app.SubAppDescriptor;
39  
40  import java.lang.reflect.AnnotatedElement;
41  import java.lang.reflect.InvocationTargetException;
42  import java.lang.reflect.Method;
43  import java.util.List;
44  
45  /**
46   * An I18n key generator for the actionbar section labels.
47   */
48  public class ActionbarSectionDefinitionKeyGenerator extends AbstractI18nKeyGenerator<ActionbarSectionDefinition> {
49  
50      /**
51       * Will generate keys for the message bundle in the following form <code> &lt;app-name&gt;.&lt;sub-app-name&gt;.actionbar.sections.&lt;section-name&gt;[.name of getter or field annotated with {@link info.magnolia.i18nsystem.I18nText}]</code>.
52       */
53      @Override
54      protected void keysFor(List<String> keys, ActionbarSectionDefinition sectionDefinition, AnnotatedElement el) {
55          Object root = getRoot(sectionDefinition);
56          if (!(root instanceof AppDescriptor)) {
57              // not an app descriptor, but can be MessageView with an ID
58              try {
59                  final Method getId = root.getClass().getMethod("getId");
60                  String messageViewId = (String) getId.invoke(root);
61                  addKey(keys, messageViewId.replace(':', '.').replace('/', '.'), "actionbar", "sections", sectionDefinition.getName(), fieldOrGetterName(el));
62              } catch (NoSuchMethodException e) {
63                  // not a MessageView - log this?
64              } catch (InvocationTargetException e) {
65                  throw new RuntimeException(e); // TODO MGNLUI-2031
66              } catch (IllegalAccessException e) {
67                  throw new RuntimeException(e); // TODO MGNLUI-2031
68              }
69  
70              return;
71          }
72          AppDescriptor appDescriptor = (AppDescriptor) root;
73          SubAppDescriptor subAppDescriptor = null;
74          List<?> ancestors = getAncestors(sectionDefinition);
75          for (Object ancestor : ancestors) {
76              if (ancestor instanceof SubAppDescriptor) {
77                  subAppDescriptor = (SubAppDescriptor) ancestor;
78                  break;
79              }
80          }
81          final String appName = appDescriptor.getName();
82          final String sectionName = sectionDefinition.getName();
83          final String subappName = subAppDescriptor != null ? subAppDescriptor.getName() : "";
84          addKey(keys, appName, subappName, "actionbar", "sections", sectionName, fieldOrGetterName(el));
85      }
86  
87  
88  }