|
Eclipse Platform Release 3.4 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.ui.statushandlers.WorkbenchStatusDialogManager
The WorkbenchStatusDialogManager
is a utility class for displaying
one or more messages (errors, warnings or infos) to the user. The dialog
supplied has a Details button that opens/closes the details area. The default
AbstractStatusAreaProvider
displays a tree of StatusAdapter
s
related to the selected item on the messages list. The dialog also hasa
Support button that opens/closes the support area which contains the provided
AbstractStatusAreaProvider
. The Support button is disabled and not
visible unless
enableDefaultSupportArea(boolean)
is
invoked.
The default details area can be replaced using
setDetailsAreaProvider(AbstractStatusAreaProvider)
The default support area can be replaced using
setSupportAreaProvider(AbstractStatusAreaProvider)
or Policy.setErrorSupportProvider(ErrorSupportProvider)
.
The manager can switch from a non-modal dialog to a modal dialog. See
addStatusAdapter(StatusAdapter, boolean)
IMPORTANT: This class is not intended to be subclassed by clients.
Policy.setErrorSupportProvider(ErrorSupportProvider)
,
ErrorSupportProvider
,
AbstractStatusAreaProvider
Constructor Summary | |
WorkbenchStatusDialogManager(int displayMask,
String dialogTitle)
Creates workbench status dialog. |
|
WorkbenchStatusDialogManager(Shell parentShell,
int displayMask,
String dialogTitle)
Deprecated. As of 3.4 the parentShell |
|
WorkbenchStatusDialogManager(Shell parentShell,
String dialogTitle)
Deprecated. As of 3.4 the parentShell |
|
WorkbenchStatusDialogManager(String dialogTitle)
Creates workbench status dialog. |
Method Summary | |
void |
addStatusAdapter(StatusAdapter statusAdapter,
boolean modal)
Adds a new StatusAdapter to the status adapters list in the
dialog.
|
void |
enableDefaultSupportArea(boolean enable)
Enables the default support area that shows stack trace of the exception contained in the selected status. |
Collection |
getStatusAdapters()
Gets a collection of status adapters that were passed to the dialog. |
void |
setDetailsAreaProvider(AbstractStatusAreaProvider provider)
Sets the details area provider. |
void |
setStatusListLabelProvider(ITableLabelProvider labelProvider)
Sets new label provider for the status list. |
void |
setSupportAreaProvider(AbstractStatusAreaProvider provider)
Sets the support provider. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public WorkbenchStatusDialogManager(int displayMask, String dialogTitle)
displayMask
- the mask used to filter the handled StatusAdapter
objects, the mask is a logical sum of status severitiesdialogTitle
- the title of the dialog. If null, than default will be used.public WorkbenchStatusDialogManager(Shell parentShell, int displayMask, String dialogTitle)
parentShell is ignored
parentShell
- the parent shell for the dialog. It may be null.displayMask
- the mask used to filter the handled StatusAdapter
objects, the mask is a logical sum of status severitiesdialogTitle
- the title of the dialog. If null, than default will be used.WorkbenchStatusDialogManager(int, String)
public WorkbenchStatusDialogManager(String dialogTitle)
dialogTitle
- the title of the dialog. If null, than default will be used.public WorkbenchStatusDialogManager(Shell parentShell, String dialogTitle)
parentShell is ignored
parentShell
- the parent shell for the dialog. It may be null.dialogTitle
- the title of the dialog. If null, than default will be used.WorkbenchStatusDialogManager(String)
Method Detail |
public void addStatusAdapter(StatusAdapter statusAdapter, boolean modal)
Adds a new StatusAdapter
to the status adapters list in the
dialog.
If the dialog is already visible, the status adapter will be shown immediately. Otherwise, the dialog with the added status adapter will show up, if all conditions below are false.
IProgressConstants.NO_IMMEDIATE_ERROR_PROMPT_PROPERTY
set to trueAll not shown status adapters will be displayed as soon as the dialog shows up.
modal
- true
if the dialog should be modal,
false
otherwisestatusAdapter
- the status adapterpublic void enableDefaultSupportArea(boolean enable)
enable
- true enables, false disables default supportpublic Collection getStatusAdapters()
StatusAdapter
objectspublic void setDetailsAreaProvider(AbstractStatusAreaProvider provider)
provider
- A details area provider to be set.public void setStatusListLabelProvider(ITableLabelProvider labelProvider)
labelProvider
- a label provider to be used when displaying status adapters.
It must not be null.public void setSupportAreaProvider(AbstractStatusAreaProvider provider)
provider
- Support provider to be set.
|
Eclipse Platform Release 3.4 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.