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.

  • Field Details

    • INPUT_FIELD_COLUMNS

      static final PropertyValue<Integer> INPUT_FIELD_COLUMNS

      Specifies the default input field columns for the username and password fields.

      Note that this only affects the minimum field size, the actual field sizes may be larger than the specified columns value dictates due to other login panel size constraints.

      • Value type: Integer
      • Default value: 8
      See Also:

    • RESIZABLE

      static final PropertyValue<Boolean> RESIZABLE

      Specifies whether login dialogs are resizable by default.

      When resizable, the dialog can not be made smaller than its packed size.

      • Value type: Boolean
      • Default value: true
      See Also:

  • Method Details

    • defaultUser

      LoginDialogBuilder defaultUser(@Nullable User defaultUser)
      Parameters:
      defaultUser - the default user credentials to display
      Returns:
      this builder instance

    • validator

      LoginDialogBuilder validator(LoginDialogBuilder.LoginValidator validator)
      Parameters:
      validator - the login validator to use
      Returns:
      this builder instance

    • southComponent

      LoginDialogBuilder southComponent(@Nullable JComponent southComponent)
      Parameters:
      southComponent - a component to add to the south of the credentials input fields
      Returns:
      this builder instance

    • inputFieldColumns

      LoginDialogBuilder inputFieldColumns(int inputFieldColumns)

      Note that this only affects the minimum field size, the actual field sizes may be larger than the specified columns value dictates due to other login panel size constraints.

      Parameters:
      inputFieldColumns - the number of columns to display in the input fields (username/password)
      Returns:
      this builder instance
      See Also:

    • resizable

      LoginDialogBuilder resizable(boolean resizable)
      When resizable, the dialog can not be made smaller than its packed size.
      Parameters:
      resizable - specifies whether the login dialog is resizable
      Returns:
      this builder instance
      See Also:

    • show

      User show()
      Returns:
      the logged-in user
      Throws:
      CancelException - in case the login is cancelled