Package com.vaadin.flow.component.fullscreen

Enum Class FullscreenState

java.lang.Object
java.lang.Enum<FullscreenState>
com.vaadin.flow.component.fullscreen.FullscreenState
All Implemented Interfaces:
Serializable, Comparable<FullscreenState>, Constable
public enum FullscreenState extends Enum<FullscreenState>
The fullscreen state of the browser page, as reported by Fullscreen.stateSignal().

There are four observable states: the browser cannot go fullscreen at all (UNSUPPORTED), it can but the page is not currently fullscreen (NOT_FULLSCREEN), the page is fullscreen (FULLSCREEN), and an UNKNOWN sentinel used before the browser has reported its first value.

Since:
25.2
See Also:

  • Enum Constant Details

    • UNKNOWN

      public static final FullscreenState UNKNOWN
      The browser has not reported a value yet. This is only the signal's initial value before the first client round-trip completes; in practice a real value is in place before any application code runs, and the signal never returns to UNKNOWN once it has a real value. Treat it as "not known yet" if you ever observe it.

    • UNSUPPORTED

      public static final FullscreenState UNSUPPORTED
      The browser cannot go fullscreen ? either it does not support fullscreen, or the page is not permitted to enter it (for example when embedded in an iframe without the required permission). A fullscreen request started via Fullscreen.onClick(T) fails in this state.

    • NOT_FULLSCREEN

      public static final FullscreenState NOT_FULLSCREEN
      The browser can go fullscreen and the page is currently not fullscreen. This is the normal state before the user triggers a fullscreen request.

    • FULLSCREEN

      public static final FullscreenState FULLSCREEN
      The page is currently displayed in fullscreen.

  • Method Details

    • values

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