MouseMovementTracker (adams-pom 24.11.0-SNAPSHOT API)

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractMouseMovementTracker, CrossHairTracker, MultiMouseMovementTracker, NullTracker, TrackMousePositionInConsole
```
public interface MouseMovementTracker
extends Serializable
```
Interface for classes that track the mouse position on the content panel.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`PaintablePanel`	`getPanel()`	Returns the spectrum panel currently in use.
`void`	`mouseMovementTracked(MouseEvent e)`	Gets triggered when the mouse moved.
`void`	`setPanel(PaintablePanel value)`	Sets the spectrum panel to use, null to disable painting.
`MouseMovementTracker`	`shallowCopyTracker()`	Returns a shallow copy of the tracker.
`MouseMovementTracker`	`shallowCopyTracker(boolean expand)`	Returns a shallow copy of the tracker.

- Method Detail
  - setPanel
```
void setPanel(PaintablePanel value)
```
    Sets the spectrum panel to use, null to disable painting.
    
    Parameters:
    
    value - the panel to paint on
  - getPanel
```
PaintablePanel getPanel()
```
    Returns the spectrum panel currently in use.
    
    Returns:
    
    the panel in use
  - mouseMovementTracked
```
void mouseMovementTracked(MouseEvent e)
```
    Gets triggered when the mouse moved.
    
    Parameters:
    
    e - the mouse event that triggered the event
  - shallowCopyTracker
```
MouseMovementTracker shallowCopyTracker()
```
    Returns a shallow copy of the tracker. Doesn't expand variables in case of OptionHandler objects.
    
    Returns:
    
    a shallow copy of the tracker
  - shallowCopyTracker
```
MouseMovementTracker shallowCopyTracker(boolean expand)
```
    Returns a shallow copy of the tracker.
    
    Parameters:
    
    expand - whether to expand variables to their actual value
    
    Returns:
    
    a shallow copy of the tracker