1 /**
2 * This file Copyright (c) 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.field;
35
36 import info.magnolia.i18nsystem.I18nText;
37 import info.magnolia.ui.framework.chooser.definition.SingleItemWorkbenchChooserDefinition;
38 import info.magnolia.ui.form.ItemPreviewDefinition;
39
40 import java.util.Optional;
41
42 import lombok.Getter;
43 import lombok.Setter;
44
45 /**
46 * Creates a link to an item provided by any kind of data source: JCR, Rest, JPA, etc.
47 * The field allows users to browse items from either a datasource or an appName specified at {@link SingleItemWorkbenchChooserDefinition}
48 *
49 * @param <T> the item type to link to.
50 * @param <DEF> datasource definition type.
51 */
52 @Getter
53 @Setter
54 public class LinkFieldDefinition<T, DEF> extends ConfiguredFieldDefinition<T> implements WithDatasource<DEF> {
55
56 private String buttonSelectNewLabel = "buttons.select.new";
57 private String buttonSelectOtherLabel = "buttons.select.another";
58 private boolean editable = true;
59 private String placeholder;
60 private SingleItemWorkbenchChooserDefinition<DEF, T> chooser;
61 private ItemPreviewDefinition<T> preview;
62
63 /**
64 * @return the button Label displayed when no link is yet selected.
65 */
66 @I18nText
67 public String getButtonSelectNewLabel() {
68 return buttonSelectNewLabel;
69 }
70
71 /**
72 * @return the button Label displayed when a link is selected.
73 */
74 @I18nText
75 public String getButtonSelectOtherLabel() {
76 return buttonSelectOtherLabel;
77 }
78
79 @I18nText
80 public String getPlaceholder() {
81 return placeholder;
82 }
83
84 @I18nText
85 public String getButtonSelectNewDefaultLabel() {
86 return this.buttonSelectNewLabel;
87 }
88
89 @I18nText
90 public String getButtonSelectOtherDefaultLabel() {
91 return this.buttonSelectOtherLabel;
92 }
93
94 @Override
95 public DEF getDatasource() {
96 return chooser.getWorkbenchChooser().getDatasource();
97 }
98
99 /**
100 * By default returns a String class.
101 * Should the field type be explicitly set, it will prevail over the default.
102 */
103 public Class<T> getType() {
104 return Optional.ofNullable(super.getType()).orElse((Class<T>)String.class);
105 }
106 }