public interface IStatusLineManager extends IContributionManager
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
Modifier and Type | Method and Description |
---|---|
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.
|
add, add, appendToGroup, appendToGroup, find, getItems, getOverrides, insertAfter, insertAfter, insertBefore, insertBefore, isDirty, isEmpty, markDirty, prependToGroup, prependToGroup, remove, remove, removeAll, update
IProgressMonitor getProgressMonitor()
boolean isCancelEnabled()
true
if the cancel button is enabled, or false
if notvoid setCancelEnabled(boolean enabled)
enabled
- true
if the cancel button is enabled, or false
if notvoid 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.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.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 messagevoid 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
Copyright (c) 2000, 2018 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.