Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
ttools: refactor navigation mouse listener code
Add a new class NavigationListener which translates mouse gestures into surface re-aspecting requests. This can now be used in both topcat and stilts, avoiding duplicated code.
- Loading branch information
Showing
3 changed files
with
196 additions
and
197 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
142 changes: 142 additions & 0 deletions
142
ttools/src/main/uk/ac/starlink/ttools/plot2/NavigationListener.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,142 @@ | ||
| package uk.ac.starlink.ttools.plot2; | ||
|
|
||
| import java.awt.Component; | ||
| import java.awt.Point; | ||
| import java.awt.event.MouseEvent; | ||
| import java.awt.event.MouseListener; | ||
| import java.awt.event.MouseMotionListener; | ||
| import java.awt.event.MouseWheelEvent; | ||
| import java.awt.event.MouseWheelListener; | ||
|
|
||
| /** | ||
| * Listener that receives mouse events and uses them in conjunction with | ||
| * a supplied navigator to updae the aspect of a plot surface. | ||
| * | ||
| * @author Mark Taylor | ||
| * @since 30 Oct 2013 | ||
| */ | ||
| public abstract class NavigationListener<A> | ||
| implements MouseListener, MouseMotionListener, MouseWheelListener { | ||
| private Surface dragSurface_; | ||
| private Point startPoint_; | ||
|
|
||
| /** | ||
| * Returns a plotting surface which provides the context for navigation | ||
| * actions. | ||
| * | ||
| * @return current plotting surface, may be null | ||
| */ | ||
| public abstract Surface getSurface(); | ||
|
|
||
| /** | ||
| * Returns a navigator which is used to convert mouse gestures into | ||
| * updated surface aspects. | ||
| * | ||
| * @return current navigator, may be null | ||
| */ | ||
| public abstract Navigator<A> getNavigator(); | ||
|
|
||
| /** | ||
| * Returns an iterable over a sequence of data space positions, | ||
| * which may be required to make sense of a click action. | ||
| * | ||
| * @return iterable over data positions, may be null | ||
| * @see Navigator#click | ||
| */ | ||
| public abstract Iterable<double[]> createDataPosIterable(); | ||
|
|
||
| /** | ||
| * Receives a new aspect requested by user interface actions in | ||
| * conjunction with this object. | ||
| * | ||
| * @param aspect definition of requested plot surface | ||
| */ | ||
| public abstract void setAspect( A aspect ); | ||
|
|
||
| public void mousePressed( MouseEvent evt ) { | ||
|
|
||
| /* Start a drag gesture. */ | ||
| startPoint_ = evt.getPoint(); | ||
| dragSurface_ = getSurface(); | ||
| } | ||
|
|
||
| public void mouseDragged( MouseEvent evt ) { | ||
|
|
||
| /* Reposition surface midway through drag gesture. */ | ||
| if ( dragSurface_ != null ) { | ||
| Navigator<A> navigator = getNavigator(); | ||
| if ( navigator != null ) { | ||
| A aspect = navigator.drag( dragSurface_, evt, startPoint_ ); | ||
| if ( aspect != null ) { | ||
| setAspect( aspect ); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| public void mouseReleased( MouseEvent evt ) { | ||
|
|
||
| /* Terminate any current drag gesture. */ | ||
| dragSurface_ = null; | ||
| startPoint_ = null; | ||
| } | ||
|
|
||
| public void mouseClicked( MouseEvent evt ) { | ||
| int iButt = evt.getButton(); | ||
| if ( iButt == MouseEvent.BUTTON3 ) { | ||
| Navigator<A> navigator = getNavigator(); | ||
| Surface surface = getSurface(); | ||
| if ( navigator != null && surface != null ) { | ||
| A aspect = navigator | ||
| .click( surface, evt, createDataPosIterable() ); | ||
| if ( aspect != null ) { | ||
| setAspect( aspect ); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| public void mouseWheelMoved( MouseWheelEvent evt ) { | ||
| Navigator<A> navigator = getNavigator(); | ||
| Surface surface = getSurface(); | ||
| if ( navigator != null && surface != null ) { | ||
| A aspect = navigator.wheel( surface, evt ); | ||
| if ( aspect != null ) { | ||
| setAspect( aspect ); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| public void mouseMoved( MouseEvent evt ) { | ||
| } | ||
| public void mouseEntered( MouseEvent evt ) { | ||
| } | ||
| public void mouseExited( MouseEvent evt ) { | ||
| } | ||
|
|
||
| /** | ||
| * Convenience method to install this listener on a graphical component. | ||
| * This currently just calls | ||
| * <code>addMouseListener</code>, | ||
| * <code>addMouseMotionListener</code> and | ||
| * <code>addMouseWheelListener</code>. | ||
| * | ||
| * @param component component to which this object should listen | ||
| */ | ||
| public void addListeners( Component component ) { | ||
| component.addMouseListener( this ); | ||
| component.addMouseMotionListener( this ); | ||
| component.addMouseWheelListener( this ); | ||
| } | ||
|
|
||
| /** | ||
| * Reverses the effect of {@link #addListeners addListeners}. | ||
| * | ||
| * @param component component to which this listener was previously added | ||
| */ | ||
| public void removeListeners( Component component ) { | ||
| component.removeMouseListener( this ); | ||
| component.removeMouseMotionListener( this ); | ||
| component.removeMouseWheelListener( this ); | ||
| } | ||
| } |
Oops, something went wrong.