* The authorizationsChangedProperty is a JavaFX property that is used to notify the UI that the authorizations have * changed */ @@ -49,10 +45,14 @@ public static void fireAuthorizationsChanged() { } public static void runOnAuthorizationsChanged(Runnable runnable) { - FXProperties.runOnPropertiesChange(() -> { - if (hasAuthorizationsChanged()) // Only on false -> true transition + FXProperties.runOnPropertyChange(changed -> { + if (changed) // Only on false -> true transition runnable.run(); }, authorizationsChangedProperty()); } + static { // All FXClass in this package should call FXInit.init() in their static initializer + FXInit.init(); // See FXInit comments to understand why + } + } diff --git a/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXAuthorizationsReceived.java b/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXAuthorizationsReceived.java index 8abeb3d41..597527b4d 100644 --- a/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXAuthorizationsReceived.java +++ b/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXAuthorizationsReceived.java @@ -4,7 +4,6 @@ import dev.webfx.platform.console.Console; import javafx.beans.property.BooleanProperty; import javafx.beans.property.ReadOnlyBooleanProperty; -import javafx.beans.property.SimpleBooleanProperty; import java.util.Objects; @@ -13,12 +12,9 @@ */ public final class FXAuthorizationsReceived { - private final static BooleanProperty authorizationsReceivedProperty = new SimpleBooleanProperty(false) { - @Override - protected void invalidated() { - Console.log("FXAuthorizationsReceived = " + get()); - } - }; + private final static BooleanProperty authorizationsReceivedProperty = FXProperties.newBooleanProperty(received -> + Console.log("FXAuthorizationsReceived = " + received) + ); public static ReadOnlyBooleanProperty authorizationsReceivedProperty() { return authorizationsReceivedProperty; @@ -39,8 +35,12 @@ else if (FXAuthorizationsChanged.hasAuthorizationsChanged()) setAuthorizationsReceived(true); } - static { - FXProperties.runNowAndOnPropertiesChange(FXAuthorizationsReceived::updateAuthorizationsReceived, FXLoggedOut.loggedOutProperty()); + static { // All FXClass in this package should call FXInit.init() in their static initializer + FXInit.init(); // See FXInit comments to understand why + } + + static void init() { // Called back (only once) by FXInit in a controlled overall sequence + FXProperties.runNowAndOnPropertyChange(FXAuthorizationsReceived::updateAuthorizationsReceived, FXLoggedOut.loggedOutProperty()); FXAuthorizationsChanged.runOnAuthorizationsChanged(FXAuthorizationsReceived::updateAuthorizationsReceived); } diff --git a/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXAuthorizationsWaiting.java b/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXAuthorizationsWaiting.java index 47e94611a..b15acac8c 100644 --- a/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXAuthorizationsWaiting.java +++ b/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXAuthorizationsWaiting.java @@ -4,7 +4,6 @@ import dev.webfx.platform.console.Console; import javafx.beans.property.BooleanProperty; import javafx.beans.property.ReadOnlyBooleanProperty; -import javafx.beans.property.SimpleBooleanProperty; import java.util.Objects; @@ -13,12 +12,9 @@ */ public final class FXAuthorizationsWaiting { - private final static BooleanProperty authorizationsWaitingProperty = new SimpleBooleanProperty(false) { - @Override - protected void invalidated() { - Console.log("FXAuthorizationsWaiting = " + get()); - } - }; + private final static BooleanProperty authorizationsWaitingProperty = FXProperties.newBooleanProperty(waiting -> + Console.log("FXAuthorizationsWaiting = " + waiting) + ); public static ReadOnlyBooleanProperty authorizationsWaitingProperty() { return authorizationsWaitingProperty; @@ -38,18 +34,18 @@ private static void updateAuthorizationsWaiting() { public static void runOnAuthorizationsChangedOrWaiting(Runnable runnable) { FXAuthorizationsChanged.runOnAuthorizationsChanged(runnable); - FXProperties.runOnPropertiesChange(() -> { - if (isAuthorizationsWaiting() || FXLoggedOut.isLoggedOut()) + FXProperties.runOnPropertyChange(loggedOut -> { + if (isAuthorizationsWaiting() || loggedOut) runnable.run(); }, FXLoggedOut.loggedOutProperty()); } - public static void init() { - // The first call will trigger the static initializer below, and subsequent calls won't do anything + static { // All FXClass in this package should call FXInit.init() in their static initializer + FXInit.init(); // See FXInit comments to understand why } - static { - FXProperties.runNowAndOnPropertiesChange(FXAuthorizationsWaiting::updateAuthorizationsWaiting, FXLoggedOut.loggedOutProperty()); + static void init() { // Called back (only once) by FXInit in a controlled overall sequence + FXProperties.runNowAndOnPropertyChange(FXAuthorizationsWaiting::updateAuthorizationsWaiting, FXLoggedOut.loggedOutProperty()); FXAuthorizationsChanged.runOnAuthorizationsChanged(FXAuthorizationsWaiting::updateAuthorizationsWaiting); } diff --git a/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXConnected.java b/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXConnected.java index 2c6e72191..77b2db74e 100644 --- a/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXConnected.java +++ b/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXConnected.java @@ -5,21 +5,17 @@ import dev.webfx.platform.console.Console; import javafx.beans.property.BooleanProperty; import javafx.beans.property.ReadOnlyBooleanProperty; -import javafx.beans.property.SimpleBooleanProperty; /** * @author Bruno Salmon */ public final class FXConnected { - private final static BooleanProperty connectedProperty = new SimpleBooleanProperty(false) { - @Override - protected void invalidated() { - Console.log("FXConnected = " + get()); - FXConnectionLost.refreshValue(); - FXReconnected.refreshValue(); - } - }; + private final static BooleanProperty connectedProperty = FXProperties.newBooleanProperty(connected -> { + Console.log("FXConnected = " + connected); + FXConnectionLost.refreshValue(); + FXReconnected.refreshValue(); + }); public static ReadOnlyBooleanProperty connectedProperty() { return connectedProperty; @@ -30,19 +26,18 @@ public static boolean isConnected() { } static void setConnected(boolean connected) { - connectedProperty.set(connected); + connectedProperty.set(connected); } public static Unregisterable runOnEachConnected(Runnable runnable) { - return FXProperties.runNowAndOnPropertiesChange(() -> { - if (isConnected()) // Only on false -> true transition + return FXProperties.runNowAndOnPropertyChange(connected -> { + if (connected) // Only on false -> true transition runnable.run(); }, connectedProperty()); } - static { - FXInit.init(); - FXConnectionSequence.init(); + static { // All FXClass in this package should call FXInit.init() in their static initializer + FXInit.init(); // See FXInit comments to understand why } } diff --git a/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXConnectionLost.java b/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXConnectionLost.java index d05e75db3..b9764a665 100644 --- a/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXConnectionLost.java +++ b/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXConnectionLost.java @@ -1,21 +1,18 @@ package dev.webfx.stack.session.state.client.fx; +import dev.webfx.kit.util.properties.FXProperties; import dev.webfx.platform.console.Console; import javafx.beans.property.BooleanProperty; import javafx.beans.property.ReadOnlyBooleanProperty; -import javafx.beans.property.SimpleBooleanProperty; /** * @author Bruno Salmon */ public final class FXConnectionLost { - private final static BooleanProperty connectionLostProperty = new SimpleBooleanProperty(false) { - @Override - protected void invalidated() { - Console.log("FXConnectionLost = " + get()); - } - }; + private final static BooleanProperty connectionLostProperty = FXProperties.newBooleanProperty(lost -> + Console.log("FXConnectionLost = " + lost) + ); public static ReadOnlyBooleanProperty connectionLostProperty() { return connectionLostProperty; @@ -36,4 +33,8 @@ private static void setConnectionLost(boolean connectionLost) { connectionLostProperty.set(connectionLost); } + static { // All FXClass in this package should call FXInit.init() in their static initializer + FXInit.init(); // See FXInit comments to understand why + } + } diff --git a/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXConnectionSequence.java b/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXConnectionSequence.java index 08e86521c..7d7dd655f 100644 --- a/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXConnectionSequence.java +++ b/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXConnectionSequence.java @@ -1,23 +1,20 @@ package dev.webfx.stack.session.state.client.fx; +import dev.webfx.kit.util.properties.FXProperties; import dev.webfx.platform.console.Console; import javafx.beans.property.IntegerProperty; import javafx.beans.property.ReadOnlyIntegerProperty; -import javafx.beans.property.SimpleIntegerProperty; /** * @author Bruno Salmon */ public final class FXConnectionSequence { - private final static IntegerProperty connectionSequence = new SimpleIntegerProperty(FXConnected.isConnected() ? 1 : 0) { - @Override - protected void invalidated() { - Console.log("FxConnectionSequence = " + get()); - FXConnectionLost.refreshValue(); - FXReconnected.refreshValue(); - } - }; + private final static IntegerProperty connectionSequence = FXProperties.newIntegerProperty(FXConnected.isConnected() ? 1 : 0, seq -> { + Console.log("FxConnectionSequence = " + seq); + FXConnectionLost.refreshValue(); + FXReconnected.refreshValue(); + }); public static int getConnectionSequence() { return connectionSequence.get(); @@ -31,10 +28,14 @@ private static void setConnectionSequence(int connectionSequence) { FXConnectionSequence.connectionSequence.set(connectionSequence); } - static void init() { - FXConnected.connectedProperty().addListener((observable, oldValue, connected) -> { + static { // All FXClass in this package should call FXInit.init() in their static initializer + FXInit.init(); // See FXInit comments to understand why + } + + static void init() { // Called back (only once) by FXInit in a controlled overall sequence + FXProperties.runOnPropertyChange(connected -> { if (connected) setConnectionSequence(getConnectionSequence() + 1); - }); + }, FXConnected.connectedProperty()); } } diff --git a/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXInit.java b/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXInit.java index d6562e579..1762700f2 100644 --- a/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXInit.java +++ b/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXInit.java @@ -5,11 +5,24 @@ import dev.webfx.stack.session.state.client.ClientSideStateSessionListener; /** + * It's important to call FXInit.init() first whatever FXClass the application code starts using. FXInit will install + * all necessary listeners over all FXClasses present in this package, so that the additional listeners possibly set by + * the application code are positioned after. This ensures that when they are called, all FX classes have already + * transitioned to a final, coherent & stable state. + * * @author Bruno Salmon */ final class FXInit { + static void init() { } // Only the first call will trigger the static initializer below, not subsequent calls + static { + FXLoggedOut.init(); + FXAuthorizationsWaiting.init(); + FXAuthorizationsReceived.init(); + FXLoggedIn.init(); + FXConnectionSequence.init(); + ClientSideStateSession.getInstance().setClientSideStateSessionHolder(new ClientSideStateSessionListener() { @Override @@ -39,7 +52,4 @@ public void onConnectedChanged(boolean connected) { }); } - static void init() { - } - } diff --git a/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXLoggedIn.java b/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXLoggedIn.java index 6bc6a7343..7e81cab1d 100644 --- a/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXLoggedIn.java +++ b/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXLoggedIn.java @@ -4,19 +4,15 @@ import dev.webfx.platform.console.Console; import javafx.beans.property.BooleanProperty; import javafx.beans.property.ReadOnlyBooleanProperty; -import javafx.beans.property.SimpleBooleanProperty; /** * @author Bruno Salmon */ public final class FXLoggedIn { - private final static BooleanProperty loggedInProperty = new SimpleBooleanProperty(false) { - @Override - protected void invalidated() { - Console.log("FXLoggedIn = " + get()); - } - }; + private final static BooleanProperty loggedInProperty = FXProperties.newBooleanProperty(loggedIn -> + Console.log("FXLoggedIn = " + loggedIn) + ); public static ReadOnlyBooleanProperty loggedInProperty() { return loggedInProperty; @@ -38,8 +34,12 @@ private static void updateLoggedIn() { setLoggedIn(FXAuthorizationsReceived.isAuthorizationsReceived()); } - static { - FXProperties.runNowAndOnPropertiesChange(FXLoggedIn::updateLoggedIn, FXAuthorizationsReceived.authorizationsReceivedProperty()); + static { // All FXClass in this package should call FXInit.init() in their static initializer + FXInit.init(); // See FXInit comments to understand why + } + + static void init() { // Called back (only once) by FXInit in a controlled overall sequence + FXProperties.runNowAndOnPropertyChange(FXLoggedIn::updateLoggedIn, FXAuthorizationsReceived.authorizationsReceivedProperty()); } } diff --git a/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXLoggedOut.java b/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXLoggedOut.java index efc29b279..47fb63148 100644 --- a/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXLoggedOut.java +++ b/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXLoggedOut.java @@ -5,19 +5,15 @@ import dev.webfx.stack.session.state.LogoutUserId; import javafx.beans.property.BooleanProperty; import javafx.beans.property.ReadOnlyBooleanProperty; -import javafx.beans.property.SimpleBooleanProperty; /** * @author Bruno Salmon */ public final class FXLoggedOut { - private final static BooleanProperty loggedOutProperty = new SimpleBooleanProperty() { - @Override - protected void invalidated() { - Console.log("FXLoggedOut = " + get()); - } - }; + private final static BooleanProperty loggedOutProperty = FXProperties.newBooleanProperty(loggedOut -> + Console.log("FXLoggedOut = " + loggedOut) + ); public static ReadOnlyBooleanProperty loggedOutProperty() { return loggedOutProperty; @@ -42,8 +38,12 @@ private static void updateLoggedOut() { setLoggedOut(LogoutUserId.isLogoutUserIdOrNull(userId)); } - static { - FXProperties.runNowAndOnPropertiesChange(FXLoggedOut::updateLoggedOut, FXUserId.userIdProperty()); + static { // All FXClass in this package should call FXInit.init() in their static initializer + FXInit.init(); // See FXInit comments to understand why + } + + static void init() { // Called back (only once) by FXInit in a controlled overall sequence + FXProperties.runNowAndOnPropertyChange(FXLoggedOut::updateLoggedOut, FXUserId.userIdProperty()); } } diff --git a/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXReconnected.java b/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXReconnected.java index 4446fad5d..af2259ec5 100644 --- a/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXReconnected.java +++ b/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXReconnected.java @@ -1,21 +1,18 @@ package dev.webfx.stack.session.state.client.fx; +import dev.webfx.kit.util.properties.FXProperties; import dev.webfx.platform.console.Console; import javafx.beans.property.BooleanProperty; import javafx.beans.property.ReadOnlyBooleanProperty; -import javafx.beans.property.SimpleBooleanProperty; /** * @author Bruno Salmon */ public final class FXReconnected { - private final static BooleanProperty reconnectedProperty = new SimpleBooleanProperty(false) { - @Override - protected void invalidated() { - Console.log("FXReconnected = " + get()); - } - }; + private final static BooleanProperty reconnectedProperty = FXProperties.newBooleanProperty(reconnected -> + Console.log("FXReconnected = " + reconnected) + ); public static ReadOnlyBooleanProperty reconnectedProperty() { return reconnectedProperty; @@ -35,4 +32,8 @@ static void refreshValue() { setReconnected(FXConnected.isConnected() && FXConnectionSequence.getConnectionSequence() >= 2); } + static { // All FXClass in this package should call FXInit.init() in their static initializer + FXInit.init(); // See FXInit comments to understand why + } + } diff --git a/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXRunId.java b/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXRunId.java index 43de3f216..2c040e987 100644 --- a/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXRunId.java +++ b/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXRunId.java @@ -5,20 +5,16 @@ import dev.webfx.stack.session.state.client.ClientSideStateSession; import javafx.beans.property.ObjectProperty; import javafx.beans.property.ReadOnlyObjectProperty; -import javafx.beans.property.SimpleObjectProperty; /** * @author Bruno Salmon */ public final class FXRunId { - private final static ObjectProperty runIdProperty = new SimpleObjectProperty<>() { - @Override - protected void invalidated() { - Console.log("FxRunId = " + get()); - ClientSideStateSession.getInstance().changeRunId(get().toString(), true, false); - } - }; + private final static ObjectProperty runIdProperty = FXProperties.newObjectProperty(runId -> { + Console.log("FxRunId = " +runId); + ClientSideStateSession.getInstance().changeRunId(runId.toString(), true, false); + }); public static ReadOnlyObjectProperty runIdProperty() { return runIdProperty; @@ -33,8 +29,8 @@ public static void setRunId(Object runId) { FXProperties.setIfNotEquals(runIdProperty, runId); } - static { - FXInit.init(); + static { // All FXClass in this package should call FXInit.init() in their static initializer + FXInit.init(); // See FXInit comments to understand why } } diff --git a/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXServerSessionId.java b/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXServerSessionId.java index cdb6b5a4c..0cfc53edc 100644 --- a/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXServerSessionId.java +++ b/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXServerSessionId.java @@ -5,21 +5,16 @@ import dev.webfx.stack.session.state.client.ClientSideStateSession; import javafx.beans.property.ObjectProperty; import javafx.beans.property.ReadOnlyObjectProperty; -import javafx.beans.property.SimpleObjectProperty; /** * @author Bruno Salmon */ public final class FXServerSessionId { - private final static ObjectProperty serverSessionIdProperty = new SimpleObjectProperty<>() { - @Override - protected void invalidated() { - Object serverSessionId = get(); - Console.log("FxServerSessionId = " + serverSessionId); - ClientSideStateSession.getInstance().changeServerSessionId(serverSessionId.toString(), true, false); - } - }; + private final static ObjectProperty serverSessionIdProperty = FXProperties.newObjectProperty(serverSessionId -> { + Console.log("FxServerSessionId = " + serverSessionId); + ClientSideStateSession.getInstance().changeServerSessionId(serverSessionId.toString(), true, false); + }); public static ReadOnlyObjectProperty serverSessionIdProperty() { return serverSessionIdProperty; @@ -33,8 +28,8 @@ static void setServerSessionId(Object serverSessionId) { FXProperties.setIfNotEquals(serverSessionIdProperty, serverSessionId); } - static { - FXInit.init(); + static { // All FXClass in this package should call FXInit.init() in their static initializer + FXInit.init(); // See FXInit comments to understand why } } diff --git a/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXSession.java b/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXSession.java index c93940eb1..235d6b979 100644 --- a/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXSession.java +++ b/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXSession.java @@ -1,26 +1,22 @@ package dev.webfx.stack.session.state.client.fx; +import dev.webfx.kit.util.properties.FXProperties; import dev.webfx.platform.console.Console; import dev.webfx.stack.session.Session; import dev.webfx.stack.session.state.client.ClientSideStateSession; import javafx.beans.property.ObjectProperty; import javafx.beans.property.ReadOnlyObjectProperty; -import javafx.beans.property.SimpleObjectProperty; /** * @author Bruno Salmon */ public final class FXSession { - private final static ObjectProperty sessionProperty = new SimpleObjectProperty<>() { - @Override - protected void invalidated() { - Session session = get(); - String localSessionId = session == null ? null : session.id(); - Console.log("FxSession: localId = " + localSessionId); - ClientSideStateSession.getInstance().setClientSession(session); - } - }; + private final static ObjectProperty sessionProperty = FXProperties.newObjectProperty(session -> { + String localSessionId = session == null ? null : session.id(); + Console.log("FxSession: localId = " + localSessionId); + ClientSideStateSession.getInstance().setClientSession(session); + }); public static ReadOnlyObjectProperty sessionProperty() { return sessionProperty; @@ -34,8 +30,8 @@ static void setSession(Session session) { sessionProperty.set(session); } - static { - FXInit.init(); + static { // All FXClass in this package should call FXInit.init() in their static initializer + FXInit.init(); // See FXInit comments to understand why } } diff --git a/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXUserClaims.java b/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXUserClaims.java index 47250ca22..b02d8acba 100644 --- a/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXUserClaims.java +++ b/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXUserClaims.java @@ -27,12 +27,16 @@ private static void setUserClaims(UserClaims userClaims) { FXProperties.setIfNotEquals(userClaimsProperty, userClaims); } + static { // All FXClass in this package should call FXInit.init() in their static initializer + FXInit.init(); // See FXInit comments to understand why + } + static { - FXProperties.runNowAndOnPropertiesChange(() -> { + FXProperties.runNowAndOnPropertyChange(() -> { // Forgetting the previous user claims on user change setUserClaims(null); // Asking the new user claim if the user is logged in (ignored if the user just logged out) - if (FXLoggedIn.isLoggedIn()) { + if (FXUserId.getUserId() != null) { AuthenticationService.getUserClaims() .onFailure(Console::log) .onSuccess(userClaims -> UiScheduler.runInUiThread(() -> setUserClaims(userClaims))); diff --git a/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXUserId.java b/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXUserId.java index fe5449839..62ec9ca99 100644 --- a/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXUserId.java +++ b/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXUserId.java @@ -4,21 +4,16 @@ import dev.webfx.platform.console.Console; import dev.webfx.stack.session.state.client.ClientSideStateSession; import javafx.beans.property.ObjectProperty; -import javafx.beans.property.SimpleObjectProperty; /** * @author Bruno Salmon */ public final class FXUserId { - private final static ObjectProperty userIdProperty = new SimpleObjectProperty<>() { - @Override - protected void invalidated() { - Object userId = get(); - Console.log("FxUserId = " + userId); - ClientSideStateSession.getInstance().changeUserId(userId, false, false); - } - }; + private final static ObjectProperty userIdProperty = FXProperties.newObjectProperty(userId -> { + Console.log("FxUserId = " + userId); + ClientSideStateSession.getInstance().changeUserId(userId, false, false); + }); public static ObjectProperty userIdProperty() { return userIdProperty; @@ -32,8 +27,8 @@ public static void setUserId(Object userId) { FXProperties.setIfNotEquals(userIdProperty, userId); } - static { - FXInit.init(); + static { // All FXClass in this package should call FXInit.init() in their static initializer + FXInit.init(); // See FXInit comments to understand why } } diff --git a/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXUserPrincipal.java b/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXUserPrincipal.java index b4bc79263..147860353 100644 --- a/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXUserPrincipal.java +++ b/webfx-stack-session-state-client-fx/src/main/java/dev/webfx/stack/session/state/client/fx/FXUserPrincipal.java @@ -24,4 +24,8 @@ public static Object getUserPrincipal() { return userPrincipalProperty().getValue(); } + static { // All FXClass in this package should call FXInit.init() in their static initializer + FXInit.init(); // See FXInit comments to understand why + } + } diff --git a/webfx-stack-session-state-client-fx/src/main/java/module-info.java b/webfx-stack-session-state-client-fx/src/main/java/module-info.java index 18792a9c1..dff9600b7 100644 --- a/webfx-stack-session-state-client-fx/src/main/java/module-info.java +++ b/webfx-stack-session-state-client-fx/src/main/java/module-info.java @@ -7,7 +7,7 @@ requires webfx.kit.util; requires webfx.platform.console; requires webfx.platform.uischeduler; - requires webfx.stack.authn; + requires transitive webfx.stack.authn; requires webfx.stack.session; requires webfx.stack.session.state; requires webfx.stack.session.state.client; diff --git a/webfx-stack-session-state-client-fx/webfx.xml b/webfx-stack-session-state-client-fx/webfx.xml index 9e8facde4..d9fec248e 100644 --- a/webfx-stack-session-state-client-fx/webfx.xml +++ b/webfx-stack-session-state-client-fx/webfx.xml @@ -6,7 +6,9 @@ - + + webfx-stack-authn + \ No newline at end of file diff --git a/webfx-stack-session-state-server/src/main/java/dev/webfx/stack/session/state/server/ServerSideStateSessionSyncer.java b/webfx-stack-session-state-server/src/main/java/dev/webfx/stack/session/state/server/ServerSideStateSessionSyncer.java index 6989a19fe..cef928632 100644 --- a/webfx-stack-session-state-server/src/main/java/dev/webfx/stack/session/state/server/ServerSideStateSessionSyncer.java +++ b/webfx-stack-session-state-server/src/main/java/dev/webfx/stack/session/state/server/ServerSideStateSessionSyncer.java @@ -99,7 +99,7 @@ private static Future syncFixedServerSessionFromIncomingClientState(Ses } private static Future storeServerSession(Session serverSession) { - return SessionService.getSessionStore().put(serverSession) + return serverSession.store() .onFailure(Console::log) .map(x -> serverSession); } diff --git a/webfx-stack-session/src/main/java/dev/webfx/stack/session/Session.java b/webfx-stack-session/src/main/java/dev/webfx/stack/session/Session.java index 87b9a6b36..c2c94d4f5 100644 --- a/webfx-stack-session/src/main/java/dev/webfx/stack/session/Session.java +++ b/webfx-stack-session/src/main/java/dev/webfx/stack/session/Session.java @@ -1,5 +1,7 @@ package dev.webfx.stack.session; +import dev.webfx.platform.async.Future; + /** * @author Bruno Salmon */ @@ -36,4 +38,8 @@ public interface Session { T remove(String key); boolean isEmpty(); + + default Future store() { + return SessionService.getSessionStore().put(this); + } } diff --git a/webfx-stack-ui-action-tuner/pom.xml b/webfx-stack-ui-action-tuner/pom.xml new file mode 100644 index 000000000..6572056ea --- /dev/null +++ b/webfx-stack-ui-action-tuner/pom.xml @@ -0,0 +1,46 @@ + + + + 4.0.0 + + + dev.webfx + webfx-stack + 0.1.0-SNAPSHOT + + + webfx-stack-ui-action-tuner + + + + + org.openjfx + javafx-base + provided + + + + dev.webfx + webfx-platform-javatime-emul-j2cl + 0.1.0-SNAPSHOT + runtime + true + + + + dev.webfx + webfx-stack-session-state-client-fx + 0.1.0-SNAPSHOT + + + + dev.webfx + webfx-stack-ui-action + 0.1.0-SNAPSHOT + + + + + \ No newline at end of file diff --git a/webfx-stack-ui-action-tuner/src/main/java/dev/webfx/stack/ui/action/tuner/ActionTuner.java b/webfx-stack-ui-action-tuner/src/main/java/dev/webfx/stack/ui/action/tuner/ActionTuner.java new file mode 100644 index 000000000..26f04f145 --- /dev/null +++ b/webfx-stack-ui-action-tuner/src/main/java/dev/webfx/stack/ui/action/tuner/ActionTuner.java @@ -0,0 +1,12 @@ +package dev.webfx.stack.ui.action.tuner; + +import dev.webfx.stack.ui.action.Action; + +/** + * @author Bruno Salmon + */ +public interface ActionTuner { + + Action tuneAction(Action action); + +} diff --git a/webfx-stack-ui-action-tuner/src/main/java/dev/webfx/stack/ui/action/tuner/logout/LogoutOnlyActionTuner.java b/webfx-stack-ui-action-tuner/src/main/java/dev/webfx/stack/ui/action/tuner/logout/LogoutOnlyActionTuner.java new file mode 100644 index 000000000..0ac74161d --- /dev/null +++ b/webfx-stack-ui-action-tuner/src/main/java/dev/webfx/stack/ui/action/tuner/logout/LogoutOnlyActionTuner.java @@ -0,0 +1,23 @@ +package dev.webfx.stack.ui.action.tuner.logout; + +import dev.webfx.stack.session.state.client.fx.FXLoggedOut; +import dev.webfx.stack.ui.action.Action; +import dev.webfx.stack.ui.action.ActionBuilder; +import dev.webfx.stack.ui.action.tuner.ActionTuner; +import javafx.beans.property.ReadOnlyBooleanProperty; + +/** + * @author Bruno Salmon + */ +public interface LogoutOnlyActionTuner extends ActionTuner { + + @Override + default Action tuneAction(Action action) { + ReadOnlyBooleanProperty loggedOutProperty = FXLoggedOut.loggedOutProperty(); + return new ActionBuilder(action) + .setVisibleProperty(loggedOutProperty) + .setHiddenWhenDisabled(true) // TODO: see if we can get this information from the underlying action instead of forcing it + .build(); + } + +} diff --git a/webfx-stack-ui-action-tuner/src/main/java/module-info.java b/webfx-stack-ui-action-tuner/src/main/java/module-info.java new file mode 100644 index 000000000..7cdb60bf0 --- /dev/null +++ b/webfx-stack-ui-action-tuner/src/main/java/module-info.java @@ -0,0 +1,14 @@ +// File managed by WebFX (DO NOT EDIT MANUALLY) + +module webfx.stack.ui.action.tuner { + + // Direct dependencies modules + requires javafx.base; + requires webfx.stack.session.state.client.fx; + requires webfx.stack.ui.action; + + // Exported packages + exports dev.webfx.stack.ui.action.tuner; + exports dev.webfx.stack.ui.action.tuner.logout; + +} \ No newline at end of file diff --git a/webfx-stack-ui-action-tuner/webfx.xml b/webfx-stack-ui-action-tuner/webfx.xml new file mode 100644 index 000000000..14bdc5177 --- /dev/null +++ b/webfx-stack-ui-action-tuner/webfx.xml @@ -0,0 +1,13 @@ + + + + + + + + + + + + + \ No newline at end of file diff --git a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/Action.java b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/Action.java index 2ad444993..84ba75952 100644 --- a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/Action.java +++ b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/Action.java @@ -2,12 +2,14 @@ import dev.webfx.stack.ui.action.impl.ReadOnlyAction; import javafx.beans.value.ObservableBooleanValue; -import javafx.beans.value.ObservableObjectValue; import javafx.beans.value.ObservableStringValue; +import javafx.beans.value.ObservableValue; import javafx.event.ActionEvent; import javafx.event.EventHandler; import javafx.scene.Node; +import java.util.function.Supplier; + /** * An action compatible with standard JavaFX API (ex: can be passed to Button.setOnAction()) but enriched with graphical * properties (ie text, graphic, disabled and visible properties). The ActionBinder utility class can be used to help @@ -22,9 +24,14 @@ default String getText() { return textProperty().get(); } - ObservableObjectValue graphicProperty(); - default Node getGraphic() { - return graphicProperty().get(); + ObservableValue> graphicFactoryProperty(); // TODO: should it be rather Supplier>? + default Supplier getGraphicFactory() { + return graphicFactoryProperty().getValue(); + } + + default Node createGraphic() { + Supplier graphicFactory = getGraphicFactory(); + return graphicFactory == null ? null : graphicFactory.get(); } ObservableBooleanValue disabledProperty(); @@ -41,7 +48,7 @@ default boolean isVisible() { Object getUserData(); - static Action create(ObservableStringValue textProperty, ObservableObjectValue graphicProperty, ObservableBooleanValue disabledProperty, ObservableBooleanValue visibleProperty, EventHandler actionHandler) { - return new ReadOnlyAction(textProperty, graphicProperty, disabledProperty, visibleProperty, actionHandler); + static Action create(ObservableStringValue textProperty, ObservableValue> graphicFactoryProperty, ObservableBooleanValue disabledProperty, ObservableBooleanValue visibleProperty, EventHandler actionHandler) { + return new ReadOnlyAction(textProperty, graphicFactoryProperty, disabledProperty, visibleProperty, actionHandler); } } diff --git a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionBinder.java b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionBinder.java index 120221221..ed25b0563 100644 --- a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionBinder.java +++ b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionBinder.java @@ -2,26 +2,37 @@ import dev.webfx.kit.util.properties.FXProperties; import dev.webfx.kit.util.properties.ObservableLists; +import dev.webfx.kit.util.properties.Unregisterable; import dev.webfx.platform.util.function.Converter; import dev.webfx.stack.ui.action.impl.WritableAction; import javafx.beans.property.ObjectProperty; -import javafx.beans.value.ObservableObjectValue; +import javafx.beans.value.ObservableValue; import javafx.collections.ObservableList; import javafx.event.ActionEvent; import javafx.scene.Node; -import javafx.scene.control.ButtonBase; -import javafx.scene.control.Labeled; -import javafx.scene.control.MenuItem; -import javafx.scene.image.ImageView; +import javafx.scene.control.*; import javafx.scene.layout.Pane; import java.util.Collection; +import java.util.function.Supplier; /** * @author Bruno Salmon */ public final class ActionBinder { + public static Button newActionButton(Action action) { + return bindButtonToAction(new Button(), action); + } + + public static Hyperlink newActionHyperlink(Action action) { + return bindButtonToAction(new Hyperlink(), action); + } + + public static MenuItem newActionMenuItem(Action action) { + return bindMenuItemToAction(new MenuItem(), action); + } + public static T bindButtonToAction(T button, Action action) { bindLabeledToAction(button, action); button.setOnAction(action); @@ -30,7 +41,7 @@ public static T bindButtonToAction(T button, Action actio public static T bindMenuItemToAction(T menuItem, Action action) { menuItem.textProperty().bind(action.textProperty()); - bindGraphicProperties(menuItem.graphicProperty(), action.graphicProperty()); + bindGraphicProperties(menuItem.graphicProperty(), action.graphicFactoryProperty()); menuItem.disableProperty().bind(action.disabledProperty()); menuItem.visibleProperty().bind(action.visibleProperty()); menuItem.setOnAction(action); @@ -39,31 +50,24 @@ public static T bindMenuItemToAction(T menuItem, Action act private static T bindLabeledToAction(T labeled, Action action) { labeled.textProperty().bind(action.textProperty()); - bindGraphicProperties(labeled.graphicProperty(), action.graphicProperty()); + bindGraphicProperties(labeled.graphicProperty(), action.graphicFactoryProperty()); bindNodeToAction(labeled, action, false); return labeled; } - private static void bindGraphicProperties(ObjectProperty dstGraphicProperty, ObservableObjectValue srcGraphicProperty) { + private static void bindGraphicProperties(ObjectProperty dstGraphicProperty, ObservableValue> srcGraphicFactoryProperty) { // Needs to make a copy of the graphic in case it is used in several places (JavaFX nodes must be unique instances in the scene graph) - FXProperties.runNowAndOnPropertiesChange(p -> dstGraphicProperty.setValue(copyGraphic(srcGraphicProperty.getValue())), srcGraphicProperty); + FXProperties.runNowAndOnPropertyChange(srcGraphicFactory -> + dstGraphicProperty.setValue(createGraphic(srcGraphicFactory)) + , srcGraphicFactoryProperty); } - private static Node copyGraphic(Node graphic) { - // Handling only ImageView for now - if (graphic instanceof ImageView) { - ImageView imageView = (ImageView) graphic; - ImageView copy = new ImageView(); - copy.imageProperty().bind(imageView.imageProperty()); - copy.fitWidthProperty().bind(imageView.fitWidthProperty()); - copy.fitHeightProperty().bind(imageView.fitHeightProperty()); - return copy; - } - return graphic; + private static Node createGraphic(Supplier graphicFactory) { + return graphicFactory == null ? null : graphicFactory.get(); } public static Node getAndBindActionIcon(Action action) { - return bindNodeToAction(action.getGraphic(), action, true); + return bindNodeToAction(createGraphic(action.getGraphicFactory()), action, true); } private static T bindNodeToAction(T node, Action action, boolean setOnMouseClicked) { @@ -78,23 +82,22 @@ private static T bindNodeToAction(T node, Action action, boolea public static void bindWritableActionToAction(WritableAction writableAction, Action action) { writableAction.writableTextProperty().bind(action.textProperty()); - writableAction.writableGraphicProperty().bind(action.graphicProperty()); + writableAction.writableGraphicFactoryProperty().bind(action.graphicFactoryProperty()); writableAction.writableDisabledProperty().bind(action.disabledProperty()); writableAction.writableVisibleProperty().bind(action.visibleProperty()); } - public static P bindChildrenToVisibleActions(P parent, Collection actions, Converter nodeFactory) { + + public static Unregisterable bindChildrenToVisibleActions(P parent, Collection actions, Converter nodeFactory) { ActionGroup actionGroup = new ActionGroupBuilder().setActions(actions).build(); return bindChildrenToActionGroup(parent, actionGroup, nodeFactory); } - public static P bindChildrenToActionGroup(P parent, ActionGroup actionGroup, Converter nodeFactory) { - bindChildrenToActionGroup(parent.getChildren(), actionGroup, nodeFactory); - return parent; + public static Unregisterable bindChildrenToActionGroup(P parent, ActionGroup actionGroup, Converter nodeFactory) { + return bindChildrenToActionGroup(parent.getChildren(), actionGroup, nodeFactory); } - public static ObservableList bindChildrenToActionGroup(ObservableList children, ActionGroup actionGroup, Converter nodeFactory) { - ObservableLists.bindConverted(children, actionGroup.getVisibleActions(), nodeFactory); - return children; + public static Unregisterable bindChildrenToActionGroup(ObservableList children, ActionGroup actionGroup, Converter nodeFactory) { + return ObservableLists.bindConverted(children, actionGroup.getVisibleActions(), nodeFactory); } } diff --git a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionBuilder.java b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionBuilder.java index 9575ff494..904e1eb90 100644 --- a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionBuilder.java +++ b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionBuilder.java @@ -1,17 +1,20 @@ package dev.webfx.stack.ui.action; +import dev.webfx.kit.util.properties.FXProperties; +import dev.webfx.stack.i18n.I18n; +import dev.webfx.stack.ui.json.JsonImageView; import javafx.beans.binding.BooleanExpression; import javafx.beans.property.SimpleBooleanProperty; import javafx.beans.property.SimpleObjectProperty; import javafx.beans.property.SimpleStringProperty; import javafx.beans.value.ObservableBooleanValue; -import javafx.beans.value.ObservableObjectValue; import javafx.beans.value.ObservableStringValue; +import javafx.beans.value.ObservableValue; import javafx.event.ActionEvent; import javafx.event.EventHandler; import javafx.scene.Node; -import dev.webfx.stack.i18n.I18n; -import dev.webfx.stack.ui.json.JsonImageView; + +import java.util.function.Supplier; /** * @author Bruno Salmon @@ -24,8 +27,8 @@ public class ActionBuilder { private String text; private Object i18nKey; - private ObservableObjectValue graphicProperty; - private Node graphic; + private ObservableValue> graphicFactoryProperty; + private Supplier graphicFactory; private Object graphicUrlOrJson; private ObservableBooleanValue disabledProperty; @@ -39,6 +42,8 @@ public class ActionBuilder { private EventHandler actionHandler; + private Object userData; + private ActionBuilderRegistry registry; public ActionBuilder() { @@ -48,6 +53,18 @@ public ActionBuilder(Object actionKey) { this.actionKey = actionKey; } + public ActionBuilder(Action action) { + setTextProperty(action.textProperty()); + setText(action.getText()); + setGraphicFactoryProperty(action.graphicFactoryProperty()); + setGraphicFactory(action.getGraphicFactory()); + setDisabledProperty(action.disabledProperty()); + setVisibleProperty(action.visibleProperty()); + setActionHandler(action); + setUserData(action.getUserData()); + //setHiddenWhenDisabled(visibleProperty == disabledProperty || visibleProperty instanceof BooleanBinding && ((BooleanBinding) visibleProperty).getDependencies().contains(disabledProperty)); + } + public Object getActionKey() { return actionKey; } @@ -84,21 +101,21 @@ public ActionBuilder setI18nKey(Object i18nKey) { return this; } - public ObservableObjectValue getGraphicProperty() { - return graphicProperty; + public ObservableValue> getGraphicFactoryProperty() { + return graphicFactoryProperty; } - public ActionBuilder setGraphicProperty(ObservableObjectValue graphicProperty) { - this.graphicProperty = graphicProperty; + public ActionBuilder setGraphicFactoryProperty(ObservableValue> graphicFactoryProperty) { + this.graphicFactoryProperty = graphicFactoryProperty; return this; } - public Node getGraphic() { - return graphic; + public Supplier getGraphicFactory() { + return graphicFactory; } - public ActionBuilder setGraphic(Node graphic) { - this.graphic = graphic; + public ActionBuilder setGraphicFactory(Supplier graphicFactory) { + this.graphicFactory = graphicFactory; return this; } @@ -169,6 +186,15 @@ public ActionBuilder setActionHandler(Runnable actionHandler) { return setActionHandler(e -> actionHandler.run()); } + public Object getUserData() { + return userData; + } + + public ActionBuilder setUserData(Object userData) { + this.userData = userData; + return this; + } + public ActionBuilder setRegistry(ActionBuilderRegistry registry) { this.registry = registry; return this; @@ -184,8 +210,8 @@ public ActionBuilder duplicate() { .setTextProperty(textProperty) .setText(text) .setI18nKey(i18nKey) - .setGraphicProperty(graphicProperty) - .setGraphic(graphic) + .setGraphicFactoryProperty(graphicFactoryProperty) + .setGraphicFactory(graphicFactory) .setGraphicUrlOrJson(graphicUrlOrJson) .setDisabledProperty(disabledProperty) .setVisibleProperty(visibleProperty) @@ -209,7 +235,9 @@ public ActionBuilder removeText() { public Action build() { completePropertiesForBuild(); - return Action.create(textProperty, graphicProperty, disabledProperty, visibleProperty, actionHandler); + Action action = Action.create(textProperty, graphicFactoryProperty, disabledProperty, visibleProperty, actionHandler); + action.setUserData(userData); + return action; } void completePropertiesForBuild() { @@ -229,13 +257,14 @@ private void completeTextProperty() { } private void completeGraphicProperty() { - if (graphicProperty == null) { - if (graphic == null && graphicUrlOrJson != null) - graphic = JsonImageView.createImageView(graphicUrlOrJson); - if (graphic != null || i18nKey == null) - graphicProperty = new SimpleObjectProperty<>(graphic); + if (graphicFactoryProperty == null) { + if (graphicFactory == null && graphicUrlOrJson != null) + graphicFactory = () -> JsonImageView.createImageView(graphicUrlOrJson); + if (graphicFactory != null || i18nKey == null) + graphicFactoryProperty = new SimpleObjectProperty<>(graphicFactory); else - graphicProperty = I18n.i18nGraphicProperty(i18nKey); + graphicFactoryProperty = FXProperties.compute(I18n.dictionaryProperty(), dictionary -> + () -> I18n.getI18nGraphic(i18nKey)); } } diff --git a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionGroup.java b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionGroup.java index 438acab5a..71838eb4a 100644 --- a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionGroup.java +++ b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionGroup.java @@ -2,14 +2,15 @@ import dev.webfx.stack.ui.action.impl.ActionGroupImpl; import javafx.beans.value.ObservableBooleanValue; -import javafx.beans.value.ObservableObjectValue; import javafx.beans.value.ObservableStringValue; +import javafx.beans.value.ObservableValue; import javafx.collections.ObservableList; import javafx.event.ActionEvent; import javafx.event.EventHandler; import javafx.scene.Node; import java.util.Collection; +import java.util.function.Supplier; /** * @author Bruno Salmon @@ -22,8 +23,8 @@ public interface ActionGroup extends Action { boolean hasSeparators(); - static ActionGroup create(Collection actions, ObservableStringValue textProperty, ObservableObjectValue graphicProperty, ObservableBooleanValue disabledProperty, ObservableBooleanValue visibleProperty, boolean hasSeparators, EventHandler actionHandler) { - return new ActionGroupImpl(actions, textProperty, graphicProperty, disabledProperty, visibleProperty, hasSeparators, actionHandler); + static ActionGroup create(Collection actions, ObservableStringValue textProperty, ObservableValue> graphicFactoryProperty, ObservableBooleanValue disabledProperty, ObservableBooleanValue visibleProperty, boolean hasSeparators, EventHandler actionHandler) { + return new ActionGroupImpl(actions, textProperty, graphicFactoryProperty, disabledProperty, visibleProperty, hasSeparators, actionHandler); } } diff --git a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionGroupBuilder.java b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionGroupBuilder.java index a0185e70a..ea2fd6bfa 100644 --- a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionGroupBuilder.java +++ b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionGroupBuilder.java @@ -1,14 +1,15 @@ package dev.webfx.stack.ui.action; +import dev.webfx.platform.util.collection.Collections; import javafx.beans.value.ObservableBooleanValue; -import javafx.beans.value.ObservableObjectValue; import javafx.beans.value.ObservableStringValue; +import javafx.beans.value.ObservableValue; import javafx.event.ActionEvent; import javafx.event.EventHandler; import javafx.scene.Node; -import dev.webfx.platform.util.collection.Collections; import java.util.Collection; +import java.util.function.Supplier; /** * @author Bruno Salmon @@ -43,7 +44,7 @@ public ActionGroupBuilder setHasSeparators(boolean hasSeparators) { @Override public ActionGroup build() { completePropertiesForBuild(); - return ActionGroup.create(actions, getTextProperty(), getGraphicProperty(), getDisabledProperty(), getVisibleProperty(), hasSeparators, getActionHandler()); + return ActionGroup.create(actions, getTextProperty(), getGraphicFactoryProperty(), getDisabledProperty(), getVisibleProperty(), hasSeparators, getActionHandler()); } // --- Overriding fluent API methods to return ActionGroupBuilder instead of ActionBuilder --- @@ -69,13 +70,13 @@ public ActionGroupBuilder setI18nKey(Object i18nKey) { } @Override - public ActionGroupBuilder setGraphicProperty(ObservableObjectValue graphicProperty) { - return (ActionGroupBuilder) super.setGraphicProperty(graphicProperty); + public ActionGroupBuilder setGraphicFactoryProperty(ObservableValue> graphicFactoryProperty) { + return (ActionGroupBuilder) super.setGraphicFactoryProperty(graphicFactoryProperty); } @Override - public ActionGroupBuilder setGraphic(Node graphic) { - return (ActionGroupBuilder) super.setGraphic(graphic); + public ActionGroupBuilder setGraphicFactory(Supplier graphicFactory) { + return (ActionGroupBuilder) super.setGraphicFactory(graphicFactory); } @Override diff --git a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/ActionGroupImpl.java b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/ActionGroupImpl.java index e331342e5..d37f5620e 100644 --- a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/ActionGroupImpl.java +++ b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/ActionGroupImpl.java @@ -1,22 +1,23 @@ package dev.webfx.stack.ui.action.impl; +import dev.webfx.kit.util.properties.FXProperties; +import dev.webfx.platform.util.collection.Collections; +import dev.webfx.stack.ui.action.Action; +import dev.webfx.stack.ui.action.ActionGroup; import javafx.beans.property.Property; import javafx.beans.value.ObservableBooleanValue; -import javafx.beans.value.ObservableObjectValue; import javafx.beans.value.ObservableStringValue; +import javafx.beans.value.ObservableValue; import javafx.collections.FXCollections; import javafx.collections.ObservableList; import javafx.event.ActionEvent; import javafx.event.EventHandler; import javafx.scene.Node; -import dev.webfx.stack.ui.action.Action; -import dev.webfx.stack.ui.action.ActionGroup; -import dev.webfx.kit.util.properties.FXProperties; -import dev.webfx.platform.util.collection.Collections; import java.util.ArrayList; import java.util.Collection; import java.util.List; +import java.util.function.Supplier; /** * @author Bruno Salmon @@ -27,8 +28,8 @@ public final class ActionGroupImpl extends ReadOnlyAction implements ActionGroup private final ObservableList visibleActions = FXCollections.observableArrayList(); private final boolean hasSeparators; - public ActionGroupImpl(Collection actions, ObservableStringValue textProperty, ObservableObjectValue graphicProperty, ObservableBooleanValue disabledProperty, ObservableBooleanValue visibleProperty, boolean hasSeparators, EventHandler actionHandler) { - super(textProperty, graphicProperty, disabledProperty, visibleProperty, actionHandler); + public ActionGroupImpl(Collection actions, ObservableStringValue textProperty, ObservableValue> graphicFactoryProperty, ObservableBooleanValue disabledProperty, ObservableBooleanValue visibleProperty, boolean hasSeparators, EventHandler actionHandler) { + super(textProperty, graphicFactoryProperty, disabledProperty, visibleProperty, actionHandler); this.actions = actions; this.hasSeparators = hasSeparators; FXProperties.runNowAndOnPropertiesChange(this::updateVisibleActions, Collections.map(actions, Action::visibleProperty)); @@ -40,7 +41,7 @@ private void updateVisibleActions() { for (Action action : this.actions) { if (action.isVisible()) { int n = actions.size(); - if (action.getText() == null && action.getGraphic() == null && action instanceof ActionGroup) { + if (action.getText() == null && action.getGraphicFactory() == null && action instanceof ActionGroup) { ActionGroup actionGroup = (ActionGroup) action; actions.addAll(actionGroup.getVisibleActions()); if (actions.size() > n) { diff --git a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/ReadOnlyAction.java b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/ReadOnlyAction.java index 17d90a782..c0843f2b0 100644 --- a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/ReadOnlyAction.java +++ b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/ReadOnlyAction.java @@ -1,12 +1,14 @@ package dev.webfx.stack.ui.action.impl; +import dev.webfx.stack.ui.action.Action; import javafx.beans.value.ObservableBooleanValue; -import javafx.beans.value.ObservableObjectValue; import javafx.beans.value.ObservableStringValue; +import javafx.beans.value.ObservableValue; import javafx.event.ActionEvent; import javafx.event.EventHandler; import javafx.scene.Node; -import dev.webfx.stack.ui.action.Action; + +import java.util.function.Supplier; /** * A read-only action where properties are observable values. @@ -15,9 +17,9 @@ */ public class ReadOnlyAction implements Action { - public ReadOnlyAction(ObservableStringValue textProperty, ObservableObjectValue graphicProperty, ObservableBooleanValue disabledProperty, ObservableBooleanValue visibleProperty, EventHandler actionHandler) { + public ReadOnlyAction(ObservableStringValue textProperty, ObservableValue> graphicFactoryProperty, ObservableBooleanValue disabledProperty, ObservableBooleanValue visibleProperty, EventHandler actionHandler) { this.textProperty = textProperty; - this.graphicProperty = graphicProperty; + this.graphicFactoryProperty = graphicFactoryProperty; this.disabledProperty = disabledProperty; this.visibleProperty = visibleProperty; this.actionHandler = actionHandler; @@ -29,10 +31,10 @@ public ObservableStringValue textProperty() { return textProperty; } - private final ObservableObjectValue graphicProperty; + private final ObservableValue> graphicFactoryProperty; @Override - public ObservableObjectValue graphicProperty() { - return graphicProperty; + public ObservableValue> graphicFactoryProperty() { + return graphicFactoryProperty; } private final ObservableBooleanValue disabledProperty; diff --git a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/WritableAction.java b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/WritableAction.java index 849ef13ca..8f42b2cee 100644 --- a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/WritableAction.java +++ b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/WritableAction.java @@ -1,14 +1,16 @@ package dev.webfx.stack.ui.action.impl; +import dev.webfx.platform.util.Arrays; +import dev.webfx.stack.ui.action.Action; import javafx.beans.property.*; import javafx.beans.value.ObservableBooleanValue; -import javafx.beans.value.ObservableObjectValue; import javafx.beans.value.ObservableStringValue; +import javafx.beans.value.ObservableValue; import javafx.event.ActionEvent; import javafx.event.EventHandler; import javafx.scene.Node; -import dev.webfx.stack.ui.action.Action; -import dev.webfx.platform.util.Arrays; + +import java.util.function.Supplier; /** * A writable action where properties (text, graphic, disabled, visible) can be set later (ie after constructor call) @@ -19,15 +21,15 @@ public class WritableAction extends ReadOnlyAction { public WritableAction(Action action, String... writablePropertyNames) { - this(createStringProperty(action.textProperty(), "text", writablePropertyNames), createObjectProperty(action.graphicProperty(), "graphic", writablePropertyNames), createBooleanProperty(action.disabledProperty(), "disabled", writablePropertyNames), createBooleanProperty(action.visibleProperty(), "visible", writablePropertyNames), action); + this(createStringProperty(action.textProperty(), "text", writablePropertyNames), createObjectProperty(action.graphicFactoryProperty(), "graphicFactory", writablePropertyNames), createBooleanProperty(action.disabledProperty(), "disabled", writablePropertyNames), createBooleanProperty(action.visibleProperty(), "visible", writablePropertyNames), action); } public WritableAction(EventHandler actionHandler) { this(new SimpleStringProperty(), new SimpleObjectProperty<>(), new SimpleBooleanProperty(true /* disabled until it is bound */), new SimpleBooleanProperty(false /* invisible until it is bound */), actionHandler); } - public WritableAction(ObservableStringValue textProperty, ObservableObjectValue graphicProperty, ObservableBooleanValue disabledProperty, ObservableBooleanValue visibleProperty, EventHandler actionHandler) { - super(textProperty, graphicProperty, disabledProperty, visibleProperty, actionHandler); + public WritableAction(ObservableStringValue textProperty, ObservableValue> graphicFactoryProperty, ObservableBooleanValue disabledProperty, ObservableBooleanValue visibleProperty, EventHandler actionHandler) { + super(textProperty, graphicFactoryProperty, disabledProperty, visibleProperty, actionHandler); } public StringProperty writableTextProperty() { @@ -38,12 +40,12 @@ public void setText(String text) { writableTextProperty().set(text); } - public ObjectProperty writableGraphicProperty() { - return (ObjectProperty) graphicProperty(); + public ObjectProperty> writableGraphicFactoryProperty() { + return (ObjectProperty>) graphicFactoryProperty(); } - public void setGraphic(Node graphic) { - writableGraphicProperty().set(graphic); + public void setGraphicFactory(Supplier graphicFactory) { + writableGraphicFactoryProperty().set(graphicFactory); } public BooleanProperty writableDisabledProperty() { @@ -76,10 +78,10 @@ public void set(String newValue) { return writableProperty; } - private static ObjectProperty createObjectProperty(ObservableObjectValue readOnlyProperty, String propertyName, String... writablePropertyNames) { + private static ObjectProperty createObjectProperty(ObservableValue readOnlyProperty, String propertyName, String... writablePropertyNames) { if (readOnlyProperty instanceof ObjectProperty) return (ObjectProperty) readOnlyProperty; - SimpleObjectProperty writableProperty = new SimpleObjectProperty() { + SimpleObjectProperty writableProperty = new SimpleObjectProperty<>() { @Override public void set(T newValue) { unbindPropertyIfWritable(this, propertyName, writablePropertyNames); diff --git a/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/ControlFactoryMixin.java b/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/ControlFactoryMixin.java index dcdeb5c0e..061e99672 100644 --- a/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/ControlFactoryMixin.java +++ b/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/ControlFactoryMixin.java @@ -110,11 +110,11 @@ default Button styleButton(Button button) { } default CheckBox newCheckBox(Object i18nKey) { - return I18nControls.bindI18nProperties(new CheckBox(), i18nKey); + return I18nControls.newCheckBox(i18nKey); } default RadioButton newRadioButton(Object i18nKey) { - return I18nControls.bindI18nProperties(new RadioButton(), i18nKey); + return I18nControls.newRadioButton(i18nKey); } default RadioButton newRadioButton(Object i18nKey, ToggleGroup toggleGroup) { @@ -124,7 +124,7 @@ default RadioButton newRadioButton(Object i18nKey, ToggleGroup toggleGroup) { } default Label newLabel(Object i18nKey) { - return I18nControls.bindI18nProperties(new Label(), i18nKey); + return I18nControls.newLabel(i18nKey); } default TextField newTextField() { @@ -144,7 +144,7 @@ default Hyperlink newHyperlink() { } default Hyperlink newHyperlink(Object i18nKey) { - return I18nControls.bindI18nProperties(newHyperlink(), i18nKey); + return I18nControls.newHyperlink(i18nKey); } default Hyperlink newHyperlink(Object i18nKey, EventHandler onAction) { @@ -158,7 +158,7 @@ default TextArea newTextArea(Object i18nKey) { } default Text newText(Object i18nKey) { - return I18n.bindI18nProperties(new Text(), i18nKey); + return I18n.newText(i18nKey); } } diff --git a/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/button/ButtonFactory.java b/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/button/ButtonFactory.java index bcd8188e9..b52cd46d5 100644 --- a/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/button/ButtonFactory.java +++ b/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/button/ButtonFactory.java @@ -62,7 +62,7 @@ public static Button decorateButtonWithDropDownArrow(Button button) { downArrow.setFill(null); downArrow.setContent("M1 1.22998L6.325 6.55499L11.65 1.22998"); GraphicDecoration dropDownArrowDecoration = new GraphicDecoration(downArrow, Pos.CENTER_RIGHT, 0, 0, -1, 0); - FXProperties.runNowAndOnPropertiesChange(() -> Platform.runLater(() -> + FXProperties.runNowAndOnPropertyChange(() -> Platform.runLater(() -> Controls.onSkinReady(button, () -> dropDownArrowDecoration.applyDecoration(button)) ), button.graphicProperty()); // Code to clip the content before the down arrow diff --git a/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/dialog/DialogContent.java b/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/dialog/DialogContent.java index 73739f4ee..c0b7e8c82 100644 --- a/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/dialog/DialogContent.java +++ b/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/dialog/DialogContent.java @@ -72,6 +72,12 @@ public DialogContent setYesNo() { return this; } + public DialogContent setOk() { + primaryButtonText = "Ok"; + secondaryButton.setManaged(false); + return this; + } + public Button getPrimaryButton() { return primaryButton; } diff --git a/webfx-stack-ui-json/src/main/java/dev/webfx/stack/ui/json/JsonSVGPath.java b/webfx-stack-ui-json/src/main/java/dev/webfx/stack/ui/json/JsonSVGPath.java index 8d2154fd0..3bd74ee98 100644 --- a/webfx-stack-ui-json/src/main/java/dev/webfx/stack/ui/json/JsonSVGPath.java +++ b/webfx-stack-ui-json/src/main/java/dev/webfx/stack/ui/json/JsonSVGPath.java @@ -7,6 +7,8 @@ import javafx.scene.paint.Paint; import javafx.scene.shape.FillRule; import javafx.scene.shape.SVGPath; +import javafx.scene.shape.StrokeLineCap; +import javafx.scene.shape.StrokeLineJoin; /** * @author Bruno Salmon @@ -21,6 +23,9 @@ public static SVGPath createSVGPath(ReadOnlyAstObject json) { svgPath.setStroke(toPaint(json.getString("stroke"), null)); svgPath.setStrokeWidth(json.getDouble("strokeWidth", 1d)); svgPath.setFillRule(toFillRule(json.getString("fillRule"))); + svgPath.setStrokeLineCap(toStrokeLineCap(json.getString("strokeLineCap"))); + svgPath.setStrokeLineJoin(toStrokeLineJoin(json.getString("strokeLineJoin"))); + svgPath.setStrokeMiterLimit(json.getDouble("strokeMiterLimit", 10d)); return svgPath; } @@ -40,11 +45,36 @@ private static Paint toPaint(String paintText, Paint defaultPaint) { } private static FillRule toFillRule(String ruleText) { - if (ruleText != null) + if (ruleText != null) { switch (ruleText.trim().toLowerCase()) { - case "evenodd" : return FillRule.EVEN_ODD; - case "nonzero" : return FillRule.NON_ZERO; + case "evenodd": + return FillRule.EVEN_ODD; + case "nonzero": + return FillRule.NON_ZERO; } + } return FillRule.NON_ZERO; } + + private static StrokeLineCap toStrokeLineCap(String strokeLineCapText) { + if (strokeLineCapText != null) { + switch (strokeLineCapText.trim().toLowerCase()) { + case "square" : return StrokeLineCap.SQUARE; + case "butt" : return StrokeLineCap.BUTT; + case "round" : return StrokeLineCap.ROUND; + } + } + return StrokeLineCap.SQUARE; + } + + private static StrokeLineJoin toStrokeLineJoin(String StrokeLineJoinText) { + if (StrokeLineJoinText != null) { + switch (StrokeLineJoinText.trim().toLowerCase()) { + case "miter": return StrokeLineJoin.MITER; + case "bevel": return StrokeLineJoin.BEVEL; + case "round": return StrokeLineJoin.ROUND; + } + } + return StrokeLineJoin.MITER; + } } diff --git a/webfx-stack-ui-operation-action/pom.xml b/webfx-stack-ui-operation-action/pom.xml index b65dbafb7..d7388c4a9 100644 --- a/webfx-stack-ui-operation-action/pom.xml +++ b/webfx-stack-ui-operation-action/pom.xml @@ -45,6 +45,14 @@ 0.1.0-SNAPSHOT + + dev.webfx + webfx-platform-javabase-emul-j2cl + 0.1.0-SNAPSHOT + runtime + true + + dev.webfx webfx-platform-javatime-emul-j2cl @@ -53,6 +61,12 @@ true + + dev.webfx + webfx-platform-scheduler + 0.1.0-SNAPSHOT + + dev.webfx webfx-platform-uischeduler @@ -77,6 +91,12 @@ 0.1.0-SNAPSHOT + + dev.webfx + webfx-stack-ui-action-tuner + 0.1.0-SNAPSHOT + + dev.webfx webfx-stack-ui-exceptions diff --git a/webfx-stack-ui-operation-action/src/main/java/dev/webfx/stack/ui/operation/action/OperationAction.java b/webfx-stack-ui-operation-action/src/main/java/dev/webfx/stack/ui/operation/action/OperationAction.java index cb8aaf170..de427612b 100644 --- a/webfx-stack-ui-operation-action/src/main/java/dev/webfx/stack/ui/operation/action/OperationAction.java +++ b/webfx-stack-ui-operation-action/src/main/java/dev/webfx/stack/ui/operation/action/OperationAction.java @@ -58,13 +58,9 @@ private OperationAction(OperationAction[] me, Function me[0] = this; this.operationRequestFactory = operationRequestFactory; OperationActionRegistry registry = getOperationActionRegistry(); - registry.bindOperationActionGraphicalProperties(this); - // Also, if some graphical dependencies are passed, we update the graphical properties when they change - if (graphicalDependencies.length > 0) - FXProperties.runNowAndOnPropertiesChange(() -> { - registry.updateOperationActionGraphicalProperties(this); - registry.bindOperationActionGraphicalProperties(this); - }, graphicalDependencies); + FXProperties.runNowAndOnPropertiesChange(() -> + registry.bindOperationActionGraphicalProperties(this) + , graphicalDependencies); // Also updating the graphical properties when graphical dependencies change } public OperationActionRegistry getOperationActionRegistry() { @@ -86,9 +82,8 @@ private void startShowingActionAsExecuting(Object operationRequest) { // If in addition an icon has been provided to graphically indicate the execution is in progress, if (actionExecutingIconFactory != null) { // we apply it to the graphic property Node executingIcon = actionExecutingIconFactory.apply(operationRequest); - if (executingIcon != null) { - FXProperties.setEvenIfBound(writableGraphicProperty(), executingIcon); - } + if (executingIcon != null) // For some operations such as routing operation, there is no executing icon + FXProperties.setEvenIfBound(writableGraphicFactoryProperty(), () -> executingIcon); } } @@ -100,9 +95,8 @@ private void stopShowingActionAsExecuting(Object operationRequest, Throwable exc // If in addition an icon has been provided to graphically indicate the execution has ended, if (actionExecutedIconFactory != null) { // we apply it to the graphic property for 2s Node executedIcon = actionExecutedIconFactory.apply(operationRequest, exception); - if (executedIcon != null) { - FXProperties.setEvenIfBound(writableGraphicProperty(), executedIcon); - } + if (executedIcon != null) // For some operations such as routing operation, there is no executed icon + FXProperties.setEvenIfBound(writableGraphicFactoryProperty(), () -> executedIcon); UiScheduler.scheduleDelay(2000, () -> { // After 2 seconds, we reestablish the original action icon, unless it's already executing again if (!executing) { // if executing again, we keep the possible executing icon instead diff --git a/webfx-stack-ui-operation-action/src/main/java/dev/webfx/stack/ui/operation/action/OperationActionRegistry.java b/webfx-stack-ui-operation-action/src/main/java/dev/webfx/stack/ui/operation/action/OperationActionRegistry.java index 90e74f406..0691fe3da 100644 --- a/webfx-stack-ui-operation-action/src/main/java/dev/webfx/stack/ui/operation/action/OperationActionRegistry.java +++ b/webfx-stack-ui-operation-action/src/main/java/dev/webfx/stack/ui/operation/action/OperationActionRegistry.java @@ -1,11 +1,17 @@ package dev.webfx.stack.ui.operation.action; +import dev.webfx.kit.util.properties.FXProperties; import dev.webfx.platform.async.AsyncFunction; import dev.webfx.platform.async.Future; +import dev.webfx.platform.console.Console; +import dev.webfx.platform.scheduler.Scheduled; import dev.webfx.platform.uischeduler.UiScheduler; +import dev.webfx.platform.util.collection.Collections; import dev.webfx.stack.authz.client.factory.AuthorizationUtil; import dev.webfx.stack.ui.action.Action; import dev.webfx.stack.ui.action.ActionBinder; +import dev.webfx.stack.ui.action.impl.WritableAction; +import dev.webfx.stack.ui.action.tuner.ActionTuner; import dev.webfx.stack.ui.operation.HasOperationCode; import javafx.beans.property.ObjectProperty; import javafx.beans.property.SimpleObjectProperty; @@ -13,10 +19,8 @@ import javafx.beans.value.ObservableValue; import javafx.event.ActionEvent; -import java.util.ArrayList; -import java.util.Collection; -import java.util.HashMap; -import java.util.Map; +import java.lang.ref.WeakReference; +import java.util.*; import java.util.function.Consumer; import java.util.function.Function; @@ -41,17 +45,32 @@ */ public final class OperationActionRegistry { - private static OperationActionRegistry INSTANCE; + private static final boolean LOG_DEBUG = false; - private final Map graphicalActions = new HashMap<>(); - private Collection notYetBoundOperationActions; - private Map> operationActionProperties; - private Runnable pendingBindRunnable; + private static final OperationActionRegistry INSTANCE = new OperationActionRegistry(); + + // Holding the actions that have been registered by the application code through registerOperationGraphicalAction(). + // These actions usually hold only the graphical properties, they are not executable (the event handler doesn't do + // anything). They are used to bind the graphical properties of the executable operation actions - through + // bindOperationActionGraphicalProperties(). + private final Map registeredGraphicalActions = new HashMap<>(); + + // Holding the executable operation actions instantiated by the application code (probably bound to a UI control + // such as a button) which have been asked to be bound to a registered graphical action, through + // bindOperationActionGraphicalProperties(). + private final Map>> registeredOperationActions = new HashMap<>(); + // Keeping a list of operation actions whose graphical action are not yet registered => the binding is deferred + // until the graphical action is registered. + private final List notYetBoundExecutableOperationActions = new ArrayList<>(); + + // When the application code wants to be notified when an executable operation action has been bound to its graphical + // properties, it can get an observable which will transit from null to the operation action at that time. + private final Map> executableOperationActionNotifyingProperties = new HashMap<>(); + + private Scheduled bindScheduled; private Consumer operationActionGraphicalPropertiesUpdater; public static OperationActionRegistry getInstance() { - if (INSTANCE == null) - INSTANCE = new OperationActionRegistry(); return INSTANCE; } @@ -80,103 +99,120 @@ public Future apply(Object request) { return AuthorizationUtil.authorizedOperationProperty( operationRequestFactory , embedAuthorizationFunction - , operationActionProperty(operationCode) // reactive property (will change when operation action will be registered, causing a new authorization evaluation) + , executableOperationActionNotifyingProperty(operationCode) // reactive property (will change when operation action will be registered, causing a new authorization evaluation) ); } - public OperationActionRegistry registerOperationGraphicalAction(Class operationRequestClass, Action graphicalAction) { - synchronized (graphicalActions) { - graphicalActions.put(operationRequestClass, graphicalAction); - return checkPendingOperationActionGraphicalBindings(); + private void processRegisteredOperationActions(Object operationCodeOrRequestClass, Consumer processor) { + List> operationActions = registeredOperationActions.get(operationCodeOrRequestClass); + if (operationActions != null) { + for (Iterator> it = operationActions.iterator(); it.hasNext(); ) { + OperationAction oa = it.next().get(); + if (oa == null) { + logDebug(operationCodeOrRequestClass + " operation action was garbage-collected"); + it.remove(); + } else { + processor.accept(oa); + } + } } } - public OperationActionRegistry registerOperationGraphicalAction(Object operationCode, Action graphicalAction) { - synchronized (graphicalActions) { - graphicalActions.put(operationCode, graphicalAction); + public OperationActionRegistry registerOperationGraphicalAction(Object operationCodeOrRequestClass, Action graphicalAction) { + synchronized (registeredGraphicalActions) { + logDebug("Registering " + operationCodeOrRequestClass + " graphical action (" + (registeredGraphicalActions.containsKey(operationCodeOrRequestClass) ? "not" : "") + " first time)"); + registeredGraphicalActions.put(operationCodeOrRequestClass, graphicalAction); + processRegisteredOperationActions(operationCodeOrRequestClass, oa -> { + logDebug(operationCodeOrRequestClass + " operation action will be rebound to new graphical action"); + Collections.addIfNotContains(oa, notYetBoundExecutableOperationActions); + }); return checkPendingOperationActionGraphicalBindings(); } } + private OperationActionRegistry registerOperationAction(Object operationCodeOrRequestClass, OperationAction operationAction) { + synchronized (registeredOperationActions) { + boolean[] alreadyRegistered = { false }; + processRegisteredOperationActions(operationCodeOrRequestClass, oa -> { + if (oa == operationAction) + alreadyRegistered[0] = true; + }); + if (!alreadyRegistered[0]) { + List> operationActions = registeredOperationActions.computeIfAbsent(operationCodeOrRequestClass, k -> new ArrayList<>()); + operationActions.add(new WeakReference<>(operationAction)); + logDebug("Registering " + operationCodeOrRequestClass + " operation action -> n°" + operationActions.size()); + } + return this; + } + } + private OperationActionRegistry checkPendingOperationActionGraphicalBindings() { - if (notYetBoundOperationActions != null && pendingBindRunnable == null) { - UiScheduler.scheduleDeferred(pendingBindRunnable = () -> { - Collection operationActionsToBind = notYetBoundOperationActions; - pendingBindRunnable = null; - notYetBoundOperationActions = null; - for (OperationAction operationAction : operationActionsToBind) - bindOperationActionGraphicalProperties(operationAction); + if (!notYetBoundExecutableOperationActions.isEmpty() && (bindScheduled == null || bindScheduled.isFinished())) { + bindScheduled = UiScheduler.scheduleDeferred(() -> { + notYetBoundExecutableOperationActions.forEach(this::bindOperationActionGraphicalProperties); + notYetBoundExecutableOperationActions.clear(); }); } return this; } - void bindOperationActionGraphicalProperties(OperationAction operationAction) { - if (bindOperationActionGraphicalPropertiesNow(operationAction)) + void bindOperationActionGraphicalProperties(OperationAction executableOperationAction) { + if (bindOperationActionGraphicalPropertiesNow(executableOperationAction)) return; - if (notYetBoundOperationActions == null) - notYetBoundOperationActions = new ArrayList<>(); - notYetBoundOperationActions.add(operationAction); + notYetBoundExecutableOperationActions.add(executableOperationAction); } - private boolean bindOperationActionGraphicalPropertiesNow(OperationAction operationAction) { + private boolean bindOperationActionGraphicalPropertiesNow(OperationAction executableOperationAction) { // The binding is possible only if a graphical action has been registered for that operation // Instantiating an operation request just to have the request class or operation code - A operationRequest = newOperationActionRequest(operationAction); + A operationRequest = newOperationActionRequest(executableOperationAction); + + // Registering the operation action (should it be done only once?) + Class operationRequestClass = operationRequest.getClass(); + registerOperationAction(operationRequestClass, executableOperationAction); + Object operationCode = operationRequest instanceof HasOperationCode ? ((HasOperationCode) operationRequest).getOperationCode() : null; + if (operationCode != null) + registerOperationAction(operationCode, executableOperationAction); + // Then getting the graphical action from it Action graphicalAction = getGraphicalActionFromOperationRequest(operationRequest); // If this is not the case, we return false (can't do the binding now) if (graphicalAction == null) return false; - Map> properties = operationActionProperties; - if (properties != null) { - Object code = getOperationCodeFromGraphicalAction(graphicalAction); - if (code != null) { - ObjectProperty operationActionProperty = properties.remove(code); + // if we reach this point, we can do the binding. + updateOperationActionGraphicalProperties(executableOperationAction); + ActionBinder.bindWritableActionToAction(executableOperationAction, graphicalAction); + // We also notify the application code that we now have an executable operation action associated + if (!executableOperationActionNotifyingProperties.isEmpty()) { + if (operationCode != null) { + ObjectProperty operationActionProperty = executableOperationActionNotifyingProperties.remove(operationCode); if (operationActionProperty != null) - operationActionProperty.set(operationAction); - if (properties.isEmpty()) - operationActionProperties = null; + operationActionProperty.set(executableOperationAction); } } - ActionBinder.bindWritableActionToAction(operationAction, graphicalAction); return true; } - public Action getGraphicalActionFromOperationAction(OperationAction operationAction) { - // Instantiating an operation request just to have the request class or operation code - A operationRequest = newOperationActionRequest(operationAction); - // Then getting the graphical action from it - return getGraphicalActionFromOperationRequest(operationRequest); - } - + // Important: the code calling this method should not store the value, but request it again each time it needs it, + // because the graphical action can change (ex: cache value on application start & then refreshed value from database) public Action getGraphicalActionFromOperationRequest(Object operationRequest) { // Trying to get the operation action registered with the operation request class or code. Action graphicalAction = getGraphicalActionFromOperationRequestClass(operationRequest.getClass()); if (graphicalAction == null && operationRequest instanceof HasOperationCode) graphicalAction = getGraphicalActionFromOperationCode(((HasOperationCode) operationRequest).getOperationCode()); + if (graphicalAction != null && operationRequest instanceof ActionTuner) { + graphicalAction = ((ActionTuner) operationRequest).tuneAction(graphicalAction); + } return graphicalAction; } private Action getGraphicalActionFromOperationRequestClass(Class operationRequestClass) { - synchronized (graphicalActions) { - return graphicalActions.get(operationRequestClass); - } + return getGraphicalActionFromOperationCode(operationRequestClass); // because they share the same map } private Action getGraphicalActionFromOperationCode(Object operationCode) { - synchronized (graphicalActions) { - return graphicalActions.get(operationCode); - } - } - - private Object getOperationCodeFromGraphicalAction(Action graphicalAction) { - synchronized (graphicalActions) { - for (Map.Entry entry : graphicalActions.entrySet()) { - if (entry.getValue() == graphicalAction) - return entry.getKey(); - } - return null; + synchronized (registeredGraphicalActions) { + return registeredGraphicalActions.get(operationCode); } } @@ -189,12 +225,15 @@ void updateOperationActionGraphicalProperties(OperationAction opera operationActionGraphicalPropertiesUpdater.accept(operationAction); } - private ObservableValue operationActionProperty(Object operationCode) { - ObjectProperty operationActionProperty = new SimpleObjectProperty<>(); - if (operationActionProperties == null) - operationActionProperties = new HashMap<>(); - operationActionProperties.put(operationCode, operationActionProperty); - return operationActionProperty; + private ObservableValue executableOperationActionNotifyingProperty(Object operationCode) { + ObjectProperty property = executableOperationActionNotifyingProperties.computeIfAbsent(operationCode, k -> new SimpleObjectProperty<>()); + if (property.get() == null) { + processRegisteredOperationActions(operationCode, oa -> { + if (property.get() == null) + property.set(oa); + }); + } + return property; } public A newOperationActionRequest(OperationAction operationAction) { @@ -206,4 +245,26 @@ public A newOperationActionRequest(OperationAction operationAction) return null; } + public Action getOrWaitOperationAction(Object operationCode) { + // Waiting to be notified + ObservableValue operationActionProperty = executableOperationActionNotifyingProperty(operationCode); + // For now, we create a wrapper action that delegates the execution to the operation action (if set) + WritableAction wrapperAction = new WritableAction(e -> { // Invisible & disabled at this stage + OperationAction operationAction = operationActionProperty.getValue(); + if (operationAction != null) { + operationAction.handle(e); + } + }); + FXProperties.onPropertySet(operationActionProperty, operationAction -> + ActionBinder.bindWritableActionToAction(wrapperAction, operationAction) + ); + return wrapperAction; + } + + private static void logDebug(String message) { + if (LOG_DEBUG) { + Console.log("[OperationActionRegistry] - " + message); + } + } + } diff --git a/webfx-stack-ui-operation-action/src/main/java/module-info.java b/webfx-stack-ui-operation-action/src/main/java/module-info.java index d434dda29..d94c95d13 100644 --- a/webfx-stack-ui-operation-action/src/main/java/module-info.java +++ b/webfx-stack-ui-operation-action/src/main/java/module-info.java @@ -8,10 +8,12 @@ requires webfx.kit.util; requires webfx.platform.async; requires webfx.platform.console; + requires webfx.platform.scheduler; requires webfx.platform.uischeduler; requires webfx.platform.util; requires webfx.stack.authz.client; requires transitive webfx.stack.ui.action; + requires webfx.stack.ui.action.tuner; requires webfx.stack.ui.exceptions; requires webfx.stack.ui.operation; diff --git a/webfx-stack-ui-operation/pom.xml b/webfx-stack-ui-operation/pom.xml index 4d52619b7..719d5fd24 100644 --- a/webfx-stack-ui-operation/pom.xml +++ b/webfx-stack-ui-operation/pom.xml @@ -27,6 +27,12 @@ provided + + dev.webfx + webfx-extras-util-control + 0.1.0-SNAPSHOT + + dev.webfx webfx-kit-util diff --git a/webfx-stack-ui-operation/src/main/java/dev/webfx/stack/ui/operation/OperationUtil.java b/webfx-stack-ui-operation/src/main/java/dev/webfx/stack/ui/operation/OperationUtil.java index 0deb82f94..d2beb5692 100644 --- a/webfx-stack-ui-operation/src/main/java/dev/webfx/stack/ui/operation/OperationUtil.java +++ b/webfx-stack-ui-operation/src/main/java/dev/webfx/stack/ui/operation/OperationUtil.java @@ -1,12 +1,12 @@ package dev.webfx.stack.ui.operation; +import dev.webfx.extras.util.control.ControlUtil; import dev.webfx.kit.util.properties.FXProperties; import dev.webfx.platform.async.AsyncFunction; import dev.webfx.platform.async.Future; import dev.webfx.platform.uischeduler.UiScheduler; import javafx.scene.Node; import javafx.scene.control.Labeled; -import javafx.scene.control.ProgressIndicator; /** * @author Bruno Salmon @@ -48,9 +48,7 @@ private static void setWaitMode(boolean on, Labeled... buttons) { Node graphic = null; if (button == buttons[0]) { if (on) { - ProgressIndicator progressIndicator = new ProgressIndicator(); - progressIndicator.setPrefSize(20, 20); // Note setMaxSize() doesn't work with WebFX but setPrefSize() does - graphic = progressIndicator; + graphic = ControlUtil.createProgressIndicator(20); // Memorising the previous graphic before changing it button.getProperties().put("webfx-operation-util-graphic", button.getGraphic()); } else { diff --git a/webfx-stack-ui-operation/src/main/java/module-info.java b/webfx-stack-ui-operation/src/main/java/module-info.java index ce97e7869..367c34a3b 100644 --- a/webfx-stack-ui-operation/src/main/java/module-info.java +++ b/webfx-stack-ui-operation/src/main/java/module-info.java @@ -5,6 +5,7 @@ // Direct dependencies modules requires javafx.controls; requires javafx.graphics; + requires webfx.extras.util.control; requires webfx.kit.util; requires webfx.platform.async; requires webfx.platform.uischeduler; diff --git a/webfx-stack-ui-validation/pom.xml b/webfx-stack-ui-validation/pom.xml index 9d625dd07..1014ed9ea 100644 --- a/webfx-stack-ui-validation/pom.xml +++ b/webfx-stack-ui-validation/pom.xml @@ -33,6 +33,44 @@ provided + + dev.webfx + webfx-extras-imagestore + 0.1.0-SNAPSHOT + + + + dev.webfx + webfx-extras-util-background + 0.1.0-SNAPSHOT + + + + dev.webfx + webfx-extras-util-border + 0.1.0-SNAPSHOT + + + + dev.webfx + webfx-extras-util-scene + 0.1.0-SNAPSHOT + + + + dev.webfx + webfx-kit-util + 0.1.0-SNAPSHOT + + + + dev.webfx + webfx-platform-javabase-emul-j2cl + 0.1.0-SNAPSHOT + runtime + true + + dev.webfx webfx-platform-javatime-emul-j2cl @@ -41,6 +79,18 @@ true + + dev.webfx + webfx-platform-uischeduler + 0.1.0-SNAPSHOT + + + + dev.webfx + webfx-platform-util + 0.1.0-SNAPSHOT + + \ No newline at end of file diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/ValidationIcons.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/ValidationIcons.java new file mode 100644 index 000000000..5ef3b7991 --- /dev/null +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/ValidationIcons.java @@ -0,0 +1,11 @@ +package dev.webfx.stack.ui.validation; + +/** + * @author Bruno Salmon + */ +final class ValidationIcons { + + public final static String validationErrorIcon16Url = "dev/webfx/stack/ui/validation/controlsfx/images/decoration-error.png"; + public final static String validationRequiredIcon16Url = "dev/webfx/stack/ui/validation/controlsfx/images/required-indicator.png"; + +} diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/ValidationSupport.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/ValidationSupport.java new file mode 100644 index 000000000..bb2f74b8b --- /dev/null +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/ValidationSupport.java @@ -0,0 +1,558 @@ +package dev.webfx.stack.ui.validation; + +import dev.webfx.extras.imagestore.ImageStore; +import dev.webfx.extras.util.background.BackgroundFactory; +import dev.webfx.extras.util.border.BorderFactory; +import dev.webfx.extras.util.scene.SceneUtil; +import dev.webfx.kit.util.properties.FXProperties; +import dev.webfx.platform.uischeduler.UiScheduler; +import dev.webfx.platform.util.collection.Collections; +import dev.webfx.stack.ui.validation.controlsfx.control.decoration.Decoration; +import dev.webfx.stack.ui.validation.controlsfx.control.decoration.GraphicDecoration; +import dev.webfx.stack.ui.validation.controlsfx.validation.decoration.GraphicValidationDecoration; +import dev.webfx.stack.ui.validation.mvvmfx.ObservableRuleBasedValidator; +import dev.webfx.stack.ui.validation.mvvmfx.ValidationMessage; +import dev.webfx.stack.ui.validation.mvvmfx.Validator; +import dev.webfx.stack.ui.validation.mvvmfx.visualization.ControlsFxVisualizer; +import javafx.application.Platform; +import javafx.beans.binding.Bindings; +import javafx.beans.property.*; +import javafx.beans.value.ObservableBooleanValue; +import javafx.beans.value.ObservableStringValue; +import javafx.beans.value.ObservableValue; +import javafx.geometry.Insets; +import javafx.geometry.Pos; +import javafx.scene.Group; +import javafx.scene.Node; +import javafx.scene.Parent; +import javafx.scene.Scene; +import javafx.scene.control.*; +import javafx.scene.layout.HBox; +import javafx.scene.layout.Pane; +import javafx.scene.layout.VBox; +import javafx.scene.paint.Color; +import javafx.scene.shape.Rectangle; +import javafx.scene.text.Font; +import javafx.scene.transform.Rotate; + +import java.time.LocalDate; +import java.time.format.DateTimeFormatter; +import java.time.format.DateTimeParseException; +import java.util.ArrayList; +import java.util.Collection; +import java.util.List; +import java.util.regex.Pattern; + +/** + * @author Bruno Salmon + */ +public final class ValidationSupport { + + private static final ObservableStringValue DEFAULT_REQUIRED_MESSAGE = new SimpleStringProperty("This field is required"); + + private final List validators = new ArrayList<>(); + private final List validatorErrorDecorationNodes = new ArrayList<>(); + private final BooleanProperty validatingProperty = new SimpleBooleanProperty(); + private Node popOverContentNode; + private Node popOverOwnerNode; + + public boolean isValid() { + validatingProperty.setValue(false); + validatingProperty.setValue(true); + Validator firstInvalidValidator = firstInvalidValidator(); + if (firstInvalidValidator != null) + Platform.runLater(() -> { + popUpOverAutoScroll = true; + showValidatorErrorPopOver(firstInvalidValidator); + }); + return firstInvalidValidator == null; + } + + public void reset() { + // This will hide the possible validation error popup and other warning icons + validatingProperty.setValue(false); + } + + public void clear() { + reset(); // hiding possible validation messages + validatorErrorDecorationNodes.forEach(this::uninstallNodeDecorator); + validatorErrorDecorationNodes.clear(); + validators.forEach(validator -> { + if (validator instanceof ObservableRuleBasedValidator) { + ((ObservableRuleBasedValidator) validator).clear(); + } + }); + validators.clear(); + } + + public boolean isEmpty() { + return validators.isEmpty(); + } + + private Validator firstInvalidValidator() { + return Collections.findFirst(validators, validator -> !validator.getValidationStatus().isValid()); + } + + public void addRequiredInputs(TextInputControl... textInputControls) { + for (TextInputControl textInputControl : textInputControls) + addRequiredInput(textInputControl); + } + + public void addRequiredInput(TextInputControl textInputControl) { + addRequiredInput(textInputControl, DEFAULT_REQUIRED_MESSAGE); + } + + public void addRequiredInput(TextInputControl textInputControl, ObservableStringValue errorMessage) { + addRequiredInput(textInputControl.textProperty(), textInputControl, errorMessage); + } + + public void addRequiredInput(ObservableValue valueProperty, Node inputNode) { + addRequiredInput(valueProperty, inputNode, DEFAULT_REQUIRED_MESSAGE); + } + + public void addRequiredInput(ObservableValue valueProperty, Node inputNode, ObservableStringValue errorMessage) { + addValidationRule(Bindings.createBooleanBinding(() -> testNotEmpty(valueProperty.getValue()), valueProperty), inputNode, errorMessage, true); + } + + private static boolean testNotEmpty(Object value) { + return value != null && (!(value instanceof String) || !((String) value).trim().isEmpty()); + } + + public ObservableBooleanValue addValidationRule(ObservableValue validProperty, Node node, ObservableStringValue errorMessage) { + return addValidationRule(validProperty, node, errorMessage, false); + } + + public ObservableBooleanValue addValidationRule(ObservableValue validProperty, Node node, ObservableStringValue errorMessageProperty, boolean required) { + ObservableRuleBasedValidator validator = new ObservableRuleBasedValidator(); + ObservableBooleanValue finalValidProperty = // when true, no decorations are displayed on the node + Bindings.createBooleanBinding(() -> + !validatingProperty.get() // no decoration displayed if not validation + || validProperty.getValue() // no decoration displayed if the node is valid + || !isShowing(node) // no decoration displayed if the node is not showing + , validProperty, validatingProperty); + ValidationMessage errorValidationMessage = ValidationMessage.error(errorMessageProperty); + validator.addRule(finalValidProperty, errorValidationMessage); + validators.add(validator); + validatorErrorDecorationNodes.add(node); + installNodeDecorator(node, validator, required); + // The following code is to remove the error message after being displayed and the user is re-typing + if (node instanceof TextInputControl) { + FXProperties.runOnPropertiesChange( + () -> { + validator.validateBooleanRule(true, errorValidationMessage); + uninstallNodeDecorator(node); + } + , ((TextInputControl) node).textProperty()); // ex of dependencies: textField.textProperty() + } + return finalValidProperty; + } + + private void installNodeDecorator(Node node, ObservableRuleBasedValidator validator, boolean required) { + if (node instanceof Control) { + Control control = (Control) node; + ControlsFxVisualizer validationVisualizer = new ControlsFxVisualizer(); + validationVisualizer.setDecoration(new GraphicValidationDecoration() { + @Override + protected Node createErrorNode() { + return ImageStore.createImageView(ValidationIcons.validationErrorIcon16Url); + } + + @Override + protected Collection createValidationDecorations(dev.webfx.stack.ui.validation.controlsfx.validation.ValidationMessage message) { + boolean isTextInput = node instanceof TextInputControl; + boolean isButton = node instanceof Button; + // isInside flag will determine if we position the decoration inside the node or not (ie outside) + boolean isInside; + if (isTextInput) // inside for text inputs + isInside = true; + else { // for others, will be generally outside unless it is stretched to full width by its container + Parent parent = node.getParent(); + while (parent instanceof Pane && !(parent instanceof VBox) && !(parent instanceof HBox)) + parent = parent.getParent(); + isInside = parent instanceof VBox && ((VBox) parent).isFillWidth(); + } + double xRelativeOffset = isInside ? -1 : 1; // positioning the decoration inside the control for button and text input + double xOffset = isInside && isButton ? -20 : 0; // moving the decoration before the drop down arrow + return java.util.Collections.singletonList( + new GraphicDecoration(createDecorationNode(message), + Pos.CENTER_RIGHT, + xOffset, + 0, + xRelativeOffset, + 0) + ); + } + + @Override + protected Collection createRequiredDecorations(Control target) { + return java.util.Collections.singletonList( + new GraphicDecoration(ImageStore.createImageView(ValidationIcons.validationRequiredIcon16Url), + Pos.CENTER_LEFT, + -10, + 0)); + } + }); + validationVisualizer.initVisualization(validator.getValidationStatus(), control, required); + node.getProperties().put("validationVisualizer", validationVisualizer); + } + } + + private void uninstallNodeDecorator(Node node) { + if (node instanceof Control) { + Control control = (Control) node; + ControlsFxVisualizer validationVisualizer = (ControlsFxVisualizer) node.getProperties().get("validationVisualizer"); + if (validationVisualizer != null) + validationVisualizer.removeDecorations(control); + } + } + + private void showValidatorErrorPopOver(Validator validator) { + int index = validators.indexOf(validator); + if (index >= 0) { + Node decorationNode = validatorErrorDecorationNodes.get(index); + if (decorationNode != null) + showValidatorErrorPopOver(validator, decorationNode); + } + } + + private void showValidatorErrorPopOver(Validator validator, Node errorDecorationNode) { + ValidationMessage errorMessage = Collections.first(validator.getValidationStatus().getErrorMessages()); + if (errorMessage != null) { + Label label = new Label(); + label.textProperty().bind(errorMessage.messageProperty()); + label.setPadding(new Insets(8)); + label.setFont(Font.font("Verdana", 11.5)); + label.setTextFill(Color.WHITE); + label.setBackground(BackgroundFactory.newBackground(Color.RED, 5, 2)); + label.setBorder(BorderFactory.newBorder(Color.WHITE, 5, 2)); + Rectangle diamond = new Rectangle(10, 10, Color.RED); + diamond.getTransforms().add(new Rotate(45, 5, 5)); + diamond.layoutYProperty().bind(FXProperties.compute(label.heightProperty(), n -> n.doubleValue() - 7)); + diamond.setLayoutX(20d); + popOverContentNode = new Group(label, diamond); + //popOverContentNode.setOpacity(0.75); + //popOverContentNode.setEffect(new DropShadow()); + showPopOver(errorDecorationNode); + // Removing the error pop over when the status is valid again + FXProperties.runOrUnregisterOnPropertyChange((thisListener, oldValue, valid) -> { + if (valid) { + thisListener.unregister(); + popOverOwnerNode = null; + hidePopOver(); + } + }, validator.getValidationStatus().validProperty()); + } + } + + private void showPopOver(Node node) { + popOverOwnerNode = node; + showPopOverNow(); + if (!node.getProperties().containsKey("popOverListen")) { + node.getProperties().put("popOverListen", true); + node.sceneProperty().addListener(observable -> { + if (popOverOwnerNode == node) { + showPopOverNow(); + } + }); + node.parentProperty().addListener(observable -> { + if (popOverOwnerNode == node) { + showPopOverNow(); + } + }); + } + } + + public void addEmailValidation(TextField emailInput, Node where, ObservableStringValue errorMessage) { + // Define the email pattern + String emailPattern = "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,6}$"; + Pattern pattern = Pattern.compile(emailPattern); + // Create the validation rule + addValidationRule( + Bindings.createBooleanBinding( + () -> pattern.matcher(emailInput.getText()).matches(), + emailInput.textProperty() + ), + where, + errorMessage + ); + } + + public void addEmailNotEqualValidation(TextField emailInput, String forbiddenValue, Node where, ObservableStringValue errorMessage) { + // Create the validation rule + addValidationRule( + Bindings.createBooleanBinding( + () -> !emailInput.getText().equalsIgnoreCase(forbiddenValue), + emailInput.textProperty() + ), + where, + errorMessage + ); + } + + public void addUrlValidation(TextField urlInput, Node where, ObservableStringValue errorMessage) { + // Define the URL pattern (basic) + String urlPattern = "^(https?://)(www\\.)?[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,6}(/.*)?$"; + Pattern pattern = Pattern.compile(urlPattern); + + addValidationRule( + Bindings.createBooleanBinding( + () -> { + String input = urlInput.getText(); + return input!=null && pattern.matcher(input).matches(); // Accept empty or valid URL + }, + urlInput.textProperty() + ), + where, + errorMessage + ); + } + + public void addMinimumDurationValidation(TextField timeInput, Node where, ObservableStringValue errorMessage) { + addValidationRule( + Bindings.createBooleanBinding( + () -> { + try { + String input = timeInput.getText(); + if (input == null || input.isEmpty()) return true; // Allow empty input + int value = Integer.parseInt(input); // Try to parse the input to an integer + return value >= 60; // Validate if the integer is at least 60 + } catch (NumberFormatException e) { + return false; // Invalid if input is not a valid integer + } + }, + timeInput.textProperty() + ), + where, + errorMessage + ); + } + + + public void addUrlOrEmptyValidation(TextField urlInput, ObservableStringValue errorMessage) { + // Define the URL pattern (basic) + String urlPattern = "^(https?|srt|rtmp|rtsp)://[\\w.-]+(:\\d+)?(/[\\w./-]*)?(\\?[\\w=&%.-]*)?(#[\\w!:.=&,-]*)?$"; + Pattern pattern = Pattern.compile(urlPattern); + + // Create the validation rule + addValidationRule( + Bindings.createBooleanBinding( + () -> { + String input = urlInput.getText(); + return input.isEmpty() || pattern.matcher(input).matches(); // Accept empty or valid URL + }, + urlInput.textProperty() + ), + urlInput, + errorMessage + ); + } + + public void addNonEmptyValidation(TextField textField, Node where, ObservableStringValue errorMessage) { + // Create the validation rule + addValidationRule( + Bindings.createBooleanBinding( + () -> !textField.getText().trim().isEmpty(), + textField.textProperty() + ), + where, + errorMessage); + } + + public void addDateValidation(TextField textField,String dateFormat, Node where, ObservableStringValue errorMessage) { + DateTimeFormatter dateFormatter = DateTimeFormatter.ofPattern(dateFormat); + // Create the validation rule + addValidationRule( + Bindings.createBooleanBinding(() -> { + try { + dateFormatter.parse(textField.getText().trim()); + return true; + } catch (DateTimeParseException e) { + return false; + }}, textField.textProperty()), + where, + errorMessage + ); + } + + public void addDateOrEmptyValidation(TextField textField, String dateFormat, Node where, ObservableStringValue errorMessage) { + DateTimeFormatter dateFormatter = DateTimeFormatter.ofPattern(dateFormat); + + // Create the validation rule + addValidationRule( + Bindings.createBooleanBinding(() -> { + String input = textField.getText().trim(); + // Allow empty input to be valid + if (input.isEmpty()) { + return true; + } + try { + dateFormatter.parse(input); + return true; // Input is valid if it can be parsed + } catch (DateTimeParseException e) { + return false; // Invalid date format + } + }, textField.textProperty()), + where, + errorMessage + ); + } + + public void addIntegerValidation(TextField textField, Node where, ObservableStringValue errorMessage) { + // Create the validation rule + addValidationRule( + Bindings.createBooleanBinding(() -> { + try { + // Try to parse the text as an integer + Integer.parseInt(textField.getText().trim()); + return true; + } catch (NumberFormatException e) { + return false; + } + }, textField.textProperty()), + where, + errorMessage + ); + } + + public void addLegalAgeValidation(TextField textField, String dateFormat, int legalAge, Node where, ObservableStringValue errorMessage) { + DateTimeFormatter dateFormatter = DateTimeFormatter.ofPattern(dateFormat); + // Create the validation rule + addValidationRule( + Bindings.createBooleanBinding(() -> { + try { + LocalDate birthDate = LocalDate.parse(textField.getText().trim(), dateFormatter); + LocalDate now = LocalDate.now(); + return birthDate.plusYears(legalAge).isBefore(now) || birthDate.plusYears(legalAge).isEqual(now); + } catch (DateTimeParseException e) { + return false; + } + }, textField.textProperty()), + where, + errorMessage + ); + } + + public void addPasswordMatchValidation(TextField passwordField, TextField repeatPasswordField, ObservableStringValue errorMessageProperty) { + addValidationRule( + Bindings.createBooleanBinding( + () -> passwordField.getText().equals(repeatPasswordField.getText()), + passwordField.textProperty(), + repeatPasswordField.textProperty() + ), + repeatPasswordField, + errorMessageProperty, + true + ); + } + + public void addPasswordStrengthValidation(TextField passwordField, ObservableStringValue errorMessage) { + addValidationRule( + Bindings.createBooleanBinding( + () -> checkPasswordStrength(passwordField.getText()), + passwordField.textProperty() + ), + passwordField, + errorMessage, + true + ); + } + /** + * Checks if a password meets strength requirements. + * @param password the password to validate. + * @return true if the password meets the requirements, false otherwise. + */ + private boolean checkPasswordStrength(String password) { + if (password == null || password.isEmpty()) { + return false; + } + // Minimum length + if (password.length() < 8) { + return false; + } + // Contains at least one uppercase letter + if (!password.matches(".*[A-Z].*")) { + return false; + } + // Contains at least one lowercase letter + if (!password.matches(".*[a-z].*")) { + return false; + } + // Contains at least one digit + if (!password.matches(".*\\d.*")) { + return false; + } + // Contains at least one special character + if (!password.matches(".*[@#$%^&+=!().,*?-].*")) { + return false; + } + return true; + } + +/* + private PopOver popOver; + private void showPopOverNow() { + if (popOver != null && popOver.getOwnerNode() != popOverOwnerNode) { + popOver.hide(); + popOver = null; + } + if (popOver == null && isShowing(popOverOwnerNode)) { + popOver = new PopOver(); + popOver.setContentNode(popOverContentNode); + popOver.setArrowLocation(PopOver.ArrowLocation.BOTTOM_LEFT); + //Platform.runLater(() -> { + popOver.show(popOverOwnerNode, -(popOverOwnerNode instanceof ImageView ? ((ImageView) popOverOwnerNode).getImage().getHeight() : 0) + 4); + //}); + } + } +*/ + + private GraphicDecoration popOverDecoration; + private Node popOverDecorationTarget; + private boolean popUpOverAutoScroll; + + private void showPopOverNow() { + Platform.runLater(() -> { + hidePopOver(); + if (isShowing(popOverOwnerNode)) { + popOverDecorationTarget = popOverOwnerNode; + popOverDecoration = new GraphicDecoration(popOverContentNode, 0, -1, 0, -1); + popOverDecoration.applyDecoration(popOverDecorationTarget); + if (popUpOverAutoScroll) { + SceneUtil.scrollNodeToBeVerticallyVisibleOnScene(popOverDecorationTarget); + SceneUtil.autoFocusIfEnabled(popOverOwnerNode); + popUpOverAutoScroll = false; + } + } + }); + } + + private void hidePopOver() { + UiScheduler.runInUiThread(() -> { + if (popOverDecoration != null) { + popOverDecoration.removeDecoration(popOverDecorationTarget); + popOverDecoration = null; + } + }); + } + + private static boolean isShowing(Node node) { + if (node == null || !node.isVisible()) + return false; + Parent parent = node.getParent(); + if (parent != null) + return isShowing(parent); + Scene scene = node.getScene(); + return scene != null && scene.getRoot() == node; + } + + public void addPasswordValidation(TextField passwordInput, Label passwordLabel, ObservableStringValue errorMessage) { + addValidationRule( + Bindings.createBooleanBinding( + () -> passwordInput.getText().length() >= 8, + passwordInput.textProperty() + ), + passwordLabel, + errorMessage + ); + } +} diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ValidationSupport.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ControlsFxValidationSupport.java similarity index 99% rename from webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ValidationSupport.java rename to webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ControlsFxValidationSupport.java index e6c9d2396..ac68b6876 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ValidationSupport.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ControlsFxValidationSupport.java @@ -76,7 +76,7 @@ * * */ -public class ValidationSupport { +public class ControlsFxValidationSupport { private static final String CTRL_REQUIRED_FLAG = "$org.controlsfx.validation.required$"; //$NON-NLS-1$ @@ -111,7 +111,7 @@ public static boolean isRequired( Control c ) { * Creates validation support instance. * If initial decoration is desired invoke {@link #initInitialDecoration()}. */ - public ValidationSupport() { + public ControlsFxValidationSupport() { validationResultProperty().addListener( (o, oldValue, validationResult) -> { invalidProperty.set(!validationResult.getErrors().isEmpty()); diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ValidationMessage.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ValidationMessage.java index 45b699d6f..3ad4a0edb 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ValidationMessage.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ValidationMessage.java @@ -35,28 +35,24 @@ */ public interface ValidationMessage extends Comparable{ - public static final Comparator COMPARATOR = new Comparator() { - - @Override - public int compare(ValidationMessage vm1, ValidationMessage vm2) { - if ( vm1 == vm2 ) return 0; - if ( vm1 == null) return 1; - if ( vm2 == null) return -1; - return vm1.compareTo(vm2); - } - }; + Comparator COMPARATOR = (vm1, vm2) -> { + if ( vm1 == vm2 ) return 0; + if ( vm1 == null) return 1; + if ( vm2 == null) return -1; + return vm1.compareTo(vm2); + }; /** * Message text * @return message text */ - public String getText(); + String getText(); /** * Message {@link Severity} * @return message severity */ - public Severity getSeverity(); + Severity getSeverity(); /** @@ -71,7 +67,7 @@ public int compare(ValidationMessage vm1, ValidationMessage vm2) { * @param text message text * @return error message */ - public static ValidationMessage error(Control target, String text) { + static ValidationMessage error(Control target, String text) { return new SimpleValidationMessage(target, text, Severity.ERROR); } @@ -81,11 +77,11 @@ public static ValidationMessage error(Control target, String text) { * @param text message text * @return warning message */ - public static ValidationMessage warning(Control target, String text) { + static ValidationMessage warning(Control target, String text) { return new SimpleValidationMessage(target, text, Severity.WARNING); } - @Override default public int compareTo(ValidationMessage msg) { + @Override default int compareTo(ValidationMessage msg) { return msg == null || getTarget() != msg.getTarget() ? -1: getSeverity().compareTo(msg.getSeverity()); } } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/decoration/AbstractValidationDecoration.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/decoration/AbstractValidationDecoration.java index a2011dd5d..8a9685232 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/decoration/AbstractValidationDecoration.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/decoration/AbstractValidationDecoration.java @@ -1,18 +1,18 @@ /** * Copyright (c) 2014, 2015, ControlsFX * All rights reserved. - * + * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: - * * Redistributions of source code must retain the above copyright + * * Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. - * * Redistributions in binary form must reproduce the above copyright + * * Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. - * * Neither the name of ControlsFX, any associated website, nor the + * * Neither the name of ControlsFX, any associated website, nor the * names of its contributors may be used to endorse or promote products * derived from this software without specific prior written permission. - * + * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE @@ -30,7 +30,7 @@ import dev.webfx.stack.ui.validation.controlsfx.control.decoration.Decorator; import dev.webfx.stack.ui.validation.controlsfx.validation.ValidationMessage; import javafx.scene.control.Control; -import dev.webfx.stack.ui.validation.controlsfx.validation.ValidationSupport; +import dev.webfx.stack.ui.validation.controlsfx.validation.ControlsFxValidationSupport; import java.util.Collection; import java.util.List; @@ -42,67 +42,69 @@ * how 'validation' and 'required' decorations should be created * * See {@link GraphicValidationDecoration} for examples of such implementations. - * + * */ public abstract class AbstractValidationDecoration implements ValidationDecoration { - - private static final String VALIDATION_DECORATION = "$org.controlsfx.decoration.vaidation$"; //$NON-NLS-1$ - - private static boolean isValidationDecoration( Decoration decoration) { + + private static final String VALIDATION_DECORATION = "$org.controlsfx.decoration.validation$"; //$NON-NLS-1$ + + private static boolean isValidationDecoration(Decoration decoration) { return decoration != null && decoration.getProperties().get(VALIDATION_DECORATION) == Boolean.TRUE; } - private static void setValidationDecoration( Decoration decoration ) { - if ( decoration != null ) { + private static void setValidationDecoration(Decoration decoration) { + if (decoration != null) { decoration.getProperties().put(VALIDATION_DECORATION, Boolean.TRUE); } } - protected abstract Collection createValidationDecorations(ValidationMessage message); - protected abstract Collection createRequiredDecorations(Control target); - - /** - * Removes all validation related decorations from the target - * @param target control - */ - @Override - public void removeDecorations(Control target) { - List decorations = Decorator.getDecorations(target); - if ( decorations != null ) { - // conversion to array is a trick to prevent concurrent modification exception - for ( Decoration d: Decorator.getDecorations(target).toArray(new Decoration[0]) ) { - if (isValidationDecoration(d)) Decorator.removeDecoration(target, d); + protected abstract Collection createValidationDecorations(ValidationMessage message); + + protected abstract Collection createRequiredDecorations(Control target); + + /** + * Removes all validation related decorations from the target + * @param target control + */ + @Override + public void removeDecorations(Control target) { + List decorations = Decorator.getDecorations(target); + if (decorations != null) { + // conversion to array is a trick to prevent concurrent modification exception + for (Decoration d : Decorator.getDecorations(target).toArray(new Decoration[0])) { + if (isValidationDecoration(d)) + Decorator.removeDecoration(target, d); } } - } - - /* - * (non-Javadoc) - * @see org.controlsfx.validation.decorator.ValidationDecorator#applyValidationDecoration(org.controlsfx.validation.ValidationMessage) - */ - @Override - public void applyValidationDecoration(ValidationMessage message) { - //createValidationDecorations(message).stream().forEach( d -> decorate( message.getTarget(), d )); // stream don't work on Android - for (Decoration decoration : createValidationDecorations(message)) - decorate(message.getTarget(), decoration); - } + } + + /* + * (non-Javadoc) + * @see org.controlsfx.validation.decorator.ValidationDecorator#applyValidationDecoration(org.controlsfx.validation.ValidationMessage) + */ + @Override + public void applyValidationDecoration(ValidationMessage message) { + //createValidationDecorations(message).stream().forEach( d -> decorate( message.getTarget(), d )); // stream don't work on Android + for (Decoration decoration : createValidationDecorations(message)) + decorate(message.getTarget(), decoration); + } - /* - * (non-Javadoc) - * @see org.controlsfx.validation.decorator.ValidationDecorator#applyRequiredDecoration(javafx.scene.control.Control) - */ - @Override - public void applyRequiredDecoration(Control target) { - if ( ValidationSupport.isRequired(target)) { - // createRequiredDecorations(target).stream().forEach( d -> decorate( target, d )); // stream don't work on Android - for (Decoration decoration : createRequiredDecorations(target)) - decorate(target, decoration); - } - } - - private void decorate( Control target, Decoration d ) { - setValidationDecoration(d); // mark as validation specific decoration + /* + * (non-Javadoc) + * @see org.controlsfx.validation.decorator.ValidationDecorator#applyRequiredDecoration(javafx.scene.control.Control) + */ + @Override + public void applyRequiredDecoration(Control target) { + if (ControlsFxValidationSupport.isRequired(target)) { + // createRequiredDecorations(target).stream().forEach( d -> decorate( target, d )); // stream don't work on Android + for (Decoration decoration : createRequiredDecorations(target)) + decorate(target, decoration); + } + } + + private void decorate(Control target, Decoration d) { + setValidationDecoration(d); // mark as validation specific decoration Decorator.addDecoration(target, d); - } + } } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ObservableRuleBasedValidator.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ObservableRuleBasedValidator.java index 8b5cb2aae..e72274e28 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ObservableRuleBasedValidator.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ObservableRuleBasedValidator.java @@ -15,6 +15,8 @@ ******************************************************************************/ package dev.webfx.stack.ui.validation.mvvmfx; +import dev.webfx.kit.util.properties.FXProperties; +import dev.webfx.kit.util.properties.Unregisterable; import javafx.beans.value.ObservableValue; import java.util.ArrayList; @@ -32,7 +34,7 @@ * * * Boolean Rules of type ObservableValue<Boolean> - * + * * The first variant uses an {@link ObservableValue} together with a static message. If this observable * has a value of false the validation status will be "invalid" and the given message will be present in the {@link ValidationStatus} * of this validator. @@ -40,35 +42,27 @@ * * * Complex Rules of type ObservableValue<ValidationMessage> - * + * * The second variant allows more complex rules. It uses a {@link ObservableValue} as rule. * If this observable has a value other then null it is considered to be invalid. The {@link ValidationMessage} * value will be present in the {@link ValidationStatus} of this validator. * * - * + * * You can add multiple rules via the {@link #addRule(ObservableValue, ValidationMessage)} and {@link #addRule(ObservableValue)} method. * If multiple rules are violated, each message will be present. */ public class ObservableRuleBasedValidator implements Validator { - /* - These lists are used to store the rules that this validator is working with. - The reason for this is to prevent problems with garbage collection. - If the validator wouldn't keep references to all given rules it would be possible that they are - removed by the garbage collector which would result in wrong validation results. - To prevent this we store references to all given rules here. - Don't get confused by the fact that no values are only added to these lists but not obtained. - */ - private List> booleanRules = new ArrayList<>(); - private List> complexRules = new ArrayList<>(); - - private ValidationStatus validationStatus = new ValidationStatus(); + private final List unregisterableRules = new ArrayList<>(); + + private final ValidationStatus validationStatus = new ValidationStatus(); /** * Creates an instance of the Validator without any rules predefined. */ - public ObservableRuleBasedValidator() {} + public ObservableRuleBasedValidator() { + } /** * Creates an instance of the Validator with the given rule predefined. @@ -86,50 +80,49 @@ public ObservableRuleBasedValidator(ObservableValue rule, ValidationMes * Creates an instance of the Validator with the given complex rules predefined. * It's a shortcut for creating an empty validator and * adding one or multiple complex rules with {@link #addRule(ObservableValue)}. + * * @param rules */ - public ObservableRuleBasedValidator(ObservableValue ... rules) { + public ObservableRuleBasedValidator(ObservableValue... rules) { for (ObservableValue rule : rules) { addRule(rule); } } - /** - * Add a rule for this validator. - * - * The rule defines a condition that has to be fulfilled. - * - * A rule is defined by an observable boolean value. If the rule has a value of true the rule is - * "fulfilled". If the rule has a value of false the rule is violated. In this case the given message - * object will be added to the status of this validator. - * - * There are some predefined rules for common use cases in the {@link ObservableRules} class that can be used. - * - * @param rule - * @param message - */ - public void addRule(ObservableValue rule, ValidationMessage message) { - booleanRules.add(rule); - - rule.addListener((observable, oldValue, newValue) -> { - validateBooleanRule(newValue, message); - }); - - validateBooleanRule(rule.getValue(), message); - } - - private void validateBooleanRule(boolean isValid, ValidationMessage message) { - if (isValid) { - validationStatus.removeMessage(message); - } else { - validationStatus.addMessage(message); - } - } - - @Override - public ValidationStatus getValidationStatus() { - return validationStatus; - } + /** + * Add a rule for this validator. + * + * The rule defines a condition that has to be fulfilled. + * + * A rule is defined by an observable boolean value. If the rule has a value of true the rule is + * "fulfilled". If the rule has a value of false the rule is violated. In this case the given message + * object will be added to the status of this validator. + * + * There are some predefined rules for common use cases in the {@link ObservableRules} class that can be used. + * + * @param validProperty + * @param message + */ + public void addRule(ObservableValue validProperty, ValidationMessage message) { + unregisterableRules.add( + FXProperties.runNowAndOnPropertyChange((observable, oldValue, newValue) -> + validateBooleanRule(newValue, message) + , validProperty) + ); + } + + public void validateBooleanRule(boolean isValid, ValidationMessage message) { + if (isValid) { + hideMessage(message); + } else { + showMessage(message); + } + } + + @Override + public ValidationStatus getValidationStatus() { + return validationStatus; + } /** * Add a complex rule for this validator. @@ -140,26 +133,37 @@ public ValidationStatus getValidationStatus() { * If the observable doesn't contain a value (in other words it contains null) the rule is considered to * be fulfilled and the validation status of this validator will be valid (given that no other rule is violated). * - * - * This method allows some more complex rules compared to {@link #addRule(ObservableValue, ValidationMessage)}. - * This way you can define rules that have different messages for specific cases. + * + * This method allows some more complex rules compared to {@link #addRule(ObservableValue, ValidationMessage)}. + * This way you can define rules that have different messages for specific cases. * * @param rule */ public void addRule(ObservableValue rule) { - complexRules.add(rule); - - rule.addListener((observable, oldValue, newValue) -> { - if(oldValue != null) { - validationStatus.removeMessage(oldValue); - } - if(newValue != null) { - validationStatus.addMessage(newValue); - } - }); - - if(rule.getValue() != null) { - validationStatus.addMessage(rule.getValue()); + unregisterableRules.add( + FXProperties.runNowAndOnPropertyChange((observable, oldValue, newValue) -> { + hideMessage(oldValue); // does nothing if oldValue is null + showMessage(newValue); // does nothing if newValue is null + }, rule) + ); + } + + private void showMessage(ValidationMessage message) { + if (message != null) { + validationStatus.addMessage(message); + } + } + + private void hideMessage(ValidationMessage message) { + if (message != null) { + validationStatus.removeMessage(message); } } + + public void clear() { + unregisterableRules.forEach(Unregisterable::unregister); + unregisterableRules.clear(); + validationStatus.clearMessages(); + } + } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java index 57c3b90e3..9ece55d7b 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java @@ -15,6 +15,8 @@ ******************************************************************************/ package dev.webfx.stack.ui.validation.mvvmfx; +import javafx.beans.value.ObservableStringValue; + import java.util.Objects; /** @@ -25,26 +27,30 @@ */ public class ValidationMessage { - private final String message; + private final ObservableStringValue messageProperty; private final Severity severity; - public ValidationMessage(Severity severity, String message) { + public ValidationMessage(Severity severity, ObservableStringValue messageProperty) { this.severity = Objects.requireNonNull(severity); - this.message = Objects.requireNonNull(message); + this.messageProperty = Objects.requireNonNull(messageProperty); } - public static ValidationMessage warning(String message) { - return new ValidationMessage(Severity.WARNING, message); + public static ValidationMessage warning(ObservableStringValue messageProperty) { + return new ValidationMessage(Severity.WARNING, messageProperty); } - public static ValidationMessage error(String message) { - return new ValidationMessage(Severity.ERROR, message); + public static ValidationMessage error(ObservableStringValue messageProperty) { + return new ValidationMessage(Severity.ERROR, messageProperty); } + public ObservableStringValue messageProperty() { + return messageProperty; + } + public String getMessage() { - return message; + return messageProperty.get(); } public Severity getSeverity() { @@ -54,27 +60,27 @@ public Severity getSeverity() { @Override public String toString() { return "ValidationMessage{" + - "message='" + message + '\'' + - ", severity=" + severity + - '}'; + "messageProperty='" + messageProperty + '\'' + + ", severity=" + severity + + '}'; } @Override public boolean equals(Object o) { if (this == o) return true; - if (o == null || !(o instanceof ValidationMessage)) + if (!(o instanceof ValidationMessage)) return false; ValidationMessage that = (ValidationMessage) o; - return message.equals(that.message) && severity == that.severity; + return messageProperty.equals(that.messageProperty) && severity == that.severity; } @Override public int hashCode() { - int result = message.hashCode(); + int result = messageProperty.hashCode(); result = 31 * result + severity.hashCode(); return result; } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java index d1f82602e..82d4062fb 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java @@ -37,11 +37,11 @@ */ public class ValidationStatus { - private ListProperty messages = new SimpleListProperty<>(FXCollections.observableArrayList()); + private final ListProperty messages = new SimpleListProperty<>(FXCollections.observableArrayList()); - private ObservableList unmodifiableMessages = FXCollections.unmodifiableObservableList(messages); - private ObservableList errorMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.ERROR)); - private ObservableList warningMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.WARNING)); + private final ObservableList unmodifiableMessages = FXCollections.unmodifiableObservableList(messages); + private final ObservableList errorMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.ERROR)); + private final ObservableList warningMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.WARNING)); /** * Intended for subclasses used by special validator implementations. diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java index a3e093bd9..6ede92357 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java @@ -17,7 +17,7 @@ import dev.webfx.stack.ui.validation.mvvmfx.Severity; import dev.webfx.stack.ui.validation.mvvmfx.ValidationMessage; -import dev.webfx.stack.ui.validation.controlsfx.validation.ValidationSupport; +import dev.webfx.stack.ui.validation.controlsfx.validation.ControlsFxValidationSupport; import dev.webfx.stack.ui.validation.controlsfx.validation.decoration.GraphicValidationDecoration; import dev.webfx.stack.ui.validation.controlsfx.validation.decoration.ValidationDecoration; import javafx.scene.control.Control; @@ -52,7 +52,7 @@ public void setDecoration(ValidationDecoration decoration) { @Override void applyRequiredVisualization(Control control, boolean required) { - ValidationSupport.setRequired(control, required); + ControlsFxValidationSupport.setRequired(control, required); if (required) { decoration.applyRequiredDecoration(control); } @@ -74,12 +74,14 @@ void applyVisualization(Control control, Optional messageOpti } } else { - decoration.removeDecorations(control); - } - - if (required) { - decoration.applyRequiredDecoration(control); + removeDecorations(control); } + + applyRequiredVisualization(control, required); + } + + @Override + public void removeDecorations(Control control) { + decoration.removeDecorations(control); } - } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java index 4b6d33d41..447baca68 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java @@ -15,11 +15,12 @@ ******************************************************************************/ package dev.webfx.stack.ui.validation.mvvmfx.visualization; +import dev.webfx.kit.util.properties.FXProperties; +import dev.webfx.kit.util.properties.ObservableLists; +import dev.webfx.platform.uischeduler.UiScheduler; import dev.webfx.stack.ui.validation.mvvmfx.Severity; import dev.webfx.stack.ui.validation.mvvmfx.ValidationMessage; import dev.webfx.stack.ui.validation.mvvmfx.ValidationStatus; -import javafx.application.Platform; -import javafx.collections.ListChangeListener; import javafx.scene.control.Control; import java.util.Optional; @@ -42,20 +43,13 @@ public abstract class ValidationVisualizerBase implements ValidationVisualizer { @Override public void initVisualization(final ValidationStatus result, final Control control, boolean required) { if (control.getSkin() == null) { - control.skinProperty().addListener((observable, oldValue, newValue) -> initVisualization(result, control, required)); + FXProperties.onPropertySet(control.skinProperty(), skin -> initVisualization(result, control, required)); return; } - if (required) { - applyRequiredVisualization(control, required); - } - - applyVisualization(control, result.getHighestMessage(), required); - - result.getMessages().addListener((ListChangeListener) c -> { - while (c.next()) { - Platform.runLater(() -> applyVisualization(control, result.getHighestMessage(), required)); - } - }); + + ObservableLists.runNowAndOnListChange(c -> UiScheduler.runInUiThread(() -> + applyVisualization(control, result.getHighestMessage(), required) + ), result.getMessages()); } /** @@ -93,5 +87,7 @@ public void initVisualization(final ValidationStatus result, final Control contr * a boolean flag indicating whether this control is mandatory or not. */ abstract void applyVisualization(Control control, Optional messageOptional, boolean required); + + public abstract void removeDecorations(Control control); } diff --git a/webfx-stack-ui-validation/src/main/java/module-info.java b/webfx-stack-ui-validation/src/main/java/module-info.java index 9aca87547..b37e66d92 100644 --- a/webfx-stack-ui-validation/src/main/java/module-info.java +++ b/webfx-stack-ui-validation/src/main/java/module-info.java @@ -6,8 +6,16 @@ requires javafx.base; requires javafx.controls; requires javafx.graphics; + requires webfx.extras.imagestore; + requires webfx.extras.util.background; + requires webfx.extras.util.border; + requires webfx.extras.util.scene; + requires webfx.kit.util; + requires webfx.platform.uischeduler; + requires webfx.platform.util; // Exported packages + exports dev.webfx.stack.ui.validation; exports dev.webfx.stack.ui.validation.controlsfx.control.decoration; exports dev.webfx.stack.ui.validation.controlsfx.impl; exports dev.webfx.stack.ui.validation.controlsfx.impl.skin;
P bindChildrenToVisibleActions(P parent, Collection actions, Converter nodeFactory) { + + public static Unregisterable bindChildrenToVisibleActions(P parent, Collection actions, Converter nodeFactory) { ActionGroup actionGroup = new ActionGroupBuilder().setActions(actions).build(); return bindChildrenToActionGroup(parent, actionGroup, nodeFactory); } - public static P bindChildrenToActionGroup(P parent, ActionGroup actionGroup, Converter nodeFactory) { - bindChildrenToActionGroup(parent.getChildren(), actionGroup, nodeFactory); - return parent; + public static Unregisterable bindChildrenToActionGroup(P parent, ActionGroup actionGroup, Converter nodeFactory) { + return bindChildrenToActionGroup(parent.getChildren(), actionGroup, nodeFactory); } - public static ObservableList bindChildrenToActionGroup(ObservableList children, ActionGroup actionGroup, Converter nodeFactory) { - ObservableLists.bindConverted(children, actionGroup.getVisibleActions(), nodeFactory); - return children; + public static Unregisterable bindChildrenToActionGroup(ObservableList children, ActionGroup actionGroup, Converter nodeFactory) { + return ObservableLists.bindConverted(children, actionGroup.getVisibleActions(), nodeFactory); } } diff --git a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionBuilder.java b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionBuilder.java index 9575ff494..904e1eb90 100644 --- a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionBuilder.java +++ b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionBuilder.java @@ -1,17 +1,20 @@ package dev.webfx.stack.ui.action; +import dev.webfx.kit.util.properties.FXProperties; +import dev.webfx.stack.i18n.I18n; +import dev.webfx.stack.ui.json.JsonImageView; import javafx.beans.binding.BooleanExpression; import javafx.beans.property.SimpleBooleanProperty; import javafx.beans.property.SimpleObjectProperty; import javafx.beans.property.SimpleStringProperty; import javafx.beans.value.ObservableBooleanValue; -import javafx.beans.value.ObservableObjectValue; import javafx.beans.value.ObservableStringValue; +import javafx.beans.value.ObservableValue; import javafx.event.ActionEvent; import javafx.event.EventHandler; import javafx.scene.Node; -import dev.webfx.stack.i18n.I18n; -import dev.webfx.stack.ui.json.JsonImageView; + +import java.util.function.Supplier; /** * @author Bruno Salmon @@ -24,8 +27,8 @@ public class ActionBuilder { private String text; private Object i18nKey; - private ObservableObjectValue graphicProperty; - private Node graphic; + private ObservableValue> graphicFactoryProperty; + private Supplier graphicFactory; private Object graphicUrlOrJson; private ObservableBooleanValue disabledProperty; @@ -39,6 +42,8 @@ public class ActionBuilder { private EventHandler actionHandler; + private Object userData; + private ActionBuilderRegistry registry; public ActionBuilder() { @@ -48,6 +53,18 @@ public ActionBuilder(Object actionKey) { this.actionKey = actionKey; } + public ActionBuilder(Action action) { + setTextProperty(action.textProperty()); + setText(action.getText()); + setGraphicFactoryProperty(action.graphicFactoryProperty()); + setGraphicFactory(action.getGraphicFactory()); + setDisabledProperty(action.disabledProperty()); + setVisibleProperty(action.visibleProperty()); + setActionHandler(action); + setUserData(action.getUserData()); + //setHiddenWhenDisabled(visibleProperty == disabledProperty || visibleProperty instanceof BooleanBinding && ((BooleanBinding) visibleProperty).getDependencies().contains(disabledProperty)); + } + public Object getActionKey() { return actionKey; } @@ -84,21 +101,21 @@ public ActionBuilder setI18nKey(Object i18nKey) { return this; } - public ObservableObjectValue getGraphicProperty() { - return graphicProperty; + public ObservableValue> getGraphicFactoryProperty() { + return graphicFactoryProperty; } - public ActionBuilder setGraphicProperty(ObservableObjectValue graphicProperty) { - this.graphicProperty = graphicProperty; + public ActionBuilder setGraphicFactoryProperty(ObservableValue> graphicFactoryProperty) { + this.graphicFactoryProperty = graphicFactoryProperty; return this; } - public Node getGraphic() { - return graphic; + public Supplier getGraphicFactory() { + return graphicFactory; } - public ActionBuilder setGraphic(Node graphic) { - this.graphic = graphic; + public ActionBuilder setGraphicFactory(Supplier graphicFactory) { + this.graphicFactory = graphicFactory; return this; } @@ -169,6 +186,15 @@ public ActionBuilder setActionHandler(Runnable actionHandler) { return setActionHandler(e -> actionHandler.run()); } + public Object getUserData() { + return userData; + } + + public ActionBuilder setUserData(Object userData) { + this.userData = userData; + return this; + } + public ActionBuilder setRegistry(ActionBuilderRegistry registry) { this.registry = registry; return this; @@ -184,8 +210,8 @@ public ActionBuilder duplicate() { .setTextProperty(textProperty) .setText(text) .setI18nKey(i18nKey) - .setGraphicProperty(graphicProperty) - .setGraphic(graphic) + .setGraphicFactoryProperty(graphicFactoryProperty) + .setGraphicFactory(graphicFactory) .setGraphicUrlOrJson(graphicUrlOrJson) .setDisabledProperty(disabledProperty) .setVisibleProperty(visibleProperty) @@ -209,7 +235,9 @@ public ActionBuilder removeText() { public Action build() { completePropertiesForBuild(); - return Action.create(textProperty, graphicProperty, disabledProperty, visibleProperty, actionHandler); + Action action = Action.create(textProperty, graphicFactoryProperty, disabledProperty, visibleProperty, actionHandler); + action.setUserData(userData); + return action; } void completePropertiesForBuild() { @@ -229,13 +257,14 @@ private void completeTextProperty() { } private void completeGraphicProperty() { - if (graphicProperty == null) { - if (graphic == null && graphicUrlOrJson != null) - graphic = JsonImageView.createImageView(graphicUrlOrJson); - if (graphic != null || i18nKey == null) - graphicProperty = new SimpleObjectProperty<>(graphic); + if (graphicFactoryProperty == null) { + if (graphicFactory == null && graphicUrlOrJson != null) + graphicFactory = () -> JsonImageView.createImageView(graphicUrlOrJson); + if (graphicFactory != null || i18nKey == null) + graphicFactoryProperty = new SimpleObjectProperty<>(graphicFactory); else - graphicProperty = I18n.i18nGraphicProperty(i18nKey); + graphicFactoryProperty = FXProperties.compute(I18n.dictionaryProperty(), dictionary -> + () -> I18n.getI18nGraphic(i18nKey)); } } diff --git a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionGroup.java b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionGroup.java index 438acab5a..71838eb4a 100644 --- a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionGroup.java +++ b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionGroup.java @@ -2,14 +2,15 @@ import dev.webfx.stack.ui.action.impl.ActionGroupImpl; import javafx.beans.value.ObservableBooleanValue; -import javafx.beans.value.ObservableObjectValue; import javafx.beans.value.ObservableStringValue; +import javafx.beans.value.ObservableValue; import javafx.collections.ObservableList; import javafx.event.ActionEvent; import javafx.event.EventHandler; import javafx.scene.Node; import java.util.Collection; +import java.util.function.Supplier; /** * @author Bruno Salmon @@ -22,8 +23,8 @@ public interface ActionGroup extends Action { boolean hasSeparators(); - static ActionGroup create(Collection actions, ObservableStringValue textProperty, ObservableObjectValue graphicProperty, ObservableBooleanValue disabledProperty, ObservableBooleanValue visibleProperty, boolean hasSeparators, EventHandler actionHandler) { - return new ActionGroupImpl(actions, textProperty, graphicProperty, disabledProperty, visibleProperty, hasSeparators, actionHandler); + static ActionGroup create(Collection actions, ObservableStringValue textProperty, ObservableValue> graphicFactoryProperty, ObservableBooleanValue disabledProperty, ObservableBooleanValue visibleProperty, boolean hasSeparators, EventHandler actionHandler) { + return new ActionGroupImpl(actions, textProperty, graphicFactoryProperty, disabledProperty, visibleProperty, hasSeparators, actionHandler); } } diff --git a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionGroupBuilder.java b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionGroupBuilder.java index a0185e70a..ea2fd6bfa 100644 --- a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionGroupBuilder.java +++ b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionGroupBuilder.java @@ -1,14 +1,15 @@ package dev.webfx.stack.ui.action; +import dev.webfx.platform.util.collection.Collections; import javafx.beans.value.ObservableBooleanValue; -import javafx.beans.value.ObservableObjectValue; import javafx.beans.value.ObservableStringValue; +import javafx.beans.value.ObservableValue; import javafx.event.ActionEvent; import javafx.event.EventHandler; import javafx.scene.Node; -import dev.webfx.platform.util.collection.Collections; import java.util.Collection; +import java.util.function.Supplier; /** * @author Bruno Salmon @@ -43,7 +44,7 @@ public ActionGroupBuilder setHasSeparators(boolean hasSeparators) { @Override public ActionGroup build() { completePropertiesForBuild(); - return ActionGroup.create(actions, getTextProperty(), getGraphicProperty(), getDisabledProperty(), getVisibleProperty(), hasSeparators, getActionHandler()); + return ActionGroup.create(actions, getTextProperty(), getGraphicFactoryProperty(), getDisabledProperty(), getVisibleProperty(), hasSeparators, getActionHandler()); } // --- Overriding fluent API methods to return ActionGroupBuilder instead of ActionBuilder --- @@ -69,13 +70,13 @@ public ActionGroupBuilder setI18nKey(Object i18nKey) { } @Override - public ActionGroupBuilder setGraphicProperty(ObservableObjectValue graphicProperty) { - return (ActionGroupBuilder) super.setGraphicProperty(graphicProperty); + public ActionGroupBuilder setGraphicFactoryProperty(ObservableValue> graphicFactoryProperty) { + return (ActionGroupBuilder) super.setGraphicFactoryProperty(graphicFactoryProperty); } @Override - public ActionGroupBuilder setGraphic(Node graphic) { - return (ActionGroupBuilder) super.setGraphic(graphic); + public ActionGroupBuilder setGraphicFactory(Supplier graphicFactory) { + return (ActionGroupBuilder) super.setGraphicFactory(graphicFactory); } @Override diff --git a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/ActionGroupImpl.java b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/ActionGroupImpl.java index e331342e5..d37f5620e 100644 --- a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/ActionGroupImpl.java +++ b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/ActionGroupImpl.java @@ -1,22 +1,23 @@ package dev.webfx.stack.ui.action.impl; +import dev.webfx.kit.util.properties.FXProperties; +import dev.webfx.platform.util.collection.Collections; +import dev.webfx.stack.ui.action.Action; +import dev.webfx.stack.ui.action.ActionGroup; import javafx.beans.property.Property; import javafx.beans.value.ObservableBooleanValue; -import javafx.beans.value.ObservableObjectValue; import javafx.beans.value.ObservableStringValue; +import javafx.beans.value.ObservableValue; import javafx.collections.FXCollections; import javafx.collections.ObservableList; import javafx.event.ActionEvent; import javafx.event.EventHandler; import javafx.scene.Node; -import dev.webfx.stack.ui.action.Action; -import dev.webfx.stack.ui.action.ActionGroup; -import dev.webfx.kit.util.properties.FXProperties; -import dev.webfx.platform.util.collection.Collections; import java.util.ArrayList; import java.util.Collection; import java.util.List; +import java.util.function.Supplier; /** * @author Bruno Salmon @@ -27,8 +28,8 @@ public final class ActionGroupImpl extends ReadOnlyAction implements ActionGroup private final ObservableList visibleActions = FXCollections.observableArrayList(); private final boolean hasSeparators; - public ActionGroupImpl(Collection actions, ObservableStringValue textProperty, ObservableObjectValue graphicProperty, ObservableBooleanValue disabledProperty, ObservableBooleanValue visibleProperty, boolean hasSeparators, EventHandler actionHandler) { - super(textProperty, graphicProperty, disabledProperty, visibleProperty, actionHandler); + public ActionGroupImpl(Collection actions, ObservableStringValue textProperty, ObservableValue> graphicFactoryProperty, ObservableBooleanValue disabledProperty, ObservableBooleanValue visibleProperty, boolean hasSeparators, EventHandler actionHandler) { + super(textProperty, graphicFactoryProperty, disabledProperty, visibleProperty, actionHandler); this.actions = actions; this.hasSeparators = hasSeparators; FXProperties.runNowAndOnPropertiesChange(this::updateVisibleActions, Collections.map(actions, Action::visibleProperty)); @@ -40,7 +41,7 @@ private void updateVisibleActions() { for (Action action : this.actions) { if (action.isVisible()) { int n = actions.size(); - if (action.getText() == null && action.getGraphic() == null && action instanceof ActionGroup) { + if (action.getText() == null && action.getGraphicFactory() == null && action instanceof ActionGroup) { ActionGroup actionGroup = (ActionGroup) action; actions.addAll(actionGroup.getVisibleActions()); if (actions.size() > n) { diff --git a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/ReadOnlyAction.java b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/ReadOnlyAction.java index 17d90a782..c0843f2b0 100644 --- a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/ReadOnlyAction.java +++ b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/ReadOnlyAction.java @@ -1,12 +1,14 @@ package dev.webfx.stack.ui.action.impl; +import dev.webfx.stack.ui.action.Action; import javafx.beans.value.ObservableBooleanValue; -import javafx.beans.value.ObservableObjectValue; import javafx.beans.value.ObservableStringValue; +import javafx.beans.value.ObservableValue; import javafx.event.ActionEvent; import javafx.event.EventHandler; import javafx.scene.Node; -import dev.webfx.stack.ui.action.Action; + +import java.util.function.Supplier; /** * A read-only action where properties are observable values. @@ -15,9 +17,9 @@ */ public class ReadOnlyAction implements Action { - public ReadOnlyAction(ObservableStringValue textProperty, ObservableObjectValue graphicProperty, ObservableBooleanValue disabledProperty, ObservableBooleanValue visibleProperty, EventHandler actionHandler) { + public ReadOnlyAction(ObservableStringValue textProperty, ObservableValue> graphicFactoryProperty, ObservableBooleanValue disabledProperty, ObservableBooleanValue visibleProperty, EventHandler actionHandler) { this.textProperty = textProperty; - this.graphicProperty = graphicProperty; + this.graphicFactoryProperty = graphicFactoryProperty; this.disabledProperty = disabledProperty; this.visibleProperty = visibleProperty; this.actionHandler = actionHandler; @@ -29,10 +31,10 @@ public ObservableStringValue textProperty() { return textProperty; } - private final ObservableObjectValue graphicProperty; + private final ObservableValue> graphicFactoryProperty; @Override - public ObservableObjectValue graphicProperty() { - return graphicProperty; + public ObservableValue> graphicFactoryProperty() { + return graphicFactoryProperty; } private final ObservableBooleanValue disabledProperty; diff --git a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/WritableAction.java b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/WritableAction.java index 849ef13ca..8f42b2cee 100644 --- a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/WritableAction.java +++ b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/WritableAction.java @@ -1,14 +1,16 @@ package dev.webfx.stack.ui.action.impl; +import dev.webfx.platform.util.Arrays; +import dev.webfx.stack.ui.action.Action; import javafx.beans.property.*; import javafx.beans.value.ObservableBooleanValue; -import javafx.beans.value.ObservableObjectValue; import javafx.beans.value.ObservableStringValue; +import javafx.beans.value.ObservableValue; import javafx.event.ActionEvent; import javafx.event.EventHandler; import javafx.scene.Node; -import dev.webfx.stack.ui.action.Action; -import dev.webfx.platform.util.Arrays; + +import java.util.function.Supplier; /** * A writable action where properties (text, graphic, disabled, visible) can be set later (ie after constructor call) @@ -19,15 +21,15 @@ public class WritableAction extends ReadOnlyAction { public WritableAction(Action action, String... writablePropertyNames) { - this(createStringProperty(action.textProperty(), "text", writablePropertyNames), createObjectProperty(action.graphicProperty(), "graphic", writablePropertyNames), createBooleanProperty(action.disabledProperty(), "disabled", writablePropertyNames), createBooleanProperty(action.visibleProperty(), "visible", writablePropertyNames), action); + this(createStringProperty(action.textProperty(), "text", writablePropertyNames), createObjectProperty(action.graphicFactoryProperty(), "graphicFactory", writablePropertyNames), createBooleanProperty(action.disabledProperty(), "disabled", writablePropertyNames), createBooleanProperty(action.visibleProperty(), "visible", writablePropertyNames), action); } public WritableAction(EventHandler actionHandler) { this(new SimpleStringProperty(), new SimpleObjectProperty<>(), new SimpleBooleanProperty(true /* disabled until it is bound */), new SimpleBooleanProperty(false /* invisible until it is bound */), actionHandler); } - public WritableAction(ObservableStringValue textProperty, ObservableObjectValue graphicProperty, ObservableBooleanValue disabledProperty, ObservableBooleanValue visibleProperty, EventHandler actionHandler) { - super(textProperty, graphicProperty, disabledProperty, visibleProperty, actionHandler); + public WritableAction(ObservableStringValue textProperty, ObservableValue> graphicFactoryProperty, ObservableBooleanValue disabledProperty, ObservableBooleanValue visibleProperty, EventHandler actionHandler) { + super(textProperty, graphicFactoryProperty, disabledProperty, visibleProperty, actionHandler); } public StringProperty writableTextProperty() { @@ -38,12 +40,12 @@ public void setText(String text) { writableTextProperty().set(text); } - public ObjectProperty writableGraphicProperty() { - return (ObjectProperty) graphicProperty(); + public ObjectProperty> writableGraphicFactoryProperty() { + return (ObjectProperty>) graphicFactoryProperty(); } - public void setGraphic(Node graphic) { - writableGraphicProperty().set(graphic); + public void setGraphicFactory(Supplier graphicFactory) { + writableGraphicFactoryProperty().set(graphicFactory); } public BooleanProperty writableDisabledProperty() { @@ -76,10 +78,10 @@ public void set(String newValue) { return writableProperty; } - private static ObjectProperty createObjectProperty(ObservableObjectValue readOnlyProperty, String propertyName, String... writablePropertyNames) { + private static ObjectProperty createObjectProperty(ObservableValue readOnlyProperty, String propertyName, String... writablePropertyNames) { if (readOnlyProperty instanceof ObjectProperty) return (ObjectProperty) readOnlyProperty; - SimpleObjectProperty writableProperty = new SimpleObjectProperty() { + SimpleObjectProperty writableProperty = new SimpleObjectProperty<>() { @Override public void set(T newValue) { unbindPropertyIfWritable(this, propertyName, writablePropertyNames); diff --git a/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/ControlFactoryMixin.java b/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/ControlFactoryMixin.java index dcdeb5c0e..061e99672 100644 --- a/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/ControlFactoryMixin.java +++ b/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/ControlFactoryMixin.java @@ -110,11 +110,11 @@ default Button styleButton(Button button) { } default CheckBox newCheckBox(Object i18nKey) { - return I18nControls.bindI18nProperties(new CheckBox(), i18nKey); + return I18nControls.newCheckBox(i18nKey); } default RadioButton newRadioButton(Object i18nKey) { - return I18nControls.bindI18nProperties(new RadioButton(), i18nKey); + return I18nControls.newRadioButton(i18nKey); } default RadioButton newRadioButton(Object i18nKey, ToggleGroup toggleGroup) { @@ -124,7 +124,7 @@ default RadioButton newRadioButton(Object i18nKey, ToggleGroup toggleGroup) { } default Label newLabel(Object i18nKey) { - return I18nControls.bindI18nProperties(new Label(), i18nKey); + return I18nControls.newLabel(i18nKey); } default TextField newTextField() { @@ -144,7 +144,7 @@ default Hyperlink newHyperlink() { } default Hyperlink newHyperlink(Object i18nKey) { - return I18nControls.bindI18nProperties(newHyperlink(), i18nKey); + return I18nControls.newHyperlink(i18nKey); } default Hyperlink newHyperlink(Object i18nKey, EventHandler onAction) { @@ -158,7 +158,7 @@ default TextArea newTextArea(Object i18nKey) { } default Text newText(Object i18nKey) { - return I18n.bindI18nProperties(new Text(), i18nKey); + return I18n.newText(i18nKey); } } diff --git a/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/button/ButtonFactory.java b/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/button/ButtonFactory.java index bcd8188e9..b52cd46d5 100644 --- a/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/button/ButtonFactory.java +++ b/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/button/ButtonFactory.java @@ -62,7 +62,7 @@ public static Button decorateButtonWithDropDownArrow(Button button) { downArrow.setFill(null); downArrow.setContent("M1 1.22998L6.325 6.55499L11.65 1.22998"); GraphicDecoration dropDownArrowDecoration = new GraphicDecoration(downArrow, Pos.CENTER_RIGHT, 0, 0, -1, 0); - FXProperties.runNowAndOnPropertiesChange(() -> Platform.runLater(() -> + FXProperties.runNowAndOnPropertyChange(() -> Platform.runLater(() -> Controls.onSkinReady(button, () -> dropDownArrowDecoration.applyDecoration(button)) ), button.graphicProperty()); // Code to clip the content before the down arrow diff --git a/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/dialog/DialogContent.java b/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/dialog/DialogContent.java index 73739f4ee..c0b7e8c82 100644 --- a/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/dialog/DialogContent.java +++ b/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/dialog/DialogContent.java @@ -72,6 +72,12 @@ public DialogContent setYesNo() { return this; } + public DialogContent setOk() { + primaryButtonText = "Ok"; + secondaryButton.setManaged(false); + return this; + } + public Button getPrimaryButton() { return primaryButton; } diff --git a/webfx-stack-ui-json/src/main/java/dev/webfx/stack/ui/json/JsonSVGPath.java b/webfx-stack-ui-json/src/main/java/dev/webfx/stack/ui/json/JsonSVGPath.java index 8d2154fd0..3bd74ee98 100644 --- a/webfx-stack-ui-json/src/main/java/dev/webfx/stack/ui/json/JsonSVGPath.java +++ b/webfx-stack-ui-json/src/main/java/dev/webfx/stack/ui/json/JsonSVGPath.java @@ -7,6 +7,8 @@ import javafx.scene.paint.Paint; import javafx.scene.shape.FillRule; import javafx.scene.shape.SVGPath; +import javafx.scene.shape.StrokeLineCap; +import javafx.scene.shape.StrokeLineJoin; /** * @author Bruno Salmon @@ -21,6 +23,9 @@ public static SVGPath createSVGPath(ReadOnlyAstObject json) { svgPath.setStroke(toPaint(json.getString("stroke"), null)); svgPath.setStrokeWidth(json.getDouble("strokeWidth", 1d)); svgPath.setFillRule(toFillRule(json.getString("fillRule"))); + svgPath.setStrokeLineCap(toStrokeLineCap(json.getString("strokeLineCap"))); + svgPath.setStrokeLineJoin(toStrokeLineJoin(json.getString("strokeLineJoin"))); + svgPath.setStrokeMiterLimit(json.getDouble("strokeMiterLimit", 10d)); return svgPath; } @@ -40,11 +45,36 @@ private static Paint toPaint(String paintText, Paint defaultPaint) { } private static FillRule toFillRule(String ruleText) { - if (ruleText != null) + if (ruleText != null) { switch (ruleText.trim().toLowerCase()) { - case "evenodd" : return FillRule.EVEN_ODD; - case "nonzero" : return FillRule.NON_ZERO; + case "evenodd": + return FillRule.EVEN_ODD; + case "nonzero": + return FillRule.NON_ZERO; } + } return FillRule.NON_ZERO; } + + private static StrokeLineCap toStrokeLineCap(String strokeLineCapText) { + if (strokeLineCapText != null) { + switch (strokeLineCapText.trim().toLowerCase()) { + case "square" : return StrokeLineCap.SQUARE; + case "butt" : return StrokeLineCap.BUTT; + case "round" : return StrokeLineCap.ROUND; + } + } + return StrokeLineCap.SQUARE; + } + + private static StrokeLineJoin toStrokeLineJoin(String StrokeLineJoinText) { + if (StrokeLineJoinText != null) { + switch (StrokeLineJoinText.trim().toLowerCase()) { + case "miter": return StrokeLineJoin.MITER; + case "bevel": return StrokeLineJoin.BEVEL; + case "round": return StrokeLineJoin.ROUND; + } + } + return StrokeLineJoin.MITER; + } } diff --git a/webfx-stack-ui-operation-action/pom.xml b/webfx-stack-ui-operation-action/pom.xml index b65dbafb7..d7388c4a9 100644 --- a/webfx-stack-ui-operation-action/pom.xml +++ b/webfx-stack-ui-operation-action/pom.xml @@ -45,6 +45,14 @@ 0.1.0-SNAPSHOT + + dev.webfx + webfx-platform-javabase-emul-j2cl + 0.1.0-SNAPSHOT + runtime + true + + dev.webfx webfx-platform-javatime-emul-j2cl @@ -53,6 +61,12 @@ true + + dev.webfx + webfx-platform-scheduler + 0.1.0-SNAPSHOT + + dev.webfx webfx-platform-uischeduler @@ -77,6 +91,12 @@ 0.1.0-SNAPSHOT + + dev.webfx + webfx-stack-ui-action-tuner + 0.1.0-SNAPSHOT + + dev.webfx webfx-stack-ui-exceptions diff --git a/webfx-stack-ui-operation-action/src/main/java/dev/webfx/stack/ui/operation/action/OperationAction.java b/webfx-stack-ui-operation-action/src/main/java/dev/webfx/stack/ui/operation/action/OperationAction.java index cb8aaf170..de427612b 100644 --- a/webfx-stack-ui-operation-action/src/main/java/dev/webfx/stack/ui/operation/action/OperationAction.java +++ b/webfx-stack-ui-operation-action/src/main/java/dev/webfx/stack/ui/operation/action/OperationAction.java @@ -58,13 +58,9 @@ private OperationAction(OperationAction[] me, Function me[0] = this; this.operationRequestFactory = operationRequestFactory; OperationActionRegistry registry = getOperationActionRegistry(); - registry.bindOperationActionGraphicalProperties(this); - // Also, if some graphical dependencies are passed, we update the graphical properties when they change - if (graphicalDependencies.length > 0) - FXProperties.runNowAndOnPropertiesChange(() -> { - registry.updateOperationActionGraphicalProperties(this); - registry.bindOperationActionGraphicalProperties(this); - }, graphicalDependencies); + FXProperties.runNowAndOnPropertiesChange(() -> + registry.bindOperationActionGraphicalProperties(this) + , graphicalDependencies); // Also updating the graphical properties when graphical dependencies change } public OperationActionRegistry getOperationActionRegistry() { @@ -86,9 +82,8 @@ private void startShowingActionAsExecuting(Object operationRequest) { // If in addition an icon has been provided to graphically indicate the execution is in progress, if (actionExecutingIconFactory != null) { // we apply it to the graphic property Node executingIcon = actionExecutingIconFactory.apply(operationRequest); - if (executingIcon != null) { - FXProperties.setEvenIfBound(writableGraphicProperty(), executingIcon); - } + if (executingIcon != null) // For some operations such as routing operation, there is no executing icon + FXProperties.setEvenIfBound(writableGraphicFactoryProperty(), () -> executingIcon); } } @@ -100,9 +95,8 @@ private void stopShowingActionAsExecuting(Object operationRequest, Throwable exc // If in addition an icon has been provided to graphically indicate the execution has ended, if (actionExecutedIconFactory != null) { // we apply it to the graphic property for 2s Node executedIcon = actionExecutedIconFactory.apply(operationRequest, exception); - if (executedIcon != null) { - FXProperties.setEvenIfBound(writableGraphicProperty(), executedIcon); - } + if (executedIcon != null) // For some operations such as routing operation, there is no executed icon + FXProperties.setEvenIfBound(writableGraphicFactoryProperty(), () -> executedIcon); UiScheduler.scheduleDelay(2000, () -> { // After 2 seconds, we reestablish the original action icon, unless it's already executing again if (!executing) { // if executing again, we keep the possible executing icon instead diff --git a/webfx-stack-ui-operation-action/src/main/java/dev/webfx/stack/ui/operation/action/OperationActionRegistry.java b/webfx-stack-ui-operation-action/src/main/java/dev/webfx/stack/ui/operation/action/OperationActionRegistry.java index 90e74f406..0691fe3da 100644 --- a/webfx-stack-ui-operation-action/src/main/java/dev/webfx/stack/ui/operation/action/OperationActionRegistry.java +++ b/webfx-stack-ui-operation-action/src/main/java/dev/webfx/stack/ui/operation/action/OperationActionRegistry.java @@ -1,11 +1,17 @@ package dev.webfx.stack.ui.operation.action; +import dev.webfx.kit.util.properties.FXProperties; import dev.webfx.platform.async.AsyncFunction; import dev.webfx.platform.async.Future; +import dev.webfx.platform.console.Console; +import dev.webfx.platform.scheduler.Scheduled; import dev.webfx.platform.uischeduler.UiScheduler; +import dev.webfx.platform.util.collection.Collections; import dev.webfx.stack.authz.client.factory.AuthorizationUtil; import dev.webfx.stack.ui.action.Action; import dev.webfx.stack.ui.action.ActionBinder; +import dev.webfx.stack.ui.action.impl.WritableAction; +import dev.webfx.stack.ui.action.tuner.ActionTuner; import dev.webfx.stack.ui.operation.HasOperationCode; import javafx.beans.property.ObjectProperty; import javafx.beans.property.SimpleObjectProperty; @@ -13,10 +19,8 @@ import javafx.beans.value.ObservableValue; import javafx.event.ActionEvent; -import java.util.ArrayList; -import java.util.Collection; -import java.util.HashMap; -import java.util.Map; +import java.lang.ref.WeakReference; +import java.util.*; import java.util.function.Consumer; import java.util.function.Function; @@ -41,17 +45,32 @@ */ public final class OperationActionRegistry { - private static OperationActionRegistry INSTANCE; + private static final boolean LOG_DEBUG = false; - private final Map graphicalActions = new HashMap<>(); - private Collection notYetBoundOperationActions; - private Map> operationActionProperties; - private Runnable pendingBindRunnable; + private static final OperationActionRegistry INSTANCE = new OperationActionRegistry(); + + // Holding the actions that have been registered by the application code through registerOperationGraphicalAction(). + // These actions usually hold only the graphical properties, they are not executable (the event handler doesn't do + // anything). They are used to bind the graphical properties of the executable operation actions - through + // bindOperationActionGraphicalProperties(). + private final Map registeredGraphicalActions = new HashMap<>(); + + // Holding the executable operation actions instantiated by the application code (probably bound to a UI control + // such as a button) which have been asked to be bound to a registered graphical action, through + // bindOperationActionGraphicalProperties(). + private final Map>> registeredOperationActions = new HashMap<>(); + // Keeping a list of operation actions whose graphical action are not yet registered => the binding is deferred + // until the graphical action is registered. + private final List notYetBoundExecutableOperationActions = new ArrayList<>(); + + // When the application code wants to be notified when an executable operation action has been bound to its graphical + // properties, it can get an observable which will transit from null to the operation action at that time. + private final Map> executableOperationActionNotifyingProperties = new HashMap<>(); + + private Scheduled bindScheduled; private Consumer operationActionGraphicalPropertiesUpdater; public static OperationActionRegistry getInstance() { - if (INSTANCE == null) - INSTANCE = new OperationActionRegistry(); return INSTANCE; } @@ -80,103 +99,120 @@ public Future apply(Object request) { return AuthorizationUtil.authorizedOperationProperty( operationRequestFactory , embedAuthorizationFunction - , operationActionProperty(operationCode) // reactive property (will change when operation action will be registered, causing a new authorization evaluation) + , executableOperationActionNotifyingProperty(operationCode) // reactive property (will change when operation action will be registered, causing a new authorization evaluation) ); } - public OperationActionRegistry registerOperationGraphicalAction(Class operationRequestClass, Action graphicalAction) { - synchronized (graphicalActions) { - graphicalActions.put(operationRequestClass, graphicalAction); - return checkPendingOperationActionGraphicalBindings(); + private void processRegisteredOperationActions(Object operationCodeOrRequestClass, Consumer processor) { + List> operationActions = registeredOperationActions.get(operationCodeOrRequestClass); + if (operationActions != null) { + for (Iterator> it = operationActions.iterator(); it.hasNext(); ) { + OperationAction oa = it.next().get(); + if (oa == null) { + logDebug(operationCodeOrRequestClass + " operation action was garbage-collected"); + it.remove(); + } else { + processor.accept(oa); + } + } } } - public OperationActionRegistry registerOperationGraphicalAction(Object operationCode, Action graphicalAction) { - synchronized (graphicalActions) { - graphicalActions.put(operationCode, graphicalAction); + public OperationActionRegistry registerOperationGraphicalAction(Object operationCodeOrRequestClass, Action graphicalAction) { + synchronized (registeredGraphicalActions) { + logDebug("Registering " + operationCodeOrRequestClass + " graphical action (" + (registeredGraphicalActions.containsKey(operationCodeOrRequestClass) ? "not" : "") + " first time)"); + registeredGraphicalActions.put(operationCodeOrRequestClass, graphicalAction); + processRegisteredOperationActions(operationCodeOrRequestClass, oa -> { + logDebug(operationCodeOrRequestClass + " operation action will be rebound to new graphical action"); + Collections.addIfNotContains(oa, notYetBoundExecutableOperationActions); + }); return checkPendingOperationActionGraphicalBindings(); } } + private OperationActionRegistry registerOperationAction(Object operationCodeOrRequestClass, OperationAction operationAction) { + synchronized (registeredOperationActions) { + boolean[] alreadyRegistered = { false }; + processRegisteredOperationActions(operationCodeOrRequestClass, oa -> { + if (oa == operationAction) + alreadyRegistered[0] = true; + }); + if (!alreadyRegistered[0]) { + List> operationActions = registeredOperationActions.computeIfAbsent(operationCodeOrRequestClass, k -> new ArrayList<>()); + operationActions.add(new WeakReference<>(operationAction)); + logDebug("Registering " + operationCodeOrRequestClass + " operation action -> n°" + operationActions.size()); + } + return this; + } + } + private OperationActionRegistry checkPendingOperationActionGraphicalBindings() { - if (notYetBoundOperationActions != null && pendingBindRunnable == null) { - UiScheduler.scheduleDeferred(pendingBindRunnable = () -> { - Collection operationActionsToBind = notYetBoundOperationActions; - pendingBindRunnable = null; - notYetBoundOperationActions = null; - for (OperationAction operationAction : operationActionsToBind) - bindOperationActionGraphicalProperties(operationAction); + if (!notYetBoundExecutableOperationActions.isEmpty() && (bindScheduled == null || bindScheduled.isFinished())) { + bindScheduled = UiScheduler.scheduleDeferred(() -> { + notYetBoundExecutableOperationActions.forEach(this::bindOperationActionGraphicalProperties); + notYetBoundExecutableOperationActions.clear(); }); } return this; } - void bindOperationActionGraphicalProperties(OperationAction operationAction) { - if (bindOperationActionGraphicalPropertiesNow(operationAction)) + void bindOperationActionGraphicalProperties(OperationAction executableOperationAction) { + if (bindOperationActionGraphicalPropertiesNow(executableOperationAction)) return; - if (notYetBoundOperationActions == null) - notYetBoundOperationActions = new ArrayList<>(); - notYetBoundOperationActions.add(operationAction); + notYetBoundExecutableOperationActions.add(executableOperationAction); } - private boolean bindOperationActionGraphicalPropertiesNow(OperationAction operationAction) { + private boolean bindOperationActionGraphicalPropertiesNow(OperationAction executableOperationAction) { // The binding is possible only if a graphical action has been registered for that operation // Instantiating an operation request just to have the request class or operation code - A operationRequest = newOperationActionRequest(operationAction); + A operationRequest = newOperationActionRequest(executableOperationAction); + + // Registering the operation action (should it be done only once?) + Class operationRequestClass = operationRequest.getClass(); + registerOperationAction(operationRequestClass, executableOperationAction); + Object operationCode = operationRequest instanceof HasOperationCode ? ((HasOperationCode) operationRequest).getOperationCode() : null; + if (operationCode != null) + registerOperationAction(operationCode, executableOperationAction); + // Then getting the graphical action from it Action graphicalAction = getGraphicalActionFromOperationRequest(operationRequest); // If this is not the case, we return false (can't do the binding now) if (graphicalAction == null) return false; - Map> properties = operationActionProperties; - if (properties != null) { - Object code = getOperationCodeFromGraphicalAction(graphicalAction); - if (code != null) { - ObjectProperty operationActionProperty = properties.remove(code); + // if we reach this point, we can do the binding. + updateOperationActionGraphicalProperties(executableOperationAction); + ActionBinder.bindWritableActionToAction(executableOperationAction, graphicalAction); + // We also notify the application code that we now have an executable operation action associated + if (!executableOperationActionNotifyingProperties.isEmpty()) { + if (operationCode != null) { + ObjectProperty operationActionProperty = executableOperationActionNotifyingProperties.remove(operationCode); if (operationActionProperty != null) - operationActionProperty.set(operationAction); - if (properties.isEmpty()) - operationActionProperties = null; + operationActionProperty.set(executableOperationAction); } } - ActionBinder.bindWritableActionToAction(operationAction, graphicalAction); return true; } - public Action getGraphicalActionFromOperationAction(OperationAction operationAction) { - // Instantiating an operation request just to have the request class or operation code - A operationRequest = newOperationActionRequest(operationAction); - // Then getting the graphical action from it - return getGraphicalActionFromOperationRequest(operationRequest); - } - + // Important: the code calling this method should not store the value, but request it again each time it needs it, + // because the graphical action can change (ex: cache value on application start & then refreshed value from database) public Action getGraphicalActionFromOperationRequest(Object operationRequest) { // Trying to get the operation action registered with the operation request class or code. Action graphicalAction = getGraphicalActionFromOperationRequestClass(operationRequest.getClass()); if (graphicalAction == null && operationRequest instanceof HasOperationCode) graphicalAction = getGraphicalActionFromOperationCode(((HasOperationCode) operationRequest).getOperationCode()); + if (graphicalAction != null && operationRequest instanceof ActionTuner) { + graphicalAction = ((ActionTuner) operationRequest).tuneAction(graphicalAction); + } return graphicalAction; } private Action getGraphicalActionFromOperationRequestClass(Class operationRequestClass) { - synchronized (graphicalActions) { - return graphicalActions.get(operationRequestClass); - } + return getGraphicalActionFromOperationCode(operationRequestClass); // because they share the same map } private Action getGraphicalActionFromOperationCode(Object operationCode) { - synchronized (graphicalActions) { - return graphicalActions.get(operationCode); - } - } - - private Object getOperationCodeFromGraphicalAction(Action graphicalAction) { - synchronized (graphicalActions) { - for (Map.Entry entry : graphicalActions.entrySet()) { - if (entry.getValue() == graphicalAction) - return entry.getKey(); - } - return null; + synchronized (registeredGraphicalActions) { + return registeredGraphicalActions.get(operationCode); } } @@ -189,12 +225,15 @@ void updateOperationActionGraphicalProperties(OperationAction opera operationActionGraphicalPropertiesUpdater.accept(operationAction); } - private ObservableValue operationActionProperty(Object operationCode) { - ObjectProperty operationActionProperty = new SimpleObjectProperty<>(); - if (operationActionProperties == null) - operationActionProperties = new HashMap<>(); - operationActionProperties.put(operationCode, operationActionProperty); - return operationActionProperty; + private ObservableValue executableOperationActionNotifyingProperty(Object operationCode) { + ObjectProperty property = executableOperationActionNotifyingProperties.computeIfAbsent(operationCode, k -> new SimpleObjectProperty<>()); + if (property.get() == null) { + processRegisteredOperationActions(operationCode, oa -> { + if (property.get() == null) + property.set(oa); + }); + } + return property; } public A newOperationActionRequest(OperationAction operationAction) { @@ -206,4 +245,26 @@ public A newOperationActionRequest(OperationAction operationAction) return null; } + public Action getOrWaitOperationAction(Object operationCode) { + // Waiting to be notified + ObservableValue operationActionProperty = executableOperationActionNotifyingProperty(operationCode); + // For now, we create a wrapper action that delegates the execution to the operation action (if set) + WritableAction wrapperAction = new WritableAction(e -> { // Invisible & disabled at this stage + OperationAction operationAction = operationActionProperty.getValue(); + if (operationAction != null) { + operationAction.handle(e); + } + }); + FXProperties.onPropertySet(operationActionProperty, operationAction -> + ActionBinder.bindWritableActionToAction(wrapperAction, operationAction) + ); + return wrapperAction; + } + + private static void logDebug(String message) { + if (LOG_DEBUG) { + Console.log("[OperationActionRegistry] - " + message); + } + } + } diff --git a/webfx-stack-ui-operation-action/src/main/java/module-info.java b/webfx-stack-ui-operation-action/src/main/java/module-info.java index d434dda29..d94c95d13 100644 --- a/webfx-stack-ui-operation-action/src/main/java/module-info.java +++ b/webfx-stack-ui-operation-action/src/main/java/module-info.java @@ -8,10 +8,12 @@ requires webfx.kit.util; requires webfx.platform.async; requires webfx.platform.console; + requires webfx.platform.scheduler; requires webfx.platform.uischeduler; requires webfx.platform.util; requires webfx.stack.authz.client; requires transitive webfx.stack.ui.action; + requires webfx.stack.ui.action.tuner; requires webfx.stack.ui.exceptions; requires webfx.stack.ui.operation; diff --git a/webfx-stack-ui-operation/pom.xml b/webfx-stack-ui-operation/pom.xml index 4d52619b7..719d5fd24 100644 --- a/webfx-stack-ui-operation/pom.xml +++ b/webfx-stack-ui-operation/pom.xml @@ -27,6 +27,12 @@ provided + + dev.webfx + webfx-extras-util-control + 0.1.0-SNAPSHOT + + dev.webfx webfx-kit-util diff --git a/webfx-stack-ui-operation/src/main/java/dev/webfx/stack/ui/operation/OperationUtil.java b/webfx-stack-ui-operation/src/main/java/dev/webfx/stack/ui/operation/OperationUtil.java index 0deb82f94..d2beb5692 100644 --- a/webfx-stack-ui-operation/src/main/java/dev/webfx/stack/ui/operation/OperationUtil.java +++ b/webfx-stack-ui-operation/src/main/java/dev/webfx/stack/ui/operation/OperationUtil.java @@ -1,12 +1,12 @@ package dev.webfx.stack.ui.operation; +import dev.webfx.extras.util.control.ControlUtil; import dev.webfx.kit.util.properties.FXProperties; import dev.webfx.platform.async.AsyncFunction; import dev.webfx.platform.async.Future; import dev.webfx.platform.uischeduler.UiScheduler; import javafx.scene.Node; import javafx.scene.control.Labeled; -import javafx.scene.control.ProgressIndicator; /** * @author Bruno Salmon @@ -48,9 +48,7 @@ private static void setWaitMode(boolean on, Labeled... buttons) { Node graphic = null; if (button == buttons[0]) { if (on) { - ProgressIndicator progressIndicator = new ProgressIndicator(); - progressIndicator.setPrefSize(20, 20); // Note setMaxSize() doesn't work with WebFX but setPrefSize() does - graphic = progressIndicator; + graphic = ControlUtil.createProgressIndicator(20); // Memorising the previous graphic before changing it button.getProperties().put("webfx-operation-util-graphic", button.getGraphic()); } else { diff --git a/webfx-stack-ui-operation/src/main/java/module-info.java b/webfx-stack-ui-operation/src/main/java/module-info.java index ce97e7869..367c34a3b 100644 --- a/webfx-stack-ui-operation/src/main/java/module-info.java +++ b/webfx-stack-ui-operation/src/main/java/module-info.java @@ -5,6 +5,7 @@ // Direct dependencies modules requires javafx.controls; requires javafx.graphics; + requires webfx.extras.util.control; requires webfx.kit.util; requires webfx.platform.async; requires webfx.platform.uischeduler; diff --git a/webfx-stack-ui-validation/pom.xml b/webfx-stack-ui-validation/pom.xml index 9d625dd07..1014ed9ea 100644 --- a/webfx-stack-ui-validation/pom.xml +++ b/webfx-stack-ui-validation/pom.xml @@ -33,6 +33,44 @@ provided + + dev.webfx + webfx-extras-imagestore + 0.1.0-SNAPSHOT + + + + dev.webfx + webfx-extras-util-background + 0.1.0-SNAPSHOT + + + + dev.webfx + webfx-extras-util-border + 0.1.0-SNAPSHOT + + + + dev.webfx + webfx-extras-util-scene + 0.1.0-SNAPSHOT + + + + dev.webfx + webfx-kit-util + 0.1.0-SNAPSHOT + + + + dev.webfx + webfx-platform-javabase-emul-j2cl + 0.1.0-SNAPSHOT + runtime + true + + dev.webfx webfx-platform-javatime-emul-j2cl @@ -41,6 +79,18 @@ true + + dev.webfx + webfx-platform-uischeduler + 0.1.0-SNAPSHOT + + + + dev.webfx + webfx-platform-util + 0.1.0-SNAPSHOT + + \ No newline at end of file diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/ValidationIcons.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/ValidationIcons.java new file mode 100644 index 000000000..5ef3b7991 --- /dev/null +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/ValidationIcons.java @@ -0,0 +1,11 @@ +package dev.webfx.stack.ui.validation; + +/** + * @author Bruno Salmon + */ +final class ValidationIcons { + + public final static String validationErrorIcon16Url = "dev/webfx/stack/ui/validation/controlsfx/images/decoration-error.png"; + public final static String validationRequiredIcon16Url = "dev/webfx/stack/ui/validation/controlsfx/images/required-indicator.png"; + +} diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/ValidationSupport.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/ValidationSupport.java new file mode 100644 index 000000000..bb2f74b8b --- /dev/null +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/ValidationSupport.java @@ -0,0 +1,558 @@ +package dev.webfx.stack.ui.validation; + +import dev.webfx.extras.imagestore.ImageStore; +import dev.webfx.extras.util.background.BackgroundFactory; +import dev.webfx.extras.util.border.BorderFactory; +import dev.webfx.extras.util.scene.SceneUtil; +import dev.webfx.kit.util.properties.FXProperties; +import dev.webfx.platform.uischeduler.UiScheduler; +import dev.webfx.platform.util.collection.Collections; +import dev.webfx.stack.ui.validation.controlsfx.control.decoration.Decoration; +import dev.webfx.stack.ui.validation.controlsfx.control.decoration.GraphicDecoration; +import dev.webfx.stack.ui.validation.controlsfx.validation.decoration.GraphicValidationDecoration; +import dev.webfx.stack.ui.validation.mvvmfx.ObservableRuleBasedValidator; +import dev.webfx.stack.ui.validation.mvvmfx.ValidationMessage; +import dev.webfx.stack.ui.validation.mvvmfx.Validator; +import dev.webfx.stack.ui.validation.mvvmfx.visualization.ControlsFxVisualizer; +import javafx.application.Platform; +import javafx.beans.binding.Bindings; +import javafx.beans.property.*; +import javafx.beans.value.ObservableBooleanValue; +import javafx.beans.value.ObservableStringValue; +import javafx.beans.value.ObservableValue; +import javafx.geometry.Insets; +import javafx.geometry.Pos; +import javafx.scene.Group; +import javafx.scene.Node; +import javafx.scene.Parent; +import javafx.scene.Scene; +import javafx.scene.control.*; +import javafx.scene.layout.HBox; +import javafx.scene.layout.Pane; +import javafx.scene.layout.VBox; +import javafx.scene.paint.Color; +import javafx.scene.shape.Rectangle; +import javafx.scene.text.Font; +import javafx.scene.transform.Rotate; + +import java.time.LocalDate; +import java.time.format.DateTimeFormatter; +import java.time.format.DateTimeParseException; +import java.util.ArrayList; +import java.util.Collection; +import java.util.List; +import java.util.regex.Pattern; + +/** + * @author Bruno Salmon + */ +public final class ValidationSupport { + + private static final ObservableStringValue DEFAULT_REQUIRED_MESSAGE = new SimpleStringProperty("This field is required"); + + private final List validators = new ArrayList<>(); + private final List validatorErrorDecorationNodes = new ArrayList<>(); + private final BooleanProperty validatingProperty = new SimpleBooleanProperty(); + private Node popOverContentNode; + private Node popOverOwnerNode; + + public boolean isValid() { + validatingProperty.setValue(false); + validatingProperty.setValue(true); + Validator firstInvalidValidator = firstInvalidValidator(); + if (firstInvalidValidator != null) + Platform.runLater(() -> { + popUpOverAutoScroll = true; + showValidatorErrorPopOver(firstInvalidValidator); + }); + return firstInvalidValidator == null; + } + + public void reset() { + // This will hide the possible validation error popup and other warning icons + validatingProperty.setValue(false); + } + + public void clear() { + reset(); // hiding possible validation messages + validatorErrorDecorationNodes.forEach(this::uninstallNodeDecorator); + validatorErrorDecorationNodes.clear(); + validators.forEach(validator -> { + if (validator instanceof ObservableRuleBasedValidator) { + ((ObservableRuleBasedValidator) validator).clear(); + } + }); + validators.clear(); + } + + public boolean isEmpty() { + return validators.isEmpty(); + } + + private Validator firstInvalidValidator() { + return Collections.findFirst(validators, validator -> !validator.getValidationStatus().isValid()); + } + + public void addRequiredInputs(TextInputControl... textInputControls) { + for (TextInputControl textInputControl : textInputControls) + addRequiredInput(textInputControl); + } + + public void addRequiredInput(TextInputControl textInputControl) { + addRequiredInput(textInputControl, DEFAULT_REQUIRED_MESSAGE); + } + + public void addRequiredInput(TextInputControl textInputControl, ObservableStringValue errorMessage) { + addRequiredInput(textInputControl.textProperty(), textInputControl, errorMessage); + } + + public void addRequiredInput(ObservableValue valueProperty, Node inputNode) { + addRequiredInput(valueProperty, inputNode, DEFAULT_REQUIRED_MESSAGE); + } + + public void addRequiredInput(ObservableValue valueProperty, Node inputNode, ObservableStringValue errorMessage) { + addValidationRule(Bindings.createBooleanBinding(() -> testNotEmpty(valueProperty.getValue()), valueProperty), inputNode, errorMessage, true); + } + + private static boolean testNotEmpty(Object value) { + return value != null && (!(value instanceof String) || !((String) value).trim().isEmpty()); + } + + public ObservableBooleanValue addValidationRule(ObservableValue validProperty, Node node, ObservableStringValue errorMessage) { + return addValidationRule(validProperty, node, errorMessage, false); + } + + public ObservableBooleanValue addValidationRule(ObservableValue validProperty, Node node, ObservableStringValue errorMessageProperty, boolean required) { + ObservableRuleBasedValidator validator = new ObservableRuleBasedValidator(); + ObservableBooleanValue finalValidProperty = // when true, no decorations are displayed on the node + Bindings.createBooleanBinding(() -> + !validatingProperty.get() // no decoration displayed if not validation + || validProperty.getValue() // no decoration displayed if the node is valid + || !isShowing(node) // no decoration displayed if the node is not showing + , validProperty, validatingProperty); + ValidationMessage errorValidationMessage = ValidationMessage.error(errorMessageProperty); + validator.addRule(finalValidProperty, errorValidationMessage); + validators.add(validator); + validatorErrorDecorationNodes.add(node); + installNodeDecorator(node, validator, required); + // The following code is to remove the error message after being displayed and the user is re-typing + if (node instanceof TextInputControl) { + FXProperties.runOnPropertiesChange( + () -> { + validator.validateBooleanRule(true, errorValidationMessage); + uninstallNodeDecorator(node); + } + , ((TextInputControl) node).textProperty()); // ex of dependencies: textField.textProperty() + } + return finalValidProperty; + } + + private void installNodeDecorator(Node node, ObservableRuleBasedValidator validator, boolean required) { + if (node instanceof Control) { + Control control = (Control) node; + ControlsFxVisualizer validationVisualizer = new ControlsFxVisualizer(); + validationVisualizer.setDecoration(new GraphicValidationDecoration() { + @Override + protected Node createErrorNode() { + return ImageStore.createImageView(ValidationIcons.validationErrorIcon16Url); + } + + @Override + protected Collection createValidationDecorations(dev.webfx.stack.ui.validation.controlsfx.validation.ValidationMessage message) { + boolean isTextInput = node instanceof TextInputControl; + boolean isButton = node instanceof Button; + // isInside flag will determine if we position the decoration inside the node or not (ie outside) + boolean isInside; + if (isTextInput) // inside for text inputs + isInside = true; + else { // for others, will be generally outside unless it is stretched to full width by its container + Parent parent = node.getParent(); + while (parent instanceof Pane && !(parent instanceof VBox) && !(parent instanceof HBox)) + parent = parent.getParent(); + isInside = parent instanceof VBox && ((VBox) parent).isFillWidth(); + } + double xRelativeOffset = isInside ? -1 : 1; // positioning the decoration inside the control for button and text input + double xOffset = isInside && isButton ? -20 : 0; // moving the decoration before the drop down arrow + return java.util.Collections.singletonList( + new GraphicDecoration(createDecorationNode(message), + Pos.CENTER_RIGHT, + xOffset, + 0, + xRelativeOffset, + 0) + ); + } + + @Override + protected Collection createRequiredDecorations(Control target) { + return java.util.Collections.singletonList( + new GraphicDecoration(ImageStore.createImageView(ValidationIcons.validationRequiredIcon16Url), + Pos.CENTER_LEFT, + -10, + 0)); + } + }); + validationVisualizer.initVisualization(validator.getValidationStatus(), control, required); + node.getProperties().put("validationVisualizer", validationVisualizer); + } + } + + private void uninstallNodeDecorator(Node node) { + if (node instanceof Control) { + Control control = (Control) node; + ControlsFxVisualizer validationVisualizer = (ControlsFxVisualizer) node.getProperties().get("validationVisualizer"); + if (validationVisualizer != null) + validationVisualizer.removeDecorations(control); + } + } + + private void showValidatorErrorPopOver(Validator validator) { + int index = validators.indexOf(validator); + if (index >= 0) { + Node decorationNode = validatorErrorDecorationNodes.get(index); + if (decorationNode != null) + showValidatorErrorPopOver(validator, decorationNode); + } + } + + private void showValidatorErrorPopOver(Validator validator, Node errorDecorationNode) { + ValidationMessage errorMessage = Collections.first(validator.getValidationStatus().getErrorMessages()); + if (errorMessage != null) { + Label label = new Label(); + label.textProperty().bind(errorMessage.messageProperty()); + label.setPadding(new Insets(8)); + label.setFont(Font.font("Verdana", 11.5)); + label.setTextFill(Color.WHITE); + label.setBackground(BackgroundFactory.newBackground(Color.RED, 5, 2)); + label.setBorder(BorderFactory.newBorder(Color.WHITE, 5, 2)); + Rectangle diamond = new Rectangle(10, 10, Color.RED); + diamond.getTransforms().add(new Rotate(45, 5, 5)); + diamond.layoutYProperty().bind(FXProperties.compute(label.heightProperty(), n -> n.doubleValue() - 7)); + diamond.setLayoutX(20d); + popOverContentNode = new Group(label, diamond); + //popOverContentNode.setOpacity(0.75); + //popOverContentNode.setEffect(new DropShadow()); + showPopOver(errorDecorationNode); + // Removing the error pop over when the status is valid again + FXProperties.runOrUnregisterOnPropertyChange((thisListener, oldValue, valid) -> { + if (valid) { + thisListener.unregister(); + popOverOwnerNode = null; + hidePopOver(); + } + }, validator.getValidationStatus().validProperty()); + } + } + + private void showPopOver(Node node) { + popOverOwnerNode = node; + showPopOverNow(); + if (!node.getProperties().containsKey("popOverListen")) { + node.getProperties().put("popOverListen", true); + node.sceneProperty().addListener(observable -> { + if (popOverOwnerNode == node) { + showPopOverNow(); + } + }); + node.parentProperty().addListener(observable -> { + if (popOverOwnerNode == node) { + showPopOverNow(); + } + }); + } + } + + public void addEmailValidation(TextField emailInput, Node where, ObservableStringValue errorMessage) { + // Define the email pattern + String emailPattern = "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,6}$"; + Pattern pattern = Pattern.compile(emailPattern); + // Create the validation rule + addValidationRule( + Bindings.createBooleanBinding( + () -> pattern.matcher(emailInput.getText()).matches(), + emailInput.textProperty() + ), + where, + errorMessage + ); + } + + public void addEmailNotEqualValidation(TextField emailInput, String forbiddenValue, Node where, ObservableStringValue errorMessage) { + // Create the validation rule + addValidationRule( + Bindings.createBooleanBinding( + () -> !emailInput.getText().equalsIgnoreCase(forbiddenValue), + emailInput.textProperty() + ), + where, + errorMessage + ); + } + + public void addUrlValidation(TextField urlInput, Node where, ObservableStringValue errorMessage) { + // Define the URL pattern (basic) + String urlPattern = "^(https?://)(www\\.)?[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,6}(/.*)?$"; + Pattern pattern = Pattern.compile(urlPattern); + + addValidationRule( + Bindings.createBooleanBinding( + () -> { + String input = urlInput.getText(); + return input!=null && pattern.matcher(input).matches(); // Accept empty or valid URL + }, + urlInput.textProperty() + ), + where, + errorMessage + ); + } + + public void addMinimumDurationValidation(TextField timeInput, Node where, ObservableStringValue errorMessage) { + addValidationRule( + Bindings.createBooleanBinding( + () -> { + try { + String input = timeInput.getText(); + if (input == null || input.isEmpty()) return true; // Allow empty input + int value = Integer.parseInt(input); // Try to parse the input to an integer + return value >= 60; // Validate if the integer is at least 60 + } catch (NumberFormatException e) { + return false; // Invalid if input is not a valid integer + } + }, + timeInput.textProperty() + ), + where, + errorMessage + ); + } + + + public void addUrlOrEmptyValidation(TextField urlInput, ObservableStringValue errorMessage) { + // Define the URL pattern (basic) + String urlPattern = "^(https?|srt|rtmp|rtsp)://[\\w.-]+(:\\d+)?(/[\\w./-]*)?(\\?[\\w=&%.-]*)?(#[\\w!:.=&,-]*)?$"; + Pattern pattern = Pattern.compile(urlPattern); + + // Create the validation rule + addValidationRule( + Bindings.createBooleanBinding( + () -> { + String input = urlInput.getText(); + return input.isEmpty() || pattern.matcher(input).matches(); // Accept empty or valid URL + }, + urlInput.textProperty() + ), + urlInput, + errorMessage + ); + } + + public void addNonEmptyValidation(TextField textField, Node where, ObservableStringValue errorMessage) { + // Create the validation rule + addValidationRule( + Bindings.createBooleanBinding( + () -> !textField.getText().trim().isEmpty(), + textField.textProperty() + ), + where, + errorMessage); + } + + public void addDateValidation(TextField textField,String dateFormat, Node where, ObservableStringValue errorMessage) { + DateTimeFormatter dateFormatter = DateTimeFormatter.ofPattern(dateFormat); + // Create the validation rule + addValidationRule( + Bindings.createBooleanBinding(() -> { + try { + dateFormatter.parse(textField.getText().trim()); + return true; + } catch (DateTimeParseException e) { + return false; + }}, textField.textProperty()), + where, + errorMessage + ); + } + + public void addDateOrEmptyValidation(TextField textField, String dateFormat, Node where, ObservableStringValue errorMessage) { + DateTimeFormatter dateFormatter = DateTimeFormatter.ofPattern(dateFormat); + + // Create the validation rule + addValidationRule( + Bindings.createBooleanBinding(() -> { + String input = textField.getText().trim(); + // Allow empty input to be valid + if (input.isEmpty()) { + return true; + } + try { + dateFormatter.parse(input); + return true; // Input is valid if it can be parsed + } catch (DateTimeParseException e) { + return false; // Invalid date format + } + }, textField.textProperty()), + where, + errorMessage + ); + } + + public void addIntegerValidation(TextField textField, Node where, ObservableStringValue errorMessage) { + // Create the validation rule + addValidationRule( + Bindings.createBooleanBinding(() -> { + try { + // Try to parse the text as an integer + Integer.parseInt(textField.getText().trim()); + return true; + } catch (NumberFormatException e) { + return false; + } + }, textField.textProperty()), + where, + errorMessage + ); + } + + public void addLegalAgeValidation(TextField textField, String dateFormat, int legalAge, Node where, ObservableStringValue errorMessage) { + DateTimeFormatter dateFormatter = DateTimeFormatter.ofPattern(dateFormat); + // Create the validation rule + addValidationRule( + Bindings.createBooleanBinding(() -> { + try { + LocalDate birthDate = LocalDate.parse(textField.getText().trim(), dateFormatter); + LocalDate now = LocalDate.now(); + return birthDate.plusYears(legalAge).isBefore(now) || birthDate.plusYears(legalAge).isEqual(now); + } catch (DateTimeParseException e) { + return false; + } + }, textField.textProperty()), + where, + errorMessage + ); + } + + public void addPasswordMatchValidation(TextField passwordField, TextField repeatPasswordField, ObservableStringValue errorMessageProperty) { + addValidationRule( + Bindings.createBooleanBinding( + () -> passwordField.getText().equals(repeatPasswordField.getText()), + passwordField.textProperty(), + repeatPasswordField.textProperty() + ), + repeatPasswordField, + errorMessageProperty, + true + ); + } + + public void addPasswordStrengthValidation(TextField passwordField, ObservableStringValue errorMessage) { + addValidationRule( + Bindings.createBooleanBinding( + () -> checkPasswordStrength(passwordField.getText()), + passwordField.textProperty() + ), + passwordField, + errorMessage, + true + ); + } + /** + * Checks if a password meets strength requirements. + * @param password the password to validate. + * @return true if the password meets the requirements, false otherwise. + */ + private boolean checkPasswordStrength(String password) { + if (password == null || password.isEmpty()) { + return false; + } + // Minimum length + if (password.length() < 8) { + return false; + } + // Contains at least one uppercase letter + if (!password.matches(".*[A-Z].*")) { + return false; + } + // Contains at least one lowercase letter + if (!password.matches(".*[a-z].*")) { + return false; + } + // Contains at least one digit + if (!password.matches(".*\\d.*")) { + return false; + } + // Contains at least one special character + if (!password.matches(".*[@#$%^&+=!().,*?-].*")) { + return false; + } + return true; + } + +/* + private PopOver popOver; + private void showPopOverNow() { + if (popOver != null && popOver.getOwnerNode() != popOverOwnerNode) { + popOver.hide(); + popOver = null; + } + if (popOver == null && isShowing(popOverOwnerNode)) { + popOver = new PopOver(); + popOver.setContentNode(popOverContentNode); + popOver.setArrowLocation(PopOver.ArrowLocation.BOTTOM_LEFT); + //Platform.runLater(() -> { + popOver.show(popOverOwnerNode, -(popOverOwnerNode instanceof ImageView ? ((ImageView) popOverOwnerNode).getImage().getHeight() : 0) + 4); + //}); + } + } +*/ + + private GraphicDecoration popOverDecoration; + private Node popOverDecorationTarget; + private boolean popUpOverAutoScroll; + + private void showPopOverNow() { + Platform.runLater(() -> { + hidePopOver(); + if (isShowing(popOverOwnerNode)) { + popOverDecorationTarget = popOverOwnerNode; + popOverDecoration = new GraphicDecoration(popOverContentNode, 0, -1, 0, -1); + popOverDecoration.applyDecoration(popOverDecorationTarget); + if (popUpOverAutoScroll) { + SceneUtil.scrollNodeToBeVerticallyVisibleOnScene(popOverDecorationTarget); + SceneUtil.autoFocusIfEnabled(popOverOwnerNode); + popUpOverAutoScroll = false; + } + } + }); + } + + private void hidePopOver() { + UiScheduler.runInUiThread(() -> { + if (popOverDecoration != null) { + popOverDecoration.removeDecoration(popOverDecorationTarget); + popOverDecoration = null; + } + }); + } + + private static boolean isShowing(Node node) { + if (node == null || !node.isVisible()) + return false; + Parent parent = node.getParent(); + if (parent != null) + return isShowing(parent); + Scene scene = node.getScene(); + return scene != null && scene.getRoot() == node; + } + + public void addPasswordValidation(TextField passwordInput, Label passwordLabel, ObservableStringValue errorMessage) { + addValidationRule( + Bindings.createBooleanBinding( + () -> passwordInput.getText().length() >= 8, + passwordInput.textProperty() + ), + passwordLabel, + errorMessage + ); + } +} diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ValidationSupport.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ControlsFxValidationSupport.java similarity index 99% rename from webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ValidationSupport.java rename to webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ControlsFxValidationSupport.java index e6c9d2396..ac68b6876 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ValidationSupport.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ControlsFxValidationSupport.java @@ -76,7 +76,7 @@ * * */ -public class ValidationSupport { +public class ControlsFxValidationSupport { private static final String CTRL_REQUIRED_FLAG = "$org.controlsfx.validation.required$"; //$NON-NLS-1$ @@ -111,7 +111,7 @@ public static boolean isRequired( Control c ) { * Creates validation support instance. * If initial decoration is desired invoke {@link #initInitialDecoration()}. */ - public ValidationSupport() { + public ControlsFxValidationSupport() { validationResultProperty().addListener( (o, oldValue, validationResult) -> { invalidProperty.set(!validationResult.getErrors().isEmpty()); diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ValidationMessage.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ValidationMessage.java index 45b699d6f..3ad4a0edb 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ValidationMessage.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ValidationMessage.java @@ -35,28 +35,24 @@ */ public interface ValidationMessage extends Comparable{ - public static final Comparator COMPARATOR = new Comparator() { - - @Override - public int compare(ValidationMessage vm1, ValidationMessage vm2) { - if ( vm1 == vm2 ) return 0; - if ( vm1 == null) return 1; - if ( vm2 == null) return -1; - return vm1.compareTo(vm2); - } - }; + Comparator COMPARATOR = (vm1, vm2) -> { + if ( vm1 == vm2 ) return 0; + if ( vm1 == null) return 1; + if ( vm2 == null) return -1; + return vm1.compareTo(vm2); + }; /** * Message text * @return message text */ - public String getText(); + String getText(); /** * Message {@link Severity} * @return message severity */ - public Severity getSeverity(); + Severity getSeverity(); /** @@ -71,7 +67,7 @@ public int compare(ValidationMessage vm1, ValidationMessage vm2) { * @param text message text * @return error message */ - public static ValidationMessage error(Control target, String text) { + static ValidationMessage error(Control target, String text) { return new SimpleValidationMessage(target, text, Severity.ERROR); } @@ -81,11 +77,11 @@ public static ValidationMessage error(Control target, String text) { * @param text message text * @return warning message */ - public static ValidationMessage warning(Control target, String text) { + static ValidationMessage warning(Control target, String text) { return new SimpleValidationMessage(target, text, Severity.WARNING); } - @Override default public int compareTo(ValidationMessage msg) { + @Override default int compareTo(ValidationMessage msg) { return msg == null || getTarget() != msg.getTarget() ? -1: getSeverity().compareTo(msg.getSeverity()); } } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/decoration/AbstractValidationDecoration.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/decoration/AbstractValidationDecoration.java index a2011dd5d..8a9685232 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/decoration/AbstractValidationDecoration.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/decoration/AbstractValidationDecoration.java @@ -1,18 +1,18 @@ /** * Copyright (c) 2014, 2015, ControlsFX * All rights reserved. - * + * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: - * * Redistributions of source code must retain the above copyright + * * Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. - * * Redistributions in binary form must reproduce the above copyright + * * Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. - * * Neither the name of ControlsFX, any associated website, nor the + * * Neither the name of ControlsFX, any associated website, nor the * names of its contributors may be used to endorse or promote products * derived from this software without specific prior written permission. - * + * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE @@ -30,7 +30,7 @@ import dev.webfx.stack.ui.validation.controlsfx.control.decoration.Decorator; import dev.webfx.stack.ui.validation.controlsfx.validation.ValidationMessage; import javafx.scene.control.Control; -import dev.webfx.stack.ui.validation.controlsfx.validation.ValidationSupport; +import dev.webfx.stack.ui.validation.controlsfx.validation.ControlsFxValidationSupport; import java.util.Collection; import java.util.List; @@ -42,67 +42,69 @@ * how 'validation' and 'required' decorations should be created * * See {@link GraphicValidationDecoration} for examples of such implementations. - * + * */ public abstract class AbstractValidationDecoration implements ValidationDecoration { - - private static final String VALIDATION_DECORATION = "$org.controlsfx.decoration.vaidation$"; //$NON-NLS-1$ - - private static boolean isValidationDecoration( Decoration decoration) { + + private static final String VALIDATION_DECORATION = "$org.controlsfx.decoration.validation$"; //$NON-NLS-1$ + + private static boolean isValidationDecoration(Decoration decoration) { return decoration != null && decoration.getProperties().get(VALIDATION_DECORATION) == Boolean.TRUE; } - private static void setValidationDecoration( Decoration decoration ) { - if ( decoration != null ) { + private static void setValidationDecoration(Decoration decoration) { + if (decoration != null) { decoration.getProperties().put(VALIDATION_DECORATION, Boolean.TRUE); } } - protected abstract Collection createValidationDecorations(ValidationMessage message); - protected abstract Collection createRequiredDecorations(Control target); - - /** - * Removes all validation related decorations from the target - * @param target control - */ - @Override - public void removeDecorations(Control target) { - List decorations = Decorator.getDecorations(target); - if ( decorations != null ) { - // conversion to array is a trick to prevent concurrent modification exception - for ( Decoration d: Decorator.getDecorations(target).toArray(new Decoration[0]) ) { - if (isValidationDecoration(d)) Decorator.removeDecoration(target, d); + protected abstract Collection createValidationDecorations(ValidationMessage message); + + protected abstract Collection createRequiredDecorations(Control target); + + /** + * Removes all validation related decorations from the target + * @param target control + */ + @Override + public void removeDecorations(Control target) { + List decorations = Decorator.getDecorations(target); + if (decorations != null) { + // conversion to array is a trick to prevent concurrent modification exception + for (Decoration d : Decorator.getDecorations(target).toArray(new Decoration[0])) { + if (isValidationDecoration(d)) + Decorator.removeDecoration(target, d); } } - } - - /* - * (non-Javadoc) - * @see org.controlsfx.validation.decorator.ValidationDecorator#applyValidationDecoration(org.controlsfx.validation.ValidationMessage) - */ - @Override - public void applyValidationDecoration(ValidationMessage message) { - //createValidationDecorations(message).stream().forEach( d -> decorate( message.getTarget(), d )); // stream don't work on Android - for (Decoration decoration : createValidationDecorations(message)) - decorate(message.getTarget(), decoration); - } + } + + /* + * (non-Javadoc) + * @see org.controlsfx.validation.decorator.ValidationDecorator#applyValidationDecoration(org.controlsfx.validation.ValidationMessage) + */ + @Override + public void applyValidationDecoration(ValidationMessage message) { + //createValidationDecorations(message).stream().forEach( d -> decorate( message.getTarget(), d )); // stream don't work on Android + for (Decoration decoration : createValidationDecorations(message)) + decorate(message.getTarget(), decoration); + } - /* - * (non-Javadoc) - * @see org.controlsfx.validation.decorator.ValidationDecorator#applyRequiredDecoration(javafx.scene.control.Control) - */ - @Override - public void applyRequiredDecoration(Control target) { - if ( ValidationSupport.isRequired(target)) { - // createRequiredDecorations(target).stream().forEach( d -> decorate( target, d )); // stream don't work on Android - for (Decoration decoration : createRequiredDecorations(target)) - decorate(target, decoration); - } - } - - private void decorate( Control target, Decoration d ) { - setValidationDecoration(d); // mark as validation specific decoration + /* + * (non-Javadoc) + * @see org.controlsfx.validation.decorator.ValidationDecorator#applyRequiredDecoration(javafx.scene.control.Control) + */ + @Override + public void applyRequiredDecoration(Control target) { + if (ControlsFxValidationSupport.isRequired(target)) { + // createRequiredDecorations(target).stream().forEach( d -> decorate( target, d )); // stream don't work on Android + for (Decoration decoration : createRequiredDecorations(target)) + decorate(target, decoration); + } + } + + private void decorate(Control target, Decoration d) { + setValidationDecoration(d); // mark as validation specific decoration Decorator.addDecoration(target, d); - } + } } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ObservableRuleBasedValidator.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ObservableRuleBasedValidator.java index 8b5cb2aae..e72274e28 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ObservableRuleBasedValidator.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ObservableRuleBasedValidator.java @@ -15,6 +15,8 @@ ******************************************************************************/ package dev.webfx.stack.ui.validation.mvvmfx; +import dev.webfx.kit.util.properties.FXProperties; +import dev.webfx.kit.util.properties.Unregisterable; import javafx.beans.value.ObservableValue; import java.util.ArrayList; @@ -32,7 +34,7 @@ * * * Boolean Rules of type ObservableValue<Boolean> - * + * * The first variant uses an {@link ObservableValue} together with a static message. If this observable * has a value of false the validation status will be "invalid" and the given message will be present in the {@link ValidationStatus} * of this validator. @@ -40,35 +42,27 @@ * * * Complex Rules of type ObservableValue<ValidationMessage> - * + * * The second variant allows more complex rules. It uses a {@link ObservableValue} as rule. * If this observable has a value other then null it is considered to be invalid. The {@link ValidationMessage} * value will be present in the {@link ValidationStatus} of this validator. * * - * + * * You can add multiple rules via the {@link #addRule(ObservableValue, ValidationMessage)} and {@link #addRule(ObservableValue)} method. * If multiple rules are violated, each message will be present. */ public class ObservableRuleBasedValidator implements Validator { - /* - These lists are used to store the rules that this validator is working with. - The reason for this is to prevent problems with garbage collection. - If the validator wouldn't keep references to all given rules it would be possible that they are - removed by the garbage collector which would result in wrong validation results. - To prevent this we store references to all given rules here. - Don't get confused by the fact that no values are only added to these lists but not obtained. - */ - private List> booleanRules = new ArrayList<>(); - private List> complexRules = new ArrayList<>(); - - private ValidationStatus validationStatus = new ValidationStatus(); + private final List unregisterableRules = new ArrayList<>(); + + private final ValidationStatus validationStatus = new ValidationStatus(); /** * Creates an instance of the Validator without any rules predefined. */ - public ObservableRuleBasedValidator() {} + public ObservableRuleBasedValidator() { + } /** * Creates an instance of the Validator with the given rule predefined. @@ -86,50 +80,49 @@ public ObservableRuleBasedValidator(ObservableValue rule, ValidationMes * Creates an instance of the Validator with the given complex rules predefined. * It's a shortcut for creating an empty validator and * adding one or multiple complex rules with {@link #addRule(ObservableValue)}. + * * @param rules */ - public ObservableRuleBasedValidator(ObservableValue ... rules) { + public ObservableRuleBasedValidator(ObservableValue... rules) { for (ObservableValue rule : rules) { addRule(rule); } } - /** - * Add a rule for this validator. - * - * The rule defines a condition that has to be fulfilled. - * - * A rule is defined by an observable boolean value. If the rule has a value of true the rule is - * "fulfilled". If the rule has a value of false the rule is violated. In this case the given message - * object will be added to the status of this validator. - * - * There are some predefined rules for common use cases in the {@link ObservableRules} class that can be used. - * - * @param rule - * @param message - */ - public void addRule(ObservableValue rule, ValidationMessage message) { - booleanRules.add(rule); - - rule.addListener((observable, oldValue, newValue) -> { - validateBooleanRule(newValue, message); - }); - - validateBooleanRule(rule.getValue(), message); - } - - private void validateBooleanRule(boolean isValid, ValidationMessage message) { - if (isValid) { - validationStatus.removeMessage(message); - } else { - validationStatus.addMessage(message); - } - } - - @Override - public ValidationStatus getValidationStatus() { - return validationStatus; - } + /** + * Add a rule for this validator. + * + * The rule defines a condition that has to be fulfilled. + * + * A rule is defined by an observable boolean value. If the rule has a value of true the rule is + * "fulfilled". If the rule has a value of false the rule is violated. In this case the given message + * object will be added to the status of this validator. + * + * There are some predefined rules for common use cases in the {@link ObservableRules} class that can be used. + * + * @param validProperty + * @param message + */ + public void addRule(ObservableValue validProperty, ValidationMessage message) { + unregisterableRules.add( + FXProperties.runNowAndOnPropertyChange((observable, oldValue, newValue) -> + validateBooleanRule(newValue, message) + , validProperty) + ); + } + + public void validateBooleanRule(boolean isValid, ValidationMessage message) { + if (isValid) { + hideMessage(message); + } else { + showMessage(message); + } + } + + @Override + public ValidationStatus getValidationStatus() { + return validationStatus; + } /** * Add a complex rule for this validator. @@ -140,26 +133,37 @@ public ValidationStatus getValidationStatus() { * If the observable doesn't contain a value (in other words it contains null) the rule is considered to * be fulfilled and the validation status of this validator will be valid (given that no other rule is violated). * - * - * This method allows some more complex rules compared to {@link #addRule(ObservableValue, ValidationMessage)}. - * This way you can define rules that have different messages for specific cases. + * + * This method allows some more complex rules compared to {@link #addRule(ObservableValue, ValidationMessage)}. + * This way you can define rules that have different messages for specific cases. * * @param rule */ public void addRule(ObservableValue rule) { - complexRules.add(rule); - - rule.addListener((observable, oldValue, newValue) -> { - if(oldValue != null) { - validationStatus.removeMessage(oldValue); - } - if(newValue != null) { - validationStatus.addMessage(newValue); - } - }); - - if(rule.getValue() != null) { - validationStatus.addMessage(rule.getValue()); + unregisterableRules.add( + FXProperties.runNowAndOnPropertyChange((observable, oldValue, newValue) -> { + hideMessage(oldValue); // does nothing if oldValue is null + showMessage(newValue); // does nothing if newValue is null + }, rule) + ); + } + + private void showMessage(ValidationMessage message) { + if (message != null) { + validationStatus.addMessage(message); + } + } + + private void hideMessage(ValidationMessage message) { + if (message != null) { + validationStatus.removeMessage(message); } } + + public void clear() { + unregisterableRules.forEach(Unregisterable::unregister); + unregisterableRules.clear(); + validationStatus.clearMessages(); + } + } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java index 57c3b90e3..9ece55d7b 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java @@ -15,6 +15,8 @@ ******************************************************************************/ package dev.webfx.stack.ui.validation.mvvmfx; +import javafx.beans.value.ObservableStringValue; + import java.util.Objects; /** @@ -25,26 +27,30 @@ */ public class ValidationMessage { - private final String message; + private final ObservableStringValue messageProperty; private final Severity severity; - public ValidationMessage(Severity severity, String message) { + public ValidationMessage(Severity severity, ObservableStringValue messageProperty) { this.severity = Objects.requireNonNull(severity); - this.message = Objects.requireNonNull(message); + this.messageProperty = Objects.requireNonNull(messageProperty); } - public static ValidationMessage warning(String message) { - return new ValidationMessage(Severity.WARNING, message); + public static ValidationMessage warning(ObservableStringValue messageProperty) { + return new ValidationMessage(Severity.WARNING, messageProperty); } - public static ValidationMessage error(String message) { - return new ValidationMessage(Severity.ERROR, message); + public static ValidationMessage error(ObservableStringValue messageProperty) { + return new ValidationMessage(Severity.ERROR, messageProperty); } + public ObservableStringValue messageProperty() { + return messageProperty; + } + public String getMessage() { - return message; + return messageProperty.get(); } public Severity getSeverity() { @@ -54,27 +60,27 @@ public Severity getSeverity() { @Override public String toString() { return "ValidationMessage{" + - "message='" + message + '\'' + - ", severity=" + severity + - '}'; + "messageProperty='" + messageProperty + '\'' + + ", severity=" + severity + + '}'; } @Override public boolean equals(Object o) { if (this == o) return true; - if (o == null || !(o instanceof ValidationMessage)) + if (!(o instanceof ValidationMessage)) return false; ValidationMessage that = (ValidationMessage) o; - return message.equals(that.message) && severity == that.severity; + return messageProperty.equals(that.messageProperty) && severity == that.severity; } @Override public int hashCode() { - int result = message.hashCode(); + int result = messageProperty.hashCode(); result = 31 * result + severity.hashCode(); return result; } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java index d1f82602e..82d4062fb 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java @@ -37,11 +37,11 @@ */ public class ValidationStatus { - private ListProperty messages = new SimpleListProperty<>(FXCollections.observableArrayList()); + private final ListProperty messages = new SimpleListProperty<>(FXCollections.observableArrayList()); - private ObservableList unmodifiableMessages = FXCollections.unmodifiableObservableList(messages); - private ObservableList errorMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.ERROR)); - private ObservableList warningMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.WARNING)); + private final ObservableList unmodifiableMessages = FXCollections.unmodifiableObservableList(messages); + private final ObservableList errorMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.ERROR)); + private final ObservableList warningMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.WARNING)); /** * Intended for subclasses used by special validator implementations. diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java index a3e093bd9..6ede92357 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java @@ -17,7 +17,7 @@ import dev.webfx.stack.ui.validation.mvvmfx.Severity; import dev.webfx.stack.ui.validation.mvvmfx.ValidationMessage; -import dev.webfx.stack.ui.validation.controlsfx.validation.ValidationSupport; +import dev.webfx.stack.ui.validation.controlsfx.validation.ControlsFxValidationSupport; import dev.webfx.stack.ui.validation.controlsfx.validation.decoration.GraphicValidationDecoration; import dev.webfx.stack.ui.validation.controlsfx.validation.decoration.ValidationDecoration; import javafx.scene.control.Control; @@ -52,7 +52,7 @@ public void setDecoration(ValidationDecoration decoration) { @Override void applyRequiredVisualization(Control control, boolean required) { - ValidationSupport.setRequired(control, required); + ControlsFxValidationSupport.setRequired(control, required); if (required) { decoration.applyRequiredDecoration(control); } @@ -74,12 +74,14 @@ void applyVisualization(Control control, Optional messageOpti } } else { - decoration.removeDecorations(control); - } - - if (required) { - decoration.applyRequiredDecoration(control); + removeDecorations(control); } + + applyRequiredVisualization(control, required); + } + + @Override + public void removeDecorations(Control control) { + decoration.removeDecorations(control); } - } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java index 4b6d33d41..447baca68 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java @@ -15,11 +15,12 @@ ******************************************************************************/ package dev.webfx.stack.ui.validation.mvvmfx.visualization; +import dev.webfx.kit.util.properties.FXProperties; +import dev.webfx.kit.util.properties.ObservableLists; +import dev.webfx.platform.uischeduler.UiScheduler; import dev.webfx.stack.ui.validation.mvvmfx.Severity; import dev.webfx.stack.ui.validation.mvvmfx.ValidationMessage; import dev.webfx.stack.ui.validation.mvvmfx.ValidationStatus; -import javafx.application.Platform; -import javafx.collections.ListChangeListener; import javafx.scene.control.Control; import java.util.Optional; @@ -42,20 +43,13 @@ public abstract class ValidationVisualizerBase implements ValidationVisualizer { @Override public void initVisualization(final ValidationStatus result, final Control control, boolean required) { if (control.getSkin() == null) { - control.skinProperty().addListener((observable, oldValue, newValue) -> initVisualization(result, control, required)); + FXProperties.onPropertySet(control.skinProperty(), skin -> initVisualization(result, control, required)); return; } - if (required) { - applyRequiredVisualization(control, required); - } - - applyVisualization(control, result.getHighestMessage(), required); - - result.getMessages().addListener((ListChangeListener) c -> { - while (c.next()) { - Platform.runLater(() -> applyVisualization(control, result.getHighestMessage(), required)); - } - }); + + ObservableLists.runNowAndOnListChange(c -> UiScheduler.runInUiThread(() -> + applyVisualization(control, result.getHighestMessage(), required) + ), result.getMessages()); } /** @@ -93,5 +87,7 @@ public void initVisualization(final ValidationStatus result, final Control contr * a boolean flag indicating whether this control is mandatory or not. */ abstract void applyVisualization(Control control, Optional messageOptional, boolean required); + + public abstract void removeDecorations(Control control); } diff --git a/webfx-stack-ui-validation/src/main/java/module-info.java b/webfx-stack-ui-validation/src/main/java/module-info.java index 9aca87547..b37e66d92 100644 --- a/webfx-stack-ui-validation/src/main/java/module-info.java +++ b/webfx-stack-ui-validation/src/main/java/module-info.java @@ -6,8 +6,16 @@ requires javafx.base; requires javafx.controls; requires javafx.graphics; + requires webfx.extras.imagestore; + requires webfx.extras.util.background; + requires webfx.extras.util.border; + requires webfx.extras.util.scene; + requires webfx.kit.util; + requires webfx.platform.uischeduler; + requires webfx.platform.util; // Exported packages + exports dev.webfx.stack.ui.validation; exports dev.webfx.stack.ui.validation.controlsfx.control.decoration; exports dev.webfx.stack.ui.validation.controlsfx.impl; exports dev.webfx.stack.ui.validation.controlsfx.impl.skin;
Unregisterable bindChildrenToVisibleActions(P parent, Collection actions, Converter nodeFactory) { ActionGroup actionGroup = new ActionGroupBuilder().setActions(actions).build(); return bindChildrenToActionGroup(parent, actionGroup, nodeFactory); } - public static P bindChildrenToActionGroup(P parent, ActionGroup actionGroup, Converter nodeFactory) { - bindChildrenToActionGroup(parent.getChildren(), actionGroup, nodeFactory); - return parent; + public static Unregisterable bindChildrenToActionGroup(P parent, ActionGroup actionGroup, Converter nodeFactory) { + return bindChildrenToActionGroup(parent.getChildren(), actionGroup, nodeFactory); } - public static ObservableList bindChildrenToActionGroup(ObservableList children, ActionGroup actionGroup, Converter nodeFactory) { - ObservableLists.bindConverted(children, actionGroup.getVisibleActions(), nodeFactory); - return children; + public static Unregisterable bindChildrenToActionGroup(ObservableList children, ActionGroup actionGroup, Converter nodeFactory) { + return ObservableLists.bindConverted(children, actionGroup.getVisibleActions(), nodeFactory); } } diff --git a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionBuilder.java b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionBuilder.java index 9575ff494..904e1eb90 100644 --- a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionBuilder.java +++ b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionBuilder.java @@ -1,17 +1,20 @@ package dev.webfx.stack.ui.action; +import dev.webfx.kit.util.properties.FXProperties; +import dev.webfx.stack.i18n.I18n; +import dev.webfx.stack.ui.json.JsonImageView; import javafx.beans.binding.BooleanExpression; import javafx.beans.property.SimpleBooleanProperty; import javafx.beans.property.SimpleObjectProperty; import javafx.beans.property.SimpleStringProperty; import javafx.beans.value.ObservableBooleanValue; -import javafx.beans.value.ObservableObjectValue; import javafx.beans.value.ObservableStringValue; +import javafx.beans.value.ObservableValue; import javafx.event.ActionEvent; import javafx.event.EventHandler; import javafx.scene.Node; -import dev.webfx.stack.i18n.I18n; -import dev.webfx.stack.ui.json.JsonImageView; + +import java.util.function.Supplier; /** * @author Bruno Salmon @@ -24,8 +27,8 @@ public class ActionBuilder { private String text; private Object i18nKey; - private ObservableObjectValue graphicProperty; - private Node graphic; + private ObservableValue> graphicFactoryProperty; + private Supplier graphicFactory; private Object graphicUrlOrJson; private ObservableBooleanValue disabledProperty; @@ -39,6 +42,8 @@ public class ActionBuilder { private EventHandler actionHandler; + private Object userData; + private ActionBuilderRegistry registry; public ActionBuilder() { @@ -48,6 +53,18 @@ public ActionBuilder(Object actionKey) { this.actionKey = actionKey; } + public ActionBuilder(Action action) { + setTextProperty(action.textProperty()); + setText(action.getText()); + setGraphicFactoryProperty(action.graphicFactoryProperty()); + setGraphicFactory(action.getGraphicFactory()); + setDisabledProperty(action.disabledProperty()); + setVisibleProperty(action.visibleProperty()); + setActionHandler(action); + setUserData(action.getUserData()); + //setHiddenWhenDisabled(visibleProperty == disabledProperty || visibleProperty instanceof BooleanBinding && ((BooleanBinding) visibleProperty).getDependencies().contains(disabledProperty)); + } + public Object getActionKey() { return actionKey; } @@ -84,21 +101,21 @@ public ActionBuilder setI18nKey(Object i18nKey) { return this; } - public ObservableObjectValue getGraphicProperty() { - return graphicProperty; + public ObservableValue> getGraphicFactoryProperty() { + return graphicFactoryProperty; } - public ActionBuilder setGraphicProperty(ObservableObjectValue graphicProperty) { - this.graphicProperty = graphicProperty; + public ActionBuilder setGraphicFactoryProperty(ObservableValue> graphicFactoryProperty) { + this.graphicFactoryProperty = graphicFactoryProperty; return this; } - public Node getGraphic() { - return graphic; + public Supplier getGraphicFactory() { + return graphicFactory; } - public ActionBuilder setGraphic(Node graphic) { - this.graphic = graphic; + public ActionBuilder setGraphicFactory(Supplier graphicFactory) { + this.graphicFactory = graphicFactory; return this; } @@ -169,6 +186,15 @@ public ActionBuilder setActionHandler(Runnable actionHandler) { return setActionHandler(e -> actionHandler.run()); } + public Object getUserData() { + return userData; + } + + public ActionBuilder setUserData(Object userData) { + this.userData = userData; + return this; + } + public ActionBuilder setRegistry(ActionBuilderRegistry registry) { this.registry = registry; return this; @@ -184,8 +210,8 @@ public ActionBuilder duplicate() { .setTextProperty(textProperty) .setText(text) .setI18nKey(i18nKey) - .setGraphicProperty(graphicProperty) - .setGraphic(graphic) + .setGraphicFactoryProperty(graphicFactoryProperty) + .setGraphicFactory(graphicFactory) .setGraphicUrlOrJson(graphicUrlOrJson) .setDisabledProperty(disabledProperty) .setVisibleProperty(visibleProperty) @@ -209,7 +235,9 @@ public ActionBuilder removeText() { public Action build() { completePropertiesForBuild(); - return Action.create(textProperty, graphicProperty, disabledProperty, visibleProperty, actionHandler); + Action action = Action.create(textProperty, graphicFactoryProperty, disabledProperty, visibleProperty, actionHandler); + action.setUserData(userData); + return action; } void completePropertiesForBuild() { @@ -229,13 +257,14 @@ private void completeTextProperty() { } private void completeGraphicProperty() { - if (graphicProperty == null) { - if (graphic == null && graphicUrlOrJson != null) - graphic = JsonImageView.createImageView(graphicUrlOrJson); - if (graphic != null || i18nKey == null) - graphicProperty = new SimpleObjectProperty<>(graphic); + if (graphicFactoryProperty == null) { + if (graphicFactory == null && graphicUrlOrJson != null) + graphicFactory = () -> JsonImageView.createImageView(graphicUrlOrJson); + if (graphicFactory != null || i18nKey == null) + graphicFactoryProperty = new SimpleObjectProperty<>(graphicFactory); else - graphicProperty = I18n.i18nGraphicProperty(i18nKey); + graphicFactoryProperty = FXProperties.compute(I18n.dictionaryProperty(), dictionary -> + () -> I18n.getI18nGraphic(i18nKey)); } } diff --git a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionGroup.java b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionGroup.java index 438acab5a..71838eb4a 100644 --- a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionGroup.java +++ b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionGroup.java @@ -2,14 +2,15 @@ import dev.webfx.stack.ui.action.impl.ActionGroupImpl; import javafx.beans.value.ObservableBooleanValue; -import javafx.beans.value.ObservableObjectValue; import javafx.beans.value.ObservableStringValue; +import javafx.beans.value.ObservableValue; import javafx.collections.ObservableList; import javafx.event.ActionEvent; import javafx.event.EventHandler; import javafx.scene.Node; import java.util.Collection; +import java.util.function.Supplier; /** * @author Bruno Salmon @@ -22,8 +23,8 @@ public interface ActionGroup extends Action { boolean hasSeparators(); - static ActionGroup create(Collection actions, ObservableStringValue textProperty, ObservableObjectValue graphicProperty, ObservableBooleanValue disabledProperty, ObservableBooleanValue visibleProperty, boolean hasSeparators, EventHandler actionHandler) { - return new ActionGroupImpl(actions, textProperty, graphicProperty, disabledProperty, visibleProperty, hasSeparators, actionHandler); + static ActionGroup create(Collection actions, ObservableStringValue textProperty, ObservableValue> graphicFactoryProperty, ObservableBooleanValue disabledProperty, ObservableBooleanValue visibleProperty, boolean hasSeparators, EventHandler actionHandler) { + return new ActionGroupImpl(actions, textProperty, graphicFactoryProperty, disabledProperty, visibleProperty, hasSeparators, actionHandler); } } diff --git a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionGroupBuilder.java b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionGroupBuilder.java index a0185e70a..ea2fd6bfa 100644 --- a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionGroupBuilder.java +++ b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionGroupBuilder.java @@ -1,14 +1,15 @@ package dev.webfx.stack.ui.action; +import dev.webfx.platform.util.collection.Collections; import javafx.beans.value.ObservableBooleanValue; -import javafx.beans.value.ObservableObjectValue; import javafx.beans.value.ObservableStringValue; +import javafx.beans.value.ObservableValue; import javafx.event.ActionEvent; import javafx.event.EventHandler; import javafx.scene.Node; -import dev.webfx.platform.util.collection.Collections; import java.util.Collection; +import java.util.function.Supplier; /** * @author Bruno Salmon @@ -43,7 +44,7 @@ public ActionGroupBuilder setHasSeparators(boolean hasSeparators) { @Override public ActionGroup build() { completePropertiesForBuild(); - return ActionGroup.create(actions, getTextProperty(), getGraphicProperty(), getDisabledProperty(), getVisibleProperty(), hasSeparators, getActionHandler()); + return ActionGroup.create(actions, getTextProperty(), getGraphicFactoryProperty(), getDisabledProperty(), getVisibleProperty(), hasSeparators, getActionHandler()); } // --- Overriding fluent API methods to return ActionGroupBuilder instead of ActionBuilder --- @@ -69,13 +70,13 @@ public ActionGroupBuilder setI18nKey(Object i18nKey) { } @Override - public ActionGroupBuilder setGraphicProperty(ObservableObjectValue graphicProperty) { - return (ActionGroupBuilder) super.setGraphicProperty(graphicProperty); + public ActionGroupBuilder setGraphicFactoryProperty(ObservableValue> graphicFactoryProperty) { + return (ActionGroupBuilder) super.setGraphicFactoryProperty(graphicFactoryProperty); } @Override - public ActionGroupBuilder setGraphic(Node graphic) { - return (ActionGroupBuilder) super.setGraphic(graphic); + public ActionGroupBuilder setGraphicFactory(Supplier graphicFactory) { + return (ActionGroupBuilder) super.setGraphicFactory(graphicFactory); } @Override diff --git a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/ActionGroupImpl.java b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/ActionGroupImpl.java index e331342e5..d37f5620e 100644 --- a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/ActionGroupImpl.java +++ b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/ActionGroupImpl.java @@ -1,22 +1,23 @@ package dev.webfx.stack.ui.action.impl; +import dev.webfx.kit.util.properties.FXProperties; +import dev.webfx.platform.util.collection.Collections; +import dev.webfx.stack.ui.action.Action; +import dev.webfx.stack.ui.action.ActionGroup; import javafx.beans.property.Property; import javafx.beans.value.ObservableBooleanValue; -import javafx.beans.value.ObservableObjectValue; import javafx.beans.value.ObservableStringValue; +import javafx.beans.value.ObservableValue; import javafx.collections.FXCollections; import javafx.collections.ObservableList; import javafx.event.ActionEvent; import javafx.event.EventHandler; import javafx.scene.Node; -import dev.webfx.stack.ui.action.Action; -import dev.webfx.stack.ui.action.ActionGroup; -import dev.webfx.kit.util.properties.FXProperties; -import dev.webfx.platform.util.collection.Collections; import java.util.ArrayList; import java.util.Collection; import java.util.List; +import java.util.function.Supplier; /** * @author Bruno Salmon @@ -27,8 +28,8 @@ public final class ActionGroupImpl extends ReadOnlyAction implements ActionGroup private final ObservableList visibleActions = FXCollections.observableArrayList(); private final boolean hasSeparators; - public ActionGroupImpl(Collection actions, ObservableStringValue textProperty, ObservableObjectValue graphicProperty, ObservableBooleanValue disabledProperty, ObservableBooleanValue visibleProperty, boolean hasSeparators, EventHandler actionHandler) { - super(textProperty, graphicProperty, disabledProperty, visibleProperty, actionHandler); + public ActionGroupImpl(Collection actions, ObservableStringValue textProperty, ObservableValue> graphicFactoryProperty, ObservableBooleanValue disabledProperty, ObservableBooleanValue visibleProperty, boolean hasSeparators, EventHandler actionHandler) { + super(textProperty, graphicFactoryProperty, disabledProperty, visibleProperty, actionHandler); this.actions = actions; this.hasSeparators = hasSeparators; FXProperties.runNowAndOnPropertiesChange(this::updateVisibleActions, Collections.map(actions, Action::visibleProperty)); @@ -40,7 +41,7 @@ private void updateVisibleActions() { for (Action action : this.actions) { if (action.isVisible()) { int n = actions.size(); - if (action.getText() == null && action.getGraphic() == null && action instanceof ActionGroup) { + if (action.getText() == null && action.getGraphicFactory() == null && action instanceof ActionGroup) { ActionGroup actionGroup = (ActionGroup) action; actions.addAll(actionGroup.getVisibleActions()); if (actions.size() > n) { diff --git a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/ReadOnlyAction.java b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/ReadOnlyAction.java index 17d90a782..c0843f2b0 100644 --- a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/ReadOnlyAction.java +++ b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/ReadOnlyAction.java @@ -1,12 +1,14 @@ package dev.webfx.stack.ui.action.impl; +import dev.webfx.stack.ui.action.Action; import javafx.beans.value.ObservableBooleanValue; -import javafx.beans.value.ObservableObjectValue; import javafx.beans.value.ObservableStringValue; +import javafx.beans.value.ObservableValue; import javafx.event.ActionEvent; import javafx.event.EventHandler; import javafx.scene.Node; -import dev.webfx.stack.ui.action.Action; + +import java.util.function.Supplier; /** * A read-only action where properties are observable values. @@ -15,9 +17,9 @@ */ public class ReadOnlyAction implements Action { - public ReadOnlyAction(ObservableStringValue textProperty, ObservableObjectValue graphicProperty, ObservableBooleanValue disabledProperty, ObservableBooleanValue visibleProperty, EventHandler actionHandler) { + public ReadOnlyAction(ObservableStringValue textProperty, ObservableValue> graphicFactoryProperty, ObservableBooleanValue disabledProperty, ObservableBooleanValue visibleProperty, EventHandler actionHandler) { this.textProperty = textProperty; - this.graphicProperty = graphicProperty; + this.graphicFactoryProperty = graphicFactoryProperty; this.disabledProperty = disabledProperty; this.visibleProperty = visibleProperty; this.actionHandler = actionHandler; @@ -29,10 +31,10 @@ public ObservableStringValue textProperty() { return textProperty; } - private final ObservableObjectValue graphicProperty; + private final ObservableValue> graphicFactoryProperty; @Override - public ObservableObjectValue graphicProperty() { - return graphicProperty; + public ObservableValue> graphicFactoryProperty() { + return graphicFactoryProperty; } private final ObservableBooleanValue disabledProperty; diff --git a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/WritableAction.java b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/WritableAction.java index 849ef13ca..8f42b2cee 100644 --- a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/WritableAction.java +++ b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/WritableAction.java @@ -1,14 +1,16 @@ package dev.webfx.stack.ui.action.impl; +import dev.webfx.platform.util.Arrays; +import dev.webfx.stack.ui.action.Action; import javafx.beans.property.*; import javafx.beans.value.ObservableBooleanValue; -import javafx.beans.value.ObservableObjectValue; import javafx.beans.value.ObservableStringValue; +import javafx.beans.value.ObservableValue; import javafx.event.ActionEvent; import javafx.event.EventHandler; import javafx.scene.Node; -import dev.webfx.stack.ui.action.Action; -import dev.webfx.platform.util.Arrays; + +import java.util.function.Supplier; /** * A writable action where properties (text, graphic, disabled, visible) can be set later (ie after constructor call) @@ -19,15 +21,15 @@ public class WritableAction extends ReadOnlyAction { public WritableAction(Action action, String... writablePropertyNames) { - this(createStringProperty(action.textProperty(), "text", writablePropertyNames), createObjectProperty(action.graphicProperty(), "graphic", writablePropertyNames), createBooleanProperty(action.disabledProperty(), "disabled", writablePropertyNames), createBooleanProperty(action.visibleProperty(), "visible", writablePropertyNames), action); + this(createStringProperty(action.textProperty(), "text", writablePropertyNames), createObjectProperty(action.graphicFactoryProperty(), "graphicFactory", writablePropertyNames), createBooleanProperty(action.disabledProperty(), "disabled", writablePropertyNames), createBooleanProperty(action.visibleProperty(), "visible", writablePropertyNames), action); } public WritableAction(EventHandler actionHandler) { this(new SimpleStringProperty(), new SimpleObjectProperty<>(), new SimpleBooleanProperty(true /* disabled until it is bound */), new SimpleBooleanProperty(false /* invisible until it is bound */), actionHandler); } - public WritableAction(ObservableStringValue textProperty, ObservableObjectValue graphicProperty, ObservableBooleanValue disabledProperty, ObservableBooleanValue visibleProperty, EventHandler actionHandler) { - super(textProperty, graphicProperty, disabledProperty, visibleProperty, actionHandler); + public WritableAction(ObservableStringValue textProperty, ObservableValue> graphicFactoryProperty, ObservableBooleanValue disabledProperty, ObservableBooleanValue visibleProperty, EventHandler actionHandler) { + super(textProperty, graphicFactoryProperty, disabledProperty, visibleProperty, actionHandler); } public StringProperty writableTextProperty() { @@ -38,12 +40,12 @@ public void setText(String text) { writableTextProperty().set(text); } - public ObjectProperty writableGraphicProperty() { - return (ObjectProperty) graphicProperty(); + public ObjectProperty> writableGraphicFactoryProperty() { + return (ObjectProperty>) graphicFactoryProperty(); } - public void setGraphic(Node graphic) { - writableGraphicProperty().set(graphic); + public void setGraphicFactory(Supplier graphicFactory) { + writableGraphicFactoryProperty().set(graphicFactory); } public BooleanProperty writableDisabledProperty() { @@ -76,10 +78,10 @@ public void set(String newValue) { return writableProperty; } - private static ObjectProperty createObjectProperty(ObservableObjectValue readOnlyProperty, String propertyName, String... writablePropertyNames) { + private static ObjectProperty createObjectProperty(ObservableValue readOnlyProperty, String propertyName, String... writablePropertyNames) { if (readOnlyProperty instanceof ObjectProperty) return (ObjectProperty) readOnlyProperty; - SimpleObjectProperty writableProperty = new SimpleObjectProperty() { + SimpleObjectProperty writableProperty = new SimpleObjectProperty<>() { @Override public void set(T newValue) { unbindPropertyIfWritable(this, propertyName, writablePropertyNames); diff --git a/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/ControlFactoryMixin.java b/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/ControlFactoryMixin.java index dcdeb5c0e..061e99672 100644 --- a/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/ControlFactoryMixin.java +++ b/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/ControlFactoryMixin.java @@ -110,11 +110,11 @@ default Button styleButton(Button button) { } default CheckBox newCheckBox(Object i18nKey) { - return I18nControls.bindI18nProperties(new CheckBox(), i18nKey); + return I18nControls.newCheckBox(i18nKey); } default RadioButton newRadioButton(Object i18nKey) { - return I18nControls.bindI18nProperties(new RadioButton(), i18nKey); + return I18nControls.newRadioButton(i18nKey); } default RadioButton newRadioButton(Object i18nKey, ToggleGroup toggleGroup) { @@ -124,7 +124,7 @@ default RadioButton newRadioButton(Object i18nKey, ToggleGroup toggleGroup) { } default Label newLabel(Object i18nKey) { - return I18nControls.bindI18nProperties(new Label(), i18nKey); + return I18nControls.newLabel(i18nKey); } default TextField newTextField() { @@ -144,7 +144,7 @@ default Hyperlink newHyperlink() { } default Hyperlink newHyperlink(Object i18nKey) { - return I18nControls.bindI18nProperties(newHyperlink(), i18nKey); + return I18nControls.newHyperlink(i18nKey); } default Hyperlink newHyperlink(Object i18nKey, EventHandler onAction) { @@ -158,7 +158,7 @@ default TextArea newTextArea(Object i18nKey) { } default Text newText(Object i18nKey) { - return I18n.bindI18nProperties(new Text(), i18nKey); + return I18n.newText(i18nKey); } } diff --git a/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/button/ButtonFactory.java b/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/button/ButtonFactory.java index bcd8188e9..b52cd46d5 100644 --- a/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/button/ButtonFactory.java +++ b/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/button/ButtonFactory.java @@ -62,7 +62,7 @@ public static Button decorateButtonWithDropDownArrow(Button button) { downArrow.setFill(null); downArrow.setContent("M1 1.22998L6.325 6.55499L11.65 1.22998"); GraphicDecoration dropDownArrowDecoration = new GraphicDecoration(downArrow, Pos.CENTER_RIGHT, 0, 0, -1, 0); - FXProperties.runNowAndOnPropertiesChange(() -> Platform.runLater(() -> + FXProperties.runNowAndOnPropertyChange(() -> Platform.runLater(() -> Controls.onSkinReady(button, () -> dropDownArrowDecoration.applyDecoration(button)) ), button.graphicProperty()); // Code to clip the content before the down arrow diff --git a/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/dialog/DialogContent.java b/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/dialog/DialogContent.java index 73739f4ee..c0b7e8c82 100644 --- a/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/dialog/DialogContent.java +++ b/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/dialog/DialogContent.java @@ -72,6 +72,12 @@ public DialogContent setYesNo() { return this; } + public DialogContent setOk() { + primaryButtonText = "Ok"; + secondaryButton.setManaged(false); + return this; + } + public Button getPrimaryButton() { return primaryButton; } diff --git a/webfx-stack-ui-json/src/main/java/dev/webfx/stack/ui/json/JsonSVGPath.java b/webfx-stack-ui-json/src/main/java/dev/webfx/stack/ui/json/JsonSVGPath.java index 8d2154fd0..3bd74ee98 100644 --- a/webfx-stack-ui-json/src/main/java/dev/webfx/stack/ui/json/JsonSVGPath.java +++ b/webfx-stack-ui-json/src/main/java/dev/webfx/stack/ui/json/JsonSVGPath.java @@ -7,6 +7,8 @@ import javafx.scene.paint.Paint; import javafx.scene.shape.FillRule; import javafx.scene.shape.SVGPath; +import javafx.scene.shape.StrokeLineCap; +import javafx.scene.shape.StrokeLineJoin; /** * @author Bruno Salmon @@ -21,6 +23,9 @@ public static SVGPath createSVGPath(ReadOnlyAstObject json) { svgPath.setStroke(toPaint(json.getString("stroke"), null)); svgPath.setStrokeWidth(json.getDouble("strokeWidth", 1d)); svgPath.setFillRule(toFillRule(json.getString("fillRule"))); + svgPath.setStrokeLineCap(toStrokeLineCap(json.getString("strokeLineCap"))); + svgPath.setStrokeLineJoin(toStrokeLineJoin(json.getString("strokeLineJoin"))); + svgPath.setStrokeMiterLimit(json.getDouble("strokeMiterLimit", 10d)); return svgPath; } @@ -40,11 +45,36 @@ private static Paint toPaint(String paintText, Paint defaultPaint) { } private static FillRule toFillRule(String ruleText) { - if (ruleText != null) + if (ruleText != null) { switch (ruleText.trim().toLowerCase()) { - case "evenodd" : return FillRule.EVEN_ODD; - case "nonzero" : return FillRule.NON_ZERO; + case "evenodd": + return FillRule.EVEN_ODD; + case "nonzero": + return FillRule.NON_ZERO; } + } return FillRule.NON_ZERO; } + + private static StrokeLineCap toStrokeLineCap(String strokeLineCapText) { + if (strokeLineCapText != null) { + switch (strokeLineCapText.trim().toLowerCase()) { + case "square" : return StrokeLineCap.SQUARE; + case "butt" : return StrokeLineCap.BUTT; + case "round" : return StrokeLineCap.ROUND; + } + } + return StrokeLineCap.SQUARE; + } + + private static StrokeLineJoin toStrokeLineJoin(String StrokeLineJoinText) { + if (StrokeLineJoinText != null) { + switch (StrokeLineJoinText.trim().toLowerCase()) { + case "miter": return StrokeLineJoin.MITER; + case "bevel": return StrokeLineJoin.BEVEL; + case "round": return StrokeLineJoin.ROUND; + } + } + return StrokeLineJoin.MITER; + } } diff --git a/webfx-stack-ui-operation-action/pom.xml b/webfx-stack-ui-operation-action/pom.xml index b65dbafb7..d7388c4a9 100644 --- a/webfx-stack-ui-operation-action/pom.xml +++ b/webfx-stack-ui-operation-action/pom.xml @@ -45,6 +45,14 @@ 0.1.0-SNAPSHOT + + dev.webfx + webfx-platform-javabase-emul-j2cl + 0.1.0-SNAPSHOT + runtime + true + + dev.webfx webfx-platform-javatime-emul-j2cl @@ -53,6 +61,12 @@ true + + dev.webfx + webfx-platform-scheduler + 0.1.0-SNAPSHOT + + dev.webfx webfx-platform-uischeduler @@ -77,6 +91,12 @@ 0.1.0-SNAPSHOT + + dev.webfx + webfx-stack-ui-action-tuner + 0.1.0-SNAPSHOT + + dev.webfx webfx-stack-ui-exceptions diff --git a/webfx-stack-ui-operation-action/src/main/java/dev/webfx/stack/ui/operation/action/OperationAction.java b/webfx-stack-ui-operation-action/src/main/java/dev/webfx/stack/ui/operation/action/OperationAction.java index cb8aaf170..de427612b 100644 --- a/webfx-stack-ui-operation-action/src/main/java/dev/webfx/stack/ui/operation/action/OperationAction.java +++ b/webfx-stack-ui-operation-action/src/main/java/dev/webfx/stack/ui/operation/action/OperationAction.java @@ -58,13 +58,9 @@ private OperationAction(OperationAction[] me, Function me[0] = this; this.operationRequestFactory = operationRequestFactory; OperationActionRegistry registry = getOperationActionRegistry(); - registry.bindOperationActionGraphicalProperties(this); - // Also, if some graphical dependencies are passed, we update the graphical properties when they change - if (graphicalDependencies.length > 0) - FXProperties.runNowAndOnPropertiesChange(() -> { - registry.updateOperationActionGraphicalProperties(this); - registry.bindOperationActionGraphicalProperties(this); - }, graphicalDependencies); + FXProperties.runNowAndOnPropertiesChange(() -> + registry.bindOperationActionGraphicalProperties(this) + , graphicalDependencies); // Also updating the graphical properties when graphical dependencies change } public OperationActionRegistry getOperationActionRegistry() { @@ -86,9 +82,8 @@ private void startShowingActionAsExecuting(Object operationRequest) { // If in addition an icon has been provided to graphically indicate the execution is in progress, if (actionExecutingIconFactory != null) { // we apply it to the graphic property Node executingIcon = actionExecutingIconFactory.apply(operationRequest); - if (executingIcon != null) { - FXProperties.setEvenIfBound(writableGraphicProperty(), executingIcon); - } + if (executingIcon != null) // For some operations such as routing operation, there is no executing icon + FXProperties.setEvenIfBound(writableGraphicFactoryProperty(), () -> executingIcon); } } @@ -100,9 +95,8 @@ private void stopShowingActionAsExecuting(Object operationRequest, Throwable exc // If in addition an icon has been provided to graphically indicate the execution has ended, if (actionExecutedIconFactory != null) { // we apply it to the graphic property for 2s Node executedIcon = actionExecutedIconFactory.apply(operationRequest, exception); - if (executedIcon != null) { - FXProperties.setEvenIfBound(writableGraphicProperty(), executedIcon); - } + if (executedIcon != null) // For some operations such as routing operation, there is no executed icon + FXProperties.setEvenIfBound(writableGraphicFactoryProperty(), () -> executedIcon); UiScheduler.scheduleDelay(2000, () -> { // After 2 seconds, we reestablish the original action icon, unless it's already executing again if (!executing) { // if executing again, we keep the possible executing icon instead diff --git a/webfx-stack-ui-operation-action/src/main/java/dev/webfx/stack/ui/operation/action/OperationActionRegistry.java b/webfx-stack-ui-operation-action/src/main/java/dev/webfx/stack/ui/operation/action/OperationActionRegistry.java index 90e74f406..0691fe3da 100644 --- a/webfx-stack-ui-operation-action/src/main/java/dev/webfx/stack/ui/operation/action/OperationActionRegistry.java +++ b/webfx-stack-ui-operation-action/src/main/java/dev/webfx/stack/ui/operation/action/OperationActionRegistry.java @@ -1,11 +1,17 @@ package dev.webfx.stack.ui.operation.action; +import dev.webfx.kit.util.properties.FXProperties; import dev.webfx.platform.async.AsyncFunction; import dev.webfx.platform.async.Future; +import dev.webfx.platform.console.Console; +import dev.webfx.platform.scheduler.Scheduled; import dev.webfx.platform.uischeduler.UiScheduler; +import dev.webfx.platform.util.collection.Collections; import dev.webfx.stack.authz.client.factory.AuthorizationUtil; import dev.webfx.stack.ui.action.Action; import dev.webfx.stack.ui.action.ActionBinder; +import dev.webfx.stack.ui.action.impl.WritableAction; +import dev.webfx.stack.ui.action.tuner.ActionTuner; import dev.webfx.stack.ui.operation.HasOperationCode; import javafx.beans.property.ObjectProperty; import javafx.beans.property.SimpleObjectProperty; @@ -13,10 +19,8 @@ import javafx.beans.value.ObservableValue; import javafx.event.ActionEvent; -import java.util.ArrayList; -import java.util.Collection; -import java.util.HashMap; -import java.util.Map; +import java.lang.ref.WeakReference; +import java.util.*; import java.util.function.Consumer; import java.util.function.Function; @@ -41,17 +45,32 @@ */ public final class OperationActionRegistry { - private static OperationActionRegistry INSTANCE; + private static final boolean LOG_DEBUG = false; - private final Map graphicalActions = new HashMap<>(); - private Collection notYetBoundOperationActions; - private Map> operationActionProperties; - private Runnable pendingBindRunnable; + private static final OperationActionRegistry INSTANCE = new OperationActionRegistry(); + + // Holding the actions that have been registered by the application code through registerOperationGraphicalAction(). + // These actions usually hold only the graphical properties, they are not executable (the event handler doesn't do + // anything). They are used to bind the graphical properties of the executable operation actions - through + // bindOperationActionGraphicalProperties(). + private final Map registeredGraphicalActions = new HashMap<>(); + + // Holding the executable operation actions instantiated by the application code (probably bound to a UI control + // such as a button) which have been asked to be bound to a registered graphical action, through + // bindOperationActionGraphicalProperties(). + private final Map>> registeredOperationActions = new HashMap<>(); + // Keeping a list of operation actions whose graphical action are not yet registered => the binding is deferred + // until the graphical action is registered. + private final List notYetBoundExecutableOperationActions = new ArrayList<>(); + + // When the application code wants to be notified when an executable operation action has been bound to its graphical + // properties, it can get an observable which will transit from null to the operation action at that time. + private final Map> executableOperationActionNotifyingProperties = new HashMap<>(); + + private Scheduled bindScheduled; private Consumer operationActionGraphicalPropertiesUpdater; public static OperationActionRegistry getInstance() { - if (INSTANCE == null) - INSTANCE = new OperationActionRegistry(); return INSTANCE; } @@ -80,103 +99,120 @@ public Future apply(Object request) { return AuthorizationUtil.authorizedOperationProperty( operationRequestFactory , embedAuthorizationFunction - , operationActionProperty(operationCode) // reactive property (will change when operation action will be registered, causing a new authorization evaluation) + , executableOperationActionNotifyingProperty(operationCode) // reactive property (will change when operation action will be registered, causing a new authorization evaluation) ); } - public OperationActionRegistry registerOperationGraphicalAction(Class operationRequestClass, Action graphicalAction) { - synchronized (graphicalActions) { - graphicalActions.put(operationRequestClass, graphicalAction); - return checkPendingOperationActionGraphicalBindings(); + private void processRegisteredOperationActions(Object operationCodeOrRequestClass, Consumer processor) { + List> operationActions = registeredOperationActions.get(operationCodeOrRequestClass); + if (operationActions != null) { + for (Iterator> it = operationActions.iterator(); it.hasNext(); ) { + OperationAction oa = it.next().get(); + if (oa == null) { + logDebug(operationCodeOrRequestClass + " operation action was garbage-collected"); + it.remove(); + } else { + processor.accept(oa); + } + } } } - public OperationActionRegistry registerOperationGraphicalAction(Object operationCode, Action graphicalAction) { - synchronized (graphicalActions) { - graphicalActions.put(operationCode, graphicalAction); + public OperationActionRegistry registerOperationGraphicalAction(Object operationCodeOrRequestClass, Action graphicalAction) { + synchronized (registeredGraphicalActions) { + logDebug("Registering " + operationCodeOrRequestClass + " graphical action (" + (registeredGraphicalActions.containsKey(operationCodeOrRequestClass) ? "not" : "") + " first time)"); + registeredGraphicalActions.put(operationCodeOrRequestClass, graphicalAction); + processRegisteredOperationActions(operationCodeOrRequestClass, oa -> { + logDebug(operationCodeOrRequestClass + " operation action will be rebound to new graphical action"); + Collections.addIfNotContains(oa, notYetBoundExecutableOperationActions); + }); return checkPendingOperationActionGraphicalBindings(); } } + private OperationActionRegistry registerOperationAction(Object operationCodeOrRequestClass, OperationAction operationAction) { + synchronized (registeredOperationActions) { + boolean[] alreadyRegistered = { false }; + processRegisteredOperationActions(operationCodeOrRequestClass, oa -> { + if (oa == operationAction) + alreadyRegistered[0] = true; + }); + if (!alreadyRegistered[0]) { + List> operationActions = registeredOperationActions.computeIfAbsent(operationCodeOrRequestClass, k -> new ArrayList<>()); + operationActions.add(new WeakReference<>(operationAction)); + logDebug("Registering " + operationCodeOrRequestClass + " operation action -> n°" + operationActions.size()); + } + return this; + } + } + private OperationActionRegistry checkPendingOperationActionGraphicalBindings() { - if (notYetBoundOperationActions != null && pendingBindRunnable == null) { - UiScheduler.scheduleDeferred(pendingBindRunnable = () -> { - Collection operationActionsToBind = notYetBoundOperationActions; - pendingBindRunnable = null; - notYetBoundOperationActions = null; - for (OperationAction operationAction : operationActionsToBind) - bindOperationActionGraphicalProperties(operationAction); + if (!notYetBoundExecutableOperationActions.isEmpty() && (bindScheduled == null || bindScheduled.isFinished())) { + bindScheduled = UiScheduler.scheduleDeferred(() -> { + notYetBoundExecutableOperationActions.forEach(this::bindOperationActionGraphicalProperties); + notYetBoundExecutableOperationActions.clear(); }); } return this; } - void bindOperationActionGraphicalProperties(OperationAction operationAction) { - if (bindOperationActionGraphicalPropertiesNow(operationAction)) + void bindOperationActionGraphicalProperties(OperationAction executableOperationAction) { + if (bindOperationActionGraphicalPropertiesNow(executableOperationAction)) return; - if (notYetBoundOperationActions == null) - notYetBoundOperationActions = new ArrayList<>(); - notYetBoundOperationActions.add(operationAction); + notYetBoundExecutableOperationActions.add(executableOperationAction); } - private boolean bindOperationActionGraphicalPropertiesNow(OperationAction operationAction) { + private boolean bindOperationActionGraphicalPropertiesNow(OperationAction executableOperationAction) { // The binding is possible only if a graphical action has been registered for that operation // Instantiating an operation request just to have the request class or operation code - A operationRequest = newOperationActionRequest(operationAction); + A operationRequest = newOperationActionRequest(executableOperationAction); + + // Registering the operation action (should it be done only once?) + Class operationRequestClass = operationRequest.getClass(); + registerOperationAction(operationRequestClass, executableOperationAction); + Object operationCode = operationRequest instanceof HasOperationCode ? ((HasOperationCode) operationRequest).getOperationCode() : null; + if (operationCode != null) + registerOperationAction(operationCode, executableOperationAction); + // Then getting the graphical action from it Action graphicalAction = getGraphicalActionFromOperationRequest(operationRequest); // If this is not the case, we return false (can't do the binding now) if (graphicalAction == null) return false; - Map> properties = operationActionProperties; - if (properties != null) { - Object code = getOperationCodeFromGraphicalAction(graphicalAction); - if (code != null) { - ObjectProperty operationActionProperty = properties.remove(code); + // if we reach this point, we can do the binding. + updateOperationActionGraphicalProperties(executableOperationAction); + ActionBinder.bindWritableActionToAction(executableOperationAction, graphicalAction); + // We also notify the application code that we now have an executable operation action associated + if (!executableOperationActionNotifyingProperties.isEmpty()) { + if (operationCode != null) { + ObjectProperty operationActionProperty = executableOperationActionNotifyingProperties.remove(operationCode); if (operationActionProperty != null) - operationActionProperty.set(operationAction); - if (properties.isEmpty()) - operationActionProperties = null; + operationActionProperty.set(executableOperationAction); } } - ActionBinder.bindWritableActionToAction(operationAction, graphicalAction); return true; } - public Action getGraphicalActionFromOperationAction(OperationAction operationAction) { - // Instantiating an operation request just to have the request class or operation code - A operationRequest = newOperationActionRequest(operationAction); - // Then getting the graphical action from it - return getGraphicalActionFromOperationRequest(operationRequest); - } - + // Important: the code calling this method should not store the value, but request it again each time it needs it, + // because the graphical action can change (ex: cache value on application start & then refreshed value from database) public Action getGraphicalActionFromOperationRequest(Object operationRequest) { // Trying to get the operation action registered with the operation request class or code. Action graphicalAction = getGraphicalActionFromOperationRequestClass(operationRequest.getClass()); if (graphicalAction == null && operationRequest instanceof HasOperationCode) graphicalAction = getGraphicalActionFromOperationCode(((HasOperationCode) operationRequest).getOperationCode()); + if (graphicalAction != null && operationRequest instanceof ActionTuner) { + graphicalAction = ((ActionTuner) operationRequest).tuneAction(graphicalAction); + } return graphicalAction; } private Action getGraphicalActionFromOperationRequestClass(Class operationRequestClass) { - synchronized (graphicalActions) { - return graphicalActions.get(operationRequestClass); - } + return getGraphicalActionFromOperationCode(operationRequestClass); // because they share the same map } private Action getGraphicalActionFromOperationCode(Object operationCode) { - synchronized (graphicalActions) { - return graphicalActions.get(operationCode); - } - } - - private Object getOperationCodeFromGraphicalAction(Action graphicalAction) { - synchronized (graphicalActions) { - for (Map.Entry entry : graphicalActions.entrySet()) { - if (entry.getValue() == graphicalAction) - return entry.getKey(); - } - return null; + synchronized (registeredGraphicalActions) { + return registeredGraphicalActions.get(operationCode); } } @@ -189,12 +225,15 @@ void updateOperationActionGraphicalProperties(OperationAction opera operationActionGraphicalPropertiesUpdater.accept(operationAction); } - private ObservableValue operationActionProperty(Object operationCode) { - ObjectProperty operationActionProperty = new SimpleObjectProperty<>(); - if (operationActionProperties == null) - operationActionProperties = new HashMap<>(); - operationActionProperties.put(operationCode, operationActionProperty); - return operationActionProperty; + private ObservableValue executableOperationActionNotifyingProperty(Object operationCode) { + ObjectProperty property = executableOperationActionNotifyingProperties.computeIfAbsent(operationCode, k -> new SimpleObjectProperty<>()); + if (property.get() == null) { + processRegisteredOperationActions(operationCode, oa -> { + if (property.get() == null) + property.set(oa); + }); + } + return property; } public A newOperationActionRequest(OperationAction operationAction) { @@ -206,4 +245,26 @@ public A newOperationActionRequest(OperationAction operationAction) return null; } + public Action getOrWaitOperationAction(Object operationCode) { + // Waiting to be notified + ObservableValue operationActionProperty = executableOperationActionNotifyingProperty(operationCode); + // For now, we create a wrapper action that delegates the execution to the operation action (if set) + WritableAction wrapperAction = new WritableAction(e -> { // Invisible & disabled at this stage + OperationAction operationAction = operationActionProperty.getValue(); + if (operationAction != null) { + operationAction.handle(e); + } + }); + FXProperties.onPropertySet(operationActionProperty, operationAction -> + ActionBinder.bindWritableActionToAction(wrapperAction, operationAction) + ); + return wrapperAction; + } + + private static void logDebug(String message) { + if (LOG_DEBUG) { + Console.log("[OperationActionRegistry] - " + message); + } + } + } diff --git a/webfx-stack-ui-operation-action/src/main/java/module-info.java b/webfx-stack-ui-operation-action/src/main/java/module-info.java index d434dda29..d94c95d13 100644 --- a/webfx-stack-ui-operation-action/src/main/java/module-info.java +++ b/webfx-stack-ui-operation-action/src/main/java/module-info.java @@ -8,10 +8,12 @@ requires webfx.kit.util; requires webfx.platform.async; requires webfx.platform.console; + requires webfx.platform.scheduler; requires webfx.platform.uischeduler; requires webfx.platform.util; requires webfx.stack.authz.client; requires transitive webfx.stack.ui.action; + requires webfx.stack.ui.action.tuner; requires webfx.stack.ui.exceptions; requires webfx.stack.ui.operation; diff --git a/webfx-stack-ui-operation/pom.xml b/webfx-stack-ui-operation/pom.xml index 4d52619b7..719d5fd24 100644 --- a/webfx-stack-ui-operation/pom.xml +++ b/webfx-stack-ui-operation/pom.xml @@ -27,6 +27,12 @@ provided + + dev.webfx + webfx-extras-util-control + 0.1.0-SNAPSHOT + + dev.webfx webfx-kit-util diff --git a/webfx-stack-ui-operation/src/main/java/dev/webfx/stack/ui/operation/OperationUtil.java b/webfx-stack-ui-operation/src/main/java/dev/webfx/stack/ui/operation/OperationUtil.java index 0deb82f94..d2beb5692 100644 --- a/webfx-stack-ui-operation/src/main/java/dev/webfx/stack/ui/operation/OperationUtil.java +++ b/webfx-stack-ui-operation/src/main/java/dev/webfx/stack/ui/operation/OperationUtil.java @@ -1,12 +1,12 @@ package dev.webfx.stack.ui.operation; +import dev.webfx.extras.util.control.ControlUtil; import dev.webfx.kit.util.properties.FXProperties; import dev.webfx.platform.async.AsyncFunction; import dev.webfx.platform.async.Future; import dev.webfx.platform.uischeduler.UiScheduler; import javafx.scene.Node; import javafx.scene.control.Labeled; -import javafx.scene.control.ProgressIndicator; /** * @author Bruno Salmon @@ -48,9 +48,7 @@ private static void setWaitMode(boolean on, Labeled... buttons) { Node graphic = null; if (button == buttons[0]) { if (on) { - ProgressIndicator progressIndicator = new ProgressIndicator(); - progressIndicator.setPrefSize(20, 20); // Note setMaxSize() doesn't work with WebFX but setPrefSize() does - graphic = progressIndicator; + graphic = ControlUtil.createProgressIndicator(20); // Memorising the previous graphic before changing it button.getProperties().put("webfx-operation-util-graphic", button.getGraphic()); } else { diff --git a/webfx-stack-ui-operation/src/main/java/module-info.java b/webfx-stack-ui-operation/src/main/java/module-info.java index ce97e7869..367c34a3b 100644 --- a/webfx-stack-ui-operation/src/main/java/module-info.java +++ b/webfx-stack-ui-operation/src/main/java/module-info.java @@ -5,6 +5,7 @@ // Direct dependencies modules requires javafx.controls; requires javafx.graphics; + requires webfx.extras.util.control; requires webfx.kit.util; requires webfx.platform.async; requires webfx.platform.uischeduler; diff --git a/webfx-stack-ui-validation/pom.xml b/webfx-stack-ui-validation/pom.xml index 9d625dd07..1014ed9ea 100644 --- a/webfx-stack-ui-validation/pom.xml +++ b/webfx-stack-ui-validation/pom.xml @@ -33,6 +33,44 @@ provided + + dev.webfx + webfx-extras-imagestore + 0.1.0-SNAPSHOT + + + + dev.webfx + webfx-extras-util-background + 0.1.0-SNAPSHOT + + + + dev.webfx + webfx-extras-util-border + 0.1.0-SNAPSHOT + + + + dev.webfx + webfx-extras-util-scene + 0.1.0-SNAPSHOT + + + + dev.webfx + webfx-kit-util + 0.1.0-SNAPSHOT + + + + dev.webfx + webfx-platform-javabase-emul-j2cl + 0.1.0-SNAPSHOT + runtime + true + + dev.webfx webfx-platform-javatime-emul-j2cl @@ -41,6 +79,18 @@ true + + dev.webfx + webfx-platform-uischeduler + 0.1.0-SNAPSHOT + + + + dev.webfx + webfx-platform-util + 0.1.0-SNAPSHOT + + \ No newline at end of file diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/ValidationIcons.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/ValidationIcons.java new file mode 100644 index 000000000..5ef3b7991 --- /dev/null +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/ValidationIcons.java @@ -0,0 +1,11 @@ +package dev.webfx.stack.ui.validation; + +/** + * @author Bruno Salmon + */ +final class ValidationIcons { + + public final static String validationErrorIcon16Url = "dev/webfx/stack/ui/validation/controlsfx/images/decoration-error.png"; + public final static String validationRequiredIcon16Url = "dev/webfx/stack/ui/validation/controlsfx/images/required-indicator.png"; + +} diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/ValidationSupport.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/ValidationSupport.java new file mode 100644 index 000000000..bb2f74b8b --- /dev/null +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/ValidationSupport.java @@ -0,0 +1,558 @@ +package dev.webfx.stack.ui.validation; + +import dev.webfx.extras.imagestore.ImageStore; +import dev.webfx.extras.util.background.BackgroundFactory; +import dev.webfx.extras.util.border.BorderFactory; +import dev.webfx.extras.util.scene.SceneUtil; +import dev.webfx.kit.util.properties.FXProperties; +import dev.webfx.platform.uischeduler.UiScheduler; +import dev.webfx.platform.util.collection.Collections; +import dev.webfx.stack.ui.validation.controlsfx.control.decoration.Decoration; +import dev.webfx.stack.ui.validation.controlsfx.control.decoration.GraphicDecoration; +import dev.webfx.stack.ui.validation.controlsfx.validation.decoration.GraphicValidationDecoration; +import dev.webfx.stack.ui.validation.mvvmfx.ObservableRuleBasedValidator; +import dev.webfx.stack.ui.validation.mvvmfx.ValidationMessage; +import dev.webfx.stack.ui.validation.mvvmfx.Validator; +import dev.webfx.stack.ui.validation.mvvmfx.visualization.ControlsFxVisualizer; +import javafx.application.Platform; +import javafx.beans.binding.Bindings; +import javafx.beans.property.*; +import javafx.beans.value.ObservableBooleanValue; +import javafx.beans.value.ObservableStringValue; +import javafx.beans.value.ObservableValue; +import javafx.geometry.Insets; +import javafx.geometry.Pos; +import javafx.scene.Group; +import javafx.scene.Node; +import javafx.scene.Parent; +import javafx.scene.Scene; +import javafx.scene.control.*; +import javafx.scene.layout.HBox; +import javafx.scene.layout.Pane; +import javafx.scene.layout.VBox; +import javafx.scene.paint.Color; +import javafx.scene.shape.Rectangle; +import javafx.scene.text.Font; +import javafx.scene.transform.Rotate; + +import java.time.LocalDate; +import java.time.format.DateTimeFormatter; +import java.time.format.DateTimeParseException; +import java.util.ArrayList; +import java.util.Collection; +import java.util.List; +import java.util.regex.Pattern; + +/** + * @author Bruno Salmon + */ +public final class ValidationSupport { + + private static final ObservableStringValue DEFAULT_REQUIRED_MESSAGE = new SimpleStringProperty("This field is required"); + + private final List validators = new ArrayList<>(); + private final List validatorErrorDecorationNodes = new ArrayList<>(); + private final BooleanProperty validatingProperty = new SimpleBooleanProperty(); + private Node popOverContentNode; + private Node popOverOwnerNode; + + public boolean isValid() { + validatingProperty.setValue(false); + validatingProperty.setValue(true); + Validator firstInvalidValidator = firstInvalidValidator(); + if (firstInvalidValidator != null) + Platform.runLater(() -> { + popUpOverAutoScroll = true; + showValidatorErrorPopOver(firstInvalidValidator); + }); + return firstInvalidValidator == null; + } + + public void reset() { + // This will hide the possible validation error popup and other warning icons + validatingProperty.setValue(false); + } + + public void clear() { + reset(); // hiding possible validation messages + validatorErrorDecorationNodes.forEach(this::uninstallNodeDecorator); + validatorErrorDecorationNodes.clear(); + validators.forEach(validator -> { + if (validator instanceof ObservableRuleBasedValidator) { + ((ObservableRuleBasedValidator) validator).clear(); + } + }); + validators.clear(); + } + + public boolean isEmpty() { + return validators.isEmpty(); + } + + private Validator firstInvalidValidator() { + return Collections.findFirst(validators, validator -> !validator.getValidationStatus().isValid()); + } + + public void addRequiredInputs(TextInputControl... textInputControls) { + for (TextInputControl textInputControl : textInputControls) + addRequiredInput(textInputControl); + } + + public void addRequiredInput(TextInputControl textInputControl) { + addRequiredInput(textInputControl, DEFAULT_REQUIRED_MESSAGE); + } + + public void addRequiredInput(TextInputControl textInputControl, ObservableStringValue errorMessage) { + addRequiredInput(textInputControl.textProperty(), textInputControl, errorMessage); + } + + public void addRequiredInput(ObservableValue valueProperty, Node inputNode) { + addRequiredInput(valueProperty, inputNode, DEFAULT_REQUIRED_MESSAGE); + } + + public void addRequiredInput(ObservableValue valueProperty, Node inputNode, ObservableStringValue errorMessage) { + addValidationRule(Bindings.createBooleanBinding(() -> testNotEmpty(valueProperty.getValue()), valueProperty), inputNode, errorMessage, true); + } + + private static boolean testNotEmpty(Object value) { + return value != null && (!(value instanceof String) || !((String) value).trim().isEmpty()); + } + + public ObservableBooleanValue addValidationRule(ObservableValue validProperty, Node node, ObservableStringValue errorMessage) { + return addValidationRule(validProperty, node, errorMessage, false); + } + + public ObservableBooleanValue addValidationRule(ObservableValue validProperty, Node node, ObservableStringValue errorMessageProperty, boolean required) { + ObservableRuleBasedValidator validator = new ObservableRuleBasedValidator(); + ObservableBooleanValue finalValidProperty = // when true, no decorations are displayed on the node + Bindings.createBooleanBinding(() -> + !validatingProperty.get() // no decoration displayed if not validation + || validProperty.getValue() // no decoration displayed if the node is valid + || !isShowing(node) // no decoration displayed if the node is not showing + , validProperty, validatingProperty); + ValidationMessage errorValidationMessage = ValidationMessage.error(errorMessageProperty); + validator.addRule(finalValidProperty, errorValidationMessage); + validators.add(validator); + validatorErrorDecorationNodes.add(node); + installNodeDecorator(node, validator, required); + // The following code is to remove the error message after being displayed and the user is re-typing + if (node instanceof TextInputControl) { + FXProperties.runOnPropertiesChange( + () -> { + validator.validateBooleanRule(true, errorValidationMessage); + uninstallNodeDecorator(node); + } + , ((TextInputControl) node).textProperty()); // ex of dependencies: textField.textProperty() + } + return finalValidProperty; + } + + private void installNodeDecorator(Node node, ObservableRuleBasedValidator validator, boolean required) { + if (node instanceof Control) { + Control control = (Control) node; + ControlsFxVisualizer validationVisualizer = new ControlsFxVisualizer(); + validationVisualizer.setDecoration(new GraphicValidationDecoration() { + @Override + protected Node createErrorNode() { + return ImageStore.createImageView(ValidationIcons.validationErrorIcon16Url); + } + + @Override + protected Collection createValidationDecorations(dev.webfx.stack.ui.validation.controlsfx.validation.ValidationMessage message) { + boolean isTextInput = node instanceof TextInputControl; + boolean isButton = node instanceof Button; + // isInside flag will determine if we position the decoration inside the node or not (ie outside) + boolean isInside; + if (isTextInput) // inside for text inputs + isInside = true; + else { // for others, will be generally outside unless it is stretched to full width by its container + Parent parent = node.getParent(); + while (parent instanceof Pane && !(parent instanceof VBox) && !(parent instanceof HBox)) + parent = parent.getParent(); + isInside = parent instanceof VBox && ((VBox) parent).isFillWidth(); + } + double xRelativeOffset = isInside ? -1 : 1; // positioning the decoration inside the control for button and text input + double xOffset = isInside && isButton ? -20 : 0; // moving the decoration before the drop down arrow + return java.util.Collections.singletonList( + new GraphicDecoration(createDecorationNode(message), + Pos.CENTER_RIGHT, + xOffset, + 0, + xRelativeOffset, + 0) + ); + } + + @Override + protected Collection createRequiredDecorations(Control target) { + return java.util.Collections.singletonList( + new GraphicDecoration(ImageStore.createImageView(ValidationIcons.validationRequiredIcon16Url), + Pos.CENTER_LEFT, + -10, + 0)); + } + }); + validationVisualizer.initVisualization(validator.getValidationStatus(), control, required); + node.getProperties().put("validationVisualizer", validationVisualizer); + } + } + + private void uninstallNodeDecorator(Node node) { + if (node instanceof Control) { + Control control = (Control) node; + ControlsFxVisualizer validationVisualizer = (ControlsFxVisualizer) node.getProperties().get("validationVisualizer"); + if (validationVisualizer != null) + validationVisualizer.removeDecorations(control); + } + } + + private void showValidatorErrorPopOver(Validator validator) { + int index = validators.indexOf(validator); + if (index >= 0) { + Node decorationNode = validatorErrorDecorationNodes.get(index); + if (decorationNode != null) + showValidatorErrorPopOver(validator, decorationNode); + } + } + + private void showValidatorErrorPopOver(Validator validator, Node errorDecorationNode) { + ValidationMessage errorMessage = Collections.first(validator.getValidationStatus().getErrorMessages()); + if (errorMessage != null) { + Label label = new Label(); + label.textProperty().bind(errorMessage.messageProperty()); + label.setPadding(new Insets(8)); + label.setFont(Font.font("Verdana", 11.5)); + label.setTextFill(Color.WHITE); + label.setBackground(BackgroundFactory.newBackground(Color.RED, 5, 2)); + label.setBorder(BorderFactory.newBorder(Color.WHITE, 5, 2)); + Rectangle diamond = new Rectangle(10, 10, Color.RED); + diamond.getTransforms().add(new Rotate(45, 5, 5)); + diamond.layoutYProperty().bind(FXProperties.compute(label.heightProperty(), n -> n.doubleValue() - 7)); + diamond.setLayoutX(20d); + popOverContentNode = new Group(label, diamond); + //popOverContentNode.setOpacity(0.75); + //popOverContentNode.setEffect(new DropShadow()); + showPopOver(errorDecorationNode); + // Removing the error pop over when the status is valid again + FXProperties.runOrUnregisterOnPropertyChange((thisListener, oldValue, valid) -> { + if (valid) { + thisListener.unregister(); + popOverOwnerNode = null; + hidePopOver(); + } + }, validator.getValidationStatus().validProperty()); + } + } + + private void showPopOver(Node node) { + popOverOwnerNode = node; + showPopOverNow(); + if (!node.getProperties().containsKey("popOverListen")) { + node.getProperties().put("popOverListen", true); + node.sceneProperty().addListener(observable -> { + if (popOverOwnerNode == node) { + showPopOverNow(); + } + }); + node.parentProperty().addListener(observable -> { + if (popOverOwnerNode == node) { + showPopOverNow(); + } + }); + } + } + + public void addEmailValidation(TextField emailInput, Node where, ObservableStringValue errorMessage) { + // Define the email pattern + String emailPattern = "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,6}$"; + Pattern pattern = Pattern.compile(emailPattern); + // Create the validation rule + addValidationRule( + Bindings.createBooleanBinding( + () -> pattern.matcher(emailInput.getText()).matches(), + emailInput.textProperty() + ), + where, + errorMessage + ); + } + + public void addEmailNotEqualValidation(TextField emailInput, String forbiddenValue, Node where, ObservableStringValue errorMessage) { + // Create the validation rule + addValidationRule( + Bindings.createBooleanBinding( + () -> !emailInput.getText().equalsIgnoreCase(forbiddenValue), + emailInput.textProperty() + ), + where, + errorMessage + ); + } + + public void addUrlValidation(TextField urlInput, Node where, ObservableStringValue errorMessage) { + // Define the URL pattern (basic) + String urlPattern = "^(https?://)(www\\.)?[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,6}(/.*)?$"; + Pattern pattern = Pattern.compile(urlPattern); + + addValidationRule( + Bindings.createBooleanBinding( + () -> { + String input = urlInput.getText(); + return input!=null && pattern.matcher(input).matches(); // Accept empty or valid URL + }, + urlInput.textProperty() + ), + where, + errorMessage + ); + } + + public void addMinimumDurationValidation(TextField timeInput, Node where, ObservableStringValue errorMessage) { + addValidationRule( + Bindings.createBooleanBinding( + () -> { + try { + String input = timeInput.getText(); + if (input == null || input.isEmpty()) return true; // Allow empty input + int value = Integer.parseInt(input); // Try to parse the input to an integer + return value >= 60; // Validate if the integer is at least 60 + } catch (NumberFormatException e) { + return false; // Invalid if input is not a valid integer + } + }, + timeInput.textProperty() + ), + where, + errorMessage + ); + } + + + public void addUrlOrEmptyValidation(TextField urlInput, ObservableStringValue errorMessage) { + // Define the URL pattern (basic) + String urlPattern = "^(https?|srt|rtmp|rtsp)://[\\w.-]+(:\\d+)?(/[\\w./-]*)?(\\?[\\w=&%.-]*)?(#[\\w!:.=&,-]*)?$"; + Pattern pattern = Pattern.compile(urlPattern); + + // Create the validation rule + addValidationRule( + Bindings.createBooleanBinding( + () -> { + String input = urlInput.getText(); + return input.isEmpty() || pattern.matcher(input).matches(); // Accept empty or valid URL + }, + urlInput.textProperty() + ), + urlInput, + errorMessage + ); + } + + public void addNonEmptyValidation(TextField textField, Node where, ObservableStringValue errorMessage) { + // Create the validation rule + addValidationRule( + Bindings.createBooleanBinding( + () -> !textField.getText().trim().isEmpty(), + textField.textProperty() + ), + where, + errorMessage); + } + + public void addDateValidation(TextField textField,String dateFormat, Node where, ObservableStringValue errorMessage) { + DateTimeFormatter dateFormatter = DateTimeFormatter.ofPattern(dateFormat); + // Create the validation rule + addValidationRule( + Bindings.createBooleanBinding(() -> { + try { + dateFormatter.parse(textField.getText().trim()); + return true; + } catch (DateTimeParseException e) { + return false; + }}, textField.textProperty()), + where, + errorMessage + ); + } + + public void addDateOrEmptyValidation(TextField textField, String dateFormat, Node where, ObservableStringValue errorMessage) { + DateTimeFormatter dateFormatter = DateTimeFormatter.ofPattern(dateFormat); + + // Create the validation rule + addValidationRule( + Bindings.createBooleanBinding(() -> { + String input = textField.getText().trim(); + // Allow empty input to be valid + if (input.isEmpty()) { + return true; + } + try { + dateFormatter.parse(input); + return true; // Input is valid if it can be parsed + } catch (DateTimeParseException e) { + return false; // Invalid date format + } + }, textField.textProperty()), + where, + errorMessage + ); + } + + public void addIntegerValidation(TextField textField, Node where, ObservableStringValue errorMessage) { + // Create the validation rule + addValidationRule( + Bindings.createBooleanBinding(() -> { + try { + // Try to parse the text as an integer + Integer.parseInt(textField.getText().trim()); + return true; + } catch (NumberFormatException e) { + return false; + } + }, textField.textProperty()), + where, + errorMessage + ); + } + + public void addLegalAgeValidation(TextField textField, String dateFormat, int legalAge, Node where, ObservableStringValue errorMessage) { + DateTimeFormatter dateFormatter = DateTimeFormatter.ofPattern(dateFormat); + // Create the validation rule + addValidationRule( + Bindings.createBooleanBinding(() -> { + try { + LocalDate birthDate = LocalDate.parse(textField.getText().trim(), dateFormatter); + LocalDate now = LocalDate.now(); + return birthDate.plusYears(legalAge).isBefore(now) || birthDate.plusYears(legalAge).isEqual(now); + } catch (DateTimeParseException e) { + return false; + } + }, textField.textProperty()), + where, + errorMessage + ); + } + + public void addPasswordMatchValidation(TextField passwordField, TextField repeatPasswordField, ObservableStringValue errorMessageProperty) { + addValidationRule( + Bindings.createBooleanBinding( + () -> passwordField.getText().equals(repeatPasswordField.getText()), + passwordField.textProperty(), + repeatPasswordField.textProperty() + ), + repeatPasswordField, + errorMessageProperty, + true + ); + } + + public void addPasswordStrengthValidation(TextField passwordField, ObservableStringValue errorMessage) { + addValidationRule( + Bindings.createBooleanBinding( + () -> checkPasswordStrength(passwordField.getText()), + passwordField.textProperty() + ), + passwordField, + errorMessage, + true + ); + } + /** + * Checks if a password meets strength requirements. + * @param password the password to validate. + * @return true if the password meets the requirements, false otherwise. + */ + private boolean checkPasswordStrength(String password) { + if (password == null || password.isEmpty()) { + return false; + } + // Minimum length + if (password.length() < 8) { + return false; + } + // Contains at least one uppercase letter + if (!password.matches(".*[A-Z].*")) { + return false; + } + // Contains at least one lowercase letter + if (!password.matches(".*[a-z].*")) { + return false; + } + // Contains at least one digit + if (!password.matches(".*\\d.*")) { + return false; + } + // Contains at least one special character + if (!password.matches(".*[@#$%^&+=!().,*?-].*")) { + return false; + } + return true; + } + +/* + private PopOver popOver; + private void showPopOverNow() { + if (popOver != null && popOver.getOwnerNode() != popOverOwnerNode) { + popOver.hide(); + popOver = null; + } + if (popOver == null && isShowing(popOverOwnerNode)) { + popOver = new PopOver(); + popOver.setContentNode(popOverContentNode); + popOver.setArrowLocation(PopOver.ArrowLocation.BOTTOM_LEFT); + //Platform.runLater(() -> { + popOver.show(popOverOwnerNode, -(popOverOwnerNode instanceof ImageView ? ((ImageView) popOverOwnerNode).getImage().getHeight() : 0) + 4); + //}); + } + } +*/ + + private GraphicDecoration popOverDecoration; + private Node popOverDecorationTarget; + private boolean popUpOverAutoScroll; + + private void showPopOverNow() { + Platform.runLater(() -> { + hidePopOver(); + if (isShowing(popOverOwnerNode)) { + popOverDecorationTarget = popOverOwnerNode; + popOverDecoration = new GraphicDecoration(popOverContentNode, 0, -1, 0, -1); + popOverDecoration.applyDecoration(popOverDecorationTarget); + if (popUpOverAutoScroll) { + SceneUtil.scrollNodeToBeVerticallyVisibleOnScene(popOverDecorationTarget); + SceneUtil.autoFocusIfEnabled(popOverOwnerNode); + popUpOverAutoScroll = false; + } + } + }); + } + + private void hidePopOver() { + UiScheduler.runInUiThread(() -> { + if (popOverDecoration != null) { + popOverDecoration.removeDecoration(popOverDecorationTarget); + popOverDecoration = null; + } + }); + } + + private static boolean isShowing(Node node) { + if (node == null || !node.isVisible()) + return false; + Parent parent = node.getParent(); + if (parent != null) + return isShowing(parent); + Scene scene = node.getScene(); + return scene != null && scene.getRoot() == node; + } + + public void addPasswordValidation(TextField passwordInput, Label passwordLabel, ObservableStringValue errorMessage) { + addValidationRule( + Bindings.createBooleanBinding( + () -> passwordInput.getText().length() >= 8, + passwordInput.textProperty() + ), + passwordLabel, + errorMessage + ); + } +} diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ValidationSupport.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ControlsFxValidationSupport.java similarity index 99% rename from webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ValidationSupport.java rename to webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ControlsFxValidationSupport.java index e6c9d2396..ac68b6876 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ValidationSupport.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ControlsFxValidationSupport.java @@ -76,7 +76,7 @@ * * */ -public class ValidationSupport { +public class ControlsFxValidationSupport { private static final String CTRL_REQUIRED_FLAG = "$org.controlsfx.validation.required$"; //$NON-NLS-1$ @@ -111,7 +111,7 @@ public static boolean isRequired( Control c ) { * Creates validation support instance. * If initial decoration is desired invoke {@link #initInitialDecoration()}. */ - public ValidationSupport() { + public ControlsFxValidationSupport() { validationResultProperty().addListener( (o, oldValue, validationResult) -> { invalidProperty.set(!validationResult.getErrors().isEmpty()); diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ValidationMessage.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ValidationMessage.java index 45b699d6f..3ad4a0edb 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ValidationMessage.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ValidationMessage.java @@ -35,28 +35,24 @@ */ public interface ValidationMessage extends Comparable{ - public static final Comparator COMPARATOR = new Comparator() { - - @Override - public int compare(ValidationMessage vm1, ValidationMessage vm2) { - if ( vm1 == vm2 ) return 0; - if ( vm1 == null) return 1; - if ( vm2 == null) return -1; - return vm1.compareTo(vm2); - } - }; + Comparator COMPARATOR = (vm1, vm2) -> { + if ( vm1 == vm2 ) return 0; + if ( vm1 == null) return 1; + if ( vm2 == null) return -1; + return vm1.compareTo(vm2); + }; /** * Message text * @return message text */ - public String getText(); + String getText(); /** * Message {@link Severity} * @return message severity */ - public Severity getSeverity(); + Severity getSeverity(); /** @@ -71,7 +67,7 @@ public int compare(ValidationMessage vm1, ValidationMessage vm2) { * @param text message text * @return error message */ - public static ValidationMessage error(Control target, String text) { + static ValidationMessage error(Control target, String text) { return new SimpleValidationMessage(target, text, Severity.ERROR); } @@ -81,11 +77,11 @@ public static ValidationMessage error(Control target, String text) { * @param text message text * @return warning message */ - public static ValidationMessage warning(Control target, String text) { + static ValidationMessage warning(Control target, String text) { return new SimpleValidationMessage(target, text, Severity.WARNING); } - @Override default public int compareTo(ValidationMessage msg) { + @Override default int compareTo(ValidationMessage msg) { return msg == null || getTarget() != msg.getTarget() ? -1: getSeverity().compareTo(msg.getSeverity()); } } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/decoration/AbstractValidationDecoration.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/decoration/AbstractValidationDecoration.java index a2011dd5d..8a9685232 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/decoration/AbstractValidationDecoration.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/decoration/AbstractValidationDecoration.java @@ -1,18 +1,18 @@ /** * Copyright (c) 2014, 2015, ControlsFX * All rights reserved. - * + * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: - * * Redistributions of source code must retain the above copyright + * * Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. - * * Redistributions in binary form must reproduce the above copyright + * * Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. - * * Neither the name of ControlsFX, any associated website, nor the + * * Neither the name of ControlsFX, any associated website, nor the * names of its contributors may be used to endorse or promote products * derived from this software without specific prior written permission. - * + * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE @@ -30,7 +30,7 @@ import dev.webfx.stack.ui.validation.controlsfx.control.decoration.Decorator; import dev.webfx.stack.ui.validation.controlsfx.validation.ValidationMessage; import javafx.scene.control.Control; -import dev.webfx.stack.ui.validation.controlsfx.validation.ValidationSupport; +import dev.webfx.stack.ui.validation.controlsfx.validation.ControlsFxValidationSupport; import java.util.Collection; import java.util.List; @@ -42,67 +42,69 @@ * how 'validation' and 'required' decorations should be created * * See {@link GraphicValidationDecoration} for examples of such implementations. - * + * */ public abstract class AbstractValidationDecoration implements ValidationDecoration { - - private static final String VALIDATION_DECORATION = "$org.controlsfx.decoration.vaidation$"; //$NON-NLS-1$ - - private static boolean isValidationDecoration( Decoration decoration) { + + private static final String VALIDATION_DECORATION = "$org.controlsfx.decoration.validation$"; //$NON-NLS-1$ + + private static boolean isValidationDecoration(Decoration decoration) { return decoration != null && decoration.getProperties().get(VALIDATION_DECORATION) == Boolean.TRUE; } - private static void setValidationDecoration( Decoration decoration ) { - if ( decoration != null ) { + private static void setValidationDecoration(Decoration decoration) { + if (decoration != null) { decoration.getProperties().put(VALIDATION_DECORATION, Boolean.TRUE); } } - protected abstract Collection createValidationDecorations(ValidationMessage message); - protected abstract Collection createRequiredDecorations(Control target); - - /** - * Removes all validation related decorations from the target - * @param target control - */ - @Override - public void removeDecorations(Control target) { - List decorations = Decorator.getDecorations(target); - if ( decorations != null ) { - // conversion to array is a trick to prevent concurrent modification exception - for ( Decoration d: Decorator.getDecorations(target).toArray(new Decoration[0]) ) { - if (isValidationDecoration(d)) Decorator.removeDecoration(target, d); + protected abstract Collection createValidationDecorations(ValidationMessage message); + + protected abstract Collection createRequiredDecorations(Control target); + + /** + * Removes all validation related decorations from the target + * @param target control + */ + @Override + public void removeDecorations(Control target) { + List decorations = Decorator.getDecorations(target); + if (decorations != null) { + // conversion to array is a trick to prevent concurrent modification exception + for (Decoration d : Decorator.getDecorations(target).toArray(new Decoration[0])) { + if (isValidationDecoration(d)) + Decorator.removeDecoration(target, d); } } - } - - /* - * (non-Javadoc) - * @see org.controlsfx.validation.decorator.ValidationDecorator#applyValidationDecoration(org.controlsfx.validation.ValidationMessage) - */ - @Override - public void applyValidationDecoration(ValidationMessage message) { - //createValidationDecorations(message).stream().forEach( d -> decorate( message.getTarget(), d )); // stream don't work on Android - for (Decoration decoration : createValidationDecorations(message)) - decorate(message.getTarget(), decoration); - } + } + + /* + * (non-Javadoc) + * @see org.controlsfx.validation.decorator.ValidationDecorator#applyValidationDecoration(org.controlsfx.validation.ValidationMessage) + */ + @Override + public void applyValidationDecoration(ValidationMessage message) { + //createValidationDecorations(message).stream().forEach( d -> decorate( message.getTarget(), d )); // stream don't work on Android + for (Decoration decoration : createValidationDecorations(message)) + decorate(message.getTarget(), decoration); + } - /* - * (non-Javadoc) - * @see org.controlsfx.validation.decorator.ValidationDecorator#applyRequiredDecoration(javafx.scene.control.Control) - */ - @Override - public void applyRequiredDecoration(Control target) { - if ( ValidationSupport.isRequired(target)) { - // createRequiredDecorations(target).stream().forEach( d -> decorate( target, d )); // stream don't work on Android - for (Decoration decoration : createRequiredDecorations(target)) - decorate(target, decoration); - } - } - - private void decorate( Control target, Decoration d ) { - setValidationDecoration(d); // mark as validation specific decoration + /* + * (non-Javadoc) + * @see org.controlsfx.validation.decorator.ValidationDecorator#applyRequiredDecoration(javafx.scene.control.Control) + */ + @Override + public void applyRequiredDecoration(Control target) { + if (ControlsFxValidationSupport.isRequired(target)) { + // createRequiredDecorations(target).stream().forEach( d -> decorate( target, d )); // stream don't work on Android + for (Decoration decoration : createRequiredDecorations(target)) + decorate(target, decoration); + } + } + + private void decorate(Control target, Decoration d) { + setValidationDecoration(d); // mark as validation specific decoration Decorator.addDecoration(target, d); - } + } } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ObservableRuleBasedValidator.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ObservableRuleBasedValidator.java index 8b5cb2aae..e72274e28 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ObservableRuleBasedValidator.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ObservableRuleBasedValidator.java @@ -15,6 +15,8 @@ ******************************************************************************/ package dev.webfx.stack.ui.validation.mvvmfx; +import dev.webfx.kit.util.properties.FXProperties; +import dev.webfx.kit.util.properties.Unregisterable; import javafx.beans.value.ObservableValue; import java.util.ArrayList; @@ -32,7 +34,7 @@ * * * Boolean Rules of type ObservableValue<Boolean> - * + * * The first variant uses an {@link ObservableValue} together with a static message. If this observable * has a value of false the validation status will be "invalid" and the given message will be present in the {@link ValidationStatus} * of this validator. @@ -40,35 +42,27 @@ * * * Complex Rules of type ObservableValue<ValidationMessage> - * + * * The second variant allows more complex rules. It uses a {@link ObservableValue} as rule. * If this observable has a value other then null it is considered to be invalid. The {@link ValidationMessage} * value will be present in the {@link ValidationStatus} of this validator. * * - * + * * You can add multiple rules via the {@link #addRule(ObservableValue, ValidationMessage)} and {@link #addRule(ObservableValue)} method. * If multiple rules are violated, each message will be present. */ public class ObservableRuleBasedValidator implements Validator { - /* - These lists are used to store the rules that this validator is working with. - The reason for this is to prevent problems with garbage collection. - If the validator wouldn't keep references to all given rules it would be possible that they are - removed by the garbage collector which would result in wrong validation results. - To prevent this we store references to all given rules here. - Don't get confused by the fact that no values are only added to these lists but not obtained. - */ - private List> booleanRules = new ArrayList<>(); - private List> complexRules = new ArrayList<>(); - - private ValidationStatus validationStatus = new ValidationStatus(); + private final List unregisterableRules = new ArrayList<>(); + + private final ValidationStatus validationStatus = new ValidationStatus(); /** * Creates an instance of the Validator without any rules predefined. */ - public ObservableRuleBasedValidator() {} + public ObservableRuleBasedValidator() { + } /** * Creates an instance of the Validator with the given rule predefined. @@ -86,50 +80,49 @@ public ObservableRuleBasedValidator(ObservableValue rule, ValidationMes * Creates an instance of the Validator with the given complex rules predefined. * It's a shortcut for creating an empty validator and * adding one or multiple complex rules with {@link #addRule(ObservableValue)}. + * * @param rules */ - public ObservableRuleBasedValidator(ObservableValue ... rules) { + public ObservableRuleBasedValidator(ObservableValue... rules) { for (ObservableValue rule : rules) { addRule(rule); } } - /** - * Add a rule for this validator. - * - * The rule defines a condition that has to be fulfilled. - * - * A rule is defined by an observable boolean value. If the rule has a value of true the rule is - * "fulfilled". If the rule has a value of false the rule is violated. In this case the given message - * object will be added to the status of this validator. - * - * There are some predefined rules for common use cases in the {@link ObservableRules} class that can be used. - * - * @param rule - * @param message - */ - public void addRule(ObservableValue rule, ValidationMessage message) { - booleanRules.add(rule); - - rule.addListener((observable, oldValue, newValue) -> { - validateBooleanRule(newValue, message); - }); - - validateBooleanRule(rule.getValue(), message); - } - - private void validateBooleanRule(boolean isValid, ValidationMessage message) { - if (isValid) { - validationStatus.removeMessage(message); - } else { - validationStatus.addMessage(message); - } - } - - @Override - public ValidationStatus getValidationStatus() { - return validationStatus; - } + /** + * Add a rule for this validator. + * + * The rule defines a condition that has to be fulfilled. + * + * A rule is defined by an observable boolean value. If the rule has a value of true the rule is + * "fulfilled". If the rule has a value of false the rule is violated. In this case the given message + * object will be added to the status of this validator. + * + * There are some predefined rules for common use cases in the {@link ObservableRules} class that can be used. + * + * @param validProperty + * @param message + */ + public void addRule(ObservableValue validProperty, ValidationMessage message) { + unregisterableRules.add( + FXProperties.runNowAndOnPropertyChange((observable, oldValue, newValue) -> + validateBooleanRule(newValue, message) + , validProperty) + ); + } + + public void validateBooleanRule(boolean isValid, ValidationMessage message) { + if (isValid) { + hideMessage(message); + } else { + showMessage(message); + } + } + + @Override + public ValidationStatus getValidationStatus() { + return validationStatus; + } /** * Add a complex rule for this validator. @@ -140,26 +133,37 @@ public ValidationStatus getValidationStatus() { * If the observable doesn't contain a value (in other words it contains null) the rule is considered to * be fulfilled and the validation status of this validator will be valid (given that no other rule is violated). * - * - * This method allows some more complex rules compared to {@link #addRule(ObservableValue, ValidationMessage)}. - * This way you can define rules that have different messages for specific cases. + * + * This method allows some more complex rules compared to {@link #addRule(ObservableValue, ValidationMessage)}. + * This way you can define rules that have different messages for specific cases. * * @param rule */ public void addRule(ObservableValue rule) { - complexRules.add(rule); - - rule.addListener((observable, oldValue, newValue) -> { - if(oldValue != null) { - validationStatus.removeMessage(oldValue); - } - if(newValue != null) { - validationStatus.addMessage(newValue); - } - }); - - if(rule.getValue() != null) { - validationStatus.addMessage(rule.getValue()); + unregisterableRules.add( + FXProperties.runNowAndOnPropertyChange((observable, oldValue, newValue) -> { + hideMessage(oldValue); // does nothing if oldValue is null + showMessage(newValue); // does nothing if newValue is null + }, rule) + ); + } + + private void showMessage(ValidationMessage message) { + if (message != null) { + validationStatus.addMessage(message); + } + } + + private void hideMessage(ValidationMessage message) { + if (message != null) { + validationStatus.removeMessage(message); } } + + public void clear() { + unregisterableRules.forEach(Unregisterable::unregister); + unregisterableRules.clear(); + validationStatus.clearMessages(); + } + } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java index 57c3b90e3..9ece55d7b 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java @@ -15,6 +15,8 @@ ******************************************************************************/ package dev.webfx.stack.ui.validation.mvvmfx; +import javafx.beans.value.ObservableStringValue; + import java.util.Objects; /** @@ -25,26 +27,30 @@ */ public class ValidationMessage { - private final String message; + private final ObservableStringValue messageProperty; private final Severity severity; - public ValidationMessage(Severity severity, String message) { + public ValidationMessage(Severity severity, ObservableStringValue messageProperty) { this.severity = Objects.requireNonNull(severity); - this.message = Objects.requireNonNull(message); + this.messageProperty = Objects.requireNonNull(messageProperty); } - public static ValidationMessage warning(String message) { - return new ValidationMessage(Severity.WARNING, message); + public static ValidationMessage warning(ObservableStringValue messageProperty) { + return new ValidationMessage(Severity.WARNING, messageProperty); } - public static ValidationMessage error(String message) { - return new ValidationMessage(Severity.ERROR, message); + public static ValidationMessage error(ObservableStringValue messageProperty) { + return new ValidationMessage(Severity.ERROR, messageProperty); } + public ObservableStringValue messageProperty() { + return messageProperty; + } + public String getMessage() { - return message; + return messageProperty.get(); } public Severity getSeverity() { @@ -54,27 +60,27 @@ public Severity getSeverity() { @Override public String toString() { return "ValidationMessage{" + - "message='" + message + '\'' + - ", severity=" + severity + - '}'; + "messageProperty='" + messageProperty + '\'' + + ", severity=" + severity + + '}'; } @Override public boolean equals(Object o) { if (this == o) return true; - if (o == null || !(o instanceof ValidationMessage)) + if (!(o instanceof ValidationMessage)) return false; ValidationMessage that = (ValidationMessage) o; - return message.equals(that.message) && severity == that.severity; + return messageProperty.equals(that.messageProperty) && severity == that.severity; } @Override public int hashCode() { - int result = message.hashCode(); + int result = messageProperty.hashCode(); result = 31 * result + severity.hashCode(); return result; } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java index d1f82602e..82d4062fb 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java @@ -37,11 +37,11 @@ */ public class ValidationStatus { - private ListProperty messages = new SimpleListProperty<>(FXCollections.observableArrayList()); + private final ListProperty messages = new SimpleListProperty<>(FXCollections.observableArrayList()); - private ObservableList unmodifiableMessages = FXCollections.unmodifiableObservableList(messages); - private ObservableList errorMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.ERROR)); - private ObservableList warningMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.WARNING)); + private final ObservableList unmodifiableMessages = FXCollections.unmodifiableObservableList(messages); + private final ObservableList errorMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.ERROR)); + private final ObservableList warningMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.WARNING)); /** * Intended for subclasses used by special validator implementations. diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java index a3e093bd9..6ede92357 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java @@ -17,7 +17,7 @@ import dev.webfx.stack.ui.validation.mvvmfx.Severity; import dev.webfx.stack.ui.validation.mvvmfx.ValidationMessage; -import dev.webfx.stack.ui.validation.controlsfx.validation.ValidationSupport; +import dev.webfx.stack.ui.validation.controlsfx.validation.ControlsFxValidationSupport; import dev.webfx.stack.ui.validation.controlsfx.validation.decoration.GraphicValidationDecoration; import dev.webfx.stack.ui.validation.controlsfx.validation.decoration.ValidationDecoration; import javafx.scene.control.Control; @@ -52,7 +52,7 @@ public void setDecoration(ValidationDecoration decoration) { @Override void applyRequiredVisualization(Control control, boolean required) { - ValidationSupport.setRequired(control, required); + ControlsFxValidationSupport.setRequired(control, required); if (required) { decoration.applyRequiredDecoration(control); } @@ -74,12 +74,14 @@ void applyVisualization(Control control, Optional messageOpti } } else { - decoration.removeDecorations(control); - } - - if (required) { - decoration.applyRequiredDecoration(control); + removeDecorations(control); } + + applyRequiredVisualization(control, required); + } + + @Override + public void removeDecorations(Control control) { + decoration.removeDecorations(control); } - } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java index 4b6d33d41..447baca68 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java @@ -15,11 +15,12 @@ ******************************************************************************/ package dev.webfx.stack.ui.validation.mvvmfx.visualization; +import dev.webfx.kit.util.properties.FXProperties; +import dev.webfx.kit.util.properties.ObservableLists; +import dev.webfx.platform.uischeduler.UiScheduler; import dev.webfx.stack.ui.validation.mvvmfx.Severity; import dev.webfx.stack.ui.validation.mvvmfx.ValidationMessage; import dev.webfx.stack.ui.validation.mvvmfx.ValidationStatus; -import javafx.application.Platform; -import javafx.collections.ListChangeListener; import javafx.scene.control.Control; import java.util.Optional; @@ -42,20 +43,13 @@ public abstract class ValidationVisualizerBase implements ValidationVisualizer { @Override public void initVisualization(final ValidationStatus result, final Control control, boolean required) { if (control.getSkin() == null) { - control.skinProperty().addListener((observable, oldValue, newValue) -> initVisualization(result, control, required)); + FXProperties.onPropertySet(control.skinProperty(), skin -> initVisualization(result, control, required)); return; } - if (required) { - applyRequiredVisualization(control, required); - } - - applyVisualization(control, result.getHighestMessage(), required); - - result.getMessages().addListener((ListChangeListener) c -> { - while (c.next()) { - Platform.runLater(() -> applyVisualization(control, result.getHighestMessage(), required)); - } - }); + + ObservableLists.runNowAndOnListChange(c -> UiScheduler.runInUiThread(() -> + applyVisualization(control, result.getHighestMessage(), required) + ), result.getMessages()); } /** @@ -93,5 +87,7 @@ public void initVisualization(final ValidationStatus result, final Control contr * a boolean flag indicating whether this control is mandatory or not. */ abstract void applyVisualization(Control control, Optional messageOptional, boolean required); + + public abstract void removeDecorations(Control control); } diff --git a/webfx-stack-ui-validation/src/main/java/module-info.java b/webfx-stack-ui-validation/src/main/java/module-info.java index 9aca87547..b37e66d92 100644 --- a/webfx-stack-ui-validation/src/main/java/module-info.java +++ b/webfx-stack-ui-validation/src/main/java/module-info.java @@ -6,8 +6,16 @@ requires javafx.base; requires javafx.controls; requires javafx.graphics; + requires webfx.extras.imagestore; + requires webfx.extras.util.background; + requires webfx.extras.util.border; + requires webfx.extras.util.scene; + requires webfx.kit.util; + requires webfx.platform.uischeduler; + requires webfx.platform.util; // Exported packages + exports dev.webfx.stack.ui.validation; exports dev.webfx.stack.ui.validation.controlsfx.control.decoration; exports dev.webfx.stack.ui.validation.controlsfx.impl; exports dev.webfx.stack.ui.validation.controlsfx.impl.skin;
P bindChildrenToActionGroup(P parent, ActionGroup actionGroup, Converter nodeFactory) { - bindChildrenToActionGroup(parent.getChildren(), actionGroup, nodeFactory); - return parent; + public static Unregisterable bindChildrenToActionGroup(P parent, ActionGroup actionGroup, Converter nodeFactory) { + return bindChildrenToActionGroup(parent.getChildren(), actionGroup, nodeFactory); } - public static ObservableList bindChildrenToActionGroup(ObservableList children, ActionGroup actionGroup, Converter nodeFactory) { - ObservableLists.bindConverted(children, actionGroup.getVisibleActions(), nodeFactory); - return children; + public static Unregisterable bindChildrenToActionGroup(ObservableList children, ActionGroup actionGroup, Converter nodeFactory) { + return ObservableLists.bindConverted(children, actionGroup.getVisibleActions(), nodeFactory); } } diff --git a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionBuilder.java b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionBuilder.java index 9575ff494..904e1eb90 100644 --- a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionBuilder.java +++ b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionBuilder.java @@ -1,17 +1,20 @@ package dev.webfx.stack.ui.action; +import dev.webfx.kit.util.properties.FXProperties; +import dev.webfx.stack.i18n.I18n; +import dev.webfx.stack.ui.json.JsonImageView; import javafx.beans.binding.BooleanExpression; import javafx.beans.property.SimpleBooleanProperty; import javafx.beans.property.SimpleObjectProperty; import javafx.beans.property.SimpleStringProperty; import javafx.beans.value.ObservableBooleanValue; -import javafx.beans.value.ObservableObjectValue; import javafx.beans.value.ObservableStringValue; +import javafx.beans.value.ObservableValue; import javafx.event.ActionEvent; import javafx.event.EventHandler; import javafx.scene.Node; -import dev.webfx.stack.i18n.I18n; -import dev.webfx.stack.ui.json.JsonImageView; + +import java.util.function.Supplier; /** * @author Bruno Salmon @@ -24,8 +27,8 @@ public class ActionBuilder { private String text; private Object i18nKey; - private ObservableObjectValue graphicProperty; - private Node graphic; + private ObservableValue> graphicFactoryProperty; + private Supplier graphicFactory; private Object graphicUrlOrJson; private ObservableBooleanValue disabledProperty; @@ -39,6 +42,8 @@ public class ActionBuilder { private EventHandler actionHandler; + private Object userData; + private ActionBuilderRegistry registry; public ActionBuilder() { @@ -48,6 +53,18 @@ public ActionBuilder(Object actionKey) { this.actionKey = actionKey; } + public ActionBuilder(Action action) { + setTextProperty(action.textProperty()); + setText(action.getText()); + setGraphicFactoryProperty(action.graphicFactoryProperty()); + setGraphicFactory(action.getGraphicFactory()); + setDisabledProperty(action.disabledProperty()); + setVisibleProperty(action.visibleProperty()); + setActionHandler(action); + setUserData(action.getUserData()); + //setHiddenWhenDisabled(visibleProperty == disabledProperty || visibleProperty instanceof BooleanBinding && ((BooleanBinding) visibleProperty).getDependencies().contains(disabledProperty)); + } + public Object getActionKey() { return actionKey; } @@ -84,21 +101,21 @@ public ActionBuilder setI18nKey(Object i18nKey) { return this; } - public ObservableObjectValue getGraphicProperty() { - return graphicProperty; + public ObservableValue> getGraphicFactoryProperty() { + return graphicFactoryProperty; } - public ActionBuilder setGraphicProperty(ObservableObjectValue graphicProperty) { - this.graphicProperty = graphicProperty; + public ActionBuilder setGraphicFactoryProperty(ObservableValue> graphicFactoryProperty) { + this.graphicFactoryProperty = graphicFactoryProperty; return this; } - public Node getGraphic() { - return graphic; + public Supplier getGraphicFactory() { + return graphicFactory; } - public ActionBuilder setGraphic(Node graphic) { - this.graphic = graphic; + public ActionBuilder setGraphicFactory(Supplier graphicFactory) { + this.graphicFactory = graphicFactory; return this; } @@ -169,6 +186,15 @@ public ActionBuilder setActionHandler(Runnable actionHandler) { return setActionHandler(e -> actionHandler.run()); } + public Object getUserData() { + return userData; + } + + public ActionBuilder setUserData(Object userData) { + this.userData = userData; + return this; + } + public ActionBuilder setRegistry(ActionBuilderRegistry registry) { this.registry = registry; return this; @@ -184,8 +210,8 @@ public ActionBuilder duplicate() { .setTextProperty(textProperty) .setText(text) .setI18nKey(i18nKey) - .setGraphicProperty(graphicProperty) - .setGraphic(graphic) + .setGraphicFactoryProperty(graphicFactoryProperty) + .setGraphicFactory(graphicFactory) .setGraphicUrlOrJson(graphicUrlOrJson) .setDisabledProperty(disabledProperty) .setVisibleProperty(visibleProperty) @@ -209,7 +235,9 @@ public ActionBuilder removeText() { public Action build() { completePropertiesForBuild(); - return Action.create(textProperty, graphicProperty, disabledProperty, visibleProperty, actionHandler); + Action action = Action.create(textProperty, graphicFactoryProperty, disabledProperty, visibleProperty, actionHandler); + action.setUserData(userData); + return action; } void completePropertiesForBuild() { @@ -229,13 +257,14 @@ private void completeTextProperty() { } private void completeGraphicProperty() { - if (graphicProperty == null) { - if (graphic == null && graphicUrlOrJson != null) - graphic = JsonImageView.createImageView(graphicUrlOrJson); - if (graphic != null || i18nKey == null) - graphicProperty = new SimpleObjectProperty<>(graphic); + if (graphicFactoryProperty == null) { + if (graphicFactory == null && graphicUrlOrJson != null) + graphicFactory = () -> JsonImageView.createImageView(graphicUrlOrJson); + if (graphicFactory != null || i18nKey == null) + graphicFactoryProperty = new SimpleObjectProperty<>(graphicFactory); else - graphicProperty = I18n.i18nGraphicProperty(i18nKey); + graphicFactoryProperty = FXProperties.compute(I18n.dictionaryProperty(), dictionary -> + () -> I18n.getI18nGraphic(i18nKey)); } } diff --git a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionGroup.java b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionGroup.java index 438acab5a..71838eb4a 100644 --- a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionGroup.java +++ b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionGroup.java @@ -2,14 +2,15 @@ import dev.webfx.stack.ui.action.impl.ActionGroupImpl; import javafx.beans.value.ObservableBooleanValue; -import javafx.beans.value.ObservableObjectValue; import javafx.beans.value.ObservableStringValue; +import javafx.beans.value.ObservableValue; import javafx.collections.ObservableList; import javafx.event.ActionEvent; import javafx.event.EventHandler; import javafx.scene.Node; import java.util.Collection; +import java.util.function.Supplier; /** * @author Bruno Salmon @@ -22,8 +23,8 @@ public interface ActionGroup extends Action { boolean hasSeparators(); - static ActionGroup create(Collection actions, ObservableStringValue textProperty, ObservableObjectValue graphicProperty, ObservableBooleanValue disabledProperty, ObservableBooleanValue visibleProperty, boolean hasSeparators, EventHandler actionHandler) { - return new ActionGroupImpl(actions, textProperty, graphicProperty, disabledProperty, visibleProperty, hasSeparators, actionHandler); + static ActionGroup create(Collection actions, ObservableStringValue textProperty, ObservableValue> graphicFactoryProperty, ObservableBooleanValue disabledProperty, ObservableBooleanValue visibleProperty, boolean hasSeparators, EventHandler actionHandler) { + return new ActionGroupImpl(actions, textProperty, graphicFactoryProperty, disabledProperty, visibleProperty, hasSeparators, actionHandler); } } diff --git a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionGroupBuilder.java b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionGroupBuilder.java index a0185e70a..ea2fd6bfa 100644 --- a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionGroupBuilder.java +++ b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionGroupBuilder.java @@ -1,14 +1,15 @@ package dev.webfx.stack.ui.action; +import dev.webfx.platform.util.collection.Collections; import javafx.beans.value.ObservableBooleanValue; -import javafx.beans.value.ObservableObjectValue; import javafx.beans.value.ObservableStringValue; +import javafx.beans.value.ObservableValue; import javafx.event.ActionEvent; import javafx.event.EventHandler; import javafx.scene.Node; -import dev.webfx.platform.util.collection.Collections; import java.util.Collection; +import java.util.function.Supplier; /** * @author Bruno Salmon @@ -43,7 +44,7 @@ public ActionGroupBuilder setHasSeparators(boolean hasSeparators) { @Override public ActionGroup build() { completePropertiesForBuild(); - return ActionGroup.create(actions, getTextProperty(), getGraphicProperty(), getDisabledProperty(), getVisibleProperty(), hasSeparators, getActionHandler()); + return ActionGroup.create(actions, getTextProperty(), getGraphicFactoryProperty(), getDisabledProperty(), getVisibleProperty(), hasSeparators, getActionHandler()); } // --- Overriding fluent API methods to return ActionGroupBuilder instead of ActionBuilder --- @@ -69,13 +70,13 @@ public ActionGroupBuilder setI18nKey(Object i18nKey) { } @Override - public ActionGroupBuilder setGraphicProperty(ObservableObjectValue graphicProperty) { - return (ActionGroupBuilder) super.setGraphicProperty(graphicProperty); + public ActionGroupBuilder setGraphicFactoryProperty(ObservableValue> graphicFactoryProperty) { + return (ActionGroupBuilder) super.setGraphicFactoryProperty(graphicFactoryProperty); } @Override - public ActionGroupBuilder setGraphic(Node graphic) { - return (ActionGroupBuilder) super.setGraphic(graphic); + public ActionGroupBuilder setGraphicFactory(Supplier graphicFactory) { + return (ActionGroupBuilder) super.setGraphicFactory(graphicFactory); } @Override diff --git a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/ActionGroupImpl.java b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/ActionGroupImpl.java index e331342e5..d37f5620e 100644 --- a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/ActionGroupImpl.java +++ b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/ActionGroupImpl.java @@ -1,22 +1,23 @@ package dev.webfx.stack.ui.action.impl; +import dev.webfx.kit.util.properties.FXProperties; +import dev.webfx.platform.util.collection.Collections; +import dev.webfx.stack.ui.action.Action; +import dev.webfx.stack.ui.action.ActionGroup; import javafx.beans.property.Property; import javafx.beans.value.ObservableBooleanValue; -import javafx.beans.value.ObservableObjectValue; import javafx.beans.value.ObservableStringValue; +import javafx.beans.value.ObservableValue; import javafx.collections.FXCollections; import javafx.collections.ObservableList; import javafx.event.ActionEvent; import javafx.event.EventHandler; import javafx.scene.Node; -import dev.webfx.stack.ui.action.Action; -import dev.webfx.stack.ui.action.ActionGroup; -import dev.webfx.kit.util.properties.FXProperties; -import dev.webfx.platform.util.collection.Collections; import java.util.ArrayList; import java.util.Collection; import java.util.List; +import java.util.function.Supplier; /** * @author Bruno Salmon @@ -27,8 +28,8 @@ public final class ActionGroupImpl extends ReadOnlyAction implements ActionGroup private final ObservableList visibleActions = FXCollections.observableArrayList(); private final boolean hasSeparators; - public ActionGroupImpl(Collection actions, ObservableStringValue textProperty, ObservableObjectValue graphicProperty, ObservableBooleanValue disabledProperty, ObservableBooleanValue visibleProperty, boolean hasSeparators, EventHandler actionHandler) { - super(textProperty, graphicProperty, disabledProperty, visibleProperty, actionHandler); + public ActionGroupImpl(Collection actions, ObservableStringValue textProperty, ObservableValue> graphicFactoryProperty, ObservableBooleanValue disabledProperty, ObservableBooleanValue visibleProperty, boolean hasSeparators, EventHandler actionHandler) { + super(textProperty, graphicFactoryProperty, disabledProperty, visibleProperty, actionHandler); this.actions = actions; this.hasSeparators = hasSeparators; FXProperties.runNowAndOnPropertiesChange(this::updateVisibleActions, Collections.map(actions, Action::visibleProperty)); @@ -40,7 +41,7 @@ private void updateVisibleActions() { for (Action action : this.actions) { if (action.isVisible()) { int n = actions.size(); - if (action.getText() == null && action.getGraphic() == null && action instanceof ActionGroup) { + if (action.getText() == null && action.getGraphicFactory() == null && action instanceof ActionGroup) { ActionGroup actionGroup = (ActionGroup) action; actions.addAll(actionGroup.getVisibleActions()); if (actions.size() > n) { diff --git a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/ReadOnlyAction.java b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/ReadOnlyAction.java index 17d90a782..c0843f2b0 100644 --- a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/ReadOnlyAction.java +++ b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/ReadOnlyAction.java @@ -1,12 +1,14 @@ package dev.webfx.stack.ui.action.impl; +import dev.webfx.stack.ui.action.Action; import javafx.beans.value.ObservableBooleanValue; -import javafx.beans.value.ObservableObjectValue; import javafx.beans.value.ObservableStringValue; +import javafx.beans.value.ObservableValue; import javafx.event.ActionEvent; import javafx.event.EventHandler; import javafx.scene.Node; -import dev.webfx.stack.ui.action.Action; + +import java.util.function.Supplier; /** * A read-only action where properties are observable values. @@ -15,9 +17,9 @@ */ public class ReadOnlyAction implements Action { - public ReadOnlyAction(ObservableStringValue textProperty, ObservableObjectValue graphicProperty, ObservableBooleanValue disabledProperty, ObservableBooleanValue visibleProperty, EventHandler actionHandler) { + public ReadOnlyAction(ObservableStringValue textProperty, ObservableValue> graphicFactoryProperty, ObservableBooleanValue disabledProperty, ObservableBooleanValue visibleProperty, EventHandler actionHandler) { this.textProperty = textProperty; - this.graphicProperty = graphicProperty; + this.graphicFactoryProperty = graphicFactoryProperty; this.disabledProperty = disabledProperty; this.visibleProperty = visibleProperty; this.actionHandler = actionHandler; @@ -29,10 +31,10 @@ public ObservableStringValue textProperty() { return textProperty; } - private final ObservableObjectValue graphicProperty; + private final ObservableValue> graphicFactoryProperty; @Override - public ObservableObjectValue graphicProperty() { - return graphicProperty; + public ObservableValue> graphicFactoryProperty() { + return graphicFactoryProperty; } private final ObservableBooleanValue disabledProperty; diff --git a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/WritableAction.java b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/WritableAction.java index 849ef13ca..8f42b2cee 100644 --- a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/WritableAction.java +++ b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/WritableAction.java @@ -1,14 +1,16 @@ package dev.webfx.stack.ui.action.impl; +import dev.webfx.platform.util.Arrays; +import dev.webfx.stack.ui.action.Action; import javafx.beans.property.*; import javafx.beans.value.ObservableBooleanValue; -import javafx.beans.value.ObservableObjectValue; import javafx.beans.value.ObservableStringValue; +import javafx.beans.value.ObservableValue; import javafx.event.ActionEvent; import javafx.event.EventHandler; import javafx.scene.Node; -import dev.webfx.stack.ui.action.Action; -import dev.webfx.platform.util.Arrays; + +import java.util.function.Supplier; /** * A writable action where properties (text, graphic, disabled, visible) can be set later (ie after constructor call) @@ -19,15 +21,15 @@ public class WritableAction extends ReadOnlyAction { public WritableAction(Action action, String... writablePropertyNames) { - this(createStringProperty(action.textProperty(), "text", writablePropertyNames), createObjectProperty(action.graphicProperty(), "graphic", writablePropertyNames), createBooleanProperty(action.disabledProperty(), "disabled", writablePropertyNames), createBooleanProperty(action.visibleProperty(), "visible", writablePropertyNames), action); + this(createStringProperty(action.textProperty(), "text", writablePropertyNames), createObjectProperty(action.graphicFactoryProperty(), "graphicFactory", writablePropertyNames), createBooleanProperty(action.disabledProperty(), "disabled", writablePropertyNames), createBooleanProperty(action.visibleProperty(), "visible", writablePropertyNames), action); } public WritableAction(EventHandler actionHandler) { this(new SimpleStringProperty(), new SimpleObjectProperty<>(), new SimpleBooleanProperty(true /* disabled until it is bound */), new SimpleBooleanProperty(false /* invisible until it is bound */), actionHandler); } - public WritableAction(ObservableStringValue textProperty, ObservableObjectValue graphicProperty, ObservableBooleanValue disabledProperty, ObservableBooleanValue visibleProperty, EventHandler actionHandler) { - super(textProperty, graphicProperty, disabledProperty, visibleProperty, actionHandler); + public WritableAction(ObservableStringValue textProperty, ObservableValue> graphicFactoryProperty, ObservableBooleanValue disabledProperty, ObservableBooleanValue visibleProperty, EventHandler actionHandler) { + super(textProperty, graphicFactoryProperty, disabledProperty, visibleProperty, actionHandler); } public StringProperty writableTextProperty() { @@ -38,12 +40,12 @@ public void setText(String text) { writableTextProperty().set(text); } - public ObjectProperty writableGraphicProperty() { - return (ObjectProperty) graphicProperty(); + public ObjectProperty> writableGraphicFactoryProperty() { + return (ObjectProperty>) graphicFactoryProperty(); } - public void setGraphic(Node graphic) { - writableGraphicProperty().set(graphic); + public void setGraphicFactory(Supplier graphicFactory) { + writableGraphicFactoryProperty().set(graphicFactory); } public BooleanProperty writableDisabledProperty() { @@ -76,10 +78,10 @@ public void set(String newValue) { return writableProperty; } - private static ObjectProperty createObjectProperty(ObservableObjectValue readOnlyProperty, String propertyName, String... writablePropertyNames) { + private static ObjectProperty createObjectProperty(ObservableValue readOnlyProperty, String propertyName, String... writablePropertyNames) { if (readOnlyProperty instanceof ObjectProperty) return (ObjectProperty) readOnlyProperty; - SimpleObjectProperty writableProperty = new SimpleObjectProperty() { + SimpleObjectProperty writableProperty = new SimpleObjectProperty<>() { @Override public void set(T newValue) { unbindPropertyIfWritable(this, propertyName, writablePropertyNames); diff --git a/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/ControlFactoryMixin.java b/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/ControlFactoryMixin.java index dcdeb5c0e..061e99672 100644 --- a/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/ControlFactoryMixin.java +++ b/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/ControlFactoryMixin.java @@ -110,11 +110,11 @@ default Button styleButton(Button button) { } default CheckBox newCheckBox(Object i18nKey) { - return I18nControls.bindI18nProperties(new CheckBox(), i18nKey); + return I18nControls.newCheckBox(i18nKey); } default RadioButton newRadioButton(Object i18nKey) { - return I18nControls.bindI18nProperties(new RadioButton(), i18nKey); + return I18nControls.newRadioButton(i18nKey); } default RadioButton newRadioButton(Object i18nKey, ToggleGroup toggleGroup) { @@ -124,7 +124,7 @@ default RadioButton newRadioButton(Object i18nKey, ToggleGroup toggleGroup) { } default Label newLabel(Object i18nKey) { - return I18nControls.bindI18nProperties(new Label(), i18nKey); + return I18nControls.newLabel(i18nKey); } default TextField newTextField() { @@ -144,7 +144,7 @@ default Hyperlink newHyperlink() { } default Hyperlink newHyperlink(Object i18nKey) { - return I18nControls.bindI18nProperties(newHyperlink(), i18nKey); + return I18nControls.newHyperlink(i18nKey); } default Hyperlink newHyperlink(Object i18nKey, EventHandler onAction) { @@ -158,7 +158,7 @@ default TextArea newTextArea(Object i18nKey) { } default Text newText(Object i18nKey) { - return I18n.bindI18nProperties(new Text(), i18nKey); + return I18n.newText(i18nKey); } } diff --git a/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/button/ButtonFactory.java b/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/button/ButtonFactory.java index bcd8188e9..b52cd46d5 100644 --- a/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/button/ButtonFactory.java +++ b/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/button/ButtonFactory.java @@ -62,7 +62,7 @@ public static Button decorateButtonWithDropDownArrow(Button button) { downArrow.setFill(null); downArrow.setContent("M1 1.22998L6.325 6.55499L11.65 1.22998"); GraphicDecoration dropDownArrowDecoration = new GraphicDecoration(downArrow, Pos.CENTER_RIGHT, 0, 0, -1, 0); - FXProperties.runNowAndOnPropertiesChange(() -> Platform.runLater(() -> + FXProperties.runNowAndOnPropertyChange(() -> Platform.runLater(() -> Controls.onSkinReady(button, () -> dropDownArrowDecoration.applyDecoration(button)) ), button.graphicProperty()); // Code to clip the content before the down arrow diff --git a/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/dialog/DialogContent.java b/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/dialog/DialogContent.java index 73739f4ee..c0b7e8c82 100644 --- a/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/dialog/DialogContent.java +++ b/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/dialog/DialogContent.java @@ -72,6 +72,12 @@ public DialogContent setYesNo() { return this; } + public DialogContent setOk() { + primaryButtonText = "Ok"; + secondaryButton.setManaged(false); + return this; + } + public Button getPrimaryButton() { return primaryButton; } diff --git a/webfx-stack-ui-json/src/main/java/dev/webfx/stack/ui/json/JsonSVGPath.java b/webfx-stack-ui-json/src/main/java/dev/webfx/stack/ui/json/JsonSVGPath.java index 8d2154fd0..3bd74ee98 100644 --- a/webfx-stack-ui-json/src/main/java/dev/webfx/stack/ui/json/JsonSVGPath.java +++ b/webfx-stack-ui-json/src/main/java/dev/webfx/stack/ui/json/JsonSVGPath.java @@ -7,6 +7,8 @@ import javafx.scene.paint.Paint; import javafx.scene.shape.FillRule; import javafx.scene.shape.SVGPath; +import javafx.scene.shape.StrokeLineCap; +import javafx.scene.shape.StrokeLineJoin; /** * @author Bruno Salmon @@ -21,6 +23,9 @@ public static SVGPath createSVGPath(ReadOnlyAstObject json) { svgPath.setStroke(toPaint(json.getString("stroke"), null)); svgPath.setStrokeWidth(json.getDouble("strokeWidth", 1d)); svgPath.setFillRule(toFillRule(json.getString("fillRule"))); + svgPath.setStrokeLineCap(toStrokeLineCap(json.getString("strokeLineCap"))); + svgPath.setStrokeLineJoin(toStrokeLineJoin(json.getString("strokeLineJoin"))); + svgPath.setStrokeMiterLimit(json.getDouble("strokeMiterLimit", 10d)); return svgPath; } @@ -40,11 +45,36 @@ private static Paint toPaint(String paintText, Paint defaultPaint) { } private static FillRule toFillRule(String ruleText) { - if (ruleText != null) + if (ruleText != null) { switch (ruleText.trim().toLowerCase()) { - case "evenodd" : return FillRule.EVEN_ODD; - case "nonzero" : return FillRule.NON_ZERO; + case "evenodd": + return FillRule.EVEN_ODD; + case "nonzero": + return FillRule.NON_ZERO; } + } return FillRule.NON_ZERO; } + + private static StrokeLineCap toStrokeLineCap(String strokeLineCapText) { + if (strokeLineCapText != null) { + switch (strokeLineCapText.trim().toLowerCase()) { + case "square" : return StrokeLineCap.SQUARE; + case "butt" : return StrokeLineCap.BUTT; + case "round" : return StrokeLineCap.ROUND; + } + } + return StrokeLineCap.SQUARE; + } + + private static StrokeLineJoin toStrokeLineJoin(String StrokeLineJoinText) { + if (StrokeLineJoinText != null) { + switch (StrokeLineJoinText.trim().toLowerCase()) { + case "miter": return StrokeLineJoin.MITER; + case "bevel": return StrokeLineJoin.BEVEL; + case "round": return StrokeLineJoin.ROUND; + } + } + return StrokeLineJoin.MITER; + } } diff --git a/webfx-stack-ui-operation-action/pom.xml b/webfx-stack-ui-operation-action/pom.xml index b65dbafb7..d7388c4a9 100644 --- a/webfx-stack-ui-operation-action/pom.xml +++ b/webfx-stack-ui-operation-action/pom.xml @@ -45,6 +45,14 @@ 0.1.0-SNAPSHOT + + dev.webfx + webfx-platform-javabase-emul-j2cl + 0.1.0-SNAPSHOT + runtime + true + + dev.webfx webfx-platform-javatime-emul-j2cl @@ -53,6 +61,12 @@ true + + dev.webfx + webfx-platform-scheduler + 0.1.0-SNAPSHOT + + dev.webfx webfx-platform-uischeduler @@ -77,6 +91,12 @@ 0.1.0-SNAPSHOT + + dev.webfx + webfx-stack-ui-action-tuner + 0.1.0-SNAPSHOT + + dev.webfx webfx-stack-ui-exceptions diff --git a/webfx-stack-ui-operation-action/src/main/java/dev/webfx/stack/ui/operation/action/OperationAction.java b/webfx-stack-ui-operation-action/src/main/java/dev/webfx/stack/ui/operation/action/OperationAction.java index cb8aaf170..de427612b 100644 --- a/webfx-stack-ui-operation-action/src/main/java/dev/webfx/stack/ui/operation/action/OperationAction.java +++ b/webfx-stack-ui-operation-action/src/main/java/dev/webfx/stack/ui/operation/action/OperationAction.java @@ -58,13 +58,9 @@ private OperationAction(OperationAction[] me, Function me[0] = this; this.operationRequestFactory = operationRequestFactory; OperationActionRegistry registry = getOperationActionRegistry(); - registry.bindOperationActionGraphicalProperties(this); - // Also, if some graphical dependencies are passed, we update the graphical properties when they change - if (graphicalDependencies.length > 0) - FXProperties.runNowAndOnPropertiesChange(() -> { - registry.updateOperationActionGraphicalProperties(this); - registry.bindOperationActionGraphicalProperties(this); - }, graphicalDependencies); + FXProperties.runNowAndOnPropertiesChange(() -> + registry.bindOperationActionGraphicalProperties(this) + , graphicalDependencies); // Also updating the graphical properties when graphical dependencies change } public OperationActionRegistry getOperationActionRegistry() { @@ -86,9 +82,8 @@ private void startShowingActionAsExecuting(Object operationRequest) { // If in addition an icon has been provided to graphically indicate the execution is in progress, if (actionExecutingIconFactory != null) { // we apply it to the graphic property Node executingIcon = actionExecutingIconFactory.apply(operationRequest); - if (executingIcon != null) { - FXProperties.setEvenIfBound(writableGraphicProperty(), executingIcon); - } + if (executingIcon != null) // For some operations such as routing operation, there is no executing icon + FXProperties.setEvenIfBound(writableGraphicFactoryProperty(), () -> executingIcon); } } @@ -100,9 +95,8 @@ private void stopShowingActionAsExecuting(Object operationRequest, Throwable exc // If in addition an icon has been provided to graphically indicate the execution has ended, if (actionExecutedIconFactory != null) { // we apply it to the graphic property for 2s Node executedIcon = actionExecutedIconFactory.apply(operationRequest, exception); - if (executedIcon != null) { - FXProperties.setEvenIfBound(writableGraphicProperty(), executedIcon); - } + if (executedIcon != null) // For some operations such as routing operation, there is no executed icon + FXProperties.setEvenIfBound(writableGraphicFactoryProperty(), () -> executedIcon); UiScheduler.scheduleDelay(2000, () -> { // After 2 seconds, we reestablish the original action icon, unless it's already executing again if (!executing) { // if executing again, we keep the possible executing icon instead diff --git a/webfx-stack-ui-operation-action/src/main/java/dev/webfx/stack/ui/operation/action/OperationActionRegistry.java b/webfx-stack-ui-operation-action/src/main/java/dev/webfx/stack/ui/operation/action/OperationActionRegistry.java index 90e74f406..0691fe3da 100644 --- a/webfx-stack-ui-operation-action/src/main/java/dev/webfx/stack/ui/operation/action/OperationActionRegistry.java +++ b/webfx-stack-ui-operation-action/src/main/java/dev/webfx/stack/ui/operation/action/OperationActionRegistry.java @@ -1,11 +1,17 @@ package dev.webfx.stack.ui.operation.action; +import dev.webfx.kit.util.properties.FXProperties; import dev.webfx.platform.async.AsyncFunction; import dev.webfx.platform.async.Future; +import dev.webfx.platform.console.Console; +import dev.webfx.platform.scheduler.Scheduled; import dev.webfx.platform.uischeduler.UiScheduler; +import dev.webfx.platform.util.collection.Collections; import dev.webfx.stack.authz.client.factory.AuthorizationUtil; import dev.webfx.stack.ui.action.Action; import dev.webfx.stack.ui.action.ActionBinder; +import dev.webfx.stack.ui.action.impl.WritableAction; +import dev.webfx.stack.ui.action.tuner.ActionTuner; import dev.webfx.stack.ui.operation.HasOperationCode; import javafx.beans.property.ObjectProperty; import javafx.beans.property.SimpleObjectProperty; @@ -13,10 +19,8 @@ import javafx.beans.value.ObservableValue; import javafx.event.ActionEvent; -import java.util.ArrayList; -import java.util.Collection; -import java.util.HashMap; -import java.util.Map; +import java.lang.ref.WeakReference; +import java.util.*; import java.util.function.Consumer; import java.util.function.Function; @@ -41,17 +45,32 @@ */ public final class OperationActionRegistry { - private static OperationActionRegistry INSTANCE; + private static final boolean LOG_DEBUG = false; - private final Map graphicalActions = new HashMap<>(); - private Collection notYetBoundOperationActions; - private Map> operationActionProperties; - private Runnable pendingBindRunnable; + private static final OperationActionRegistry INSTANCE = new OperationActionRegistry(); + + // Holding the actions that have been registered by the application code through registerOperationGraphicalAction(). + // These actions usually hold only the graphical properties, they are not executable (the event handler doesn't do + // anything). They are used to bind the graphical properties of the executable operation actions - through + // bindOperationActionGraphicalProperties(). + private final Map registeredGraphicalActions = new HashMap<>(); + + // Holding the executable operation actions instantiated by the application code (probably bound to a UI control + // such as a button) which have been asked to be bound to a registered graphical action, through + // bindOperationActionGraphicalProperties(). + private final Map>> registeredOperationActions = new HashMap<>(); + // Keeping a list of operation actions whose graphical action are not yet registered => the binding is deferred + // until the graphical action is registered. + private final List notYetBoundExecutableOperationActions = new ArrayList<>(); + + // When the application code wants to be notified when an executable operation action has been bound to its graphical + // properties, it can get an observable which will transit from null to the operation action at that time. + private final Map> executableOperationActionNotifyingProperties = new HashMap<>(); + + private Scheduled bindScheduled; private Consumer operationActionGraphicalPropertiesUpdater; public static OperationActionRegistry getInstance() { - if (INSTANCE == null) - INSTANCE = new OperationActionRegistry(); return INSTANCE; } @@ -80,103 +99,120 @@ public Future apply(Object request) { return AuthorizationUtil.authorizedOperationProperty( operationRequestFactory , embedAuthorizationFunction - , operationActionProperty(operationCode) // reactive property (will change when operation action will be registered, causing a new authorization evaluation) + , executableOperationActionNotifyingProperty(operationCode) // reactive property (will change when operation action will be registered, causing a new authorization evaluation) ); } - public OperationActionRegistry registerOperationGraphicalAction(Class operationRequestClass, Action graphicalAction) { - synchronized (graphicalActions) { - graphicalActions.put(operationRequestClass, graphicalAction); - return checkPendingOperationActionGraphicalBindings(); + private void processRegisteredOperationActions(Object operationCodeOrRequestClass, Consumer processor) { + List> operationActions = registeredOperationActions.get(operationCodeOrRequestClass); + if (operationActions != null) { + for (Iterator> it = operationActions.iterator(); it.hasNext(); ) { + OperationAction oa = it.next().get(); + if (oa == null) { + logDebug(operationCodeOrRequestClass + " operation action was garbage-collected"); + it.remove(); + } else { + processor.accept(oa); + } + } } } - public OperationActionRegistry registerOperationGraphicalAction(Object operationCode, Action graphicalAction) { - synchronized (graphicalActions) { - graphicalActions.put(operationCode, graphicalAction); + public OperationActionRegistry registerOperationGraphicalAction(Object operationCodeOrRequestClass, Action graphicalAction) { + synchronized (registeredGraphicalActions) { + logDebug("Registering " + operationCodeOrRequestClass + " graphical action (" + (registeredGraphicalActions.containsKey(operationCodeOrRequestClass) ? "not" : "") + " first time)"); + registeredGraphicalActions.put(operationCodeOrRequestClass, graphicalAction); + processRegisteredOperationActions(operationCodeOrRequestClass, oa -> { + logDebug(operationCodeOrRequestClass + " operation action will be rebound to new graphical action"); + Collections.addIfNotContains(oa, notYetBoundExecutableOperationActions); + }); return checkPendingOperationActionGraphicalBindings(); } } + private OperationActionRegistry registerOperationAction(Object operationCodeOrRequestClass, OperationAction operationAction) { + synchronized (registeredOperationActions) { + boolean[] alreadyRegistered = { false }; + processRegisteredOperationActions(operationCodeOrRequestClass, oa -> { + if (oa == operationAction) + alreadyRegistered[0] = true; + }); + if (!alreadyRegistered[0]) { + List> operationActions = registeredOperationActions.computeIfAbsent(operationCodeOrRequestClass, k -> new ArrayList<>()); + operationActions.add(new WeakReference<>(operationAction)); + logDebug("Registering " + operationCodeOrRequestClass + " operation action -> n°" + operationActions.size()); + } + return this; + } + } + private OperationActionRegistry checkPendingOperationActionGraphicalBindings() { - if (notYetBoundOperationActions != null && pendingBindRunnable == null) { - UiScheduler.scheduleDeferred(pendingBindRunnable = () -> { - Collection operationActionsToBind = notYetBoundOperationActions; - pendingBindRunnable = null; - notYetBoundOperationActions = null; - for (OperationAction operationAction : operationActionsToBind) - bindOperationActionGraphicalProperties(operationAction); + if (!notYetBoundExecutableOperationActions.isEmpty() && (bindScheduled == null || bindScheduled.isFinished())) { + bindScheduled = UiScheduler.scheduleDeferred(() -> { + notYetBoundExecutableOperationActions.forEach(this::bindOperationActionGraphicalProperties); + notYetBoundExecutableOperationActions.clear(); }); } return this; } - void bindOperationActionGraphicalProperties(OperationAction operationAction) { - if (bindOperationActionGraphicalPropertiesNow(operationAction)) + void bindOperationActionGraphicalProperties(OperationAction executableOperationAction) { + if (bindOperationActionGraphicalPropertiesNow(executableOperationAction)) return; - if (notYetBoundOperationActions == null) - notYetBoundOperationActions = new ArrayList<>(); - notYetBoundOperationActions.add(operationAction); + notYetBoundExecutableOperationActions.add(executableOperationAction); } - private boolean bindOperationActionGraphicalPropertiesNow(OperationAction operationAction) { + private boolean bindOperationActionGraphicalPropertiesNow(OperationAction executableOperationAction) { // The binding is possible only if a graphical action has been registered for that operation // Instantiating an operation request just to have the request class or operation code - A operationRequest = newOperationActionRequest(operationAction); + A operationRequest = newOperationActionRequest(executableOperationAction); + + // Registering the operation action (should it be done only once?) + Class operationRequestClass = operationRequest.getClass(); + registerOperationAction(operationRequestClass, executableOperationAction); + Object operationCode = operationRequest instanceof HasOperationCode ? ((HasOperationCode) operationRequest).getOperationCode() : null; + if (operationCode != null) + registerOperationAction(operationCode, executableOperationAction); + // Then getting the graphical action from it Action graphicalAction = getGraphicalActionFromOperationRequest(operationRequest); // If this is not the case, we return false (can't do the binding now) if (graphicalAction == null) return false; - Map> properties = operationActionProperties; - if (properties != null) { - Object code = getOperationCodeFromGraphicalAction(graphicalAction); - if (code != null) { - ObjectProperty operationActionProperty = properties.remove(code); + // if we reach this point, we can do the binding. + updateOperationActionGraphicalProperties(executableOperationAction); + ActionBinder.bindWritableActionToAction(executableOperationAction, graphicalAction); + // We also notify the application code that we now have an executable operation action associated + if (!executableOperationActionNotifyingProperties.isEmpty()) { + if (operationCode != null) { + ObjectProperty operationActionProperty = executableOperationActionNotifyingProperties.remove(operationCode); if (operationActionProperty != null) - operationActionProperty.set(operationAction); - if (properties.isEmpty()) - operationActionProperties = null; + operationActionProperty.set(executableOperationAction); } } - ActionBinder.bindWritableActionToAction(operationAction, graphicalAction); return true; } - public Action getGraphicalActionFromOperationAction(OperationAction operationAction) { - // Instantiating an operation request just to have the request class or operation code - A operationRequest = newOperationActionRequest(operationAction); - // Then getting the graphical action from it - return getGraphicalActionFromOperationRequest(operationRequest); - } - + // Important: the code calling this method should not store the value, but request it again each time it needs it, + // because the graphical action can change (ex: cache value on application start & then refreshed value from database) public Action getGraphicalActionFromOperationRequest(Object operationRequest) { // Trying to get the operation action registered with the operation request class or code. Action graphicalAction = getGraphicalActionFromOperationRequestClass(operationRequest.getClass()); if (graphicalAction == null && operationRequest instanceof HasOperationCode) graphicalAction = getGraphicalActionFromOperationCode(((HasOperationCode) operationRequest).getOperationCode()); + if (graphicalAction != null && operationRequest instanceof ActionTuner) { + graphicalAction = ((ActionTuner) operationRequest).tuneAction(graphicalAction); + } return graphicalAction; } private Action getGraphicalActionFromOperationRequestClass(Class operationRequestClass) { - synchronized (graphicalActions) { - return graphicalActions.get(operationRequestClass); - } + return getGraphicalActionFromOperationCode(operationRequestClass); // because they share the same map } private Action getGraphicalActionFromOperationCode(Object operationCode) { - synchronized (graphicalActions) { - return graphicalActions.get(operationCode); - } - } - - private Object getOperationCodeFromGraphicalAction(Action graphicalAction) { - synchronized (graphicalActions) { - for (Map.Entry entry : graphicalActions.entrySet()) { - if (entry.getValue() == graphicalAction) - return entry.getKey(); - } - return null; + synchronized (registeredGraphicalActions) { + return registeredGraphicalActions.get(operationCode); } } @@ -189,12 +225,15 @@ void updateOperationActionGraphicalProperties(OperationAction opera operationActionGraphicalPropertiesUpdater.accept(operationAction); } - private ObservableValue operationActionProperty(Object operationCode) { - ObjectProperty operationActionProperty = new SimpleObjectProperty<>(); - if (operationActionProperties == null) - operationActionProperties = new HashMap<>(); - operationActionProperties.put(operationCode, operationActionProperty); - return operationActionProperty; + private ObservableValue executableOperationActionNotifyingProperty(Object operationCode) { + ObjectProperty property = executableOperationActionNotifyingProperties.computeIfAbsent(operationCode, k -> new SimpleObjectProperty<>()); + if (property.get() == null) { + processRegisteredOperationActions(operationCode, oa -> { + if (property.get() == null) + property.set(oa); + }); + } + return property; } public A newOperationActionRequest(OperationAction operationAction) { @@ -206,4 +245,26 @@ public A newOperationActionRequest(OperationAction operationAction) return null; } + public Action getOrWaitOperationAction(Object operationCode) { + // Waiting to be notified + ObservableValue operationActionProperty = executableOperationActionNotifyingProperty(operationCode); + // For now, we create a wrapper action that delegates the execution to the operation action (if set) + WritableAction wrapperAction = new WritableAction(e -> { // Invisible & disabled at this stage + OperationAction operationAction = operationActionProperty.getValue(); + if (operationAction != null) { + operationAction.handle(e); + } + }); + FXProperties.onPropertySet(operationActionProperty, operationAction -> + ActionBinder.bindWritableActionToAction(wrapperAction, operationAction) + ); + return wrapperAction; + } + + private static void logDebug(String message) { + if (LOG_DEBUG) { + Console.log("[OperationActionRegistry] - " + message); + } + } + } diff --git a/webfx-stack-ui-operation-action/src/main/java/module-info.java b/webfx-stack-ui-operation-action/src/main/java/module-info.java index d434dda29..d94c95d13 100644 --- a/webfx-stack-ui-operation-action/src/main/java/module-info.java +++ b/webfx-stack-ui-operation-action/src/main/java/module-info.java @@ -8,10 +8,12 @@ requires webfx.kit.util; requires webfx.platform.async; requires webfx.platform.console; + requires webfx.platform.scheduler; requires webfx.platform.uischeduler; requires webfx.platform.util; requires webfx.stack.authz.client; requires transitive webfx.stack.ui.action; + requires webfx.stack.ui.action.tuner; requires webfx.stack.ui.exceptions; requires webfx.stack.ui.operation; diff --git a/webfx-stack-ui-operation/pom.xml b/webfx-stack-ui-operation/pom.xml index 4d52619b7..719d5fd24 100644 --- a/webfx-stack-ui-operation/pom.xml +++ b/webfx-stack-ui-operation/pom.xml @@ -27,6 +27,12 @@ provided + + dev.webfx + webfx-extras-util-control + 0.1.0-SNAPSHOT + + dev.webfx webfx-kit-util diff --git a/webfx-stack-ui-operation/src/main/java/dev/webfx/stack/ui/operation/OperationUtil.java b/webfx-stack-ui-operation/src/main/java/dev/webfx/stack/ui/operation/OperationUtil.java index 0deb82f94..d2beb5692 100644 --- a/webfx-stack-ui-operation/src/main/java/dev/webfx/stack/ui/operation/OperationUtil.java +++ b/webfx-stack-ui-operation/src/main/java/dev/webfx/stack/ui/operation/OperationUtil.java @@ -1,12 +1,12 @@ package dev.webfx.stack.ui.operation; +import dev.webfx.extras.util.control.ControlUtil; import dev.webfx.kit.util.properties.FXProperties; import dev.webfx.platform.async.AsyncFunction; import dev.webfx.platform.async.Future; import dev.webfx.platform.uischeduler.UiScheduler; import javafx.scene.Node; import javafx.scene.control.Labeled; -import javafx.scene.control.ProgressIndicator; /** * @author Bruno Salmon @@ -48,9 +48,7 @@ private static void setWaitMode(boolean on, Labeled... buttons) { Node graphic = null; if (button == buttons[0]) { if (on) { - ProgressIndicator progressIndicator = new ProgressIndicator(); - progressIndicator.setPrefSize(20, 20); // Note setMaxSize() doesn't work with WebFX but setPrefSize() does - graphic = progressIndicator; + graphic = ControlUtil.createProgressIndicator(20); // Memorising the previous graphic before changing it button.getProperties().put("webfx-operation-util-graphic", button.getGraphic()); } else { diff --git a/webfx-stack-ui-operation/src/main/java/module-info.java b/webfx-stack-ui-operation/src/main/java/module-info.java index ce97e7869..367c34a3b 100644 --- a/webfx-stack-ui-operation/src/main/java/module-info.java +++ b/webfx-stack-ui-operation/src/main/java/module-info.java @@ -5,6 +5,7 @@ // Direct dependencies modules requires javafx.controls; requires javafx.graphics; + requires webfx.extras.util.control; requires webfx.kit.util; requires webfx.platform.async; requires webfx.platform.uischeduler; diff --git a/webfx-stack-ui-validation/pom.xml b/webfx-stack-ui-validation/pom.xml index 9d625dd07..1014ed9ea 100644 --- a/webfx-stack-ui-validation/pom.xml +++ b/webfx-stack-ui-validation/pom.xml @@ -33,6 +33,44 @@ provided + + dev.webfx + webfx-extras-imagestore + 0.1.0-SNAPSHOT + + + + dev.webfx + webfx-extras-util-background + 0.1.0-SNAPSHOT + + + + dev.webfx + webfx-extras-util-border + 0.1.0-SNAPSHOT + + + + dev.webfx + webfx-extras-util-scene + 0.1.0-SNAPSHOT + + + + dev.webfx + webfx-kit-util + 0.1.0-SNAPSHOT + + + + dev.webfx + webfx-platform-javabase-emul-j2cl + 0.1.0-SNAPSHOT + runtime + true + + dev.webfx webfx-platform-javatime-emul-j2cl @@ -41,6 +79,18 @@ true + + dev.webfx + webfx-platform-uischeduler + 0.1.0-SNAPSHOT + + + + dev.webfx + webfx-platform-util + 0.1.0-SNAPSHOT + + \ No newline at end of file diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/ValidationIcons.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/ValidationIcons.java new file mode 100644 index 000000000..5ef3b7991 --- /dev/null +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/ValidationIcons.java @@ -0,0 +1,11 @@ +package dev.webfx.stack.ui.validation; + +/** + * @author Bruno Salmon + */ +final class ValidationIcons { + + public final static String validationErrorIcon16Url = "dev/webfx/stack/ui/validation/controlsfx/images/decoration-error.png"; + public final static String validationRequiredIcon16Url = "dev/webfx/stack/ui/validation/controlsfx/images/required-indicator.png"; + +} diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/ValidationSupport.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/ValidationSupport.java new file mode 100644 index 000000000..bb2f74b8b --- /dev/null +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/ValidationSupport.java @@ -0,0 +1,558 @@ +package dev.webfx.stack.ui.validation; + +import dev.webfx.extras.imagestore.ImageStore; +import dev.webfx.extras.util.background.BackgroundFactory; +import dev.webfx.extras.util.border.BorderFactory; +import dev.webfx.extras.util.scene.SceneUtil; +import dev.webfx.kit.util.properties.FXProperties; +import dev.webfx.platform.uischeduler.UiScheduler; +import dev.webfx.platform.util.collection.Collections; +import dev.webfx.stack.ui.validation.controlsfx.control.decoration.Decoration; +import dev.webfx.stack.ui.validation.controlsfx.control.decoration.GraphicDecoration; +import dev.webfx.stack.ui.validation.controlsfx.validation.decoration.GraphicValidationDecoration; +import dev.webfx.stack.ui.validation.mvvmfx.ObservableRuleBasedValidator; +import dev.webfx.stack.ui.validation.mvvmfx.ValidationMessage; +import dev.webfx.stack.ui.validation.mvvmfx.Validator; +import dev.webfx.stack.ui.validation.mvvmfx.visualization.ControlsFxVisualizer; +import javafx.application.Platform; +import javafx.beans.binding.Bindings; +import javafx.beans.property.*; +import javafx.beans.value.ObservableBooleanValue; +import javafx.beans.value.ObservableStringValue; +import javafx.beans.value.ObservableValue; +import javafx.geometry.Insets; +import javafx.geometry.Pos; +import javafx.scene.Group; +import javafx.scene.Node; +import javafx.scene.Parent; +import javafx.scene.Scene; +import javafx.scene.control.*; +import javafx.scene.layout.HBox; +import javafx.scene.layout.Pane; +import javafx.scene.layout.VBox; +import javafx.scene.paint.Color; +import javafx.scene.shape.Rectangle; +import javafx.scene.text.Font; +import javafx.scene.transform.Rotate; + +import java.time.LocalDate; +import java.time.format.DateTimeFormatter; +import java.time.format.DateTimeParseException; +import java.util.ArrayList; +import java.util.Collection; +import java.util.List; +import java.util.regex.Pattern; + +/** + * @author Bruno Salmon + */ +public final class ValidationSupport { + + private static final ObservableStringValue DEFAULT_REQUIRED_MESSAGE = new SimpleStringProperty("This field is required"); + + private final List validators = new ArrayList<>(); + private final List validatorErrorDecorationNodes = new ArrayList<>(); + private final BooleanProperty validatingProperty = new SimpleBooleanProperty(); + private Node popOverContentNode; + private Node popOverOwnerNode; + + public boolean isValid() { + validatingProperty.setValue(false); + validatingProperty.setValue(true); + Validator firstInvalidValidator = firstInvalidValidator(); + if (firstInvalidValidator != null) + Platform.runLater(() -> { + popUpOverAutoScroll = true; + showValidatorErrorPopOver(firstInvalidValidator); + }); + return firstInvalidValidator == null; + } + + public void reset() { + // This will hide the possible validation error popup and other warning icons + validatingProperty.setValue(false); + } + + public void clear() { + reset(); // hiding possible validation messages + validatorErrorDecorationNodes.forEach(this::uninstallNodeDecorator); + validatorErrorDecorationNodes.clear(); + validators.forEach(validator -> { + if (validator instanceof ObservableRuleBasedValidator) { + ((ObservableRuleBasedValidator) validator).clear(); + } + }); + validators.clear(); + } + + public boolean isEmpty() { + return validators.isEmpty(); + } + + private Validator firstInvalidValidator() { + return Collections.findFirst(validators, validator -> !validator.getValidationStatus().isValid()); + } + + public void addRequiredInputs(TextInputControl... textInputControls) { + for (TextInputControl textInputControl : textInputControls) + addRequiredInput(textInputControl); + } + + public void addRequiredInput(TextInputControl textInputControl) { + addRequiredInput(textInputControl, DEFAULT_REQUIRED_MESSAGE); + } + + public void addRequiredInput(TextInputControl textInputControl, ObservableStringValue errorMessage) { + addRequiredInput(textInputControl.textProperty(), textInputControl, errorMessage); + } + + public void addRequiredInput(ObservableValue valueProperty, Node inputNode) { + addRequiredInput(valueProperty, inputNode, DEFAULT_REQUIRED_MESSAGE); + } + + public void addRequiredInput(ObservableValue valueProperty, Node inputNode, ObservableStringValue errorMessage) { + addValidationRule(Bindings.createBooleanBinding(() -> testNotEmpty(valueProperty.getValue()), valueProperty), inputNode, errorMessage, true); + } + + private static boolean testNotEmpty(Object value) { + return value != null && (!(value instanceof String) || !((String) value).trim().isEmpty()); + } + + public ObservableBooleanValue addValidationRule(ObservableValue validProperty, Node node, ObservableStringValue errorMessage) { + return addValidationRule(validProperty, node, errorMessage, false); + } + + public ObservableBooleanValue addValidationRule(ObservableValue validProperty, Node node, ObservableStringValue errorMessageProperty, boolean required) { + ObservableRuleBasedValidator validator = new ObservableRuleBasedValidator(); + ObservableBooleanValue finalValidProperty = // when true, no decorations are displayed on the node + Bindings.createBooleanBinding(() -> + !validatingProperty.get() // no decoration displayed if not validation + || validProperty.getValue() // no decoration displayed if the node is valid + || !isShowing(node) // no decoration displayed if the node is not showing + , validProperty, validatingProperty); + ValidationMessage errorValidationMessage = ValidationMessage.error(errorMessageProperty); + validator.addRule(finalValidProperty, errorValidationMessage); + validators.add(validator); + validatorErrorDecorationNodes.add(node); + installNodeDecorator(node, validator, required); + // The following code is to remove the error message after being displayed and the user is re-typing + if (node instanceof TextInputControl) { + FXProperties.runOnPropertiesChange( + () -> { + validator.validateBooleanRule(true, errorValidationMessage); + uninstallNodeDecorator(node); + } + , ((TextInputControl) node).textProperty()); // ex of dependencies: textField.textProperty() + } + return finalValidProperty; + } + + private void installNodeDecorator(Node node, ObservableRuleBasedValidator validator, boolean required) { + if (node instanceof Control) { + Control control = (Control) node; + ControlsFxVisualizer validationVisualizer = new ControlsFxVisualizer(); + validationVisualizer.setDecoration(new GraphicValidationDecoration() { + @Override + protected Node createErrorNode() { + return ImageStore.createImageView(ValidationIcons.validationErrorIcon16Url); + } + + @Override + protected Collection createValidationDecorations(dev.webfx.stack.ui.validation.controlsfx.validation.ValidationMessage message) { + boolean isTextInput = node instanceof TextInputControl; + boolean isButton = node instanceof Button; + // isInside flag will determine if we position the decoration inside the node or not (ie outside) + boolean isInside; + if (isTextInput) // inside for text inputs + isInside = true; + else { // for others, will be generally outside unless it is stretched to full width by its container + Parent parent = node.getParent(); + while (parent instanceof Pane && !(parent instanceof VBox) && !(parent instanceof HBox)) + parent = parent.getParent(); + isInside = parent instanceof VBox && ((VBox) parent).isFillWidth(); + } + double xRelativeOffset = isInside ? -1 : 1; // positioning the decoration inside the control for button and text input + double xOffset = isInside && isButton ? -20 : 0; // moving the decoration before the drop down arrow + return java.util.Collections.singletonList( + new GraphicDecoration(createDecorationNode(message), + Pos.CENTER_RIGHT, + xOffset, + 0, + xRelativeOffset, + 0) + ); + } + + @Override + protected Collection createRequiredDecorations(Control target) { + return java.util.Collections.singletonList( + new GraphicDecoration(ImageStore.createImageView(ValidationIcons.validationRequiredIcon16Url), + Pos.CENTER_LEFT, + -10, + 0)); + } + }); + validationVisualizer.initVisualization(validator.getValidationStatus(), control, required); + node.getProperties().put("validationVisualizer", validationVisualizer); + } + } + + private void uninstallNodeDecorator(Node node) { + if (node instanceof Control) { + Control control = (Control) node; + ControlsFxVisualizer validationVisualizer = (ControlsFxVisualizer) node.getProperties().get("validationVisualizer"); + if (validationVisualizer != null) + validationVisualizer.removeDecorations(control); + } + } + + private void showValidatorErrorPopOver(Validator validator) { + int index = validators.indexOf(validator); + if (index >= 0) { + Node decorationNode = validatorErrorDecorationNodes.get(index); + if (decorationNode != null) + showValidatorErrorPopOver(validator, decorationNode); + } + } + + private void showValidatorErrorPopOver(Validator validator, Node errorDecorationNode) { + ValidationMessage errorMessage = Collections.first(validator.getValidationStatus().getErrorMessages()); + if (errorMessage != null) { + Label label = new Label(); + label.textProperty().bind(errorMessage.messageProperty()); + label.setPadding(new Insets(8)); + label.setFont(Font.font("Verdana", 11.5)); + label.setTextFill(Color.WHITE); + label.setBackground(BackgroundFactory.newBackground(Color.RED, 5, 2)); + label.setBorder(BorderFactory.newBorder(Color.WHITE, 5, 2)); + Rectangle diamond = new Rectangle(10, 10, Color.RED); + diamond.getTransforms().add(new Rotate(45, 5, 5)); + diamond.layoutYProperty().bind(FXProperties.compute(label.heightProperty(), n -> n.doubleValue() - 7)); + diamond.setLayoutX(20d); + popOverContentNode = new Group(label, diamond); + //popOverContentNode.setOpacity(0.75); + //popOverContentNode.setEffect(new DropShadow()); + showPopOver(errorDecorationNode); + // Removing the error pop over when the status is valid again + FXProperties.runOrUnregisterOnPropertyChange((thisListener, oldValue, valid) -> { + if (valid) { + thisListener.unregister(); + popOverOwnerNode = null; + hidePopOver(); + } + }, validator.getValidationStatus().validProperty()); + } + } + + private void showPopOver(Node node) { + popOverOwnerNode = node; + showPopOverNow(); + if (!node.getProperties().containsKey("popOverListen")) { + node.getProperties().put("popOverListen", true); + node.sceneProperty().addListener(observable -> { + if (popOverOwnerNode == node) { + showPopOverNow(); + } + }); + node.parentProperty().addListener(observable -> { + if (popOverOwnerNode == node) { + showPopOverNow(); + } + }); + } + } + + public void addEmailValidation(TextField emailInput, Node where, ObservableStringValue errorMessage) { + // Define the email pattern + String emailPattern = "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,6}$"; + Pattern pattern = Pattern.compile(emailPattern); + // Create the validation rule + addValidationRule( + Bindings.createBooleanBinding( + () -> pattern.matcher(emailInput.getText()).matches(), + emailInput.textProperty() + ), + where, + errorMessage + ); + } + + public void addEmailNotEqualValidation(TextField emailInput, String forbiddenValue, Node where, ObservableStringValue errorMessage) { + // Create the validation rule + addValidationRule( + Bindings.createBooleanBinding( + () -> !emailInput.getText().equalsIgnoreCase(forbiddenValue), + emailInput.textProperty() + ), + where, + errorMessage + ); + } + + public void addUrlValidation(TextField urlInput, Node where, ObservableStringValue errorMessage) { + // Define the URL pattern (basic) + String urlPattern = "^(https?://)(www\\.)?[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,6}(/.*)?$"; + Pattern pattern = Pattern.compile(urlPattern); + + addValidationRule( + Bindings.createBooleanBinding( + () -> { + String input = urlInput.getText(); + return input!=null && pattern.matcher(input).matches(); // Accept empty or valid URL + }, + urlInput.textProperty() + ), + where, + errorMessage + ); + } + + public void addMinimumDurationValidation(TextField timeInput, Node where, ObservableStringValue errorMessage) { + addValidationRule( + Bindings.createBooleanBinding( + () -> { + try { + String input = timeInput.getText(); + if (input == null || input.isEmpty()) return true; // Allow empty input + int value = Integer.parseInt(input); // Try to parse the input to an integer + return value >= 60; // Validate if the integer is at least 60 + } catch (NumberFormatException e) { + return false; // Invalid if input is not a valid integer + } + }, + timeInput.textProperty() + ), + where, + errorMessage + ); + } + + + public void addUrlOrEmptyValidation(TextField urlInput, ObservableStringValue errorMessage) { + // Define the URL pattern (basic) + String urlPattern = "^(https?|srt|rtmp|rtsp)://[\\w.-]+(:\\d+)?(/[\\w./-]*)?(\\?[\\w=&%.-]*)?(#[\\w!:.=&,-]*)?$"; + Pattern pattern = Pattern.compile(urlPattern); + + // Create the validation rule + addValidationRule( + Bindings.createBooleanBinding( + () -> { + String input = urlInput.getText(); + return input.isEmpty() || pattern.matcher(input).matches(); // Accept empty or valid URL + }, + urlInput.textProperty() + ), + urlInput, + errorMessage + ); + } + + public void addNonEmptyValidation(TextField textField, Node where, ObservableStringValue errorMessage) { + // Create the validation rule + addValidationRule( + Bindings.createBooleanBinding( + () -> !textField.getText().trim().isEmpty(), + textField.textProperty() + ), + where, + errorMessage); + } + + public void addDateValidation(TextField textField,String dateFormat, Node where, ObservableStringValue errorMessage) { + DateTimeFormatter dateFormatter = DateTimeFormatter.ofPattern(dateFormat); + // Create the validation rule + addValidationRule( + Bindings.createBooleanBinding(() -> { + try { + dateFormatter.parse(textField.getText().trim()); + return true; + } catch (DateTimeParseException e) { + return false; + }}, textField.textProperty()), + where, + errorMessage + ); + } + + public void addDateOrEmptyValidation(TextField textField, String dateFormat, Node where, ObservableStringValue errorMessage) { + DateTimeFormatter dateFormatter = DateTimeFormatter.ofPattern(dateFormat); + + // Create the validation rule + addValidationRule( + Bindings.createBooleanBinding(() -> { + String input = textField.getText().trim(); + // Allow empty input to be valid + if (input.isEmpty()) { + return true; + } + try { + dateFormatter.parse(input); + return true; // Input is valid if it can be parsed + } catch (DateTimeParseException e) { + return false; // Invalid date format + } + }, textField.textProperty()), + where, + errorMessage + ); + } + + public void addIntegerValidation(TextField textField, Node where, ObservableStringValue errorMessage) { + // Create the validation rule + addValidationRule( + Bindings.createBooleanBinding(() -> { + try { + // Try to parse the text as an integer + Integer.parseInt(textField.getText().trim()); + return true; + } catch (NumberFormatException e) { + return false; + } + }, textField.textProperty()), + where, + errorMessage + ); + } + + public void addLegalAgeValidation(TextField textField, String dateFormat, int legalAge, Node where, ObservableStringValue errorMessage) { + DateTimeFormatter dateFormatter = DateTimeFormatter.ofPattern(dateFormat); + // Create the validation rule + addValidationRule( + Bindings.createBooleanBinding(() -> { + try { + LocalDate birthDate = LocalDate.parse(textField.getText().trim(), dateFormatter); + LocalDate now = LocalDate.now(); + return birthDate.plusYears(legalAge).isBefore(now) || birthDate.plusYears(legalAge).isEqual(now); + } catch (DateTimeParseException e) { + return false; + } + }, textField.textProperty()), + where, + errorMessage + ); + } + + public void addPasswordMatchValidation(TextField passwordField, TextField repeatPasswordField, ObservableStringValue errorMessageProperty) { + addValidationRule( + Bindings.createBooleanBinding( + () -> passwordField.getText().equals(repeatPasswordField.getText()), + passwordField.textProperty(), + repeatPasswordField.textProperty() + ), + repeatPasswordField, + errorMessageProperty, + true + ); + } + + public void addPasswordStrengthValidation(TextField passwordField, ObservableStringValue errorMessage) { + addValidationRule( + Bindings.createBooleanBinding( + () -> checkPasswordStrength(passwordField.getText()), + passwordField.textProperty() + ), + passwordField, + errorMessage, + true + ); + } + /** + * Checks if a password meets strength requirements. + * @param password the password to validate. + * @return true if the password meets the requirements, false otherwise. + */ + private boolean checkPasswordStrength(String password) { + if (password == null || password.isEmpty()) { + return false; + } + // Minimum length + if (password.length() < 8) { + return false; + } + // Contains at least one uppercase letter + if (!password.matches(".*[A-Z].*")) { + return false; + } + // Contains at least one lowercase letter + if (!password.matches(".*[a-z].*")) { + return false; + } + // Contains at least one digit + if (!password.matches(".*\\d.*")) { + return false; + } + // Contains at least one special character + if (!password.matches(".*[@#$%^&+=!().,*?-].*")) { + return false; + } + return true; + } + +/* + private PopOver popOver; + private void showPopOverNow() { + if (popOver != null && popOver.getOwnerNode() != popOverOwnerNode) { + popOver.hide(); + popOver = null; + } + if (popOver == null && isShowing(popOverOwnerNode)) { + popOver = new PopOver(); + popOver.setContentNode(popOverContentNode); + popOver.setArrowLocation(PopOver.ArrowLocation.BOTTOM_LEFT); + //Platform.runLater(() -> { + popOver.show(popOverOwnerNode, -(popOverOwnerNode instanceof ImageView ? ((ImageView) popOverOwnerNode).getImage().getHeight() : 0) + 4); + //}); + } + } +*/ + + private GraphicDecoration popOverDecoration; + private Node popOverDecorationTarget; + private boolean popUpOverAutoScroll; + + private void showPopOverNow() { + Platform.runLater(() -> { + hidePopOver(); + if (isShowing(popOverOwnerNode)) { + popOverDecorationTarget = popOverOwnerNode; + popOverDecoration = new GraphicDecoration(popOverContentNode, 0, -1, 0, -1); + popOverDecoration.applyDecoration(popOverDecorationTarget); + if (popUpOverAutoScroll) { + SceneUtil.scrollNodeToBeVerticallyVisibleOnScene(popOverDecorationTarget); + SceneUtil.autoFocusIfEnabled(popOverOwnerNode); + popUpOverAutoScroll = false; + } + } + }); + } + + private void hidePopOver() { + UiScheduler.runInUiThread(() -> { + if (popOverDecoration != null) { + popOverDecoration.removeDecoration(popOverDecorationTarget); + popOverDecoration = null; + } + }); + } + + private static boolean isShowing(Node node) { + if (node == null || !node.isVisible()) + return false; + Parent parent = node.getParent(); + if (parent != null) + return isShowing(parent); + Scene scene = node.getScene(); + return scene != null && scene.getRoot() == node; + } + + public void addPasswordValidation(TextField passwordInput, Label passwordLabel, ObservableStringValue errorMessage) { + addValidationRule( + Bindings.createBooleanBinding( + () -> passwordInput.getText().length() >= 8, + passwordInput.textProperty() + ), + passwordLabel, + errorMessage + ); + } +} diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ValidationSupport.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ControlsFxValidationSupport.java similarity index 99% rename from webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ValidationSupport.java rename to webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ControlsFxValidationSupport.java index e6c9d2396..ac68b6876 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ValidationSupport.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ControlsFxValidationSupport.java @@ -76,7 +76,7 @@ * * */ -public class ValidationSupport { +public class ControlsFxValidationSupport { private static final String CTRL_REQUIRED_FLAG = "$org.controlsfx.validation.required$"; //$NON-NLS-1$ @@ -111,7 +111,7 @@ public static boolean isRequired( Control c ) { * Creates validation support instance. * If initial decoration is desired invoke {@link #initInitialDecoration()}. */ - public ValidationSupport() { + public ControlsFxValidationSupport() { validationResultProperty().addListener( (o, oldValue, validationResult) -> { invalidProperty.set(!validationResult.getErrors().isEmpty()); diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ValidationMessage.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ValidationMessage.java index 45b699d6f..3ad4a0edb 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ValidationMessage.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ValidationMessage.java @@ -35,28 +35,24 @@ */ public interface ValidationMessage extends Comparable{ - public static final Comparator COMPARATOR = new Comparator() { - - @Override - public int compare(ValidationMessage vm1, ValidationMessage vm2) { - if ( vm1 == vm2 ) return 0; - if ( vm1 == null) return 1; - if ( vm2 == null) return -1; - return vm1.compareTo(vm2); - } - }; + Comparator COMPARATOR = (vm1, vm2) -> { + if ( vm1 == vm2 ) return 0; + if ( vm1 == null) return 1; + if ( vm2 == null) return -1; + return vm1.compareTo(vm2); + }; /** * Message text * @return message text */ - public String getText(); + String getText(); /** * Message {@link Severity} * @return message severity */ - public Severity getSeverity(); + Severity getSeverity(); /** @@ -71,7 +67,7 @@ public int compare(ValidationMessage vm1, ValidationMessage vm2) { * @param text message text * @return error message */ - public static ValidationMessage error(Control target, String text) { + static ValidationMessage error(Control target, String text) { return new SimpleValidationMessage(target, text, Severity.ERROR); } @@ -81,11 +77,11 @@ public static ValidationMessage error(Control target, String text) { * @param text message text * @return warning message */ - public static ValidationMessage warning(Control target, String text) { + static ValidationMessage warning(Control target, String text) { return new SimpleValidationMessage(target, text, Severity.WARNING); } - @Override default public int compareTo(ValidationMessage msg) { + @Override default int compareTo(ValidationMessage msg) { return msg == null || getTarget() != msg.getTarget() ? -1: getSeverity().compareTo(msg.getSeverity()); } } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/decoration/AbstractValidationDecoration.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/decoration/AbstractValidationDecoration.java index a2011dd5d..8a9685232 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/decoration/AbstractValidationDecoration.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/decoration/AbstractValidationDecoration.java @@ -1,18 +1,18 @@ /** * Copyright (c) 2014, 2015, ControlsFX * All rights reserved. - * + * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: - * * Redistributions of source code must retain the above copyright + * * Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. - * * Redistributions in binary form must reproduce the above copyright + * * Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. - * * Neither the name of ControlsFX, any associated website, nor the + * * Neither the name of ControlsFX, any associated website, nor the * names of its contributors may be used to endorse or promote products * derived from this software without specific prior written permission. - * + * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE @@ -30,7 +30,7 @@ import dev.webfx.stack.ui.validation.controlsfx.control.decoration.Decorator; import dev.webfx.stack.ui.validation.controlsfx.validation.ValidationMessage; import javafx.scene.control.Control; -import dev.webfx.stack.ui.validation.controlsfx.validation.ValidationSupport; +import dev.webfx.stack.ui.validation.controlsfx.validation.ControlsFxValidationSupport; import java.util.Collection; import java.util.List; @@ -42,67 +42,69 @@ * how 'validation' and 'required' decorations should be created * * See {@link GraphicValidationDecoration} for examples of such implementations. - * + * */ public abstract class AbstractValidationDecoration implements ValidationDecoration { - - private static final String VALIDATION_DECORATION = "$org.controlsfx.decoration.vaidation$"; //$NON-NLS-1$ - - private static boolean isValidationDecoration( Decoration decoration) { + + private static final String VALIDATION_DECORATION = "$org.controlsfx.decoration.validation$"; //$NON-NLS-1$ + + private static boolean isValidationDecoration(Decoration decoration) { return decoration != null && decoration.getProperties().get(VALIDATION_DECORATION) == Boolean.TRUE; } - private static void setValidationDecoration( Decoration decoration ) { - if ( decoration != null ) { + private static void setValidationDecoration(Decoration decoration) { + if (decoration != null) { decoration.getProperties().put(VALIDATION_DECORATION, Boolean.TRUE); } } - protected abstract Collection createValidationDecorations(ValidationMessage message); - protected abstract Collection createRequiredDecorations(Control target); - - /** - * Removes all validation related decorations from the target - * @param target control - */ - @Override - public void removeDecorations(Control target) { - List decorations = Decorator.getDecorations(target); - if ( decorations != null ) { - // conversion to array is a trick to prevent concurrent modification exception - for ( Decoration d: Decorator.getDecorations(target).toArray(new Decoration[0]) ) { - if (isValidationDecoration(d)) Decorator.removeDecoration(target, d); + protected abstract Collection createValidationDecorations(ValidationMessage message); + + protected abstract Collection createRequiredDecorations(Control target); + + /** + * Removes all validation related decorations from the target + * @param target control + */ + @Override + public void removeDecorations(Control target) { + List decorations = Decorator.getDecorations(target); + if (decorations != null) { + // conversion to array is a trick to prevent concurrent modification exception + for (Decoration d : Decorator.getDecorations(target).toArray(new Decoration[0])) { + if (isValidationDecoration(d)) + Decorator.removeDecoration(target, d); } } - } - - /* - * (non-Javadoc) - * @see org.controlsfx.validation.decorator.ValidationDecorator#applyValidationDecoration(org.controlsfx.validation.ValidationMessage) - */ - @Override - public void applyValidationDecoration(ValidationMessage message) { - //createValidationDecorations(message).stream().forEach( d -> decorate( message.getTarget(), d )); // stream don't work on Android - for (Decoration decoration : createValidationDecorations(message)) - decorate(message.getTarget(), decoration); - } + } + + /* + * (non-Javadoc) + * @see org.controlsfx.validation.decorator.ValidationDecorator#applyValidationDecoration(org.controlsfx.validation.ValidationMessage) + */ + @Override + public void applyValidationDecoration(ValidationMessage message) { + //createValidationDecorations(message).stream().forEach( d -> decorate( message.getTarget(), d )); // stream don't work on Android + for (Decoration decoration : createValidationDecorations(message)) + decorate(message.getTarget(), decoration); + } - /* - * (non-Javadoc) - * @see org.controlsfx.validation.decorator.ValidationDecorator#applyRequiredDecoration(javafx.scene.control.Control) - */ - @Override - public void applyRequiredDecoration(Control target) { - if ( ValidationSupport.isRequired(target)) { - // createRequiredDecorations(target).stream().forEach( d -> decorate( target, d )); // stream don't work on Android - for (Decoration decoration : createRequiredDecorations(target)) - decorate(target, decoration); - } - } - - private void decorate( Control target, Decoration d ) { - setValidationDecoration(d); // mark as validation specific decoration + /* + * (non-Javadoc) + * @see org.controlsfx.validation.decorator.ValidationDecorator#applyRequiredDecoration(javafx.scene.control.Control) + */ + @Override + public void applyRequiredDecoration(Control target) { + if (ControlsFxValidationSupport.isRequired(target)) { + // createRequiredDecorations(target).stream().forEach( d -> decorate( target, d )); // stream don't work on Android + for (Decoration decoration : createRequiredDecorations(target)) + decorate(target, decoration); + } + } + + private void decorate(Control target, Decoration d) { + setValidationDecoration(d); // mark as validation specific decoration Decorator.addDecoration(target, d); - } + } } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ObservableRuleBasedValidator.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ObservableRuleBasedValidator.java index 8b5cb2aae..e72274e28 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ObservableRuleBasedValidator.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ObservableRuleBasedValidator.java @@ -15,6 +15,8 @@ ******************************************************************************/ package dev.webfx.stack.ui.validation.mvvmfx; +import dev.webfx.kit.util.properties.FXProperties; +import dev.webfx.kit.util.properties.Unregisterable; import javafx.beans.value.ObservableValue; import java.util.ArrayList; @@ -32,7 +34,7 @@ * * * Boolean Rules of type ObservableValue<Boolean> - * + * * The first variant uses an {@link ObservableValue} together with a static message. If this observable * has a value of false the validation status will be "invalid" and the given message will be present in the {@link ValidationStatus} * of this validator. @@ -40,35 +42,27 @@ * * * Complex Rules of type ObservableValue<ValidationMessage> - * + * * The second variant allows more complex rules. It uses a {@link ObservableValue} as rule. * If this observable has a value other then null it is considered to be invalid. The {@link ValidationMessage} * value will be present in the {@link ValidationStatus} of this validator. * * - * + * * You can add multiple rules via the {@link #addRule(ObservableValue, ValidationMessage)} and {@link #addRule(ObservableValue)} method. * If multiple rules are violated, each message will be present. */ public class ObservableRuleBasedValidator implements Validator { - /* - These lists are used to store the rules that this validator is working with. - The reason for this is to prevent problems with garbage collection. - If the validator wouldn't keep references to all given rules it would be possible that they are - removed by the garbage collector which would result in wrong validation results. - To prevent this we store references to all given rules here. - Don't get confused by the fact that no values are only added to these lists but not obtained. - */ - private List> booleanRules = new ArrayList<>(); - private List> complexRules = new ArrayList<>(); - - private ValidationStatus validationStatus = new ValidationStatus(); + private final List unregisterableRules = new ArrayList<>(); + + private final ValidationStatus validationStatus = new ValidationStatus(); /** * Creates an instance of the Validator without any rules predefined. */ - public ObservableRuleBasedValidator() {} + public ObservableRuleBasedValidator() { + } /** * Creates an instance of the Validator with the given rule predefined. @@ -86,50 +80,49 @@ public ObservableRuleBasedValidator(ObservableValue rule, ValidationMes * Creates an instance of the Validator with the given complex rules predefined. * It's a shortcut for creating an empty validator and * adding one or multiple complex rules with {@link #addRule(ObservableValue)}. + * * @param rules */ - public ObservableRuleBasedValidator(ObservableValue ... rules) { + public ObservableRuleBasedValidator(ObservableValue... rules) { for (ObservableValue rule : rules) { addRule(rule); } } - /** - * Add a rule for this validator. - * - * The rule defines a condition that has to be fulfilled. - * - * A rule is defined by an observable boolean value. If the rule has a value of true the rule is - * "fulfilled". If the rule has a value of false the rule is violated. In this case the given message - * object will be added to the status of this validator. - * - * There are some predefined rules for common use cases in the {@link ObservableRules} class that can be used. - * - * @param rule - * @param message - */ - public void addRule(ObservableValue rule, ValidationMessage message) { - booleanRules.add(rule); - - rule.addListener((observable, oldValue, newValue) -> { - validateBooleanRule(newValue, message); - }); - - validateBooleanRule(rule.getValue(), message); - } - - private void validateBooleanRule(boolean isValid, ValidationMessage message) { - if (isValid) { - validationStatus.removeMessage(message); - } else { - validationStatus.addMessage(message); - } - } - - @Override - public ValidationStatus getValidationStatus() { - return validationStatus; - } + /** + * Add a rule for this validator. + * + * The rule defines a condition that has to be fulfilled. + * + * A rule is defined by an observable boolean value. If the rule has a value of true the rule is + * "fulfilled". If the rule has a value of false the rule is violated. In this case the given message + * object will be added to the status of this validator. + * + * There are some predefined rules for common use cases in the {@link ObservableRules} class that can be used. + * + * @param validProperty + * @param message + */ + public void addRule(ObservableValue validProperty, ValidationMessage message) { + unregisterableRules.add( + FXProperties.runNowAndOnPropertyChange((observable, oldValue, newValue) -> + validateBooleanRule(newValue, message) + , validProperty) + ); + } + + public void validateBooleanRule(boolean isValid, ValidationMessage message) { + if (isValid) { + hideMessage(message); + } else { + showMessage(message); + } + } + + @Override + public ValidationStatus getValidationStatus() { + return validationStatus; + } /** * Add a complex rule for this validator. @@ -140,26 +133,37 @@ public ValidationStatus getValidationStatus() { * If the observable doesn't contain a value (in other words it contains null) the rule is considered to * be fulfilled and the validation status of this validator will be valid (given that no other rule is violated). * - * - * This method allows some more complex rules compared to {@link #addRule(ObservableValue, ValidationMessage)}. - * This way you can define rules that have different messages for specific cases. + * + * This method allows some more complex rules compared to {@link #addRule(ObservableValue, ValidationMessage)}. + * This way you can define rules that have different messages for specific cases. * * @param rule */ public void addRule(ObservableValue rule) { - complexRules.add(rule); - - rule.addListener((observable, oldValue, newValue) -> { - if(oldValue != null) { - validationStatus.removeMessage(oldValue); - } - if(newValue != null) { - validationStatus.addMessage(newValue); - } - }); - - if(rule.getValue() != null) { - validationStatus.addMessage(rule.getValue()); + unregisterableRules.add( + FXProperties.runNowAndOnPropertyChange((observable, oldValue, newValue) -> { + hideMessage(oldValue); // does nothing if oldValue is null + showMessage(newValue); // does nothing if newValue is null + }, rule) + ); + } + + private void showMessage(ValidationMessage message) { + if (message != null) { + validationStatus.addMessage(message); + } + } + + private void hideMessage(ValidationMessage message) { + if (message != null) { + validationStatus.removeMessage(message); } } + + public void clear() { + unregisterableRules.forEach(Unregisterable::unregister); + unregisterableRules.clear(); + validationStatus.clearMessages(); + } + } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java index 57c3b90e3..9ece55d7b 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java @@ -15,6 +15,8 @@ ******************************************************************************/ package dev.webfx.stack.ui.validation.mvvmfx; +import javafx.beans.value.ObservableStringValue; + import java.util.Objects; /** @@ -25,26 +27,30 @@ */ public class ValidationMessage { - private final String message; + private final ObservableStringValue messageProperty; private final Severity severity; - public ValidationMessage(Severity severity, String message) { + public ValidationMessage(Severity severity, ObservableStringValue messageProperty) { this.severity = Objects.requireNonNull(severity); - this.message = Objects.requireNonNull(message); + this.messageProperty = Objects.requireNonNull(messageProperty); } - public static ValidationMessage warning(String message) { - return new ValidationMessage(Severity.WARNING, message); + public static ValidationMessage warning(ObservableStringValue messageProperty) { + return new ValidationMessage(Severity.WARNING, messageProperty); } - public static ValidationMessage error(String message) { - return new ValidationMessage(Severity.ERROR, message); + public static ValidationMessage error(ObservableStringValue messageProperty) { + return new ValidationMessage(Severity.ERROR, messageProperty); } + public ObservableStringValue messageProperty() { + return messageProperty; + } + public String getMessage() { - return message; + return messageProperty.get(); } public Severity getSeverity() { @@ -54,27 +60,27 @@ public Severity getSeverity() { @Override public String toString() { return "ValidationMessage{" + - "message='" + message + '\'' + - ", severity=" + severity + - '}'; + "messageProperty='" + messageProperty + '\'' + + ", severity=" + severity + + '}'; } @Override public boolean equals(Object o) { if (this == o) return true; - if (o == null || !(o instanceof ValidationMessage)) + if (!(o instanceof ValidationMessage)) return false; ValidationMessage that = (ValidationMessage) o; - return message.equals(that.message) && severity == that.severity; + return messageProperty.equals(that.messageProperty) && severity == that.severity; } @Override public int hashCode() { - int result = message.hashCode(); + int result = messageProperty.hashCode(); result = 31 * result + severity.hashCode(); return result; } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java index d1f82602e..82d4062fb 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java @@ -37,11 +37,11 @@ */ public class ValidationStatus { - private ListProperty messages = new SimpleListProperty<>(FXCollections.observableArrayList()); + private final ListProperty messages = new SimpleListProperty<>(FXCollections.observableArrayList()); - private ObservableList unmodifiableMessages = FXCollections.unmodifiableObservableList(messages); - private ObservableList errorMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.ERROR)); - private ObservableList warningMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.WARNING)); + private final ObservableList unmodifiableMessages = FXCollections.unmodifiableObservableList(messages); + private final ObservableList errorMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.ERROR)); + private final ObservableList warningMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.WARNING)); /** * Intended for subclasses used by special validator implementations. diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java index a3e093bd9..6ede92357 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java @@ -17,7 +17,7 @@ import dev.webfx.stack.ui.validation.mvvmfx.Severity; import dev.webfx.stack.ui.validation.mvvmfx.ValidationMessage; -import dev.webfx.stack.ui.validation.controlsfx.validation.ValidationSupport; +import dev.webfx.stack.ui.validation.controlsfx.validation.ControlsFxValidationSupport; import dev.webfx.stack.ui.validation.controlsfx.validation.decoration.GraphicValidationDecoration; import dev.webfx.stack.ui.validation.controlsfx.validation.decoration.ValidationDecoration; import javafx.scene.control.Control; @@ -52,7 +52,7 @@ public void setDecoration(ValidationDecoration decoration) { @Override void applyRequiredVisualization(Control control, boolean required) { - ValidationSupport.setRequired(control, required); + ControlsFxValidationSupport.setRequired(control, required); if (required) { decoration.applyRequiredDecoration(control); } @@ -74,12 +74,14 @@ void applyVisualization(Control control, Optional messageOpti } } else { - decoration.removeDecorations(control); - } - - if (required) { - decoration.applyRequiredDecoration(control); + removeDecorations(control); } + + applyRequiredVisualization(control, required); + } + + @Override + public void removeDecorations(Control control) { + decoration.removeDecorations(control); } - } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java index 4b6d33d41..447baca68 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java @@ -15,11 +15,12 @@ ******************************************************************************/ package dev.webfx.stack.ui.validation.mvvmfx.visualization; +import dev.webfx.kit.util.properties.FXProperties; +import dev.webfx.kit.util.properties.ObservableLists; +import dev.webfx.platform.uischeduler.UiScheduler; import dev.webfx.stack.ui.validation.mvvmfx.Severity; import dev.webfx.stack.ui.validation.mvvmfx.ValidationMessage; import dev.webfx.stack.ui.validation.mvvmfx.ValidationStatus; -import javafx.application.Platform; -import javafx.collections.ListChangeListener; import javafx.scene.control.Control; import java.util.Optional; @@ -42,20 +43,13 @@ public abstract class ValidationVisualizerBase implements ValidationVisualizer { @Override public void initVisualization(final ValidationStatus result, final Control control, boolean required) { if (control.getSkin() == null) { - control.skinProperty().addListener((observable, oldValue, newValue) -> initVisualization(result, control, required)); + FXProperties.onPropertySet(control.skinProperty(), skin -> initVisualization(result, control, required)); return; } - if (required) { - applyRequiredVisualization(control, required); - } - - applyVisualization(control, result.getHighestMessage(), required); - - result.getMessages().addListener((ListChangeListener) c -> { - while (c.next()) { - Platform.runLater(() -> applyVisualization(control, result.getHighestMessage(), required)); - } - }); + + ObservableLists.runNowAndOnListChange(c -> UiScheduler.runInUiThread(() -> + applyVisualization(control, result.getHighestMessage(), required) + ), result.getMessages()); } /** @@ -93,5 +87,7 @@ public void initVisualization(final ValidationStatus result, final Control contr * a boolean flag indicating whether this control is mandatory or not. */ abstract void applyVisualization(Control control, Optional messageOptional, boolean required); + + public abstract void removeDecorations(Control control); } diff --git a/webfx-stack-ui-validation/src/main/java/module-info.java b/webfx-stack-ui-validation/src/main/java/module-info.java index 9aca87547..b37e66d92 100644 --- a/webfx-stack-ui-validation/src/main/java/module-info.java +++ b/webfx-stack-ui-validation/src/main/java/module-info.java @@ -6,8 +6,16 @@ requires javafx.base; requires javafx.controls; requires javafx.graphics; + requires webfx.extras.imagestore; + requires webfx.extras.util.background; + requires webfx.extras.util.border; + requires webfx.extras.util.scene; + requires webfx.kit.util; + requires webfx.platform.uischeduler; + requires webfx.platform.util; // Exported packages + exports dev.webfx.stack.ui.validation; exports dev.webfx.stack.ui.validation.controlsfx.control.decoration; exports dev.webfx.stack.ui.validation.controlsfx.impl; exports dev.webfx.stack.ui.validation.controlsfx.impl.skin;
Unregisterable bindChildrenToActionGroup(P parent, ActionGroup actionGroup, Converter nodeFactory) { + return bindChildrenToActionGroup(parent.getChildren(), actionGroup, nodeFactory); } - public static ObservableList bindChildrenToActionGroup(ObservableList children, ActionGroup actionGroup, Converter nodeFactory) { - ObservableLists.bindConverted(children, actionGroup.getVisibleActions(), nodeFactory); - return children; + public static Unregisterable bindChildrenToActionGroup(ObservableList children, ActionGroup actionGroup, Converter nodeFactory) { + return ObservableLists.bindConverted(children, actionGroup.getVisibleActions(), nodeFactory); } } diff --git a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionBuilder.java b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionBuilder.java index 9575ff494..904e1eb90 100644 --- a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionBuilder.java +++ b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionBuilder.java @@ -1,17 +1,20 @@ package dev.webfx.stack.ui.action; +import dev.webfx.kit.util.properties.FXProperties; +import dev.webfx.stack.i18n.I18n; +import dev.webfx.stack.ui.json.JsonImageView; import javafx.beans.binding.BooleanExpression; import javafx.beans.property.SimpleBooleanProperty; import javafx.beans.property.SimpleObjectProperty; import javafx.beans.property.SimpleStringProperty; import javafx.beans.value.ObservableBooleanValue; -import javafx.beans.value.ObservableObjectValue; import javafx.beans.value.ObservableStringValue; +import javafx.beans.value.ObservableValue; import javafx.event.ActionEvent; import javafx.event.EventHandler; import javafx.scene.Node; -import dev.webfx.stack.i18n.I18n; -import dev.webfx.stack.ui.json.JsonImageView; + +import java.util.function.Supplier; /** * @author Bruno Salmon @@ -24,8 +27,8 @@ public class ActionBuilder { private String text; private Object i18nKey; - private ObservableObjectValue graphicProperty; - private Node graphic; + private ObservableValue> graphicFactoryProperty; + private Supplier graphicFactory; private Object graphicUrlOrJson; private ObservableBooleanValue disabledProperty; @@ -39,6 +42,8 @@ public class ActionBuilder { private EventHandler actionHandler; + private Object userData; + private ActionBuilderRegistry registry; public ActionBuilder() { @@ -48,6 +53,18 @@ public ActionBuilder(Object actionKey) { this.actionKey = actionKey; } + public ActionBuilder(Action action) { + setTextProperty(action.textProperty()); + setText(action.getText()); + setGraphicFactoryProperty(action.graphicFactoryProperty()); + setGraphicFactory(action.getGraphicFactory()); + setDisabledProperty(action.disabledProperty()); + setVisibleProperty(action.visibleProperty()); + setActionHandler(action); + setUserData(action.getUserData()); + //setHiddenWhenDisabled(visibleProperty == disabledProperty || visibleProperty instanceof BooleanBinding && ((BooleanBinding) visibleProperty).getDependencies().contains(disabledProperty)); + } + public Object getActionKey() { return actionKey; } @@ -84,21 +101,21 @@ public ActionBuilder setI18nKey(Object i18nKey) { return this; } - public ObservableObjectValue getGraphicProperty() { - return graphicProperty; + public ObservableValue> getGraphicFactoryProperty() { + return graphicFactoryProperty; } - public ActionBuilder setGraphicProperty(ObservableObjectValue graphicProperty) { - this.graphicProperty = graphicProperty; + public ActionBuilder setGraphicFactoryProperty(ObservableValue> graphicFactoryProperty) { + this.graphicFactoryProperty = graphicFactoryProperty; return this; } - public Node getGraphic() { - return graphic; + public Supplier getGraphicFactory() { + return graphicFactory; } - public ActionBuilder setGraphic(Node graphic) { - this.graphic = graphic; + public ActionBuilder setGraphicFactory(Supplier graphicFactory) { + this.graphicFactory = graphicFactory; return this; } @@ -169,6 +186,15 @@ public ActionBuilder setActionHandler(Runnable actionHandler) { return setActionHandler(e -> actionHandler.run()); } + public Object getUserData() { + return userData; + } + + public ActionBuilder setUserData(Object userData) { + this.userData = userData; + return this; + } + public ActionBuilder setRegistry(ActionBuilderRegistry registry) { this.registry = registry; return this; @@ -184,8 +210,8 @@ public ActionBuilder duplicate() { .setTextProperty(textProperty) .setText(text) .setI18nKey(i18nKey) - .setGraphicProperty(graphicProperty) - .setGraphic(graphic) + .setGraphicFactoryProperty(graphicFactoryProperty) + .setGraphicFactory(graphicFactory) .setGraphicUrlOrJson(graphicUrlOrJson) .setDisabledProperty(disabledProperty) .setVisibleProperty(visibleProperty) @@ -209,7 +235,9 @@ public ActionBuilder removeText() { public Action build() { completePropertiesForBuild(); - return Action.create(textProperty, graphicProperty, disabledProperty, visibleProperty, actionHandler); + Action action = Action.create(textProperty, graphicFactoryProperty, disabledProperty, visibleProperty, actionHandler); + action.setUserData(userData); + return action; } void completePropertiesForBuild() { @@ -229,13 +257,14 @@ private void completeTextProperty() { } private void completeGraphicProperty() { - if (graphicProperty == null) { - if (graphic == null && graphicUrlOrJson != null) - graphic = JsonImageView.createImageView(graphicUrlOrJson); - if (graphic != null || i18nKey == null) - graphicProperty = new SimpleObjectProperty<>(graphic); + if (graphicFactoryProperty == null) { + if (graphicFactory == null && graphicUrlOrJson != null) + graphicFactory = () -> JsonImageView.createImageView(graphicUrlOrJson); + if (graphicFactory != null || i18nKey == null) + graphicFactoryProperty = new SimpleObjectProperty<>(graphicFactory); else - graphicProperty = I18n.i18nGraphicProperty(i18nKey); + graphicFactoryProperty = FXProperties.compute(I18n.dictionaryProperty(), dictionary -> + () -> I18n.getI18nGraphic(i18nKey)); } } diff --git a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionGroup.java b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionGroup.java index 438acab5a..71838eb4a 100644 --- a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionGroup.java +++ b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionGroup.java @@ -2,14 +2,15 @@ import dev.webfx.stack.ui.action.impl.ActionGroupImpl; import javafx.beans.value.ObservableBooleanValue; -import javafx.beans.value.ObservableObjectValue; import javafx.beans.value.ObservableStringValue; +import javafx.beans.value.ObservableValue; import javafx.collections.ObservableList; import javafx.event.ActionEvent; import javafx.event.EventHandler; import javafx.scene.Node; import java.util.Collection; +import java.util.function.Supplier; /** * @author Bruno Salmon @@ -22,8 +23,8 @@ public interface ActionGroup extends Action { boolean hasSeparators(); - static ActionGroup create(Collection actions, ObservableStringValue textProperty, ObservableObjectValue graphicProperty, ObservableBooleanValue disabledProperty, ObservableBooleanValue visibleProperty, boolean hasSeparators, EventHandler actionHandler) { - return new ActionGroupImpl(actions, textProperty, graphicProperty, disabledProperty, visibleProperty, hasSeparators, actionHandler); + static ActionGroup create(Collection actions, ObservableStringValue textProperty, ObservableValue> graphicFactoryProperty, ObservableBooleanValue disabledProperty, ObservableBooleanValue visibleProperty, boolean hasSeparators, EventHandler actionHandler) { + return new ActionGroupImpl(actions, textProperty, graphicFactoryProperty, disabledProperty, visibleProperty, hasSeparators, actionHandler); } } diff --git a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionGroupBuilder.java b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionGroupBuilder.java index a0185e70a..ea2fd6bfa 100644 --- a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionGroupBuilder.java +++ b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/ActionGroupBuilder.java @@ -1,14 +1,15 @@ package dev.webfx.stack.ui.action; +import dev.webfx.platform.util.collection.Collections; import javafx.beans.value.ObservableBooleanValue; -import javafx.beans.value.ObservableObjectValue; import javafx.beans.value.ObservableStringValue; +import javafx.beans.value.ObservableValue; import javafx.event.ActionEvent; import javafx.event.EventHandler; import javafx.scene.Node; -import dev.webfx.platform.util.collection.Collections; import java.util.Collection; +import java.util.function.Supplier; /** * @author Bruno Salmon @@ -43,7 +44,7 @@ public ActionGroupBuilder setHasSeparators(boolean hasSeparators) { @Override public ActionGroup build() { completePropertiesForBuild(); - return ActionGroup.create(actions, getTextProperty(), getGraphicProperty(), getDisabledProperty(), getVisibleProperty(), hasSeparators, getActionHandler()); + return ActionGroup.create(actions, getTextProperty(), getGraphicFactoryProperty(), getDisabledProperty(), getVisibleProperty(), hasSeparators, getActionHandler()); } // --- Overriding fluent API methods to return ActionGroupBuilder instead of ActionBuilder --- @@ -69,13 +70,13 @@ public ActionGroupBuilder setI18nKey(Object i18nKey) { } @Override - public ActionGroupBuilder setGraphicProperty(ObservableObjectValue graphicProperty) { - return (ActionGroupBuilder) super.setGraphicProperty(graphicProperty); + public ActionGroupBuilder setGraphicFactoryProperty(ObservableValue> graphicFactoryProperty) { + return (ActionGroupBuilder) super.setGraphicFactoryProperty(graphicFactoryProperty); } @Override - public ActionGroupBuilder setGraphic(Node graphic) { - return (ActionGroupBuilder) super.setGraphic(graphic); + public ActionGroupBuilder setGraphicFactory(Supplier graphicFactory) { + return (ActionGroupBuilder) super.setGraphicFactory(graphicFactory); } @Override diff --git a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/ActionGroupImpl.java b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/ActionGroupImpl.java index e331342e5..d37f5620e 100644 --- a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/ActionGroupImpl.java +++ b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/ActionGroupImpl.java @@ -1,22 +1,23 @@ package dev.webfx.stack.ui.action.impl; +import dev.webfx.kit.util.properties.FXProperties; +import dev.webfx.platform.util.collection.Collections; +import dev.webfx.stack.ui.action.Action; +import dev.webfx.stack.ui.action.ActionGroup; import javafx.beans.property.Property; import javafx.beans.value.ObservableBooleanValue; -import javafx.beans.value.ObservableObjectValue; import javafx.beans.value.ObservableStringValue; +import javafx.beans.value.ObservableValue; import javafx.collections.FXCollections; import javafx.collections.ObservableList; import javafx.event.ActionEvent; import javafx.event.EventHandler; import javafx.scene.Node; -import dev.webfx.stack.ui.action.Action; -import dev.webfx.stack.ui.action.ActionGroup; -import dev.webfx.kit.util.properties.FXProperties; -import dev.webfx.platform.util.collection.Collections; import java.util.ArrayList; import java.util.Collection; import java.util.List; +import java.util.function.Supplier; /** * @author Bruno Salmon @@ -27,8 +28,8 @@ public final class ActionGroupImpl extends ReadOnlyAction implements ActionGroup private final ObservableList visibleActions = FXCollections.observableArrayList(); private final boolean hasSeparators; - public ActionGroupImpl(Collection actions, ObservableStringValue textProperty, ObservableObjectValue graphicProperty, ObservableBooleanValue disabledProperty, ObservableBooleanValue visibleProperty, boolean hasSeparators, EventHandler actionHandler) { - super(textProperty, graphicProperty, disabledProperty, visibleProperty, actionHandler); + public ActionGroupImpl(Collection actions, ObservableStringValue textProperty, ObservableValue> graphicFactoryProperty, ObservableBooleanValue disabledProperty, ObservableBooleanValue visibleProperty, boolean hasSeparators, EventHandler actionHandler) { + super(textProperty, graphicFactoryProperty, disabledProperty, visibleProperty, actionHandler); this.actions = actions; this.hasSeparators = hasSeparators; FXProperties.runNowAndOnPropertiesChange(this::updateVisibleActions, Collections.map(actions, Action::visibleProperty)); @@ -40,7 +41,7 @@ private void updateVisibleActions() { for (Action action : this.actions) { if (action.isVisible()) { int n = actions.size(); - if (action.getText() == null && action.getGraphic() == null && action instanceof ActionGroup) { + if (action.getText() == null && action.getGraphicFactory() == null && action instanceof ActionGroup) { ActionGroup actionGroup = (ActionGroup) action; actions.addAll(actionGroup.getVisibleActions()); if (actions.size() > n) { diff --git a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/ReadOnlyAction.java b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/ReadOnlyAction.java index 17d90a782..c0843f2b0 100644 --- a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/ReadOnlyAction.java +++ b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/ReadOnlyAction.java @@ -1,12 +1,14 @@ package dev.webfx.stack.ui.action.impl; +import dev.webfx.stack.ui.action.Action; import javafx.beans.value.ObservableBooleanValue; -import javafx.beans.value.ObservableObjectValue; import javafx.beans.value.ObservableStringValue; +import javafx.beans.value.ObservableValue; import javafx.event.ActionEvent; import javafx.event.EventHandler; import javafx.scene.Node; -import dev.webfx.stack.ui.action.Action; + +import java.util.function.Supplier; /** * A read-only action where properties are observable values. @@ -15,9 +17,9 @@ */ public class ReadOnlyAction implements Action { - public ReadOnlyAction(ObservableStringValue textProperty, ObservableObjectValue graphicProperty, ObservableBooleanValue disabledProperty, ObservableBooleanValue visibleProperty, EventHandler actionHandler) { + public ReadOnlyAction(ObservableStringValue textProperty, ObservableValue> graphicFactoryProperty, ObservableBooleanValue disabledProperty, ObservableBooleanValue visibleProperty, EventHandler actionHandler) { this.textProperty = textProperty; - this.graphicProperty = graphicProperty; + this.graphicFactoryProperty = graphicFactoryProperty; this.disabledProperty = disabledProperty; this.visibleProperty = visibleProperty; this.actionHandler = actionHandler; @@ -29,10 +31,10 @@ public ObservableStringValue textProperty() { return textProperty; } - private final ObservableObjectValue graphicProperty; + private final ObservableValue> graphicFactoryProperty; @Override - public ObservableObjectValue graphicProperty() { - return graphicProperty; + public ObservableValue> graphicFactoryProperty() { + return graphicFactoryProperty; } private final ObservableBooleanValue disabledProperty; diff --git a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/WritableAction.java b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/WritableAction.java index 849ef13ca..8f42b2cee 100644 --- a/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/WritableAction.java +++ b/webfx-stack-ui-action/src/main/java/dev/webfx/stack/ui/action/impl/WritableAction.java @@ -1,14 +1,16 @@ package dev.webfx.stack.ui.action.impl; +import dev.webfx.platform.util.Arrays; +import dev.webfx.stack.ui.action.Action; import javafx.beans.property.*; import javafx.beans.value.ObservableBooleanValue; -import javafx.beans.value.ObservableObjectValue; import javafx.beans.value.ObservableStringValue; +import javafx.beans.value.ObservableValue; import javafx.event.ActionEvent; import javafx.event.EventHandler; import javafx.scene.Node; -import dev.webfx.stack.ui.action.Action; -import dev.webfx.platform.util.Arrays; + +import java.util.function.Supplier; /** * A writable action where properties (text, graphic, disabled, visible) can be set later (ie after constructor call) @@ -19,15 +21,15 @@ public class WritableAction extends ReadOnlyAction { public WritableAction(Action action, String... writablePropertyNames) { - this(createStringProperty(action.textProperty(), "text", writablePropertyNames), createObjectProperty(action.graphicProperty(), "graphic", writablePropertyNames), createBooleanProperty(action.disabledProperty(), "disabled", writablePropertyNames), createBooleanProperty(action.visibleProperty(), "visible", writablePropertyNames), action); + this(createStringProperty(action.textProperty(), "text", writablePropertyNames), createObjectProperty(action.graphicFactoryProperty(), "graphicFactory", writablePropertyNames), createBooleanProperty(action.disabledProperty(), "disabled", writablePropertyNames), createBooleanProperty(action.visibleProperty(), "visible", writablePropertyNames), action); } public WritableAction(EventHandler actionHandler) { this(new SimpleStringProperty(), new SimpleObjectProperty<>(), new SimpleBooleanProperty(true /* disabled until it is bound */), new SimpleBooleanProperty(false /* invisible until it is bound */), actionHandler); } - public WritableAction(ObservableStringValue textProperty, ObservableObjectValue graphicProperty, ObservableBooleanValue disabledProperty, ObservableBooleanValue visibleProperty, EventHandler actionHandler) { - super(textProperty, graphicProperty, disabledProperty, visibleProperty, actionHandler); + public WritableAction(ObservableStringValue textProperty, ObservableValue> graphicFactoryProperty, ObservableBooleanValue disabledProperty, ObservableBooleanValue visibleProperty, EventHandler actionHandler) { + super(textProperty, graphicFactoryProperty, disabledProperty, visibleProperty, actionHandler); } public StringProperty writableTextProperty() { @@ -38,12 +40,12 @@ public void setText(String text) { writableTextProperty().set(text); } - public ObjectProperty writableGraphicProperty() { - return (ObjectProperty) graphicProperty(); + public ObjectProperty> writableGraphicFactoryProperty() { + return (ObjectProperty>) graphicFactoryProperty(); } - public void setGraphic(Node graphic) { - writableGraphicProperty().set(graphic); + public void setGraphicFactory(Supplier graphicFactory) { + writableGraphicFactoryProperty().set(graphicFactory); } public BooleanProperty writableDisabledProperty() { @@ -76,10 +78,10 @@ public void set(String newValue) { return writableProperty; } - private static ObjectProperty createObjectProperty(ObservableObjectValue readOnlyProperty, String propertyName, String... writablePropertyNames) { + private static ObjectProperty createObjectProperty(ObservableValue readOnlyProperty, String propertyName, String... writablePropertyNames) { if (readOnlyProperty instanceof ObjectProperty) return (ObjectProperty) readOnlyProperty; - SimpleObjectProperty writableProperty = new SimpleObjectProperty() { + SimpleObjectProperty writableProperty = new SimpleObjectProperty<>() { @Override public void set(T newValue) { unbindPropertyIfWritable(this, propertyName, writablePropertyNames); diff --git a/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/ControlFactoryMixin.java b/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/ControlFactoryMixin.java index dcdeb5c0e..061e99672 100644 --- a/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/ControlFactoryMixin.java +++ b/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/ControlFactoryMixin.java @@ -110,11 +110,11 @@ default Button styleButton(Button button) { } default CheckBox newCheckBox(Object i18nKey) { - return I18nControls.bindI18nProperties(new CheckBox(), i18nKey); + return I18nControls.newCheckBox(i18nKey); } default RadioButton newRadioButton(Object i18nKey) { - return I18nControls.bindI18nProperties(new RadioButton(), i18nKey); + return I18nControls.newRadioButton(i18nKey); } default RadioButton newRadioButton(Object i18nKey, ToggleGroup toggleGroup) { @@ -124,7 +124,7 @@ default RadioButton newRadioButton(Object i18nKey, ToggleGroup toggleGroup) { } default Label newLabel(Object i18nKey) { - return I18nControls.bindI18nProperties(new Label(), i18nKey); + return I18nControls.newLabel(i18nKey); } default TextField newTextField() { @@ -144,7 +144,7 @@ default Hyperlink newHyperlink() { } default Hyperlink newHyperlink(Object i18nKey) { - return I18nControls.bindI18nProperties(newHyperlink(), i18nKey); + return I18nControls.newHyperlink(i18nKey); } default Hyperlink newHyperlink(Object i18nKey, EventHandler onAction) { @@ -158,7 +158,7 @@ default TextArea newTextArea(Object i18nKey) { } default Text newText(Object i18nKey) { - return I18n.bindI18nProperties(new Text(), i18nKey); + return I18n.newText(i18nKey); } } diff --git a/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/button/ButtonFactory.java b/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/button/ButtonFactory.java index bcd8188e9..b52cd46d5 100644 --- a/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/button/ButtonFactory.java +++ b/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/button/ButtonFactory.java @@ -62,7 +62,7 @@ public static Button decorateButtonWithDropDownArrow(Button button) { downArrow.setFill(null); downArrow.setContent("M1 1.22998L6.325 6.55499L11.65 1.22998"); GraphicDecoration dropDownArrowDecoration = new GraphicDecoration(downArrow, Pos.CENTER_RIGHT, 0, 0, -1, 0); - FXProperties.runNowAndOnPropertiesChange(() -> Platform.runLater(() -> + FXProperties.runNowAndOnPropertyChange(() -> Platform.runLater(() -> Controls.onSkinReady(button, () -> dropDownArrowDecoration.applyDecoration(button)) ), button.graphicProperty()); // Code to clip the content before the down arrow diff --git a/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/dialog/DialogContent.java b/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/dialog/DialogContent.java index 73739f4ee..c0b7e8c82 100644 --- a/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/dialog/DialogContent.java +++ b/webfx-stack-ui-controls/src/main/java/dev/webfx/stack/ui/controls/dialog/DialogContent.java @@ -72,6 +72,12 @@ public DialogContent setYesNo() { return this; } + public DialogContent setOk() { + primaryButtonText = "Ok"; + secondaryButton.setManaged(false); + return this; + } + public Button getPrimaryButton() { return primaryButton; } diff --git a/webfx-stack-ui-json/src/main/java/dev/webfx/stack/ui/json/JsonSVGPath.java b/webfx-stack-ui-json/src/main/java/dev/webfx/stack/ui/json/JsonSVGPath.java index 8d2154fd0..3bd74ee98 100644 --- a/webfx-stack-ui-json/src/main/java/dev/webfx/stack/ui/json/JsonSVGPath.java +++ b/webfx-stack-ui-json/src/main/java/dev/webfx/stack/ui/json/JsonSVGPath.java @@ -7,6 +7,8 @@ import javafx.scene.paint.Paint; import javafx.scene.shape.FillRule; import javafx.scene.shape.SVGPath; +import javafx.scene.shape.StrokeLineCap; +import javafx.scene.shape.StrokeLineJoin; /** * @author Bruno Salmon @@ -21,6 +23,9 @@ public static SVGPath createSVGPath(ReadOnlyAstObject json) { svgPath.setStroke(toPaint(json.getString("stroke"), null)); svgPath.setStrokeWidth(json.getDouble("strokeWidth", 1d)); svgPath.setFillRule(toFillRule(json.getString("fillRule"))); + svgPath.setStrokeLineCap(toStrokeLineCap(json.getString("strokeLineCap"))); + svgPath.setStrokeLineJoin(toStrokeLineJoin(json.getString("strokeLineJoin"))); + svgPath.setStrokeMiterLimit(json.getDouble("strokeMiterLimit", 10d)); return svgPath; } @@ -40,11 +45,36 @@ private static Paint toPaint(String paintText, Paint defaultPaint) { } private static FillRule toFillRule(String ruleText) { - if (ruleText != null) + if (ruleText != null) { switch (ruleText.trim().toLowerCase()) { - case "evenodd" : return FillRule.EVEN_ODD; - case "nonzero" : return FillRule.NON_ZERO; + case "evenodd": + return FillRule.EVEN_ODD; + case "nonzero": + return FillRule.NON_ZERO; } + } return FillRule.NON_ZERO; } + + private static StrokeLineCap toStrokeLineCap(String strokeLineCapText) { + if (strokeLineCapText != null) { + switch (strokeLineCapText.trim().toLowerCase()) { + case "square" : return StrokeLineCap.SQUARE; + case "butt" : return StrokeLineCap.BUTT; + case "round" : return StrokeLineCap.ROUND; + } + } + return StrokeLineCap.SQUARE; + } + + private static StrokeLineJoin toStrokeLineJoin(String StrokeLineJoinText) { + if (StrokeLineJoinText != null) { + switch (StrokeLineJoinText.trim().toLowerCase()) { + case "miter": return StrokeLineJoin.MITER; + case "bevel": return StrokeLineJoin.BEVEL; + case "round": return StrokeLineJoin.ROUND; + } + } + return StrokeLineJoin.MITER; + } } diff --git a/webfx-stack-ui-operation-action/pom.xml b/webfx-stack-ui-operation-action/pom.xml index b65dbafb7..d7388c4a9 100644 --- a/webfx-stack-ui-operation-action/pom.xml +++ b/webfx-stack-ui-operation-action/pom.xml @@ -45,6 +45,14 @@ 0.1.0-SNAPSHOT + + dev.webfx + webfx-platform-javabase-emul-j2cl + 0.1.0-SNAPSHOT + runtime + true + + dev.webfx webfx-platform-javatime-emul-j2cl @@ -53,6 +61,12 @@ true + + dev.webfx + webfx-platform-scheduler + 0.1.0-SNAPSHOT + + dev.webfx webfx-platform-uischeduler @@ -77,6 +91,12 @@ 0.1.0-SNAPSHOT + + dev.webfx + webfx-stack-ui-action-tuner + 0.1.0-SNAPSHOT + + dev.webfx webfx-stack-ui-exceptions diff --git a/webfx-stack-ui-operation-action/src/main/java/dev/webfx/stack/ui/operation/action/OperationAction.java b/webfx-stack-ui-operation-action/src/main/java/dev/webfx/stack/ui/operation/action/OperationAction.java index cb8aaf170..de427612b 100644 --- a/webfx-stack-ui-operation-action/src/main/java/dev/webfx/stack/ui/operation/action/OperationAction.java +++ b/webfx-stack-ui-operation-action/src/main/java/dev/webfx/stack/ui/operation/action/OperationAction.java @@ -58,13 +58,9 @@ private OperationAction(OperationAction[] me, Function me[0] = this; this.operationRequestFactory = operationRequestFactory; OperationActionRegistry registry = getOperationActionRegistry(); - registry.bindOperationActionGraphicalProperties(this); - // Also, if some graphical dependencies are passed, we update the graphical properties when they change - if (graphicalDependencies.length > 0) - FXProperties.runNowAndOnPropertiesChange(() -> { - registry.updateOperationActionGraphicalProperties(this); - registry.bindOperationActionGraphicalProperties(this); - }, graphicalDependencies); + FXProperties.runNowAndOnPropertiesChange(() -> + registry.bindOperationActionGraphicalProperties(this) + , graphicalDependencies); // Also updating the graphical properties when graphical dependencies change } public OperationActionRegistry getOperationActionRegistry() { @@ -86,9 +82,8 @@ private void startShowingActionAsExecuting(Object operationRequest) { // If in addition an icon has been provided to graphically indicate the execution is in progress, if (actionExecutingIconFactory != null) { // we apply it to the graphic property Node executingIcon = actionExecutingIconFactory.apply(operationRequest); - if (executingIcon != null) { - FXProperties.setEvenIfBound(writableGraphicProperty(), executingIcon); - } + if (executingIcon != null) // For some operations such as routing operation, there is no executing icon + FXProperties.setEvenIfBound(writableGraphicFactoryProperty(), () -> executingIcon); } } @@ -100,9 +95,8 @@ private void stopShowingActionAsExecuting(Object operationRequest, Throwable exc // If in addition an icon has been provided to graphically indicate the execution has ended, if (actionExecutedIconFactory != null) { // we apply it to the graphic property for 2s Node executedIcon = actionExecutedIconFactory.apply(operationRequest, exception); - if (executedIcon != null) { - FXProperties.setEvenIfBound(writableGraphicProperty(), executedIcon); - } + if (executedIcon != null) // For some operations such as routing operation, there is no executed icon + FXProperties.setEvenIfBound(writableGraphicFactoryProperty(), () -> executedIcon); UiScheduler.scheduleDelay(2000, () -> { // After 2 seconds, we reestablish the original action icon, unless it's already executing again if (!executing) { // if executing again, we keep the possible executing icon instead diff --git a/webfx-stack-ui-operation-action/src/main/java/dev/webfx/stack/ui/operation/action/OperationActionRegistry.java b/webfx-stack-ui-operation-action/src/main/java/dev/webfx/stack/ui/operation/action/OperationActionRegistry.java index 90e74f406..0691fe3da 100644 --- a/webfx-stack-ui-operation-action/src/main/java/dev/webfx/stack/ui/operation/action/OperationActionRegistry.java +++ b/webfx-stack-ui-operation-action/src/main/java/dev/webfx/stack/ui/operation/action/OperationActionRegistry.java @@ -1,11 +1,17 @@ package dev.webfx.stack.ui.operation.action; +import dev.webfx.kit.util.properties.FXProperties; import dev.webfx.platform.async.AsyncFunction; import dev.webfx.platform.async.Future; +import dev.webfx.platform.console.Console; +import dev.webfx.platform.scheduler.Scheduled; import dev.webfx.platform.uischeduler.UiScheduler; +import dev.webfx.platform.util.collection.Collections; import dev.webfx.stack.authz.client.factory.AuthorizationUtil; import dev.webfx.stack.ui.action.Action; import dev.webfx.stack.ui.action.ActionBinder; +import dev.webfx.stack.ui.action.impl.WritableAction; +import dev.webfx.stack.ui.action.tuner.ActionTuner; import dev.webfx.stack.ui.operation.HasOperationCode; import javafx.beans.property.ObjectProperty; import javafx.beans.property.SimpleObjectProperty; @@ -13,10 +19,8 @@ import javafx.beans.value.ObservableValue; import javafx.event.ActionEvent; -import java.util.ArrayList; -import java.util.Collection; -import java.util.HashMap; -import java.util.Map; +import java.lang.ref.WeakReference; +import java.util.*; import java.util.function.Consumer; import java.util.function.Function; @@ -41,17 +45,32 @@ */ public final class OperationActionRegistry { - private static OperationActionRegistry INSTANCE; + private static final boolean LOG_DEBUG = false; - private final Map graphicalActions = new HashMap<>(); - private Collection notYetBoundOperationActions; - private Map> operationActionProperties; - private Runnable pendingBindRunnable; + private static final OperationActionRegistry INSTANCE = new OperationActionRegistry(); + + // Holding the actions that have been registered by the application code through registerOperationGraphicalAction(). + // These actions usually hold only the graphical properties, they are not executable (the event handler doesn't do + // anything). They are used to bind the graphical properties of the executable operation actions - through + // bindOperationActionGraphicalProperties(). + private final Map registeredGraphicalActions = new HashMap<>(); + + // Holding the executable operation actions instantiated by the application code (probably bound to a UI control + // such as a button) which have been asked to be bound to a registered graphical action, through + // bindOperationActionGraphicalProperties(). + private final Map>> registeredOperationActions = new HashMap<>(); + // Keeping a list of operation actions whose graphical action are not yet registered => the binding is deferred + // until the graphical action is registered. + private final List notYetBoundExecutableOperationActions = new ArrayList<>(); + + // When the application code wants to be notified when an executable operation action has been bound to its graphical + // properties, it can get an observable which will transit from null to the operation action at that time. + private final Map> executableOperationActionNotifyingProperties = new HashMap<>(); + + private Scheduled bindScheduled; private Consumer operationActionGraphicalPropertiesUpdater; public static OperationActionRegistry getInstance() { - if (INSTANCE == null) - INSTANCE = new OperationActionRegistry(); return INSTANCE; } @@ -80,103 +99,120 @@ public Future apply(Object request) { return AuthorizationUtil.authorizedOperationProperty( operationRequestFactory , embedAuthorizationFunction - , operationActionProperty(operationCode) // reactive property (will change when operation action will be registered, causing a new authorization evaluation) + , executableOperationActionNotifyingProperty(operationCode) // reactive property (will change when operation action will be registered, causing a new authorization evaluation) ); } - public OperationActionRegistry registerOperationGraphicalAction(Class operationRequestClass, Action graphicalAction) { - synchronized (graphicalActions) { - graphicalActions.put(operationRequestClass, graphicalAction); - return checkPendingOperationActionGraphicalBindings(); + private void processRegisteredOperationActions(Object operationCodeOrRequestClass, Consumer processor) { + List> operationActions = registeredOperationActions.get(operationCodeOrRequestClass); + if (operationActions != null) { + for (Iterator> it = operationActions.iterator(); it.hasNext(); ) { + OperationAction oa = it.next().get(); + if (oa == null) { + logDebug(operationCodeOrRequestClass + " operation action was garbage-collected"); + it.remove(); + } else { + processor.accept(oa); + } + } } } - public OperationActionRegistry registerOperationGraphicalAction(Object operationCode, Action graphicalAction) { - synchronized (graphicalActions) { - graphicalActions.put(operationCode, graphicalAction); + public OperationActionRegistry registerOperationGraphicalAction(Object operationCodeOrRequestClass, Action graphicalAction) { + synchronized (registeredGraphicalActions) { + logDebug("Registering " + operationCodeOrRequestClass + " graphical action (" + (registeredGraphicalActions.containsKey(operationCodeOrRequestClass) ? "not" : "") + " first time)"); + registeredGraphicalActions.put(operationCodeOrRequestClass, graphicalAction); + processRegisteredOperationActions(operationCodeOrRequestClass, oa -> { + logDebug(operationCodeOrRequestClass + " operation action will be rebound to new graphical action"); + Collections.addIfNotContains(oa, notYetBoundExecutableOperationActions); + }); return checkPendingOperationActionGraphicalBindings(); } } + private OperationActionRegistry registerOperationAction(Object operationCodeOrRequestClass, OperationAction operationAction) { + synchronized (registeredOperationActions) { + boolean[] alreadyRegistered = { false }; + processRegisteredOperationActions(operationCodeOrRequestClass, oa -> { + if (oa == operationAction) + alreadyRegistered[0] = true; + }); + if (!alreadyRegistered[0]) { + List> operationActions = registeredOperationActions.computeIfAbsent(operationCodeOrRequestClass, k -> new ArrayList<>()); + operationActions.add(new WeakReference<>(operationAction)); + logDebug("Registering " + operationCodeOrRequestClass + " operation action -> n°" + operationActions.size()); + } + return this; + } + } + private OperationActionRegistry checkPendingOperationActionGraphicalBindings() { - if (notYetBoundOperationActions != null && pendingBindRunnable == null) { - UiScheduler.scheduleDeferred(pendingBindRunnable = () -> { - Collection operationActionsToBind = notYetBoundOperationActions; - pendingBindRunnable = null; - notYetBoundOperationActions = null; - for (OperationAction operationAction : operationActionsToBind) - bindOperationActionGraphicalProperties(operationAction); + if (!notYetBoundExecutableOperationActions.isEmpty() && (bindScheduled == null || bindScheduled.isFinished())) { + bindScheduled = UiScheduler.scheduleDeferred(() -> { + notYetBoundExecutableOperationActions.forEach(this::bindOperationActionGraphicalProperties); + notYetBoundExecutableOperationActions.clear(); }); } return this; } - void bindOperationActionGraphicalProperties(OperationAction operationAction) { - if (bindOperationActionGraphicalPropertiesNow(operationAction)) + void bindOperationActionGraphicalProperties(OperationAction executableOperationAction) { + if (bindOperationActionGraphicalPropertiesNow(executableOperationAction)) return; - if (notYetBoundOperationActions == null) - notYetBoundOperationActions = new ArrayList<>(); - notYetBoundOperationActions.add(operationAction); + notYetBoundExecutableOperationActions.add(executableOperationAction); } - private boolean bindOperationActionGraphicalPropertiesNow(OperationAction operationAction) { + private boolean bindOperationActionGraphicalPropertiesNow(OperationAction executableOperationAction) { // The binding is possible only if a graphical action has been registered for that operation // Instantiating an operation request just to have the request class or operation code - A operationRequest = newOperationActionRequest(operationAction); + A operationRequest = newOperationActionRequest(executableOperationAction); + + // Registering the operation action (should it be done only once?) + Class operationRequestClass = operationRequest.getClass(); + registerOperationAction(operationRequestClass, executableOperationAction); + Object operationCode = operationRequest instanceof HasOperationCode ? ((HasOperationCode) operationRequest).getOperationCode() : null; + if (operationCode != null) + registerOperationAction(operationCode, executableOperationAction); + // Then getting the graphical action from it Action graphicalAction = getGraphicalActionFromOperationRequest(operationRequest); // If this is not the case, we return false (can't do the binding now) if (graphicalAction == null) return false; - Map> properties = operationActionProperties; - if (properties != null) { - Object code = getOperationCodeFromGraphicalAction(graphicalAction); - if (code != null) { - ObjectProperty operationActionProperty = properties.remove(code); + // if we reach this point, we can do the binding. + updateOperationActionGraphicalProperties(executableOperationAction); + ActionBinder.bindWritableActionToAction(executableOperationAction, graphicalAction); + // We also notify the application code that we now have an executable operation action associated + if (!executableOperationActionNotifyingProperties.isEmpty()) { + if (operationCode != null) { + ObjectProperty operationActionProperty = executableOperationActionNotifyingProperties.remove(operationCode); if (operationActionProperty != null) - operationActionProperty.set(operationAction); - if (properties.isEmpty()) - operationActionProperties = null; + operationActionProperty.set(executableOperationAction); } } - ActionBinder.bindWritableActionToAction(operationAction, graphicalAction); return true; } - public Action getGraphicalActionFromOperationAction(OperationAction operationAction) { - // Instantiating an operation request just to have the request class or operation code - A operationRequest = newOperationActionRequest(operationAction); - // Then getting the graphical action from it - return getGraphicalActionFromOperationRequest(operationRequest); - } - + // Important: the code calling this method should not store the value, but request it again each time it needs it, + // because the graphical action can change (ex: cache value on application start & then refreshed value from database) public Action getGraphicalActionFromOperationRequest(Object operationRequest) { // Trying to get the operation action registered with the operation request class or code. Action graphicalAction = getGraphicalActionFromOperationRequestClass(operationRequest.getClass()); if (graphicalAction == null && operationRequest instanceof HasOperationCode) graphicalAction = getGraphicalActionFromOperationCode(((HasOperationCode) operationRequest).getOperationCode()); + if (graphicalAction != null && operationRequest instanceof ActionTuner) { + graphicalAction = ((ActionTuner) operationRequest).tuneAction(graphicalAction); + } return graphicalAction; } private Action getGraphicalActionFromOperationRequestClass(Class operationRequestClass) { - synchronized (graphicalActions) { - return graphicalActions.get(operationRequestClass); - } + return getGraphicalActionFromOperationCode(operationRequestClass); // because they share the same map } private Action getGraphicalActionFromOperationCode(Object operationCode) { - synchronized (graphicalActions) { - return graphicalActions.get(operationCode); - } - } - - private Object getOperationCodeFromGraphicalAction(Action graphicalAction) { - synchronized (graphicalActions) { - for (Map.Entry entry : graphicalActions.entrySet()) { - if (entry.getValue() == graphicalAction) - return entry.getKey(); - } - return null; + synchronized (registeredGraphicalActions) { + return registeredGraphicalActions.get(operationCode); } } @@ -189,12 +225,15 @@ void updateOperationActionGraphicalProperties(OperationAction opera operationActionGraphicalPropertiesUpdater.accept(operationAction); } - private ObservableValue operationActionProperty(Object operationCode) { - ObjectProperty operationActionProperty = new SimpleObjectProperty<>(); - if (operationActionProperties == null) - operationActionProperties = new HashMap<>(); - operationActionProperties.put(operationCode, operationActionProperty); - return operationActionProperty; + private ObservableValue executableOperationActionNotifyingProperty(Object operationCode) { + ObjectProperty property = executableOperationActionNotifyingProperties.computeIfAbsent(operationCode, k -> new SimpleObjectProperty<>()); + if (property.get() == null) { + processRegisteredOperationActions(operationCode, oa -> { + if (property.get() == null) + property.set(oa); + }); + } + return property; } public A newOperationActionRequest(OperationAction operationAction) { @@ -206,4 +245,26 @@ public A newOperationActionRequest(OperationAction operationAction) return null; } + public Action getOrWaitOperationAction(Object operationCode) { + // Waiting to be notified + ObservableValue operationActionProperty = executableOperationActionNotifyingProperty(operationCode); + // For now, we create a wrapper action that delegates the execution to the operation action (if set) + WritableAction wrapperAction = new WritableAction(e -> { // Invisible & disabled at this stage + OperationAction operationAction = operationActionProperty.getValue(); + if (operationAction != null) { + operationAction.handle(e); + } + }); + FXProperties.onPropertySet(operationActionProperty, operationAction -> + ActionBinder.bindWritableActionToAction(wrapperAction, operationAction) + ); + return wrapperAction; + } + + private static void logDebug(String message) { + if (LOG_DEBUG) { + Console.log("[OperationActionRegistry] - " + message); + } + } + } diff --git a/webfx-stack-ui-operation-action/src/main/java/module-info.java b/webfx-stack-ui-operation-action/src/main/java/module-info.java index d434dda29..d94c95d13 100644 --- a/webfx-stack-ui-operation-action/src/main/java/module-info.java +++ b/webfx-stack-ui-operation-action/src/main/java/module-info.java @@ -8,10 +8,12 @@ requires webfx.kit.util; requires webfx.platform.async; requires webfx.platform.console; + requires webfx.platform.scheduler; requires webfx.platform.uischeduler; requires webfx.platform.util; requires webfx.stack.authz.client; requires transitive webfx.stack.ui.action; + requires webfx.stack.ui.action.tuner; requires webfx.stack.ui.exceptions; requires webfx.stack.ui.operation; diff --git a/webfx-stack-ui-operation/pom.xml b/webfx-stack-ui-operation/pom.xml index 4d52619b7..719d5fd24 100644 --- a/webfx-stack-ui-operation/pom.xml +++ b/webfx-stack-ui-operation/pom.xml @@ -27,6 +27,12 @@ provided + + dev.webfx + webfx-extras-util-control + 0.1.0-SNAPSHOT + + dev.webfx webfx-kit-util diff --git a/webfx-stack-ui-operation/src/main/java/dev/webfx/stack/ui/operation/OperationUtil.java b/webfx-stack-ui-operation/src/main/java/dev/webfx/stack/ui/operation/OperationUtil.java index 0deb82f94..d2beb5692 100644 --- a/webfx-stack-ui-operation/src/main/java/dev/webfx/stack/ui/operation/OperationUtil.java +++ b/webfx-stack-ui-operation/src/main/java/dev/webfx/stack/ui/operation/OperationUtil.java @@ -1,12 +1,12 @@ package dev.webfx.stack.ui.operation; +import dev.webfx.extras.util.control.ControlUtil; import dev.webfx.kit.util.properties.FXProperties; import dev.webfx.platform.async.AsyncFunction; import dev.webfx.platform.async.Future; import dev.webfx.platform.uischeduler.UiScheduler; import javafx.scene.Node; import javafx.scene.control.Labeled; -import javafx.scene.control.ProgressIndicator; /** * @author Bruno Salmon @@ -48,9 +48,7 @@ private static void setWaitMode(boolean on, Labeled... buttons) { Node graphic = null; if (button == buttons[0]) { if (on) { - ProgressIndicator progressIndicator = new ProgressIndicator(); - progressIndicator.setPrefSize(20, 20); // Note setMaxSize() doesn't work with WebFX but setPrefSize() does - graphic = progressIndicator; + graphic = ControlUtil.createProgressIndicator(20); // Memorising the previous graphic before changing it button.getProperties().put("webfx-operation-util-graphic", button.getGraphic()); } else { diff --git a/webfx-stack-ui-operation/src/main/java/module-info.java b/webfx-stack-ui-operation/src/main/java/module-info.java index ce97e7869..367c34a3b 100644 --- a/webfx-stack-ui-operation/src/main/java/module-info.java +++ b/webfx-stack-ui-operation/src/main/java/module-info.java @@ -5,6 +5,7 @@ // Direct dependencies modules requires javafx.controls; requires javafx.graphics; + requires webfx.extras.util.control; requires webfx.kit.util; requires webfx.platform.async; requires webfx.platform.uischeduler; diff --git a/webfx-stack-ui-validation/pom.xml b/webfx-stack-ui-validation/pom.xml index 9d625dd07..1014ed9ea 100644 --- a/webfx-stack-ui-validation/pom.xml +++ b/webfx-stack-ui-validation/pom.xml @@ -33,6 +33,44 @@ provided + + dev.webfx + webfx-extras-imagestore + 0.1.0-SNAPSHOT + + + + dev.webfx + webfx-extras-util-background + 0.1.0-SNAPSHOT + + + + dev.webfx + webfx-extras-util-border + 0.1.0-SNAPSHOT + + + + dev.webfx + webfx-extras-util-scene + 0.1.0-SNAPSHOT + + + + dev.webfx + webfx-kit-util + 0.1.0-SNAPSHOT + + + + dev.webfx + webfx-platform-javabase-emul-j2cl + 0.1.0-SNAPSHOT + runtime + true + + dev.webfx webfx-platform-javatime-emul-j2cl @@ -41,6 +79,18 @@ true + + dev.webfx + webfx-platform-uischeduler + 0.1.0-SNAPSHOT + + + + dev.webfx + webfx-platform-util + 0.1.0-SNAPSHOT + + \ No newline at end of file diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/ValidationIcons.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/ValidationIcons.java new file mode 100644 index 000000000..5ef3b7991 --- /dev/null +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/ValidationIcons.java @@ -0,0 +1,11 @@ +package dev.webfx.stack.ui.validation; + +/** + * @author Bruno Salmon + */ +final class ValidationIcons { + + public final static String validationErrorIcon16Url = "dev/webfx/stack/ui/validation/controlsfx/images/decoration-error.png"; + public final static String validationRequiredIcon16Url = "dev/webfx/stack/ui/validation/controlsfx/images/required-indicator.png"; + +} diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/ValidationSupport.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/ValidationSupport.java new file mode 100644 index 000000000..bb2f74b8b --- /dev/null +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/ValidationSupport.java @@ -0,0 +1,558 @@ +package dev.webfx.stack.ui.validation; + +import dev.webfx.extras.imagestore.ImageStore; +import dev.webfx.extras.util.background.BackgroundFactory; +import dev.webfx.extras.util.border.BorderFactory; +import dev.webfx.extras.util.scene.SceneUtil; +import dev.webfx.kit.util.properties.FXProperties; +import dev.webfx.platform.uischeduler.UiScheduler; +import dev.webfx.platform.util.collection.Collections; +import dev.webfx.stack.ui.validation.controlsfx.control.decoration.Decoration; +import dev.webfx.stack.ui.validation.controlsfx.control.decoration.GraphicDecoration; +import dev.webfx.stack.ui.validation.controlsfx.validation.decoration.GraphicValidationDecoration; +import dev.webfx.stack.ui.validation.mvvmfx.ObservableRuleBasedValidator; +import dev.webfx.stack.ui.validation.mvvmfx.ValidationMessage; +import dev.webfx.stack.ui.validation.mvvmfx.Validator; +import dev.webfx.stack.ui.validation.mvvmfx.visualization.ControlsFxVisualizer; +import javafx.application.Platform; +import javafx.beans.binding.Bindings; +import javafx.beans.property.*; +import javafx.beans.value.ObservableBooleanValue; +import javafx.beans.value.ObservableStringValue; +import javafx.beans.value.ObservableValue; +import javafx.geometry.Insets; +import javafx.geometry.Pos; +import javafx.scene.Group; +import javafx.scene.Node; +import javafx.scene.Parent; +import javafx.scene.Scene; +import javafx.scene.control.*; +import javafx.scene.layout.HBox; +import javafx.scene.layout.Pane; +import javafx.scene.layout.VBox; +import javafx.scene.paint.Color; +import javafx.scene.shape.Rectangle; +import javafx.scene.text.Font; +import javafx.scene.transform.Rotate; + +import java.time.LocalDate; +import java.time.format.DateTimeFormatter; +import java.time.format.DateTimeParseException; +import java.util.ArrayList; +import java.util.Collection; +import java.util.List; +import java.util.regex.Pattern; + +/** + * @author Bruno Salmon + */ +public final class ValidationSupport { + + private static final ObservableStringValue DEFAULT_REQUIRED_MESSAGE = new SimpleStringProperty("This field is required"); + + private final List validators = new ArrayList<>(); + private final List validatorErrorDecorationNodes = new ArrayList<>(); + private final BooleanProperty validatingProperty = new SimpleBooleanProperty(); + private Node popOverContentNode; + private Node popOverOwnerNode; + + public boolean isValid() { + validatingProperty.setValue(false); + validatingProperty.setValue(true); + Validator firstInvalidValidator = firstInvalidValidator(); + if (firstInvalidValidator != null) + Platform.runLater(() -> { + popUpOverAutoScroll = true; + showValidatorErrorPopOver(firstInvalidValidator); + }); + return firstInvalidValidator == null; + } + + public void reset() { + // This will hide the possible validation error popup and other warning icons + validatingProperty.setValue(false); + } + + public void clear() { + reset(); // hiding possible validation messages + validatorErrorDecorationNodes.forEach(this::uninstallNodeDecorator); + validatorErrorDecorationNodes.clear(); + validators.forEach(validator -> { + if (validator instanceof ObservableRuleBasedValidator) { + ((ObservableRuleBasedValidator) validator).clear(); + } + }); + validators.clear(); + } + + public boolean isEmpty() { + return validators.isEmpty(); + } + + private Validator firstInvalidValidator() { + return Collections.findFirst(validators, validator -> !validator.getValidationStatus().isValid()); + } + + public void addRequiredInputs(TextInputControl... textInputControls) { + for (TextInputControl textInputControl : textInputControls) + addRequiredInput(textInputControl); + } + + public void addRequiredInput(TextInputControl textInputControl) { + addRequiredInput(textInputControl, DEFAULT_REQUIRED_MESSAGE); + } + + public void addRequiredInput(TextInputControl textInputControl, ObservableStringValue errorMessage) { + addRequiredInput(textInputControl.textProperty(), textInputControl, errorMessage); + } + + public void addRequiredInput(ObservableValue valueProperty, Node inputNode) { + addRequiredInput(valueProperty, inputNode, DEFAULT_REQUIRED_MESSAGE); + } + + public void addRequiredInput(ObservableValue valueProperty, Node inputNode, ObservableStringValue errorMessage) { + addValidationRule(Bindings.createBooleanBinding(() -> testNotEmpty(valueProperty.getValue()), valueProperty), inputNode, errorMessage, true); + } + + private static boolean testNotEmpty(Object value) { + return value != null && (!(value instanceof String) || !((String) value).trim().isEmpty()); + } + + public ObservableBooleanValue addValidationRule(ObservableValue validProperty, Node node, ObservableStringValue errorMessage) { + return addValidationRule(validProperty, node, errorMessage, false); + } + + public ObservableBooleanValue addValidationRule(ObservableValue validProperty, Node node, ObservableStringValue errorMessageProperty, boolean required) { + ObservableRuleBasedValidator validator = new ObservableRuleBasedValidator(); + ObservableBooleanValue finalValidProperty = // when true, no decorations are displayed on the node + Bindings.createBooleanBinding(() -> + !validatingProperty.get() // no decoration displayed if not validation + || validProperty.getValue() // no decoration displayed if the node is valid + || !isShowing(node) // no decoration displayed if the node is not showing + , validProperty, validatingProperty); + ValidationMessage errorValidationMessage = ValidationMessage.error(errorMessageProperty); + validator.addRule(finalValidProperty, errorValidationMessage); + validators.add(validator); + validatorErrorDecorationNodes.add(node); + installNodeDecorator(node, validator, required); + // The following code is to remove the error message after being displayed and the user is re-typing + if (node instanceof TextInputControl) { + FXProperties.runOnPropertiesChange( + () -> { + validator.validateBooleanRule(true, errorValidationMessage); + uninstallNodeDecorator(node); + } + , ((TextInputControl) node).textProperty()); // ex of dependencies: textField.textProperty() + } + return finalValidProperty; + } + + private void installNodeDecorator(Node node, ObservableRuleBasedValidator validator, boolean required) { + if (node instanceof Control) { + Control control = (Control) node; + ControlsFxVisualizer validationVisualizer = new ControlsFxVisualizer(); + validationVisualizer.setDecoration(new GraphicValidationDecoration() { + @Override + protected Node createErrorNode() { + return ImageStore.createImageView(ValidationIcons.validationErrorIcon16Url); + } + + @Override + protected Collection createValidationDecorations(dev.webfx.stack.ui.validation.controlsfx.validation.ValidationMessage message) { + boolean isTextInput = node instanceof TextInputControl; + boolean isButton = node instanceof Button; + // isInside flag will determine if we position the decoration inside the node or not (ie outside) + boolean isInside; + if (isTextInput) // inside for text inputs + isInside = true; + else { // for others, will be generally outside unless it is stretched to full width by its container + Parent parent = node.getParent(); + while (parent instanceof Pane && !(parent instanceof VBox) && !(parent instanceof HBox)) + parent = parent.getParent(); + isInside = parent instanceof VBox && ((VBox) parent).isFillWidth(); + } + double xRelativeOffset = isInside ? -1 : 1; // positioning the decoration inside the control for button and text input + double xOffset = isInside && isButton ? -20 : 0; // moving the decoration before the drop down arrow + return java.util.Collections.singletonList( + new GraphicDecoration(createDecorationNode(message), + Pos.CENTER_RIGHT, + xOffset, + 0, + xRelativeOffset, + 0) + ); + } + + @Override + protected Collection createRequiredDecorations(Control target) { + return java.util.Collections.singletonList( + new GraphicDecoration(ImageStore.createImageView(ValidationIcons.validationRequiredIcon16Url), + Pos.CENTER_LEFT, + -10, + 0)); + } + }); + validationVisualizer.initVisualization(validator.getValidationStatus(), control, required); + node.getProperties().put("validationVisualizer", validationVisualizer); + } + } + + private void uninstallNodeDecorator(Node node) { + if (node instanceof Control) { + Control control = (Control) node; + ControlsFxVisualizer validationVisualizer = (ControlsFxVisualizer) node.getProperties().get("validationVisualizer"); + if (validationVisualizer != null) + validationVisualizer.removeDecorations(control); + } + } + + private void showValidatorErrorPopOver(Validator validator) { + int index = validators.indexOf(validator); + if (index >= 0) { + Node decorationNode = validatorErrorDecorationNodes.get(index); + if (decorationNode != null) + showValidatorErrorPopOver(validator, decorationNode); + } + } + + private void showValidatorErrorPopOver(Validator validator, Node errorDecorationNode) { + ValidationMessage errorMessage = Collections.first(validator.getValidationStatus().getErrorMessages()); + if (errorMessage != null) { + Label label = new Label(); + label.textProperty().bind(errorMessage.messageProperty()); + label.setPadding(new Insets(8)); + label.setFont(Font.font("Verdana", 11.5)); + label.setTextFill(Color.WHITE); + label.setBackground(BackgroundFactory.newBackground(Color.RED, 5, 2)); + label.setBorder(BorderFactory.newBorder(Color.WHITE, 5, 2)); + Rectangle diamond = new Rectangle(10, 10, Color.RED); + diamond.getTransforms().add(new Rotate(45, 5, 5)); + diamond.layoutYProperty().bind(FXProperties.compute(label.heightProperty(), n -> n.doubleValue() - 7)); + diamond.setLayoutX(20d); + popOverContentNode = new Group(label, diamond); + //popOverContentNode.setOpacity(0.75); + //popOverContentNode.setEffect(new DropShadow()); + showPopOver(errorDecorationNode); + // Removing the error pop over when the status is valid again + FXProperties.runOrUnregisterOnPropertyChange((thisListener, oldValue, valid) -> { + if (valid) { + thisListener.unregister(); + popOverOwnerNode = null; + hidePopOver(); + } + }, validator.getValidationStatus().validProperty()); + } + } + + private void showPopOver(Node node) { + popOverOwnerNode = node; + showPopOverNow(); + if (!node.getProperties().containsKey("popOverListen")) { + node.getProperties().put("popOverListen", true); + node.sceneProperty().addListener(observable -> { + if (popOverOwnerNode == node) { + showPopOverNow(); + } + }); + node.parentProperty().addListener(observable -> { + if (popOverOwnerNode == node) { + showPopOverNow(); + } + }); + } + } + + public void addEmailValidation(TextField emailInput, Node where, ObservableStringValue errorMessage) { + // Define the email pattern + String emailPattern = "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,6}$"; + Pattern pattern = Pattern.compile(emailPattern); + // Create the validation rule + addValidationRule( + Bindings.createBooleanBinding( + () -> pattern.matcher(emailInput.getText()).matches(), + emailInput.textProperty() + ), + where, + errorMessage + ); + } + + public void addEmailNotEqualValidation(TextField emailInput, String forbiddenValue, Node where, ObservableStringValue errorMessage) { + // Create the validation rule + addValidationRule( + Bindings.createBooleanBinding( + () -> !emailInput.getText().equalsIgnoreCase(forbiddenValue), + emailInput.textProperty() + ), + where, + errorMessage + ); + } + + public void addUrlValidation(TextField urlInput, Node where, ObservableStringValue errorMessage) { + // Define the URL pattern (basic) + String urlPattern = "^(https?://)(www\\.)?[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,6}(/.*)?$"; + Pattern pattern = Pattern.compile(urlPattern); + + addValidationRule( + Bindings.createBooleanBinding( + () -> { + String input = urlInput.getText(); + return input!=null && pattern.matcher(input).matches(); // Accept empty or valid URL + }, + urlInput.textProperty() + ), + where, + errorMessage + ); + } + + public void addMinimumDurationValidation(TextField timeInput, Node where, ObservableStringValue errorMessage) { + addValidationRule( + Bindings.createBooleanBinding( + () -> { + try { + String input = timeInput.getText(); + if (input == null || input.isEmpty()) return true; // Allow empty input + int value = Integer.parseInt(input); // Try to parse the input to an integer + return value >= 60; // Validate if the integer is at least 60 + } catch (NumberFormatException e) { + return false; // Invalid if input is not a valid integer + } + }, + timeInput.textProperty() + ), + where, + errorMessage + ); + } + + + public void addUrlOrEmptyValidation(TextField urlInput, ObservableStringValue errorMessage) { + // Define the URL pattern (basic) + String urlPattern = "^(https?|srt|rtmp|rtsp)://[\\w.-]+(:\\d+)?(/[\\w./-]*)?(\\?[\\w=&%.-]*)?(#[\\w!:.=&,-]*)?$"; + Pattern pattern = Pattern.compile(urlPattern); + + // Create the validation rule + addValidationRule( + Bindings.createBooleanBinding( + () -> { + String input = urlInput.getText(); + return input.isEmpty() || pattern.matcher(input).matches(); // Accept empty or valid URL + }, + urlInput.textProperty() + ), + urlInput, + errorMessage + ); + } + + public void addNonEmptyValidation(TextField textField, Node where, ObservableStringValue errorMessage) { + // Create the validation rule + addValidationRule( + Bindings.createBooleanBinding( + () -> !textField.getText().trim().isEmpty(), + textField.textProperty() + ), + where, + errorMessage); + } + + public void addDateValidation(TextField textField,String dateFormat, Node where, ObservableStringValue errorMessage) { + DateTimeFormatter dateFormatter = DateTimeFormatter.ofPattern(dateFormat); + // Create the validation rule + addValidationRule( + Bindings.createBooleanBinding(() -> { + try { + dateFormatter.parse(textField.getText().trim()); + return true; + } catch (DateTimeParseException e) { + return false; + }}, textField.textProperty()), + where, + errorMessage + ); + } + + public void addDateOrEmptyValidation(TextField textField, String dateFormat, Node where, ObservableStringValue errorMessage) { + DateTimeFormatter dateFormatter = DateTimeFormatter.ofPattern(dateFormat); + + // Create the validation rule + addValidationRule( + Bindings.createBooleanBinding(() -> { + String input = textField.getText().trim(); + // Allow empty input to be valid + if (input.isEmpty()) { + return true; + } + try { + dateFormatter.parse(input); + return true; // Input is valid if it can be parsed + } catch (DateTimeParseException e) { + return false; // Invalid date format + } + }, textField.textProperty()), + where, + errorMessage + ); + } + + public void addIntegerValidation(TextField textField, Node where, ObservableStringValue errorMessage) { + // Create the validation rule + addValidationRule( + Bindings.createBooleanBinding(() -> { + try { + // Try to parse the text as an integer + Integer.parseInt(textField.getText().trim()); + return true; + } catch (NumberFormatException e) { + return false; + } + }, textField.textProperty()), + where, + errorMessage + ); + } + + public void addLegalAgeValidation(TextField textField, String dateFormat, int legalAge, Node where, ObservableStringValue errorMessage) { + DateTimeFormatter dateFormatter = DateTimeFormatter.ofPattern(dateFormat); + // Create the validation rule + addValidationRule( + Bindings.createBooleanBinding(() -> { + try { + LocalDate birthDate = LocalDate.parse(textField.getText().trim(), dateFormatter); + LocalDate now = LocalDate.now(); + return birthDate.plusYears(legalAge).isBefore(now) || birthDate.plusYears(legalAge).isEqual(now); + } catch (DateTimeParseException e) { + return false; + } + }, textField.textProperty()), + where, + errorMessage + ); + } + + public void addPasswordMatchValidation(TextField passwordField, TextField repeatPasswordField, ObservableStringValue errorMessageProperty) { + addValidationRule( + Bindings.createBooleanBinding( + () -> passwordField.getText().equals(repeatPasswordField.getText()), + passwordField.textProperty(), + repeatPasswordField.textProperty() + ), + repeatPasswordField, + errorMessageProperty, + true + ); + } + + public void addPasswordStrengthValidation(TextField passwordField, ObservableStringValue errorMessage) { + addValidationRule( + Bindings.createBooleanBinding( + () -> checkPasswordStrength(passwordField.getText()), + passwordField.textProperty() + ), + passwordField, + errorMessage, + true + ); + } + /** + * Checks if a password meets strength requirements. + * @param password the password to validate. + * @return true if the password meets the requirements, false otherwise. + */ + private boolean checkPasswordStrength(String password) { + if (password == null || password.isEmpty()) { + return false; + } + // Minimum length + if (password.length() < 8) { + return false; + } + // Contains at least one uppercase letter + if (!password.matches(".*[A-Z].*")) { + return false; + } + // Contains at least one lowercase letter + if (!password.matches(".*[a-z].*")) { + return false; + } + // Contains at least one digit + if (!password.matches(".*\\d.*")) { + return false; + } + // Contains at least one special character + if (!password.matches(".*[@#$%^&+=!().,*?-].*")) { + return false; + } + return true; + } + +/* + private PopOver popOver; + private void showPopOverNow() { + if (popOver != null && popOver.getOwnerNode() != popOverOwnerNode) { + popOver.hide(); + popOver = null; + } + if (popOver == null && isShowing(popOverOwnerNode)) { + popOver = new PopOver(); + popOver.setContentNode(popOverContentNode); + popOver.setArrowLocation(PopOver.ArrowLocation.BOTTOM_LEFT); + //Platform.runLater(() -> { + popOver.show(popOverOwnerNode, -(popOverOwnerNode instanceof ImageView ? ((ImageView) popOverOwnerNode).getImage().getHeight() : 0) + 4); + //}); + } + } +*/ + + private GraphicDecoration popOverDecoration; + private Node popOverDecorationTarget; + private boolean popUpOverAutoScroll; + + private void showPopOverNow() { + Platform.runLater(() -> { + hidePopOver(); + if (isShowing(popOverOwnerNode)) { + popOverDecorationTarget = popOverOwnerNode; + popOverDecoration = new GraphicDecoration(popOverContentNode, 0, -1, 0, -1); + popOverDecoration.applyDecoration(popOverDecorationTarget); + if (popUpOverAutoScroll) { + SceneUtil.scrollNodeToBeVerticallyVisibleOnScene(popOverDecorationTarget); + SceneUtil.autoFocusIfEnabled(popOverOwnerNode); + popUpOverAutoScroll = false; + } + } + }); + } + + private void hidePopOver() { + UiScheduler.runInUiThread(() -> { + if (popOverDecoration != null) { + popOverDecoration.removeDecoration(popOverDecorationTarget); + popOverDecoration = null; + } + }); + } + + private static boolean isShowing(Node node) { + if (node == null || !node.isVisible()) + return false; + Parent parent = node.getParent(); + if (parent != null) + return isShowing(parent); + Scene scene = node.getScene(); + return scene != null && scene.getRoot() == node; + } + + public void addPasswordValidation(TextField passwordInput, Label passwordLabel, ObservableStringValue errorMessage) { + addValidationRule( + Bindings.createBooleanBinding( + () -> passwordInput.getText().length() >= 8, + passwordInput.textProperty() + ), + passwordLabel, + errorMessage + ); + } +} diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ValidationSupport.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ControlsFxValidationSupport.java similarity index 99% rename from webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ValidationSupport.java rename to webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ControlsFxValidationSupport.java index e6c9d2396..ac68b6876 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ValidationSupport.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ControlsFxValidationSupport.java @@ -76,7 +76,7 @@ * * */ -public class ValidationSupport { +public class ControlsFxValidationSupport { private static final String CTRL_REQUIRED_FLAG = "$org.controlsfx.validation.required$"; //$NON-NLS-1$ @@ -111,7 +111,7 @@ public static boolean isRequired( Control c ) { * Creates validation support instance. * If initial decoration is desired invoke {@link #initInitialDecoration()}. */ - public ValidationSupport() { + public ControlsFxValidationSupport() { validationResultProperty().addListener( (o, oldValue, validationResult) -> { invalidProperty.set(!validationResult.getErrors().isEmpty()); diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ValidationMessage.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ValidationMessage.java index 45b699d6f..3ad4a0edb 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ValidationMessage.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/ValidationMessage.java @@ -35,28 +35,24 @@ */ public interface ValidationMessage extends Comparable{ - public static final Comparator COMPARATOR = new Comparator() { - - @Override - public int compare(ValidationMessage vm1, ValidationMessage vm2) { - if ( vm1 == vm2 ) return 0; - if ( vm1 == null) return 1; - if ( vm2 == null) return -1; - return vm1.compareTo(vm2); - } - }; + Comparator COMPARATOR = (vm1, vm2) -> { + if ( vm1 == vm2 ) return 0; + if ( vm1 == null) return 1; + if ( vm2 == null) return -1; + return vm1.compareTo(vm2); + }; /** * Message text * @return message text */ - public String getText(); + String getText(); /** * Message {@link Severity} * @return message severity */ - public Severity getSeverity(); + Severity getSeverity(); /** @@ -71,7 +67,7 @@ public int compare(ValidationMessage vm1, ValidationMessage vm2) { * @param text message text * @return error message */ - public static ValidationMessage error(Control target, String text) { + static ValidationMessage error(Control target, String text) { return new SimpleValidationMessage(target, text, Severity.ERROR); } @@ -81,11 +77,11 @@ public static ValidationMessage error(Control target, String text) { * @param text message text * @return warning message */ - public static ValidationMessage warning(Control target, String text) { + static ValidationMessage warning(Control target, String text) { return new SimpleValidationMessage(target, text, Severity.WARNING); } - @Override default public int compareTo(ValidationMessage msg) { + @Override default int compareTo(ValidationMessage msg) { return msg == null || getTarget() != msg.getTarget() ? -1: getSeverity().compareTo(msg.getSeverity()); } } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/decoration/AbstractValidationDecoration.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/decoration/AbstractValidationDecoration.java index a2011dd5d..8a9685232 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/decoration/AbstractValidationDecoration.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/controlsfx/validation/decoration/AbstractValidationDecoration.java @@ -1,18 +1,18 @@ /** * Copyright (c) 2014, 2015, ControlsFX * All rights reserved. - * + * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: - * * Redistributions of source code must retain the above copyright + * * Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. - * * Redistributions in binary form must reproduce the above copyright + * * Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. - * * Neither the name of ControlsFX, any associated website, nor the + * * Neither the name of ControlsFX, any associated website, nor the * names of its contributors may be used to endorse or promote products * derived from this software without specific prior written permission. - * + * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE @@ -30,7 +30,7 @@ import dev.webfx.stack.ui.validation.controlsfx.control.decoration.Decorator; import dev.webfx.stack.ui.validation.controlsfx.validation.ValidationMessage; import javafx.scene.control.Control; -import dev.webfx.stack.ui.validation.controlsfx.validation.ValidationSupport; +import dev.webfx.stack.ui.validation.controlsfx.validation.ControlsFxValidationSupport; import java.util.Collection; import java.util.List; @@ -42,67 +42,69 @@ * how 'validation' and 'required' decorations should be created * * See {@link GraphicValidationDecoration} for examples of such implementations. - * + * */ public abstract class AbstractValidationDecoration implements ValidationDecoration { - - private static final String VALIDATION_DECORATION = "$org.controlsfx.decoration.vaidation$"; //$NON-NLS-1$ - - private static boolean isValidationDecoration( Decoration decoration) { + + private static final String VALIDATION_DECORATION = "$org.controlsfx.decoration.validation$"; //$NON-NLS-1$ + + private static boolean isValidationDecoration(Decoration decoration) { return decoration != null && decoration.getProperties().get(VALIDATION_DECORATION) == Boolean.TRUE; } - private static void setValidationDecoration( Decoration decoration ) { - if ( decoration != null ) { + private static void setValidationDecoration(Decoration decoration) { + if (decoration != null) { decoration.getProperties().put(VALIDATION_DECORATION, Boolean.TRUE); } } - protected abstract Collection createValidationDecorations(ValidationMessage message); - protected abstract Collection createRequiredDecorations(Control target); - - /** - * Removes all validation related decorations from the target - * @param target control - */ - @Override - public void removeDecorations(Control target) { - List decorations = Decorator.getDecorations(target); - if ( decorations != null ) { - // conversion to array is a trick to prevent concurrent modification exception - for ( Decoration d: Decorator.getDecorations(target).toArray(new Decoration[0]) ) { - if (isValidationDecoration(d)) Decorator.removeDecoration(target, d); + protected abstract Collection createValidationDecorations(ValidationMessage message); + + protected abstract Collection createRequiredDecorations(Control target); + + /** + * Removes all validation related decorations from the target + * @param target control + */ + @Override + public void removeDecorations(Control target) { + List decorations = Decorator.getDecorations(target); + if (decorations != null) { + // conversion to array is a trick to prevent concurrent modification exception + for (Decoration d : Decorator.getDecorations(target).toArray(new Decoration[0])) { + if (isValidationDecoration(d)) + Decorator.removeDecoration(target, d); } } - } - - /* - * (non-Javadoc) - * @see org.controlsfx.validation.decorator.ValidationDecorator#applyValidationDecoration(org.controlsfx.validation.ValidationMessage) - */ - @Override - public void applyValidationDecoration(ValidationMessage message) { - //createValidationDecorations(message).stream().forEach( d -> decorate( message.getTarget(), d )); // stream don't work on Android - for (Decoration decoration : createValidationDecorations(message)) - decorate(message.getTarget(), decoration); - } + } + + /* + * (non-Javadoc) + * @see org.controlsfx.validation.decorator.ValidationDecorator#applyValidationDecoration(org.controlsfx.validation.ValidationMessage) + */ + @Override + public void applyValidationDecoration(ValidationMessage message) { + //createValidationDecorations(message).stream().forEach( d -> decorate( message.getTarget(), d )); // stream don't work on Android + for (Decoration decoration : createValidationDecorations(message)) + decorate(message.getTarget(), decoration); + } - /* - * (non-Javadoc) - * @see org.controlsfx.validation.decorator.ValidationDecorator#applyRequiredDecoration(javafx.scene.control.Control) - */ - @Override - public void applyRequiredDecoration(Control target) { - if ( ValidationSupport.isRequired(target)) { - // createRequiredDecorations(target).stream().forEach( d -> decorate( target, d )); // stream don't work on Android - for (Decoration decoration : createRequiredDecorations(target)) - decorate(target, decoration); - } - } - - private void decorate( Control target, Decoration d ) { - setValidationDecoration(d); // mark as validation specific decoration + /* + * (non-Javadoc) + * @see org.controlsfx.validation.decorator.ValidationDecorator#applyRequiredDecoration(javafx.scene.control.Control) + */ + @Override + public void applyRequiredDecoration(Control target) { + if (ControlsFxValidationSupport.isRequired(target)) { + // createRequiredDecorations(target).stream().forEach( d -> decorate( target, d )); // stream don't work on Android + for (Decoration decoration : createRequiredDecorations(target)) + decorate(target, decoration); + } + } + + private void decorate(Control target, Decoration d) { + setValidationDecoration(d); // mark as validation specific decoration Decorator.addDecoration(target, d); - } + } } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ObservableRuleBasedValidator.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ObservableRuleBasedValidator.java index 8b5cb2aae..e72274e28 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ObservableRuleBasedValidator.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ObservableRuleBasedValidator.java @@ -15,6 +15,8 @@ ******************************************************************************/ package dev.webfx.stack.ui.validation.mvvmfx; +import dev.webfx.kit.util.properties.FXProperties; +import dev.webfx.kit.util.properties.Unregisterable; import javafx.beans.value.ObservableValue; import java.util.ArrayList; @@ -32,7 +34,7 @@ * * * Boolean Rules of type ObservableValue<Boolean> - * + * * The first variant uses an {@link ObservableValue} together with a static message. If this observable * has a value of false the validation status will be "invalid" and the given message will be present in the {@link ValidationStatus} * of this validator. @@ -40,35 +42,27 @@ * * * Complex Rules of type ObservableValue<ValidationMessage> - * + * * The second variant allows more complex rules. It uses a {@link ObservableValue} as rule. * If this observable has a value other then null it is considered to be invalid. The {@link ValidationMessage} * value will be present in the {@link ValidationStatus} of this validator. * * - * + * * You can add multiple rules via the {@link #addRule(ObservableValue, ValidationMessage)} and {@link #addRule(ObservableValue)} method. * If multiple rules are violated, each message will be present. */ public class ObservableRuleBasedValidator implements Validator { - /* - These lists are used to store the rules that this validator is working with. - The reason for this is to prevent problems with garbage collection. - If the validator wouldn't keep references to all given rules it would be possible that they are - removed by the garbage collector which would result in wrong validation results. - To prevent this we store references to all given rules here. - Don't get confused by the fact that no values are only added to these lists but not obtained. - */ - private List> booleanRules = new ArrayList<>(); - private List> complexRules = new ArrayList<>(); - - private ValidationStatus validationStatus = new ValidationStatus(); + private final List unregisterableRules = new ArrayList<>(); + + private final ValidationStatus validationStatus = new ValidationStatus(); /** * Creates an instance of the Validator without any rules predefined. */ - public ObservableRuleBasedValidator() {} + public ObservableRuleBasedValidator() { + } /** * Creates an instance of the Validator with the given rule predefined. @@ -86,50 +80,49 @@ public ObservableRuleBasedValidator(ObservableValue rule, ValidationMes * Creates an instance of the Validator with the given complex rules predefined. * It's a shortcut for creating an empty validator and * adding one or multiple complex rules with {@link #addRule(ObservableValue)}. + * * @param rules */ - public ObservableRuleBasedValidator(ObservableValue ... rules) { + public ObservableRuleBasedValidator(ObservableValue... rules) { for (ObservableValue rule : rules) { addRule(rule); } } - /** - * Add a rule for this validator. - * - * The rule defines a condition that has to be fulfilled. - * - * A rule is defined by an observable boolean value. If the rule has a value of true the rule is - * "fulfilled". If the rule has a value of false the rule is violated. In this case the given message - * object will be added to the status of this validator. - * - * There are some predefined rules for common use cases in the {@link ObservableRules} class that can be used. - * - * @param rule - * @param message - */ - public void addRule(ObservableValue rule, ValidationMessage message) { - booleanRules.add(rule); - - rule.addListener((observable, oldValue, newValue) -> { - validateBooleanRule(newValue, message); - }); - - validateBooleanRule(rule.getValue(), message); - } - - private void validateBooleanRule(boolean isValid, ValidationMessage message) { - if (isValid) { - validationStatus.removeMessage(message); - } else { - validationStatus.addMessage(message); - } - } - - @Override - public ValidationStatus getValidationStatus() { - return validationStatus; - } + /** + * Add a rule for this validator. + * + * The rule defines a condition that has to be fulfilled. + * + * A rule is defined by an observable boolean value. If the rule has a value of true the rule is + * "fulfilled". If the rule has a value of false the rule is violated. In this case the given message + * object will be added to the status of this validator. + * + * There are some predefined rules for common use cases in the {@link ObservableRules} class that can be used. + * + * @param validProperty + * @param message + */ + public void addRule(ObservableValue validProperty, ValidationMessage message) { + unregisterableRules.add( + FXProperties.runNowAndOnPropertyChange((observable, oldValue, newValue) -> + validateBooleanRule(newValue, message) + , validProperty) + ); + } + + public void validateBooleanRule(boolean isValid, ValidationMessage message) { + if (isValid) { + hideMessage(message); + } else { + showMessage(message); + } + } + + @Override + public ValidationStatus getValidationStatus() { + return validationStatus; + } /** * Add a complex rule for this validator. @@ -140,26 +133,37 @@ public ValidationStatus getValidationStatus() { * If the observable doesn't contain a value (in other words it contains null) the rule is considered to * be fulfilled and the validation status of this validator will be valid (given that no other rule is violated). * - * - * This method allows some more complex rules compared to {@link #addRule(ObservableValue, ValidationMessage)}. - * This way you can define rules that have different messages for specific cases. + * + * This method allows some more complex rules compared to {@link #addRule(ObservableValue, ValidationMessage)}. + * This way you can define rules that have different messages for specific cases. * * @param rule */ public void addRule(ObservableValue rule) { - complexRules.add(rule); - - rule.addListener((observable, oldValue, newValue) -> { - if(oldValue != null) { - validationStatus.removeMessage(oldValue); - } - if(newValue != null) { - validationStatus.addMessage(newValue); - } - }); - - if(rule.getValue() != null) { - validationStatus.addMessage(rule.getValue()); + unregisterableRules.add( + FXProperties.runNowAndOnPropertyChange((observable, oldValue, newValue) -> { + hideMessage(oldValue); // does nothing if oldValue is null + showMessage(newValue); // does nothing if newValue is null + }, rule) + ); + } + + private void showMessage(ValidationMessage message) { + if (message != null) { + validationStatus.addMessage(message); + } + } + + private void hideMessage(ValidationMessage message) { + if (message != null) { + validationStatus.removeMessage(message); } } + + public void clear() { + unregisterableRules.forEach(Unregisterable::unregister); + unregisterableRules.clear(); + validationStatus.clearMessages(); + } + } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java index 57c3b90e3..9ece55d7b 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java @@ -15,6 +15,8 @@ ******************************************************************************/ package dev.webfx.stack.ui.validation.mvvmfx; +import javafx.beans.value.ObservableStringValue; + import java.util.Objects; /** @@ -25,26 +27,30 @@ */ public class ValidationMessage { - private final String message; + private final ObservableStringValue messageProperty; private final Severity severity; - public ValidationMessage(Severity severity, String message) { + public ValidationMessage(Severity severity, ObservableStringValue messageProperty) { this.severity = Objects.requireNonNull(severity); - this.message = Objects.requireNonNull(message); + this.messageProperty = Objects.requireNonNull(messageProperty); } - public static ValidationMessage warning(String message) { - return new ValidationMessage(Severity.WARNING, message); + public static ValidationMessage warning(ObservableStringValue messageProperty) { + return new ValidationMessage(Severity.WARNING, messageProperty); } - public static ValidationMessage error(String message) { - return new ValidationMessage(Severity.ERROR, message); + public static ValidationMessage error(ObservableStringValue messageProperty) { + return new ValidationMessage(Severity.ERROR, messageProperty); } + public ObservableStringValue messageProperty() { + return messageProperty; + } + public String getMessage() { - return message; + return messageProperty.get(); } public Severity getSeverity() { @@ -54,27 +60,27 @@ public Severity getSeverity() { @Override public String toString() { return "ValidationMessage{" + - "message='" + message + '\'' + - ", severity=" + severity + - '}'; + "messageProperty='" + messageProperty + '\'' + + ", severity=" + severity + + '}'; } @Override public boolean equals(Object o) { if (this == o) return true; - if (o == null || !(o instanceof ValidationMessage)) + if (!(o instanceof ValidationMessage)) return false; ValidationMessage that = (ValidationMessage) o; - return message.equals(that.message) && severity == that.severity; + return messageProperty.equals(that.messageProperty) && severity == that.severity; } @Override public int hashCode() { - int result = message.hashCode(); + int result = messageProperty.hashCode(); result = 31 * result + severity.hashCode(); return result; } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java index d1f82602e..82d4062fb 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java @@ -37,11 +37,11 @@ */ public class ValidationStatus { - private ListProperty messages = new SimpleListProperty<>(FXCollections.observableArrayList()); + private final ListProperty messages = new SimpleListProperty<>(FXCollections.observableArrayList()); - private ObservableList unmodifiableMessages = FXCollections.unmodifiableObservableList(messages); - private ObservableList errorMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.ERROR)); - private ObservableList warningMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.WARNING)); + private final ObservableList unmodifiableMessages = FXCollections.unmodifiableObservableList(messages); + private final ObservableList errorMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.ERROR)); + private final ObservableList warningMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.WARNING)); /** * Intended for subclasses used by special validator implementations. diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java index a3e093bd9..6ede92357 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java @@ -17,7 +17,7 @@ import dev.webfx.stack.ui.validation.mvvmfx.Severity; import dev.webfx.stack.ui.validation.mvvmfx.ValidationMessage; -import dev.webfx.stack.ui.validation.controlsfx.validation.ValidationSupport; +import dev.webfx.stack.ui.validation.controlsfx.validation.ControlsFxValidationSupport; import dev.webfx.stack.ui.validation.controlsfx.validation.decoration.GraphicValidationDecoration; import dev.webfx.stack.ui.validation.controlsfx.validation.decoration.ValidationDecoration; import javafx.scene.control.Control; @@ -52,7 +52,7 @@ public void setDecoration(ValidationDecoration decoration) { @Override void applyRequiredVisualization(Control control, boolean required) { - ValidationSupport.setRequired(control, required); + ControlsFxValidationSupport.setRequired(control, required); if (required) { decoration.applyRequiredDecoration(control); } @@ -74,12 +74,14 @@ void applyVisualization(Control control, Optional messageOpti } } else { - decoration.removeDecorations(control); - } - - if (required) { - decoration.applyRequiredDecoration(control); + removeDecorations(control); } + + applyRequiredVisualization(control, required); + } + + @Override + public void removeDecorations(Control control) { + decoration.removeDecorations(control); } - } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java index 4b6d33d41..447baca68 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java @@ -15,11 +15,12 @@ ******************************************************************************/ package dev.webfx.stack.ui.validation.mvvmfx.visualization; +import dev.webfx.kit.util.properties.FXProperties; +import dev.webfx.kit.util.properties.ObservableLists; +import dev.webfx.platform.uischeduler.UiScheduler; import dev.webfx.stack.ui.validation.mvvmfx.Severity; import dev.webfx.stack.ui.validation.mvvmfx.ValidationMessage; import dev.webfx.stack.ui.validation.mvvmfx.ValidationStatus; -import javafx.application.Platform; -import javafx.collections.ListChangeListener; import javafx.scene.control.Control; import java.util.Optional; @@ -42,20 +43,13 @@ public abstract class ValidationVisualizerBase implements ValidationVisualizer { @Override public void initVisualization(final ValidationStatus result, final Control control, boolean required) { if (control.getSkin() == null) { - control.skinProperty().addListener((observable, oldValue, newValue) -> initVisualization(result, control, required)); + FXProperties.onPropertySet(control.skinProperty(), skin -> initVisualization(result, control, required)); return; } - if (required) { - applyRequiredVisualization(control, required); - } - - applyVisualization(control, result.getHighestMessage(), required); - - result.getMessages().addListener((ListChangeListener) c -> { - while (c.next()) { - Platform.runLater(() -> applyVisualization(control, result.getHighestMessage(), required)); - } - }); + + ObservableLists.runNowAndOnListChange(c -> UiScheduler.runInUiThread(() -> + applyVisualization(control, result.getHighestMessage(), required) + ), result.getMessages()); } /** @@ -93,5 +87,7 @@ public void initVisualization(final ValidationStatus result, final Control contr * a boolean flag indicating whether this control is mandatory or not. */ abstract void applyVisualization(Control control, Optional messageOptional, boolean required); + + public abstract void removeDecorations(Control control); } diff --git a/webfx-stack-ui-validation/src/main/java/module-info.java b/webfx-stack-ui-validation/src/main/java/module-info.java index 9aca87547..b37e66d92 100644 --- a/webfx-stack-ui-validation/src/main/java/module-info.java +++ b/webfx-stack-ui-validation/src/main/java/module-info.java @@ -6,8 +6,16 @@ requires javafx.base; requires javafx.controls; requires javafx.graphics; + requires webfx.extras.imagestore; + requires webfx.extras.util.background; + requires webfx.extras.util.border; + requires webfx.extras.util.scene; + requires webfx.kit.util; + requires webfx.platform.uischeduler; + requires webfx.platform.util; // Exported packages + exports dev.webfx.stack.ui.validation; exports dev.webfx.stack.ui.validation.controlsfx.control.decoration; exports dev.webfx.stack.ui.validation.controlsfx.impl; exports dev.webfx.stack.ui.validation.controlsfx.impl.skin;
* Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: - * * Redistributions of source code must retain the above copyright + * * Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. - * * Redistributions in binary form must reproduce the above copyright + * * Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. - * * Neither the name of ControlsFX, any associated website, nor the + * * Neither the name of ControlsFX, any associated website, nor the * names of its contributors may be used to endorse or promote products * derived from this software without specific prior written permission. - * + *
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE @@ -30,7 +30,7 @@ import dev.webfx.stack.ui.validation.controlsfx.control.decoration.Decorator; import dev.webfx.stack.ui.validation.controlsfx.validation.ValidationMessage; import javafx.scene.control.Control; -import dev.webfx.stack.ui.validation.controlsfx.validation.ValidationSupport; +import dev.webfx.stack.ui.validation.controlsfx.validation.ControlsFxValidationSupport; import java.util.Collection; import java.util.List; @@ -42,67 +42,69 @@ * how 'validation' and 'required' decorations should be created * * See {@link GraphicValidationDecoration} for examples of such implementations. - * + * */ public abstract class AbstractValidationDecoration implements ValidationDecoration { - - private static final String VALIDATION_DECORATION = "$org.controlsfx.decoration.vaidation$"; //$NON-NLS-1$ - - private static boolean isValidationDecoration( Decoration decoration) { + + private static final String VALIDATION_DECORATION = "$org.controlsfx.decoration.validation$"; //$NON-NLS-1$ + + private static boolean isValidationDecoration(Decoration decoration) { return decoration != null && decoration.getProperties().get(VALIDATION_DECORATION) == Boolean.TRUE; } - private static void setValidationDecoration( Decoration decoration ) { - if ( decoration != null ) { + private static void setValidationDecoration(Decoration decoration) { + if (decoration != null) { decoration.getProperties().put(VALIDATION_DECORATION, Boolean.TRUE); } } - protected abstract Collection createValidationDecorations(ValidationMessage message); - protected abstract Collection createRequiredDecorations(Control target); - - /** - * Removes all validation related decorations from the target - * @param target control - */ - @Override - public void removeDecorations(Control target) { - List decorations = Decorator.getDecorations(target); - if ( decorations != null ) { - // conversion to array is a trick to prevent concurrent modification exception - for ( Decoration d: Decorator.getDecorations(target).toArray(new Decoration[0]) ) { - if (isValidationDecoration(d)) Decorator.removeDecoration(target, d); + protected abstract Collection createValidationDecorations(ValidationMessage message); + + protected abstract Collection createRequiredDecorations(Control target); + + /** + * Removes all validation related decorations from the target + * @param target control + */ + @Override + public void removeDecorations(Control target) { + List decorations = Decorator.getDecorations(target); + if (decorations != null) { + // conversion to array is a trick to prevent concurrent modification exception + for (Decoration d : Decorator.getDecorations(target).toArray(new Decoration[0])) { + if (isValidationDecoration(d)) + Decorator.removeDecoration(target, d); } } - } - - /* - * (non-Javadoc) - * @see org.controlsfx.validation.decorator.ValidationDecorator#applyValidationDecoration(org.controlsfx.validation.ValidationMessage) - */ - @Override - public void applyValidationDecoration(ValidationMessage message) { - //createValidationDecorations(message).stream().forEach( d -> decorate( message.getTarget(), d )); // stream don't work on Android - for (Decoration decoration : createValidationDecorations(message)) - decorate(message.getTarget(), decoration); - } + } + + /* + * (non-Javadoc) + * @see org.controlsfx.validation.decorator.ValidationDecorator#applyValidationDecoration(org.controlsfx.validation.ValidationMessage) + */ + @Override + public void applyValidationDecoration(ValidationMessage message) { + //createValidationDecorations(message).stream().forEach( d -> decorate( message.getTarget(), d )); // stream don't work on Android + for (Decoration decoration : createValidationDecorations(message)) + decorate(message.getTarget(), decoration); + } - /* - * (non-Javadoc) - * @see org.controlsfx.validation.decorator.ValidationDecorator#applyRequiredDecoration(javafx.scene.control.Control) - */ - @Override - public void applyRequiredDecoration(Control target) { - if ( ValidationSupport.isRequired(target)) { - // createRequiredDecorations(target).stream().forEach( d -> decorate( target, d )); // stream don't work on Android - for (Decoration decoration : createRequiredDecorations(target)) - decorate(target, decoration); - } - } - - private void decorate( Control target, Decoration d ) { - setValidationDecoration(d); // mark as validation specific decoration + /* + * (non-Javadoc) + * @see org.controlsfx.validation.decorator.ValidationDecorator#applyRequiredDecoration(javafx.scene.control.Control) + */ + @Override + public void applyRequiredDecoration(Control target) { + if (ControlsFxValidationSupport.isRequired(target)) { + // createRequiredDecorations(target).stream().forEach( d -> decorate( target, d )); // stream don't work on Android + for (Decoration decoration : createRequiredDecorations(target)) + decorate(target, decoration); + } + } + + private void decorate(Control target, Decoration d) { + setValidationDecoration(d); // mark as validation specific decoration Decorator.addDecoration(target, d); - } + } } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ObservableRuleBasedValidator.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ObservableRuleBasedValidator.java index 8b5cb2aae..e72274e28 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ObservableRuleBasedValidator.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ObservableRuleBasedValidator.java @@ -15,6 +15,8 @@ ******************************************************************************/ package dev.webfx.stack.ui.validation.mvvmfx; +import dev.webfx.kit.util.properties.FXProperties; +import dev.webfx.kit.util.properties.Unregisterable; import javafx.beans.value.ObservableValue; import java.util.ArrayList; @@ -32,7 +34,7 @@ * * * Boolean Rules of type ObservableValue<Boolean> - * + * * The first variant uses an {@link ObservableValue} together with a static message. If this observable * has a value of false the validation status will be "invalid" and the given message will be present in the {@link ValidationStatus} * of this validator. @@ -40,35 +42,27 @@ * * * Complex Rules of type ObservableValue<ValidationMessage> - * + * * The second variant allows more complex rules. It uses a {@link ObservableValue} as rule. * If this observable has a value other then null it is considered to be invalid. The {@link ValidationMessage} * value will be present in the {@link ValidationStatus} of this validator. * * - * + * * You can add multiple rules via the {@link #addRule(ObservableValue, ValidationMessage)} and {@link #addRule(ObservableValue)} method. * If multiple rules are violated, each message will be present. */ public class ObservableRuleBasedValidator implements Validator { - /* - These lists are used to store the rules that this validator is working with. - The reason for this is to prevent problems with garbage collection. - If the validator wouldn't keep references to all given rules it would be possible that they are - removed by the garbage collector which would result in wrong validation results. - To prevent this we store references to all given rules here. - Don't get confused by the fact that no values are only added to these lists but not obtained. - */ - private List> booleanRules = new ArrayList<>(); - private List> complexRules = new ArrayList<>(); - - private ValidationStatus validationStatus = new ValidationStatus(); + private final List unregisterableRules = new ArrayList<>(); + + private final ValidationStatus validationStatus = new ValidationStatus(); /** * Creates an instance of the Validator without any rules predefined. */ - public ObservableRuleBasedValidator() {} + public ObservableRuleBasedValidator() { + } /** * Creates an instance of the Validator with the given rule predefined. @@ -86,50 +80,49 @@ public ObservableRuleBasedValidator(ObservableValue rule, ValidationMes * Creates an instance of the Validator with the given complex rules predefined. * It's a shortcut for creating an empty validator and * adding one or multiple complex rules with {@link #addRule(ObservableValue)}. + * * @param rules */ - public ObservableRuleBasedValidator(ObservableValue ... rules) { + public ObservableRuleBasedValidator(ObservableValue... rules) { for (ObservableValue rule : rules) { addRule(rule); } } - /** - * Add a rule for this validator. - * - * The rule defines a condition that has to be fulfilled. - * - * A rule is defined by an observable boolean value. If the rule has a value of true the rule is - * "fulfilled". If the rule has a value of false the rule is violated. In this case the given message - * object will be added to the status of this validator. - * - * There are some predefined rules for common use cases in the {@link ObservableRules} class that can be used. - * - * @param rule - * @param message - */ - public void addRule(ObservableValue rule, ValidationMessage message) { - booleanRules.add(rule); - - rule.addListener((observable, oldValue, newValue) -> { - validateBooleanRule(newValue, message); - }); - - validateBooleanRule(rule.getValue(), message); - } - - private void validateBooleanRule(boolean isValid, ValidationMessage message) { - if (isValid) { - validationStatus.removeMessage(message); - } else { - validationStatus.addMessage(message); - } - } - - @Override - public ValidationStatus getValidationStatus() { - return validationStatus; - } + /** + * Add a rule for this validator. + * + * The rule defines a condition that has to be fulfilled. + * + * A rule is defined by an observable boolean value. If the rule has a value of true the rule is + * "fulfilled". If the rule has a value of false the rule is violated. In this case the given message + * object will be added to the status of this validator. + * + * There are some predefined rules for common use cases in the {@link ObservableRules} class that can be used. + * + * @param validProperty + * @param message + */ + public void addRule(ObservableValue validProperty, ValidationMessage message) { + unregisterableRules.add( + FXProperties.runNowAndOnPropertyChange((observable, oldValue, newValue) -> + validateBooleanRule(newValue, message) + , validProperty) + ); + } + + public void validateBooleanRule(boolean isValid, ValidationMessage message) { + if (isValid) { + hideMessage(message); + } else { + showMessage(message); + } + } + + @Override + public ValidationStatus getValidationStatus() { + return validationStatus; + } /** * Add a complex rule for this validator. @@ -140,26 +133,37 @@ public ValidationStatus getValidationStatus() { * If the observable doesn't contain a value (in other words it contains null) the rule is considered to * be fulfilled and the validation status of this validator will be valid (given that no other rule is violated). * - * - * This method allows some more complex rules compared to {@link #addRule(ObservableValue, ValidationMessage)}. - * This way you can define rules that have different messages for specific cases. + * + * This method allows some more complex rules compared to {@link #addRule(ObservableValue, ValidationMessage)}. + * This way you can define rules that have different messages for specific cases. * * @param rule */ public void addRule(ObservableValue rule) { - complexRules.add(rule); - - rule.addListener((observable, oldValue, newValue) -> { - if(oldValue != null) { - validationStatus.removeMessage(oldValue); - } - if(newValue != null) { - validationStatus.addMessage(newValue); - } - }); - - if(rule.getValue() != null) { - validationStatus.addMessage(rule.getValue()); + unregisterableRules.add( + FXProperties.runNowAndOnPropertyChange((observable, oldValue, newValue) -> { + hideMessage(oldValue); // does nothing if oldValue is null + showMessage(newValue); // does nothing if newValue is null + }, rule) + ); + } + + private void showMessage(ValidationMessage message) { + if (message != null) { + validationStatus.addMessage(message); + } + } + + private void hideMessage(ValidationMessage message) { + if (message != null) { + validationStatus.removeMessage(message); } } + + public void clear() { + unregisterableRules.forEach(Unregisterable::unregister); + unregisterableRules.clear(); + validationStatus.clearMessages(); + } + } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java index 57c3b90e3..9ece55d7b 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java @@ -15,6 +15,8 @@ ******************************************************************************/ package dev.webfx.stack.ui.validation.mvvmfx; +import javafx.beans.value.ObservableStringValue; + import java.util.Objects; /** @@ -25,26 +27,30 @@ */ public class ValidationMessage { - private final String message; + private final ObservableStringValue messageProperty; private final Severity severity; - public ValidationMessage(Severity severity, String message) { + public ValidationMessage(Severity severity, ObservableStringValue messageProperty) { this.severity = Objects.requireNonNull(severity); - this.message = Objects.requireNonNull(message); + this.messageProperty = Objects.requireNonNull(messageProperty); } - public static ValidationMessage warning(String message) { - return new ValidationMessage(Severity.WARNING, message); + public static ValidationMessage warning(ObservableStringValue messageProperty) { + return new ValidationMessage(Severity.WARNING, messageProperty); } - public static ValidationMessage error(String message) { - return new ValidationMessage(Severity.ERROR, message); + public static ValidationMessage error(ObservableStringValue messageProperty) { + return new ValidationMessage(Severity.ERROR, messageProperty); } + public ObservableStringValue messageProperty() { + return messageProperty; + } + public String getMessage() { - return message; + return messageProperty.get(); } public Severity getSeverity() { @@ -54,27 +60,27 @@ public Severity getSeverity() { @Override public String toString() { return "ValidationMessage{" + - "message='" + message + '\'' + - ", severity=" + severity + - '}'; + "messageProperty='" + messageProperty + '\'' + + ", severity=" + severity + + '}'; } @Override public boolean equals(Object o) { if (this == o) return true; - if (o == null || !(o instanceof ValidationMessage)) + if (!(o instanceof ValidationMessage)) return false; ValidationMessage that = (ValidationMessage) o; - return message.equals(that.message) && severity == that.severity; + return messageProperty.equals(that.messageProperty) && severity == that.severity; } @Override public int hashCode() { - int result = message.hashCode(); + int result = messageProperty.hashCode(); result = 31 * result + severity.hashCode(); return result; } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java index d1f82602e..82d4062fb 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java @@ -37,11 +37,11 @@ */ public class ValidationStatus { - private ListProperty messages = new SimpleListProperty<>(FXCollections.observableArrayList()); + private final ListProperty messages = new SimpleListProperty<>(FXCollections.observableArrayList()); - private ObservableList unmodifiableMessages = FXCollections.unmodifiableObservableList(messages); - private ObservableList errorMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.ERROR)); - private ObservableList warningMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.WARNING)); + private final ObservableList unmodifiableMessages = FXCollections.unmodifiableObservableList(messages); + private final ObservableList errorMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.ERROR)); + private final ObservableList warningMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.WARNING)); /** * Intended for subclasses used by special validator implementations. diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java index a3e093bd9..6ede92357 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java @@ -17,7 +17,7 @@ import dev.webfx.stack.ui.validation.mvvmfx.Severity; import dev.webfx.stack.ui.validation.mvvmfx.ValidationMessage; -import dev.webfx.stack.ui.validation.controlsfx.validation.ValidationSupport; +import dev.webfx.stack.ui.validation.controlsfx.validation.ControlsFxValidationSupport; import dev.webfx.stack.ui.validation.controlsfx.validation.decoration.GraphicValidationDecoration; import dev.webfx.stack.ui.validation.controlsfx.validation.decoration.ValidationDecoration; import javafx.scene.control.Control; @@ -52,7 +52,7 @@ public void setDecoration(ValidationDecoration decoration) { @Override void applyRequiredVisualization(Control control, boolean required) { - ValidationSupport.setRequired(control, required); + ControlsFxValidationSupport.setRequired(control, required); if (required) { decoration.applyRequiredDecoration(control); } @@ -74,12 +74,14 @@ void applyVisualization(Control control, Optional messageOpti } } else { - decoration.removeDecorations(control); - } - - if (required) { - decoration.applyRequiredDecoration(control); + removeDecorations(control); } + + applyRequiredVisualization(control, required); + } + + @Override + public void removeDecorations(Control control) { + decoration.removeDecorations(control); } - } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java index 4b6d33d41..447baca68 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java @@ -15,11 +15,12 @@ ******************************************************************************/ package dev.webfx.stack.ui.validation.mvvmfx.visualization; +import dev.webfx.kit.util.properties.FXProperties; +import dev.webfx.kit.util.properties.ObservableLists; +import dev.webfx.platform.uischeduler.UiScheduler; import dev.webfx.stack.ui.validation.mvvmfx.Severity; import dev.webfx.stack.ui.validation.mvvmfx.ValidationMessage; import dev.webfx.stack.ui.validation.mvvmfx.ValidationStatus; -import javafx.application.Platform; -import javafx.collections.ListChangeListener; import javafx.scene.control.Control; import java.util.Optional; @@ -42,20 +43,13 @@ public abstract class ValidationVisualizerBase implements ValidationVisualizer { @Override public void initVisualization(final ValidationStatus result, final Control control, boolean required) { if (control.getSkin() == null) { - control.skinProperty().addListener((observable, oldValue, newValue) -> initVisualization(result, control, required)); + FXProperties.onPropertySet(control.skinProperty(), skin -> initVisualization(result, control, required)); return; } - if (required) { - applyRequiredVisualization(control, required); - } - - applyVisualization(control, result.getHighestMessage(), required); - - result.getMessages().addListener((ListChangeListener) c -> { - while (c.next()) { - Platform.runLater(() -> applyVisualization(control, result.getHighestMessage(), required)); - } - }); + + ObservableLists.runNowAndOnListChange(c -> UiScheduler.runInUiThread(() -> + applyVisualization(control, result.getHighestMessage(), required) + ), result.getMessages()); } /** @@ -93,5 +87,7 @@ public void initVisualization(final ValidationStatus result, final Control contr * a boolean flag indicating whether this control is mandatory or not. */ abstract void applyVisualization(Control control, Optional messageOptional, boolean required); + + public abstract void removeDecorations(Control control); } diff --git a/webfx-stack-ui-validation/src/main/java/module-info.java b/webfx-stack-ui-validation/src/main/java/module-info.java index 9aca87547..b37e66d92 100644 --- a/webfx-stack-ui-validation/src/main/java/module-info.java +++ b/webfx-stack-ui-validation/src/main/java/module-info.java @@ -6,8 +6,16 @@ requires javafx.base; requires javafx.controls; requires javafx.graphics; + requires webfx.extras.imagestore; + requires webfx.extras.util.background; + requires webfx.extras.util.border; + requires webfx.extras.util.scene; + requires webfx.kit.util; + requires webfx.platform.uischeduler; + requires webfx.platform.util; // Exported packages + exports dev.webfx.stack.ui.validation; exports dev.webfx.stack.ui.validation.controlsfx.control.decoration; exports dev.webfx.stack.ui.validation.controlsfx.impl; exports dev.webfx.stack.ui.validation.controlsfx.impl.skin;
* The first variant uses an {@link ObservableValue} together with a static message. If this observable * has a value of false the validation status will be "invalid" and the given message will be present in the {@link ValidationStatus} * of this validator. @@ -40,35 +42,27 @@ * * * Complex Rules of type ObservableValue<ValidationMessage> - * + * * The second variant allows more complex rules. It uses a {@link ObservableValue} as rule. * If this observable has a value other then null it is considered to be invalid. The {@link ValidationMessage} * value will be present in the {@link ValidationStatus} of this validator. * * - * + * * You can add multiple rules via the {@link #addRule(ObservableValue, ValidationMessage)} and {@link #addRule(ObservableValue)} method. * If multiple rules are violated, each message will be present. */ public class ObservableRuleBasedValidator implements Validator { - /* - These lists are used to store the rules that this validator is working with. - The reason for this is to prevent problems with garbage collection. - If the validator wouldn't keep references to all given rules it would be possible that they are - removed by the garbage collector which would result in wrong validation results. - To prevent this we store references to all given rules here. - Don't get confused by the fact that no values are only added to these lists but not obtained. - */ - private List> booleanRules = new ArrayList<>(); - private List> complexRules = new ArrayList<>(); - - private ValidationStatus validationStatus = new ValidationStatus(); + private final List unregisterableRules = new ArrayList<>(); + + private final ValidationStatus validationStatus = new ValidationStatus(); /** * Creates an instance of the Validator without any rules predefined. */ - public ObservableRuleBasedValidator() {} + public ObservableRuleBasedValidator() { + } /** * Creates an instance of the Validator with the given rule predefined. @@ -86,50 +80,49 @@ public ObservableRuleBasedValidator(ObservableValue rule, ValidationMes * Creates an instance of the Validator with the given complex rules predefined. * It's a shortcut for creating an empty validator and * adding one or multiple complex rules with {@link #addRule(ObservableValue)}. + * * @param rules */ - public ObservableRuleBasedValidator(ObservableValue ... rules) { + public ObservableRuleBasedValidator(ObservableValue... rules) { for (ObservableValue rule : rules) { addRule(rule); } } - /** - * Add a rule for this validator. - * - * The rule defines a condition that has to be fulfilled. - * - * A rule is defined by an observable boolean value. If the rule has a value of true the rule is - * "fulfilled". If the rule has a value of false the rule is violated. In this case the given message - * object will be added to the status of this validator. - * - * There are some predefined rules for common use cases in the {@link ObservableRules} class that can be used. - * - * @param rule - * @param message - */ - public void addRule(ObservableValue rule, ValidationMessage message) { - booleanRules.add(rule); - - rule.addListener((observable, oldValue, newValue) -> { - validateBooleanRule(newValue, message); - }); - - validateBooleanRule(rule.getValue(), message); - } - - private void validateBooleanRule(boolean isValid, ValidationMessage message) { - if (isValid) { - validationStatus.removeMessage(message); - } else { - validationStatus.addMessage(message); - } - } - - @Override - public ValidationStatus getValidationStatus() { - return validationStatus; - } + /** + * Add a rule for this validator. + * + * The rule defines a condition that has to be fulfilled. + * + * A rule is defined by an observable boolean value. If the rule has a value of true the rule is + * "fulfilled". If the rule has a value of false the rule is violated. In this case the given message + * object will be added to the status of this validator. + * + * There are some predefined rules for common use cases in the {@link ObservableRules} class that can be used. + * + * @param validProperty + * @param message + */ + public void addRule(ObservableValue validProperty, ValidationMessage message) { + unregisterableRules.add( + FXProperties.runNowAndOnPropertyChange((observable, oldValue, newValue) -> + validateBooleanRule(newValue, message) + , validProperty) + ); + } + + public void validateBooleanRule(boolean isValid, ValidationMessage message) { + if (isValid) { + hideMessage(message); + } else { + showMessage(message); + } + } + + @Override + public ValidationStatus getValidationStatus() { + return validationStatus; + } /** * Add a complex rule for this validator. @@ -140,26 +133,37 @@ public ValidationStatus getValidationStatus() { * If the observable doesn't contain a value (in other words it contains null) the rule is considered to * be fulfilled and the validation status of this validator will be valid (given that no other rule is violated). * - * - * This method allows some more complex rules compared to {@link #addRule(ObservableValue, ValidationMessage)}. - * This way you can define rules that have different messages for specific cases. + * + * This method allows some more complex rules compared to {@link #addRule(ObservableValue, ValidationMessage)}. + * This way you can define rules that have different messages for specific cases. * * @param rule */ public void addRule(ObservableValue rule) { - complexRules.add(rule); - - rule.addListener((observable, oldValue, newValue) -> { - if(oldValue != null) { - validationStatus.removeMessage(oldValue); - } - if(newValue != null) { - validationStatus.addMessage(newValue); - } - }); - - if(rule.getValue() != null) { - validationStatus.addMessage(rule.getValue()); + unregisterableRules.add( + FXProperties.runNowAndOnPropertyChange((observable, oldValue, newValue) -> { + hideMessage(oldValue); // does nothing if oldValue is null + showMessage(newValue); // does nothing if newValue is null + }, rule) + ); + } + + private void showMessage(ValidationMessage message) { + if (message != null) { + validationStatus.addMessage(message); + } + } + + private void hideMessage(ValidationMessage message) { + if (message != null) { + validationStatus.removeMessage(message); } } + + public void clear() { + unregisterableRules.forEach(Unregisterable::unregister); + unregisterableRules.clear(); + validationStatus.clearMessages(); + } + } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java index 57c3b90e3..9ece55d7b 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java @@ -15,6 +15,8 @@ ******************************************************************************/ package dev.webfx.stack.ui.validation.mvvmfx; +import javafx.beans.value.ObservableStringValue; + import java.util.Objects; /** @@ -25,26 +27,30 @@ */ public class ValidationMessage { - private final String message; + private final ObservableStringValue messageProperty; private final Severity severity; - public ValidationMessage(Severity severity, String message) { + public ValidationMessage(Severity severity, ObservableStringValue messageProperty) { this.severity = Objects.requireNonNull(severity); - this.message = Objects.requireNonNull(message); + this.messageProperty = Objects.requireNonNull(messageProperty); } - public static ValidationMessage warning(String message) { - return new ValidationMessage(Severity.WARNING, message); + public static ValidationMessage warning(ObservableStringValue messageProperty) { + return new ValidationMessage(Severity.WARNING, messageProperty); } - public static ValidationMessage error(String message) { - return new ValidationMessage(Severity.ERROR, message); + public static ValidationMessage error(ObservableStringValue messageProperty) { + return new ValidationMessage(Severity.ERROR, messageProperty); } + public ObservableStringValue messageProperty() { + return messageProperty; + } + public String getMessage() { - return message; + return messageProperty.get(); } public Severity getSeverity() { @@ -54,27 +60,27 @@ public Severity getSeverity() { @Override public String toString() { return "ValidationMessage{" + - "message='" + message + '\'' + - ", severity=" + severity + - '}'; + "messageProperty='" + messageProperty + '\'' + + ", severity=" + severity + + '}'; } @Override public boolean equals(Object o) { if (this == o) return true; - if (o == null || !(o instanceof ValidationMessage)) + if (!(o instanceof ValidationMessage)) return false; ValidationMessage that = (ValidationMessage) o; - return message.equals(that.message) && severity == that.severity; + return messageProperty.equals(that.messageProperty) && severity == that.severity; } @Override public int hashCode() { - int result = message.hashCode(); + int result = messageProperty.hashCode(); result = 31 * result + severity.hashCode(); return result; } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java index d1f82602e..82d4062fb 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java @@ -37,11 +37,11 @@ */ public class ValidationStatus { - private ListProperty messages = new SimpleListProperty<>(FXCollections.observableArrayList()); + private final ListProperty messages = new SimpleListProperty<>(FXCollections.observableArrayList()); - private ObservableList unmodifiableMessages = FXCollections.unmodifiableObservableList(messages); - private ObservableList errorMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.ERROR)); - private ObservableList warningMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.WARNING)); + private final ObservableList unmodifiableMessages = FXCollections.unmodifiableObservableList(messages); + private final ObservableList errorMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.ERROR)); + private final ObservableList warningMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.WARNING)); /** * Intended for subclasses used by special validator implementations. diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java index a3e093bd9..6ede92357 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java @@ -17,7 +17,7 @@ import dev.webfx.stack.ui.validation.mvvmfx.Severity; import dev.webfx.stack.ui.validation.mvvmfx.ValidationMessage; -import dev.webfx.stack.ui.validation.controlsfx.validation.ValidationSupport; +import dev.webfx.stack.ui.validation.controlsfx.validation.ControlsFxValidationSupport; import dev.webfx.stack.ui.validation.controlsfx.validation.decoration.GraphicValidationDecoration; import dev.webfx.stack.ui.validation.controlsfx.validation.decoration.ValidationDecoration; import javafx.scene.control.Control; @@ -52,7 +52,7 @@ public void setDecoration(ValidationDecoration decoration) { @Override void applyRequiredVisualization(Control control, boolean required) { - ValidationSupport.setRequired(control, required); + ControlsFxValidationSupport.setRequired(control, required); if (required) { decoration.applyRequiredDecoration(control); } @@ -74,12 +74,14 @@ void applyVisualization(Control control, Optional messageOpti } } else { - decoration.removeDecorations(control); - } - - if (required) { - decoration.applyRequiredDecoration(control); + removeDecorations(control); } + + applyRequiredVisualization(control, required); + } + + @Override + public void removeDecorations(Control control) { + decoration.removeDecorations(control); } - } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java index 4b6d33d41..447baca68 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java @@ -15,11 +15,12 @@ ******************************************************************************/ package dev.webfx.stack.ui.validation.mvvmfx.visualization; +import dev.webfx.kit.util.properties.FXProperties; +import dev.webfx.kit.util.properties.ObservableLists; +import dev.webfx.platform.uischeduler.UiScheduler; import dev.webfx.stack.ui.validation.mvvmfx.Severity; import dev.webfx.stack.ui.validation.mvvmfx.ValidationMessage; import dev.webfx.stack.ui.validation.mvvmfx.ValidationStatus; -import javafx.application.Platform; -import javafx.collections.ListChangeListener; import javafx.scene.control.Control; import java.util.Optional; @@ -42,20 +43,13 @@ public abstract class ValidationVisualizerBase implements ValidationVisualizer { @Override public void initVisualization(final ValidationStatus result, final Control control, boolean required) { if (control.getSkin() == null) { - control.skinProperty().addListener((observable, oldValue, newValue) -> initVisualization(result, control, required)); + FXProperties.onPropertySet(control.skinProperty(), skin -> initVisualization(result, control, required)); return; } - if (required) { - applyRequiredVisualization(control, required); - } - - applyVisualization(control, result.getHighestMessage(), required); - - result.getMessages().addListener((ListChangeListener) c -> { - while (c.next()) { - Platform.runLater(() -> applyVisualization(control, result.getHighestMessage(), required)); - } - }); + + ObservableLists.runNowAndOnListChange(c -> UiScheduler.runInUiThread(() -> + applyVisualization(control, result.getHighestMessage(), required) + ), result.getMessages()); } /** @@ -93,5 +87,7 @@ public void initVisualization(final ValidationStatus result, final Control contr * a boolean flag indicating whether this control is mandatory or not. */ abstract void applyVisualization(Control control, Optional messageOptional, boolean required); + + public abstract void removeDecorations(Control control); } diff --git a/webfx-stack-ui-validation/src/main/java/module-info.java b/webfx-stack-ui-validation/src/main/java/module-info.java index 9aca87547..b37e66d92 100644 --- a/webfx-stack-ui-validation/src/main/java/module-info.java +++ b/webfx-stack-ui-validation/src/main/java/module-info.java @@ -6,8 +6,16 @@ requires javafx.base; requires javafx.controls; requires javafx.graphics; + requires webfx.extras.imagestore; + requires webfx.extras.util.background; + requires webfx.extras.util.border; + requires webfx.extras.util.scene; + requires webfx.kit.util; + requires webfx.platform.uischeduler; + requires webfx.platform.util; // Exported packages + exports dev.webfx.stack.ui.validation; exports dev.webfx.stack.ui.validation.controlsfx.control.decoration; exports dev.webfx.stack.ui.validation.controlsfx.impl; exports dev.webfx.stack.ui.validation.controlsfx.impl.skin;
false
* The second variant allows more complex rules. It uses a {@link ObservableValue} as rule. * If this observable has a value other then null it is considered to be invalid. The {@link ValidationMessage} * value will be present in the {@link ValidationStatus} of this validator. * * - * + * * You can add multiple rules via the {@link #addRule(ObservableValue, ValidationMessage)} and {@link #addRule(ObservableValue)} method. * If multiple rules are violated, each message will be present. */ public class ObservableRuleBasedValidator implements Validator { - /* - These lists are used to store the rules that this validator is working with. - The reason for this is to prevent problems with garbage collection. - If the validator wouldn't keep references to all given rules it would be possible that they are - removed by the garbage collector which would result in wrong validation results. - To prevent this we store references to all given rules here. - Don't get confused by the fact that no values are only added to these lists but not obtained. - */ - private List> booleanRules = new ArrayList<>(); - private List> complexRules = new ArrayList<>(); - - private ValidationStatus validationStatus = new ValidationStatus(); + private final List unregisterableRules = new ArrayList<>(); + + private final ValidationStatus validationStatus = new ValidationStatus(); /** * Creates an instance of the Validator without any rules predefined. */ - public ObservableRuleBasedValidator() {} + public ObservableRuleBasedValidator() { + } /** * Creates an instance of the Validator with the given rule predefined. @@ -86,50 +80,49 @@ public ObservableRuleBasedValidator(ObservableValue rule, ValidationMes * Creates an instance of the Validator with the given complex rules predefined. * It's a shortcut for creating an empty validator and * adding one or multiple complex rules with {@link #addRule(ObservableValue)}. + * * @param rules */ - public ObservableRuleBasedValidator(ObservableValue ... rules) { + public ObservableRuleBasedValidator(ObservableValue... rules) { for (ObservableValue rule : rules) { addRule(rule); } } - /** - * Add a rule for this validator. - * - * The rule defines a condition that has to be fulfilled. - * - * A rule is defined by an observable boolean value. If the rule has a value of true the rule is - * "fulfilled". If the rule has a value of false the rule is violated. In this case the given message - * object will be added to the status of this validator. - * - * There are some predefined rules for common use cases in the {@link ObservableRules} class that can be used. - * - * @param rule - * @param message - */ - public void addRule(ObservableValue rule, ValidationMessage message) { - booleanRules.add(rule); - - rule.addListener((observable, oldValue, newValue) -> { - validateBooleanRule(newValue, message); - }); - - validateBooleanRule(rule.getValue(), message); - } - - private void validateBooleanRule(boolean isValid, ValidationMessage message) { - if (isValid) { - validationStatus.removeMessage(message); - } else { - validationStatus.addMessage(message); - } - } - - @Override - public ValidationStatus getValidationStatus() { - return validationStatus; - } + /** + * Add a rule for this validator. + * + * The rule defines a condition that has to be fulfilled. + * + * A rule is defined by an observable boolean value. If the rule has a value of true the rule is + * "fulfilled". If the rule has a value of false the rule is violated. In this case the given message + * object will be added to the status of this validator. + * + * There are some predefined rules for common use cases in the {@link ObservableRules} class that can be used. + * + * @param validProperty + * @param message + */ + public void addRule(ObservableValue validProperty, ValidationMessage message) { + unregisterableRules.add( + FXProperties.runNowAndOnPropertyChange((observable, oldValue, newValue) -> + validateBooleanRule(newValue, message) + , validProperty) + ); + } + + public void validateBooleanRule(boolean isValid, ValidationMessage message) { + if (isValid) { + hideMessage(message); + } else { + showMessage(message); + } + } + + @Override + public ValidationStatus getValidationStatus() { + return validationStatus; + } /** * Add a complex rule for this validator. @@ -140,26 +133,37 @@ public ValidationStatus getValidationStatus() { * If the observable doesn't contain a value (in other words it contains null) the rule is considered to * be fulfilled and the validation status of this validator will be valid (given that no other rule is violated). * - * - * This method allows some more complex rules compared to {@link #addRule(ObservableValue, ValidationMessage)}. - * This way you can define rules that have different messages for specific cases. + * + * This method allows some more complex rules compared to {@link #addRule(ObservableValue, ValidationMessage)}. + * This way you can define rules that have different messages for specific cases. * * @param rule */ public void addRule(ObservableValue rule) { - complexRules.add(rule); - - rule.addListener((observable, oldValue, newValue) -> { - if(oldValue != null) { - validationStatus.removeMessage(oldValue); - } - if(newValue != null) { - validationStatus.addMessage(newValue); - } - }); - - if(rule.getValue() != null) { - validationStatus.addMessage(rule.getValue()); + unregisterableRules.add( + FXProperties.runNowAndOnPropertyChange((observable, oldValue, newValue) -> { + hideMessage(oldValue); // does nothing if oldValue is null + showMessage(newValue); // does nothing if newValue is null + }, rule) + ); + } + + private void showMessage(ValidationMessage message) { + if (message != null) { + validationStatus.addMessage(message); + } + } + + private void hideMessage(ValidationMessage message) { + if (message != null) { + validationStatus.removeMessage(message); } } + + public void clear() { + unregisterableRules.forEach(Unregisterable::unregister); + unregisterableRules.clear(); + validationStatus.clearMessages(); + } + } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java index 57c3b90e3..9ece55d7b 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java @@ -15,6 +15,8 @@ ******************************************************************************/ package dev.webfx.stack.ui.validation.mvvmfx; +import javafx.beans.value.ObservableStringValue; + import java.util.Objects; /** @@ -25,26 +27,30 @@ */ public class ValidationMessage { - private final String message; + private final ObservableStringValue messageProperty; private final Severity severity; - public ValidationMessage(Severity severity, String message) { + public ValidationMessage(Severity severity, ObservableStringValue messageProperty) { this.severity = Objects.requireNonNull(severity); - this.message = Objects.requireNonNull(message); + this.messageProperty = Objects.requireNonNull(messageProperty); } - public static ValidationMessage warning(String message) { - return new ValidationMessage(Severity.WARNING, message); + public static ValidationMessage warning(ObservableStringValue messageProperty) { + return new ValidationMessage(Severity.WARNING, messageProperty); } - public static ValidationMessage error(String message) { - return new ValidationMessage(Severity.ERROR, message); + public static ValidationMessage error(ObservableStringValue messageProperty) { + return new ValidationMessage(Severity.ERROR, messageProperty); } + public ObservableStringValue messageProperty() { + return messageProperty; + } + public String getMessage() { - return message; + return messageProperty.get(); } public Severity getSeverity() { @@ -54,27 +60,27 @@ public Severity getSeverity() { @Override public String toString() { return "ValidationMessage{" + - "message='" + message + '\'' + - ", severity=" + severity + - '}'; + "messageProperty='" + messageProperty + '\'' + + ", severity=" + severity + + '}'; } @Override public boolean equals(Object o) { if (this == o) return true; - if (o == null || !(o instanceof ValidationMessage)) + if (!(o instanceof ValidationMessage)) return false; ValidationMessage that = (ValidationMessage) o; - return message.equals(that.message) && severity == that.severity; + return messageProperty.equals(that.messageProperty) && severity == that.severity; } @Override public int hashCode() { - int result = message.hashCode(); + int result = messageProperty.hashCode(); result = 31 * result + severity.hashCode(); return result; } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java index d1f82602e..82d4062fb 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java @@ -37,11 +37,11 @@ */ public class ValidationStatus { - private ListProperty messages = new SimpleListProperty<>(FXCollections.observableArrayList()); + private final ListProperty messages = new SimpleListProperty<>(FXCollections.observableArrayList()); - private ObservableList unmodifiableMessages = FXCollections.unmodifiableObservableList(messages); - private ObservableList errorMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.ERROR)); - private ObservableList warningMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.WARNING)); + private final ObservableList unmodifiableMessages = FXCollections.unmodifiableObservableList(messages); + private final ObservableList errorMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.ERROR)); + private final ObservableList warningMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.WARNING)); /** * Intended for subclasses used by special validator implementations. diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java index a3e093bd9..6ede92357 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java @@ -17,7 +17,7 @@ import dev.webfx.stack.ui.validation.mvvmfx.Severity; import dev.webfx.stack.ui.validation.mvvmfx.ValidationMessage; -import dev.webfx.stack.ui.validation.controlsfx.validation.ValidationSupport; +import dev.webfx.stack.ui.validation.controlsfx.validation.ControlsFxValidationSupport; import dev.webfx.stack.ui.validation.controlsfx.validation.decoration.GraphicValidationDecoration; import dev.webfx.stack.ui.validation.controlsfx.validation.decoration.ValidationDecoration; import javafx.scene.control.Control; @@ -52,7 +52,7 @@ public void setDecoration(ValidationDecoration decoration) { @Override void applyRequiredVisualization(Control control, boolean required) { - ValidationSupport.setRequired(control, required); + ControlsFxValidationSupport.setRequired(control, required); if (required) { decoration.applyRequiredDecoration(control); } @@ -74,12 +74,14 @@ void applyVisualization(Control control, Optional messageOpti } } else { - decoration.removeDecorations(control); - } - - if (required) { - decoration.applyRequiredDecoration(control); + removeDecorations(control); } + + applyRequiredVisualization(control, required); + } + + @Override + public void removeDecorations(Control control) { + decoration.removeDecorations(control); } - } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java index 4b6d33d41..447baca68 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java @@ -15,11 +15,12 @@ ******************************************************************************/ package dev.webfx.stack.ui.validation.mvvmfx.visualization; +import dev.webfx.kit.util.properties.FXProperties; +import dev.webfx.kit.util.properties.ObservableLists; +import dev.webfx.platform.uischeduler.UiScheduler; import dev.webfx.stack.ui.validation.mvvmfx.Severity; import dev.webfx.stack.ui.validation.mvvmfx.ValidationMessage; import dev.webfx.stack.ui.validation.mvvmfx.ValidationStatus; -import javafx.application.Platform; -import javafx.collections.ListChangeListener; import javafx.scene.control.Control; import java.util.Optional; @@ -42,20 +43,13 @@ public abstract class ValidationVisualizerBase implements ValidationVisualizer { @Override public void initVisualization(final ValidationStatus result, final Control control, boolean required) { if (control.getSkin() == null) { - control.skinProperty().addListener((observable, oldValue, newValue) -> initVisualization(result, control, required)); + FXProperties.onPropertySet(control.skinProperty(), skin -> initVisualization(result, control, required)); return; } - if (required) { - applyRequiredVisualization(control, required); - } - - applyVisualization(control, result.getHighestMessage(), required); - - result.getMessages().addListener((ListChangeListener) c -> { - while (c.next()) { - Platform.runLater(() -> applyVisualization(control, result.getHighestMessage(), required)); - } - }); + + ObservableLists.runNowAndOnListChange(c -> UiScheduler.runInUiThread(() -> + applyVisualization(control, result.getHighestMessage(), required) + ), result.getMessages()); } /** @@ -93,5 +87,7 @@ public void initVisualization(final ValidationStatus result, final Control contr * a boolean flag indicating whether this control is mandatory or not. */ abstract void applyVisualization(Control control, Optional messageOptional, boolean required); + + public abstract void removeDecorations(Control control); } diff --git a/webfx-stack-ui-validation/src/main/java/module-info.java b/webfx-stack-ui-validation/src/main/java/module-info.java index 9aca87547..b37e66d92 100644 --- a/webfx-stack-ui-validation/src/main/java/module-info.java +++ b/webfx-stack-ui-validation/src/main/java/module-info.java @@ -6,8 +6,16 @@ requires javafx.base; requires javafx.controls; requires javafx.graphics; + requires webfx.extras.imagestore; + requires webfx.extras.util.background; + requires webfx.extras.util.border; + requires webfx.extras.util.scene; + requires webfx.kit.util; + requires webfx.platform.uischeduler; + requires webfx.platform.util; // Exported packages + exports dev.webfx.stack.ui.validation; exports dev.webfx.stack.ui.validation.controlsfx.control.decoration; exports dev.webfx.stack.ui.validation.controlsfx.impl; exports dev.webfx.stack.ui.validation.controlsfx.impl.skin;
null
- * + *
* You can add multiple rules via the {@link #addRule(ObservableValue, ValidationMessage)} and {@link #addRule(ObservableValue)} method. * If multiple rules are violated, each message will be present. */ public class ObservableRuleBasedValidator implements Validator { - /* - These lists are used to store the rules that this validator is working with. - The reason for this is to prevent problems with garbage collection. - If the validator wouldn't keep references to all given rules it would be possible that they are - removed by the garbage collector which would result in wrong validation results. - To prevent this we store references to all given rules here. - Don't get confused by the fact that no values are only added to these lists but not obtained. - */ - private List> booleanRules = new ArrayList<>(); - private List> complexRules = new ArrayList<>(); - - private ValidationStatus validationStatus = new ValidationStatus(); + private final List unregisterableRules = new ArrayList<>(); + + private final ValidationStatus validationStatus = new ValidationStatus(); /** * Creates an instance of the Validator without any rules predefined. */ - public ObservableRuleBasedValidator() {} + public ObservableRuleBasedValidator() { + } /** * Creates an instance of the Validator with the given rule predefined. @@ -86,50 +80,49 @@ public ObservableRuleBasedValidator(ObservableValue rule, ValidationMes * Creates an instance of the Validator with the given complex rules predefined. * It's a shortcut for creating an empty validator and * adding one or multiple complex rules with {@link #addRule(ObservableValue)}. + * * @param rules */ - public ObservableRuleBasedValidator(ObservableValue ... rules) { + public ObservableRuleBasedValidator(ObservableValue... rules) { for (ObservableValue rule : rules) { addRule(rule); } } - /** - * Add a rule for this validator. - * - * The rule defines a condition that has to be fulfilled. - * - * A rule is defined by an observable boolean value. If the rule has a value of true the rule is - * "fulfilled". If the rule has a value of false the rule is violated. In this case the given message - * object will be added to the status of this validator. - * - * There are some predefined rules for common use cases in the {@link ObservableRules} class that can be used. - * - * @param rule - * @param message - */ - public void addRule(ObservableValue rule, ValidationMessage message) { - booleanRules.add(rule); - - rule.addListener((observable, oldValue, newValue) -> { - validateBooleanRule(newValue, message); - }); - - validateBooleanRule(rule.getValue(), message); - } - - private void validateBooleanRule(boolean isValid, ValidationMessage message) { - if (isValid) { - validationStatus.removeMessage(message); - } else { - validationStatus.addMessage(message); - } - } - - @Override - public ValidationStatus getValidationStatus() { - return validationStatus; - } + /** + * Add a rule for this validator. + * + * The rule defines a condition that has to be fulfilled. + * + * A rule is defined by an observable boolean value. If the rule has a value of true the rule is + * "fulfilled". If the rule has a value of false the rule is violated. In this case the given message + * object will be added to the status of this validator. + * + * There are some predefined rules for common use cases in the {@link ObservableRules} class that can be used. + * + * @param validProperty + * @param message + */ + public void addRule(ObservableValue validProperty, ValidationMessage message) { + unregisterableRules.add( + FXProperties.runNowAndOnPropertyChange((observable, oldValue, newValue) -> + validateBooleanRule(newValue, message) + , validProperty) + ); + } + + public void validateBooleanRule(boolean isValid, ValidationMessage message) { + if (isValid) { + hideMessage(message); + } else { + showMessage(message); + } + } + + @Override + public ValidationStatus getValidationStatus() { + return validationStatus; + } /** * Add a complex rule for this validator. @@ -140,26 +133,37 @@ public ValidationStatus getValidationStatus() { * If the observable doesn't contain a value (in other words it contains null) the rule is considered to * be fulfilled and the validation status of this validator will be valid (given that no other rule is violated). * - * - * This method allows some more complex rules compared to {@link #addRule(ObservableValue, ValidationMessage)}. - * This way you can define rules that have different messages for specific cases. + * + * This method allows some more complex rules compared to {@link #addRule(ObservableValue, ValidationMessage)}. + * This way you can define rules that have different messages for specific cases. * * @param rule */ public void addRule(ObservableValue rule) { - complexRules.add(rule); - - rule.addListener((observable, oldValue, newValue) -> { - if(oldValue != null) { - validationStatus.removeMessage(oldValue); - } - if(newValue != null) { - validationStatus.addMessage(newValue); - } - }); - - if(rule.getValue() != null) { - validationStatus.addMessage(rule.getValue()); + unregisterableRules.add( + FXProperties.runNowAndOnPropertyChange((observable, oldValue, newValue) -> { + hideMessage(oldValue); // does nothing if oldValue is null + showMessage(newValue); // does nothing if newValue is null + }, rule) + ); + } + + private void showMessage(ValidationMessage message) { + if (message != null) { + validationStatus.addMessage(message); + } + } + + private void hideMessage(ValidationMessage message) { + if (message != null) { + validationStatus.removeMessage(message); } } + + public void clear() { + unregisterableRules.forEach(Unregisterable::unregister); + unregisterableRules.clear(); + validationStatus.clearMessages(); + } + } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java index 57c3b90e3..9ece55d7b 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java @@ -15,6 +15,8 @@ ******************************************************************************/ package dev.webfx.stack.ui.validation.mvvmfx; +import javafx.beans.value.ObservableStringValue; + import java.util.Objects; /** @@ -25,26 +27,30 @@ */ public class ValidationMessage { - private final String message; + private final ObservableStringValue messageProperty; private final Severity severity; - public ValidationMessage(Severity severity, String message) { + public ValidationMessage(Severity severity, ObservableStringValue messageProperty) { this.severity = Objects.requireNonNull(severity); - this.message = Objects.requireNonNull(message); + this.messageProperty = Objects.requireNonNull(messageProperty); } - public static ValidationMessage warning(String message) { - return new ValidationMessage(Severity.WARNING, message); + public static ValidationMessage warning(ObservableStringValue messageProperty) { + return new ValidationMessage(Severity.WARNING, messageProperty); } - public static ValidationMessage error(String message) { - return new ValidationMessage(Severity.ERROR, message); + public static ValidationMessage error(ObservableStringValue messageProperty) { + return new ValidationMessage(Severity.ERROR, messageProperty); } + public ObservableStringValue messageProperty() { + return messageProperty; + } + public String getMessage() { - return message; + return messageProperty.get(); } public Severity getSeverity() { @@ -54,27 +60,27 @@ public Severity getSeverity() { @Override public String toString() { return "ValidationMessage{" + - "message='" + message + '\'' + - ", severity=" + severity + - '}'; + "messageProperty='" + messageProperty + '\'' + + ", severity=" + severity + + '}'; } @Override public boolean equals(Object o) { if (this == o) return true; - if (o == null || !(o instanceof ValidationMessage)) + if (!(o instanceof ValidationMessage)) return false; ValidationMessage that = (ValidationMessage) o; - return message.equals(that.message) && severity == that.severity; + return messageProperty.equals(that.messageProperty) && severity == that.severity; } @Override public int hashCode() { - int result = message.hashCode(); + int result = messageProperty.hashCode(); result = 31 * result + severity.hashCode(); return result; } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java index d1f82602e..82d4062fb 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java @@ -37,11 +37,11 @@ */ public class ValidationStatus { - private ListProperty messages = new SimpleListProperty<>(FXCollections.observableArrayList()); + private final ListProperty messages = new SimpleListProperty<>(FXCollections.observableArrayList()); - private ObservableList unmodifiableMessages = FXCollections.unmodifiableObservableList(messages); - private ObservableList errorMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.ERROR)); - private ObservableList warningMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.WARNING)); + private final ObservableList unmodifiableMessages = FXCollections.unmodifiableObservableList(messages); + private final ObservableList errorMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.ERROR)); + private final ObservableList warningMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.WARNING)); /** * Intended for subclasses used by special validator implementations. diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java index a3e093bd9..6ede92357 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java @@ -17,7 +17,7 @@ import dev.webfx.stack.ui.validation.mvvmfx.Severity; import dev.webfx.stack.ui.validation.mvvmfx.ValidationMessage; -import dev.webfx.stack.ui.validation.controlsfx.validation.ValidationSupport; +import dev.webfx.stack.ui.validation.controlsfx.validation.ControlsFxValidationSupport; import dev.webfx.stack.ui.validation.controlsfx.validation.decoration.GraphicValidationDecoration; import dev.webfx.stack.ui.validation.controlsfx.validation.decoration.ValidationDecoration; import javafx.scene.control.Control; @@ -52,7 +52,7 @@ public void setDecoration(ValidationDecoration decoration) { @Override void applyRequiredVisualization(Control control, boolean required) { - ValidationSupport.setRequired(control, required); + ControlsFxValidationSupport.setRequired(control, required); if (required) { decoration.applyRequiredDecoration(control); } @@ -74,12 +74,14 @@ void applyVisualization(Control control, Optional messageOpti } } else { - decoration.removeDecorations(control); - } - - if (required) { - decoration.applyRequiredDecoration(control); + removeDecorations(control); } + + applyRequiredVisualization(control, required); + } + + @Override + public void removeDecorations(Control control) { + decoration.removeDecorations(control); } - } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java index 4b6d33d41..447baca68 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java @@ -15,11 +15,12 @@ ******************************************************************************/ package dev.webfx.stack.ui.validation.mvvmfx.visualization; +import dev.webfx.kit.util.properties.FXProperties; +import dev.webfx.kit.util.properties.ObservableLists; +import dev.webfx.platform.uischeduler.UiScheduler; import dev.webfx.stack.ui.validation.mvvmfx.Severity; import dev.webfx.stack.ui.validation.mvvmfx.ValidationMessage; import dev.webfx.stack.ui.validation.mvvmfx.ValidationStatus; -import javafx.application.Platform; -import javafx.collections.ListChangeListener; import javafx.scene.control.Control; import java.util.Optional; @@ -42,20 +43,13 @@ public abstract class ValidationVisualizerBase implements ValidationVisualizer { @Override public void initVisualization(final ValidationStatus result, final Control control, boolean required) { if (control.getSkin() == null) { - control.skinProperty().addListener((observable, oldValue, newValue) -> initVisualization(result, control, required)); + FXProperties.onPropertySet(control.skinProperty(), skin -> initVisualization(result, control, required)); return; } - if (required) { - applyRequiredVisualization(control, required); - } - - applyVisualization(control, result.getHighestMessage(), required); - - result.getMessages().addListener((ListChangeListener) c -> { - while (c.next()) { - Platform.runLater(() -> applyVisualization(control, result.getHighestMessage(), required)); - } - }); + + ObservableLists.runNowAndOnListChange(c -> UiScheduler.runInUiThread(() -> + applyVisualization(control, result.getHighestMessage(), required) + ), result.getMessages()); } /** @@ -93,5 +87,7 @@ public void initVisualization(final ValidationStatus result, final Control contr * a boolean flag indicating whether this control is mandatory or not. */ abstract void applyVisualization(Control control, Optional messageOptional, boolean required); + + public abstract void removeDecorations(Control control); } diff --git a/webfx-stack-ui-validation/src/main/java/module-info.java b/webfx-stack-ui-validation/src/main/java/module-info.java index 9aca87547..b37e66d92 100644 --- a/webfx-stack-ui-validation/src/main/java/module-info.java +++ b/webfx-stack-ui-validation/src/main/java/module-info.java @@ -6,8 +6,16 @@ requires javafx.base; requires javafx.controls; requires javafx.graphics; + requires webfx.extras.imagestore; + requires webfx.extras.util.background; + requires webfx.extras.util.border; + requires webfx.extras.util.scene; + requires webfx.kit.util; + requires webfx.platform.uischeduler; + requires webfx.platform.util; // Exported packages + exports dev.webfx.stack.ui.validation; exports dev.webfx.stack.ui.validation.controlsfx.control.decoration; exports dev.webfx.stack.ui.validation.controlsfx.impl; exports dev.webfx.stack.ui.validation.controlsfx.impl.skin;
- * The rule defines a condition that has to be fulfilled. - *
- * A rule is defined by an observable boolean value. If the rule has a value of true the rule is - * "fulfilled". If the rule has a value of false the rule is violated. In this case the given message - * object will be added to the status of this validator. - *
true
- * There are some predefined rules for common use cases in the {@link ObservableRules} class that can be used. - * - * @param rule - * @param message - */ - public void addRule(ObservableValue rule, ValidationMessage message) { - booleanRules.add(rule); - - rule.addListener((observable, oldValue, newValue) -> { - validateBooleanRule(newValue, message); - }); - - validateBooleanRule(rule.getValue(), message); - } - - private void validateBooleanRule(boolean isValid, ValidationMessage message) { - if (isValid) { - validationStatus.removeMessage(message); - } else { - validationStatus.addMessage(message); - } - } - - @Override - public ValidationStatus getValidationStatus() { - return validationStatus; - } + /** + * Add a rule for this validator. + * + * The rule defines a condition that has to be fulfilled. + * + * A rule is defined by an observable boolean value. If the rule has a value of true the rule is + * "fulfilled". If the rule has a value of false the rule is violated. In this case the given message + * object will be added to the status of this validator. + * + * There are some predefined rules for common use cases in the {@link ObservableRules} class that can be used. + * + * @param validProperty + * @param message + */ + public void addRule(ObservableValue validProperty, ValidationMessage message) { + unregisterableRules.add( + FXProperties.runNowAndOnPropertyChange((observable, oldValue, newValue) -> + validateBooleanRule(newValue, message) + , validProperty) + ); + } + + public void validateBooleanRule(boolean isValid, ValidationMessage message) { + if (isValid) { + hideMessage(message); + } else { + showMessage(message); + } + } + + @Override + public ValidationStatus getValidationStatus() { + return validationStatus; + } /** * Add a complex rule for this validator. @@ -140,26 +133,37 @@ public ValidationStatus getValidationStatus() { * If the observable doesn't contain a value (in other words it contains null) the rule is considered to * be fulfilled and the validation status of this validator will be valid (given that no other rule is violated). * - * - * This method allows some more complex rules compared to {@link #addRule(ObservableValue, ValidationMessage)}. - * This way you can define rules that have different messages for specific cases. + * + * This method allows some more complex rules compared to {@link #addRule(ObservableValue, ValidationMessage)}. + * This way you can define rules that have different messages for specific cases. * * @param rule */ public void addRule(ObservableValue rule) { - complexRules.add(rule); - - rule.addListener((observable, oldValue, newValue) -> { - if(oldValue != null) { - validationStatus.removeMessage(oldValue); - } - if(newValue != null) { - validationStatus.addMessage(newValue); - } - }); - - if(rule.getValue() != null) { - validationStatus.addMessage(rule.getValue()); + unregisterableRules.add( + FXProperties.runNowAndOnPropertyChange((observable, oldValue, newValue) -> { + hideMessage(oldValue); // does nothing if oldValue is null + showMessage(newValue); // does nothing if newValue is null + }, rule) + ); + } + + private void showMessage(ValidationMessage message) { + if (message != null) { + validationStatus.addMessage(message); + } + } + + private void hideMessage(ValidationMessage message) { + if (message != null) { + validationStatus.removeMessage(message); } } + + public void clear() { + unregisterableRules.forEach(Unregisterable::unregister); + unregisterableRules.clear(); + validationStatus.clearMessages(); + } + } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java index 57c3b90e3..9ece55d7b 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java @@ -15,6 +15,8 @@ ******************************************************************************/ package dev.webfx.stack.ui.validation.mvvmfx; +import javafx.beans.value.ObservableStringValue; + import java.util.Objects; /** @@ -25,26 +27,30 @@ */ public class ValidationMessage { - private final String message; + private final ObservableStringValue messageProperty; private final Severity severity; - public ValidationMessage(Severity severity, String message) { + public ValidationMessage(Severity severity, ObservableStringValue messageProperty) { this.severity = Objects.requireNonNull(severity); - this.message = Objects.requireNonNull(message); + this.messageProperty = Objects.requireNonNull(messageProperty); } - public static ValidationMessage warning(String message) { - return new ValidationMessage(Severity.WARNING, message); + public static ValidationMessage warning(ObservableStringValue messageProperty) { + return new ValidationMessage(Severity.WARNING, messageProperty); } - public static ValidationMessage error(String message) { - return new ValidationMessage(Severity.ERROR, message); + public static ValidationMessage error(ObservableStringValue messageProperty) { + return new ValidationMessage(Severity.ERROR, messageProperty); } + public ObservableStringValue messageProperty() { + return messageProperty; + } + public String getMessage() { - return message; + return messageProperty.get(); } public Severity getSeverity() { @@ -54,27 +60,27 @@ public Severity getSeverity() { @Override public String toString() { return "ValidationMessage{" + - "message='" + message + '\'' + - ", severity=" + severity + - '}'; + "messageProperty='" + messageProperty + '\'' + + ", severity=" + severity + + '}'; } @Override public boolean equals(Object o) { if (this == o) return true; - if (o == null || !(o instanceof ValidationMessage)) + if (!(o instanceof ValidationMessage)) return false; ValidationMessage that = (ValidationMessage) o; - return message.equals(that.message) && severity == that.severity; + return messageProperty.equals(that.messageProperty) && severity == that.severity; } @Override public int hashCode() { - int result = message.hashCode(); + int result = messageProperty.hashCode(); result = 31 * result + severity.hashCode(); return result; } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java index d1f82602e..82d4062fb 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java @@ -37,11 +37,11 @@ */ public class ValidationStatus { - private ListProperty messages = new SimpleListProperty<>(FXCollections.observableArrayList()); + private final ListProperty messages = new SimpleListProperty<>(FXCollections.observableArrayList()); - private ObservableList unmodifiableMessages = FXCollections.unmodifiableObservableList(messages); - private ObservableList errorMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.ERROR)); - private ObservableList warningMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.WARNING)); + private final ObservableList unmodifiableMessages = FXCollections.unmodifiableObservableList(messages); + private final ObservableList errorMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.ERROR)); + private final ObservableList warningMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.WARNING)); /** * Intended for subclasses used by special validator implementations. diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java index a3e093bd9..6ede92357 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java @@ -17,7 +17,7 @@ import dev.webfx.stack.ui.validation.mvvmfx.Severity; import dev.webfx.stack.ui.validation.mvvmfx.ValidationMessage; -import dev.webfx.stack.ui.validation.controlsfx.validation.ValidationSupport; +import dev.webfx.stack.ui.validation.controlsfx.validation.ControlsFxValidationSupport; import dev.webfx.stack.ui.validation.controlsfx.validation.decoration.GraphicValidationDecoration; import dev.webfx.stack.ui.validation.controlsfx.validation.decoration.ValidationDecoration; import javafx.scene.control.Control; @@ -52,7 +52,7 @@ public void setDecoration(ValidationDecoration decoration) { @Override void applyRequiredVisualization(Control control, boolean required) { - ValidationSupport.setRequired(control, required); + ControlsFxValidationSupport.setRequired(control, required); if (required) { decoration.applyRequiredDecoration(control); } @@ -74,12 +74,14 @@ void applyVisualization(Control control, Optional messageOpti } } else { - decoration.removeDecorations(control); - } - - if (required) { - decoration.applyRequiredDecoration(control); + removeDecorations(control); } + + applyRequiredVisualization(control, required); + } + + @Override + public void removeDecorations(Control control) { + decoration.removeDecorations(control); } - } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java index 4b6d33d41..447baca68 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java @@ -15,11 +15,12 @@ ******************************************************************************/ package dev.webfx.stack.ui.validation.mvvmfx.visualization; +import dev.webfx.kit.util.properties.FXProperties; +import dev.webfx.kit.util.properties.ObservableLists; +import dev.webfx.platform.uischeduler.UiScheduler; import dev.webfx.stack.ui.validation.mvvmfx.Severity; import dev.webfx.stack.ui.validation.mvvmfx.ValidationMessage; import dev.webfx.stack.ui.validation.mvvmfx.ValidationStatus; -import javafx.application.Platform; -import javafx.collections.ListChangeListener; import javafx.scene.control.Control; import java.util.Optional; @@ -42,20 +43,13 @@ public abstract class ValidationVisualizerBase implements ValidationVisualizer { @Override public void initVisualization(final ValidationStatus result, final Control control, boolean required) { if (control.getSkin() == null) { - control.skinProperty().addListener((observable, oldValue, newValue) -> initVisualization(result, control, required)); + FXProperties.onPropertySet(control.skinProperty(), skin -> initVisualization(result, control, required)); return; } - if (required) { - applyRequiredVisualization(control, required); - } - - applyVisualization(control, result.getHighestMessage(), required); - - result.getMessages().addListener((ListChangeListener) c -> { - while (c.next()) { - Platform.runLater(() -> applyVisualization(control, result.getHighestMessage(), required)); - } - }); + + ObservableLists.runNowAndOnListChange(c -> UiScheduler.runInUiThread(() -> + applyVisualization(control, result.getHighestMessage(), required) + ), result.getMessages()); } /** @@ -93,5 +87,7 @@ public void initVisualization(final ValidationStatus result, final Control contr * a boolean flag indicating whether this control is mandatory or not. */ abstract void applyVisualization(Control control, Optional messageOptional, boolean required); + + public abstract void removeDecorations(Control control); } diff --git a/webfx-stack-ui-validation/src/main/java/module-info.java b/webfx-stack-ui-validation/src/main/java/module-info.java index 9aca87547..b37e66d92 100644 --- a/webfx-stack-ui-validation/src/main/java/module-info.java +++ b/webfx-stack-ui-validation/src/main/java/module-info.java @@ -6,8 +6,16 @@ requires javafx.base; requires javafx.controls; requires javafx.graphics; + requires webfx.extras.imagestore; + requires webfx.extras.util.background; + requires webfx.extras.util.border; + requires webfx.extras.util.scene; + requires webfx.kit.util; + requires webfx.platform.uischeduler; + requires webfx.platform.util; // Exported packages + exports dev.webfx.stack.ui.validation; exports dev.webfx.stack.ui.validation.controlsfx.control.decoration; exports dev.webfx.stack.ui.validation.controlsfx.impl; exports dev.webfx.stack.ui.validation.controlsfx.impl.skin;
+ * The rule defines a condition that has to be fulfilled. + *
+ * A rule is defined by an observable boolean value. If the rule has a value of true the rule is + * "fulfilled". If the rule has a value of false the rule is violated. In this case the given message + * object will be added to the status of this validator. + *
+ * There are some predefined rules for common use cases in the {@link ObservableRules} class that can be used. + * + * @param validProperty + * @param message + */ + public void addRule(ObservableValue validProperty, ValidationMessage message) { + unregisterableRules.add( + FXProperties.runNowAndOnPropertyChange((observable, oldValue, newValue) -> + validateBooleanRule(newValue, message) + , validProperty) + ); + } + + public void validateBooleanRule(boolean isValid, ValidationMessage message) { + if (isValid) { + hideMessage(message); + } else { + showMessage(message); + } + } + + @Override + public ValidationStatus getValidationStatus() { + return validationStatus; + } /** * Add a complex rule for this validator. @@ -140,26 +133,37 @@ public ValidationStatus getValidationStatus() { * If the observable doesn't contain a value (in other words it contains null) the rule is considered to * be fulfilled and the validation status of this validator will be valid (given that no other rule is violated). * - * - * This method allows some more complex rules compared to {@link #addRule(ObservableValue, ValidationMessage)}. - * This way you can define rules that have different messages for specific cases. + * + * This method allows some more complex rules compared to {@link #addRule(ObservableValue, ValidationMessage)}. + * This way you can define rules that have different messages for specific cases. * * @param rule */ public void addRule(ObservableValue rule) { - complexRules.add(rule); - - rule.addListener((observable, oldValue, newValue) -> { - if(oldValue != null) { - validationStatus.removeMessage(oldValue); - } - if(newValue != null) { - validationStatus.addMessage(newValue); - } - }); - - if(rule.getValue() != null) { - validationStatus.addMessage(rule.getValue()); + unregisterableRules.add( + FXProperties.runNowAndOnPropertyChange((observable, oldValue, newValue) -> { + hideMessage(oldValue); // does nothing if oldValue is null + showMessage(newValue); // does nothing if newValue is null + }, rule) + ); + } + + private void showMessage(ValidationMessage message) { + if (message != null) { + validationStatus.addMessage(message); + } + } + + private void hideMessage(ValidationMessage message) { + if (message != null) { + validationStatus.removeMessage(message); } } + + public void clear() { + unregisterableRules.forEach(Unregisterable::unregister); + unregisterableRules.clear(); + validationStatus.clearMessages(); + } + } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java index 57c3b90e3..9ece55d7b 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java @@ -15,6 +15,8 @@ ******************************************************************************/ package dev.webfx.stack.ui.validation.mvvmfx; +import javafx.beans.value.ObservableStringValue; + import java.util.Objects; /** @@ -25,26 +27,30 @@ */ public class ValidationMessage { - private final String message; + private final ObservableStringValue messageProperty; private final Severity severity; - public ValidationMessage(Severity severity, String message) { + public ValidationMessage(Severity severity, ObservableStringValue messageProperty) { this.severity = Objects.requireNonNull(severity); - this.message = Objects.requireNonNull(message); + this.messageProperty = Objects.requireNonNull(messageProperty); } - public static ValidationMessage warning(String message) { - return new ValidationMessage(Severity.WARNING, message); + public static ValidationMessage warning(ObservableStringValue messageProperty) { + return new ValidationMessage(Severity.WARNING, messageProperty); } - public static ValidationMessage error(String message) { - return new ValidationMessage(Severity.ERROR, message); + public static ValidationMessage error(ObservableStringValue messageProperty) { + return new ValidationMessage(Severity.ERROR, messageProperty); } + public ObservableStringValue messageProperty() { + return messageProperty; + } + public String getMessage() { - return message; + return messageProperty.get(); } public Severity getSeverity() { @@ -54,27 +60,27 @@ public Severity getSeverity() { @Override public String toString() { return "ValidationMessage{" + - "message='" + message + '\'' + - ", severity=" + severity + - '}'; + "messageProperty='" + messageProperty + '\'' + + ", severity=" + severity + + '}'; } @Override public boolean equals(Object o) { if (this == o) return true; - if (o == null || !(o instanceof ValidationMessage)) + if (!(o instanceof ValidationMessage)) return false; ValidationMessage that = (ValidationMessage) o; - return message.equals(that.message) && severity == that.severity; + return messageProperty.equals(that.messageProperty) && severity == that.severity; } @Override public int hashCode() { - int result = message.hashCode(); + int result = messageProperty.hashCode(); result = 31 * result + severity.hashCode(); return result; } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java index d1f82602e..82d4062fb 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java @@ -37,11 +37,11 @@ */ public class ValidationStatus { - private ListProperty messages = new SimpleListProperty<>(FXCollections.observableArrayList()); + private final ListProperty messages = new SimpleListProperty<>(FXCollections.observableArrayList()); - private ObservableList unmodifiableMessages = FXCollections.unmodifiableObservableList(messages); - private ObservableList errorMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.ERROR)); - private ObservableList warningMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.WARNING)); + private final ObservableList unmodifiableMessages = FXCollections.unmodifiableObservableList(messages); + private final ObservableList errorMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.ERROR)); + private final ObservableList warningMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.WARNING)); /** * Intended for subclasses used by special validator implementations. diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java index a3e093bd9..6ede92357 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java @@ -17,7 +17,7 @@ import dev.webfx.stack.ui.validation.mvvmfx.Severity; import dev.webfx.stack.ui.validation.mvvmfx.ValidationMessage; -import dev.webfx.stack.ui.validation.controlsfx.validation.ValidationSupport; +import dev.webfx.stack.ui.validation.controlsfx.validation.ControlsFxValidationSupport; import dev.webfx.stack.ui.validation.controlsfx.validation.decoration.GraphicValidationDecoration; import dev.webfx.stack.ui.validation.controlsfx.validation.decoration.ValidationDecoration; import javafx.scene.control.Control; @@ -52,7 +52,7 @@ public void setDecoration(ValidationDecoration decoration) { @Override void applyRequiredVisualization(Control control, boolean required) { - ValidationSupport.setRequired(control, required); + ControlsFxValidationSupport.setRequired(control, required); if (required) { decoration.applyRequiredDecoration(control); } @@ -74,12 +74,14 @@ void applyVisualization(Control control, Optional messageOpti } } else { - decoration.removeDecorations(control); - } - - if (required) { - decoration.applyRequiredDecoration(control); + removeDecorations(control); } + + applyRequiredVisualization(control, required); + } + + @Override + public void removeDecorations(Control control) { + decoration.removeDecorations(control); } - } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java index 4b6d33d41..447baca68 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java @@ -15,11 +15,12 @@ ******************************************************************************/ package dev.webfx.stack.ui.validation.mvvmfx.visualization; +import dev.webfx.kit.util.properties.FXProperties; +import dev.webfx.kit.util.properties.ObservableLists; +import dev.webfx.platform.uischeduler.UiScheduler; import dev.webfx.stack.ui.validation.mvvmfx.Severity; import dev.webfx.stack.ui.validation.mvvmfx.ValidationMessage; import dev.webfx.stack.ui.validation.mvvmfx.ValidationStatus; -import javafx.application.Platform; -import javafx.collections.ListChangeListener; import javafx.scene.control.Control; import java.util.Optional; @@ -42,20 +43,13 @@ public abstract class ValidationVisualizerBase implements ValidationVisualizer { @Override public void initVisualization(final ValidationStatus result, final Control control, boolean required) { if (control.getSkin() == null) { - control.skinProperty().addListener((observable, oldValue, newValue) -> initVisualization(result, control, required)); + FXProperties.onPropertySet(control.skinProperty(), skin -> initVisualization(result, control, required)); return; } - if (required) { - applyRequiredVisualization(control, required); - } - - applyVisualization(control, result.getHighestMessage(), required); - - result.getMessages().addListener((ListChangeListener) c -> { - while (c.next()) { - Platform.runLater(() -> applyVisualization(control, result.getHighestMessage(), required)); - } - }); + + ObservableLists.runNowAndOnListChange(c -> UiScheduler.runInUiThread(() -> + applyVisualization(control, result.getHighestMessage(), required) + ), result.getMessages()); } /** @@ -93,5 +87,7 @@ public void initVisualization(final ValidationStatus result, final Control contr * a boolean flag indicating whether this control is mandatory or not. */ abstract void applyVisualization(Control control, Optional messageOptional, boolean required); + + public abstract void removeDecorations(Control control); } diff --git a/webfx-stack-ui-validation/src/main/java/module-info.java b/webfx-stack-ui-validation/src/main/java/module-info.java index 9aca87547..b37e66d92 100644 --- a/webfx-stack-ui-validation/src/main/java/module-info.java +++ b/webfx-stack-ui-validation/src/main/java/module-info.java @@ -6,8 +6,16 @@ requires javafx.base; requires javafx.controls; requires javafx.graphics; + requires webfx.extras.imagestore; + requires webfx.extras.util.background; + requires webfx.extras.util.border; + requires webfx.extras.util.scene; + requires webfx.kit.util; + requires webfx.platform.uischeduler; + requires webfx.platform.util; // Exported packages + exports dev.webfx.stack.ui.validation; exports dev.webfx.stack.ui.validation.controlsfx.control.decoration; exports dev.webfx.stack.ui.validation.controlsfx.impl; exports dev.webfx.stack.ui.validation.controlsfx.impl.skin;
- * - * This method allows some more complex rules compared to {@link #addRule(ObservableValue, ValidationMessage)}. - * This way you can define rules that have different messages for specific cases. + *
+ * This method allows some more complex rules compared to {@link #addRule(ObservableValue, ValidationMessage)}. + * This way you can define rules that have different messages for specific cases. * * @param rule */ public void addRule(ObservableValue rule) { - complexRules.add(rule); - - rule.addListener((observable, oldValue, newValue) -> { - if(oldValue != null) { - validationStatus.removeMessage(oldValue); - } - if(newValue != null) { - validationStatus.addMessage(newValue); - } - }); - - if(rule.getValue() != null) { - validationStatus.addMessage(rule.getValue()); + unregisterableRules.add( + FXProperties.runNowAndOnPropertyChange((observable, oldValue, newValue) -> { + hideMessage(oldValue); // does nothing if oldValue is null + showMessage(newValue); // does nothing if newValue is null + }, rule) + ); + } + + private void showMessage(ValidationMessage message) { + if (message != null) { + validationStatus.addMessage(message); + } + } + + private void hideMessage(ValidationMessage message) { + if (message != null) { + validationStatus.removeMessage(message); } } + + public void clear() { + unregisterableRules.forEach(Unregisterable::unregister); + unregisterableRules.clear(); + validationStatus.clearMessages(); + } + } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java index 57c3b90e3..9ece55d7b 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationMessage.java @@ -15,6 +15,8 @@ ******************************************************************************/ package dev.webfx.stack.ui.validation.mvvmfx; +import javafx.beans.value.ObservableStringValue; + import java.util.Objects; /** @@ -25,26 +27,30 @@ */ public class ValidationMessage { - private final String message; + private final ObservableStringValue messageProperty; private final Severity severity; - public ValidationMessage(Severity severity, String message) { + public ValidationMessage(Severity severity, ObservableStringValue messageProperty) { this.severity = Objects.requireNonNull(severity); - this.message = Objects.requireNonNull(message); + this.messageProperty = Objects.requireNonNull(messageProperty); } - public static ValidationMessage warning(String message) { - return new ValidationMessage(Severity.WARNING, message); + public static ValidationMessage warning(ObservableStringValue messageProperty) { + return new ValidationMessage(Severity.WARNING, messageProperty); } - public static ValidationMessage error(String message) { - return new ValidationMessage(Severity.ERROR, message); + public static ValidationMessage error(ObservableStringValue messageProperty) { + return new ValidationMessage(Severity.ERROR, messageProperty); } + public ObservableStringValue messageProperty() { + return messageProperty; + } + public String getMessage() { - return message; + return messageProperty.get(); } public Severity getSeverity() { @@ -54,27 +60,27 @@ public Severity getSeverity() { @Override public String toString() { return "ValidationMessage{" + - "message='" + message + '\'' + - ", severity=" + severity + - '}'; + "messageProperty='" + messageProperty + '\'' + + ", severity=" + severity + + '}'; } @Override public boolean equals(Object o) { if (this == o) return true; - if (o == null || !(o instanceof ValidationMessage)) + if (!(o instanceof ValidationMessage)) return false; ValidationMessage that = (ValidationMessage) o; - return message.equals(that.message) && severity == that.severity; + return messageProperty.equals(that.messageProperty) && severity == that.severity; } @Override public int hashCode() { - int result = message.hashCode(); + int result = messageProperty.hashCode(); result = 31 * result + severity.hashCode(); return result; } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java index d1f82602e..82d4062fb 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/ValidationStatus.java @@ -37,11 +37,11 @@ */ public class ValidationStatus { - private ListProperty messages = new SimpleListProperty<>(FXCollections.observableArrayList()); + private final ListProperty messages = new SimpleListProperty<>(FXCollections.observableArrayList()); - private ObservableList unmodifiableMessages = FXCollections.unmodifiableObservableList(messages); - private ObservableList errorMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.ERROR)); - private ObservableList warningMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.WARNING)); + private final ObservableList unmodifiableMessages = FXCollections.unmodifiableObservableList(messages); + private final ObservableList errorMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.ERROR)); + private final ObservableList warningMessages = new FilteredList<>(unmodifiableMessages, message -> message.getSeverity().equals(Severity.WARNING)); /** * Intended for subclasses used by special validator implementations. diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java index a3e093bd9..6ede92357 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ControlsFxVisualizer.java @@ -17,7 +17,7 @@ import dev.webfx.stack.ui.validation.mvvmfx.Severity; import dev.webfx.stack.ui.validation.mvvmfx.ValidationMessage; -import dev.webfx.stack.ui.validation.controlsfx.validation.ValidationSupport; +import dev.webfx.stack.ui.validation.controlsfx.validation.ControlsFxValidationSupport; import dev.webfx.stack.ui.validation.controlsfx.validation.decoration.GraphicValidationDecoration; import dev.webfx.stack.ui.validation.controlsfx.validation.decoration.ValidationDecoration; import javafx.scene.control.Control; @@ -52,7 +52,7 @@ public void setDecoration(ValidationDecoration decoration) { @Override void applyRequiredVisualization(Control control, boolean required) { - ValidationSupport.setRequired(control, required); + ControlsFxValidationSupport.setRequired(control, required); if (required) { decoration.applyRequiredDecoration(control); } @@ -74,12 +74,14 @@ void applyVisualization(Control control, Optional messageOpti } } else { - decoration.removeDecorations(control); - } - - if (required) { - decoration.applyRequiredDecoration(control); + removeDecorations(control); } + + applyRequiredVisualization(control, required); + } + + @Override + public void removeDecorations(Control control) { + decoration.removeDecorations(control); } - } diff --git a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java index 4b6d33d41..447baca68 100644 --- a/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java +++ b/webfx-stack-ui-validation/src/main/java/dev/webfx/stack/ui/validation/mvvmfx/visualization/ValidationVisualizerBase.java @@ -15,11 +15,12 @@ ******************************************************************************/ package dev.webfx.stack.ui.validation.mvvmfx.visualization; +import dev.webfx.kit.util.properties.FXProperties; +import dev.webfx.kit.util.properties.ObservableLists; +import dev.webfx.platform.uischeduler.UiScheduler; import dev.webfx.stack.ui.validation.mvvmfx.Severity; import dev.webfx.stack.ui.validation.mvvmfx.ValidationMessage; import dev.webfx.stack.ui.validation.mvvmfx.ValidationStatus; -import javafx.application.Platform; -import javafx.collections.ListChangeListener; import javafx.scene.control.Control; import java.util.Optional; @@ -42,20 +43,13 @@ public abstract class ValidationVisualizerBase implements ValidationVisualizer { @Override public void initVisualization(final ValidationStatus result, final Control control, boolean required) { if (control.getSkin() == null) { - control.skinProperty().addListener((observable, oldValue, newValue) -> initVisualization(result, control, required)); + FXProperties.onPropertySet(control.skinProperty(), skin -> initVisualization(result, control, required)); return; } - if (required) { - applyRequiredVisualization(control, required); - } - - applyVisualization(control, result.getHighestMessage(), required); - - result.getMessages().addListener((ListChangeListener) c -> { - while (c.next()) { - Platform.runLater(() -> applyVisualization(control, result.getHighestMessage(), required)); - } - }); + + ObservableLists.runNowAndOnListChange(c -> UiScheduler.runInUiThread(() -> + applyVisualization(control, result.getHighestMessage(), required) + ), result.getMessages()); } /** @@ -93,5 +87,7 @@ public void initVisualization(final ValidationStatus result, final Control contr * a boolean flag indicating whether this control is mandatory or not. */ abstract void applyVisualization(Control control, Optional messageOptional, boolean required); + + public abstract void removeDecorations(Control control); } diff --git a/webfx-stack-ui-validation/src/main/java/module-info.java b/webfx-stack-ui-validation/src/main/java/module-info.java index 9aca87547..b37e66d92 100644 --- a/webfx-stack-ui-validation/src/main/java/module-info.java +++ b/webfx-stack-ui-validation/src/main/java/module-info.java @@ -6,8 +6,16 @@ requires javafx.base; requires javafx.controls; requires javafx.graphics; + requires webfx.extras.imagestore; + requires webfx.extras.util.background; + requires webfx.extras.util.border; + requires webfx.extras.util.scene; + requires webfx.kit.util; + requires webfx.platform.uischeduler; + requires webfx.platform.util; // Exported packages + exports dev.webfx.stack.ui.validation; exports dev.webfx.stack.ui.validation.controlsfx.control.decoration; exports dev.webfx.stack.ui.validation.controlsfx.impl; exports dev.webfx.stack.ui.validation.controlsfx.impl.skin;