Package clickDetector.offlineFuncs

Class ClickMarkHandler

java.lang.Object

clickDetector.offlineFuncs.ClickMarkHandler

All Implemented Interfaces:

OverlayMarkObserver

public class ClickMarkHandler
extends Object
implements OverlayMarkObserver

Field Summary

Fields inherited from interface PamView.paneloverlay.overlaymark.OverlayMarkObserver

MARK_CANCELLED, MARK_END, MARK_START, MARK_UPDATE, MOUSE_CLICK

Constructor Summary

Constructors

Constructor	Description
ClickMarkHandler(ClickControl clickControl)

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.
JMenuItem	getMarkOptionsMenuItem(Frame parentFrame)	Get a single menu item to include in the greater click detector menu.
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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ClickMarkHandler

public ClickMarkHandler(ClickControl clickControl)

Parameters:

clickControl -

Method Details

markUpdate

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

Description copied from interface: OverlayMarkObserver

Mark update called whenever a mark changes

Specified by:

markUpdate in interface OverlayMarkObserver

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

public JPopupMenu getPopupMenuItems(DetectionGroupSummary markSummaryData)

Description copied from interface: OverlayMarkObserver

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.

Specified by:

getPopupMenuItems in interface OverlayMarkObserver

Parameters:

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

Returns:

A menu item (can be null)

getRequiredParameterTypes

public GeneralProjector.ParameterType[] getRequiredParameterTypes()

Description copied from interface: OverlayMarkObserver

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.

Specified by:

getRequiredParameterTypes in interface OverlayMarkObserver

Returns:

list of parameters (up to three).

getObserverName

public String getObserverName()

Description copied from interface: OverlayMarkObserver

Name of the mark observer.

Specified by:

getObserverName in interface OverlayMarkObserver

Returns:

the observer name

getMarkOptionsMenuItem

public JMenuItem getMarkOptionsMenuItem(Frame parentFrame)

Get a single menu item to include in the greater click detector menu.

Parameters:

parentFrame -

Returns:

menu item.

getMarkDataSelector

public MarkDataSelector getMarkDataSelector(OverlayMarker overlayMarker)

Description copied from interface: OverlayMarkObserver

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

Specified by:

getMarkDataSelector in interface OverlayMarkObserver

Parameters:

overlayMarker - Marker

Returns:

Data selector (can be null)

getMarkName

public String getMarkName()

Description copied from interface: OverlayMarkObserver

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

Specified by:

getMarkName in interface OverlayMarkObserver

Returns: