View Javadoc
1   /**
2    * This file Copyright (c) 2010-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.ui.form.field.transformer.Transformer;
37  import info.magnolia.ui.form.field.transformer.basic.ListToSetTransformer;
38  
39  /**
40   * Field definition for radio and check box select field.
41   *
42   * @deprecated since 6.2 - use {@link info.magnolia.ui.field.CheckBoxGroupFieldDefinition} and
43   *      {@link info.magnolia.ui.field.RadioButtonGroupFieldDefinition} instead.
44   *
45   * @see <a href="https://documentation.magnolia-cms.com/display/DOCS62/Upgrading+to+Magnolia+6.2.x">Upgrading to Magnolia 6.2.x</a>
46   */
47  @Deprecated
48  public class OptionGroupFieldDefinition extends SelectFieldDefinition {
49  
50      private boolean multiselect = false;
51      private Layout layout = Layout.vertical;
52  
53      /**
54       * Option group need a specific {@link Transformer} in order to handle the conversion between Set and List.
55       */
56      @SuppressWarnings("unchecked")
57      public OptionGroupFieldDefinition() {
58          setTransformerClass((Class<? extends Transformer<?>>) (Object) ListToSetTransformer.class);
59      }
60  
61      public boolean isMultiselect() {
62          return multiselect;
63      }
64  
65      public void setMultiselect(boolean multiple) {
66          this.multiselect = multiple;
67      }
68  
69      /**
70       * Defines whether options should be displayed horizontally or vertically.
71       *
72       * @return a <code>Layout</code> enum value corresponding to current orientation. Defaults to <code>Layout.vertical</code>.
73       * @see Layout
74       */
75      public Layout getLayout() {
76          return layout;
77      }
78  
79      public void setLayout(Layout layout) {
80          this.layout = layout;
81      }
82  }