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