org.eclipse.jface.dialogs
Class TitleAreaDialog

java.lang.Object
  |
  +--org.eclipse.jface.window.Window
        |
        +--org.eclipse.jface.dialogs.Dialog
              |
              +--org.eclipse.jface.dialogs.TitleAreaDialog

Direct Known Subclasses:

SaveAsDialog, WizardDialog

public class TitleAreaDialog

extends Dialog

A dialog that has a title area for displaying a title and an image as well as a common area for displaying a description, a message, or an error message.

This dialog class may be subclassed.

Nested Class Summary

Nested classes inherited from class org.eclipse.jface.window.Window

Window.IExceptionHandler

Field Summary

static String	DLG_IMG_TITLE_BANNER Image registry key for banner image (value "dialog_title_banner_image").
static String	DLG_IMG_TITLE_ERROR Image registry key for error message image.
static String	INFO_MESSAGE Deprecated.
static String	WARNING_MESSAGE Deprecated.

Fields inherited from class org.eclipse.jface.dialogs.Dialog

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

TitleAreaDialog(Shell parentShell)
Instantiate a new title area dialog.

Method Summary

protected Control	createDialogArea(Composite parent) Creates and returns the contents of the upper part of this dialog (above the button bar).
protected Point	getInitialSize() The TitleAreaDialog implementation of this Window methods returns an initial size which is at least some reasonable minimum.
protected Composite	getTitleArea() Returns the title area composite.
protected Label	getTitleImageLabel() Returns the title image label.
void	setErrorMessage(String newErrorMessage) Display the given error message.
void	setMessage(String newMessage) Set the message text.
void	setMessage(String newMessage, int newType) Sets the message for this dialog with an indication of what type of message it is.
void	setTitle(String newTitle) Sets the title to be shown in the title area of this dialog.
void	setTitleAreaColor(RGB color) Sets the title bar color for this dialog.
void	setTitleImage(Image newTitleImage) Sets the title image to be shown in the title area of this dialog.

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

buttonPressed, cancelPressed, constrainShellSize, convertHeightInCharsToPixels, convertHeightInCharsToPixels, convertHorizontalDLUsToPixels, convertHorizontalDLUsToPixels, convertVerticalDLUsToPixels, convertVerticalDLUsToPixels, convertWidthInCharsToPixels, convertWidthInCharsToPixels, createButton, createButtonBar, createButtonsForButtonBar, createContents, getButton, getButtonBar, getCancelButton, getDialogArea, getImage, getOKButton, initializeDialogUnits, okPressed

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

close, configureShell, create, createShell, getContents, getDefaultImage, getInitialLocation, getParentShell, getReturnCode, getShell, getShellListener, getShellStyle, getWindowManager, handleFontChange, handleShellCloseEvent, initializeBounds, 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

DLG_IMG_TITLE_ERROR

public static final String DLG_IMG_TITLE_ERROR

Image registry key for error message image.

See Also:

Constant Field Values

DLG_IMG_TITLE_BANNER

public static final String DLG_IMG_TITLE_BANNER

Image registry key for banner image (value "dialog_title_banner_image").

See Also:

Constant Field Values

INFO_MESSAGE

public static final String INFO_MESSAGE

Deprecated.

Message type constant used to display an info icon with the message.

Since:

2.0

See Also:

Constant Field Values

WARNING_MESSAGE

public static final String WARNING_MESSAGE

Deprecated.

Message type constant used to display a warning icon with the message.

Since:

2.0

See Also:

Constant Field Values

Constructor Detail

TitleAreaDialog

public TitleAreaDialog(Shell parentShell)

Instantiate a new title area dialog.

Parameters:

parentShell - the parent SWT shell

Method Detail

createDialogArea

protected Control createDialogArea(Composite parent)

Creates and returns the contents of the upper part of this dialog (above the button bar).

The Dialog implementation of this framework method creates and returns a new Composite with standard margins and spacing. Subclasses should override.

Overrides:

createDialogArea in class Dialog

Parameters:

parent - the parent composite to contain the dialog area

Returns:

the dialog area control

getInitialSize

protected Point getInitialSize()

The TitleAreaDialog implementation of this Window methods returns an initial size which is at least some reasonable minimum.

Overrides:

getInitialSize in class Window

Returns:

the initial size of the dialog

getTitleArea

protected Composite getTitleArea()

Returns the title area composite.

Returns:

the title area composite

getTitleImageLabel

protected Label getTitleImageLabel()

Returns the title image label.

Returns:

the title image label

setErrorMessage

public void setErrorMessage(String newErrorMessage)

Display the given error message. The currently displayed message is saved and will be redisplayed when the error message is set to null.

Parameters:

newErrorMessage - the newErrorMessage to display or null

setMessage

public void setMessage(String newMessage)

Set the message text. If the message line currently displays an error, the message is saved and will be redisplayed when the error message is set to null.

Shortcut for setMessage(newMessage, IMessageProvider.NONE)

Parameters:

newMessage - the message, or null to clear the message

setMessage

public void setMessage(String newMessage,
                       int newType)

Sets the message for this dialog with an indication of what type of message it is.

The valid message types are one of NONE, INFORMATION, WARNING, or ERROR.

Note that for backward compatibility, a message of type ERROR is different than an error message (set using setErrorMessage). An error message overrides the current message until the error message is cleared. This method replaces the current message and does not affect the error message.

Parameters:

newMessage - the message, or null to clear the message

newType - the message type

Since:

2.0

setTitle

public void setTitle(String newTitle)

Sets the title to be shown in the title area of this dialog.

Parameters:

newTitle - the title show

setTitleAreaColor

public void setTitleAreaColor(RGB color)

Sets the title bar color for this dialog.

Parameters:

color - the title bar color

setTitleImage

public void setTitleImage(Image newTitleImage)

Sets the title image to be shown in the title area of this dialog.