io.github.palexdev.mfxeffects.ripple.base.RippleGeneratorBase Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of materialfx-all Show documentation

Material Design/Modern components for JavaFX, now packed as a single Jar

There is a newer version: 11.26.0

package io.github.palexdev.mfxeffects.ripple.base;

import io.github.palexdev.mfxeffects.ripple.CircleRipple;
import javafx.scene.layout.Region;

import java.util.function.Supplier;

/**
 * Abstract class extending {@link Region} and implementing {@link RippleGenerator}.
 * 
 * This exists just to restrict the visibility of some internal methods, it's also a good base to implement
 * custom generators.
 */
public abstract class RippleGeneratorBase extends Region implements RippleGenerator {

    //================================================================================
    // Constructors
    //================================================================================
    protected RippleGeneratorBase() {
        setRippleSupplier(defaultRippleSupplier());
    }

    //================================================================================
    // Methods
    //================================================================================

    /**
     * This is responsible for building the generator's clip node.
     * 
     * By default, this just relies on {@link #getClipSupplier()}
     */
    protected Region buildClip() {
        return getClipSupplier().get();
    }

    /**
     * This is responsible for building the ripple node.
     * 
     * By default, this just relies on {@link #getRippleSupplier()}.
     */
    protected Ripple buildRipple() {
        return getRippleSupplier().get();
    }

    /**
     * Since this extends {@link Region}, and the children list is unmodifiable (we want it to be so), this allows internal
     * classes to add the ripple node on the generator.
     */
    protected void setRipple(Ripple ripple) {
        getChildren().setAll(ripple.toNode());
    }

    //================================================================================
    // Overridden Methods
    //================================================================================

    /**
     * @return a {@link Supplier} building ripples of type {@link CircleRipple}
     */
    @Override
    public Supplier> defaultRippleSupplier() {
        return () -> new CircleRipple(this);
    }
}