com.sun.javafx.css.TransitionDefinition Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of javafx-graphics Show documentation
There is a newer version: 24-ea+19
/*
 * Copyright (c) 2024, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code 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 General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package com.sun.javafx.css;

import javafx.animation.Interpolator;
import javafx.util.Duration;
import java.util.Objects;

/**
 * {@code TransitionDefinition} describes how a {@link javafx.css.StyleableProperty} changes from one
 * value to another when its value is changed implicitly by the CSS subsystem. The transition can be
 * smooth, for example using linear or Bézier interpolation, or discrete using stepwise interpolation.
 *
 * @param propertyName the CSS property name, or "all" to target any property
 * @param duration duration of the transition
 * @param delay delay after which the transition is started; if negative, the transition starts
 *              immediately, but will appear to have begun at an earlier point in time
 * @param interpolator interpolator for the transition
 */
public record TransitionDefinition(String propertyName, Duration duration,
                                   Duration delay, Interpolator interpolator) {

    /**
     * Creates a new {@code TransitionDefinition} instance.
     *
     * @throws NullPointerException if any of the arguments is {@code null}
     * @throws IllegalArgumentException if the duration is negative
     */
    public TransitionDefinition {
        Objects.requireNonNull(propertyName, "propertyName cannot be null");
        Objects.requireNonNull(duration, "duration cannot be null");
        Objects.requireNonNull(delay, "delay cannot be null");
        Objects.requireNonNull(interpolator, "interpolator cannot be null");

        propertyName = TransitionDefinitionConverter.PROPERTY_ALL.equalsIgnoreCase(propertyName) ?
            TransitionDefinitionConverter.PROPERTY_ALL : propertyName;

        if (duration.lessThan(Duration.ZERO)) {
            throw new IllegalArgumentException("duration cannot be negative");
        }
    }

}