javafx.css.TransitionEvent Maven / Gradle / Ivy
/*
* 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 javafx.css;
import javafx.animation.Transition;
import javafx.event.Event;
import javafx.event.EventType;
import javafx.scene.Node;
import javafx.scene.layout.Region;
import javafx.util.Duration;
import java.util.Objects;
/**
* An event that signals the creation, beginning, completion and cancellation of implicit CSS transitions.
*
* Note that this event is not raised for explicit transitions that are created using the {@link Transition} class.
*
* @since 23
*/
public final class TransitionEvent extends Event {
private static final long serialVersionUID = 1L;
/**
* Common supertype for all {@code TransitionEvent} types.
*/
public static final EventType ANY =
new EventType<>(Event.ANY, "TRANSITION");
/**
* This event occurs when a transition has been created and added to the list of running
* transitions of a {@link Node}.
*/
public static final EventType RUN =
new EventType<>(TransitionEvent.ANY, "TRANSITION_RUN");
/**
* This event occurs when a running transition enters its active period, which happens
* at the end of the delay phase.
*/
public static final EventType START =
new EventType<>(TransitionEvent.ANY, "TRANSITION_START");
/**
* This event occurs when a running transition has reached the end of its active period.
* If the transition is cancelled prior to reaching the end of its active period, this
* event does not occur.
*/
public static final EventType END =
new EventType<>(TransitionEvent.ANY, "TRANSITION_END");
/**
* This event occurs when a running transition was cancelled before it has reached the
* end of its active period.
*/
public static final EventType CANCEL =
new EventType<>(TransitionEvent.ANY, "TRANSITION_CANCEL");
/**
* The {@code StyleableProperty} that is targeted by the transition.
*/
private final StyleableProperty property;
/**
* The name of the CSS property or sub-property that is targeted by the transition.
*/
private final String propertyName;
/**
* The time that has elapsed since the transition has entered its active period,
* not including the time spent in the delay phase.
*/
private final Duration elapsedTime;
/**
* Creates a new instance of the {@code TransitionEvent} class.
*
* @param eventType the event type
* @param property the {@code StyleableProperty} that is targeted by the transition
* @param elapsedTime the time that has elapsed since the transition has entered its active period
* @throws NullPointerException if {@code eventType}, {@code property} or {@code elapsedTime} is {@code null}
* @deprecated use {@link #TransitionEvent(EventType, StyleableProperty, String, Duration)} instead
*/
@Deprecated(since = "24", forRemoval = true)
public TransitionEvent(EventType eventType,
StyleableProperty property,
Duration elapsedTime) {
this(eventType, property, property.getCssMetaData().getProperty(), elapsedTime);
}
/**
* Creates a new instance of the {@code TransitionEvent} class.
*
* @param eventType the event type
* @param property the {@code StyleableProperty} that is targeted by the transition
* @param propertyName the name of the targeted CSS property or sub-property
* @param elapsedTime the time that has elapsed since the transition has entered its active period
* @throws NullPointerException if any of the arguments is {@code null}
* @since 24
*/
public TransitionEvent(EventType eventType,
StyleableProperty property,
String propertyName,
Duration elapsedTime) {
super(Objects.requireNonNull(eventType, "eventType cannot be null"));
this.property = Objects.requireNonNull(property, "property cannot be null");
this.propertyName = Objects.requireNonNull(propertyName, "propertyName cannot be null");
this.elapsedTime = Objects.requireNonNull(elapsedTime, "elapsedTime cannot be null");
}
/**
* Gets the {@code StyleableProperty} that is targeted by the transition.
*
* @return the {@code StyleableProperty}
*/
public StyleableProperty getProperty() {
return property;
}
/**
* Gets the name of the CSS property or sub-property that is targeted by the transition.
*
* The name of the CSS property under transition can be a long-hand property name, which is different
* from the name returned by {@link CssMetaData#getProperty()} of the {@code StyleableProperty} that
* is targeted by the transition. For example, if a transition targets {@link Region#borderProperty()},
* the name of the CSS property might be {@code -fx-border-color}, {@code -fx-border-radius}, etc.
*
* @return the CSS property or sub-property name
* @since 24
*/
public String getPropertyName() {
return propertyName;
}
/**
* Gets the time that has elapsed since the transition has entered its active period,
* not including the time spent in the delay phase.
*
* @return the elapsed time, or zero if the transition has not entered its active period
*/
public Duration getElapsedTime() {
return elapsedTime;
}
}