es.gob.afirma.standalone.plugins.PluginAction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of afirma-ui-simpleafirma-plugins Show documentation

Base para la construccion de plugins de AutoFirma

The newest version!

package es.gob.afirma.standalone.plugins;

import java.awt.Window;
import java.util.Properties;

/**
 * Define a nivel generico una accion que se puede realizar desde un botón de un plugin.
 * Para definir una accion personalizada, se debería implementar alguna de las subinterfaces
 * que extienden a esta.
 */
public abstract class PluginAction {

	private AfirmaPlugin plugin = null;

	public final void setPlugin(final AfirmaPlugin plugin) {
		this.plugin = plugin;
	}

	/**
	 * Obtiene la configuración establecida para el plugin a traves de su panel
	 * de configuración.
	 * @return Configuración establecida.
	 */
	protected final Properties getConfig() {
		if (this.plugin != null) {
			return PluginPreferences.getInstance(this.plugin).recoverConfig();
		}
		return new Properties();
	}

	/**
	 * Actualiza la configuración proporcionada para el plugin, permitiendo que se actualice a
	 * traves de los diálogos y acciones que ejecuta.
	 * @param config Configuración que debe establecerse.
	 */
	protected final void saveConfig(final Properties config) {
		if (this.plugin != null) {
			PluginPreferences.getInstance(this.plugin).saveConfig(config);
		}
	}

	@SuppressWarnings("unused")
	public void start(final Window parent) {
		// Por defecto, no se hace nada
	}

}