- * Note: You don't need to add the popover component before opening it, - * because opening a popover will automatically add it to the {@code
} - * if it's not yet attached anywhere. - *- * When using {@link #setFor(String)} it is recommended to manually add the - * popover to the UI instead, and to ensure it is placed in the same DOM - * scope (document or shadow root) as the component with the given ID. */ public void open() { setOpened(true); @@ -253,9 +224,6 @@ public void open() { /** * Closes the popover. - *
- * Note: This method also removes the popover component from the DOM after - * closing it, unless you have added the component manually. */ public void close() { setOpened(false); @@ -697,6 +665,9 @@ private void updateTrigger() { *
* By default, the popover can be opened with a click on the target * component. + *
+ * Note: setting target will also add the popover to the {@code
} if + * it's not yet attached anywhere. * * @param target * the target component for this popover, can be {@code null} to @@ -717,6 +688,11 @@ public void setTarget(Component target) { this.target = target; if (target == null) { + if (autoAddedToTheUi) { + getElement().removeFromParent(); + autoAddedToTheUi = false; + } + getElement().executeJs("this.target = null"); return; } @@ -726,10 +702,22 @@ public void setTarget(Component target) { target.getUI().ifPresent(this::onTargetAttach); targetAttachRegistration = target .addAttachListener(e -> onTargetAttach(e.getUI())); + target.addDetachListener(e -> { + if (autoAddedToTheUi) { + getElement().removeFromParent(); + autoAddedToTheUi = false; + } + }); } private void onTargetAttach(UI ui) { if (target != null) { + ui.beforeClientResponse(ui, context -> { + if (getElement().getNode().getParent() == null) { + ui.addToModalComponent(this); + autoAddedToTheUi = true; + } + }); getElement().executeJs("this.target = $0", target.getElement()); } } @@ -858,45 +846,6 @@ protected void onAttach(AttachEvent attachEvent) { updateVirtualChildNodeIds(); } - private UI getCurrentUI() { - UI ui = UI.getCurrent(); - if (ui == null) { - throw new IllegalStateException("UI instance is not available. " - + "It means that you are calling this method " - + "out of a normal workflow where it's always implicitly set. " - + "That may happen if you call the method from the custom thread without " - + "'UI::access' or from tests without proper initialization."); - } - return ui; - } - - private void ensureAttached() { - UI ui = getCurrentUI(); - StateTree.ExecutionRegistration addToUiRegistration = ui - .beforeClientResponse(ui, context -> { - if (getElement().getNode().getParent() == null - && isOpened()) { - ui.addToModalComponent(this); - autoAddedToTheUi = true; - } - if (afterProgrammaticNavigationListenerRegistration != null) { - afterProgrammaticNavigationListenerRegistration - .remove(); - } - }); - if (ui.getSession() != null) { - afterProgrammaticNavigationListenerRegistration = ui - .addAfterNavigationListener(event -> { - if (event.getLocationChangeEvent() - .getTrigger() == NavigationTrigger.PROGRAMMATIC) { - addToUiRegistration.remove(); - afterProgrammaticNavigationListenerRegistration - .remove(); - } - }); - } - } - /** * Updates the virtualChildNodeIds property of the popover element. *diff --git a/vaadin-popover-flow-parent/vaadin-popover-flow/src/test/java/com/vaadin/flow/component/popover/PopoverAutoAddTest.java b/vaadin-popover-flow-parent/vaadin-popover-flow/src/test/java/com/vaadin/flow/component/popover/PopoverAutoAddTest.java index c86a715a494..97f7686521a 100644 --- a/vaadin-popover-flow-parent/vaadin-popover-flow/src/test/java/com/vaadin/flow/component/popover/PopoverAutoAddTest.java +++ b/vaadin-popover-flow-parent/vaadin-popover-flow/src/test/java/com/vaadin/flow/component/popover/PopoverAutoAddTest.java @@ -22,6 +22,7 @@ import org.mockito.Mockito; import com.vaadin.flow.component.UI; +import com.vaadin.flow.component.html.Div; import com.vaadin.flow.server.VaadinSession; /** @@ -45,21 +46,39 @@ public void tearDown() { } @Test - public void open_autoAttachedInBeforeClientResponse() { + public void setTarget_autoAttachedInBeforeClientResponse() { Popover popover = new Popover(); - popover.open(); + Div target = new Div(); + popover.setTarget(target); + ui.add(target); fakeClientResponse(); Assert.assertNotNull(popover.getElement().getParent()); } @Test - public void open_close_notAutoAttachedInBeforeClientResponse() { + public void setTarget_clearTarget_notAutoAttachedInBeforeClientResponse() { Popover popover = new Popover(); - popover.open(); + Div target = new Div(); + popover.setTarget(target); + ui.add(target); fakeClientResponse(); - popover.close(); + popover.setTarget(null); + + fakeClientResponse(); + Assert.assertNull(popover.getElement().getParent()); + } + + @Test + public void setTarget_detachTarget_notAutoAttachedInBeforeClientResponse() { + Popover popover = new Popover(); + Div target = new Div(); + popover.setTarget(target); + ui.add(target); + fakeClientResponse(); + + ui.remove(target); fakeClientResponse(); Assert.assertNull(popover.getElement().getParent());