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