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

Interface DialogBuilder<B extends DialogBuilder<B>>

Type Parameters:
B - the Builder type
All Known Subinterfaces:
ActionDialogBuilder<B>, CalendarDialogBuilder, ComboBoxSelectionDialogBuilder<T>, ComponentDialogBuilder, EntityDialogs.AddEntityDialogBuilder, EntityDialogs.EditAttributeDialogBuilder<T>, EntityDialogs.EditEntityDialogBuilder, EntityDialogs.EntitySelectionDialogBuilder, ExceptionDialogBuilder, FileSelectionDialogBuilder, InputDialogBuilder<T>, ListSelectionDialogBuilder<T>, LoginDialogBuilder, OkCancelDialogBuilder, ProgressDialog.Builder, ProgressWorkerDialogBuilder<T,V>, SelectionDialogBuilder<T,B>
All Known Implementing Classes:
AbstractDialogBuilder
public interface DialogBuilder<B extends DialogBuilder<B>>
A base interface for JDialog builders

  • Method Details

    • owner

      B owner(@Nullable Window owner)
      Sets the dialog owner as the given window. Also sets the locationRelativeTo(Component) to the given window in case one has not been specified.
      Parameters:
      owner - the dialog owner
      Returns:
      this DialogBuilder instance

    • owner

      B owner(@Nullable Component owner)
      Sets the dialog owner as the parent window of the given component. Also sets the locationRelativeTo(Component) using the given component in case one has not been specified.
      Parameters:
      owner - the dialog parent component
      Returns:
      this builder instance

    • locationRelativeTo

      B locationRelativeTo(@Nullable Component component)
      Parameters:
      component - the component for the relative location
      Returns:
      this builder instance

    • location

      B location(@Nullable Point location)
      Overrides locationRelativeTo(Component).
      Parameters:
      location - the location of the dialog
      Returns:
      this builder instance

    • title

      B title(@Nullable String title)
      Parameters:
      title - the dialog title
      Returns:
      this builder instance

    • title

      B title(@Nullable Observable<String> title)
      Parameters:
      title - an observable for a dynamic dialog title
      Returns:
      this builder instance

    • icon

      B icon(@Nullable ImageIcon icon)
      Parameters:
      icon - the dialog icon
      Returns:
      this builder instance

    • keyEvent

      B keyEvent(KeyEvents.Builder keyEventBuilder)
      Enables the key event defined by the given KeyEvents.Builder on the dialog root pane.
      Parameters:
      keyEventBuilder - a key event builder to enable on the dialog root pane
      Returns:
      this builder instance

    • onBuild

      B onBuild(Consumer<JDialog> onBuild)
      Parameters:
      onBuild - called when the dialog has been built, before it is shown
      Returns:
      this builder instance