refactor: throw exception when setting and getting visibility (#6658)

* refactor: throw exception when setting and getting visibility * refactor: always return true when isvisible is called * refactor: make section and widget return true for isvisible
vaadin · Oct 10, 2024 · 6f16553 · 6f16553
1 parent cd72fd8
commit 6f16553
Show file tree

Hide file tree

Showing 5 changed files with 88 additions and 0 deletions.
diff --git a/...nt/vaadin-dashboard-flow/src/main/java/com/vaadin/flow/component/dashboard/Dashboard.java b/...nt/vaadin-dashboard-flow/src/main/java/com/vaadin/flow/component/dashboard/Dashboard.java
@@ -369,6 +369,21 @@ public Stream<Component> getChildren() {
         return childrenComponents.stream();
     }
 
+    /**
+     * @throws UnsupportedOperationException
+     *             Dashboard does not support setting visibility
+     */
+    @Override
+    public void setVisible(boolean visible) {
+        throw new UnsupportedOperationException(
+                "Dashboard does not support setting visibility");
+    }
+
+    @Override
+    public boolean isVisible() {
+        return true;
+    }
+
     @Override
     protected void onAttach(AttachEvent attachEvent) {
         super.onAttach(attachEvent);

diff --git a/...in-dashboard-flow/src/main/java/com/vaadin/flow/component/dashboard/DashboardSection.java b/...in-dashboard-flow/src/main/java/com/vaadin/flow/component/dashboard/DashboardSection.java
@@ -151,6 +151,21 @@ public void removeFromParent() {
         getParent().ifPresent(parent -> ((Dashboard) parent).remove(this));
     }
 
+    /**
+     * @throws UnsupportedOperationException
+     *             Dashboard section does not support setting visibility
+     */
+    @Override
+    public void setVisible(boolean visible) {
+        throw new UnsupportedOperationException(
+                "Dashboard section does not support setting visibility");
+    }
+
+    @Override
+    public boolean isVisible() {
+        return true;
+    }
+
     private void doRemoveAll() {
         new ArrayList<>(widgets).forEach(this::doRemoveWidget);
     }

diff --git a/...din-dashboard-flow/src/main/java/com/vaadin/flow/component/dashboard/DashboardWidget.java b/...din-dashboard-flow/src/main/java/com/vaadin/flow/component/dashboard/DashboardWidget.java
@@ -155,6 +155,21 @@ public void setHeader(Component header) {
         SlotUtils.setSlot(this, "header", header);
     }
 
+    /**
+     * @throws UnsupportedOperationException
+     *             Dashboard widget does not support setting visibility
+     */
+    @Override
+    public void setVisible(boolean visible) {
+        throw new UnsupportedOperationException(
+                "Dashboard widget does not support setting visibility");
+    }
+
+    @Override
+    public boolean isVisible() {
+        return true;
+    }
+
     private void notifyParentDashboardOrSection() {
         getParent().ifPresent(parent -> {
             if (parent instanceof Dashboard dashboard) {

diff --git a/...dashboard-flow/src/test/java/com/vaadin/flow/component/dashboard/tests/DashboardTest.java b/...dashboard-flow/src/test/java/com/vaadin/flow/component/dashboard/tests/DashboardTest.java
@@ -852,6 +852,34 @@ public void setDashboardEditable_removeWidget_widgetIsRemoved() {
         Assert.assertFalse(actualNodeIds.contains(nodeIdToBeRemoved));
     }
 
+    @Test
+    public void setDashboardVisibility_exceptionIsThrown() {
+        Assert.assertThrows(UnsupportedOperationException.class,
+                () -> dashboard.setVisible(false));
+        Assert.assertThrows(UnsupportedOperationException.class,
+                () -> dashboard.setVisible(true));
+    }
+
+    @Test
+    public void setDashboardSectionVisibility_exceptionIsThrown() {
+        DashboardSection section = dashboard.addSection();
+        Assert.assertThrows(UnsupportedOperationException.class,
+                () -> section.setVisible(false));
+        Assert.assertThrows(UnsupportedOperationException.class,
+                () -> section.setVisible(true));
+    }
+
+    @Test
+    public void getDashboardVisibility_returnsTrue() {
+        Assert.assertTrue(dashboard.isVisible());
+    }
+
+    @Test
+    public void getSectionVisibility_returnsTrue() {
+        DashboardSection section = dashboard.addSection();
+        Assert.assertTrue(section.isVisible());
+    }
+
     private void fireItemRemovedEvent(int nodeId) {
         ComponentUtil.fireEvent(dashboard,
                 new DashboardItemRemovedEvent(dashboard, false, nodeId));

diff --git a/...ard-flow/src/test/java/com/vaadin/flow/component/dashboard/tests/DashboardWidgetTest.java b/...ard-flow/src/test/java/com/vaadin/flow/component/dashboard/tests/DashboardWidgetTest.java
@@ -249,4 +249,19 @@ public void setContentToWidgetWithHeader_contentAndHeaderCorrectlyRetrieved() {
         Assert.assertEquals(content, widget.getContent());
         Assert.assertEquals(header, widget.getHeader());
     }
+
+    @Test
+    public void setWidgetVisibility_exceptionIsThrown() {
+        DashboardWidget widget = new DashboardWidget();
+        Assert.assertThrows(UnsupportedOperationException.class,
+                () -> widget.setVisible(false));
+        Assert.assertThrows(UnsupportedOperationException.class,
+                () -> widget.setVisible(true));
+    }
+
+    @Test
+    public void getWidgetVisibility_returnsTrue() {
+        DashboardWidget widget = new DashboardWidget();
+        Assert.assertTrue(widget.isVisible());
+    }
 }