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.workbench.column.definition;
35
36 import info.magnolia.ui.api.app.AppDescriptor;
37 import info.magnolia.ui.api.app.SubAppDescriptor;
38 import info.magnolia.ui.api.i18n.AbstractAppKeyGenerator;
39 import info.magnolia.ui.workbench.definition.ContentPresenterDefinition;
40
41 import java.lang.reflect.AnnotatedElement;
42 import java.util.List;
43
44 /**
45 * Key generator for {@link ColumnDefinition}. Generates key in form <app-name>.<sub-app-name>.views.<view-name>.<column-name>.<property-name>.
46 */
47 public class ColumnDefinitionKeyGenerator extends AbstractAppKeyGenerator<ColumnDefinition> {
48
49 private static final String VIEWS = "views";
50
51 @Override
52 protected void keysFor(List<String> keys, ColumnDefinition columnDefinition, AnnotatedElement el) {
53 Object root = getRoot(columnDefinition);
54 if (!(root instanceof AppDescriptor)) {
55 // TODO handle ChooseDialog if needed
56 return;
57 }
58 AppDescriptor appDescriptor = (AppDescriptor) root;
59 SubAppDescriptor subAppDescriptor = null;
60 ContentPresenterDefinition contentPresenterDefinition = null;
61 List<?> ancestors = getAncestors(columnDefinition);
62 for (Object ancestor : ancestors) {
63 if (ancestor instanceof SubAppDescriptor) {
64 subAppDescriptor = (SubAppDescriptor) ancestor;
65 continue;
66 }
67 if (ancestor instanceof ContentPresenterDefinition) {
68 contentPresenterDefinition = (ContentPresenterDefinition) ancestor;
69 continue;
70 }
71 }
72 final String appName = appDescriptor.getName();
73 final String viewType = contentPresenterDefinition != null ? contentPresenterDefinition.getViewType() : null;
74 final String columnName = columnDefinition.getName();
75 final String fieldOrGetterName = fieldOrGetterName(el);
76 if (subAppDescriptor != null) {
77 // app specific, view-specific
78 if (viewType != null) {
79 addKey(keys, appName, subAppDescriptor.getName(), VIEWS, viewType, columnName, fieldOrGetterName);
80 }
81 addKey(keys, appName, subAppDescriptor.getName(), VIEWS, columnName, fieldOrGetterName);
82 }
83 if (viewType != null) {
84 // sub-app specific, all views
85 addKey(keys, appName, VIEWS, viewType, columnName, fieldOrGetterName);
86 }
87 // app specific, all views
88 addKey(keys, appName, VIEWS, columnName, fieldOrGetterName);
89 if (viewType != null) {
90 // all apps, view-specific
91 addKey(keys, VIEWS, viewType, columnName, fieldOrGetterName);
92 }
93 // all apps, all views
94 addKey(keys, VIEWS, columnName, fieldOrGetterName);
95 }
96 }