public class SubStatusLineManager extends SubContributionManager implements IStatusLineManager
SubStatusLineManager is used to define a set of contribution
items within a parent manager. Once defined, the visibility of the entire set can
be changed as a unit.| Constructor and Description |
|---|
SubStatusLineManager(IStatusLineManager mgr)
Constructs a new manager.
|
| Modifier and Type | Method and Description |
|---|---|
protected IStatusLineManager |
getParentStatusLineManager()
Returns the parent status line manager that this sub-manager contributes
to.
|
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.
|
void |
setVisible(boolean visible)
Sets the visibility of the manager.
|
void |
update(boolean force)
Updates this manager's underlying widget(s) with any changes which
have been made to it or its items.
|
add, add, appendToGroup, appendToGroup, disposeManager, find, getItems, getOverrides, getParent, insertAfter, insertAfter, insertBefore, insertBefore, isDirty, isEmpty, isVisible, itemAdded, itemRemoved, items, markDirty, prependToGroup, prependToGroup, remove, remove, removeAll, unwrap, wrapclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitadd, add, appendToGroup, appendToGroup, find, getItems, getOverrides, insertAfter, insertAfter, insertBefore, insertBefore, isDirty, isEmpty, markDirty, prependToGroup, prependToGroup, remove, remove, removeAllpublic SubStatusLineManager(IStatusLineManager mgr)
mgr - the parent manager. All contributions made to the
SubStatusLineManager are forwarded and appear in the
parent manager.protected final IStatusLineManager getParentStatusLineManager()
public IProgressMonitor getProgressMonitor()
IStatusLineManagergetProgressMonitor in interface IStatusLineManagerpublic boolean isCancelEnabled()
IStatusLineManagerisCancelEnabled in interface IStatusLineManagertrue if the cancel button is enabled, or false if notpublic void setCancelEnabled(boolean enabled)
IStatusLineManagersetCancelEnabled in interface IStatusLineManagerenabled - true if the cancel button is enabled, or false if notpublic void setErrorMessage(String message)
IStatusLineManager
An error message overrides the current message until the error
message is cleared (set to null).
setErrorMessage in interface IStatusLineManagermessage - the error message, or null to clear
the current error message.public void setErrorMessage(Image image, String message)
IStatusLineManager
An error message overrides the current message until the error
message is cleared (set to null).
setErrorMessage in interface IStatusLineManagerimage - 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)
IStatusLineManager
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).
setMessage in interface IStatusLineManagermessage - the message, or null for no messagepublic void setMessage(Image image, String message)
IStatusLineManager
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).
setMessage in interface IStatusLineManagerimage - the image to use, or null for no imagemessage - the message, or null for no messagepublic void setVisible(boolean visible)
SubContributionManagertrue
then each item within the manager appears within the parent manager.
Otherwise, the items are not visible.setVisible in class SubContributionManagervisible - the new visibilitypublic void update(boolean force)
IContributionManagerupdate in interface IContributionManagerforce - true means update even if not dirty,
and false for normal incremental updatingGuidelines for using Eclipse APIs. Copyright (c) IBM Corp. and others 2000, 2006. All rights reserved.