|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.ObjectTrayDialog
org.eclipse.birt.core.ui.frameworks.taskwizard.BirtTitleAreaDialog
public class BirtTitleAreaDialog
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.
The class is transformed from
org.eclipse.jface.dialogs.TigleAreaDialog
and can limit the
width of message label.
Field Summary | |
---|---|
static java.lang.String |
DLG_IMG_TITLE_BANNER
Image registry key for banner image (value "dialog_title_banner_image" ). |
static java.lang.String |
DLG_IMG_TITLE_ERROR
Image registry key for error message image. |
static java.lang.String |
INFO_MESSAGE
Deprecated. |
static java.lang.String |
WARNING_MESSAGE
Deprecated. |
Constructor Summary | |
---|---|
BirtTitleAreaDialog(Shell parentShell)
Instantiate a new title area dialog. |
|
BirtTitleAreaDialog(Shell parentShell,
int msgLabelWidth)
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()
Deprecated. |
protected Label |
getTitleImageLabel()
Returns the title image label. |
void |
setErrorMessage(java.lang.String newErrorMessage)
Display the given error message. |
void |
setMessage(java.lang.String newMessage)
Set the message text. |
void |
setMessage(java.lang.String newMessage,
int newType)
Sets the message for this dialog with an indication of what type of message it is. |
void |
setTitle(java.lang.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 java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String DLG_IMG_TITLE_ERROR
public static final java.lang.String DLG_IMG_TITLE_BANNER
"dialog_title_banner_image"
).
public static final java.lang.String INFO_MESSAGE
public static final java.lang.String WARNING_MESSAGE
Constructor Detail |
---|
public BirtTitleAreaDialog(Shell parentShell)
parentShell
- the parent SWT shellpublic BirtTitleAreaDialog(Shell parentShell, int msgLabelWidth)
parentShell
- the parent SWT shellmsgLabelWidth
- width of message label.Method Detail |
---|
protected Control createContents(Composite parent)
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.
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.
protected Composite getTitleArea()
protected Label getTitleImageLabel()
public void setErrorMessage(java.lang.String newErrorMessage)
null
.
newErrorMessage
- the newErrorMessage to display or null
public void setMessage(java.lang.String newMessage)
null
.
Shortcut for setMessage(newMessage, IMessageProvider.NONE)
newMessage
- the message, or null
to clear the messagepublic void setMessage(java.lang.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(java.lang.String newTitle)
newTitle
- the title showpublic void setTitleAreaColor(RGB color)
color
- the title bar colorpublic void setTitleImage(Image newTitleImage)
newTitleImage
- the title image to be shown
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |