Package dataPlotsFX.overlaymark.menuOptions

Interface OverlayMenuItem

All Known Implementing Classes:

ClickReclassifyMenuItem, CopyDetectionPlot, CopyTDDataPlot, CSVExportOverlayMenu, ExportOverlayMenu, MLExportOverlayMenu, RExportOverlayMenu, StandardOverlayMenuItem, WavExportOverlayMenu

public interface OverlayMenuItem

Interface for menu items which are TD Display specific.

Author:

Jamie Macaulay

Field Summary

Fields

Modifier and Type	Field	Description
static final int	buttonWidthStandard
static final int	DATAINFO	Flag for menu items which are form Data Infos
static final int	EXPORT_GROUP
static final int	NO_GROUP

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)

Field Details

buttonWidthStandard

static final int buttonWidthStandard

See Also:

• Constant Field Values

NO_GROUP

static final int NO_GROUP

See Also:

• Constant Field Values

EXPORT_GROUP

static final int EXPORT_GROUP

See Also:

• Constant Field Values

DATAINFO

static final int DATAINFO

Flag for menu items which are form Data Infos

See Also:

• Constant Field Values

Method Details

getNodeToolTip

javafx.scene.control.Tooltip getNodeToolTip()

menuAction

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

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

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

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

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

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

int getFlag()

Flags for general grouping menu items

Returns:

integer flag which groups items

getSubMenuGroup

int getSubMenuGroup()

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

Returns:

the group number. -1 for no grouping.