io.github.palexdev.mfxeffects.beans.properties.SizeProperty Maven / Gradle / Ivy

Go to download
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.8
/*
 * Copyright (C) 2022 Parisi Alessandro - [email protected]
 * This file is part of MaterialFX (https://github.com/palexdev/MaterialFX)
 *
 * MaterialFX is free software: you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 3 of the License,
 * or (at your option) any later version.
 *
 * MaterialFX is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with MaterialFX. If not, see .
 */

package io.github.palexdev.mfxeffects.beans.properties;

import io.github.palexdev.mfxeffects.beans.Size;
import javafx.beans.property.ReadOnlyObjectWrapper;

import java.util.Optional;

/**
 * Simple extension of {@link ReadOnlyObjectWrapper} for {@link Size} objects.
 */
public class SizeProperty extends ReadOnlyObjectWrapper {

    //================================================================================
    // Constructors
    //================================================================================
    public SizeProperty() {
    }

    public SizeProperty(Size initialValue) {
        super(initialValue);
    }

    public SizeProperty(Object bean, String name) {
        super(bean, name);
    }

    public SizeProperty(Object bean, String name, Size initialValue) {
        super(bean, name, initialValue);
    }

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

    /**
     * Convenience method to create a new {@link Size} object with the given parameters and set it
     * as the new value of this property.
     */
    public void setSize(double w, double h) {
        set(Size.of(w, h));
    }

    /**
     * Convenience method to set only the width of the current {@link Size} of this property.
     * Note that if the value is null a new {@link Size} object is created with a height of 0.0.
     * Also, if the value was not null, {@link #invalidated()} and {@link #fireValueChangedEvent()} are invoked programmatically
     * only if the width was not the same as the given one, this is needed as the object will remain the same.
     */
    public void setWidth(double w) {
        Optional.ofNullable(get())
                .ifPresentOrElse(
                        s -> {
                            boolean changed = s.getWidth() != w;
                            s.setWidth(w);
                            if (changed) {
                                invalidated();
                                fireValueChangedEvent();
                            }
                        },
                        () -> setSize(w, 0.0)
                );
    }

    /**
     * Convenience method to set only the height of the current {@link Size} of this property.
     * Note that if the value is null a new {@link Size} object is created with a width of 0.0.
     * Also, if the value was not null, {@link #invalidated()}, {@link #fireValueChangedEvent()} are invoked programmatically
     * only if the height was not the same as the given one, this is needed as the object will remain the same.
     */
    public void setHeight(double h) {
        Optional.ofNullable(get())
                .ifPresentOrElse(
                        s -> {
                            boolean changed = s.getHeight() != h;
                            s.setHeight(h);
                            if (changed) {
                                invalidated();
                                fireValueChangedEvent();
                            }
                        },
                        () -> setSize(0.0, h)
                );
    }

    /**
     * Null-safe alternative to {@code get().getWidth()}, if the value is null returns an invalid width of -1.0.
     */
    public double getWidth() {
        return Optional.ofNullable(get())
                .map(Size::getWidth)
                .orElse(-1.0);
    }

    /**
     * Null-safe alternative to {@code get().getHeight()}, if the value is null returns an invalid height of -1.0.
     */
    public double getHeight() {
        return Optional.ofNullable(get())
                .map(Size::getHeight)
                .orElse(-1.0);
    }
}