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.chooser.definition;
35
36 import static info.magnolia.ui.contentapp.action.ChooseActionDefinition.CHOOSE_ACTION_NAME;
37 import static info.magnolia.ui.contentapp.action.CloseActionDefinition.CLOSE_ACTION_NAME;
38
39 import info.magnolia.ui.ViewDefinition;
40 import info.magnolia.ui.chooser.Chooser;
41 import info.magnolia.ui.contentapp.action.ChooseActionDefinition;
42 import info.magnolia.ui.contentapp.action.CloseActionDefinition;
43 import info.magnolia.ui.datasource.DatasourceDefinition;
44 import info.magnolia.ui.datasource.WithDatasource;
45 import info.magnolia.ui.dialog.ConfiguredDialogDefinition;
46 import info.magnolia.ui.dialog.layout.DefaultEditorActionLayoutDefinition;
47
48 import java.util.Arrays;
49
50 import lombok.Data;
51 import lombok.EqualsAndHashCode;
52
53 /**
54 * Definition for creating a chooser.
55 *
56 * @param <T> type of items to be chosen
57 * @param <C> type of chooser to be created
58 */
59 @Data
60 @EqualsAndHashCode(callSuper = true)
61 public class ChooserDefinition<T, C extends Chooser<T>> extends ConfiguredDialogDefinition implements ViewDefinition<C>, WithDatasource<DatasourceDefinition> {
62
63 private DatasourceDefinition datasource;
64 private Class<C> implementationClass;
65
66 public ChooserDefinition() {
67 getActions().put(CHOOSE_ACTION_NAME, new ChooseActionDefinition());
68 getActions().put(CLOSE_ACTION_NAME, new CloseActionDefinition());
69 final DefaultEditorActionLayoutDefinitionnition.html#DefaultEditorActionLayoutDefinition">DefaultEditorActionLayoutDefinition footerLayout = new DefaultEditorActionLayoutDefinition();
70 footerLayout.setPrimaryActions(Arrays.asList(CHOOSE_ACTION_NAME, CLOSE_ACTION_NAME));
71 setFooterLayout(footerLayout);
72 }
73
74 @Override
75 public String getName() {
76 return "chooser";
77 }
78
79 /**
80 * @deprecated since 6.2.3. Use {@link info.magnolia.ui.field.LinkFieldDefinition#setDatasource(info.magnolia.ui.datasource.DatasourceDefinition)} instead.
81 */
82 @Deprecated
83 public void setDatasource(DatasourceDefinition datasource) {
84 this.datasource = datasource;
85 }
86
87 /**
88 * @deprecated since 6.2.3. Use {@link info.magnolia.ui.field.LinkFieldDefinition#getDatasource()} instead.
89 */
90 @Deprecated
91 public DatasourceDefinition getDatasource() {
92 return datasource;
93 }
94 }