RenderHost.java

/*
 *  RenderHost.java
 *  Eisenkraut
 *
 *  Copyright (c) 2004-2016 Hanns Holger Rutz. All rights reserved.
 *
 *  This software is published under the GNU General Public License v3+
 *
 *
 *	For further information, please contact Hanns Holger Rutz at
 *	contact@sciss.de
 */

package de.sciss.eisenkraut.render;

/**
 *	A simple extension to
 *	the <code>PlugInHost</code>
 *	interface which adds support
 *	for progress bar and exception
 *	display.
 */
public interface RenderHost
{
	/**
	 *	Called by the plug-in to
	 *	request a message display
	 *
	 *	@param	type	type of message as given by
	 *					the JOptionPane
	 *	@param	text	the text to display
	 *
	 *	@see	javax.swing.JOptionPane#WARNING_MESSAGE 
	 *	@see	javax.swing.JOptionPane#ERROR_MESSAGE 
	 *	@see	javax.swing.JOptionPane#INFORMATION_MESSAGE 
	 */
	public void showMessage(int type, String text);
	
	/**
	 *	Determines if the host is active
	 *	that is processing or realtime enabled
	 *
	 *	@return	true if the host and thus the plug-in is actively processing
	 */
	public boolean isRunning();

	/**
	 *	Tells the host to update the progression bar.
	 *
	 *	@param	p	the new progression normalized
	 *				to 0.0 ... 1.0 . use -1 for
	 *				indeterminate mode
	 */
	public void setProgression( float p );
	
	/**
	 *	Saves the last internally caught exception.
	 *	This will be displayed when rendering aborts
	 *	with a failure.
	 *
	 *	@param	e	the recently caught exception
	 */
	public void setException( Exception e );
}