Class WaitingDialog

  • All Implemented Interfaces:
    BasePane, Composite, Window

    public class WaitingDialog
    extends DialogWindow
    Dialog that displays a text message, an optional spinning indicator and an optional progress bar. There is no buttons in this dialog so it has to be explicitly closed through code.
    • Constructor Detail

      • WaitingDialog

        private WaitingDialog​(java.lang.String title,
                              java.lang.String text)
    • Method Detail

      • showDialog

        public java.lang.Object showDialog​(WindowBasedTextGUI textGUI)
        Description copied from class: DialogWindow
        Opens the dialog by showing it on the GUI and doesn't return until the dialog has been closed
        Overrides:
        showDialog in class DialogWindow
        Parameters:
        textGUI - Text GUI to add the dialog to
        Returns:
        Depending on the DialogWindow implementation, by default null
      • showDialog

        public void showDialog​(WindowBasedTextGUI textGUI,
                               boolean blockUntilClosed)
        Displays the waiting dialog and optionally blocks until another thread closes it
        Parameters:
        textGUI - GUI to add the dialog to
        blockUntilClosed - If true, the method call will block until another thread calls close() on the dialog, otherwise the method call returns immediately
      • createDialog

        public static WaitingDialog createDialog​(java.lang.String title,
                                                 java.lang.String text)
        Creates a new waiting dialog
        Parameters:
        title - Title of the waiting dialog
        text - Text to display on the waiting dialog
        Returns:
        Created waiting dialog
      • showDialog

        public static WaitingDialog showDialog​(WindowBasedTextGUI textGUI,
                                               java.lang.String title,
                                               java.lang.String text)
        Creates and displays a waiting dialog without blocking for it to finish
        Parameters:
        textGUI - GUI to add the dialog to
        title - Title of the waiting dialog
        text - Text to display on the waiting dialog
        Returns:
        Created waiting dialog