View Javadoc
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.form.field.factory;
35  
36  import info.magnolia.cms.i18n.I18nContentSupport;
37  import info.magnolia.cms.i18n.Messages;
38  import info.magnolia.objectfactory.ComponentProvider;
39  import info.magnolia.ui.api.context.UiContext;
40  import info.magnolia.ui.api.i18n.I18NAuthoringSupport;
41  import info.magnolia.ui.form.field.SwitchableField;
42  import info.magnolia.ui.form.field.definition.ConfiguredFieldDefinition;
43  import info.magnolia.ui.form.field.definition.Layout;
44  import info.magnolia.ui.form.field.definition.OptionGroupFieldDefinition;
45  import info.magnolia.ui.form.field.definition.SelectFieldDefinition;
46  import info.magnolia.ui.form.field.definition.StaticFieldDefinition;
47  import info.magnolia.ui.form.field.definition.SwitchableFieldDefinition;
48  import info.magnolia.ui.form.field.transformer.Transformer;
49  import info.magnolia.ui.form.field.transformer.composite.DelegatingCompositeFieldTransformer;
50  
51  import java.util.ArrayList;
52  import java.util.List;
53  
54  import javax.inject.Inject;
55  
56  import org.apache.commons.lang3.StringUtils;
57  import org.slf4j.Logger;
58  import org.slf4j.LoggerFactory;
59  
60  import com.vaadin.v7.data.Item;
61  import com.vaadin.v7.data.util.PropertysetItem;
62  import com.vaadin.v7.ui.Field;
63  
64  /**
65   * Creates a {@link SwitchableField} based on a {@link SwitchableFieldDefinition}.
66   *
67   * <p>The {@link SwitchableField} has two components: <br>
68   * - A select section configured based on the {@linkplain SwitchableFieldDefinition#getOptions() options} list of the definition<br>
69   * - A field section configured based on the {@linkplain SwitchableFieldDefinition#getFields() fields} list of the definition<br>
70   * The link between select and fields is based on the association of: <br>
71   * - The String property defined into the value property of the definition (value = date) <br>
72   * and<br>
73   * - The Field name defined into the Fields set (Date field named date).
74   *
75   * @param <D> definition type
76   */
77  public class SwitchableFieldFactory<D extends SwitchableFieldDefinition> extends AbstractFieldFactory<D, PropertysetItem> {
78  
79      private static final Logger log = LoggerFactory.getLogger(SwitchableFieldFactory.class);
80  
81      private final FieldFactoryFactory fieldFactoryFactory;
82      private final ComponentProvider componentProvider;
83      private final I18NAuthoringSupport i18nAuthoringSupport;
84  
85      @Inject
86      public SwitchableFieldFactory(D definition, Item relatedFieldItem, UiContext uiContext, I18NAuthoringSupport i18nAuthoringSupport, FieldFactoryFactory fieldFactoryFactory, ComponentProvider componentProvider) {
87          super(definition, relatedFieldItem, uiContext, i18nAuthoringSupport);
88          this.fieldFactoryFactory = fieldFactoryFactory;
89          this.componentProvider = componentProvider;
90          this.i18nAuthoringSupport = i18nAuthoringSupport;
91      }
92  
93      /**
94       * @deprecated since 5.4.7 - use {@link #SwitchableFieldFactory(SwitchableFieldDefinition, Item, UiContext, I18NAuthoringSupport, FieldFactoryFactory, ComponentProvider)} instead.
95       */
96      @Deprecated
97      public SwitchableFieldFactory(D definition, Item relatedFieldItem, FieldFactoryFactory fieldFactoryFactory, ComponentProvider componentProvider, I18NAuthoringSupport i18nAuthoringSupport) {
98          this(definition, relatedFieldItem, null, i18nAuthoringSupport, fieldFactoryFactory, componentProvider);
99  
100     }
101 
102     /**
103      * @deprecated since 5.3.5 removing i18nContentSupport dependency (actually unused way before that). Besides, fields should use i18nAuthoringSupport for internationalization.
104      */
105     @Deprecated
106     public SwitchableFieldFactory(D definition, Item relatedFieldItem, FieldFactoryFactory fieldFactoryFactory, I18nContentSupport i18nContentSupport, ComponentProvider componentProvider) {
107         this(definition, relatedFieldItem, null, componentProvider.getComponent(I18NAuthoringSupport.class), fieldFactoryFactory, componentProvider);
108     }
109 
110     @Override
111     protected Field<PropertysetItem> createFieldComponent() {
112         // FIXME change i18n setting : MGNLUI-1548
113         Messages messages = getMessages();
114         if (messages != null) {
115             definition.setI18nBasename(messages.getBasename());
116         }
117 
118         // create the select field definition
119         if (!containsSelectFieldDefinition()) {
120             definition.addField(createSelectFieldDefinition());
121         }
122 
123         return new SwitchableField(definition, fieldFactoryFactory, componentProvider, item, i18nAuthoringSupport);
124     }
125 
126     /**
127      * Create a new Instance of {@link Transformer}.
128      */
129     @Override
130     protected Transformer<?> initializeTransformer(Class<? extends Transformer<?>> transformerClass) {
131         // fieldNames list is unmodifiable, ensure safe usage in transformers (e.g. MailSecurityTransformer)
132         List<String> propertyNames = new ArrayList<>(definition.getFieldNames());
133         if (!propertyNames.contains(definition.getName())) {
134             propertyNames.add(definition.getName());
135         }
136         final Transformer<?> transformer = this.componentProvider.newInstance(transformerClass, item, definition, PropertysetItem.class, propertyNames, i18nAuthoringSupport);
137         transformer.setLocale(getLocale());
138         return transformer;
139     }
140 
141     /**
142      * @return true if the select field definition was already initialized.
143      */
144     private boolean containsSelectFieldDefinition() {
145         for (ConfiguredFieldDefinition fieldDefinition : definition.getFields()) {
146             if (StringUtils.equals(fieldDefinition.getName(), definition.getName())) {
147                 return true;
148             }
149         }
150         return false;
151     }
152 
153     /**
154      * @return {@link SelectFieldDefinition} initialized based on the {@link SwitchableFieldDefinition#getOptions()} and relevant options. <br>
155      * In case of exception, return a {@link StaticFieldDefinition} containing a warn message.
156      */
157     protected ConfiguredFieldDefinition createSelectFieldDefinition() {
158         try {
159             SelectFieldDefinition selectDefinition;
160             // Create the correct definition class
161             String layout = "horizontal";
162             if (definition.getSelectionType().equals("radio")) {
163                 selectDefinition = new OptionGroupFieldDefinition();
164                 if (definition.getLayout() == Layout.vertical) {
165                     layout = "vertical";
166                 }
167             } else {
168                 selectDefinition = new SelectFieldDefinition();
169             }
170             // Copy options to the newly created select definition. definition
171             selectDefinition.setOptions(definition.getOptions());
172             selectDefinition.setTransformerClass(null);
173             selectDefinition.setRequired(false);
174             selectDefinition.setSortOptions(false);
175             selectDefinition.setStyleName(layout);
176             selectDefinition.setName(definition.getName());
177 
178             if (definition.isI18n() && definition.getTransformerClass().isAssignableFrom(DelegatingCompositeFieldTransformer.class)) {
179                 selectDefinition.setI18n(definition.isI18n());
180             }
181             return selectDefinition;
182         } catch (Exception e) {
183             log.warn("Couldn't create the select field.", e.getMessage());
184             StaticFieldDefinition definition = new StaticFieldDefinition();
185             definition.setName(this.definition.getName());
186             definition.setValue("Select definition not correctly initialised. Please check your field configuration");
187             return definition;
188         }
189     }
190 }