mds.wave.WaveformManager Maven / Gradle / Ivy

Go to download
package mds.wave;

/* $Id$ */
import java.awt.Point;

/**
 * This interface can be implemented by (Multi)Waveform panel container to
 * perfom interaction between (Multi)Waveform object, autoscale action,
 * copy/paste action etc..
 *
 * @see WaveformContainer
 */
public interface WaveformManager
{
	/**
	 * Set the same scale factor of the argument waveform to all waveform
	 *
	 * @param curr_w a waveform
	 * @see Waveform
	 * @see MultiWaveform
	 */
	public void allSameScale(Waveform curr_w);

	/**
	 * Set x scale factor of all waveform equals to argument waveform
	 *
	 * @param curr_w a waveform
	 * @see Waveform
	 * @see MultiWaveform
	 */
	public void allSameXScale(Waveform curr_w);

	/**
	 * Autoscale y axis and set x axis equals to argument waveform
	 *
	 * @param curr_w a waveform
	 * @see Waveform
	 * @see MultiWaveform
	 */
	public void allSameXScaleAutoY(Waveform curr_w);

	/**
	 * Set y scale factor of all waveform equals to argument waveform
	 *
	 * @param curr_w a waveform
	 * @see Waveform
	 * @see MultiWaveform
	 */
	public void allSameYScale(Waveform curr_w);

	/**
	 * Autoscale operation on all waveforms
	 *
	 * @see Waveform
	 * @see MultiWaveform
	 */
	public void autoscaleAll();

	/**
	 * Autoscale operation on all images
	 *
	 * @see Waveform
	 * @see MultiWaveform
	 */
	public void autoscaleAllImages();

	/**
	 * Autoscale y axis on all waveform
	 *
	 * @see Waveform
	 * @see MultiWaveform
	 */
	public void autoscaleAllY();

	/**
	 * Deselect waveform.
	 *
	 * @see Waveform
	 * @see MultiWaveform
	 */
	public void deselect();

	/**
	 * Get current waveform selected as copy source
	 *
	 * @return copy source waveform
	 */
	public Waveform getCopySource();

	/**
	 * Get the number of waveform in the container
	 *
	 * @return number of waveform in the container
	 */
	public int getWaveformCount();

	/**
	 * Return row, column position on the panel
	 *
	 * @param w a waveform
	 */
	public Point getWavePosition(Waveform w);

	/**
	 * Get current selected waveform.
	 *
	 * @return current selected waveform or null
	 * @see Waveform
	 * @see MultiWaveform
	 */
	public Waveform gGetSelected();

	public boolean isMaximize();

	public void maximizeComponent(Waveform w);

	/**
	 * Perform copy operation
	 *
	 * @param dest   destination waveform
	 * @param source source waveform
	 */
	public void notifyChange(Waveform dest, Waveform source);

	/**
	 * Remove a waveform.
	 *
	 * @param w waveform to remove
	 */
	public void removePanel(Waveform w);

	/**
	 * Reset all waveform scale factor.
	 *
	 * @see Waveform
	 * @see MultiWaveform
	 */
	public void resetAllScales();

	/**
	 * Select a waveform
	 *
	 * @param w waveform to select
	 * @see Waveform
	 * @see MultiWaveform
	 */
	public void select(Waveform w);

	/**
	 * Set copy source waveform
	 *
	 * @param w copy source waveform
	 * @see Waveform
	 * @see MultiWaveform
	 */
	public void setCopySource(Waveform w);

	/**
	 * Enable or disable measure mode
	 *
	 * @param state measure mode flag
	 * @see Waveform
	 * @see MultiWaveform
	 */
	public void setShowMeasure(boolean state);

	/**
	 * Update crosshair position
	 *
	 * @param curr_x x axis position
	 * @param w      a waveform to update cross
	 * @see Waveform
	 * @see MultiWaveform
	 */
	public void updatePoints(double curr_x, Waveform w);
}