io.github.interacto.jfx.binding.api.InteractionBinderBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of interacto-javafx Show documentation
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.interaction.InteractionData;
import io.github.interacto.jfx.interaction.JfxInteraction;
import io.github.interacto.jfx.interaction.help.HelpAnimation;
import java.util.function.BooleanSupplier;
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 InteractionBinderBuilder, D extends InteractionData> extends BaseBinderBuilder {
/**
* Specifies the conditions to fulfill to initialise, update, or execute the command while the interaction is running.
* @param whenPredicate The predicate that checks whether the command can be initialised, updated, or executed.
* This predicate takes as arguments the ongoing user interaction involved in the binding.
* @return The builder to chain the building configuration.
*/
InteractionBinderBuilder when(final Predicate whenPredicate);
@Override
InteractionBinderBuilder on(final W... widgets);
@Override
InteractionBinderBuilder on(final ObservableList widgets);
@Override
InteractionBinderBuilder when(final BooleanSupplier whenPredicate);
@Override
InteractionBinderBuilder end(final Runnable endFct);
@Override
InteractionBinderBuilder log(final LogLevel... level);
@Override
InteractionBinderBuilder consume();
@Override
InteractionBinderBuilder async(final Button cancel, final DoubleProperty progressProp, final StringProperty msgProp);
@Override
InteractionBinderBuilder help(final HelpAnimation animation);
@Override
InteractionBinderBuilder help(final Pane helpPane);
}