Package dataPlotsFX.clickPlotFX

Class ClickReclassifyMenuItem

java.lang.Object

dataPlotsFX.clickPlotFX.ClickReclassifyMenuItem

All Implemented Interfaces:

OverlayMenuItem

public class ClickReclassifyMenuItem
extends Object
implements OverlayMenuItem

Menu items for manually classifying selected clicks in a TDGraph.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CLICK_GROUP	Flag to ensure clicks types can be grouped into sub menu if needs be

Fields inherited from interface dataPlotsFX.overlaymark.menuOptions.OverlayMenuItem

buttonWidthStandard, DATAINFO, EXPORT_GROUP, NO_GROUP

Constructor Summary

Constructors

Constructor	Description
ClickReclassifyMenuItem(ClickPlotInfoFX clickPlotInfoFX)

Method Summary

Modifier and Type	Method	Description
boolean	canBeUsed(DetectionGroupSummary foundDataUnits, int index, OverlayMark overlayMark)	Check whether the menu item can be used within a group of data units.
int	getFlag()	Flags for general grouping menu items
javafx.scene.control.Tooltip	getNodeToolTip()
int	getSubMenuGroup()	Indicates whether menu items should be grouped together in a sub menu.
javafx.scene.control.Control	menuAction(DetectionGroupSummary foundDataUnits, int index, OverlayMark overlayMark)	Returns a control which performs an action when pressed (or action occurs)

Methods inherited from class java.lang.Object

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

Field Details

CLICK_GROUP

public static final int CLICK_GROUP

Flag to ensure clicks types can be grouped into sub menu if needs be

See Also:

• Constant Field Values

Constructor Details

ClickReclassifyMenuItem

public ClickReclassifyMenuItem(ClickPlotInfoFX clickPlotInfoFX)

Method Details

getNodeToolTip

public javafx.scene.control.Tooltip getNodeToolTip()

Specified by:

getNodeToolTip in interface OverlayMenuItem

menuAction

public javafx.scene.control.Control menuAction(DetectionGroupSummary foundDataUnits,
 int index,
 OverlayMark overlayMark)

Description copied from interface: OverlayMenuItem

Returns a control which performs an action when pressed (or action occurs)

Specified by:

menuAction in interface OverlayMenuItem

Parameters:

foundDataUnits - all the selected data units

index - - the currently selected data unit

overlayMark - - the overlay mark. Can be null if a data unit is individually selected

canBeUsed

public boolean canBeUsed(DetectionGroupSummary foundDataUnits,
 int index,
 OverlayMark overlayMark)

Description copied from interface: OverlayMenuItem

Check whether the menu item can be used within a group of data units.

Specified by:

canBeUsed in interface OverlayMenuItem

Parameters:

foundDataUnits - - class which holds a list of data units and metadata info.

index - :. If the index is invalid input: '<'0 then returns whether the menu item can be used for at least one of the units in the list.

overlayMark - - holds info on the current mark drawn on the display.

getFlag

public int getFlag()

Description copied from interface: OverlayMenuItem

Flags for general grouping menu items

Specified by:

getFlag in interface OverlayMenuItem

Returns:

integer flag which groups items

getSubMenuGroup

public int getSubMenuGroup()

Description copied from interface: OverlayMenuItem

Indicates whether menu items should be grouped together in a sub menu. Make the same group and same flag if so.

Specified by:

getSubMenuGroup in interface OverlayMenuItem

Returns:

the group number. -1 for no grouping.