Package dataPlotsFX.overlaymark.menuOptions

Class CSVExportOverlayMenu

java.lang.Object

dataPlotsFX.overlaymark.menuOptions.ExportOverlayMenu

dataPlotsFX.overlaymark.menuOptions.CSVExportOverlayMenu

All Implemented Interfaces:

OverlayMenuItem

public class CSVExportOverlayMenu
extends ExportOverlayMenu

Export data units as .csv file

Author:

Jamie Macaulay

Nested Class Summary

Nested classes/interfaces inherited from class dataPlotsFX.overlaymark.menuOptions.ExportOverlayMenu

ExportOverlayMenu.FileTransferable

Field Summary

Fields inherited from class dataPlotsFX.overlaymark.menuOptions.ExportOverlayMenu

standardIconSize

Fields inherited from interface dataPlotsFX.overlaymark.menuOptions.OverlayMenuItem

buttonWidthStandard, DATAINFO, EXPORT_GROUP, NO_GROUP

Constructor Summary

Constructors

Constructor	Description
CSVExportOverlayMenu()

Method Summary

Modifier and Type	Method	Description
boolean	canBeUsed(DetectionGroupSummary foundDataUnits, int index, OverlayMark mark)	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.Labeled	menuAction(DetectionGroupSummary foundDataUnits, int index, OverlayMark mark)	Returns a control which performs an action when pressed (or action occurs)

Methods inherited from class dataPlotsFX.overlaymark.menuOptions.ExportOverlayMenu

showConfirmOverlay

Methods inherited from class java.lang.Object

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

Constructor Details

CSVExportOverlayMenu

public CSVExportOverlayMenu()

Method Details

menuAction

public javafx.scene.control.Labeled menuAction(DetectionGroupSummary foundDataUnits,
 int index,
 OverlayMark mark)

Description copied from interface: OverlayMenuItem

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

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

canBeUsed

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

Description copied from interface: OverlayMenuItem

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.

mark - - 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

Overrides:

getFlag in class ExportOverlayMenu

Returns:

integer flag which groups items

getNodeToolTip

public javafx.scene.control.Tooltip getNodeToolTip()

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.

Returns:

the group number. -1 for no grouping.