Package qupath.lib.gui.tools

Class CommandFinderTools

java.lang.Object

qupath.lib.gui.tools.CommandFinderTools

public class CommandFinderTools
extends Object

Helper tools for creating components that enable fast access to menu commands via a filtered list.

Author:

Pete Bankhead

Property Summary

Properties

Type	Property	Description
static ObjectProperty<CommandFinderTools.CommandBarDisplay>	commandBarDisplay	Property specifying where the command bar should be displayed relative to the main viewer window.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	CommandFinderTools.CommandBarDisplay	Available modes for displaying the command bar.
static class	CommandFinderTools.CommandEntry	Helper class to wrap summary data for a command to display in the list.

Constructor Summary

Constructors

Constructor	Description
CommandFinderTools()

Method Summary

Modifier and Type	Method	Description
static ObjectProperty<CommandFinderTools.CommandBarDisplay>	commandBarDisplayProperty()	Property specifying where the command bar should be displayed relative to the main viewer window.
static Stage	createCommandFinderDialog(QuPathGUI qupath)	Create a dialog showing a filtered list of menu commands, for fast selection.
static org.controlsfx.control.HiddenSidesPane	createCommandFinderPane(QuPathGUI qupath, Node node, ObjectProperty<CommandFinderTools.CommandBarDisplay> displayMode)	Create a component that contains a TextField for entering menu commands to run quickly.
static Stage	createRecentCommandsDialog(QuPathGUI qupath)	Create a dialog showing a filtered list of recently-used commands, for fast selection.
static String	menusToMarkdown()	Create a markdown representation of the menus for inclusion in the documentation, using the current QuPath instance.
static void	menusToMarkdown(QuPathGUI qupath, Writer writer)	Write a markdown representation of the menus for inclusion in the documentation.

Methods inherited from class java.lang.Object

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

Property Details

commandBarDisplay

public static ObjectProperty<CommandFinderTools.CommandBarDisplay> commandBarDisplayProperty

Property specifying where the command bar should be displayed relative to the main viewer window.

See Also:

• commandBarDisplayProperty()

Constructor Details

CommandFinderTools

public CommandFinderTools()

Method Details

commandBarDisplayProperty

public static ObjectProperty<CommandFinderTools.CommandBarDisplay> commandBarDisplayProperty()

Property specifying where the command bar should be displayed relative to the main viewer window.

Returns:

createCommandFinderPane

public static org.controlsfx.control.HiddenSidesPane createCommandFinderPane(QuPathGUI qupath,
 Node node,
 ObjectProperty<CommandFinderTools.CommandBarDisplay> displayMode)

Create a component that contains a TextField for entering menu commands to run quickly. This component is a container that holds a main Node, and displays the TextField only when requested.

Parameters:

qupath -

node -

displayMode -

Returns:

createCommandFinderDialog

public static Stage createCommandFinderDialog(QuPathGUI qupath)

Create a dialog showing a filtered list of menu commands, for fast selection.

Parameters:

qupath -

Returns:

createRecentCommandsDialog

public static Stage createRecentCommandsDialog(QuPathGUI qupath)

Create a dialog showing a filtered list of recently-used commands, for fast selection.

Parameters:

qupath -

Returns:

menusToMarkdown

public static String menusToMarkdown()
                              throws IOException

Create a markdown representation of the menus for inclusion in the documentation, using the current QuPath instance.

Returns:

Throws:

IOException

menusToMarkdown

public static void menusToMarkdown(QuPathGUI qupath,
 Writer writer)
                            throws IOException

Write a markdown representation of the menus for inclusion in the documentation.

Parameters:

qupath -

writer -

Throws:

IOException