Package org.pentaho.di.ui.core.dialog

Class SimpleMessageDialog

  • All Implemented Interfaces:
    org.eclipse.jface.window.IShellProvider
    public class SimpleMessageDialog
extends org.eclipse.jface.dialogs.MessageDialog
    A simple message dialog containing a title, icon, message and a single button (OK by default) that closes the dialog. The dialog width can be specified and the height is auto-adjusted based on the width.

    • 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
      static int BUTTON_WIDTH  
      static int DEFULT_WIDTH  
      protected static Class<?> PKG  

      • Fields inherited from class org.eclipse.jface.dialogs.MessageDialog

        CONFIRM, ERROR, INFORMATION, NONE, QUESTION, QUESTION_WITH_CANCEL, WARNING

      • 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
      SimpleMessageDialog​(org.eclipse.swt.widgets.Shell parentShell, String title, String message, int dialogType)
      Creates a new dialog with the button label set to "Ok", dialog width set to DEFULT_WIDTH and button width set to BUTTON_WIDTH
      SimpleMessageDialog​(org.eclipse.swt.widgets.Shell parentShell, String title, String message, int dialogType, String buttonLabel)
      Creates a new dialog with the button label set to closeButtonLabel, dialog width set to DEFULT_WIDTH and button width set to BUTTON_WIDTH
      SimpleMessageDialog​(org.eclipse.swt.widgets.Shell parentShell, String title, String message, int dialogType, String buttonLabel, int width, int buttonWidth)
      Creates a new dialog with the specified title, message, dialogType and width.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void configureShell​(org.eclipse.swt.widgets.Shell shell)
      Overridden to make the shell background white.
      protected void constrainShellSize()
      Overridden to auto-size the shell according to the selected width.
      void create()
      Overridden to give the button the desired width.

      • Methods inherited from class org.eclipse.jface.dialogs.MessageDialog

        buttonPressed, createButton, createButtonsForButtonBar, createCustomArea, createDialogArea, customShouldTakeFocus, getButton, getButtonLabels, getDefaultButtonIndex, getImage, getMinimumMessageWidth, handleShellCloseEvent, open, open, openConfirm, openError, openInformation, openQuestion, openWarning, setButtonLabels, setButtons

      • Methods inherited from class org.eclipse.jface.dialogs.IconAndMessageDialog

        createButtonBar, createContents, createDialogAndButtonArea, createMessageArea, getColumnCount, getErrorImage, getInfoImage, getMessageLabelStyle, getQuestionImage, getWarningImage

      • Methods inherited from class org.eclipse.jface.dialogs.Dialog

        applyDialogFont, cancelPressed, close, convertHeightInCharsToPixels, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, convertWidthInCharsToPixels, dialogFontIsDefault, getBlockedHandler, getButtonBar, getCancelButton, getDialogArea, getDialogBoundsSettings, getDialogBoundsStrategy, getImage, getInitialLocation, getInitialSize, getOKButton, initializeBounds, initializeDialogUnits, isResizable, okPressed, setBlockedHandler, setButtonLayoutData, setButtonLayoutFormData, shortenText

      • Methods inherited from class org.eclipse.jface.window.Window

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

    • Constructor Detail

      • SimpleMessageDialog

        public SimpleMessageDialog​(org.eclipse.swt.widgets.Shell parentShell,
                           String title,
                           String message,
                           int dialogType)
        Creates a new dialog with the button label set to "Ok", dialog width set to DEFULT_WIDTH and button width set to BUTTON_WIDTH
        Parameters:
        parentShell - the parent Shell
        title - the dialog title
        message - the dialog message
        dialogType - the dialog type (MessageDialog.INFORMATION, MessageDialog.WARNING, MessageDialog.ERROR etc...)

      • SimpleMessageDialog

        public SimpleMessageDialog​(org.eclipse.swt.widgets.Shell parentShell,
                           String title,
                           String message,
                           int dialogType,
                           String buttonLabel)
        Creates a new dialog with the button label set to closeButtonLabel, dialog width set to DEFULT_WIDTH and button width set to BUTTON_WIDTH
        Parameters:
        parentShell - the parent Shell
        title - the dialog title
        message - the dialog message
        dialogType - the dialog type (MessageDialog.INFORMATION, MessageDialog.WARNING, MessageDialog.ERROR etc...)
        buttonLabel - the label for the close dialog

      • SimpleMessageDialog

        public SimpleMessageDialog​(org.eclipse.swt.widgets.Shell parentShell,
                           String title,
                           String message,
                           int dialogType,
                           String buttonLabel,
                           int width,
                           int buttonWidth)
        Creates a new dialog with the specified title, message, dialogType and width.
        Parameters:
        parentShell - the parent Shell
        title - the dialog title
        message - the dialog message
        dialogType - the dialog type (MessageDialog.INFORMATION, MessageDialog.WARNING, MessageDialog.ERROR etc...)
        buttonLabel - the button label
        width - dialog width
        buttonWidth - button width

    • Method Detail

      • constrainShellSize

        protected void constrainShellSize()
        Overridden to auto-size the shell according to the selected width.
        Overrides:
        constrainShellSize in class org.eclipse.jface.window.Window

      • configureShell

        protected void configureShell​(org.eclipse.swt.widgets.Shell shell)
        Overridden to make the shell background white.
        Overrides:
        configureShell in class org.eclipse.jface.dialogs.MessageDialog
        Parameters:
        shell -

      • create

        public void create()
        Overridden to give the button the desired width.
        Overrides:
        create in class org.eclipse.jface.dialogs.Dialog