Package qupath.lib.gui.tools

Enum Class GuiTools.SnapshotType

java.lang.Object

java.lang.Enum<GuiTools.SnapshotType>

qupath.lib.gui.tools.GuiTools.SnapshotType

All Implemented Interfaces:

Serializable, Comparable<GuiTools.SnapshotType>, Constable

Enclosing class:

GuiTools

public static enum GuiTools.SnapshotType
extends Enum<GuiTools.SnapshotType>

Kinds of snapshot image that can be created for QuPath.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FULL_SCREENSHOT	Full screenshot, including items outside of QuPath.
MAIN_SCENE	Snapshot of the full Scene of the main QuPath Window.
MAIN_WINDOW_SCREENSHOT	Screenshot of the full QuPath window as it currently appears, including any overlapping windows.
VIEWER	Snapshot of the current viewer content.

Method Summary

Modifier and Type	Method	Description
static GuiTools.SnapshotType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static GuiTools.SnapshotType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

VIEWER

public static final GuiTools.SnapshotType VIEWER

Snapshot of the current viewer content.

MAIN_SCENE

public static final GuiTools.SnapshotType MAIN_SCENE

Snapshot of the full Scene of the main QuPath Window. This excludes the titlebar and any overlapping windows.

MAIN_WINDOW_SCREENSHOT

public static final GuiTools.SnapshotType MAIN_WINDOW_SCREENSHOT

Screenshot of the full QuPath window as it currently appears, including any overlapping windows.

FULL_SCREENSHOT

public static final GuiTools.SnapshotType FULL_SCREENSHOT

Full screenshot, including items outside of QuPath.

Method Details

values

public static GuiTools.SnapshotType[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static GuiTools.SnapshotType valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null