Class LoginForm

Constructor Detail

• LoginForm

  public LoginForm()

Method Detail

• createUsernameField

  protected TextField createUsernameField()

  Customize the user name field. Only for overriding, do not call.

  Returns:

  the user name field

  Since:

  7.7

• getUsernameCaption

  public String getUsernameCaption()

  Gets the caption set with setUsernameCaption(String). Note that this method might not match what is shown to the user if createUsernameField() has been overridden.

  Returns:

  the user name field caption

• setUsernameCaption

  public void setUsernameCaption​(String usernameCaption)

  Sets the caption of the user name field. Note that the caption can only be set with this method before the login form has been initialized (attached).

  As an alternative to calling this method, the method createUsernameField() can be overridden.

  Parameters:

  usernameCaption - the caption to set for the user name field

• createPasswordField

  protected PasswordField createPasswordField()

  Customize the password field. Only for overriding, do not call.

  Returns:

  the password field

  Since:

  7.7

• getPasswordCaption

  public String getPasswordCaption()

  Gets the caption set with setPasswordCaption(String). Note that this method might not match what is shown to the user if createPasswordField() has been overridden.

  Returns:

  the password field caption

• setPasswordCaption

  public void setPasswordCaption​(String passwordCaption)

  Set the caption of the password field. Note that the caption can only be set with this method before the login form has been initialized (attached).

  As an alternative to calling this method, the method createPasswordField() can be overridden.

  Parameters:

  passwordCaption - the caption for the password field

• createLoginButton

  protected Button createLoginButton()

  Customize the login button. Only for overriding, do not call.

  Returns:

  the login button

  Since:

  7.7

• getLoginButtonCaption

  public String getLoginButtonCaption()

  Gets the caption set with setLoginButtonCaption(String). Note that this method might not match what is shown to the user if createLoginButton() has been overridden.

  Returns:

  the login button caption

• setLoginButtonCaption

  public void setLoginButtonCaption​(String loginButtonCaption)

  Sets the caption of the login button. Note that the caption can only be set with this method before the login form has been initialized (attached).

  As an alternative to calling this method, the method createLoginButton() can be overridden.

  Parameters:

  loginButtonCaption - new caption

• getState

  protected LoginFormState getState()

  Description copied from class: AbstractComponent

  Returns the shared state bean with information to be sent from the server to the client. Subclasses should override this method and set any relevant fields of the state returned by super.getState().

  Overrides:

  getState in class AbstractSingleComponentContainer

  Returns:

  updated component shared state

• getState

  protected LoginFormState getState​(boolean markAsDirty)

  Description copied from class: AbstractClientConnector

  Returns the shared state for this connector.

  Overrides:

  getState in class AbstractSingleComponentContainer

  Parameters:

  markAsDirty - true if the connector should automatically be marked dirty, false otherwise

  Returns:

  The shared state for this connector. Never null.

  See Also:

  AbstractClientConnector.getState()

• attach

  public void attach()

  Description copied from interface: ClientConnector

  Notifies the connector that it is connected to a VaadinSession (and therefore also to a UI).

  The caller of this method is Component.setParent(HasComponents) if the parent is itself already attached to the session. If not, the parent will call the ClientConnector.attach() for all its children when it is attached to the session. This method is always called before the connector's data is sent to the client-side for the first time.

  The attachment logic is implemented in AbstractClientConnector.

  Specified by:

  attach in interface ClientConnector

  Specified by:

  attach in interface Component

  Overrides:

  attach in class AbstractComponent

• createContent

  protected Component createContent​(TextField userNameField,
                                    PasswordField passwordField,
                                    Button loginButton)

  Create the content for the login form with the supplied user name field, password field and the login button. You cannot use any other text fields or buttons for this purpose. To replace these components with your own implementations, override createUsernameField(), createPasswordField() and createLoginButton(). If you only want to change the default captions, override getUsernameCaption(), getPasswordCaption() and getLoginButtonCaption(). You do not have to use the login button in your layout.

  Parameters:

  userNameField - the user name text field

  passwordField - the password field

  loginButton - the login button

  Returns:

  content component

  Since:

  7.7

• addLoginListener

  public Registration addLoginListener​(LoginForm.LoginListener listener)

  Adds a LoginForm.LoginListener.

  The listener is called when the user presses the login button.

  Parameters:

  listener - the listener to add

  Returns:

  a registration object for removing the listener

  Since:

  8.0

• removeLoginListener

  @Deprecated
  public void removeLoginListener​(LoginForm.LoginListener listener)

  Deprecated.

  As of 8.0, replaced by Registration.remove() in the registration object returned from addLoginListener(LoginListener).

  Removes a LoginForm.LoginListener.

  Parameters:

  listener - the listener to remove