|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.jface.window.Window
org.eclipse.jface.dialogs.Dialog
org.eclipse.jface.dialogs.TitleAreaDialog
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 |
blockedHandler, 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, ELLIPSIS |
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 |
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 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()
Deprecated. |
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.window.Window |
canHandleShellCloseEvent, configureShell, constrainShellSize, createShell, getConstrainedShellBounds, getContents, getDefaultImage, getDefaultImages, getInitialLocation, getLayout, getParentShell, getReturnCode, getShell, getShellListener, getShellStyle, getWindowManager, handleFontChange, handleShellCloseEvent, open, setBlockOnOpen, setDefaultImage, setDefaultImages, setExceptionHandler, setReturnCode, setShellStyle, setWindowManager |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String DLG_IMG_TITLE_ERROR
public static final String DLG_IMG_TITLE_BANNER
"dialog_title_banner_image"
).
public static final String INFO_MESSAGE
public static final String WARNING_MESSAGE
Constructor Detail |
public TitleAreaDialog(Shell parentShell)
parentShell
- the parent SWT shellMethod Detail |
protected Control createContents(Composite parent)
Dialog
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.
createContents
in class Dialog
protected Control createDialogArea(Composite parent)
The Dialog
implementation of this framework method creates
and returns a new Composite
with no margins and spacing.
Subclasses should override.
createDialogArea
in class Dialog
parent
- The parent composite to contain the dialog area
protected Point getInitialSize()
TitleAreaDialog
implementation of this
Window
methods returns an initial size which is at least
some reasonable minimum.
getInitialSize
in class Window
protected Composite getTitleArea()
protected Label getTitleImageLabel()
public void setErrorMessage(String newErrorMessage)
null
.
newErrorMessage
- the newErrorMessage to display or null
public void setMessage(String newMessage)
null
.
Shortcut for setMessage(newMessage, IMessageProvider.NONE)
newMessage
- the message, or null
to clear the messagepublic void setMessage(String newMessage, int newType)
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.
newMessage
- the message, or null
to clear the messagenewType
- the message typepublic void setTitle(String newTitle)
newTitle
- the title showpublic void setTitleAreaColor(RGB color)
color
- the title bar colorpublic void setTitleImage(Image newTitleImage)
newTitleImage
- the title image show
|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp. and others 2000, 2004. All rights reserved.