com.jfoenix.controls.JFXAlert Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jfoenix Show documentation
JFoenix
There is a newer version: 9.0.10
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 com.jfoenix.controls;

import com.jfoenix.animation.alert.JFXAlertAnimation;
import com.jfoenix.effects.JFXDepthManager;
import com.sun.javafx.event.EventHandlerManager;
import javafx.animation.Animation;
import javafx.application.Platform;
import javafx.beans.property.BooleanProperty;
import javafx.beans.property.ObjectProperty;
import javafx.beans.property.SimpleBooleanProperty;
import javafx.beans.property.SimpleObjectProperty;
import javafx.event.EventDispatchChain;
import javafx.geometry.Bounds;
import javafx.geometry.Insets;
import javafx.scene.Group;
import javafx.scene.Node;
import javafx.scene.Parent;
import javafx.scene.control.ButtonType;
import javafx.scene.control.Dialog;
import javafx.scene.control.DialogEvent;
import javafx.scene.control.DialogPane;
import javafx.scene.input.MouseEvent;
import javafx.scene.layout.Background;
import javafx.scene.layout.BackgroundFill;
import javafx.scene.layout.CornerRadii;
import javafx.scene.layout.StackPane;
import javafx.scene.paint.Color;
import javafx.stage.Stage;
import javafx.stage.StageStyle;

/**
 * JFXAlert is similar to {@link JFXDialog} control, however it extends JavaFX {@link Dialog}
 * control, thus it support modality options and doesn't require a parent to be specifed
 * unlike {@link JFXDialog}
 *
 * @author Shadi Shaheen
 * @version 1.0
 * @since 2017-05-26
 */
public class JFXAlert extends Dialog {

    private final StackPane contentContainer;
    private final StackPane overlay;
    private final Group contentGroup;

    public JFXAlert(Stage stage) {
        // set the stage to transparent
        initStyle(StageStyle.TRANSPARENT);
        initOwner(stage);

        // create custom dialog pane
        setDialogPane(new DialogPane() {
            {
                getButtonTypes().add(ButtonType.CLOSE);
                Node closeButton = this.lookupButton(ButtonType.CLOSE);
                closeButton.managedProperty().bind(closeButton.visibleProperty());
                closeButton.setVisible(false);
            }

            @Override
            protected Node createButtonBar() {
                return null;
            }
        });


        // init style for the content container
        contentContainer = new StackPane();
        contentContainer.getStyleClass().add("jfx-alert-content-container");
        contentContainer.setPrefSize(300, 250);
        contentContainer.setStyle("-fx-background-color: WHITE;");

        // customize dialogPane
        final DialogPane dialogPane = getDialogPane();
        dialogPane.getScene().setFill(Color.TRANSPARENT);
        dialogPane.setStyle("-fx-background-color: TRANSPARENT;");
        dialogPane.prefWidthProperty().bind(stage.getScene().widthProperty());
        dialogPane.prefHeightProperty().bind(stage.getScene().heightProperty());

        // set dialog pane content
        final Node materialNode = JFXDepthManager.createMaterialNode(contentContainer, 2);
        materialNode.setPickOnBounds(false);
        contentGroup = new Group(materialNode);

        // init style for overlay
        overlay = new StackPane(contentGroup);
        overlay.getStyleClass().add("jfx-alert-overlay");
        overlay.setBackground(new Background(
            new BackgroundFill(Color.valueOf("#00000011"), CornerRadii.EMPTY, Insets.EMPTY)));

        final StackPane container = new StackPane(overlay);
        container.setPadding(new Insets(0));
        dialogPane.setContent(container);


        // bind dialog position to stage position
        stage.getScene().widthProperty().addListener(observable -> updateSize(dialogPane));
        stage.getScene().heightProperty().addListener(observable -> updateSize(dialogPane));
        stage.xProperty().addListener((observable, oldValue, newValue) -> {
            final Parent root = stage.getScene().getRoot();
            final Bounds screenBounds = root.localToScreen(root.getLayoutBounds());
            setX(screenBounds.getMinX());
        });
        stage.yProperty().addListener((observable, oldValue, newValue) -> {
            final Parent root = stage.getScene().getRoot();
            final Bounds screenBounds = root.localToScreen(root.getLayoutBounds());
            setY(screenBounds.getMinY());
        });

        // handle animation
        eventHandlerManager.addEventHandler(DialogEvent.DIALOG_SHOWING, event -> {
            if (getAnimation() != null) {
                getAnimation().initAnimation(contentGroup, overlay);
            }
        });
        eventHandlerManager.addEventHandler(DialogEvent.DIALOG_SHOWN, event -> {
            if (getAnimation() != null) {
                Animation animation = getAnimation().createShowingAnimation(contentGroup, overlay);
                if (animation != null) {
                    animation.play();
                }
            }
        });
        overlay.addEventHandler(MouseEvent.MOUSE_CLICKED, event -> {
            if (this.isOverlayClose()) {
                new Thread(() -> hideWithAnimation()).start();
            }
        });
    }


    /**
     * play the hide animation for the dialog, as the java hide method is set to final
     * can not be overridden
     */
    public void hideWithAnimation() {
        if (getAnimation() != null) {
            Animation animation = getAnimation().createHidingAnimation(contentGroup, overlay);
            if (animation != null) {
                animation.setOnFinished(finish -> this.hide());
                animation.play();
            } else {
                Platform.runLater(this::hide);
            }
        }
    }

    private void updateSize(DialogPane dialogPane) {
        if (dialogPane.getScene() != null) {
            dialogPane.getScene().getWindow().sizeToScene();
        }
    }

    private final EventHandlerManager eventHandlerManager = new EventHandlerManager(this);

    /**
     * {@inheritDoc}
     */
    @Override
    public EventDispatchChain buildEventDispatchChain(EventDispatchChain tail) {
        return super.buildEventDispatchChain(tail).prepend(eventHandlerManager);
    }

    public void setContent(Node... content) {
        contentContainer.getChildren().setAll(content);
    }

    /**
     * indicates whether the dialog will close when clicking on the overlay or not
     */
    private BooleanProperty overlayClose = new SimpleBooleanProperty(true);

    public boolean isOverlayClose() {
        return overlayClose.get();
    }

    public BooleanProperty overlayCloseProperty() {
        return overlayClose;
    }

    public void setOverlayClose(boolean overlayClose) {
        this.overlayClose.set(overlayClose);
    }


    /**
     * specify the animation when showing / hiding the dialog
     * by default it's set to {@link JFXAlertAnimation#CENTER_ANIMATION}
     */
    private ObjectProperty animation = new SimpleObjectProperty<>
        (JFXAlertAnimation.CENTER_ANIMATION);

    public JFXAlertAnimation getAnimation() {
        return animation.get();
    }

    public ObjectProperty animationProperty() {
        return animation;
    }

    public void setAnimation(JFXAlertAnimation animation) {
        this.animation.set(animation);
    }
}