io.github.interacto.jfx.binding.api.CmdBinder 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.command.Command;
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.Consumer;
import java.util.function.Supplier;
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 widget binding builder API already knows the type of UI command
* the widget bindings will produce, with routines
* for defining the UI command and the user interaction to use.
* @param The type of accepted widgets.
* @param The type of the produced UI Commands
*/
public interface CmdBinder extends CmdBinderBuilder {
@Override
CmdBinder first(final Consumer initCmdFct);
@Override
CmdBinder end(final Consumer onEnd);
@Override
CmdBinder end(final Runnable endFct);
@Override
CmdBinder on(final W... widgets);
@Override
CmdBinder on(final ObservableList widgets);
@Override
CmdBinder consume();
@Override
CmdBinder when(final BooleanSupplier whenPredicate);
@Override
CmdBinder log(final LogLevel... level);
@Override
CmdBinder async(final Button cancel, final DoubleProperty progressProp, final StringProperty msgProp);
@Override
CmdBinder help(final HelpAnimation animation);
@Override
CmdBinder help(final Pane helpPane);
/**
* Defines how to create the user interaction that the widget binding will use to create UI commands.
* @param interactionSupplier The supplier that will return a new user interaction.
* @param The user interaction data type
* @param The user interaction type
* @return A clone of the current builder to chain the building configuration.
*/
, D extends InteractionData> InteractionCmdBinder usingInteraction(final Supplier interactionSupplier);
}