Package org.vaadin.firitin.util

Enum Class PageVisibility.Visibility

java.lang.Object

java.lang.Enum<PageVisibility.Visibility>

org.vaadin.firitin.util.PageVisibility.Visibility

All Implemented Interfaces:

Serializable, Comparable<PageVisibility.Visibility>, Constable

Enclosing class:

PageVisibility

public static enum PageVisibility.Visibility
extends Enum<PageVisibility.Visibility>

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
HIDDEN	The page is not visible, e.g. the browser tab is not active or the window is minimized.
VISIBLE	The page is visible and focused.
VISIBLE_NON_FOCUSED	The page is visible but not focused.

Method Summary

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

VISIBLE

public static final PageVisibility.Visibility VISIBLE

The page is visible and focused. In the browser, this is indicated by the `document.hasFocus()` method returning true.

VISIBLE_NON_FOCUSED

public static final PageVisibility.Visibility VISIBLE_NON_FOCUSED

The page is visible but not focused. E.g. behind another window. In the browser, this is indicated by the `document.hasFocus()` method returning false,

HIDDEN

public static final PageVisibility.Visibility HIDDEN

The page is not visible, e.g. the browser tab is not active or the window is minimized. In the browser, this is indicated by the `document.hidden` property being true.

Method Details

values

public static PageVisibility.Visibility[] 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 PageVisibility.Visibility 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