com.vaadin.flow.component.login

Class AbstractLogin

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.login.AbstractLogin

All Implemented Interfaces:

AttachNotifier, DetachNotifier, HasElement, HasEnabled, Serializable

Direct Known Subclasses:

LoginForm, LoginOverlay

public abstract class AbstractLogin
extends Component
implements HasEnabled

Abstract component for the <vaadin-login-overlay> and <vaadin-login-form> components. On LoginForm.LoginEvent component becomes disabled. Disabled component stops to process login events, however the LoginForm.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 and 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 and Description
AbstractLogin() Initializes a new AbstractLogin with a default localization.
AbstractLogin(LoginI18n i18n) Initializes a new AbstractLogin.

Method Summary

Modifier and Type	Method and Description
Registration	addForgotPasswordListener(ComponentEventListener<AbstractLogin.ForgotPasswordEvent> listener) Adds `forgotPassword` event listener.
Registration	addLoginListener(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) Handle component enable state when the enabled state changes.
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.
void	setUnsafeAction(String action) Sets the action URL without validating its scheme.

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

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

isEnabled, setEnabled

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

getElement

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

addAttachListener

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

addDetachListener

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.

Throws:

IllegalArgumentException - if action uses a scheme that is not considered safe according to DeploymentConfiguration.getUrlSafeSchemes(); see setUnsafeAction(String) and the configuration property

See Also:

getAction(), setUnsafeAction(String)

setUnsafeAction

public void setUnsafeAction(String action)

Sets the action URL without validating its scheme.

Unlike setAction(String), this method does not reject URLs based on the configuration. Use it only for URLs that are fully under your control and known to be safe, such as a hard-coded javascript: URL. Passing untrusted input here can expose the application to cross-site scripting (XSS) attacks.

Parameters:

action - the action URL

See Also:

setAction(String)

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 Registration addLoginListener(ComponentEventListener<AbstractLogin.LoginEvent> listener)

Adds `login` event listener

addForgotPasswordListener

public Registration addForgotPasswordListener(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)

Description copied from class: Component

Handle component enable state when the enabled state changes.

By default this sets or removes the 'disabled' attribute from the element. This can be overridden to have custom handling.

Overrides:

onEnabledStateChanged in class Component

Parameters:

enabled - the new enabled state of the component