1 /**
2 * This file Copyright (c) 2013-2016 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.definition;
35
36 import info.magnolia.ui.form.field.transformer.composite.CompositeTransformer;
37
38 import java.util.ArrayList;
39 import java.util.Collections;
40 import java.util.List;
41
42 import org.slf4j.Logger;
43 import org.slf4j.LoggerFactory;
44
45 import com.google.common.base.Function;
46 import com.google.common.collect.Lists;
47
48 /**
49 * Configures a composite field, i.e. a composition of {@link info.magnolia.ui.form.field.definition.FieldDefinition fields},
50 * presented in a horizontal or vertical layout.
51 */
52 public class CompositeFieldDefinition extends ConfiguredFieldDefinition {
53
54 private static final Logger log = LoggerFactory.getLogger(CompositeFieldDefinition.class);
55
56 private List<ConfiguredFieldDefinition> fields = new ArrayList<ConfiguredFieldDefinition>();
57 private Layout layout = Layout.horizontal;
58
59 /**
60 * Set default {@link info.magnolia.ui.form.field.transformer.Transformer}.
61 */
62 public CompositeFieldDefinition() {
63 setTransformerClass(CompositeTransformer.class);
64 }
65
66 public List<ConfiguredFieldDefinition> getFields() {
67 return fields;
68 }
69
70 public void setFields(List<ConfiguredFieldDefinition> fields) {
71 this.fields = fields;
72 }
73
74 public void addField(ConfiguredFieldDefinition field) {
75 this.fields.add(field);
76 }
77
78 /**
79 * @return an unmodifiable list of the field names.
80 */
81 public List<String> getFieldNames() {
82 // List#transform gives a view on the original list; we don't want client usages to mess with it
83 return Collections.unmodifiableList(Lists.transform(fields, new Function<ConfiguredFieldDefinition, String>() {
84 @Override
85 public String apply(ConfiguredFieldDefinition fieldDefinition) {
86 return fieldDefinition.getName();
87 }
88 }));
89 }
90
91 /**
92 * @deprecated since 5.3.9 - use {@link CompositeFieldDefinition#getFieldNames()} instead.
93 */
94 @Deprecated
95 public List<String> getFieldsName() {
96 return getFieldNames();
97 }
98
99 /**
100 * @deprecated since 5.3.9. It is not supported to add only a field name.
101 */
102 @Deprecated
103 public void addFieldName(String fieldName) {
104 log.warn("CompositeFieldDefinition#addFieldName is deprecated and has no effect. Please adjust your code accordingly.");
105 }
106
107 /**
108 * @return desired select part layout.
109 */
110 public Layout getLayout() {
111 return layout;
112 }
113
114 public void setLayout(Layout layout) {
115 this.layout = layout;
116 }
117
118 }