io.github.interacto.jfx.binding.KeysWindowBinder 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;

import io.github.interacto.command.Command;
import io.github.interacto.jfx.binding.api.LogLevel;
import io.github.interacto.jfx.instrument.JfxInstrument;
import io.github.interacto.jfx.interaction.help.HelpAnimation;
import io.github.interacto.jfx.interaction.library.KeysData;
import io.github.interacto.jfx.interaction.library.KeysPressed;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.EnumSet;
import java.util.List;
import java.util.function.BiConsumer;
import java.util.function.Function;
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.input.KeyCode;
import javafx.stage.Window;

/**
 * The binding builder to create bindings between a key interaction (eg shortcuts) on a window and a given command.
 * @param  The type of the command to produce.
 * @author Arnaud Blouin
 */
class KeysWindowBinder extends KeysBinder {
	KeysWindowBinder(final JfxInstrument instrument, final BindingsObserver observer) {
		super(instrument, observer);
	}

	KeysWindowBinder(final BiConsumer initCmd, final Predicate checkConditions, final Function cmdProducer,
		final List widgets, final JfxInstrument instrument, final boolean async,
		final BiConsumer onEnd, final List> additionalWidgets, final EnumSet logLevels,
		final HelpAnimation helpAnimation, final boolean withHelp, final DoubleProperty progressProp, final StringProperty msgProp, final Button cancel,
		final Collection codes, final BiConsumer hadNoEffectFct, final BiConsumer hadEffectsFct,
		final BiConsumer cannotExecFct, final BindingsObserver observer, final boolean consumeEvents) {
		super(initCmd, checkConditions, cmdProducer, widgets, instrument, async, onEnd, additionalWidgets, logLevels, helpAnimation,
			withHelp, progressProp, msgProp, cancel, codes, hadNoEffectFct, hadEffectsFct, cannotExecFct, observer, consumeEvents);
	}

	@Override
	protected KeysWindowBinder duplicate() {
		final KeysWindowBinder binder =  new KeysWindowBinder<>(initCmd, checkConditions, cmdProducer, widgets, instrument, async,
			onEnd, additionalWidgets, logLevels, helpAnimation, withHelp, progressProp, msgProp, cancel, new ArrayList<>(codes),
			hadNoEffectFct, hadEffectsFct, cannotExecFct, observer, consumeEvents);
		binder.alt = alt;
		binder.ctrl = ctrl;
		binder.meta = meta;
		binder.shift = shift;
		binder.shortcut = shortcut;
		return binder;
	}

	@Override
	public JfxWidgetBinding bind() {
		final JfxAnonWindowBinding binding = new JfxAnonWindowBinding<>(false, interactionSupplier.get(),
			initCmd, null, checkCode, onEnd, cmdProducer, null, null, widgets, false, false,
			10L, Collections.emptySet(), false, null, hadNoEffectFct, hadEffectsFct, cannotExecFct, consumeEvents);
		binding.setProgressBarProp(progressProp);
		binding.setProgressMsgProp(msgProp);
		binding.setCancelCmdButton(cancel);
		if(instrument != null) {
			instrument.addBinding(binding);
		}
		if(observer != null) {
			observer.observeBinding(binding);
		}
		return binding;
	}
}