|
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.StatusManager
StatusManager is the entry point for all statuses to be reported in the user interface.
Handlers shoudn't be used directly but through the StatusManager singleton
which keeps the status handling policy and chooses handlers.
StatusManager.getManager().handle(IStatus)
and
handle(IStatus status, int style)
are the methods are the
primary access points to the StatusManager.
Acceptable styles (can be combined with logical OR)
Dialog
Dialog
Handlers are intended to be accessed via the status manager. The
StatusManager chooses which handler should be used for a particular error.
There are two ways for adding handlers to the handling flow. First using
extension point org.eclipse.ui.statusHandlers
, second by the
workbench advisor and its method
WorkbenchAdvisor.getWorkbenchErrorHandler()
. If a handler is
associated with a product, it is used instead of this defined in advisor.
AbstractStatusHandler
Field Summary | |
static int |
BLOCK
A style indicating that the handling should block the calling method until the user has responded. |
static int |
LOG
A style indicating that the status should be logged only. |
static int |
NONE
A style indicating that the status should not be acted on. |
static int |
SHOW
A style indicating that handlers should show a problem to an user without blocking the calling method while awaiting user response. |
Method Summary | |
void |
addLoggedStatus(IStatus status)
This method informs the StatusManager that this IStatus is being handled by the handler and to ignore it when it shows up in our ILogListener. |
static StatusManager |
getManager()
Returns StatusManager singleton instance. |
void |
handle(CoreException coreException,
String pluginId)
Handles given CoreException. |
void |
handle(IStatus status)
Handles the given status. |
void |
handle(IStatus status,
int style)
Handles the given status due to the style. |
void |
handle(StatusAdapter statusAdapter)
Handles the given status adapter. |
void |
handle(StatusAdapter statusAdapter,
int style)
Handles the given status adapter due to the style. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int NONE
public static final int LOG
public static final int SHOW
Dialog
.
public static final int BLOCK
Dialog
.
Method Detail |
public static StatusManager getManager()
public void handle(StatusAdapter statusAdapter, int style)
NONE
. If Workbench isn't
initialized and the style is NONE
, the manager will do nothing.
statusAdapter
- the status adapterstyle
- the style. Value can be combined with logical OR. One of
NONE
, LOG
, SHOW
and
BLOCK
.public void handle(StatusAdapter statusAdapter)
LOG
style is used when
this method is called.
statusAdapter
- the status adapterpublic void handle(IStatus status, int style)
NONE
. If Workbench isn't
initialized and the style is NONE
, the manager will do nothing.
status
- the status to handlestyle
- the style. Value can be combined with logical OR. One of
NONE
, LOG
, SHOW
and
BLOCK
.public void handle(IStatus status)
LOG
style is used when this method
is called.
status
- the status to handlepublic void handle(CoreException coreException, String pluginId)
StatusManager.getManager().handle(coreException.getStatus());
coreException
- a CoreException to be handled.pluginId
- the unique identifier of the relevant plug-inhandle(IStatus)
public void addLoggedStatus(IStatus status)
status
- already handled and logged status
|
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.