Package com.vaadin.flow.dom

Enum DisabledUpdateMode

java.lang.Object

java.lang.Enum<DisabledUpdateMode>

com.vaadin.flow.dom.DisabledUpdateMode

All Implemented Interfaces:

Serializable, Comparable<DisabledUpdateMode>

public enum DisabledUpdateMode
extends Enum<DisabledUpdateMode>

Controls RPC communication from the client side to the server side respecting enabled state.

Since:

1.0

Author:

Vaadin Ltd

See Also:

Element.setEnabled(boolean), Element.isEnabled(), HasEnabled.setEnabled(boolean), HasEnabled.isEnabled()

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALWAYS	If used then updates from the client side are allowed even for disabled element.
ONLY_WHEN_ENABLED	If used then updates from the client side are allowed only if element is enabled.

Method Summary

Modifier and Type	Method	Description
static DisabledUpdateMode	mostPermissive(DisabledUpdateMode mode1, DisabledUpdateMode mode2)	Gets the most permissive out of two update modes.
static DisabledUpdateMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static DisabledUpdateMode[]	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

ALWAYS

public static final DisabledUpdateMode ALWAYS

If used then updates from the client side are allowed even for disabled element.

ONLY_WHEN_ENABLED

public static final DisabledUpdateMode ONLY_WHEN_ENABLED

If used then updates from the client side are allowed only if element is enabled.

Method Detail

values

public static DisabledUpdateMode[] 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 (DisabledUpdateMode c : DisabledUpdateMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static DisabledUpdateMode 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

mostPermissive

public static DisabledUpdateMode mostPermissive(DisabledUpdateMode mode1,
                                                DisabledUpdateMode mode2)

Gets the most permissive out of two update modes.

Parameters:

mode1 - the first mode, or null

mode2 - the second mode, or null

Returns:

the most permissive mode, or null if both parameters are null