com.jfoenix.skins.JFXToggleButtonSkin Maven / Gradle / Ivy

/*
 * 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.skins;

import com.jfoenix.controls.JFXRippler;
import com.jfoenix.controls.JFXRippler.RipplerMask;
import com.jfoenix.controls.JFXRippler.RipplerPos;
import com.jfoenix.controls.JFXToggleButton;
import com.jfoenix.effects.JFXDepthManager;
import com.jfoenix.transitions.JFXAnimationTimer;
import com.jfoenix.transitions.JFXKeyFrame;
import com.jfoenix.transitions.JFXKeyValue;
import com.sun.javafx.scene.control.skin.ToggleButtonSkin;
import javafx.animation.Interpolator;
import javafx.geometry.Insets;
import javafx.scene.Cursor;
import javafx.scene.layout.StackPane;
import javafx.scene.shape.Circle;
import javafx.scene.shape.Line;
import javafx.scene.shape.StrokeLineCap;
import javafx.util.Duration;

/**
 * Material Design ToggleButton Skin
 *
 * @author Shadi Shaheen
 * @version 1.0
 * @since 2016-03-09
 */
public class JFXToggleButtonSkin extends ToggleButtonSkin {


    private Runnable releaseManualRippler = null;

    private JFXAnimationTimer timer;
    private final Circle circle;
    private final Line line;

    public JFXToggleButtonSkin(JFXToggleButton toggleButton) {
        super(toggleButton);

        double circleRadius = toggleButton.getSize();

        line = new Line();
        line.setStroke(getSkinnable().isSelected() ? toggleButton.getToggleLineColor() : toggleButton.getUnToggleLineColor());
        line.setStartX(0);
        line.setStartY(0);
        line.setEndX(circleRadius * 2 + 2);
        line.setEndY(0);
        line.setStrokeWidth(circleRadius * 1.5);
        line.setStrokeLineCap(StrokeLineCap.ROUND);
        line.setSmooth(true);

        circle = new Circle();
        circle.setFill(getSkinnable().isSelected() ? toggleButton.getToggleColor() : toggleButton.getUnToggleColor());
        circle.setCenterX(-circleRadius);
        circle.setCenterY(0);
        circle.setRadius(circleRadius);
        circle.setSmooth(true);
        JFXDepthManager.setDepth(circle, 1);

        StackPane circlePane = new StackPane();
        circlePane.getChildren().add(circle);
        circlePane.setPadding(new Insets(circleRadius * 1.5));

        JFXRippler rippler = new JFXRippler(circlePane, RipplerMask.CIRCLE, RipplerPos.BACK);
        rippler.setTranslateX(computeTranslation(circleRadius, line));

        final StackPane main = new StackPane();
        main.getChildren().setAll(line, rippler);
        main.setCursor(Cursor.HAND);

        // show focus traversal effect
        getSkinnable().armedProperty().addListener((o, oldVal, newVal) -> {
            if (newVal) {
                releaseManualRippler = rippler.createManualRipple();
            } else if (releaseManualRippler != null) {
                releaseManualRippler.run();
            }
        });
        toggleButton.focusedProperty().addListener((o, oldVal, newVal) -> {
            if (!toggleButton.isDisableVisualFocus()) {
                if (newVal) {
                    if (!getSkinnable().isPressed()) {
                        rippler.setOverlayVisible(true);
                    }
                } else {
                    rippler.setOverlayVisible(false);
                }
            }
        });
        toggleButton.pressedProperty().addListener(observable -> rippler.setOverlayVisible(false));

        // add change listener to selected property
        getSkinnable().selectedProperty().addListener(observable -> {
            if (!toggleButton.isDisableAnimation()) {
                timer.reverseAndContinue();
            } else {
                rippler.setTranslateX(computeTranslation(circleRadius, line));
            }
        });

        getSkinnable().setGraphic(main);

        timer = new JFXAnimationTimer(
            new JFXKeyFrame(Duration.millis(100),
                JFXKeyValue.builder()
                    .setTarget(rippler.translateXProperty())
                    .setEndValueSupplier(() -> computeTranslation(circleRadius, line))
                    .setInterpolator(Interpolator.EASE_BOTH)
                    .setAnimateCondition(() -> !((JFXToggleButton) getSkinnable()).isDisableAnimation())
                    .build(),

                JFXKeyValue.builder()
                    .setTarget(line.strokeProperty())
                    .setEndValueSupplier(() -> getSkinnable().isSelected() ?
                        ((JFXToggleButton) getSkinnable()).getToggleLineColor()
                        : ((JFXToggleButton) getSkinnable()).getUnToggleLineColor())
                    .setInterpolator(Interpolator.EASE_BOTH)
                    .setAnimateCondition(() -> !((JFXToggleButton) getSkinnable()).isDisableAnimation())
                    .build(),

                JFXKeyValue.builder()
                    .setTarget(circle.fillProperty())
                    .setEndValueSupplier(() -> getSkinnable().isSelected() ?
                        ((JFXToggleButton) getSkinnable()).getToggleColor()
                        : ((JFXToggleButton) getSkinnable()).getUnToggleColor())
                    .setInterpolator(Interpolator.EASE_BOTH)
                    .setAnimateCondition(() -> !((JFXToggleButton) getSkinnable()).isDisableAnimation())
                    .build()
            )
        );
        timer.setCacheNodes(circle, line);

        registerChangeListener(toggleButton.toggleColorProperty(), "TOGGLE_COLOR");
        registerChangeListener(toggleButton.unToggleColorProperty(), "UNTOGGLE_COLOR");
        registerChangeListener(toggleButton.toggleLineColorProperty(), "TOGGLE_LINE_COLOR");
        registerChangeListener(toggleButton.unToggleColorProperty(), "UNTOGGLE_LINE_COLOR");
    }

    @Override
    protected void handleControlPropertyChanged(String p) {
        if ("TOGGLE_COLOR".equals(p)) {
            if (getSkinnable().isSelected()) {
                circle.setFill(((JFXToggleButton) getSkinnable()).getToggleColor());
            }
        } else if ("UNTOGGLE_COLOR".equals(p)) {
            if (!getSkinnable().isSelected()) {
                circle.setFill(((JFXToggleButton) getSkinnable()).getUnToggleColor());
            }
        } else if ("TOGGLE_LINE_COLOR".equals(p)) {
            if (getSkinnable().isSelected()) {
                line.setStroke(((JFXToggleButton) getSkinnable()).getToggleLineColor());
            }
        } else if ("UNTOGGLE_LINE_COLOR".equals(p)) {
            if (!getSkinnable().isSelected()) {
                line.setStroke(((JFXToggleButton) getSkinnable()).getUnToggleLineColor());
            }
        } else {
            super.handleControlPropertyChanged(p);
        }
    }

    private double computeTranslation(double circleRadius, Line line) {
        return (getSkinnable().isSelected() ? 1 : -1) * ((line.getLayoutBounds().getWidth() / 2) - circleRadius + 2);
    }

    @Override
    public void dispose() {
        super.dispose();
        timer.dispose();
        timer = null;
    }
}