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.contentapp.browser;
35  
36  import info.magnolia.objectfactory.ComponentProvider;
37  import info.magnolia.ui.availability.AvailabilityChecker;
38  import info.magnolia.ui.contentapp.Datasource;
39  import info.magnolia.ui.contentapp.FilterableHierarchicalDataProvider;
40  import info.magnolia.ui.contentapp.configuration.GridViewDefinition;
41  import info.magnolia.ui.observation.DatasourceObservation;
42  
43  import java.util.stream.Stream;
44  
45  import javax.inject.Inject;
46  
47  import com.vaadin.ui.TreeGrid;
48  
49  /**
50   * Handles some datasource related presentation logic on behalf of {@link TreeView}.
51   *
52   * @param <T>
53   *     data type tree view is working with
54   */
55  public abstract class TreePresenter<T> extends GridViewPresenter<T> {
56  
57      @Inject
58      public TreePresenter(
59              GridViewDefinition<T> definition,
60              ComponentProvider componentProvider,
61              AvailabilityChecker availabilityChecker,
62              Datasource<T> datasource,
63              DatasourceObservation datasourceObservation
64      ) {
65          super(definition, componentProvider, availabilityChecker, datasource, datasourceObservation);
66      }
67  
68      public TreePresenter(
69              GridViewDefinition<T> definition,
70              ComponentProvider componentProvider,
71              AvailabilityChecker availabilityChecker,
72              Datasource<T> datasource
73      ) {
74          super(definition, componentProvider, availabilityChecker, datasource, componentProvider.getComponent(DatasourceObservation.class));
75      }
76  
77      @Override
78      protected TreeGrid<T> createGrid() {
79          return new MagnoliaTreeGrid<>(
80                  propertySet(),
81                  this::isItemAvailable,
82                  this::isPropertyEditable,
83                  datasource
84          );
85      }
86  
87      public TreeGrid<T> grid() {
88          return (TreeGrid<T>) super.grid();
89      }
90  
91      public abstract Stream<T> getParents(T item);
92  
93      @Override
94      protected FilterableHierarchicalDataProvider<T> dataProvider() {
95          //noinspection unchecked
96          return (FilterableHierarchicalDataProvider<T>) super.dataProvider();
97      }
98  
99      @Override
100     public abstract FilterableHierarchicalDataProvider<T> createDataProvider();
101 }