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