Package sc.fiji.snt.gui

Class GuiUtils.MenuItems

java.lang.Object

sc.fiji.snt.gui.GuiUtils.MenuItems

Enclosing class:

GuiUtils

public static class GuiUtils.MenuItems
extends Object

Utility methods for building and configuring JMenuItem/JMenu entries.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONNECT_HELP_LABEL	Label of the item returned by connectHelp(Supplier, Runnable, Runnable)

Method Summary

Modifier and Type	Method	Description
static void	addSeparator(JMenu menu, String header)
static void	addSeparator(JMenu menu, IconFactory.GLYPH glyph, String header)
static void	addSeparator(JPopupMenu menu, String header)
static void	addSeparator(JPopupMenu menu, IconFactory.GLYPH glyph, String header)
static void	addSeparator(JPopupMenu menu, IconFactory.GLYPH glyph, String header, String tooltip)
static JMenuItem	brainAreaAnalysis()
static JCheckBoxMenuItem	checkboxMenuItem(String label, boolean selected, ActionListener lstnr, KeyStroke keystroke)	Creates a checkbox menu item with a right-aligned shortcut hint and no global accelerator binding.
static JCheckBoxMenuItem	checkboxWithoutAccelerator(String text, boolean selected)
static JComponent	colorTagMenu(boolean asPopup, Component parent, Consumer<Color> onColorChosen)
static JMenu	colorTagMenu(Component parent, Consumer<Color> onColorChosen)
static JPopupMenu	colorTagPopup(Component parent, Consumer<Color> onColorChosen)
static LinkedHashMap<String,Color>	colorTagPresets()
static JMenuItem	combineCharts()
static JMenuItem	connectHelp(Supplier<GuiUtils> gui, Runnable onOpen, Runnable onClose)	Menu item that opens the "how to connect two paths in Edit Mode" help dialog (shared by the InteractiveTracerCanvas and Bdv/Bvv context menus)
static void	contrastOptions(JComponent menuOrPopupMenu, JComponent component, boolean includeSeparator)
static JMenuItem	convexHull()
static JMenuItem	createAnnotationGraph()
static JMenuItem	createDendrogram()
static JCheckBoxMenuItem	debugMode()
static int	defaultHeight()
static JMenuItem	devResourceJavaAPI()
static JMenuItem	devResourceMain()
static JMenuItem	devResourcePythonAPI()
static JMenuItem	distribution(Supplier<SNTTable> tableSupplier)
static JMenuItem	fromFileImage()
static JMenuItem	fromOpenImage()
static MenuElement[]	getMenuPath(JMenuItem item)
static Window	getParentWindow(JMenuItem menuItem)
static JMenu	helpMenu(SNTCommandFinder cmdFinder)
static JMenuItem	itemWithoutAccelerator(String text)
static JMenuItem	measureOptions()
static JMenuItem	measureQuick()
static JMenuItem	menuItem(String label, ActionListener lstnr, KeyStroke keystroke, char symbol, boolean solid, Color color)	Creates a menu item with a right-aligned shortcut hint, an optional icon specified by a font symbol, and no global accelerator binding.
static JMenuItem	menuItem(String label, ActionListener lstnr, KeyStroke keystroke, IconFactory.GLYPH glyph)	Creates a menu item with a right-aligned shortcut hint, an optional icon, and no global accelerator binding.
static JMenuItem	openHelpURL(String label, String URL)
static JMenuItem	openURL(String label, String URL)
static JMenuItem	persistenceAnalysis()
static JMenuItem	renderQuick()
static boolean	revealMenuItem(JMenuItem jmi)	Opens and arms the JMenu/JMenuBar chain leading to jmi, so it becomes showing without the user clicking through it (e.g., to anchor a tour callout, or to reveal a command-finder search hit).
static JMenuItem	rootAngleAnalysis()
static JMenuItem	save(Supplier<SNTTable> tableSupplier, JTable optionalUnderlyingJTable)
static JMenuItem	saveTablesAndPlots(IconFactory.GLYPH glyph)
static JMenuItem	shollAnalysis()
static JMenuItem	showHelpOnCountingSpines(boolean streamMode, Action postDialogAction)
static JMenuItem	strahlerAnalysis()
static JMenuItem	summarize(Supplier<SNTTable> tableSupplier, JTable optionalUnderlyingJTable)

Methods inherited from class java.lang.Object

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

Field Details

CONNECT_HELP_LABEL

public static final String CONNECT_HELP_LABEL

Label of the item returned by connectHelp(Supplier, Runnable, Runnable)

See Also:

• Constant Field Values

Method Details

connectHelp

public static JMenuItem connectHelp(Supplier<GuiUtils> gui,
 Runnable onOpen,
 Runnable onClose)

Menu item that opens the "how to connect two paths in Edit Mode" help dialog (shared by the InteractiveTracerCanvas and Bdv/Bvv context menus)

Parameters:

gui - supplies the GuiUtils used to display the dialog (evaluated when the item is activated)

onOpen - optional task run right before the dialog is displayed (may be null)

onClose - optional task run when the dialog is closed (may be null)

Returns:

the menu item

addSeparator

public static void addSeparator(JPopupMenu menu,
 String header)

addSeparator

public static void addSeparator(JMenu menu,
 String header)

addSeparator

public static void addSeparator(JPopupMenu menu,
 IconFactory.GLYPH glyph,
 String header)

addSeparator

public static void addSeparator(JPopupMenu menu,
 IconFactory.GLYPH glyph,
 String header,
 String tooltip)

addSeparator

public static void addSeparator(JMenu menu,
 IconFactory.GLYPH glyph,
 String header)

getParentWindow

public static Window getParentWindow(JMenuItem menuItem)

getMenuPath

public static MenuElement[] getMenuPath(JMenuItem item)

revealMenuItem

public static boolean revealMenuItem(JMenuItem jmi)

Opens and arms the JMenu/JMenuBar chain leading to jmi, so it becomes showing without the user clicking through it (e.g., to anchor a tour callout, or to reveal a command-finder search hit). Does nothing (returns false) if jmi's chain could not be resolved this way.

Returns:

true if jmi ended up armed/selected

distribution

public static JMenuItem distribution(Supplier<SNTTable> tableSupplier)

summarize

public static JMenuItem summarize(Supplier<SNTTable> tableSupplier,
 JTable optionalUnderlyingJTable)

save

public static JMenuItem save(Supplier<SNTTable> tableSupplier,
 JTable optionalUnderlyingJTable)

combineCharts

public static JMenuItem combineCharts()

persistenceAnalysis

public static JMenuItem persistenceAnalysis()

brainAreaAnalysis

public static JMenuItem brainAreaAnalysis()

devResourceMain

public static JMenuItem devResourceMain()

devResourceJavaAPI

public static JMenuItem devResourceJavaAPI()

devResourcePythonAPI

public static JMenuItem devResourcePythonAPI()

convexHull

public static JMenuItem convexHull()

createDendrogram

public static JMenuItem createDendrogram()

createAnnotationGraph

public static JMenuItem createAnnotationGraph()

measureOptions

public static JMenuItem measureOptions()

measureQuick

public static JMenuItem measureQuick()

renderQuick

public static JMenuItem renderQuick()

debugMode

public static JCheckBoxMenuItem debugMode()

rootAngleAnalysis

public static JMenuItem rootAngleAnalysis()

saveTablesAndPlots

public static JMenuItem saveTablesAndPlots(IconFactory.GLYPH glyph)

shollAnalysis

public static JMenuItem shollAnalysis()

strahlerAnalysis

public static JMenuItem strahlerAnalysis()

fromOpenImage

public static JMenuItem fromOpenImage()

fromFileImage

public static JMenuItem fromFileImage()

defaultHeight

public static int defaultHeight()

contrastOptions

public static void contrastOptions(JComponent menuOrPopupMenu,
 JComponent component,
 boolean includeSeparator)

itemWithoutAccelerator

public static JMenuItem itemWithoutAccelerator(String text)

checkboxWithoutAccelerator

public static JCheckBoxMenuItem checkboxWithoutAccelerator(String text,
 boolean selected)

menuItem

public static JMenuItem menuItem(String label,
 ActionListener lstnr,
 KeyStroke keystroke,
 IconFactory.GLYPH glyph)

Creates a menu item with a right-aligned shortcut hint, an optional icon, and no global accelerator binding. Suitable for context/popup menus where the shortcut is handled elsewhere.

Parameters:

label - the menu item text

lstnr - the action listener

keystroke - the shortcut to display (or null for none)

glyph - the icon glyph (or null for no icon)

Returns:

the configured menu item

menuItem

public static JMenuItem menuItem(String label,
 ActionListener lstnr,
 KeyStroke keystroke,
 char symbol,
 boolean solid,
 Color color)

Creates a menu item with a right-aligned shortcut hint, an optional icon specified by a font symbol, and no global accelerator binding.

Parameters:

label - the menu item text

lstnr - the action listener

keystroke - the shortcut to display (or null for none)

symbol - the icon font character (or '' for no icon)

solid - whether to use the solid font variant

color - the icon color

Returns:

the configured menu item

checkboxMenuItem

public static JCheckBoxMenuItem checkboxMenuItem(String label,
 boolean selected,
 ActionListener lstnr,
 KeyStroke keystroke)

Creates a checkbox menu item with a right-aligned shortcut hint and no global accelerator binding.

Parameters:

label - the menu item text

selected - the initial selection state

lstnr - the action listener

keystroke - the shortcut to display (or null for none)

Returns:

the configured checkbox menu item

helpMenu

public static JMenu helpMenu(SNTCommandFinder cmdFinder)

openURL

public static JMenuItem openURL(String label,
 String URL)

openHelpURL

public static JMenuItem openHelpURL(String label,
 String URL)

showHelpOnCountingSpines

public static JMenuItem showHelpOnCountingSpines(boolean streamMode,
 Action postDialogAction)

colorTagPresets

public static LinkedHashMap<String,Color> colorTagPresets()

colorTagMenu

public static JMenu colorTagMenu(Component parent,
 Consumer<Color> onColorChosen)

colorTagPopup

public static JPopupMenu colorTagPopup(Component parent,
 Consumer<Color> onColorChosen)

colorTagMenu

public static JComponent colorTagMenu(boolean asPopup,
 Component parent,
 Consumer<Color> onColorChosen)