Eclipse Platform
2.1

org.eclipse.jface.dialogs
Class IconAndMessageDialog

java.lang.Object
  |
  +--org.eclipse.jface.window.Window
        |
        +--org.eclipse.jface.dialogs.Dialog
              |
              +--org.eclipse.jface.dialogs.IconAndMessageDialog
Direct Known Subclasses:
ErrorDialog, MessageDialog, 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.


Inner classes inherited from class org.eclipse.jface.window.Window
Window.IExceptionHandler
 
Field Summary
protected  String message
          Message (a localized string).
protected  Label messageLabel
          Message label is the label the message is shown on.
 
Fields inherited from class org.eclipse.jface.dialogs.Dialog
buttonBar, dialogArea, DLG_IMG_ERROR, DLG_IMG_INFO, DLG_IMG_MESSAGE_ERROR, DLG_IMG_MESSAGE_INFO, DLG_IMG_MESSAGE_WARNING, DLG_IMG_QUESTION, DLG_IMG_WARNING
 
Fields inherited from class org.eclipse.jface.window.Window
CANCEL, OK
 
Constructor Summary
IconAndMessageDialog(Shell parentShell)
          Constructor for IconAndMessageDialog.
 
Method Summary
protected  Control createButtonBar(Composite parent)
          Creates and returns the contents of this dialog's button bar.
protected  Control createContents(Composite parent)
          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.
protected  void createDialogAndButtonArea(Composite parent)
          Create the dialog area and the button bar for the receiver.
protected  Control createMessageArea(Composite composite)
          Create the area the message will be shown in.
protected abstract  Image getImage()
          Returns the image to display beside the message in this dialog.
 
Methods inherited from class org.eclipse.jface.dialogs.Dialog
applyDialogFont, buttonPressed, cancelPressed, close, configureShell, constrainShellSize, convertHeightInCharsToPixels, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, convertWidthInCharsToPixels, createButton, createButtonsForButtonBar, createDialogArea, getButton, getButtonBar, getCancelButton, getDialogArea, getImage, getOKButton, initializeBounds, initializeDialogUnits, okPressed, setButtonLayoutData, setButtonLayoutFormData
 
Methods inherited from class org.eclipse.jface.window.Window
canHandleShellCloseEvent, create, createShell, getContents, getDefaultImage, getInitialLocation, getInitialSize, getParentShell, getReturnCode, getShell, getShellListener, getShellStyle, getWindowManager, handleFontChange, handleShellCloseEvent, open, setBlockOnOpen, setDefaultImage, setExceptionHandler, setReturnCode, setShellStyle, setWindowManager
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

message

protected String message
Message (a localized string).

messageLabel

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

IconAndMessageDialog

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

createMessageArea

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

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
Following copied from class: org.eclipse.jface.dialogs.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
Following copied from class: org.eclipse.jface.window.Window
Returns:
the control

createDialogAndButtonArea

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

Eclipse Platform
2.1

Copyright (c) IBM Corp. and others 2000, 2003. All Rights Reserved.