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.ui.form.field.transformer.composite.SwitchableTransformer;
39  
40  import java.util.ArrayList;
41  import java.util.List;
42  
43  /**
44   * Field definition for a switchable field.
45   *
46   * @deprecated since 6.2 - use {@link info.magnolia.ui.field.ConfiguredSwitchableFieldDefinition} instead.
47   *
48   * @see <a href="https://documentation.magnolia-cms.com/display/DOCS62/Upgrading+to+Magnolia+6.2.x">Upgrading to Magnolia 6.2.x</a>
49   */
50  @Deprecated
51  @MgnlDeprecated(since = "6.2", description = "Use new framework and info.magnolia.ui.field.ConfiguredSwitchableFieldDefinition instead.")
52  public class SwitchableFieldDefinition extends CompositeFieldDefinition {
53      private String selectionType = "radio";
54  
55      private List<SelectFieldOptionDefinition> options = new ArrayList<>();
56  
57      /**
58       * Set default {@link info.magnolia.ui.form.field.transformer.Transformer}.
59       */
60      public SwitchableFieldDefinition() {
61          setTransformerClass(SwitchableTransformer.class);
62      }
63  
64      /**
65       * Default selectionType is 'radio'.
66       *
67       * @return the desired selection field (radio:OptionGroupFieldDefinition, select:).
68       */
69      public String getSelectionType() {
70          return selectionType;
71      }
72  
73      /**
74       * @return SelectFieldOptionDefinition. The value (for example 'text') of the Option should match with a <br>
75       * ConfiguredFieldDefinition name of the fields list.
76       */
77      public List<SelectFieldOptionDefinition> getOptions() {
78          return options;
79      }
80  
81      public void setSelectionType(String selectionType) {
82          this.selectionType = selectionType;
83      }
84  
85      public void setOptions(List<SelectFieldOptionDefinition> options) {
86          this.options = options;
87      }
88  
89  }