+ * Note: The sidebar can be in "open state" but not actually
+ * visible inside grid. See {@link #isVisibleInGrid()}.
+ *
+ * @since
+ * @return true if open, false if not
+ */
+ public boolean isOpen() {
+ return open;
+ }
+
+ @Override
+ public void setStylePrimaryName(String styleName) {
+ super.setStylePrimaryName(styleName);
+ openCloseButton.setStylePrimaryName(styleName + "-button");
+ }
+
+ }
+
/**
* Escalator used internally by grid to render the rows
*/
@@ -2793,6 +2883,8 @@ public boolean isScheduled() {
private final Footer footer = GWT.create(Footer.class);
+ private final Sidebar sidebar = GWT.create(Sidebar.class);
+
/**
* List of columns in the grid. Order defines the visible order.
*/
@@ -3385,7 +3477,7 @@ public void render(RendererCellReference cell, Object data) {
private boolean hidden = false;
- private boolean hideable = false;
+ private boolean hidable = false;
private String headerCaption = "";
@@ -3699,13 +3791,13 @@ public boolean isHidden() {
* programmatically using {@link #setHidden(boolean)}.
*
* @since
- * @param hideable
+ * @param hidable
* true if the user can hide this column,
* false if not
*/
- public void setHideable(boolean hideable) {
- this.hideable = hideable;
- // TODO update whether sidebar/popup can be opened
+ public void setHidable(boolean hidable) {
+ this.hidable = hidable;
+ grid.updateSideBarVisibility();
}
/**
@@ -3719,8 +3811,8 @@ public void setHideable(boolean hideable) {
* @return true if the user can hide the column,
* false if not
*/
- public boolean isHideable() {
- return hideable;
+ public boolean isHidable() {
+ return hidable;
}
@Override
@@ -4444,6 +4536,7 @@ public void setStylePrimaryName(String style) {
super.setStylePrimaryName(style);
escalator.setStylePrimaryName(style);
editor.setStylePrimaryName(style);
+ sidebar.setStylePrimaryName(style + "-sidebar");
String rowStyle = getStylePrimaryName() + "-row";
rowHasDataStyleName = rowStyle + "-has-data";
@@ -6945,4 +7038,52 @@ public void resetSizesFromDom() {
public void recalculateColumnWidths() {
autoColumnWidthsRecalculator.schedule();
}
+
+ /**
+ * Setter for displaying the grid's {@link Sidebar}. The sidebar is visible
+ * automatically when there are {@link Column#setHidable(boolean) hidable
+ * columns}.
+ *
+ * Setting the sidebar visible doens't open it - it only shows the button
+ * for opening it. For opening and closing the sidebar use
+ * {@link Sidebar#open()} and {@link Sidebar#close()}.
+ *
+ * @since
+ * @param visible
+ * true for showing the sidebar, false
+ * for removing it
+ */
+ public void setSidebarVisible(boolean visible) {
+ if ((sidebar.getParent() != null) != visible) {
+ if (visible) {
+ getElement().appendChild(sidebar.getElement());
+ setParent(sidebar, this);
+ } else {
+ sidebar.getElement().removeFromParent();
+ sidebar.removeFromParent();
+ }
+ }
+ }
+
+ /**
+ * Returns the sidebar for this grid.
+ *
+ * @since
+ * @return
+ */
+ public Sidebar getSidebar() {
+ return sidebar;
+ }
+
+ private void updateSideBarVisibility() {
+ boolean visible = false;
+ for (Column c : getColumns()) {
+ if (c.isHidable()) {
+ visible = true;
+ break;
+ }
+ }
+ setSidebarVisible(visible);
+ }
+
}
diff --git a/uitest/src/com/vaadin/tests/components/grid/basicfeatures/GridColumnHidingTest.java b/uitest/src/com/vaadin/tests/components/grid/basicfeatures/GridColumnHidingTest.java
index 6d38c25fb61..ba4468da2c0 100644
--- a/uitest/src/com/vaadin/tests/components/grid/basicfeatures/GridColumnHidingTest.java
+++ b/uitest/src/com/vaadin/tests/components/grid/basicfeatures/GridColumnHidingTest.java
@@ -16,7 +16,12 @@
package com.vaadin.tests.components.grid.basicfeatures;
import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertNull;
+import static org.junit.Assert.assertTrue;
+
+import java.util.List;
import org.junit.Before;
import org.junit.Test;
@@ -127,6 +132,85 @@ public void testColumnHiding_onVisibilityChange_triggersClientSideEvent() {
assertEquals(false, hidden);
}
+ @Test
+ public void testColumnHidability_onTriggerColumnHidability_showsSidebarButton() {
+ WebElement sidebar = getSidebar();
+ assertNull(sidebar);
+
+ toggleHidableColumn(0);
+
+ sidebar = getSidebar();
+ assertNotNull(sidebar);
+ }
+
+ @Test
+ public void testColumnHidability_triggeringColumnHidabilityWithSeveralColumns_showsAndHidesSiderbarButton() {
+ verifySidebarNotVisible();
+
+ toggleHidableColumn(3);
+ toggleHidableColumn(4);
+
+ verifySidebarVisible();
+
+ toggleHidableColumn(3);
+
+ verifySidebarVisible();
+
+ toggleHidableColumn(4);
+
+ verifySidebarNotVisible();
+ }
+
+ @Test
+ public void testColumnHidability_clickingSidebarButton_opensClosesSidebar() {
+ toggleHidableColumn(0);
+ verifySidebarClosed();
+
+ getSidebarOpenButton().click();
+
+ verifySidebarOpened();
+
+ getSidebarOpenButton().click();
+
+ verifySidebarClosed();
+ }
+
+ private void verifySidebarOpened() {
+ WebElement sidebar = getSidebar();
+ assertTrue(sidebar.getAttribute("class").contains("opened"));
+ }
+
+ private void verifySidebarClosed() {
+ WebElement sidebar = getSidebar();
+ assertFalse(sidebar.getAttribute("class").contains("opened"));
+ }
+
+ private void verifySidebarNotVisible() {
+ WebElement sidebar = getSidebar();
+ assertNull(sidebar);
+ }
+
+ private void verifySidebarVisible() {
+ WebElement sidebar = getSidebar();
+ assertNotNull(sidebar);
+ }
+
+ private WebElement getSidebar() {
+ List