Class ErdInputDialog

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

    public class ErdInputDialog
    extends org.eclipse.jface.dialogs.Dialog
    Instanse of this class represents input dialog.
    Copied from InputDialog and added error image.
    • Nested Class Summary

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

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

      • 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
      ErdInputDialog​(org.eclipse.swt.widgets.Shell parentShell, String dialogTitle, String dialogMessage, String initialValue, org.eclipse.jface.dialogs.IInputValidator validator)
      Creates an input dialog with OK and Cancel buttons.
    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      protected void buttonPressed​(int buttonId)  
      protected void configureShell​(org.eclipse.swt.widgets.Shell shell)  
      protected void createButtonsForButtonBar​(org.eclipse.swt.widgets.Composite parent)  
      protected org.eclipse.swt.widgets.Control createDialogArea​(org.eclipse.swt.widgets.Composite parent)  
      protected org.eclipse.swt.widgets.Label getErrorMessageLabel()
      Deprecated.
      use setErrorMessage(String) instead
      protected int getInputTextStyle()
      Returns the style bits that should be used for the input text field.
      protected org.eclipse.swt.widgets.Button getOkButton()
      Returns the ok button.
      protected org.eclipse.swt.widgets.Text getText()
      Returns the text area.
      protected org.eclipse.jface.dialogs.IInputValidator getValidator()
      Returns the validator.
      String getValue()
      Returns the string typed into this input dialog.
      void setErrorMessage​(String errorMessage)
      Sets or clears the error message.
      protected void validateInput()
      Validates the input.
      • Methods inherited from class org.eclipse.jface.dialogs.Dialog

        applyDialogFont, cancelPressed, close, convertHeightInCharsToPixels, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, convertWidthInCharsToPixels, create, createButton, createButtonBar, createContents, dialogFontIsDefault, getBlockedHandler, getButton, 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, 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
    • Constructor Detail

      • ErdInputDialog

        public ErdInputDialog​(org.eclipse.swt.widgets.Shell parentShell,
                              String dialogTitle,
                              String dialogMessage,
                              String initialValue,
                              org.eclipse.jface.dialogs.IInputValidator validator)
        Creates an input dialog with OK and Cancel buttons. Note that the dialog will have no visual representation (no widgets) until it is told to open.

        Note that the open method blocks for input dialogs.

        Parameters:
        parentShell - the parent shell, or null to create a top-level shell
        dialogTitle - the dialog title, or null if none
        dialogMessage - the dialog message, or null if none
        initialValue - the initial input value, or null if none (equivalent to the empty string)
        validator - an input validator, or null if none
    • Method Detail

      • getValue

        public String getValue()
        Returns the string typed into this input dialog.
        Returns:
        the input string
      • setErrorMessage

        public void setErrorMessage​(String errorMessage)
        Sets or clears the error message. If not null, the OK button is disabled.
        Parameters:
        errorMessage - the error message, or null to clear
        Since:
        3.0
      • buttonPressed

        protected void buttonPressed​(int buttonId)
        Overrides:
        buttonPressed 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
      • createButtonsForButtonBar

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

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

        @Deprecated
        protected org.eclipse.swt.widgets.Label getErrorMessageLabel()
        Deprecated.
        use setErrorMessage(String) instead
        Returns the error message label.
        Returns:
        the error message label
      • getOkButton

        protected org.eclipse.swt.widgets.Button getOkButton()
        Returns the ok button.
        Returns:
        the ok button
      • getText

        protected org.eclipse.swt.widgets.Text getText()
        Returns the text area.
        Returns:
        the text area
      • getValidator

        protected org.eclipse.jface.dialogs.IInputValidator getValidator()
        Returns the validator.
        Returns:
        the validator
      • validateInput

        protected void validateInput()
        Validates the input.

        The default implementation of this framework method delegates the request to the supplied input validator object; if it finds the input invalid, the error message is displayed in the dialog's message line. This hook method is called whenever the text changes in the input field.

      • getInputTextStyle

        protected int getInputTextStyle()
        Returns the style bits that should be used for the input text field. Defaults to a single line entry. Subclasses may override.
        Returns:
        the integer style bits that should be used when creating the input text
        Since:
        3.4