From 173ac5b1def8785ac5b1c5b1fdd08b8bdf09b936 Mon Sep 17 00:00:00 2001 From: Yuriy Artamonov Date: Thu, 29 Jun 2017 09:44:16 +0400 Subject: [PATCH] Provide old value of position in SplitPositionChangeEvent of *SplitPanel (#9578) Provide old value of position in SplitPositionChangeEvent of *SplitPanel New properties have been added to SplitPositionChangeEvent: oldSplitPositionUnit, oldSplitPosition, userOriginated Resolves #9472 --- .../com/vaadin/ui/AbstractSplitPanel.java | 76 +++++++++++++++++-- .../ui/SplitPositionChangeListenerTest.java | 41 ++++++++-- 2 files changed, 106 insertions(+), 11 deletions(-) diff --git a/server/src/main/java/com/vaadin/ui/AbstractSplitPanel.java b/server/src/main/java/com/vaadin/ui/AbstractSplitPanel.java index 93afdcfc2a..898a25674f 100644 --- a/server/src/main/java/com/vaadin/ui/AbstractSplitPanel.java +++ b/server/src/main/java/com/vaadin/ui/AbstractSplitPanel.java @@ -64,9 +64,12 @@ public abstract class AbstractSplitPanel extends AbstractComponentContainer { @Override public void setSplitterPosition(float position) { + float oldPosition = getSplitPosition(); + getSplitterState().position = position; - fireEvent(new SplitPositionChangeEvent(AbstractSplitPanel.this, - position, getSplitPositionUnit())); + + fireEvent(new SplitPositionChangeEvent(AbstractSplitPanel.this, true, + oldPosition, getSplitPositionUnit(), position, getSplitPositionUnit())); } }; @@ -331,13 +334,16 @@ public abstract class AbstractSplitPanel extends AbstractComponentContainer { if (unit != Unit.PERCENTAGE) { pos = Math.round(pos); } + float oldPosition = getSplitPosition(); + Unit oldUnit = getSplitPositionUnit(); + SplitterState splitterState = getSplitterState(); splitterState.position = pos; splitterState.positionUnit = unit.getSymbol(); splitterState.positionReversed = reverse; posUnit = unit; - fireEvent(new SplitPositionChangeEvent(AbstractSplitPanel.this, pos, - posUnit)); + fireEvent(new SplitPositionChangeEvent(AbstractSplitPanel.this, false, + oldPosition, oldUnit, pos, posUnit)); } /** @@ -559,24 +565,84 @@ public abstract class AbstractSplitPanel extends AbstractComponentContainer { */ public static class SplitPositionChangeEvent extends Component.Event { + private final float oldPosition; + private final Unit oldUnit; + private final float position; private final Unit unit; + private final boolean userOriginated; + public SplitPositionChangeEvent(final Component source, - final float position, final Unit unit) { + final boolean userOriginated, + final float oldPosition, final Unit oldUnit, + final float position, final Unit unit) { super(source); + this.userOriginated = userOriginated; + this.oldUnit = oldUnit; + this.oldPosition = oldPosition; this.position = position; this.unit = unit; } + /** + * Returns the new split position that triggered this change event. + * + * @since 7.5.0 + * + * @return the new value of split position + */ public float getSplitPosition() { return position; } + /** + * Returns the new split position unit that triggered this change event. + * + * @since 7.5.0 + * + * @return the new value of split position + */ public Unit getSplitPositionUnit() { return unit; } + /** + * Returns the position of the split before this change event occurred. + * + * @since 8.1 + * + * @return the split position previously set to the source of this event + */ + public float getOldSplitPosition() { + return oldPosition; + } + + /** + * Returns the position unit of the split before this change event + * occurred. + * + * @since 8.1 + * + * @return the split position unit previously set to the source of + * this event + */ + public Unit getOldSplitPositionUnit() { + return oldUnit; + } + + /** + * Returns whether this event was triggered by user interaction, on the + * client side, or programmatically, on the server side. + * + * @since 8.1 + * + * @return {@code true} if this event originates from the client, + * {@code false} otherwise. + */ + public boolean isUserOriginated() { + return userOriginated; + } } public Registration addSplitterClickListener( diff --git a/server/src/test/java/com/vaadin/ui/SplitPositionChangeListenerTest.java b/server/src/test/java/com/vaadin/ui/SplitPositionChangeListenerTest.java index 10bde6e151..2c2509560f 100644 --- a/server/src/test/java/com/vaadin/ui/SplitPositionChangeListenerTest.java +++ b/server/src/test/java/com/vaadin/ui/SplitPositionChangeListenerTest.java @@ -15,15 +15,19 @@ */ package com.vaadin.ui; -import static org.mockito.Matchers.any; -import static org.mockito.Mockito.mock; -import static org.mockito.Mockito.verify; - -import org.junit.Test; - import com.vaadin.server.Sizeable.Unit; import com.vaadin.ui.AbstractSplitPanel.SplitPositionChangeEvent; import com.vaadin.ui.AbstractSplitPanel.SplitPositionChangeListener; +import org.junit.Test; + +import java.util.concurrent.atomic.AtomicBoolean; + +import static org.junit.Assert.assertEquals; +import static org.junit.Assert.assertFalse; +import static org.junit.Assert.assertTrue; +import static org.mockito.Matchers.any; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.verify; /** * Test for {@link SplitPositionChangeListener} @@ -42,4 +46,29 @@ public class SplitPositionChangeListenerTest { verify(splitPositionChangeListener) .onSplitPositionChanged(any(SplitPositionChangeEvent.class)); } + + @Test + public void testSplitPositionListenerContainsOldValues() throws Exception { + final HorizontalSplitPanel splitPanel = new HorizontalSplitPanel(); + + float previousPosition = 50.0f; + float newPosition = 125.0f; + + AtomicBoolean executed = new AtomicBoolean(false); + + splitPanel.setSplitPosition(previousPosition, Unit.PERCENTAGE); + splitPanel.addSplitPositionChangeListener(event -> { + assertFalse(event.isUserOriginated()); + + assertTrue(previousPosition == event.getOldSplitPosition()); + assertEquals(Unit.PERCENTAGE, event.getOldSplitPositionUnit()); + + assertTrue(newPosition == event.getSplitPosition()); + assertEquals(Unit.PIXELS, event.getSplitPositionUnit()); + + executed.set(true); + }); + splitPanel.setSplitPosition(newPosition, Unit.PIXELS); + assertTrue(executed.get()); + } } -- 2.39.5