View Javadoc
1   /**
2    * This file Copyright (c) 2011-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.editor.i18n;
35  
36  import info.magnolia.ui.field.FieldDefinition;
37  import info.magnolia.ui.datasource.optionlist.Option;
38  import info.magnolia.i18nsystem.I18nKeyGenerator;
39  import info.magnolia.ui.editor.AbstractFormKeyGenerator;
40  
41  import java.lang.reflect.AnnotatedElement;
42  import java.util.List;
43  
44  /**
45   * Key generator for {@link Option}. Uses the {@link EditorPropertyDefinitionKeyGenerator} to generate the parent path down to the options group.
46   * {@link I18nKeyGenerator}. Assuming there is getOptions method defined.
47   */
48  public class OptionDefinitionKeyGenerator extends AbstractFormKeyGenerator<Option> {
49  
50      @Override
51      protected void keysFor(List<String> keys, Option definition, AnnotatedElement el) {
52          FieldDefinition selectField = getParentViaCast(definition);
53  
54          I18nKeyGenerator<FieldDefinition> parentKG = getKeyGenerator(selectField);
55          String[] parentKeys;
56  
57          try {
58              // We take the method from the select field, as all that is needed is the name of the method
59              parentKeys = parentKG.keysFor(null, selectField, selectField.getClass().getMethod("getOptions"));
60  
61              for (String parentKey : parentKeys) {
62                  addKey(keys, parentKey, definition.getName());
63              }
64          } catch (NoSuchMethodException e) {
65              throw new IllegalStateException("Key generator was expecting to find a method getOptions on " + selectField.getClass().getName(), e);
66          }
67      }
68  }