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.form;
35
36 import info.magnolia.ui.field.ComplexPropertyDefinition;
37 import info.magnolia.ui.field.EditorPropertyDefinition;
38 import info.magnolia.ui.field.FieldDefinition;
39 import info.magnolia.ui.framework.databinding.layout.LayoutDefinition;
40
41 import java.util.List;
42 import java.util.stream.Collectors;
43
44 /**
45 * Defines a form. A form typically contains simple fields/components, such as text fields, checkboxes, selects, etc. or complex fields which are themselves forms.
46 * Each form has a layout associated to it.
47 *
48 * @see FieldDefinition
49 * @see LayoutDefinition
50 *
51 * @param <T>
52 */
53 public interface FormDefinition<T> extends EditorDefinition<T> {
54
55 List<EditorPropertyDefinition> getProperties();
56
57 LayoutDefinition getLayout();
58
59 default List<FieldDefinition> getFieldDefinitions() {
60 return getProperties()
61 .stream()
62 .filter(FieldDefinition.class::isInstance)
63 .map(FieldDefinition.class::cast).collect(Collectors.toList());
64 }
65
66 default List<ComplexPropertyDefinition> getSubFormDefinitions() {
67 return getProperties()
68 .stream()
69 .filter(ComplexPropertyDefinition.class::isInstance)
70 .map(ComplexPropertyDefinition.class::cast).collect(Collectors.toList());
71 }
72 }