Package PamView.paneloverlay.overlaymark

Interface OverlayMarkObserver

All Known Implementing Classes:

ClickMarkHandler, MarkGroupProcess, SpectrogramAnnotationModule.DisplayObserver, SpectrogramMarkConverter

public interface OverlayMarkObserver

Interface used by something that is observing a spectrogram mark.

Author:

Doug Gillespie

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MARK_CANCELLED
static final int	MARK_END
static final int	MARK_START	Note that start, end and update are the same (0,1,2) as SpectrogramMarkObserver down, up and drag
static final int	MARK_UPDATE
static final int	MOUSE_CLICK

Method Summary

Modifier and Type	Method	Description
MarkDataSelector	getMarkDataSelector(OverlayMarker overlayMarker)	Get a data selector for use with a specific type of mark.
String	getMarkName()	Name of the mark.
String	getObserverName()	Name of the mark observer.
JPopupMenu	getPopupMenuItems(DetectionGroupSummary markSummaryData)	Get a menu, or menu items which can be used to display on the marking display in response to a right click or some other action.
GeneralProjector.ParameterType[]	getRequiredParameterTypes()	Required parameters for the mark to get used.
boolean	markUpdate(int markStatus, javafx.scene.input.MouseEvent mouseEvent, OverlayMarker overlayMarker, OverlayMark overlayMark)	Mark update called whenever a mark changes

Field Details

MARK_START

static final int MARK_START

Note that start, end and update are the same (0,1,2) as SpectrogramMarkObserver down, up and drag

See Also:

• Constant Field Values

MARK_END

static final int MARK_END

See Also:

• Constant Field Values

MARK_UPDATE

static final int MARK_UPDATE

See Also:

• Constant Field Values

MARK_CANCELLED

static final int MARK_CANCELLED

See Also:

• Constant Field Values

MOUSE_CLICK

static final int MOUSE_CLICK

See Also:

• Constant Field Values

Method Details

markUpdate

boolean markUpdate(int markStatus,
 javafx.scene.input.MouseEvent mouseEvent,
 OverlayMarker overlayMarker,
 OverlayMark overlayMark)

Mark update called whenever a mark changes

Parameters:

markStatus - start, end, update, cancel, etc.

overlayMarker - Source of the mark (generally a display)

overlayMark - updated mark.

Returns:

true if the observer has used the mark.

getPopupMenuItems

JPopupMenu getPopupMenuItems(DetectionGroupSummary markSummaryData)

Get a menu, or menu items which can be used to display on the marking display in response to a right click or some other action.

The menu items will be put into a popup menu for display.

Parameters:

markSummaryData - everything we need to know about the mark, including which data are within it.

Returns:

A menu item (can be null)

getRequiredParameterTypes

GeneralProjector.ParameterType[] getRequiredParameterTypes()

Required parameters for the mark to get used. Can be null in which case the mark can accept anything, might be something like TIME invalid input: '&' FREQUENCY, etc.

Returns:

list of parameters (up to three).

getObserverName

String getObserverName()

Name of the mark observer.

Returns:

the observer name

getMarkDataSelector

MarkDataSelector getMarkDataSelector(OverlayMarker overlayMarker)

Get a data selector for use with a specific type of mark.

Parameters:

overlayMarker - Marker

Returns:

Data selector (can be null)

getMarkName

String getMarkName()

Name of the mark. Observers may have several mark types and might want to change the name to indicate what action will be taken when a mark is made

Returns: