io.github.interacto.jfx.command.IOCommand 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.command;

import io.github.interacto.command.CommandImpl;
import io.github.interacto.jfx.ui.JfxUI;
import io.github.interacto.jfx.ui.OpenSaver;
import java.io.File;
import javafx.scene.control.ProgressBar;

/**
 * An model for loading and saving commands.
 * @param  The type of the widget that will be used to display information.
 * @author Arnaud Blouin
 */
public abstract class IOCommand extends CommandImpl {
	/** The current file loaded or saved. */
	protected File file;

	/** Define if the drawing has been successfully loaded or saved. */
	protected boolean ok;

	/** The object that does save and load operations. */
	protected OpenSaver openSaveManager;

	/** The progress bar used to show the progress of the operation. */
	protected ProgressBar progressBar;

	/** The widget that displays the status of the I/O operation. */
	protected B statusWidget;

	protected JfxUI ui;


	public IOCommand(final File file, final OpenSaver openSaveManager, final ProgressBar progressBar, final B statusWidget, final JfxUI ui) {
		super();
		this.file = file;
		this.openSaveManager = openSaveManager;
		this.progressBar = progressBar;
		this.statusWidget = statusWidget;
		this.ui = ui;
		ok = false;
	}


	@Override
	public void flush() {
		super.flush();
		file = null;
		openSaveManager = null;
		progressBar = null;
		statusWidget = null;
		ui = null;
	}


	@Override
	public boolean canDo() {
		return openSaveManager != null && ui != null;
	}


	@Override
	public boolean hadEffect() {
		return ok && super.hadEffect();
	}

	/**
	 * @return The targeted file.
	 */
	public File getFile() {
		return file;
	}
}