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

Interface EntitySearchInput.Builder

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

  • Method Details

    • includeSearchButton

      EntitySearchInput.Builder includeSearchButton(boolean includeSearchButton)
      Parameters:
      includeSearchButton - true if a search button should be included
      Returns:
      this builder instance

    • includeAddButton

      EntitySearchInput.Builder includeAddButton(boolean includeAddButton)
      Parameters:
      includeAddButton - true if an 'Add' button should be included
      Returns:
      this builder instance

    • includeEditButton

      EntitySearchInput.Builder includeEditButton(boolean includeEditButton)
      Parameters:
      includeEditButton - true if an 'Edit' button should be included
      Returns:
      this builder instance

    • confirmAdd

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

    • confirmEdit

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

    • buttonsFocusable

      EntitySearchInput.Builder buttonsFocusable(boolean buttonsFocusable)
      Default false
      Parameters:
      buttonsFocusable - true if the buttons should be focusable
      Returns:
      this builder instance

    • buttonLocation

      EntitySearchInput.Builder buttonLocation(String buttonLocation)
      Must be one of BorderLayout.WEST or BorderLayout.EAST
      Parameters:
      buttonLocation - the button location
      Returns:
      this builder instance
      Throws:
      IllegalArgumentException - in case the value is not one of BorderLayout.WEST or BorderLayout.EAST

    • preferredSearchFieldWidth

      EntitySearchInput.Builder preferredSearchFieldWidth(int preferredSearchFieldWidth)
      Parameters:
      preferredSearchFieldWidth - the preferred search field width
      Returns:
      this builder instance

    • columns

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

    • upperCase

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

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

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

    • searchHintEnabled

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

    • searchOnFocusLost

      EntitySearchInput.Builder searchOnFocusLost(boolean searchOnFocusLost)
      Parameters:
      searchOnFocusLost - true if search should be performed on focus lost
      Returns:
      this builder instance

    • searchIndicator

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

    • selector

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

    • limit

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

    • build

      EntitySearchInput build()
      Description copied from interface: ComponentBuilder
      Builds a new component instance.
      Specified by:
      build in interface ComponentBuilder<EntitySearchInput,EntitySearchInput.Builder>
      Returns:
      a new EntitySearchInput based on this builder