Package com.vaadin.flow.component.login

Class AbstractLogin

  • All Implemented Interfaces:
    com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, Serializable
    Direct Known Subclasses:
    LoginForm, LoginOverlay
    public abstract class AbstractLogin
extends com.vaadin.flow.component.Component
implements com.vaadin.flow.component.HasEnabled
    Abstract component for the <vaadin-login-overlay> and <vaadin-login-form> components. On AbstractLogin.LoginEvent component becomes disabled. Disabled component stops to process login events, however the AbstractLogin.ForgotPasswordEvent event is processed anyway. To enable use the HasEnabled.setEnabled(boolean) method. Setting error setError(boolean) true makes component automatically enabled for the next login attempt.
    Author:
    Vaadin Ltd
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  AbstractLogin.ForgotPasswordEvent
      `forgot-password` is fired when the user clicks Forgot password button
      static class  AbstractLogin.LoginEvent
      `login` is fired when the user either clicks Submit button or presses an Enter key.

    • Constructor Summary

      Constructors 
      Constructor Description
      AbstractLogin()
      Initializes a new AbstractLogin with a default localization.
      AbstractLogin​(LoginI18n i18n)
      Initializes a new AbstractLogin.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.vaadin.flow.shared.Registration addForgotPasswordListener​(com.vaadin.flow.component.ComponentEventListener<AbstractLogin.ForgotPasswordEvent> listener)
      Adds `forgotPassword` event listener.
      com.vaadin.flow.shared.Registration addLoginListener​(com.vaadin.flow.component.ComponentEventListener<AbstractLogin.LoginEvent> listener)
      Adds `login` event listener
      String getAction()
      Returns the action defined for a login form.
      boolean isError()
      Returns whether the error message is displayed or not
      boolean isForgotPasswordButtonVisible()
      Returns whether the forgot password button is visible or not
      void onEnabledStateChanged​(boolean enabled)  
      void setAction​(String action)
      Sets the path where to send the form-data when a form is submitted.
      void setError​(boolean error)
      Sets whether to show or hide the error message.
      void setForgotPasswordButtonVisible​(boolean forgotPasswordButtonVisible)
      Sets whether to show or hide the forgot password button.
      void setI18n​(LoginI18n i18n)
      Sets the internationalized messages to be used by this instance.

      • Methods inherited from class com.vaadin.flow.component.Component

        addListener, findAncestor, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, scrollIntoView, set, setElement, setId, setVisible

      • Methods inherited from interface com.vaadin.flow.component.AttachNotifier

        addAttachListener

      • Methods inherited from interface com.vaadin.flow.component.DetachNotifier

        addDetachListener

      • Methods inherited from interface com.vaadin.flow.component.HasElement

        getElement

      • Methods inherited from interface com.vaadin.flow.component.HasEnabled

        isEnabled, setEnabled

    • Constructor Detail

      • AbstractLogin

        public AbstractLogin()
        Initializes a new AbstractLogin with a default localization.

      • AbstractLogin

        public AbstractLogin​(LoginI18n i18n)
        Initializes a new AbstractLogin.
        Parameters:
        i18n - internationalized messages to be used by this instance.

    • Method Detail

      • setAction

        public void setAction​(String action)
        Sets the path where to send the form-data when a form is submitted. Once action is defined a AbstractLogin.LoginEvent is not fired anymore.
        See Also:
        getAction()

      • getAction

        @Synchronize(property="action",
             value="action-changed")
public String getAction()
        Returns the action defined for a login form.
        Returns:
        the value of action property

      • setError

        public void setError​(boolean error)
        Sets whether to show or hide the error message. The message can be set via setI18n(LoginI18n) Calling this method with true will also enable the component.
        Parameters:
        error - true to show the error message and enable component for next login attempt, false to hide an error
        See Also:
        isError()

      • isError

        @Synchronize(property="error",
             value="error-changed")
public boolean isError()
        Returns whether the error message is displayed or not
        Returns:
        the value of error property

      • setForgotPasswordButtonVisible

        public void setForgotPasswordButtonVisible​(boolean forgotPasswordButtonVisible)
        Sets whether to show or hide the forgot password button. The button is visible by default
        Parameters:
        forgotPasswordButtonVisible - whether to display or hide the button
        See Also:
        isForgotPasswordButtonVisible()

      • isForgotPasswordButtonVisible

        public boolean isForgotPasswordButtonVisible()
        Returns whether the forgot password button is visible or not
        Returns:
        true if the forgot password button is visible false otherwise

      • setI18n

        public void setI18n​(LoginI18n i18n)
        Sets the internationalized messages to be used by this instance.
        Parameters:
        i18n - the internationalized messages
        See Also:
        LoginI18n.createDefault()

      • addLoginListener

        public com.vaadin.flow.shared.Registration addLoginListener​(com.vaadin.flow.component.ComponentEventListener<AbstractLogin.LoginEvent> listener)
        Adds `login` event listener

      • addForgotPasswordListener

        public com.vaadin.flow.shared.Registration addForgotPasswordListener​(com.vaadin.flow.component.ComponentEventListener<AbstractLogin.ForgotPasswordEvent> listener)
        Adds `forgotPassword` event listener. Event continues being process even if the component is not HasEnabled.isEnabled().

      • onEnabledStateChanged

        public void onEnabledStateChanged​(boolean enabled)
        Overrides:
        onEnabledStateChanged in class com.vaadin.flow.component.Component