com.vaadin.ui
Enum LoginForm.LoginMode

java.lang.Object
  java.lang.Enum<LoginForm.LoginMode>
      com.vaadin.ui.LoginForm.LoginMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<LoginForm.LoginMode>

Enclosing class:

LoginForm

public static enum LoginForm.LoginMode
extends java.lang.Enum<LoginForm.LoginMode>

Determines the way in which the login form reacts to a login on the server side. The login mode is set by calling LoginForm.setLoginMode(LoginMode).

Enum Constant Summary

DEFERRED
Deferred mode means that LoginForm#login(String, String) will be called after the dummy form submission that triggers the password manager has completed.

DIRECT
Direct mode means that LoginForm#login(String, String) will be called as soon as the user clicks on the login button or presses the enter key in the user name or password text fields.

Method Summary

static LoginForm.LoginMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static LoginForm.LoginMode[]	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

DIRECT

public static final LoginForm.LoginMode DIRECT

Direct mode means that LoginForm#login(String, String) will be called as soon as the user clicks on the login button or presses the enter key in the user name or password text fields. In direct mode, you cannot change the URL in the LoginForm#login(String, String) method, otherwise the password manager will not be triggered.

This is the default mode for a new login form instance.

DEFERRED

public static final LoginForm.LoginMode DEFERRED

Deferred mode means that LoginForm#login(String, String) will be called after the dummy form submission that triggers the password manager has completed. In deferred mode, it is possible to change the URL in the LoginForm#login(String, String) method. The drawbacks with resepect to deferred mode are the following:

• There will be a slight UI lag between the user action and the UI change
• Any UI change resulting from the login is not a direct consequence of the user input. If you use Vaadin TestBench, you have to add your own code to wait for any UI changes.

Method Detail

values

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

Returns:

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

valueOf

public static LoginForm.LoginMode valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null