mirror of
https://github.com/haveno-dex/haveno.git
synced 2025-04-20 15:55:54 -04:00
Re-introduce enzo Notification in original form
Copied from https://hansolo@bitbucket.org/hansolo/enzo.git at commit eb1d32
This commit is contained in:
Chris Beams
parent
cbdd60631c
commit
47d9693a07
452
src/main/java/eu/hansolo/enzo/notification/Notification.java
Normal file
452
src/main/java/eu/hansolo/enzo/notification/Notification.java
Normal file
@ -0,0 +1,452 @@
|
||||
/*
|
||||
* Copyright (c) 2013 by Gerrit Grunwald
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package eu.hansolo.enzo.notification;
|
||||
|
||||
import javafx.animation.KeyFrame;
|
||||
import javafx.animation.KeyValue;
|
||||
import javafx.animation.Timeline;
|
||||
import javafx.application.Platform;
|
||||
import javafx.beans.property.ObjectProperty;
|
||||
import javafx.beans.property.ObjectPropertyBase;
|
||||
import javafx.collections.FXCollections;
|
||||
import javafx.collections.ObservableList;
|
||||
import javafx.event.EventHandler;
|
||||
import javafx.event.EventType;
|
||||
import javafx.event.WeakEventHandler;
|
||||
import javafx.geometry.Insets;
|
||||
import javafx.geometry.Pos;
|
||||
import javafx.scene.Scene;
|
||||
import javafx.scene.control.Label;
|
||||
import javafx.scene.image.Image;
|
||||
import javafx.scene.image.ImageView;
|
||||
import javafx.scene.input.MouseEvent;
|
||||
import javafx.scene.layout.Region;
|
||||
import javafx.scene.layout.StackPane;
|
||||
import javafx.scene.layout.VBox;
|
||||
import javafx.stage.Popup;
|
||||
import javafx.stage.Screen;
|
||||
import javafx.stage.Stage;
|
||||
import javafx.stage.StageStyle;
|
||||
import javafx.util.Duration;
|
||||
|
||||
import java.util.stream.IntStream;
|
||||
|
||||
|
||||
/**
|
||||
* Created by
|
||||
* User: hansolo
|
||||
* Date: 01.07.13
|
||||
* Time: 07:10
|
||||
*/
|
||||
public class Notification {
|
||||
public static final Image INFO_ICON = new Image(Notifier.class.getResourceAsStream("info.png"));
|
||||
public static final Image WARNING_ICON = new Image(Notifier.class.getResourceAsStream("warning.png"));
|
||||
public static final Image SUCCESS_ICON = new Image(Notifier.class.getResourceAsStream("success.png"));
|
||||
public static final Image ERROR_ICON = new Image(Notifier.class.getResourceAsStream("error.png"));
|
||||
public final String TITLE;
|
||||
public final String MESSAGE;
|
||||
public final Image IMAGE;
|
||||
|
||||
|
||||
// ******************** Constructors **************************************
|
||||
public Notification(final String TITLE, final String MESSAGE) {
|
||||
this(TITLE, MESSAGE, null);
|
||||
}
|
||||
public Notification(final String MESSAGE, final Image IMAGE) {
|
||||
this("", MESSAGE, IMAGE);
|
||||
}
|
||||
public Notification(final String TITLE, final String MESSAGE, final Image IMAGE) {
|
||||
this.TITLE = TITLE;
|
||||
this.MESSAGE = MESSAGE;
|
||||
this.IMAGE = IMAGE;
|
||||
}
|
||||
|
||||
|
||||
// ******************** Inner Classes *************************************
|
||||
public enum Notifier {
|
||||
INSTANCE;
|
||||
|
||||
private static final double ICON_WIDTH = 24;
|
||||
private static final double ICON_HEIGHT = 24;
|
||||
private static double width = 300;
|
||||
private static double height = 80;
|
||||
private static double offsetX = 0;
|
||||
private static double offsetY = 25;
|
||||
private static double spacingY = 5;
|
||||
private static Pos popupLocation = Pos.TOP_RIGHT;
|
||||
private static Stage stageRef = null;
|
||||
private Duration popupLifetime;
|
||||
private Duration popupAnimationTime;
|
||||
private Stage stage;
|
||||
private Scene scene;
|
||||
private ObservableList<Popup> popups;
|
||||
|
||||
|
||||
// ******************** Constructor ***************************************
|
||||
private Notifier() {
|
||||
init();
|
||||
initGraphics();
|
||||
}
|
||||
|
||||
|
||||
// ******************** Initialization ************************************
|
||||
private void init() {
|
||||
popupLifetime = Duration.millis(5000);
|
||||
popupAnimationTime = Duration.millis(500);
|
||||
popups = FXCollections.observableArrayList();
|
||||
}
|
||||
|
||||
private void initGraphics() {
|
||||
scene = new Scene(new Region());
|
||||
scene.setFill(null);
|
||||
scene.getStylesheets().add(getClass().getResource("notifier.css").toExternalForm());
|
||||
|
||||
stage = new Stage();
|
||||
stage.initStyle(StageStyle.TRANSPARENT);
|
||||
stage.setAlwaysOnTop(true);
|
||||
}
|
||||
|
||||
|
||||
// ******************** Methods *******************************************
|
||||
/**
|
||||
* @param STAGE_REF The Notification will be positioned relative to the given Stage.<br>
|
||||
* If null then the Notification will be positioned relative to the primary Screen.
|
||||
* @param POPUP_LOCATION The default is TOP_RIGHT of primary Screen.
|
||||
*/
|
||||
public static void setPopupLocation(final Stage STAGE_REF, final Pos POPUP_LOCATION) {
|
||||
if (null != STAGE_REF) {
|
||||
INSTANCE.stage.initOwner(STAGE_REF);
|
||||
Notifier.stageRef = STAGE_REF;
|
||||
}
|
||||
Notifier.popupLocation = POPUP_LOCATION;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the Notification's owner stage so that when the owner
|
||||
* stage is closed Notifications will be shut down as well.<br>
|
||||
* This is only needed if <code>setPopupLocation</code> is called
|
||||
* <u>without</u> a stage reference.
|
||||
* @param OWNER
|
||||
*/
|
||||
public static void setNotificationOwner(final Stage OWNER) {
|
||||
INSTANCE.stage.initOwner(OWNER);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param OFFSET_X The horizontal shift required.
|
||||
* <br> The default is 0 px.
|
||||
*/
|
||||
public static void setOffsetX(final double OFFSET_X) {
|
||||
Notifier.offsetX = OFFSET_X;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param OFFSET_Y The vertical shift required.
|
||||
* <br> The default is 25 px.
|
||||
*/
|
||||
public static void setOffsetY(final double OFFSET_Y) {
|
||||
Notifier.offsetY = OFFSET_Y;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param WIDTH The default is 300 px.
|
||||
*/
|
||||
public static void setWidth(final double WIDTH) {
|
||||
Notifier.width = WIDTH;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param HEIGHT The default is 80 px.
|
||||
*/
|
||||
public static void setHeight(final double HEIGHT) {
|
||||
Notifier.height = HEIGHT;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param SPACING_Y The spacing between multiple Notifications.
|
||||
* <br> The default is 5 px.
|
||||
*/
|
||||
public static void setSpacingY(final double SPACING_Y) {
|
||||
Notifier.spacingY = SPACING_Y;
|
||||
}
|
||||
|
||||
public void stop() {
|
||||
popups.clear();
|
||||
stage.close();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the Duration that the notification will stay on screen before it
|
||||
* will fade out. The default is 5000 ms
|
||||
* @return the Duration the popup notification will stay on screen
|
||||
*/
|
||||
public Duration getPopupLifetime() {
|
||||
return popupLifetime;
|
||||
}
|
||||
|
||||
/**
|
||||
* Defines the Duration that the popup notification will stay on screen before it
|
||||
* will fade out. The parameter is limited to values between 2 and 20 seconds.
|
||||
* @param POPUP_LIFETIME
|
||||
*/
|
||||
public void setPopupLifetime(final Duration POPUP_LIFETIME) {
|
||||
popupLifetime = Duration.millis(clamp(2000, 20000, POPUP_LIFETIME.toMillis()));
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the Duration that it takes to fade out the notification
|
||||
* The parameter is limited to values between 0 and 1000 ms
|
||||
* @return the Duration that it takes to fade out the notification
|
||||
*/
|
||||
public Duration getPopupAnimationTime() {
|
||||
return popupAnimationTime;
|
||||
}
|
||||
|
||||
/**
|
||||
* Defines the Duration that it takes to fade out the notification
|
||||
* The parameter is limited to values between 0 and 1000 ms
|
||||
* Default value is 500 ms
|
||||
* @param POPUP_ANIMATION_TIME
|
||||
*/
|
||||
public void setPopupAnimationTime(final Duration POPUP_ANIMATION_TIME) {
|
||||
popupAnimationTime = Duration.millis(clamp(0, 1000, POPUP_ANIMATION_TIME.toMillis()));
|
||||
}
|
||||
|
||||
/**
|
||||
* Show the given Notification on the screen
|
||||
* @param NOTIFICATION
|
||||
*/
|
||||
public void notify(final Notification NOTIFICATION) {
|
||||
preOrder();
|
||||
showPopup(NOTIFICATION);
|
||||
}
|
||||
|
||||
/**
|
||||
* Show a Notification with the given parameters on the screen
|
||||
* @param TITLE
|
||||
* @param MESSAGE
|
||||
* @param IMAGE
|
||||
*/
|
||||
public void notify(final String TITLE, final String MESSAGE, final Image IMAGE) {
|
||||
notify(new Notification(TITLE, MESSAGE, IMAGE));
|
||||
}
|
||||
|
||||
/**
|
||||
* Show a Notification with the given title and message and an Info icon
|
||||
* @param TITLE
|
||||
* @param MESSAGE
|
||||
*/
|
||||
public void notifyInfo(final String TITLE, final String MESSAGE) {
|
||||
notify(new Notification(TITLE, MESSAGE, Notification.INFO_ICON));
|
||||
}
|
||||
|
||||
/**
|
||||
* Show a Notification with the given title and message and a Warning icon
|
||||
* @param TITLE
|
||||
* @param MESSAGE
|
||||
*/
|
||||
public void notifyWarning(final String TITLE, final String MESSAGE) {
|
||||
notify(new Notification(TITLE, MESSAGE, Notification.WARNING_ICON));
|
||||
}
|
||||
|
||||
/**
|
||||
* Show a Notification with the given title and message and a Checkmark icon
|
||||
* @param TITLE
|
||||
* @param MESSAGE
|
||||
*/
|
||||
public void notifySuccess(final String TITLE, final String MESSAGE) {
|
||||
notify(new Notification(TITLE, MESSAGE, Notification.SUCCESS_ICON));
|
||||
}
|
||||
|
||||
/**
|
||||
* Show a Notification with the given title and message and an Error icon
|
||||
* @param TITLE
|
||||
* @param MESSAGE
|
||||
*/
|
||||
public void notifyError(final String TITLE, final String MESSAGE) {
|
||||
notify(new Notification(TITLE, MESSAGE, Notification.ERROR_ICON));
|
||||
}
|
||||
|
||||
/**
|
||||
* Makes sure that the given VALUE is within the range of MIN to MAX
|
||||
* @param MIN
|
||||
* @param MAX
|
||||
* @param VALUE
|
||||
* @return
|
||||
*/
|
||||
private double clamp(final double MIN, final double MAX, final double VALUE) {
|
||||
if (VALUE < MIN) return MIN;
|
||||
if (VALUE > MAX) return MAX;
|
||||
return VALUE;
|
||||
}
|
||||
|
||||
/**
|
||||
* Reorder the popup Notifications on screen so that the latest Notification will stay on top
|
||||
*/
|
||||
private void preOrder() {
|
||||
if (popups.isEmpty()) return;
|
||||
IntStream.range(0, popups.size()).parallel().forEachOrdered(
|
||||
i -> {
|
||||
switch (popupLocation) {
|
||||
case TOP_LEFT: case TOP_CENTER: case TOP_RIGHT:
|
||||
popups.get(i).setY(popups.get(i).getY() + height + spacingY);
|
||||
break;
|
||||
|
||||
case BOTTOM_LEFT: case BOTTOM_CENTER: case BOTTOM_RIGHT:
|
||||
popups.get(i).setY(popups.get(i).getY() - height - spacingY);
|
||||
break;
|
||||
|
||||
default:
|
||||
popups.get(i).setY(popups.get(i).getY() - height - spacingY);
|
||||
break;
|
||||
}
|
||||
}
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates and shows a popup with the data from the given Notification object
|
||||
* @param NOTIFICATION
|
||||
*/
|
||||
private void showPopup(final Notification NOTIFICATION) {
|
||||
Label title = new Label(NOTIFICATION.TITLE);
|
||||
title.getStyleClass().add("title");
|
||||
|
||||
ImageView icon = new ImageView(NOTIFICATION.IMAGE);
|
||||
icon.setFitWidth(ICON_WIDTH);
|
||||
icon.setFitHeight(ICON_HEIGHT);
|
||||
|
||||
Label message = new Label(NOTIFICATION.MESSAGE, icon);
|
||||
message.getStyleClass().add("message");
|
||||
|
||||
VBox popupLayout = new VBox();
|
||||
popupLayout.setSpacing(10);
|
||||
popupLayout.setPadding(new Insets(10, 10, 10, 10));
|
||||
popupLayout.getChildren().addAll(title, message);
|
||||
|
||||
StackPane popupContent = new StackPane();
|
||||
popupContent.setPrefSize(width, height);
|
||||
popupContent.getStyleClass().add("notification");
|
||||
popupContent.getChildren().addAll(popupLayout);
|
||||
|
||||
final Popup POPUP = new Popup();
|
||||
POPUP.setX(getX());
|
||||
POPUP.setY(getY());
|
||||
POPUP.getContent().add(popupContent);
|
||||
POPUP.addEventHandler(MouseEvent.MOUSE_PRESSED, new WeakEventHandler<>(event ->
|
||||
fireNotificationEvent(new NotificationEvent(NOTIFICATION, Notifier.this, POPUP, NotificationEvent.NOTIFICATION_PRESSED))
|
||||
));
|
||||
popups.add(POPUP);
|
||||
|
||||
// Add a timeline for popup fade out
|
||||
KeyValue fadeOutBegin = new KeyValue(POPUP.opacityProperty(), 1.0);
|
||||
KeyValue fadeOutEnd = new KeyValue(POPUP.opacityProperty(), 0.0);
|
||||
|
||||
KeyFrame kfBegin = new KeyFrame(Duration.ZERO, fadeOutBegin);
|
||||
KeyFrame kfEnd = new KeyFrame(popupAnimationTime, fadeOutEnd);
|
||||
|
||||
Timeline timeline = new Timeline(kfBegin, kfEnd);
|
||||
timeline.setDelay(popupLifetime);
|
||||
timeline.setOnFinished(actionEvent -> Platform.runLater(() -> {
|
||||
POPUP.hide();
|
||||
popups.remove(POPUP);
|
||||
fireNotificationEvent(new NotificationEvent(NOTIFICATION, Notifier.this, POPUP, NotificationEvent.HIDE_NOTIFICATION));
|
||||
}));
|
||||
|
||||
if (stage.isShowing()) {
|
||||
stage.toFront();
|
||||
} else {
|
||||
stage.show();
|
||||
}
|
||||
|
||||
POPUP.show(stage);
|
||||
fireNotificationEvent(new NotificationEvent(NOTIFICATION, Notifier.this, POPUP, NotificationEvent.SHOW_NOTIFICATION));
|
||||
timeline.play();
|
||||
}
|
||||
|
||||
private double getX() {
|
||||
if (null == stageRef) return calcX( 0.0, Screen.getPrimary().getBounds().getWidth() );
|
||||
|
||||
return calcX(stageRef.getX(), stageRef.getWidth());
|
||||
}
|
||||
private double getY() {
|
||||
if (null == stageRef) return calcY( 0.0, Screen.getPrimary().getBounds().getHeight() );
|
||||
return calcY(stageRef.getY(), stageRef.getHeight());
|
||||
}
|
||||
|
||||
private double calcX(final double LEFT, final double TOTAL_WIDTH) {
|
||||
switch (popupLocation) {
|
||||
case TOP_LEFT : case CENTER_LEFT : case BOTTOM_LEFT : return LEFT + offsetX;
|
||||
case TOP_CENTER: case CENTER : case BOTTOM_CENTER: return LEFT + (TOTAL_WIDTH - width) * 0.5 - offsetX;
|
||||
case TOP_RIGHT : case CENTER_RIGHT: case BOTTOM_RIGHT : return LEFT + TOTAL_WIDTH - width - offsetX;
|
||||
default: return 0.0;
|
||||
}
|
||||
}
|
||||
private double calcY(final double TOP, final double TOTAL_HEIGHT ) {
|
||||
switch (popupLocation) {
|
||||
case TOP_LEFT : case TOP_CENTER : case TOP_RIGHT : return TOP + offsetY;
|
||||
case CENTER_LEFT: case CENTER : case CENTER_RIGHT: return TOP + (TOTAL_HEIGHT- height)/2 - offsetY;
|
||||
case BOTTOM_LEFT: case BOTTOM_CENTER: case BOTTOM_RIGHT: return TOP + TOTAL_HEIGHT - height - offsetY;
|
||||
default: return 0.0;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
// ******************** Event handling ********************************
|
||||
public final ObjectProperty<EventHandler<NotificationEvent>> onNotificationPressedProperty() { return onNotificationPressed; }
|
||||
public final void setOnNotificationPressed(EventHandler<NotificationEvent> value) { onNotificationPressedProperty().set(value); }
|
||||
public final EventHandler<NotificationEvent> getOnNotificationPressed() { return onNotificationPressedProperty().get(); }
|
||||
private ObjectProperty<EventHandler<NotificationEvent>> onNotificationPressed = new ObjectPropertyBase<EventHandler<NotificationEvent>>() {
|
||||
@Override public Object getBean() { return this; }
|
||||
@Override public String getName() { return "onNotificationPressed";}
|
||||
};
|
||||
|
||||
public final ObjectProperty<EventHandler<NotificationEvent>> onShowNotificationProperty() { return onShowNotification; }
|
||||
public final void setOnShowNotification(EventHandler<NotificationEvent> value) { onShowNotificationProperty().set(value); }
|
||||
public final EventHandler<NotificationEvent> getOnShowNotification() { return onShowNotificationProperty().get(); }
|
||||
private ObjectProperty<EventHandler<NotificationEvent>> onShowNotification = new ObjectPropertyBase<EventHandler<NotificationEvent>>() {
|
||||
@Override public Object getBean() { return this; }
|
||||
@Override public String getName() { return "onShowNotification";}
|
||||
};
|
||||
|
||||
public final ObjectProperty<EventHandler<NotificationEvent>> onHideNotificationProperty() { return onHideNotification; }
|
||||
public final void setOnHideNotification(EventHandler<NotificationEvent> value) { onHideNotificationProperty().set(value); }
|
||||
public final EventHandler<NotificationEvent> getOnHideNotification() { return onHideNotificationProperty().get(); }
|
||||
private ObjectProperty<EventHandler<NotificationEvent>> onHideNotification = new ObjectPropertyBase<EventHandler<NotificationEvent>>() {
|
||||
@Override public Object getBean() { return this; }
|
||||
@Override public String getName() { return "onHideNotification";}
|
||||
};
|
||||
|
||||
|
||||
public void fireNotificationEvent(final NotificationEvent EVENT) {
|
||||
final EventType TYPE = EVENT.getEventType();
|
||||
final EventHandler<NotificationEvent> HANDLER;
|
||||
if (NotificationEvent.NOTIFICATION_PRESSED == TYPE) {
|
||||
HANDLER = getOnNotificationPressed();
|
||||
} else if (NotificationEvent.SHOW_NOTIFICATION == TYPE) {
|
||||
HANDLER = getOnShowNotification();
|
||||
} else if (NotificationEvent.HIDE_NOTIFICATION == TYPE) {
|
||||
HANDLER = getOnHideNotification();
|
||||
} else {
|
||||
HANDLER = null;
|
||||
}
|
||||
if (null == HANDLER) return;
|
||||
HANDLER.handle(EVENT);
|
||||
}
|
||||
|
||||
}
|
||||
}
|
||||
Loading…
x
Reference in New Issue
Block a user