View Javadoc
1   /**
2    * This file Copyright (c) 2014-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.workbench.tree;
35  
36  import info.magnolia.ui.vaadin.grid.MagnoliaTreeTable;
37  
38  import com.vaadin.v7.data.Container;
39  import com.vaadin.v7.data.Item;
40  import com.vaadin.v7.ui.TreeTable;
41  
42  /**
43   * Just like {@link RowScroller} - brings tree table rows into view and also expands the parent
44   * nodes if needed.
45   */
46  public class TreeRowScroller extends RowScroller {
47  
48      public TreeRowScroller(TreeTable table) {
49          super(table);
50      }
51  
52      @Override
53      public void bringRowIntoView(Object rowId) {
54          expandTreeToNode(rowId, false);
55          super.bringRowIntoView(rowId);
56      }
57  
58      @Override
59      public TreeTable getParent() {
60          return (TreeTable) super.getParent();
61      }
62  
63      @Override
64      protected int getItemIndex(Object itemId) {
65          if (getParent() instanceof MagnoliaTreeTable) {
66              return ((MagnoliaTreeTable)getParent()).indexOfId(itemId);
67          }
68          return super.getItemIndex(itemId);
69      }
70  
71      public void expandTreeToNode(Object id, boolean expandNode) {
72          Container.Hierarchical container = getParent().getContainerDataSource();
73          Item item = container.getItem(id);
74  
75          if (item == null) {
76              return;
77          }
78  
79          // Determine node to expand.
80          Object node = null;
81          if (!container.areChildrenAllowed(id)) {
82              node = container.getParent(id);
83          } else {
84              if (expandNode) {
85                  node = id;
86              } else {
87                  Object parent = container.getParent(id);
88                  // Check if item is root.
89                  if (parent != null) {
90                      node = parent;
91                  }
92              }
93          }
94  
95          // as long as parent is within the scope of the workbench
96          while (node != null) {
97              getParent().setCollapsed(node, false);
98              node = container.getParent(node);
99          }
100 
101     }
102 }