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