View Javadoc
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.I18nText;
37  import info.magnolia.ui.framework.WithImplementation;
38  
39  import java.util.List;
40  
41  import lombok.Data;
42  
43  /**
44   * Multiform definition.
45   *
46   * @param <T>
47   *     item type.
48   */
49  @EditorType("multiFormEditor")
50  public interface MultiFormDefinition<T> extends EditorDefinition<T> {
51  
52      MultiFormView.EntryResolution.Definition<T> getEntryResolution();
53  
54      OrderHandlerDefinition<T> getOrderHandler();
55  
56      boolean isCanRemoveItems();
57  
58      @I18nText(fallback = "buttons.add")
59      default String getButtonSelectAddLabel() {
60          return null;
61      }
62  
63      @I18nText(fallback = "buttons.delete")
64      default String getButtonSelectRemoveLabel() {
65          return null;
66      }
67  
68      interface OrderHandler<T> {
69          void applyOrder(List<T> items);
70      }
71  
72      @Data
73      class OrderHandlerDefinition<T> implements WithImplementation<OrderHandler<T>> {
74          Class<? extends OrderHandler<T>> implementationClass;
75  
76          public static class Noop<T> extends OrderHandlerDefinition<T> {
77             public Noop() {
78                 setImplementationClass((Class) NoopOrderHandler.class);
79             }
80          }
81      }
82  
83      class NoopOrderHandler<T> implements OrderHandler<T> {
84  
85          @Override
86          public void applyOrder(List<T> items) {
87          }
88      }
89  
90  }