1 /**
2 * This file Copyright (c) 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.framework.layout;
35
36 import info.magnolia.objectfactory.Components;
37 import info.magnolia.ui.field.EditorPropertyDefinition;
38 import info.magnolia.ui.framework.layout.field.FieldComponentDecorator;
39 import info.magnolia.ui.vaadin.extension.FocusFieldCaption;
40
41 import java.util.Map;
42
43 import javax.inject.Inject;
44
45 import com.vaadin.ui.Component;
46 import com.vaadin.ui.FormLayout;
47
48 /**
49 * A simple form layout.
50 * @see FormLayoutDefinition
51 */
52 public class FormLayoutProducer implements FieldLayoutProducer<FormLayoutDefinition> {
53
54 private final FieldComponentDecorator fieldComponentDecorator;
55
56 @Inject
57 protected FormLayoutProducer(FieldComponentDecorator fieldComponentDecorator) {
58 this.fieldComponentDecorator = fieldComponentDecorator;
59 }
60
61 /**
62 * @deprecated since 6.2.2. Use {@link #FormLayoutProducer(info.magnolia.ui.framework.layout.field.FieldComponentDecorator)} instead.
63 */
64 @Deprecated
65 public FormLayoutProducer() {
66 this(Components.getComponent(FieldComponentDecorator.class));
67 }
68
69 @Override
70 public Component createLayout(FormLayoutDefinition definition, Map<EditorPropertyDefinition, Component> mappings) {
71 final FormLayout formLayout = new FormLayout();
72 formLayout.setMargin(false);
73 mappings.entrySet().forEach(entry -> formLayout.addComponent(createFieldComponentLayout(entry.getValue(), entry.getKey())));
74 FocusFieldCaption.focusCaptionOf(formLayout);
75 return formLayout;
76 }
77
78 private Component createFieldComponentLayout(Component component, EditorPropertyDefinition editorPropertyDefinition) {
79 return fieldComponentDecorator.decorateField(component, editorPropertyDefinition);
80 }
81 }