|
Eclipse Platform Release 3.0 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The IStatusLineManager
interface provides protocol
for displaying messages on a status line, for monitoring progress,
and for managing contributions to the status line.
Note: An error message overrides the current message until the error message is cleared.
This package also provides a concrete status line manager implementation,
.
StatusLineManager
Method Summary | |
IProgressMonitor |
getProgressMonitor()
Returns a progress monitor which reports progress in the status line. |
boolean |
isCancelEnabled()
Returns whether the cancel button on the status line's progress monitor is enabled. |
void |
setCancelEnabled(boolean enabled)
Sets whether the cancel button on the status line's progress monitor is enabled. |
void |
setErrorMessage(Image image,
String message)
Sets the image and error message to be displayed on the status line. |
void |
setErrorMessage(String message)
Sets the error message text to be displayed on the status line. |
void |
setMessage(Image image,
String message)
Sets the image and message to be displayed on the status line. |
void |
setMessage(String message)
Sets the message text to be displayed on the status line. |
Methods inherited from interface org.eclipse.jface.action.IContributionManager |
add, add, appendToGroup, appendToGroup, find, getItems, getOverrides, insertAfter, insertAfter, insertBefore, insertBefore, isDirty, isEmpty, markDirty, prependToGroup, prependToGroup, remove, remove, removeAll, update |
Method Detail |
public IProgressMonitor getProgressMonitor()
public boolean isCancelEnabled()
true
if the cancel button is enabled, or false
if notpublic void setCancelEnabled(boolean enabled)
enabled
- true
if the cancel button is enabled, or false
if notpublic void setErrorMessage(String message)
An error message overrides the current message until the error
message is cleared (set to null
).
message
- the error message, or null
to clear
the current error message.public void setErrorMessage(Image image, String message)
An error message overrides the current message until the error
message is cleared (set to null
).
image
- the image to use, or null
for no imagemessage
- the error message, or null
to clear
the current error message.public void setMessage(String message)
This method replaces the current message but does not affect the
error message. That is, the error message, if set, will continue
to be displayed until it is cleared (set to null
).
message
- the message, or null
for no messagepublic void setMessage(Image image, String message)
This method replaces the current message but does not affect the
error message. That is, the error message, if set, will continue
to be displayed until it is cleared (set to null
).
image
- the image to use, or null
for no imagemessage
- the message, or null
for no message
|
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.