View Javadoc
1   /**
2    * This file Copyright (c) 2013-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.definition;
35  
36  import info.magnolia.annotation.deprecation.MgnlDeprecated;
37  
38  import info.magnolia.i18nsystem.I18nText;
39  import info.magnolia.ui.form.field.transformer.multi.MultiValueTransformer;
40  
41  /**
42   * Definition used to configure a generic multi field.
43   *
44   * @deprecated since 6.2 - use {@link info.magnolia.ui.field.JcrMultiValueFieldDefinition} instead.
45   *
46   * @see <a href="https://documentation.magnolia-cms.com/display/DOCS62/Upgrading+to+Magnolia+6.2.x">Upgrading to Magnolia 6.2.x</a>
47   */
48  @Deprecated
49  @MgnlDeprecated(since = "6.2", description = "Use new framework and info.magnolia.ui.field.JcrMultiValueFieldDefinition instead.")
50  public class MultiValueFieldDefinition extends ConfiguredFieldDefinition {
51  
52      private String buttonSelectAddLabel = "buttons.add";
53      private String buttonSelectRemoveLabel = "buttons.delete";
54      private ConfiguredFieldDefinition field;
55  
56      /**
57       * Set default {@link info.magnolia.ui.form.field.transformer.Transformer}.
58       */
59      public MultiValueFieldDefinition() {
60          setTransformerClass(MultiValueTransformer.class);
61      }
62  
63      /**
64       * @return i18n property used to configure the Add Button Label.
65       */
66      @I18nText
67      public String getButtonSelectAddLabel() {
68          return buttonSelectAddLabel;
69      }
70  
71      /**
72       * @return i18n property used to configure the Remove Button Label.
73       */
74      @I18nText
75      public String getButtonSelectRemoveLabel() {
76          return buttonSelectRemoveLabel;
77      }
78  
79      /**
80       * @return Generic field that may be used and display as multi field.
81       */
82      public ConfiguredFieldDefinition getField() {
83          return field;
84      }
85  
86      public void setButtonSelectAddLabel(String buttonSelectAddLabel) {
87          this.buttonSelectAddLabel = buttonSelectAddLabel;
88      }
89  
90      public void setButtonSelectRemoveLabel(String buttonSelectRemoveLabel) {
91          this.buttonSelectRemoveLabel = buttonSelectRemoveLabel;
92      }
93  
94      public void setField(ConfiguredFieldDefinition field) {
95          this.field = field;
96      }
97  
98  }