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.annotation.deprecation.MgnlDeprecated;
37  
38  import info.magnolia.i18nsystem.I18nText;
39  import info.magnolia.i18nsystem.I18nable;
40  
41  /**
42   * Simple pojo used to define options used in selection.
43   */
44  
45  @I18nable(keyGenerator = SelectFieldOptionDefinitionKeyGenerator.class)
46  @MgnlDeprecated(since = "5.4.3,", description = "Use new framework and info.magnolia.ui.form.field.factory.SelectFieldFactory.DefaultOptionComparator instead.")
47  public class SelectFieldOptionDefinition implements Comparable<SelectFieldOptionDefinition> {
48  
49      // Value saved to the repository and displayed to the user.
50      private String value;
51      // Name of the property that stores the selected value.
52      private String name;
53      // Sets the option as pre-selected
54      private boolean selected = false;
55      // The human-readable label for this option.
56      private String label;
57      // Value is a path to the image.
58      private String iconSrc;
59  
60      public String getValue() {
61          return value;
62      }
63  
64      public void setValue(String value) {
65          this.value = value;
66      }
67  
68      public String getName() {
69          return name;
70      }
71  
72      public void setName(String name) {
73          this.name = name;
74      }
75  
76      public boolean isSelected() {
77          return selected;
78      }
79  
80      public void setSelected(boolean selected) {
81          this.selected = selected;
82      }
83  
84      @I18nText
85      public String getLabel() {
86          return label;
87      }
88  
89      public void setLabel(String label) {
90          this.label = label;
91      }
92  
93      public String getIconSrc() {
94          return iconSrc;
95      }
96  
97      public void setIconSrc(String iconSrc) {
98          this.iconSrc = iconSrc;
99      }
100 
101     /**
102      * @deprecated since 5.4.3, please use {@link info.magnolia.ui.form.field.factory.SelectFieldFactory.DefaultOptionComparator} instead.
103      */
104     @Override
105     @Deprecated
106     public int compareTo(SelectFieldOptionDefinition arg) {
107         return this.label.compareToIgnoreCase(arg.getLabel());
108     }
109 }