Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- animateProperty() - Method in class qupath.fx.controls.tour.GuiTour
-
Property to control whether the tour should animate highlights when moving between items.
- attach(Window) - Method in class qupath.fx.controls.tour.RelativeWindowMover
-
Attach to an owner window.
B
- boundsToRect(Bounds) - Static method in class qupath.fx.controls.tour.TourUtils
-
Convert the 2D component of a bounds object to a rectangle.
C
- computeScreenBounds(List<? extends Node>) - Static method in class qupath.fx.controls.tour.TourUtils
-
Compute the bounding box for all specified nodes.
- create(ResourceBundle, String, Collection<? extends Node>) - Static method in class qupath.ext.training.ui.tour.MarkdownTourItem
-
Create a new tour item.
- createDefaultSkin() - Method in class qupath.fx.controls.tour.GuiTour
- createPage() - Method in class qupath.ext.training.ui.tour.MarkdownTourItem
- createPage() - Method in interface qupath.fx.controls.tour.TourItem
-
Create a content page to display for this item.
- createScaledSnapshot(Node, double) - Static method in class qupath.fx.controls.tour.TourUtils
-
Create a snapshot image of a node with a transparent background, scaled by the specified factor.
- createScaledSnapshot(Node, Rectangle2D, double) - Static method in class qupath.fx.controls.tour.TourUtils
-
Create a snapshot image of a node with a transparent background, scaled by the specified factor and optionally cropping to the specified bounds.
- createScaledSnapshot(Window, Rectangle2D, double) - Static method in class qupath.fx.controls.tour.TourUtils
-
Create a snapshot image of a portion of a window, using screen coordinates and a transparent background.
- createWithImage(ResourceBundle, String, Collection<? extends Node>, Supplier<Image>) - Static method in class qupath.ext.training.ui.tour.MarkdownTourItem
-
Create a new tour item with a lazily-generated image.
- createWithImage(ResourceBundle, String, Collection<? extends Node>, Image) - Static method in class qupath.ext.training.ui.tour.MarkdownTourItem
-
Create a new tour item with a specific (static) image.
D
- detach() - Method in class qupath.fx.controls.tour.RelativeWindowMover
-
Detach from the current owner window.
- doAnimate() - Method in class qupath.fx.controls.tour.GuiTour
-
Get whether the tour should animate highlights when moving between items.
- doShowHighlight() - Method in class qupath.fx.controls.tour.GuiTour
-
Get whether the tour should show highlights.
G
- getDescription() - Method in class qupath.ext.training.ui.TrainingExtension
- getHighlightNodes() - Method in class qupath.ext.training.ui.tour.MarkdownTourItem
-
Get an unmodifiable list of nodes to display.
- getHighlightNodes() - Method in interface qupath.fx.controls.tour.TourItem
-
Get a list of nodes to highlight.
- getImage() - Method in class qupath.ext.training.ui.tour.MarkdownTourItem
-
Get a static image to display, or null if no static image is stored.
- getItems() - Method in class qupath.fx.controls.tour.GuiTour
-
Get the list of items in the tour.
- getName() - Method in class qupath.ext.training.ui.TrainingExtension
- getOwner() - Method in class qupath.fx.controls.tour.RelativeWindowMover
-
Get the current owner window, or null if there is no owner.
- getQuPathVersion() - Method in class qupath.ext.training.ui.TrainingExtension
- getRepository() - Method in class qupath.ext.training.ui.TrainingExtension
- getText() - Method in class qupath.ext.training.ui.tour.MarkdownTourItem
-
Get the main text to display, formatted as markdown.
- getTitle() - Method in class qupath.ext.training.ui.tour.GuiTourCommand
-
Get the title to display for the QuPath tour.
- getTitle() - Method in class qupath.ext.training.ui.tour.MarkdownTourItem
-
Get the title to display.
- getTitle() - Method in interface qupath.fx.controls.tour.TourItem
-
Get the title for this item.
- getWindow() - Method in class qupath.fx.controls.tour.RelativeWindowMover
-
Get the current window, which may be moved relative to an owner.
- GuiTour - Class in qupath.fx.controls.tour
-
A control to manage a tour of GUI elements.
- GuiTour() - Constructor for class qupath.fx.controls.tour.GuiTour
-
Create a new tour.
- GuiTourCommand - Class in qupath.ext.training.ui.tour
-
A command to run a tour of the QuPath user interface.
- GuiTourCommand(QuPathGUI) - Constructor for class qupath.ext.training.ui.tour.GuiTourCommand
- GuiTourSkin - Class in qupath.fx.controls.tour
-
The default skin for the
GuiTourcontrol. - GuiTourSkin(GuiTour, TourHighlight) - Constructor for class qupath.fx.controls.tour.GuiTourSkin
-
Constructor for all SkinBase instances.
H
- hide() - Method in interface qupath.fx.controls.tour.TourHighlight
-
Stop displaying the highlight.
- highlightNodes(List<? extends Node>) - Method in interface qupath.fx.controls.tour.TourHighlight
-
Highlight multiple nodes in the GUI.
I
- installExtension(QuPathGUI) - Method in class qupath.ext.training.ui.TrainingExtension
M
- MarkdownTourItem - Class in qupath.ext.training.ui.tour
-
An implementation of
TourItemthat uses resource bundles, markdown and WebViews to display content. - moveTo(double, double) - Method in class qupath.fx.controls.tour.RelativeWindowMover
-
Set the location of the managed window.
Q
- qupath.ext.training.ui - package qupath.ext.training.ui
- qupath.ext.training.ui.tour - package qupath.ext.training.ui.tour
- qupath.fx.controls.tour - package qupath.fx.controls.tour
-
Create a tour of a JavaFX graphical user interface, highlighting elements and providing explanations.
R
- rectToBounds(Rectangle2D) - Static method in class qupath.fx.controls.tour.TourUtils
-
Convert a rectangle to a bounds object.
- RelativeWindowMover - Class in qupath.fx.controls.tour
-
Helper class to move a window relative to another window.
- RelativeWindowMover(Window) - Constructor for class qupath.fx.controls.tour.RelativeWindowMover
-
Constructor.
- run() - Method in class qupath.ext.training.ui.tour.GuiTourCommand
S
- setAnimate(boolean) - Method in class qupath.fx.controls.tour.GuiTour
-
Set whether the tour should animate highlights when moving between items.
- setShowHighlight(boolean) - Method in class qupath.fx.controls.tour.GuiTour
-
Set whether the tour should show highlights.
- show() - Method in interface qupath.fx.controls.tour.TourHighlight
-
Ensure the highlight is showing.
- showHighlightProperty() - Method in class qupath.fx.controls.tour.GuiTour
-
Property to control whether the tour should show highlights.
- STYLE_HIGHLIGHT_CSS - Static variable in class qupath.fx.controls.tour.GuiTour
-
Style class using CSS to highlight nodes.
- STYLE_HIGHLIGHT_EFFECT - Static variable in class qupath.fx.controls.tour.GuiTour
-
Style class that temporary attaches an Effect to nodes to highlight them.
- STYLE_HIGHLIGHT_OVERLAY - Static variable in class qupath.fx.controls.tour.GuiTour
-
Style class using a transparent window overlay to highlight nodes.
T
- toString() - Method in class qupath.ext.training.ui.tour.MarkdownTourItem
- TourHighlight - Interface in qupath.fx.controls.tour
-
Helper class to highlight specific nodes during a GUI tour.
- TourItem - Interface in qupath.fx.controls.tour
-
A single item in a
GuiTour. - TourUtils - Class in qupath.fx.controls.tour
-
Utility methods for working with tours.
- TourUtils() - Constructor for class qupath.fx.controls.tour.TourUtils
- TrainingExtension - Class in qupath.ext.training.ui
- TrainingExtension() - Constructor for class qupath.ext.training.ui.TrainingExtension
All Classes and Interfaces|All Packages|Constant Field Values