|
| |
|
| org.eclipse.jface.dialogs.Dialog
 org.eclipse.jface.dialogs.TrayDialog
org.eclipse.jface.dialogs.TitleAreaDialog
All known Subclasses: org.eclipse.jface.wizard.WizardDialog,
| TitleAreaDialog | | public class TitleAreaDialog extends TrayDialog (Code) | | 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.
|
| Constructor Summary | |
| public | TitleAreaDialog(Shell parentShell)
Instantiate a new title area dialog. |
| Method Summary | |
| protected Control | createContents(Composite parent)
| | 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()
Retained for backward compatibility.
Returns the title area composite. | | protected Label | getTitleImageLabel()
Returns the title image label. | | public void | setErrorMessage(String newErrorMessage)
Display the given error message. | | public void | setMessage(String newMessage)
Set the message text. | | 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). | | public void | setTitle(String newTitle)
Sets the title to be shown in the title area of this dialog. | | public void | setTitleAreaColor(RGB color)
Sets the title bar color for this dialog. | | public void | setTitleImage(Image newTitleImage)
Sets the title image to be shown in the title area of this dialog. |
| DLG_IMG_TITLE_BANNER | | final public static String DLG_IMG_TITLE_BANNER(Code) | | Image registry key for banner image (value
"dialog_title_banner_image").
|
| DLG_IMG_TITLE_ERROR | | final public static String DLG_IMG_TITLE_ERROR(Code) | | Image registry key for error message image.
|
| INFO_MESSAGE | | final public static String INFO_MESSAGE(Code) | | Message type constant used to display an info icon with the message.
since:
2.0 |
| WARNING_MESSAGE | | final public static String WARNING_MESSAGE(Code) | | Message type constant used to display a warning icon with the message.
since:
2.0 |
| titleAreaColor | | Color titleAreaColor(Code) | | |
| TitleAreaDialog | | public TitleAreaDialog(Shell parentShell)(Code) | | Instantiate a new title area dialog.
Parameters:
parentShell - the parent SWT shell |
| createContents | | protected Control createContents(Composite parent)(Code) | | |
| createDialogArea | | protected Control createDialogArea(Composite parent)(Code) | | 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 no margins and spacing.
Subclasses should override.
Parameters:
parent - The parent composite to contain the dialog area the dialog area control |
| getInitialSize | | protected Point getInitialSize()(Code) | | The TitleAreaDialog implementation of this
Window methods returns an initial size which is at least
some reasonable minimum.
the initial size of the dialog |
| getTitleArea | | protected Composite getTitleArea()(Code) | | Retained for backward compatibility.
Returns the title area composite. There is no composite in this
implementation so the shell is returned.
Composite |
| getTitleImageLabel | | protected Label getTitleImageLabel()(Code) | | Returns the title image label.
the title image label |
| setErrorMessage | | public void setErrorMessage(String newErrorMessage)(Code) | | 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)(Code) | | 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)
This method should be called after the dialog has been opened as it
updates the message label immediately.
Parameters:
newMessage - the message, or null to clear the message |
| setMessage | | public void setMessage(String newMessage, int newType)(Code) | | 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
Parameters:
newType - the message type
since:
2.0 |
| setTitle | | public void setTitle(String newTitle)(Code) | | Sets the title to be shown in the title area of this dialog.
Parameters:
newTitle - the title show |
| setTitleAreaColor | | public void setTitleAreaColor(RGB color)(Code) | | Sets the title bar color for this dialog.
Parameters:
color - the title bar color |
| setTitleImage | | public void setTitleImage(Image newTitleImage)(Code) | | Sets the title image to be shown in the title area of this dialog.
Parameters:
newTitleImage - the title image to be shown |
|
|
|