Package org.eclipse.jface.dialogs

Class IconAndMessageDialog

java.lang.Object
org.eclipse.jface.window.Window
org.eclipse.jface.dialogs.Dialog
org.eclipse.jface.dialogs.IconAndMessageDialog
All Implemented Interfaces:
IShellProvider
Direct Known Subclasses:
ErrorDialog, MessageDialog, PlainMessageDialog, ProgressMonitorDialog
public abstract class IconAndMessageDialog extends Dialog
The IconAndMessageDialog is the abstract superclass of dialogs that have an icon and a message as the first two widgets. In this dialog the icon and message are direct children of the shell in order that they can be read by accessibility tools more easily.

Note: Clients are expected to call createMessageArea(Composite), otherwise neither the icon nor the message will appear.

  • Field Details

    • message

      protected String message
      Message (a localized string).

    • messageLabel

      protected Label messageLabel
      Message label is the label the message is shown on.

    • imageLabel

      protected Label imageLabel
      Return the label for the image.

  • Constructor Details

    • IconAndMessageDialog

      public IconAndMessageDialog(Shell parentShell)
      Constructor for IconAndMessageDialog.
      Parameters:
      parentShell - the parent shell, or null to create a top-level shell

  • Method Details

    • createMessageArea

      protected Control createMessageArea(Composite composite)
      Create the area the message will be shown in.

      The parent composite is assumed to use GridLayout as its layout manager, since the parent is typically the composite created in Dialog.createDialogArea(org.eclipse.swt.widgets.Composite).

      Note: Clients are expected to call this method, otherwise neither the icon nor the message will appear.

      Parameters:
      composite - The composite to parent from.
      Returns:
      Control

    • getMessageLabelStyle

      protected int getMessageLabelStyle()
      Returns the style for the message label.
      Returns:
      the style for the message label
      Since:
      3.0

    • 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 Dialog
      Parameters:
      parent - the parent composite to contain the button bar
      Returns:
      the button bar control

    • getImage

      protected abstract Image getImage()
      Returns the image to display beside the message in this dialog.

      Subclasses may override.

      Returns:
      the image to display beside the message
      Since:
      2.0

    • createContents

      protected Control createContents(Composite parent)
      Description copied from class: Dialog
      The Dialog implementation of this Window method creates and lays out the top level composite for the dialog, and determines the appropriate horizontal and vertical dialog units based on the font size. It then calls the createDialogArea and createButtonBar methods to create the dialog area and button bar, respectively. Overriding createDialogArea and createButtonBar are recommended rather than overriding this method.
      Overrides:
      createContents in class Dialog
      Parameters:
      parent - the parent composite for the controls in this window. The type of layout used is determined by getLayout()
      Returns:
      the control that will be returned by subsequent calls to getContents()

    • getColumnCount

      protected int getColumnCount()
      Get the number of columns in the layout of the Shell of the dialog.
      Returns:
      int
      Since:
      3.22

    • createDialogAndButtonArea

      protected void createDialogAndButtonArea(Composite parent)
      Create the dialog area and the button bar for the receiver.
      Parameters:
      parent - the parent composite

    • getErrorImage

      public Image getErrorImage()
      Return the Image to be used when displaying an error.
      Returns:
      image the error image

    • getWarningImage

      public Image getWarningImage()
      Return the Image to be used when displaying a warning.
      Returns:
      image the warning image

    • getInfoImage

      public Image getInfoImage()
      Return the Image to be used when displaying information.
      Returns:
      image the information image

    • getQuestionImage

      public Image getQuestionImage()
      Return the Image to be used when displaying a question.
      Returns:
      image the question image