Package io.jmix.ui

Interface Dialogs.BackgroundWorkDialogBuilder<T extends Number,V>

All Superinterfaces:
Dialogs.HasCaption<Dialogs.BackgroundWorkDialogBuilder<T,V>>, Dialogs.HasMessage<Dialogs.BackgroundWorkDialogBuilder<T,V>>
All Known Implementing Classes:
DialogsImpl.BackgroundWorkDialogBuilderImpl
Enclosing interface:
Dialogs
public static interface Dialogs.BackgroundWorkDialogBuilder<T extends Number,V> extends Dialogs.HasCaption<Dialogs.BackgroundWorkDialogBuilder<T,V>>, Dialogs.HasMessage<Dialogs.BackgroundWorkDialogBuilder<T,V>>
Builder of background work dialog.

  • Method Details

    • withCancelAllowed

      Dialogs.BackgroundWorkDialogBuilder<T,V> withCancelAllowed(boolean cancelAllowed)
      Determines whether the dialog can be closed. False by default.
      Parameters:
      cancelAllowed - true if dialog is closeable
      Returns:
      builder

    • isCancelAllowed

      boolean isCancelAllowed()
      Returns:
      true if the dialog can be closed

    • withTotal

      Dialogs.BackgroundWorkDialogBuilder<T,V> withTotal(Number total)
      Parameters:
      total - amount of items to be processed by background task, use TaskLifeCycle.publish(Object[]) to notify the dialog about progress completion.
      Returns:
      builder

    • getTotal

      Number getTotal()
      Returns:
      total

    • withShowProgressInPercentage

      Dialogs.BackgroundWorkDialogBuilder<T,V> withShowProgressInPercentage(boolean percentProgress)
      Parameters:
      percentProgress - true if progress should be represented as percentage (rather than as raw number)
      Returns:
      builder

    • isShowProgressInPercentage

      boolean isShowProgressInPercentage()
      Returns:
      true if progress should is shown in percents

    • show

      BackgroundWorkDialog<T,V> show()
      Shows the dialog.
      Returns:
      background work dialog

    • build

      BackgroundWorkDialog<T,V> build()
      Builds the dialog.
      Returns:
      background work dialog