org.apache.deltaspike.jsf.spi.scope.window

Enum ClientWindowConfig.ClientWindowRenderMode

java.lang.Object

java.lang.Enum<ClientWindowConfig.ClientWindowRenderMode>

org.apache.deltaspike.jsf.spi.scope.window.ClientWindowConfig.ClientWindowRenderMode

All Implemented Interfaces:

Serializable, Comparable<ClientWindowConfig.ClientWindowRenderMode>

Enclosing interface:

ClientWindowConfig

public static enum ClientWindowConfig.ClientWindowRenderMode
extends Enum<ClientWindowConfig.ClientWindowRenderMode>

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLIENTWINDOW The GET request results in an intermediate small html page which checks if the browser tab fits the selected windowId
CUSTOM If you set this mode, you also need to provide an own ClientWindow implementation.
DELEGATED Delegates to the default window-handling of JSF 2.2+ (if configured)
LAZY Render each GET request with the windowId you get during the request and perform a lazy check on the client side via JavaScript or similar.
NONE Any window or browser tab detection is disabled for this request

Method Summary

Modifier and Type	Method and Description
static ClientWindowConfig.ClientWindowRenderMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static ClientWindowConfig.ClientWindowRenderMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final ClientWindowConfig.ClientWindowRenderMode NONE

Any window or browser tab detection is disabled for this request

CLIENTWINDOW

public static final ClientWindowConfig.ClientWindowRenderMode CLIENTWINDOW

The GET request results in an intermediate small html page which checks if the browser tab fits the selected windowId

The ClientWindow html extracts the windowId from the window.name and enforces a 2nd GET which will contain the windowId and will get routed through to the target JSF page.

LAZY

public static final ClientWindowConfig.ClientWindowRenderMode LAZY

Render each GET request with the windowId you get during the request and perform a lazy check on the client side via JavaScript or similar.

DELEGATED

public static final ClientWindowConfig.ClientWindowRenderMode DELEGATED

Delegates to the default window-handling of JSF 2.2+ (if configured)

CUSTOM

public static final ClientWindowConfig.ClientWindowRenderMode CUSTOM

If you set this mode, you also need to provide an own ClientWindow implementation.

Method Detail

values

public static ClientWindowConfig.ClientWindowRenderMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ClientWindowConfig.ClientWindowRenderMode c : ClientWindowConfig.ClientWindowRenderMode.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ClientWindowConfig.ClientWindowRenderMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null