View Javadoc
1   /**
2    * This file Copyright (c) 2014-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.field.transformer.multi;
35  
36  import info.magnolia.ui.form.field.transformer.Transformer;
37  
38  import com.vaadin.v7.data.Property;
39  import com.vaadin.v7.data.util.PropertysetItem;
40  
41  /**
42   * Defines a {@link Transformer} that supports properties with multiple values.
43   * In particular it is capable of creating new — or removing existing {@link Property Properties} on the related form item.
44   * 
45   * @see {@link info.magnolia.ui.form.field.MultiField MultiField};
46   */
47  public interface MultiTransformer extends Transformer<PropertysetItem> {
48  
49      /**
50       * Creates and returns a new property associated to the root item.
51       */
52      public Property<?> createProperty();
53  
54      /**
55       * Removes a property from the root item.
56       * 
57       * @param id the property identifier as specified by the concrete {@link Transformer} implementation
58       */
59      public void removeProperty(Object id);
60  }