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.chooser.definition;
35  
36  
37  import info.magnolia.ui.contentapp.configuration.ContentViewDefinition;
38  import info.magnolia.ui.contentapp.configuration.TreeViewDefinition;
39  import info.magnolia.ui.contentapp.configuration.WorkbenchDefinition;
40  import info.magnolia.ui.contentapp.configuration.column.ColumnDefinition;
41  import info.magnolia.ui.chooser.WorkbenchChooser;
42  import info.magnolia.ui.datasource.DatasourceDefinition;
43  
44  import java.util.ArrayList;
45  import java.util.Collections;
46  import java.util.List;
47  import java.util.Set;
48  
49  import org.apache.commons.lang3.ObjectUtils;
50  
51  import lombok.Data;
52  import lombok.EqualsAndHashCode;
53  
54  /**
55   * Workbench-based chooser definition, for choosing items based on a datasource.
56   *
57   * @param <T> type of items to choose from
58   */
59  @Data
60  @EqualsAndHashCode(callSuper = true)
61  public class WorkbenchChooserDefinition<T> extends ChooserDefinition<Set<T>, WorkbenchChooser<T>> {
62  
63      // TODO: Update lombok version (to 1.18.2+), so we can use @SuperBuilder and remove this duplicated field
64      private String title;
65  
66      private DatasourceDefinition datasource;
67      private WorkbenchDefinition<T> workbench;
68      private List<ColumnDefinition<T>> columns = Collections.emptyList();
69      private boolean multiSelect = true;
70  
71      @SuppressWarnings("unchecked")
72      private Class<WorkbenchChooser<T>> implementationClass = (Class) WorkbenchChooser.class;
73  
74      public WorkbenchDefinition<T> getWorkbench() {
75          return ObjectUtils.defaultIfNull(this.workbench, defaultWorkbenchDefinition());
76      }
77  
78      private WorkbenchDefinition<T> defaultWorkbenchDefinition() {
79          WorkbenchDefinition<T> definition = new WorkbenchDefinition<>();
80  
81          final TreeViewDefinition<T> treeDefinition = new TreeViewDefinition<>();
82          treeDefinition.setColumns(this.columns);
83          treeDefinition.setMultiSelect(this.isMultiSelect());
84  
85          List<ContentViewDefinition<T>> contentViewDefs = new ArrayList<>();
86          contentViewDefs.add(treeDefinition);
87          definition.setContentViews(contentViewDefs);
88  
89          return definition;
90      }
91  
92      @Override
93      public String getName() {
94          return "workbenchchooser";
95      }
96  }