Package arez.dom

Enum Class DocumentVisibility.Visibility

java.lang.Object

java.lang.Enum<DocumentVisibility.Visibility>

arez.dom.DocumentVisibility.Visibility

All Implemented Interfaces:

Serializable, Comparable<DocumentVisibility.Visibility>, Constable

Enclosing class:

DocumentVisibility

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

The visibility state of the document.

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.
PRERENDER	The page content is being prerendered and is not visible to the user (considered hidden for purposes of document.hidden).
VISIBLE	The page content may be at least partially visible.

Method Summary

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

The page content may be at least partially visible. In practice this means that the page is the foreground tab of a non-minimized window.

HIDDEN

public static final DocumentVisibility.Visibility HIDDEN

The page content is not visible to the user. In practice this means that the document is either a background tab or part of a minimized window, or the OS screen lock is active.

PRERENDER

public static final DocumentVisibility.Visibility PRERENDER

The page content is being prerendered and is not visible to the user (considered hidden for purposes of document.hidden). The document may start in this state, but will never transition to it from another value. Note: browser support is optional.

Method Details

values

public static DocumentVisibility.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 DocumentVisibility.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