PamView.zoomer

Interface Zoomable

All Known Implementing Classes:

AbstractTDZoomable, SpectrogramZoomer, TDGraphZoomer

public interface Zoomable

To be implemented by any display working with the Zoomer class.

Author:

Doug Gillespie

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canClearZoomShape(java.awt.event.MouseEvent mouseEvent)
boolean	canStartZoomArea(java.awt.event.MouseEvent mouseEvent) Can a zoom area be started ?
int	getCoordinateType()
double	getXRange()
double	getXScale()
double	getXStart()
double	getYRange()
double	getYScale()
double	getYStart()
void	zoomPolygonComplete(ZoomShape zoomShape) Called when a zoom shape has been completed.
void	zoomShapeChanging(ZoomShape zoomShape) Called as the zoom shape changes via some sort of mouse action.
void	zoomToShape(ZoomShape zoomShape) Zoom to the bounds of a particular shape.

Method Detail

canStartZoomArea

boolean canStartZoomArea(java.awt.event.MouseEvent mouseEvent)

Can a zoom area be started ?

This is called from the zoomer when a zoom area is about to start to check that there are not reasons for not starting the area. For instance if some other mouse event is to take priority over the zoom, e.g. clicking on a detection which might initiate some other menu action.

Parameters:

mouseEvent -

Returns:

true if zooming can start

zoomShapeChanging

void zoomShapeChanging(ZoomShape zoomShape)

Called as the zoom shape changes via some sort of mouse action.

Parameters:

zoomShape - shape that's changing.

zoomPolygonComplete

void zoomPolygonComplete(ZoomShape zoomShape)

Called when a zoom shape has been completed.

Parameters:

zoomShape - zoom shape that's completed.

getXStart

double getXStart()

Returns:

start (left most) value on the x axis scale

getXScale

double getXScale()

Returns:

x scale in pixels per unit

getXRange

double getXRange()

Returns:

range of x axis

getYStart

double getYStart()

Returns:

start (bottom most) value on the y axis scale

getYScale

double getYScale()

Returns:

y scale in pixels per unit

getYRange

double getYRange()

Returns:

the range of the y axis

getCoordinateType

int getCoordinateType()

Returns:

the coordinate type - can be pretty much anything so long as it is unique for different types of coordinate for that display, e.g. the Click bearing time display so that zooming can only take place in that coordinate system.

zoomToShape

void zoomToShape(ZoomShape zoomShape)

Zoom to the bounds of a particular shape.

Parameters:

zoomShape - shape to zoom to

canClearZoomShape

boolean canClearZoomShape(java.awt.event.MouseEvent mouseEvent)

Parameters:

mouseEvent -

Returns: