TimelineAxis.java

/*
 *  TimelineAxis.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
 */

// XXX TO-DO : dispose, removeTimelineListener

package de.sciss.eisenkraut.timeline;

import de.sciss.app.AbstractApplication;
import de.sciss.app.DynamicAncestorAdapter;
import de.sciss.app.DynamicListening;
import de.sciss.app.DynamicPrefChangeManager;
import de.sciss.eisenkraut.edit.TimelineVisualEdit;
import de.sciss.eisenkraut.session.Session;
import de.sciss.eisenkraut.util.PrefsUtil;
import de.sciss.gui.Axis;
import de.sciss.gui.ComponentHost;
import de.sciss.gui.VectorSpace;
import de.sciss.io.Span;

import javax.swing.undo.CompoundEdit;
import javax.swing.undo.UndoableEdit;
import java.awt.event.MouseEvent;
import java.awt.event.MouseListener;
import java.awt.event.MouseMotionListener;
import java.util.prefs.PreferenceChangeEvent;
import java.util.prefs.PreferenceChangeListener;

/**
 *  A GUI element for displaying
 *  the timeline's axis (ruler)
 *  which is used to display the
 *  time indices and to allow the
 *  user to position and select the
 *  timeline.
 */
@SuppressWarnings("serial")
public class TimelineAxis
		extends Axis
		implements TimelineListener, MouseListener, MouseMotionListener,
		DynamicListening, PreferenceChangeListener {

	private final Session   doc;

	// when the user begins a selection by shift+clicking, the
	// initially fixed selection bound is saved to selectionStart.
	private long				selectionStart  = -1;
	private boolean				shiftDrag, altDrag;
    
	public TimelineAxis( Session doc )
	{
		this( doc, null );
	}
	
	/**
	 *  Constructs a new object for
	 *  displaying the timeline ruler
	 *
	 *  @param  doc		session Session
	 */
	public TimelineAxis(Session doc, ComponentHost host) {
		super(HORIZONTAL, 0, host);

		this.doc = doc;
		
		// --- Listener ---
		new DynamicAncestorAdapter(this).addTo(this);
		new DynamicAncestorAdapter(new DynamicPrefChangeManager(
				AbstractApplication.getApplication().getUserPrefs(), new String[]{PrefsUtil.KEY_TIMEUNITS}, this
		)).addTo(this);
		this.addMouseListener(this);
		this.addMouseMotionListener(this);

//		// ------
//		HelpGlassPane.setHelp( this, "TimelineAxis" );
	}
  
	private void recalcSpace()
	{
		final Span			visibleSpan;
		final double		d1;
		final VectorSpace	space;
	
//		if( !doc.bird.attemptShared( Session.DOOR_TIME, 250 )) return;
//		try {
			visibleSpan = doc.timeline.getVisibleSpan();
			if( (getFlags() & TIMEFORMAT) == 0 ) {
				space	= VectorSpace.createLinSpace( visibleSpan.getStart(),
													  visibleSpan.getStop(),
													  0.0, 1.0, null, null, null, null );
			} else {
				d1		= 1.0 / doc.timeline.getRate();
				space	= VectorSpace.createLinSpace( visibleSpan.getStart() * d1,
													  visibleSpan.getStop() * d1,
													  0.0, 1.0, null, null, null, null );
			}
			setSpace( space );
//		}
//		finally {
//			doc.bird.releaseShared( Session.DOOR_TIME );
//		}
	}

	// Sync: attempts doc.timeline
	private void dragTimelinePosition( MouseEvent e )
	{
		int				x   = e.getX();
		Span			span, span2;
		long			position;
		UndoableEdit	edit;

		// translate into a valid time offset
        span        = doc.timeline.getVisibleSpan();
        position    = span.getStart() + (long) ((double) x / (double) getWidth() *
                                                span.getLength());
        position    = Math.max( 0, Math.min( doc.timeline.getLength(), position ));
        
        if( shiftDrag ) {
			span2	= doc.timeline.getSelectionSpan();
			if( altDrag || span2.isEmpty() ) {
				selectionStart = doc.timeline.getPosition();
				altDrag = false;
			} else if( selectionStart == -1 ) {
				selectionStart = Math.abs( span2.getStart() - position ) >
								 Math.abs( span2.getStop() - position ) ?
								 span2.getStart() : span2.getStop();
			}
			span	= new Span( Math.min( position, selectionStart ),
								Math.max( position, selectionStart ));
			edit	= TimelineVisualEdit.select( this, doc, span ).perform();
        } else {
			if( altDrag ) {
				edit	= new CompoundEdit();
				edit.addEdit( TimelineVisualEdit.select( this, doc, new Span() ).perform() );
				edit.addEdit( TimelineVisualEdit.position( this, doc, position ).perform() );
				((CompoundEdit) edit).end();
				altDrag = false;
			} else {
				edit	= TimelineVisualEdit.position( this, doc, position ).perform();
			}
        }
		doc.getUndoManager().addEdit( edit );
	}

// ---------------- PreferenceChangeListener interface ---------------- 

		public void preferenceChange( PreferenceChangeEvent e )
		{
			final String key = e.getKey();
			
			if( key.equals( PrefsUtil.KEY_TIMEUNITS )) {
				int timeUnits = e.getNode().getInt( key, 0 );
				if( timeUnits == 0 ) {
					setFlags( INTEGERS );
				} else {
					setFlags( TIMEFORMAT );
				}
				recalcSpace();
			}
		}

// ---------------- DynamicListening interface ---------------- 

    public void startListening()
    {
         doc.timeline.addTimelineListener( this );
    }

    public void stopListening()
    {
         doc.timeline.removeTimelineListener( this );
    }

// ---------------- MouseListener interface ---------------- 
// we're listening to the ourselves

	public void mouseEntered( MouseEvent e )
	{
//		if( isEnabled() ) dispatchMouseMove( e );
	}
	
	public void mousePressed( MouseEvent e )
	{
		shiftDrag		= e.isShiftDown();
		altDrag			= e.isAltDown();
		selectionStart  = -1;
		dragTimelinePosition( e );
	}

	public void mouseExited( MouseEvent e ) { /* ignore */ }
	public void mouseReleased( MouseEvent e ) { /* ignore */ }
	public void mouseClicked( MouseEvent e ) { /* ignore */ }

// ---------------- MouseMotionListener interface ---------------- 
// we're listening to ourselves

    public void mouseMoved( MouseEvent e ) { /* ignore */ }

	public void mouseDragged( MouseEvent e )
	{
		dragTimelinePosition( e );
	}

// ---------------- TimelineListener interface ---------------- 
  
   	public void timelineSelected( TimelineEvent e ) { /* ignore */ }
	public void timelinePositioned( TimelineEvent e ) { /* ignore */ }

	public void timelineChanged( TimelineEvent e )
	{
		recalcSpace();
	}

   	public void timelineScrolled( TimelineEvent e )
    {
		recalcSpace();
    }
}