View Javadoc
1   /**
2    * This file Copyright (c) 2012-2015 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.vaadin.grid;
35  
36  import java.util.Collection;
37  import java.util.Map;
38  
39  import org.apache.commons.lang.StringEscapeUtils;
40  import org.slf4j.Logger;
41  import org.slf4j.LoggerFactory;
42  
43  import com.vaadin.data.Property;
44  import com.vaadin.data.Validator;
45  import com.vaadin.shared.ui.treetable.TreeTableState;
46  import com.vaadin.ui.TreeTable;
47  
48  /**
49   * VMagnoliaTreeTable.
50   */
51  public class MagnoliaTreeTable extends TreeTable {
52  
53      private static Logger log = LoggerFactory.getLogger(MagnoliaTreeTable.class);
54  
55      public MagnoliaTreeTable() {
56          addStyleName("v-magnolia-table");
57          setCacheRate(4);
58      }
59  
60      /**
61       * This method is made public in order to be able to delegate the call to
62       * tree tables' {@link HierarchicalStrategy} instead of the actual container
63       * which can be very slow.
64       */
65      @Override
66      public int indexOfId(Object itemId) {
67          return super.indexOfId(itemId);
68      }
69  
70      @Override
71      protected String formatPropertyValue(Object rowId, Object colId, Property<?> property) {
72          String result = super.formatPropertyValue(rowId, colId, property);
73          return StringEscapeUtils.escapeHtml(result);
74      }
75  
76      @Override
77      public void changeVariables(Object source, Map<String, Object> variables) {
78          super.changeVariables(source, variables);
79          if (variables.containsKey("selectAll")) {
80              boolean selectAll = (Boolean) variables.get("selectAll");
81              if (selectAll) {
82                  Collection<?> ids = getItemIds();
83                  for (final Object id : ids) {
84                      select(id);
85                  }
86              } else {
87                  setValue(null);
88              }
89          }
90  
91          if (variables.containsKey("toggleSelection")) {
92              boolean selected = (Boolean) variables.get("toggleSelection");
93              String key = String.valueOf(variables.get("toggledRowId"));
94              final Object id = itemIdMapper.get(key);
95              if (selected) {
96                  select(id);
97              } else {
98                  unselect(id);
99              }
100         }
101     }
102 
103     /**
104      * MGNLUI-729 Overridden so that table is not marked as dirty without changes. This was made to prevent selection from being sent over again.
105      * Beware, this breaks the normal state update mechanism and might require that you mark it as dirty explicitly.
106      */
107     @Override
108     protected TreeTableState getState() {
109         return (TreeTableState) getState(false);
110     }
111 
112     /**
113      * MGNLUI-962 Overridden to fulfill AbstractField's repaintIsNotNeeded, super impl returns empty collection instead.
114      */
115     @Override
116     public Collection<Validator> getValidators() {
117         return null;
118     }
119 }