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