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

Interface TextInput.Builder

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

  • Method Details

    • updateOn

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

    • columns

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

    • upperCase

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

    • lowerCase

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

    • selectAllOnFocusGained

      TextInput.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

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

    • caption

      TextInput.Builder caption(@Nullable 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

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

    • buttonFocusable

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

    • buttonIcon

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

    • maximumLength

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

    • keyStroke

      TextInput.Builder keyStroke(ControlKey<?> controlKey, KeyStroke keyStroke)
      Parameters:
      controlKey - the control key
      keyStroke - the keyStroke to assign to the given control
      Returns:
      this builder instance