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 static java.util.stream.Collectors.toSet;
37  
38  import info.magnolia.objectfactory.Components;
39  import info.magnolia.ui.ValueContext;
40  import info.magnolia.ui.contentapp.configuration.TreeViewDefinition;
41  import info.magnolia.ui.filter.DataFilter;
42  import info.magnolia.ui.filter.FilterContext;
43  
44  import java.util.Set;
45  
46  import javax.inject.Inject;
47  
48  import com.vaadin.ui.TreeGrid;
49  
50  /**
51   * Tree content view implementation.
52   * @param <T> item type.
53   */
54  public class TreeView<T> extends GridView<T, TreePresenter<T>> implements ContentView {
55  
56      @Inject
57      public TreeView(ValueContext<T> valueContext, TreeViewDefinition<T> definition, FilterContext filterContext) {
58          super(valueContext, definition);
59  
60          final TreeGrid<T> treeGrid = treeGrid();
61          treeGrid.addCollapseListener(e -> treeGrid.getEditor().cancel());
62          treeGrid.addSelectionListener(e -> expandParents(e.getAllSelectedItems()));
63  
64          //make sure items expanded when selected in flat (filtering) mode and returned to tree mode (all filters cleared)
65          filterContext.getFilter().observe(dataFilter -> dataFilter
66                  .filter(DataFilter::isEmpty)
67                  .ifPresent(any -> expandParents(valueContext.get().collect(toSet())))
68          );
69      }
70  
71      /**
72       * @deprecated since 6.2.4. Use {@link #TreeView(info.magnolia.ui.ValueContext, info.magnolia.ui.contentapp.configuration.TreeViewDefinition, info.magnolia.ui.filter.FilterContext)} instead.
73       */
74      @Deprecated
75      public TreeView(ValueContext<T> valueContext, TreeViewDefinition<T> definition) {
76          this(valueContext, definition, Components.getComponent(FilterContext.class));
77      }
78  
79      @Override
80      protected TreePresenter<T> createPresenter() {
81          return create(TreePresenter.class, this, this.definition);
82      }
83  
84      protected TreeGrid<T> treeGrid() {
85          return (TreeGrid<T>) this.grid;
86      }
87  
88      private void expandParents(Set<T> items) {
89          treeGrid().expand(items.stream()
90                  .filter(presenter::isItemAvailable)
91                  .flatMap(presenter::getParents)
92                  .collect(toSet())
93          );
94      }
95  }