Package eu.webtoolkit.jwt

Enum Class VisibilityState

java.lang.Object

java.lang.Enum<VisibilityState>

eu.webtoolkit.jwt.VisibilityState

All Implemented Interfaces:

Serializable, Comparable<VisibilityState>, Constable

public enum VisibilityState
extends Enum<VisibilityState>

Enumeration for the visibility state of a page.

The visibility state of a page indicates whether the page content is visible to the user or not.

See Also:

• WApplication.getVisibilityState()

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 content is not visible to the user.
Unknown	The visibility state of the page is not known.
Visible	The page content may be visible to the user.

Method Summary

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

The page content may be visible to the user.

This state means that the page may be completely or partially visible to the user. In practice, it means that the page is the active tab of a window that is not minimized.

Hidden

public static final VisibilityState Hidden

The page content is not visible to the user.

This state means that the page content is hidden from the user. This could be because the page is in a background tab, the window is minimized, or the OS screen lock is active.

Unknown

public static final VisibilityState Unknown

The visibility state of the page is not known.

Method Details

values

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

getValue

public int getValue()

Returns the numerical representation of this enum.