Module is.codion.swing.common.ui
Package is.codion.swing.common.ui.component.text

Interface TextFieldPanel.Builder

All Superinterfaces:
ComponentBuilder<String,TextFieldPanel,TextFieldPanel.Builder>
Enclosing class:
TextFieldPanel
public static interface TextFieldPanel.Builder extends ComponentBuilder<String,TextFieldPanel,TextFieldPanel.Builder>
A builder for TextFieldPanel.

  • Method Details

    • updateOn

      TextFieldPanel.Builder updateOn(UpdateOn updateOn)
      Parameters:
      updateOn - specifies when the underlying value should be updated
      Returns:
      this builder instance

    • columns

      TextFieldPanel.Builder columns(int columns)
      Parameters:
      columns - the number of colums in the text field
      Returns:
      this builder instance

    • upperCase

      TextFieldPanel.Builder upperCase(boolean upperCase)
      Parameters:
      upperCase - if true the text component convert all lower case input to upper case
      Returns:
      this builder instance

    • lowerCase

      TextFieldPanel.Builder lowerCase(boolean lowerCase)
      Parameters:
      lowerCase - if true the text component convert all upper case input to lower case
      Returns:
      this builder instance

    • selectAllOnFocusGained

      TextFieldPanel.Builder selectAllOnFocusGained(boolean selectAllOnFocusGained)
      Makes the text field select all when it gains focus
      Parameters:
      selectAllOnFocusGained - if true the component will select contents on focus gained
      Returns:
      this builder instance

    • dialogTitle

      TextFieldPanel.Builder dialogTitle(String dialogTitle)
      Parameters:
      dialogTitle - the input dialog title
      Returns:
      this builder instance

    • caption

      TextFieldPanel.Builder caption(String caption)
      If specified a titled border with the given caption is added to the input field
      Parameters:
      caption - the caption to display
      Returns:
      this builder instance

    • textAreaSize

      TextFieldPanel.Builder textAreaSize(Dimension textAreaSize)
      Parameters:
      textAreaSize - the input text area siz
      Returns:
      this builder instance

    • buttonFocusable

      TextFieldPanel.Builder buttonFocusable(boolean buttonFocusable)
      Default false.
      Parameters:
      buttonFocusable - true if the input button should be focusable
      Returns:
      this builder instance

    • buttonIcon

      TextFieldPanel.Builder buttonIcon(ImageIcon buttonIcon)
      Parameters:
      buttonIcon - the button icon
      Returns:
      this builder instance

    • maximumLength

      TextFieldPanel.Builder maximumLength(int maximumLength)
      Parameters:
      maximumLength - the maximum text length
      Returns:
      this builder instance

    • keyStroke

      TextFieldPanel.Builder keyStroke(TextFieldPanel.KeyboardShortcut keyboardShortcut, KeyStroke keyStroke)
      Parameters:
      keyboardShortcut - the keyboard shortcut key
      keyStroke - the keyStroke to assign to the given shortcut key, null resets to the default one
      Returns:
      this builder instance