io.github.interacto.jfx.binding.api.InteractionCmdUpdateBinder 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.command.Command;
import io.github.interacto.interaction.InteractionData;
import io.github.interacto.jfx.binding.JfxWidgetBinding;
import io.github.interacto.jfx.interaction.JfxInteraction;
import io.github.interacto.jfx.interaction.help.HelpAnimation;
import java.util.function.BiConsumer;
import java.util.function.BooleanSupplier;
import java.util.function.Consumer;
import java.util.function.Predicate;
import javafx.beans.property.DoubleProperty;
import javafx.beans.property.StringProperty;
import javafx.collections.ObservableList;
import javafx.scene.control.Button;
import javafx.scene.layout.Pane;

public interface InteractionCmdUpdateBinder, D extends InteractionData>
		extends InteractionCmdBinder, CmdUpdateBinderBuilder, InteractionUpdateBinderBuilder {
	/**
	 * Specifies the update of the command on interaction command.
	 * @param update The callback method that updates the action.
	 * 				This callback takes as arguments the command to update and the ongoing interactions (and its parameters).
	 * @return The builder to chain the building configuration.
	 */
	InteractionCmdUpdateBinder then(final BiConsumer update);

	@Override
	InteractionCmdUpdateBinder then(final Consumer update);

	@Override
	InteractionCmdUpdateBinder continuousExecution();

	@Override
	InteractionCmdUpdateBinder strictStart();

	@Override
	InteractionCmdUpdateBinder consume();

	@Override
	InteractionCmdUpdateBinder throttle(final long timeout);

	@Override
	InteractionCmdUpdateBinder first(final BiConsumer initCmdFct);

	@Override
	InteractionCmdUpdateBinder first(final Consumer initCmdFct);

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

	@Override
	InteractionCmdUpdateBinder on(final ObservableList widgets);

	@Override
	InteractionCmdUpdateBinder when(final BooleanSupplier whenPredicate);

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

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

	@Override
	InteractionCmdUpdateBinder help(final HelpAnimation animation);

	@Override
	InteractionCmdUpdateBinder help(final Pane helpPane);

	@Override
	InteractionCmdUpdateBinder cancel(final Consumer cancel);

	@Override
	InteractionCmdUpdateBinder endOrCancel(final Consumer endOrCancel);

	@Override
	InteractionCmdUpdateBinder end(final Runnable endFct);

	@Override
	InteractionCmdUpdateBinder when(final Predicate whenPredicate);

	@Override
	InteractionCmdUpdateBinder ifHadEffects(final BiConsumer hadEffectFct);

	@Override
	InteractionCmdUpdateBinder ifHadNoEffect(final BiConsumer noEffectFct);

	@Override
	InteractionCmdUpdateBinder end(final BiConsumer onEnd);

	@Override
	InteractionCmdUpdateBinder end(final Consumer onEnd);

	@Override
	JfxWidgetBinding bind();
}