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.editor; 35 36 import info.magnolia.i18nsystem.I18nable; 37 import info.magnolia.ui.field.EditorPropertyDefinition; 38 import info.magnolia.ui.field.FieldDefinition; 39 import info.magnolia.ui.framework.layout.FieldLayoutDefinition; 40 import info.magnolia.ui.framework.layout.LayoutDefinition; 41 42 import java.util.List; 43 import java.util.Optional; 44 import java.util.stream.Collectors; 45 46 /** 47 * Defines a form. A form typically contains simple fields/components, such as text fields, checkboxes, selects, etc. or complex fields which are themselves forms. 48 * Each form has a layout associated to it. 49 * 50 * @see FieldDefinition 51 * @see LayoutDefinition 52 * 53 * @param <T> 54 */ 55 @I18nable 56 public interface FormDefinition<T> extends EditorDefinition<T> { 57 58 List<EditorPropertyDefinition> getProperties(); 59 60 FieldLayoutDefinition getLayout(); 61 62 default Optional<EditorPropertyDefinition> getFieldDefinition(String id) { 63 return getProperties() 64 .stream() 65 .filter(fieldDefinition -> id.equals(fieldDefinition.getName())) 66 .findFirst(); 67 } 68 69 default List<FieldDefinition> getFieldDefinitions() { 70 return getProperties() 71 .stream() 72 .filter(FieldDefinition.class::isInstance) 73 .map(FieldDefinition.class::cast).collect(Collectors.toList()); 74 } 75 76 default List<ComplexPropertyDefinition> getSubFormDefinitions() { 77 return getProperties() 78 .stream() 79 .filter(ComplexPropertyDefinition.class::isInstance) 80 .map(ComplexPropertyDefinition.class::cast).collect(Collectors.toList()); 81 } 82 83 default boolean hasI18NProperties() { 84 return getProperties().stream().anyMatch(EditorPropertyDefinition::isI18n); 85 } 86 }