Class StatusDialog

  • All Implemented Interfaces:
    org.eclipse.jface.window.IShellProvider

    public class StatusDialog
    extends org.eclipse.jface.dialogs.IconAndMessageDialog
    The dialog with icon, message and tree element of IStatus-tree object
    • Nested Class Summary

      • Nested classes/interfaces inherited from class org.eclipse.jface.window.Window

        org.eclipse.jface.window.Window.IExceptionHandler
    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected TreeViewer viewer
      The dialog tree viewer; null until dialog is layed out.
      • Fields inherited from class org.eclipse.jface.dialogs.IconAndMessageDialog

        imageLabel, message, messageLabel
      • Fields inherited from class org.eclipse.jface.dialogs.Dialog

        blockedHandler, buttonBar, DIALOG_DEFAULT_BOUNDS, DIALOG_PERSISTLOCATION, DIALOG_PERSISTSIZE, dialogArea, DLG_IMG_ERROR, DLG_IMG_HELP, DLG_IMG_INFO, DLG_IMG_MESSAGE_ERROR, DLG_IMG_MESSAGE_INFO, DLG_IMG_MESSAGE_WARNING, DLG_IMG_QUESTION, DLG_IMG_WARNING, ELLIPSIS
      • Fields inherited from class org.eclipse.jface.window.Window

        CANCEL, OK, resizeHasOccurred
    • Constructor Summary

      Constructors 
      Constructor Description
      StatusDialog​(org.eclipse.swt.widgets.Shell parentShell, String dialogTitle, org.eclipse.core.runtime.IStatus status)
      Create a insatance of StatusDialog
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void buttonPressed​(int id)  
      boolean close()  
      protected void configureShell​(org.eclipse.swt.widgets.Shell shell)  
      protected void createButtonsForButtonBar​(org.eclipse.swt.widgets.Composite parent)  
      protected void createDialogAndButtonArea​(org.eclipse.swt.widgets.Composite parent)  
      protected org.eclipse.swt.widgets.Control createDialogArea​(org.eclipse.swt.widgets.Composite parent)  
      protected TreeViewer createTreeArea​(org.eclipse.swt.widgets.Composite parent)
      Create and return TreeViewer used for show status contents
      protected org.eclipse.swt.graphics.Image getImage()  
      protected boolean isResizable()  
      static void open​(org.eclipse.swt.widgets.Shell shell, String title, org.eclipse.core.runtime.IStatus status)
      Opens this dialog, creating it first if it has not yet been created.
      void setInitialShowDetails​(boolean showDetails)
      Sets the flag whether need to show details pane with statuses content by default.
      void setShowExceptionMessage​(boolean showExceptionMessage)
      Sets the flag whether need to show exception message (if any) in the nested node.
      • Methods inherited from class org.eclipse.jface.dialogs.IconAndMessageDialog

        createButtonBar, createContents, createMessageArea, getColumnCount, getErrorImage, getInfoImage, getMessageLabelStyle, getQuestionImage, getWarningImage
      • Methods inherited from class org.eclipse.jface.dialogs.Dialog

        applyDialogFont, cancelPressed, convertHeightInCharsToPixels, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, convertWidthInCharsToPixels, create, createButton, dialogFontIsDefault, getBlockedHandler, getButton, getButtonBar, getCancelButton, getDialogArea, getDialogBoundsSettings, getDialogBoundsStrategy, getImage, getInitialLocation, getInitialSize, getOKButton, initializeBounds, initializeDialogUnits, okPressed, setBlockedHandler, setButtonLayoutData, setButtonLayoutFormData, shortenText
      • Methods inherited from class org.eclipse.jface.window.Window

        canHandleShellCloseEvent, constrainShellSize, createShell, getConstrainedShellBounds, getContents, getDefaultImage, getDefaultImages, getDefaultOrientation, getLayout, getParentShell, getReturnCode, getShell, getShellListener, getShellStyle, getWindowManager, handleFontChange, handleShellCloseEvent, open, setBlockOnOpen, setDefaultImage, setDefaultImages, setDefaultModalParent, setDefaultOrientation, setExceptionHandler, setParentShell, setReturnCode, setShellStyle, setWindowManager
    • Field Detail

      • viewer

        protected TreeViewer viewer
        The dialog tree viewer; null until dialog is layed out.
    • Constructor Detail

      • StatusDialog

        public StatusDialog​(org.eclipse.swt.widgets.Shell parentShell,
                            String dialogTitle,
                            org.eclipse.core.runtime.IStatus status)
        Create a insatance of StatusDialog
        Parameters:
        parentShell - the parent shell, or null to create a top-level shell
        dialogTitle - the text, which is the string that the window manager will typically display as the title, cannot be null
        status - the target status used for dialog main message and icon, children of status fill the dialog tree, cannot be null
    • Method Detail

      • open

        public static void open​(org.eclipse.swt.widgets.Shell shell,
                                String title,
                                org.eclipse.core.runtime.IStatus status)
        Opens this dialog, creating it first if it has not yet been created.
        Parameters:
        shell - the parent shell, or null to create a top-level shell
        title - the text, which is the string that the window manager will typically display as the title, cannot be null
        status - the target status used for dialog main message and icon, children of status fill the dialog tree, cannot be null
      • setInitialShowDetails

        public void setInitialShowDetails​(boolean showDetails)
        Sets the flag whether need to show details pane with statuses content by default.
        Parameters:
        showDetails - whether need to show details pane with statuses content by default
      • setShowExceptionMessage

        public void setShowExceptionMessage​(boolean showExceptionMessage)
        Sets the flag whether need to show exception message (if any) in the nested node.
        Parameters:
        showExceptionMessage - whether need to show exception message
      • close

        public boolean close()
        Overrides:
        close in class org.eclipse.jface.dialogs.Dialog
      • configureShell

        protected void configureShell​(org.eclipse.swt.widgets.Shell shell)
        Overrides:
        configureShell in class org.eclipse.jface.window.Window
      • createDialogAndButtonArea

        protected void createDialogAndButtonArea​(org.eclipse.swt.widgets.Composite parent)
        Overrides:
        createDialogAndButtonArea in class org.eclipse.jface.dialogs.IconAndMessageDialog
      • createDialogArea

        protected org.eclipse.swt.widgets.Control createDialogArea​(org.eclipse.swt.widgets.Composite parent)
        Overrides:
        createDialogArea in class org.eclipse.jface.dialogs.Dialog
      • createButtonsForButtonBar

        protected void createButtonsForButtonBar​(org.eclipse.swt.widgets.Composite parent)
        Overrides:
        createButtonsForButtonBar in class org.eclipse.jface.dialogs.Dialog
      • createTreeArea

        protected TreeViewer createTreeArea​(org.eclipse.swt.widgets.Composite parent)
        Create and return TreeViewer used for show status contents
        Parameters:
        parent - the parent composite to contain the dialog area, cannot be null
        Returns:
        the dialog tree viewer, never null
      • buttonPressed

        protected void buttonPressed​(int id)
        Overrides:
        buttonPressed in class org.eclipse.jface.dialogs.Dialog
      • getImage

        protected org.eclipse.swt.graphics.Image getImage()
        Specified by:
        getImage in class org.eclipse.jface.dialogs.IconAndMessageDialog
      • isResizable

        protected boolean isResizable()
        Overrides:
        isResizable in class org.eclipse.jface.dialogs.Dialog