io.github.interacto.jfx.ui.JfxUI 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.ui;

import io.github.interacto.jfx.instrument.JfxInstrument;
import io.github.interacto.properties.Modifiable;
import io.github.interacto.properties.Preferenciable;
import io.github.interacto.properties.Reinitialisable;
import java.util.Set;
import java.util.stream.Stream;
import javafx.application.Application;
import javafx.beans.property.BooleanProperty;
import javafx.beans.property.SimpleBooleanProperty;
import javafx.beans.value.ChangeListener;
import javafx.scene.Scene;
import org.w3c.dom.Document;
import org.w3c.dom.Element;

/**
 * A JFX user interface.
 * @author Arnaud BLOUIN
 */
public abstract class JfxUI extends Application implements Modifiable, Reinitialisable, Preferenciable {
	/** Defined if the UI has been modified. */
	protected final BooleanProperty modified;
	/** The lambda that windows should register to reset interactions on focus loses. */
	private final ChangeListener focusReset;

	/**
	 * Creates a user interface.
	 */
	public JfxUI() {
		super();
		modified = new SimpleBooleanProperty(false);
		focusReset = (observable, oldValue, newValue) -> getInstruments().stream().map(ins -> ins.getWidgetBindings()).flatMap(s -> s.stream()).
			forEach(binding -> binding.clearEvents());
	}

	/**
	 * @return The instruments of the app.
	 */
	public abstract Set getInstruments();

	/**
	 * @param  The components must be Modifiable and Reinitialisable
	 * @return The set of objects that must be set as modified or be reinitialised (in complement to the instruments).
	 */
	protected abstract  Set getAdditionalComponents();

	@Override
	public void setModified(final boolean isModified) {
		modified.set(isModified);
		getAdditionalComponents().forEach(comp -> comp.setModified(isModified));
		getInstruments().forEach(ins -> ins.setModified(isModified));
	}


	@Override
	public boolean isModified() {
		return modified.get() || Stream.concat(getInstruments().stream(), getAdditionalComponents().stream()).anyMatch(ins -> ins.isModified());
	}

	@Override
	public void save(final boolean generalPreferences, final String nsURI, final Document document, final Element root) {
		// To override.
	}


	@Override
	public void load(final boolean generalPreferences, final String nsURI, final Element meta) {
		// To override.
	}

	public void registerScene(final Scene scene) {
		if(scene != null) {
			scene.getWindow().focusedProperty().addListener(focusReset);
		}
	}

	public void unregisterScene(final Scene scene) {
		if(scene != null) {
			scene.getWindow().focusedProperty().removeListener(focusReset);
		}
	}

	@Override
	public void reinit() {
		getAdditionalComponents().forEach(comp -> comp.reinit());
		getInstruments().forEach(ins -> ins.reinit());
		setModified(false);
	}
}