Module is.codion.swing.common.ui

Package is.codion.swing.common.ui.dialog

Interface LoginDialogBuilder

All Superinterfaces:

DialogBuilder<LoginDialogBuilder>

public interface LoginDialogBuilder
extends DialogBuilder<LoginDialogBuilder>

A login dialog builder.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	LoginDialogBuilder.LoginValidator	Validates a login attempt.

Method Summary

Modifier and Type	Method	Description
LoginDialogBuilder	defaultUser(User defaultUser)
LoginDialogBuilder	inputFieldColumns(int inputFieldColumns)
User	show()
LoginDialogBuilder	southComponent(JComponent southComponent)
LoginDialogBuilder	validator(LoginDialogBuilder.LoginValidator validator)

Methods inherited from interface is.codion.swing.common.ui.dialog.DialogBuilder

icon, keyEvent, location, locationRelativeTo, onBuild, owner, owner, title, title

Method Details

defaultUser

LoginDialogBuilder defaultUser(User defaultUser)

Parameters:

defaultUser - the default user credentials to display

Returns:

this LoginDialogBuilder instance

validator

LoginDialogBuilder validator(LoginDialogBuilder.LoginValidator validator)

Parameters:

validator - the login validator to use

Returns:

this LoginDialogBuilder instance

southComponent

LoginDialogBuilder southComponent(JComponent southComponent)

Parameters:

southComponent - a component to add to the south of the credentials input fields

Returns:

this LoginDialogBuilder instance

inputFieldColumns

LoginDialogBuilder inputFieldColumns(int inputFieldColumns)

Parameters:

inputFieldColumns - the number of columns to display in the input fields (username/password), 8 by default

Returns:

this LoginDialogBuilder instance

show

User show()

Returns:

the logged-in user

Throws:

CancelException - in case the login is cancelled