We use cookies to serve our customers and website visitors in the best possible way. Cookies are used for the proper functioning of the website and for improving the user experience, monitoring visitor traffic and marketing purposes. By continuing to browse the site, you agree to our use of cookies. You can read more about cookies here.
com.vaadin.flow.component.login.
Class LoginOverlay
- java.lang.Object
-
- com.vaadin.flow.component.Component
-
- com.vaadin.flow.component.login.AbstractLogin
-
- com.vaadin.flow.component.login.LoginOverlay
-
All Implemented Interfaces:
AttachNotifier, DetachNotifier, HasElement, HasEnabled, Serializable
@Tag(value="vaadin-login-overlay") @NpmPackage(value="@vaadin/vaadin-login", version="1.3.0") @JsModule(value="@vaadin/vaadin-login/src/vaadin-login-overlay.js") public class LoginOverlay extends AbstractLoginServer-side component for the
<vaadin-login-overlay>component. OnLoginForm.LoginEventcomponent becomes disabled. Disabled component stops to process login events, however theLoginForm.ForgotPasswordEventevent is processed anyway. To enable use theHasEnabled.setEnabled(boolean)method. Setting errorAbstractLogin.setError(boolean)true makes component automatically enabled for the next login attempt.Author:
Vaadin Ltd
See Also:
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.vaadin.flow.component.login.AbstractLogin
AbstractLogin.ForgotPasswordEvent, AbstractLogin.LoginEvent
-
-
Constructor Summary
Constructors Constructor and Description LoginOverlay()LoginOverlay(LoginI18n i18n)
-
Method Summary
All Methods Modifier and Type Method and Description voidclose()Closes the login overlay.
StringgetDescription()ComponentgetTitle()Returns custom title component which was set via
setTitle(Component)StringgetTitleAsText()Returns the value of the title property or a text content of the title if it was set via
setTitle(Component)booleanisOpened()voidsetDescription(String description)Sets the application description.
voidsetOpened(boolean opened)Opens or closes the login overlay.
voidsetTitle(Component title)Sets the application title,
nullto remove any previous title and to display title set viasetTitle(String).voidsetTitle(String title)Sets the application title.
-
Methods inherited from class com.vaadin.flow.component.login.AbstractLogin
addForgotPasswordListener, addLoginListener, getAction, isError, isForgotPasswordButtonVisible, onEnabledStateChanged, setAction, setError, setForgotPasswordButtonVisible, setI18n
-
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
-
LoginOverlay
public LoginOverlay()
-
LoginOverlay
public LoginOverlay(LoginI18n i18n)
-
-
Method Detail
-
close
public void close()Closes the login overlay.
Note: This method also removes the overlay component from the DOM after closing it, unless you have added the component manually.
-
isOpened
@Synchronize(property="opened", value="opened-changed") public boolean isOpened()
-
setOpened
public void setOpened(boolean opened)Opens or closes the login overlay. On open component becomes enabled
HasEnabled.setEnabled(boolean)Note: Overlay will be attached or detached from the DOM automatically, if it was not added manually.
Parameters:
opened-trueto open the login overlay,falseto close it
-
setTitle
public void setTitle(String title)Sets the application title. Detaches the component title if it was set earlier. Note: the method calls
setTitle(Component), which will reset the custom title, if it was set. Custom title can be reset only when the overlay is closed. Title is a part of the I18n object. SeeAbstractLogin.setI18n(LoginI18n).See Also:
-
getTitleAsText
@Synchronize(property="title", value="title-changed") public String getTitleAsText()Returns the value of the title property or a text content of the title if it was set via
setTitle(Component)Returns:
the string value of title
-
setTitle
public void setTitle(Component title)Sets the application title,
nullto remove any previous title and to display title set viasetTitle(String). Note: the title component has to be set when the overlay is closed.Parameters:
title- the title component to set, ornullto remove any previously set titleSee Also:
-
getTitle
public Component getTitle()Returns custom title component which was set via
setTitle(Component)Returns:
the title component,
nullif nothing was set
-
setDescription
public void setDescription(String description)Sets the application description. Description is a part of I18n object. See
AbstractLogin.setI18n(LoginI18n).Parameters:
description- the description stringSee Also:
-
getDescription
@Synchronize(property="description", value="description-changed") public String getDescription()Returns:
the value of description property
-
-