javafx.stage

Enum Modality

java.lang.Object

java.lang.Enum<Modality>

javafx.stage.Modality

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Modality>

public enum Modality
extends java.lang.Enum<Modality>

This enum defines the possible modality types for a Stage.

Enum Constant Summary

Enum Constants

Enum Constant and Description
APPLICATION_MODAL Defines a modal window that blocks events from being delivered to any other application window.
NONE Defines a top-level window that is not modal and does not block any other window.
WINDOW_MODAL Defines a modal window that block events from being delivered to its entire owner window hierarchy.

Method Summary

Methods

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final Modality NONE

Defines a top-level window that is not modal and does not block any other window.

WINDOW_MODAL

public static final Modality WINDOW_MODAL

Defines a modal window that block events from being delivered to its entire owner window hierarchy. Note: A Stage with modality set to WINDOW_MODAL, but its owner is null, is treated as if its modality is set to NONE.

APPLICATION_MODAL

public static final Modality APPLICATION_MODAL

Defines a modal window that blocks events from being delivered to any other application window.

Method Detail

values

public static Modality[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Modality c : Modality.values())
    System.out.println(c);

Returns:

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

valueOf

public static Modality valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null