Package com.vaadin.flow.component.page

Enum Class FullscreenSessionState

java.lang.Object

java.lang.Enum<FullscreenSessionState>

com.vaadin.flow.component.page.FullscreenSessionState

All Implemented Interfaces:

Serializable, Comparable<FullscreenSessionState>, Constable

public enum FullscreenSessionState
extends Enum<FullscreenSessionState>

Lifecycle state of a single FullscreenSession.

Each call to Page.requestFullscreen() or Component.requestFullscreen() starts a new session in PENDING and ends in one of the four terminal states: REJECTED if the browser refused the request, EXITED_BY_CODE if server code initiated the exit, or EXITED_BY_USER if the browser exited fullscreen for any other reason (Escape key, browser close button, navigation, etc.). The intermediate ACTIVE state means the browser accepted the request and fullscreen is currently in effect for this session.

See Also:

• FullscreenSession.stateSignal()

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
ACTIVE	The browser has accepted the request and the page or component is currently fullscreen.
EXITED_BY_CODE	Server code ended fullscreen by calling Page.exitFullscreen(), Component.exitFullscreen(), or FullscreenSession.exit().
EXITED_BY_USER	The user ended fullscreen — Escape key, the browser's exit button, navigation, or any other browser-side cause that was not a server-side Page.exitFullscreen() or Component.exitFullscreen() or FullscreenSession.exit() call.
PENDING	The request has been sent to the browser but no outcome has been reported yet.
REJECTED	The browser refused the request.

Method Summary

Modifier and Type	Method	Description
static FullscreenSessionState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FullscreenSessionState[]	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

PENDING

public static final FullscreenSessionState PENDING

The request has been sent to the browser but no outcome has been reported yet. Sessions transition out of this state to either ACTIVE or REJECTED.

ACTIVE

public static final FullscreenSessionState ACTIVE

The browser has accepted the request and the page or component is currently fullscreen. Sessions in this state transition to EXITED_BY_CODE or EXITED_BY_USER when fullscreen ends.

REJECTED

public static final FullscreenSessionState REJECTED

The browser refused the request. Common causes are missing transient user activation (the request was not made from a direct user gesture), an iframe permissions policy that blocks fullscreen, or the document being detached. A WARN is logged with the browser-provided error message. Terminal state.

EXITED_BY_USER

public static final FullscreenSessionState EXITED_BY_USER

The user ended fullscreen — Escape key, the browser's exit button, navigation, or any other browser-side cause that was not a server-side Page.exitFullscreen() or Component.exitFullscreen() or FullscreenSession.exit() call. Terminal state.

EXITED_BY_CODE

public static final FullscreenSessionState EXITED_BY_CODE

Server code ended fullscreen by calling Page.exitFullscreen(), Component.exitFullscreen(), or FullscreenSession.exit(). Also reached when a new requestFullscreen() supersedes the session before the previous one exited. Terminal state.

Method Details

values

public static FullscreenSessionState[] 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 FullscreenSessionState 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