com.vaadin.ui
Class LoginForm

java.lang.Object
  com.vaadin.server.AbstractClientConnector
      com.vaadin.ui.AbstractComponent
          com.vaadin.ui.AbstractComponentContainer
              com.vaadin.ui.CustomComponent
                  com.vaadin.ui.LoginForm

All Implemented Interfaces:

MethodEventSource, ClientConnector, RpcTarget, Sizeable, com.vaadin.shared.Connector, Component, ComponentContainer, HasComponents, java.io.Serializable, java.lang.Iterable<Component>

Deprecated. as of Vaadin 7.0. This component no longer fulfills its duty reliably in the supported browsers and a VerticalLayout with two TextFields can be used instead.

@Deprecated
public class LoginForm
extends CustomComponent

LoginForm is a Vaadin component to handle common problem among Ajax applications: browsers password managers don't fill dynamically created forms like all those UI elements created by Vaadin.

For developer it is easy to use: add component to a desired place in you UI and add LoginListener to validate form input. Behind the curtain LoginForm creates an iframe with static html that browsers detect.

Login form is by default 100% width and height, so consider using it inside a sized Panel or Window.

Login page html can be overridden by replacing protected getLoginHTML method. As the login page is actually an iframe, styles must be handled manually. By default component tries to guess the right place for theme css.

Since:

5.3

See Also:

Serialized Form

Nested Class Summary

static class	LoginForm.LoginEvent Deprecated. This event is sent when login form is submitted.
static interface	LoginForm.LoginListener Deprecated. Login listener is a class capable to listen LoginEvents sent from LoginBox

Nested classes/interfaces inherited from class com.vaadin.ui.AbstractComponent

AbstractComponent.ComponentErrorEvent, AbstractComponent.ComponentErrorHandler

Nested classes/interfaces inherited from interface com.vaadin.ui.ComponentContainer

ComponentContainer.ComponentAttachEvent, ComponentContainer.ComponentAttachListener, ComponentContainer.ComponentDetachEvent, ComponentContainer.ComponentDetachListener

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

Component.ErrorEvent, Component.ErrorListener, Component.Event, Component.Focusable, Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

Sizeable.Unit

Field Summary

Fields inherited from interface com.vaadin.server.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Constructor Summary

LoginForm()
Deprecated.

Method Summary

void	addListener(LoginForm.LoginListener listener) Deprecated. Since 7.0, replaced by addLoginListener(LoginListener)
void	addLoginListener(LoginForm.LoginListener listener) Deprecated. Adds LoginListener to handle login logic
void	attach() Deprecated. Notifies the connector that it is connected to an application.
void	detach() Deprecated. Notifies the component that it is detached from the application.
java.lang.String	getLoginButtonCaption() Deprecated. Returns the caption for the login button.
protected byte[]	getLoginHTML() Deprecated. Returns byte array containing login page html.
java.lang.String	getPasswordCaption() Deprecated. Returns the caption for the password field.
java.lang.String	getUsernameCaption() Deprecated. Returns the caption for the user name field.
void	removeListener(LoginForm.LoginListener listener) Deprecated. Since 7.0, replaced by removeLoginListener(LoginListener)
void	removeLoginListener(LoginForm.LoginListener listener) Deprecated. Removes LoginListener
void	setHeight(float height, Sizeable.Unit unit) Deprecated. Sets the height of the object.
void	setLoginButtonCaption(java.lang.String loginButtonCaption) Deprecated. Sets the caption (button text) to show for the login button.
void	setPasswordCaption(java.lang.String passwordCaption) Deprecated. Sets the caption to show for the password field.
void	setUsernameCaption(java.lang.String usernameCaption) Deprecated. Sets the caption to show for the user name field.
void	setWidth(float width, Sizeable.Unit unit) Deprecated. Sets the width of the object.

Methods inherited from class com.vaadin.ui.CustomComponent

addComponent, getComponentCount, getComponentIterator, getCompositionRoot, moveComponentsFrom, removeAllComponents, removeComponent, replaceComponent, setCompositionRoot

Methods inherited from class com.vaadin.ui.AbstractComponentContainer

addComponentAttachListener, addComponentDetachListener, addListener, addListener, fireComponentAttachEvent, fireComponentDetachEvent, isComponentVisible, iterator, removeComponentAttachListener, removeComponentDetachListener, removeListener, removeListener, setVisible

Methods inherited from class com.vaadin.ui.AbstractComponent

addListener, addListener, addListener, addListener, addShortcutListener, addStyleName, beforeClientResponse, findAncestor, fireComponentErrorEvent, fireComponentEvent, fireEvent, focus, getActionManager, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorHandler, getErrorMessage, getHeight, getHeightUnits, getIcon, getId, getListeners, getLocale, getParent, getState, getStyleName, getWidth, getWidthUnits, handleError, hasListeners, isConnectorEnabled, isEnabled, isImmediate, isReadOnly, isVisible, removeListener, removeListener, removeListener, removeListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setComponentError, setData, setDebugId, setDescription, setEnabled, setErrorHandler, setHeight, setIcon, setId, setImmediate, setLocale, setParent, setReadOnly, setSizeFull, setSizeUndefined, setStyleName, setWidth

Methods inherited from class com.vaadin.server.AbstractClientConnector

addExtension, addMethodInvocationToQueue, createState, encodeState, getAllChildrenIterable, getConnectorId, getExtensions, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setResource

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, getCaption, getIcon, getId, getLocale, getParent, getStyleName, getUI, isEnabled, isReadOnly, isVisible, removeListener, removeStyleName, setCaption, setEnabled, setIcon, setId, setReadOnly, setStyleName

Methods inherited from interface com.vaadin.server.ClientConnector

beforeClientResponse, encodeState, getExtensions, getStateType, handleConnectorRequest, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setParent

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.server.RpcTarget

getRpcManager

Methods inherited from interface com.vaadin.server.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setSizeFull, setSizeUndefined, setWidth

Constructor Detail

LoginForm

public LoginForm()

Deprecated.

Method Detail

getLoginHTML

protected byte[] getLoginHTML()

Deprecated.

Returns byte array containing login page html. If you need to override the login html, use the default html as basis. Login page sets its target with javascript.

Returns:

byte array containing login page html

attach

public void attach()

Deprecated.

Description copied from interface: ClientConnector

Notifies the connector that it is connected to an application.

The caller of this method is ClientConnector.setParent(ClientConnector) if the parent is itself already attached to the application. If not, the parent will call the ClientConnector.attach() for all its children when it is attached to the application. 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

detach

public void detach()

Deprecated.

Description copied from class: AbstractClientConnector

Notifies the component that it is detached from the application.

The caller of this method is ClientConnector.setParent(ClientConnector) if the parent is in the application. When the parent is detached from the application it is its response to call ClientConnector.detach() for all the children and to detach itself from the terminal.

The AbstractClientConnector.getSession() and AbstractClientConnector.getUI() methods might return null after this method is called.

Specified by:

detach in interface ClientConnector

Overrides:

detach in class AbstractComponent

addLoginListener

public void addLoginListener(LoginForm.LoginListener listener)

Deprecated.

Adds LoginListener to handle login logic

Parameters:

listener -

addListener

@Deprecated
public void addListener(LoginForm.LoginListener listener)

Deprecated. Since 7.0, replaced by addLoginListener(LoginListener)

removeLoginListener

public void removeLoginListener(LoginForm.LoginListener listener)

Deprecated.

Removes LoginListener

Parameters:

listener -

removeListener

@Deprecated
public void removeListener(LoginForm.LoginListener listener)

Deprecated. Since 7.0, replaced by removeLoginListener(LoginListener)

setWidth

public void setWidth(float width,
                     Sizeable.Unit unit)

Deprecated.

Description copied from interface: Sizeable

Sets the width of the object. Negative number implies unspecified size (terminal is free to set the size).

Specified by:

setWidth in interface Sizeable

Overrides:

setWidth in class AbstractComponentContainer

Parameters:

width - the width of the object.

unit - the unit used for the width.

setHeight

public void setHeight(float height,
                      Sizeable.Unit unit)

Deprecated.

Description copied from interface: Sizeable

Sets the height of the object. Negative number implies unspecified size (terminal is free to set the size).

Specified by:

setHeight in interface Sizeable

Overrides:

setHeight in class AbstractComponentContainer

Parameters:

height - the height of the object.

unit - the unit used for the width.

getUsernameCaption

public java.lang.String getUsernameCaption()

Deprecated.

Returns the caption for the user name field.

Returns:

String

setUsernameCaption

public void setUsernameCaption(java.lang.String usernameCaption)

Deprecated.

Sets the caption to show for the user name field. The caption cannot be changed after the form has been shown to the user.

Parameters:

usernameCaption -

getPasswordCaption

public java.lang.String getPasswordCaption()

Deprecated.

Returns the caption for the password field.

Returns:

String

setPasswordCaption

public void setPasswordCaption(java.lang.String passwordCaption)

Deprecated.

Sets the caption to show for the password field. The caption cannot be changed after the form has been shown to the user.

Parameters:

passwordCaption -

getLoginButtonCaption

public java.lang.String getLoginButtonCaption()

Deprecated.

Returns the caption for the login button.

Returns:

String

setLoginButtonCaption

public void setLoginButtonCaption(java.lang.String loginButtonCaption)

Deprecated.

Sets the caption (button text) to show for the login button. The caption cannot be changed after the form has been shown to the user.

Parameters:

loginButtonCaption -