Class StatusDialog

  • All Implemented Interfaces:
    IShellProvider
    Direct Known Subclasses:
    TemplatePreferencePage.EditTemplateDialog

    public abstract class StatusDialog
    extends TrayDialog
    An abstract base class for dialogs with a status bar and OK/CANCEL buttons. The status message is specified in an IStatus which can be of severity ERROR, WARNING, INFO or OK. The OK button is enabled or disabled depending on the status.
    Since:
    3.1
    • Constructor Detail

      • StatusDialog

        public StatusDialog​(Shell parent)
        Creates an instance of a status dialog.
        Parameters:
        parent - the parent Shell of the dialog
    • Method Detail

      • setStatusLineAboveButtons

        public void setStatusLineAboveButtons​(boolean aboveButtons)
        Specifies whether status line appears to the left of the buttons (default) or above them.
        Parameters:
        aboveButtons - if true status line is placed above buttons; if false to the right
      • updateStatus

        protected void updateStatus​(IStatus status)
        Update the dialog's status line to reflect the given status. It is safe to call this method before the dialog has been opened.
        Parameters:
        status - the status to set
      • getStatus

        public IStatus getStatus()
        Returns the last status.
        Returns:
        IStatus
      • updateButtonsEnableState

        protected void updateButtonsEnableState​(IStatus status)
        Updates the status of the ok button to reflect the given status. Subclasses may override this method to update additional buttons.
        Parameters:
        status - the status.
      • configureShell

        protected void configureShell​(Shell shell)
        Description copied from class: Window
        Configures the given shell in preparation for opening this window in it.

        The default implementation of this framework method sets the shell's image and gives it a grid layout. Subclasses may extend or reimplement.

        Overrides:
        configureShell in class Window
        Parameters:
        shell - the shell
      • create

        public void create()
        Description copied from class: Window
        Creates this window's widgetry in a new top-level shell.

        The default implementation of this framework method creates this window's shell (by calling createShell), and its controls (by calling createContents), then initializes this window's shell bounds (by calling initializeBounds).

        Overrides:
        create in class Dialog
      • createButtonsForButtonBar

        protected void createButtonsForButtonBar​(Composite parent)
        Description copied from class: Dialog
        Adds buttons to this dialog's button bar.

        The Dialog implementation of this framework method adds standard ok and cancel buttons using the createButton framework method. These standard buttons will be accessible from getCancelButton, and getOKButton. Subclasses may override.

        Note: The common button order is: {other buttons}, OK, Cancel. On some platforms, Dialog.initializeBounds() will move the default button to the right.

        Overrides:
        createButtonsForButtonBar in class Dialog
        Parameters:
        parent - the button bar composite
      • createButtonBar

        protected Control createButtonBar​(Composite parent)
        Description copied from class: Dialog
        Creates and returns the contents of this dialog's button bar.

        The Dialog implementation of this framework method lays out a button bar and calls the createButtonsForButtonBar framework method to populate it. Subclasses may override.

        The returned control's layout data must be an instance of GridData.

        Overrides:
        createButtonBar in class TrayDialog
        Parameters:
        parent - the parent composite to contain the button bar
        Returns:
        the button bar control
      • setTitle

        public void setTitle​(String title)
        Sets the title for this dialog.
        Parameters:
        title - the title.
      • setImage

        public void setImage​(Image image)
        Sets the image for this dialog.
        Parameters:
        image - the image.