io.github.interacto.jfx.binding.api.BaseUpdateBinderBuilder Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of interacto-javafx Show documentation
The JavaFX implementation of the Interacto library
The newest version!
/*
 * Interacto
 * Copyright (C) 2020 Arnaud Blouin
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * This program 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 for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see .
 */
package io.github.interacto.jfx.binding.api;

import io.github.interacto.jfx.interaction.help.HelpAnimation;
import java.util.function.BooleanSupplier;
import javafx.beans.property.DoubleProperty;
import javafx.beans.property.StringProperty;
import javafx.collections.ObservableList;
import javafx.scene.control.Button;
import javafx.scene.layout.Pane;

/**
 * The base interface for building widget bindings based on non-trivial user interactions (eg DnD).
 * @param  The type of accepted widgets.
 */
public interface BaseUpdateBinderBuilder extends BaseBinderBuilder  {
	/**
	 * Specifies whether the command must be executed on each evolution of the interaction (if 'when' predicate is ok).
	 * @return The builder to chain the building configuration.
	 */
	BaseUpdateBinderBuilder continuousExecution();

	/**
	 * The interaction does not start if the condition of the binding ('when') is not fulfilled.
	 * @return The builder to chain the building configuration.
	 */
	BaseUpdateBinderBuilder strictStart();

	/**
	 * Backpressure operation. Instead of emitting all the events, successive events of the same type are factorized modulo a timeout.
	 * The timeout is used to send at max one event of the same type in a given duration (the timeout).
	 * For example with three mouse moves and a time out of 10ms.
	 * The first move is received and processed. The timer starts. A second mouse moves is received at T+5ms.
	 * It is for the moment not processed. A third mouse move is received at T+8ms. The second move is finally ignored and this third one not processed yet.
	 * At T+10s the third event is finally processed.
	 * Based on our own experiments, the given timeout value should be greater than 10ms to throttle some UI events.
	 * @param timeout The timeout used by the throttle operation. In ms.
	 * @return The builder to chain the building configuration.
	 */
	BaseUpdateBinderBuilder throttle(final long timeout);

	@Override
	BaseUpdateBinderBuilder when(final BooleanSupplier whenPredicate);

	@Override
	BaseUpdateBinderBuilder consume();

	@Override
	BaseUpdateBinderBuilder end(final Runnable endFct);

	@Override
	BaseUpdateBinderBuilder log(final LogLevel... level);

	@Override
	BaseUpdateBinderBuilder async(final Button cancel, final DoubleProperty progressProp, final StringProperty msgProp);

	@Override
	BaseUpdateBinderBuilder help(final HelpAnimation animation);

	@Override
	BaseUpdateBinderBuilder help(final Pane helpPane);

	@Override
	BaseUpdateBinderBuilder on(final W... widgets);

	@Override
	BaseUpdateBinderBuilder on(final ObservableList widgets);
}