Module is.codion.swing.common.ui
Package is.codion.swing.common.ui.dialog

Interface InputDialogBuilder<T>

All Superinterfaces:
DialogBuilder<InputDialogBuilder<T>>
public interface InputDialogBuilder<T> extends DialogBuilder<InputDialogBuilder<T>>
Displays the component from a given component value in a dialog and returns the value if the user accepts the input.

  • Method Details

    • caption

      InputDialogBuilder<T> caption(@Nullable String caption)
      Parameters:
      caption - the label caption
      Returns:
      this builder instance

    • valid

      InputDialogBuilder<T> valid(ObservableState valid)
      A ObservableState indicating whether the input is valid, this state controls the enabled state of the OK button. Overrides any previously set validator(Predicate).
      Parameters:
      valid - an ObservableState indicating whether the input value is valid
      Returns:
      this builder instance

    • validator

      InputDialogBuilder<T> validator(Predicate<@Nullable T> validator)
      Sets the valid(ObservableState) according to the given predicate. Overrides any previously set valid(ObservableState).
      Parameters:
      validator - the valididator predicate
      Returns:
      this builder instance

    • close

      InputDialogBuilder<T> close(Predicate<@Nullable T> close)
      Specify a Predicate used to determine if the dialog should be closed when a input value has been accepted. Called with the current value each time the input is accepted.
      Parameters:
      close - called with the current input to determine if the dialog should be closed when accepting input
      Returns:
      this builder instance

    • show

      T show()
      Shows the input dialog and returns the value if the user presses OK
      Returns:
      the value from the component value if the user accepts the input
      Throws:
      CancelException - in case the user cancels