Module is.codion.swing.framework.ui
Package is.codion.swing.framework.ui.component

Interface EntitySearchField.Builder

All Superinterfaces:
ComponentBuilder<EntitySearchField,EntitySearchField.Builder>, ComponentValueBuilder<EntitySearchField,Entity,EntitySearchField.Builder>, Supplier<EntitySearchField>
Enclosing class:
EntitySearchField
public static interface EntitySearchField.Builder extends ComponentValueBuilder<EntitySearchField,Entity,EntitySearchField.Builder>
Builds an entity search field.

  • Method Details

    • columns

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

    • upperCase

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

    • lowerCase

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

    • editable

      EntitySearchField.Builder editable(boolean editable)
      Parameters:
      editable - false if the field should not be editable
      Returns:
      this builder instance

    • formatter

      EntitySearchField.Builder formatter(Function<Entity,String> formatter)
      Overrides the default formatter for search elements when displayed in a field based on this field
      Parameters:
      formatter - the formatter
      Returns:
      this builder

    • searchHintEnabled

      EntitySearchField.Builder searchHintEnabled(boolean searchHintEnabled)
      Parameters:
      searchHintEnabled - true if a search hint text should be visible when the field is empty and not focused
      Returns:
      this builder instance

    • selectionToolTip

      EntitySearchField.Builder selectionToolTip(boolean selectionToolTip)
      Specifies whether the selected entity should be available in a tool tip, for a field too narrow to display it in full. Default false.
      Parameters:
      selectionToolTip - true if the selected entity should be available in a tool tip
      Returns:
      this builder instance

    • searchOnFocusLost

      EntitySearchField.Builder searchOnFocusLost(boolean searchOnFocusLost)

      Specifies whether a search should be performed when the field loses focus.

      Note that the focus lost search only selects an item in case of a single result, multiple results are ignored in order to not display a result selection dialog during focus traversal.

      Default true.

      Parameters:
      searchOnFocusLost - true if search should be performed on focus lost
      Returns:
      this builder instance

    • searchIndicator

      EntitySearchField.Builder searchIndicator(EntitySearchField.SearchIndicator searchIndicator)
      Parameters:
      searchIndicator - the search indicator
      Returns:
      this builder instance

    • searchProgressBarDelay

      EntitySearchField.Builder searchProgressBarDelay(int searchProgressBarDelay)
      Parameters:
      searchProgressBarDelay - the number of milliseconds to delay showing the search progress bar, if enabled
      Returns:
      this builder instance
      See Also:

    • selector

      EntitySearchField.Builder selector(Function<EntitySearchField,EntitySearchField.Selector> selector)
      Parameters:
      selector - the selector factory to use
      Returns:
      this builder instance

    • editPanel

      EntitySearchField.Builder editPanel(Supplier<EntityEditPanel> editPanel)
      An edit panel is required for the add and edit controls.
      Parameters:
      editPanel - the edit panel supplier
      Returns:
      this builder instance

    • keyStroke

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

    • limit

      EntitySearchField.Builder limit(int limit)
      Parameters:
      limit - the search result limit
      Returns:
      this builder instance

    • confirmAdd

      EntitySearchField.Builder confirmAdd(boolean confirmAdd)
      Parameters:
      confirmAdd - true if adding an item should be confirmed
      Returns:
      this builder instance
      See Also:

    • confirmEdit

      EntitySearchField.Builder confirmEdit(boolean confirmEdit)
      Parameters:
      confirmEdit - true if editing an item should be confirmed
      Returns:
      this builder instance
      See Also: