net.officefloor.eclipse.configurer.Configuration Maven / Gradle / Ivy

Go to download
/*
 * OfficeFloor - http://www.officefloor.net
 * Copyright (C) 2005-2018 Daniel Sagenschneider
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero 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 Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see .
 */
package net.officefloor.eclipse.configurer;

import javafx.beans.property.Property;
import javafx.beans.property.ReadOnlyProperty;
import javafx.scene.Node;

/**
 * Configured configuration.
 * 
 * @author Daniel Sagenschneider
 */
public interface Configuration {

	/**
	 * Obtains the {@link Node} containing the configuration.
	 * 
	 * @return {@link Node} containing the configuration.
	 */
	Node getConfigurationNode();

	/**
	 * Obtains the title.
	 * 
	 * @return Title.
	 */
	String getTitle();

	/**
	 * Indicates if configuration has been changed.
	 * 
	 * @return {@link Property} to indicate if the configuration has been changed.
	 */
	Property dirtyProperty();

	/**
	 * Indicates if the configuration is valid.
	 * 
	 * @return {@link ReadOnlyProperty} to indicate if the configuration is valid.
	 */
	Property validProperty();

	/**
	 * 
	 * Obtains the {@link Actioner} for the configuration
	 * 
	 * Should this be invoked, it is assumed the {@link Actioner} will be triggered
	 * externally to the configuration.
	 * 
	 * @return {@link Actioner} for the configuration.
	 */
	Actioner getActioner();

}