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